mikespokefire / rspec-virtus Goto Github PK

View Code? Open in Web Editor NEW

17.0 4.0 14.0 247 KB

Simple RSpec matchers for Virtus objects

License: MIT License

Ruby 100.00%

rspec-virtus's Introduction

Rspec::Virtus

Simple RSpec matchers for your Virtus objects

Installation

Add this line to your application's Gemfile:

gem 'rspec-virtus'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rspec-virtus

Usage

Here is a sample Virtus object

class Post
  include Virtus.model
  attribute :title, String
  attribute :body, String
  attribute :comments, Array[String]
end

And with rspec-virtus we can now make simple assertions about these models

require 'spec_helper'

describe Post
  describe 'attributes' do
    it "has an attribute" do
      expect(described_class).to have_attribute(:title)
    end

    it "has an attribute with a type check" do
      expect(described_class).to have_attribute(:body).of_type(String)
    end

    it "has an array attribute with a type check" do
      expect(described_class).to have_attribute(:comments).of_type(Array, member_type: String)
    end
  end
end

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Changelog

Version 1.0.1
- Remove deprecation notices about legacy matcher syntax
- Add description to match RSpec 3 matchers
Version 1.0.0
- Upgrade syntax to work with Virtus 1.0.x
Version 0.2.0
- Upgrade to RSpec 3.0

rspec-virtus's People

Contributors

Stargazers

Watchers

Forkers

dwhelan aaronrenner mkaschenko vince94320 holidayworking ijustwanttocode swistaczek arunagw simonoff kukunin

rspec-virtus's Issues

Compatibility with the last virtus version

The last virtus version is 1.0.3 [1], but this gem depends on ~> 0.5 [2].

[1] https://github.com/solnic/virtus/blob/master/lib/virtus/version.rb
[2] https://github.com/mikespokefire/rspec-virtus/blob/master/rspec-virtus.gemspec#L21

Failing specs due to the new use of Ruby coerce method

Problem was introduced with this modification on equalizer gem:

dkubb/equalizer@0f13

Failing specs:

$ rspec

Randomized with seed 31093
FF........F..F...

Failures:

  1) DummyPost should have body defined
     Failure/Error: it { expect(described_class).to have_attribute(:body).of_type(String) }
     NoMethodError:
       undefined method `first' for nil:NilClass
     # /home/embs/.rvm/gems/ruby-2.1.2@rspec-virtus/gems/equalizer-0.0.11/lib/equalizer.rb:117:in `=='
     # ./lib/rspec-virtus/matcher.rb:47:in `!='
     # ./lib/rspec-virtus/matcher.rb:47:in `attribute_exists?'
     # ./lib/rspec-virtus/matcher.rb:21:in `matches?'
     # ./spec/acceptance/rspec-virtus_spec.rb:14:in `block (2 levels) in <top (required)>'

  2) DummyPost should have title defined
     Failure/Error: it { expect(described_class).to have_attribute(:title) }
     NoMethodError:
       undefined method `first' for nil:NilClass
     # /home/embs/.rvm/gems/ruby-2.1.2@rspec-virtus/gems/equalizer-0.0.11/lib/equalizer.rb:117:in `=='
     # ./lib/rspec-virtus/matcher.rb:47:in `!='
     # ./lib/rspec-virtus/matcher.rb:47:in `attribute_exists?'
     # ./lib/rspec-virtus/matcher.rb:21:in `matches?'
     # ./spec/acceptance/rspec-virtus_spec.rb:13:in `block (2 levels) in <top (required)>'

  3) RSpec::Virtus::Matcher#matches? successful match on attribute name 
     Failure/Error: subject { instance.matches?(actual) }
     NoMethodError:
       undefined method `first' for nil:NilClass
     # /home/embs/.rvm/gems/ruby-2.1.2@rspec-virtus/gems/equalizer-0.0.11/lib/equalizer.rb:117:in `=='
     # ./lib/rspec-virtus/matcher.rb:47:in `!='
     # ./lib/rspec-virtus/matcher.rb:47:in `attribute_exists?'
     # ./lib/rspec-virtus/matcher.rb:21:in `matches?'
     # ./spec/lib/rspec-virtus/matcher_spec.rb:16:in `block (3 levels) in <top (required)>'
     # ./spec/lib/rspec-virtus/matcher_spec.rb:20:in `block (4 levels) in <top (required)>'

  4) RSpec::Virtus::Matcher#matches? successful match on attribute name and type 
     Failure/Error: subject { instance.matches?(actual) }
     NoMethodError:
       undefined method `first' for nil:NilClass
     # /home/embs/.rvm/gems/ruby-2.1.2@rspec-virtus/gems/equalizer-0.0.11/lib/equalizer.rb:117:in `=='
     # ./lib/rspec-virtus/matcher.rb:47:in `!='
     # ./lib/rspec-virtus/matcher.rb:47:in `attribute_exists?'
     # ./lib/rspec-virtus/matcher.rb:21:in `matches?'
     # ./spec/lib/rspec-virtus/matcher_spec.rb:16:in `block (3 levels) in <top (required)>'
     # ./spec/lib/rspec-virtus/matcher_spec.rb:28:in `block (4 levels) in <top (required)>'

Finished in 0.00842 seconds (files took 0.13039 seconds to load)
17 examples, 4 failures

Failed examples:

rspec ./spec/acceptance/rspec-virtus_spec.rb:14 # DummyPost should have body defined
rspec ./spec/acceptance/rspec-virtus_spec.rb:13 # DummyPost should have title defined
rspec ./spec/lib/rspec-virtus/matcher_spec.rb:20 # RSpec::Virtus::Matcher#matches? successful match on attribute name 
rspec ./spec/lib/rspec-virtus/matcher_spec.rb:28 # RSpec::Virtus::Matcher#matches? successful match on attribute name and type

Allow new RSpec matcher syntax

Currently We have to use old syntax for matching:

it { expect(described_class).to have_attribute(:title) }

It would be much nicer if we could keep the old implementation, as well as using the new and improved version:

it { is_expected.to have_attribute(:title) }

Model with boolean attribute

With the current version it is not possible to test attribute type if attribute type is boolean.

The current implementation uses method Attribute#primitive to fetch and compare types, which in case of Boolean returns BasicObject (because ruby does not have a corresponding type) and thus fails.

class Authorization
  include Virtus.model

  attribute :status, String
  attribute :approved, Boolean
  attribute :pending
end

it { expect(described_class).to have_attribute(:approved).of_type(described_class::Boolean) } # fails
it { expect(described_class).to have_attribute(:approved).of_type(Virtus::Attribute::Boolean) } # fails
it { expect(described_class).to have_attribute(:approved).of_type(Axiom::Types::Boolean) } #fails

Authorization.attribute_set['status']   #=> #<Virtus::Attribute type=Axiom::Types::String (String)
Authorization.attribute_set['status'].primitive   #=> String

Authorization.attribute_set['approved'] #=> #<Virtus::Attribute::Boolean type=Axiom::Types::Boolean (BasicObject) ...
Authorization.attribute_set['approved'].primitive #=> BasicObject

Authorization.attribute_set['pending']  #=> #<Virtus::Attribute type=Axiom::Types::Object (BasicObject)
Authorization.attribute_set['pending'].primitive  #=> BasicObject

As a solution I suggest to update method type_correct? to check if attribute is instance of given type.

module RSpec
  module Virtus
    class Matcher
      def type_correct?
        if @options[:member_type]
          member_type == @options[:member_type] && (attribute_type == @options[:type] || attribute.is_a?(@options[:type]))
        elsif @options[:type]
          attribute_type == @options[:type] || attribute.is_a?(@options[:type])
        else
          true
        end
      end
    end
  end
end

mikespokefire / rspec-virtus Goto Github PK

rspec-virtus's Introduction

Rspec::Virtus

Installation

Usage

Contributing

Changelog

rspec-virtus's People

Contributors

Stargazers

Watchers

Forkers

rspec-virtus's Issues

Compatibility with the last virtus version

Failing specs due to the new use of Ruby coerce method

Allow new RSpec matcher syntax

Model with boolean attribute

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent