rspec_virtus 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8cf549d7ff73eca8bdc70f761c478fbf5a0eff85
+  data.tar.gz: 9288e5325620c75deff55965f3d65b73c107551a
+SHA512:
+  metadata.gz: d88daee24f73e62aa1926736896686586328e8da97081a25a1e763102fd754f3f027ee93165d7c1ea619d8a3651294b7affd9c53e8d482ff9fac2e4c1ea51255
+  data.tar.gz: c19e6e567174acce747ce1ed08bec2e6b6b0824903609c906ec5e624f1cbf01c4aec72cc69e5c23cbb0ac40af9c7eb3ac0dba25a069391a50ff1cd9365b136f1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+  Exclude:
+    - 'spec/**/*'
+Style/LineLength:
+  Enabled: false
+Style/FileName:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false
+Style/Encoding:
+  Enabled: false
+Documentation:
+  Enabled: false
+Style/MethodLength:
+  Max: 15

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_filter "/spec/"
+end

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2
+  - 2.0.0
+  - 2.1
+  - 2.2

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-virtus.gemspec
+gemspec
+
+group :test do
+  # additional testing libs
+  gem 'simplecov', '>= 0.10.0', require: false
+  gem 'coveralls', require: false
+end
+
+group :local_development do
+  gem 'terminal-notifier-guard', require: false if RUBY_PLATFORM.downcase.include?('darwin')
+  gem 'guard-rspec', '>= 4.3.1', require: false
+  gem 'guard-bundler', require: false
+  gem 'guard-preek', require: false
+  gem 'guard-rubocop', require: false
+  gem 'guard-reek', github: 'pericles/guard-reek', require: false
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2013 Michael Smith
+Copyright (c) 2015 Alexander Simonov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# RSpec::Virtus [![Build Status](https://travis-ci.org/simonoff/rspec_virtus.png?branch=master)](https://travis-ci.org/simonoff/rspec_virtus) [![Code Climate](https://codeclimate.com/github/simonoff/rspec_virtus.png)](https://codeclimate.com/github/simonoff/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 :some_default, String, default: 'WOW!'
+      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 { is_expected.to have_attribute(:title) }
+
+        it { is_expected.to have_attribute(:body).of_type(String) }
+
+        it { is_expected.to have_attribute(:some_default).with_default('WOW!') }
+
+        it { is_expected.to have_attribute(:comments).of_type(String, member_type: String) }
+
+      end
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Changelog
+
+- Version 1.1.0
+    - Refactor gem
+    - Rename gem
+    - Make possibility to use default subject
+    - Support for default values
+    - Support for required option
+
+- 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

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+# rubocop
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+# reek
+require 'reek/rake/task'
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+  t.source_files = Dir['lib/**/*.rb']
+end
+
+default_tasks = [:spec, :rubocop, :reek]
+
+task default: default_tasks

data/lib/rspec_virtus.rb

@@ -0,0 +1,16 @@
+require 'rspec/core'
+require 'rspec_virtus/matcher'
+require 'rspec_virtus/version'
+
+module RSpec
+  module Virtus
+    # rubocop:disable Style/PredicateName
+    def have_attribute(attribute_name)
+      Matcher.new(attribute_name)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Virtus
+end

data/lib/rspec_virtus/matcher.rb

@@ -0,0 +1,97 @@
+module RSpec
+  module Virtus
+    class Matcher
+      def initialize(attribute_name)
+        @attribute_name = attribute_name
+        @options = {}
+      end
+
+      def description
+        msg = "have attribute #{@attribute_name}"
+        msg << ", #{@options[:type]}" if @options[:type]
+        msg << ", default: #{@options[:default_value]}" if @options[:default_value]
+        msg
+      end
+
+      def of_type(type)
+        @options[:type] = type
+        self
+      end
+
+      def with_default(default_value)
+        @options[:default_value] = default_value
+        self
+      end
+
+      def with_required(value)
+        @options[:required] = value
+        self
+      end
+
+      def matches?(instance)
+        @instance = instance
+        @subject = instance.class
+        attribute_exists? && type_correct? && default_value_correct? && required?
+      end
+
+      def failure_message
+        "should #{@attribute_name} to be defined"
+      end
+
+      def failure_message_when_negated
+        "should #{@attribute_name} not to be defined"
+      end
+
+      private
+
+      def attribute
+        @subject.attribute_set[@attribute_name]
+      end
+
+      def member_type
+        attribute.member_type.primitive
+      end
+
+      def attribute_type
+        attribute.primitive
+      end
+
+      def attribute_exists?
+        !attribute.nil?
+      end
+
+      def attribute_default_value
+        value = attribute.default_value.value
+
+        case value
+        when ::Proc
+          value.call(@instance, attribute)
+        when ::Symbol
+          @instance.__send__(value)
+        else
+          value
+        end
+      end
+
+      def type_correct?
+        if @options[:type].is_a?(::Array)
+          attribute_type == Array && member_type == @options[:type].first
+        elsif @options[:type]
+          attribute_type == @options[:type]
+        else
+          true
+        end
+      end
+
+      def default_value_correct?
+        return true unless @options[:default_value]
+        attribute_default_value == @options[:default_value]
+      end
+
+      def required?
+        return true if @options[:required].nil?
+        attribute.required? == @options[:required]
+      end
+    end
+  end
+end

data/lib/rspec_virtus/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Virtus
+    VERSION = '1.1.0'
+  end
+end

data/rspec_virtus.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_virtus/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'rspec_virtus'
+  gem.version       = RSpec::Virtus::VERSION
+  gem.authors       = ['Michael Smith', 'Alexander Simonov']
+  gem.email         = ['mike@spokefire.co.uk', 'alex@simonov.me']
+  gem.description   = 'Simple RSpec matchers for Virtus objects'
+  gem.summary       = 'Simple RSpec matchers for Virtus objects'
+  gem.homepage      = 'https://github.com/simonoff/rspec_virtus'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'rspec', '>= 3.0'
+  gem.add_dependency 'virtus', '>= 1.0'
+
+  gem.add_development_dependency 'rake', '~> 10.0.0'
+end

data/spec/acceptance/rspec_virtus_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'virtus'
+
+class DummyPost
+  include Virtus.model
+
+  attribute :title, String
+  attribute :body, String
+  attribute :comments, Array[String]
+  attribute :greeting, String, default: 'Hello!'
+  attribute :default_lambda, String, default: ->(_, _) { 'Wow!' }
+  attribute :customs, String, default: :custom_default_via_method
+  attribute :some_required, String, default: 'FooBar', required: true
+
+  def custom_default_via_method
+    'Foo!'
+  end
+
+end
+
+describe ::DummyPost do
+  it { is_expected.to have_attribute(:title) }
+  it { is_expected.to have_attribute(:body).of_type(String) }
+  it { is_expected.to have_attribute(:comments).of_type(Array[String]) }
+  it { is_expected.to have_attribute(:greeting).of_type(String).with_default('Hello!') }
+  it { is_expected.to have_attribute(:default_lambda).of_type(String).with_default('Wow!') }
+  it { is_expected.to have_attribute(:customs).of_type(String).with_default('Foo!') }
+  it { is_expected.to have_attribute(:some_required).of_type(String).with_default('FooBar').with_required(true) }
+end

data/spec/lib/rspec_virtus/matcher_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+require 'virtus'
+
+describe RSpec::Virtus::Matcher do
+  let(:instance) { described_class.new(attribute_name) }
+  let(:attribute_name) { :the_attribute }
+
+  class DummyVirtus
+    include Virtus.model
+
+    attribute :the_attribute, String
+    attribute :the_array_attribute, Array[String]
+    attribute :the_integer_attribute_with_default, Integer, default: 5
+  end
+
+  describe '#matches?' do
+    subject { instance.matches?(actual) }
+    let(:actual) { DummyVirtus.new }
+
+    context 'successful match on attribute name' do
+      it { is_expected.to eql(true) }
+    end
+
+    context 'successful match on attribute name and type' do
+      before do
+        instance.of_type(String)
+      end
+
+      it { is_expected.to eql(true) }
+    end
+
+    context 'successful match on attribute name, type and member_type' do
+      let(:attribute_name) { :the_array_attribute }
+
+      before do
+        instance.of_type(Array[String])
+      end
+
+      it { is_expected.to eql(true) }
+    end
+
+    context 'successful match with default value' do
+      let(:attribute_name) { :the_integer_attribute_with_default }
+      before do
+        instance.with_default(5)
+      end
+      it { is_expected.to eql(true) }
+    end
+
+    context 'successful match with type and default value' do
+      let(:attribute_name) { :the_integer_attribute_with_default }
+      before do
+        instance.of_type(Integer).with_default(5)
+      end
+      it { is_expected.to eql(true) }
+    end
+
+    context 'unsuccessful match on attribute name' do
+      let(:attribute_name) { :something_else }
+
+      it { is_expected.to eql(false) }
+    end
+
+    context 'unsuccessful match on attribute name and type' do
+      let(:attribute_name) { :something_else }
+
+      before do
+        instance.of_type(Integer)
+      end
+
+      it { is_expected.to eql(false) }
+    end
+
+    context 'unsuccessful match on attribute name, type and member_type' do
+      let(:attribute_name) { :the_array_attribute }
+
+      before do
+        instance.of_type(Array[Integer])
+      end
+
+      it { is_expected.to eql(false) }
+    end
+
+    context 'unsuccessful match with default value' do
+      let(:attribute_name) { :the_integer_attribute_with_default }
+      before do
+        instance.with_default(-1)
+      end
+      it { is_expected.to eql(false) }
+    end
+
+    context 'unsuccessful match with type and default value' do
+      let(:attribute_name) { :the_integer_attribute_with_default }
+      before do
+        instance.of_type(Integer).with_default(-5)
+      end
+      it { is_expected.to eql(false) }
+    end
+  end
+
+  describe '#of_type' do
+    subject { instance.of_type(String) }
+
+    it 'returns itsself so it can be chained' do
+      expect(subject).to eql(instance)
+    end
+
+    context 'singular values' do
+      it 'adds an option to allow the type to be checked' do
+        options_type = subject.instance_variable_get(:@options)[:type]
+        expect(options_type).to eql(String)
+      end
+    end
+
+    context 'arrays of values' do
+      subject { instance.of_type(Array[String]) }
+
+      it 'adds an option to allow the type to be checked' do
+        options_type = subject.instance_variable_get(:@options)[:type].class
+        expect(options_type).to eql(Array)
+      end
+
+      it 'adds an option to allow the member_type to be checked' do
+        member_options_type = subject.instance_variable_get(:@options)[:type].first
+        expect(member_options_type).to eql(String)
+      end
+    end
+  end
+
+  describe '#with_default' do
+    subject { instance.with_default('My Default') }
+
+    it 'returns itsself so it can be chained' do
+      expect(subject).to eql(instance)
+    end
+
+    it 'adds an option to allow the default value to be checked' do
+      options_default_value = subject.instance_variable_get(:@options)[:default_value]
+      expect(options_default_value).to eql('My Default')
+    end
+  end
+
+  describe '#description' do
+    subject { instance.description }
+
+    it 'tells you which attribute we are testing' do
+      expect(subject).to include(attribute_name.to_s)
+    end
+  end
+
+  describe '#failure_message' do
+    subject { instance.failure_message }
+
+    it 'tells you which attribute failed' do
+      expect(subject).to include(attribute_name.to_s)
+    end
+  end
+
+  describe '#failure_message_when_negated' do
+    subject { instance.failure_message_when_negated }
+
+    it 'tells you which attribute failed' do
+      expect(subject).to include(attribute_name.to_s)
+    end
+  end
+end

data/spec/lib/rspec_virtus_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe RSpec::Virtus do
+  let(:instance) { Class.new { include RSpec::Virtus }.new  }
+
+  describe '#have_attribute' do
+    subject { instance.have_attribute(:attribute_name) }
+
+    it 'returns a new matcher instance' do
+      expect(subject).to be_an_instance_of(RSpec::Virtus::Matcher)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+require 'rspec_virtus'
+
+RSpec.configure do |config|
+  config.order = :random
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rspec_virtus
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Michael Smith
+- Alexander Simonov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+description: Simple RSpec matchers for Virtus objects
+email:
+- mike@spokefire.co.uk
+- alex@simonov.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec_virtus.rb
+- lib/rspec_virtus/matcher.rb
+- lib/rspec_virtus/version.rb
+- rspec_virtus.gemspec
+- spec/acceptance/rspec_virtus_spec.rb
+- spec/lib/rspec_virtus/matcher_spec.rb
+- spec/lib/rspec_virtus_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/simonoff/rspec_virtus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Simple RSpec matchers for Virtus objects
+test_files:
+- spec/acceptance/rspec_virtus_spec.rb
+- spec/lib/rspec_virtus/matcher_spec.rb
+- spec/lib/rspec_virtus_spec.rb
+- spec/spec_helper.rb