accept_values_for 0.2.1 → 0.3.0

data/Readme.textile

@@ -2,25 +2,67 @@ h1. Accept values for
 
 h2. Description
 
-In order to spec a complex validation for ActiveRecord models.
-Implemented accept_values_for custom matcher.
-With this matcher you can specify which values of model attribute should be accepted by model validation and which should not.
+  In order to spec ActiveRecord models.
+  I decided to write a few custom matchers that makes the work match easier:
 
 
-h2. Usage
+h2. Matchers
 
-  <pre>
-  describe User do
+* accept_values_for
+* discover
 
-    subject { User.new(@valid_attributes)}
-    
+h3. Accept values for
 
+"Rpec matcher to test the validation":http://gusiev.com/2010/06/ultimate-rspec-matcher-to-test-validation/
 
-    it { should accept_values_for(:email, "john@example.com", "lambda@gusiev.com") }
-    it { should_not accept_values_for(:email, "invalid", nil, "a@b", "john@.com") }
+<pre>
+describe User do
 
+  subject { User.new(@valid_attributes)}
+  
+
+
+  it { should accept_values_for(:email, "john@example.com", "lambda@gusiev.com") }
+  it { should_not accept_values_for(:email, "invalid", nil, "a@b", "john@.com") }
+
+end</pre>
+
+h3. Discovery matcher
+
+"Rspec matcher to test named scopes":http://gusiev.com/2010/07/bdd-rspec-matcher-to-test-named_scope-scoped-rails
+
+
+<pre><code>describe "#by_category_id named scope" do
+  let(:given_category) do 
+    Factory.create(:given_category)
+  end
+
+
+  let(:product_in_given_category) do
+    Factory.create(
+      :product,
+      :categories => [category]
+    )
+  end
+
+  let(:product_not_in_given_category) do
+    Factory.create(
+      :product,
+      :categories => [Factory.create(:category)]
+    )
   end
-  </pre>
+
+  # This might be tricky to redefine subject as the finder result
+  # but in this way we can delegate the matcher to subject and 
+  # avoid writing test descriptions.
+  subject { described_class.by_category_id(given_category.id) }
+
+  it { should discover(product_in_given_category) }
+  it { should_not discover(product_not_in_given_category) }
+
+end
+</code></pre> 
+
 
 h2. Dependencies
 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/accept_values_for.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{accept_values_for}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bogdan Gusiev"]
+  s.date = %q{2010-07-12}
+  s.description = %q{Rspec: When you have a complex validation(e.g. regexp or custom method) on ActiveRecord model
+you have to write annoying easy specs on which values should be accepted by your validation method and which should not.
+accepts_values_for rspec matcher simplify the code. See example for more information.
+}
+  s.email = %q{agresso@gmail.com}
+  s.files = [
+    "Gemfile",
+     "Rakefile",
+     "Readme.textile",
+     "VERSION",
+     "accept_values_for.gemspec",
+     "lib/accept_values_for.rb",
+     "lib/discover.rb",
+     "spec/accept_values_for_spec.rb",
+     "spec/discover_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bogdan/accept_values_for}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{In order to test a complex validation for ActiveRecord models Implemented accept_values_for custom rspec matcher}
+  s.test_files = [
+    "spec/discover_spec.rb",
+     "spec/accept_values_for_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_runtime_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/lib/discover.rb

@@ -0,0 +1,127 @@
+if defined?(ActiveRecord)
+
+  # In order to spec ActiveRecord finders
+  # Implemented discover custom matcher
+  #
+  # :call-seq:
+  #   Class.named_scope.should discover(model1, model2)
+  #   Class.named_scope.should_not discover(model3, model4)
+  #
+  # matcher subject should be an instance of ActiverRecord::NamedScope::Scoped or Array
+  # models should be an instace of ActiverRecord::Base
+  #
+  # Use this if you need to check the inclution of objects ActiveRecord finders result
+  # and it's order
+  #
+  # == Examples
+  #
+  #   class Group < AR::Base
+  #     named_scope :approved, :conditions => "approved = true"
+  #     named_scope :order_by_name, :order => "name"
+  #   end
+  #
+  #   Group.approved.should discover(Group.create!(:approved => true))
+  #   Group.approved.should_not discover(Group.create!(:approved => false))
+  #   Group.order_by_name.should discover(Group.create!(:name => "apple"), Group.create!(:name => "bear").with_exact_order)
+  #
+  #
+  def discover(*objects)
+    Rspec::Discover.new(*objects)
+  end
+
+end
+
+module Rspec
+  class Discover  #:nodoc:
+
+    def initialize(*objects)
+      @objects = objects
+    end
+
+    def with_exact_order
+      @with_exact_order = true
+      self
+    end
+
+    def matches?(scope)
+      @scope = scope
+      return valid_findness? && valid_indexes?
+    end
+
+    def does_not_match?(scope)
+      @scope = scope
+      if @with_exact_order
+        raise "calling #with_exact_order is not allowed with should_not match"
+      end
+      return valid_not_findness?
+    end
+
+    def failure_message_for_should
+      result = @not_found_object_ids.any? ? 
+        "expected #{@scope.inspect} to include objects: #{@not_found_object_ids.inspect}" :
+        "expected #{@scope.inspect} to be ordered as: #{@objects.map(&:id).inspect}"
+      result += ", but it was not. " 
+      if @not_found_object_ids.any?
+        result += found_objects_string
+      end
+      result
+    end
+
+    def failure_message_for_should_not
+      result = "expected #{@scope.inspect} to not include objects: #{@found_object_ids.inspect}" 
+      result += ", but it was. " 
+      result += found_objects_string
+      result
+    end
+
+
+    def description
+      "discover #{@objects.map(&:inspect).join(', ')} " + ordering_string
+    end
+
+    protected
+
+    def valid_findness?
+      result = true
+      @not_found_object_ids = []
+      @objects.each do |object|
+        unless @scope.include?(object)
+          @not_found_object_ids << object.id
+          result = false
+        end
+      end
+      result
+    end
+
+
+    def valid_indexes?
+      return true unless @with_exact_order
+      indexes = @objects.map{|o| @scope.index(o)}
+      return indexes.sort == indexes
+    end
+
+    def valid_not_findness?
+      result = true
+      @found_object_ids = []
+      @objects.each do |object|
+        if @scope.include?(object)
+          @found_object_ids << object.id
+          result = false
+        end
+      end
+      result
+    end
+
+    def found_objects_string
+      "Found objects: " + @scope.map(&:id).inspect
+    end
+
+
+    def ordering_string
+      @with_exact_order ? "with exact order" : ""
+    end
+
+  end
+end
+
+

data/spec/discover_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe "Discover" do
+
+
+  let(:named_scope) {
+      Group.by_char("j") 
+  }
+  let(:java) { Group.create!(:name => "java") }
+  let(:json) { Group.create!(:name => "json") }
+  let(:jruby) { Group.create!(:name => "jruby") }
+  let(:ruby) { Group.create!(:name => "ruby")}
+  let(:python) { Group.create!(:name => "python")}
+
+  describe "#does_not_match?" do
+
+    context "if scope contains any of the specified values" do
+      subject { discover(java, ruby) }
+      before(:each) do
+        subject.does_not_match?(named_scope).should be_false
+      end
+
+      it { subject.failure_message_for_should_not.should == "expected #{named_scope.inspect} to not include objects: #{[java.id].inspect}, but it was. Found objects: #{named_scope.map(&:id).inspect}"}
+      
+    end
+
+  end
+
+  describe "#matches?" do
+    context "if scope doesn't contain any of the specified objects" do
+      subject { discover(java, ruby) }
+      before(:each) do
+        subject.matches?(named_scope).should be_false
+      end
+
+      it {subject.failure_message_for_should.should == "expected #{named_scope.inspect} to include objects: #{[ruby.id].inspect}, but it was not. Found objects: #{named_scope.map(&:id).inspect}"}
+    end
+
+    context "if scope contain all of the specified objects but without correct order" do
+      subject { discover(jruby, java).with_exact_order }
+      before(:each) do
+        subject.matches?(named_scope).should be_false
+      end
+
+      it "should render error message correctly" do
+        subject.failure_message_for_should.should == "expected #{named_scope.inspect} to be ordered as: #{[jruby.id, java.id].inspect}, but it was not. "
+      end
+    end
+  end
+
+  describe "api" do
+    subject {
+      named_scope
+    }
+
+    it { should discover(java) }
+
+    it { should discover(json, java, jruby) }
+    it { should discover(java, jruby, json).with_exact_order }
+    it { should discover(java, json).with_exact_order }
+
+    it { should_not discover(ruby) }
+    it { should_not discover(ruby, python) }
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'spec'
 require 'spec/autorun'
 require 'active_record'
 require 'lib/accept_values_for'
+require 'lib/discover'
 
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
 ActiveRecord::Base.configurations = true
@@ -13,6 +14,7 @@ ActiveRecord::Schema.define(:version => 1) do
   create_table :people do |t|
     t.string :gender
     t.integer :group_id
+    t.string :name
   end
 
   create_table :groups do |t|
@@ -23,7 +25,14 @@ end
 Spec::Runner.configure do |config|
   config.before(:each) do
     class ::Group < ActiveRecord::Base
-
+      has_many :people
+      
+      named_scope :by_char, lambda { |char| 
+        { 
+          :conditions => ["name like ?", char + "%"],
+          :order => "name"
+        } 
+      }
     end
 
     class ::Person < ActiveRecord::Base

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Bogdan Gusiev
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-29 00:00:00 +03:00
+date: 2010-07-12 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,8 +58,11 @@ files:
 - Rakefile
 - Readme.textile
 - VERSION
+- accept_values_for.gemspec
 - lib/accept_values_for.rb
+- lib/discover.rb
 - spec/accept_values_for_spec.rb
+- spec/discover_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/bogdan/accept_values_for
@@ -92,5 +95,6 @@ signing_key:
 specification_version: 3
 summary: In order to test a complex validation for ActiveRecord models Implemented accept_values_for custom rspec matcher
 test_files: 
+- spec/discover_spec.rb
 - spec/accept_values_for_spec.rb
 - spec/spec_helper.rb