yeastymobs-remarkable_mongomapper 0.1.0 → 0.1.1

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'rake'
+require 'spec/rake/spectask'
 
 begin
   require 'jeweler'
@@ -15,4 +16,13 @@ begin
   end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run all the specs for the machinist plugin.'
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = false
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/remarkable_mongomapper/base.rb

@@ -104,7 +104,6 @@ module Remarkable
 
           return true if model.valid?
           
-          # FIXME
           error_message_to_avoid = error_message_from_model(model, attribute, error_message_to_avoid)
           assert_does_not_contain(model.errors.on(attribute), error_message_to_avoid)
         end
@@ -131,7 +130,6 @@ module Remarkable
 
           return false if model.valid? || model.errors.on(attribute).blank?
           
-          # FIXME
           error_message_to_expect = error_message_from_model(model, attribute, error_message_to_expect)
           assert_contains(model.errors.on(attribute), error_message_to_expect)
         end

data/lib/remarkable_mongomapper/describe.rb

@@ -0,0 +1,199 @@
+module Remarkable
+  module ActiveRecord
+
+    def self.after_include(target) #:nodoc:
+      target.class_inheritable_reader :describe_subject_attributes, :default_subject_attributes
+      target.send :include, Describe
+    end
+
+    # Overwrites describe to provide quick way to configure your subject:
+    #
+    #   describe Post
+    #     should_validate_presente_of :title
+    #
+    #     describe :published => true do
+    #       should_validate_presence_of :published_at
+    #     end
+    #   end
+    #
+    # This is the same as:
+    #
+    #   describe Post
+    #     should_validate_presente_of :title
+    #
+    #     describe "when published is true" do
+    #       subject { Post.new(:published => true) }
+    #       should_validate_presence_of :published_at
+    #     end
+    #   end
+    #
+    # The string can be localized using I18n. An example yml file is:
+    #
+    #   locale:
+    #     remarkable:
+    #       mongo_mapper:
+    #         describe:
+    #           each: "{{key}} is {{value}}"
+    #           prepend: "when "
+    #           connector: " and "
+    #
+    # You can also call subject attributes to set the default attributes for a
+    # subject. You can even mix with a fixture replacement tool:
+    #
+    #   describe Post
+    #     # Fixjour example
+    #     subject_attributes { valid_post_attributes }
+    #
+    #     describe :published => true do
+    #       should_validate_presence_of :published_at
+    #     end
+    #   end
+    #
+    # You can retrieve the merged result of all attributes given using the
+    # subject_attributes instance method:
+    #
+    #   describe Post
+    #     # Fixjour example
+    #     subject_attributes { valid_post_attributes }
+    #
+    #     describe :published => true do
+    #       it "should have default subject attributes" do
+    #         subject_attributes.should == { :title => 'My title', :published => true }
+    #       end
+    #     end
+    #   end
+    #
+    module Describe
+
+      def self.included(base) #:nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+
+        # Overwrites describe to provide quick way to configure your subject:
+        #
+        #   describe Post
+        #     should_validate_presente_of :title
+        #
+        #     describe :published => true do
+        #       should_validate_presence_of :published_at
+        #     end
+        #   end
+        #
+        # This is the same as:
+        #
+        #   describe Post
+        #     should_validate_presente_of :title
+        #
+        #     describe "when published is true" do
+        #       subject { Post.new(:published => true) }
+        #       should_validate_presence_of :published_at
+        #     end
+        #   end
+        #
+        # The string can be localized using I18n. An example yml file is:
+        #
+        #   locale:
+        #     remarkable:
+        #       mongo_mapper:
+        #         describe:
+        #           each: "{{key}} is {{value}}"
+        #           prepend: "when "
+        #           connector: " and "
+        #
+        # See also subject_attributes instance and class methods for more
+        # information.
+        #
+        def describe(*args, &block)
+          if described_class && args.first.is_a?(Hash)
+            attributes = args.shift
+
+            connector = Remarkable.t "remarkable.mongo_mapper.describe.connector", :default => " and "
+
+            description = if self.describe_subject_attributes.blank?
+              Remarkable.t("remarkable.mongo_mapper.describe.prepend", :default => "when ")
+            else
+              connector.lstrip
+            end
+
+            pieces = []
+            attributes.each do |key, value|
+              translated_key = if described_class.respond_to?(:human_attribute_name)
+                described_class.human_attribute_name(key.to_s, :locale => Remarkable.locale)
+              else
+                key.to_s.humanize
+              end
+
+              pieces << Remarkable.t("remarkable.mongo_mapper.describe.each",
+                                      :default => "{{key}} is {{value}}",
+                                      :key => translated_key.downcase, :value => value.inspect)
+            end
+
+            description << pieces.join(connector)
+            args.unshift(description)
+
+            # Creates an example group, set the subject and eval the given block.
+            #
+            example_group = super(*args) do
+              write_inheritable_hash(:describe_subject_attributes, attributes)
+              set_described_subject!
+              instance_eval(&block)
+            end
+          else
+            super(*args, &block)
+          end
+        end
+
+        # Sets default attributes for the subject. You can use this to set up
+        # your subject with valid attributes. You can even mix with a fixture
+        # replacement tool and still use quick subjects:
+        #
+        #   describe Post
+        #     # Fixjour example
+        #     subject_attributes { valid_post_attributes }
+        #
+        #     describe :published => true do
+        #       should_validate_presence_of :published_at
+        #     end
+        #   end
+        #
+        def subject_attributes(options=nil, &block)
+          write_inheritable_attribute(:default_subject_attributes, options || block)
+          set_described_subject!
+        end
+
+        def set_described_subject!
+          subject {
+            record = self.class.described_class.new
+            record.send(:attributes=, subject_attributes, false)
+            record
+          }
+        end
+      end
+
+      # Returns a hash with the subject attributes declared using the
+      # subject_attributes class method and the attributes given using the
+      # describe method.
+      #
+      #   describe Post
+      #     subject_attributes { valid_post_attributes }
+      #
+      #     describe :published => true do
+      #       it "should have default subject attributes" do
+      #         subject_attributes.should == { :title => 'My title', :published => true }
+      #       end
+      #     end
+      #   end
+      #
+      def subject_attributes
+        default = self.class.default_subject_attributes
+        default = self.instance_eval(&default) if default.is_a?(Proc)
+        default ||= {}
+
+        default.merge(self.class.describe_subject_attributes || {})
+      end
+
+    end
+  end
+end

data/lib/remarkable_mongomapper/human_names.rb

@@ -0,0 +1,37 @@
+if defined?(Spec)
+  module Spec #:nodoc:
+    module Example #:nodoc:
+      module ExampleGroupMethods #:nodoc:
+
+        # This allows "describe User" to use the I18n human name of User.
+        #
+        def self.build_description_with_i18n(*args)
+          args.inject("") do |description, arg|
+            arg = if arg.respond_to?(:human_name)
+              arg.human_name(:locale => Remarkable.locale)
+            else
+              arg.to_s
+            end
+
+            description << " " unless (description == "" || arg =~ /^(\s|\.|#)/)
+            description << arg
+          end
+        end
+
+        # This is for rspec <= 1.1.12.
+        #
+        def self.description_text(*args)
+          self.build_description_with_i18n(*args)
+        end
+
+        # This is for rspec >= 1.2.0.
+        #
+        def self.build_description_from(*args)
+          text = ExampleGroupMethods.build_description_with_i18n(*args)
+          text == "" ? nil : text
+        end
+
+      end
+    end
+  end
+end

data/lib/remarkable_mongomapper/matchers/allow_values_for_matcher.rb

@@ -0,0 +1,86 @@
+module Remarkable
+  module MongoMapper
+    module Matchers
+      class AllowValuesForMatcher < Remarkable::MongoMapper::Base #:nodoc:
+        include Remarkable::Negative
+        arguments :collection => :attributes, :as => :attribute
+
+        optional :message
+        optional :in, :splat => true
+        optional :allow_nil, :allow_blank, :default => true
+
+        collection_assertions :is_valid?, :is_invalid?, :allow_nil?, :allow_blank?
+
+        default_options :message => "is invalid"
+
+        before_assert do
+          first_value = @options[:in].is_a?(Array) ? @options[:in].first : @options[:in]
+          @in_range = first_value.is_a?(Range)
+
+          @options[:in] = if @in_range
+            first_value.to_a[0,2] + first_value.to_a[-2,2]
+          else
+            [*@options[:in]].compact
+          end
+
+          @options[:in].uniq!
+        end
+
+        protected
+
+          def is_valid?
+            assert_collection :value, valid_values do |value|
+              good?(value)
+            end
+          end
+
+          def is_invalid?
+            assert_collection :value, invalid_values do |value|
+              bad?(value)
+            end
+          end
+
+          def valid_values
+            @options[:in]
+          end
+
+          def invalid_values
+            []
+          end
+
+          def interpolation_options
+            options = if @in_range
+              { :in => (@options[:in].first..@options[:in].last).inspect }
+            elsif @options[:in].is_a?(Array)
+              { :in => array_to_sentence(@options[:in], true, '[]') }
+            else
+              { :in => @options[:in].inspect }
+            end
+
+            options.merge!(:behavior => @behavior.to_s)
+          end
+
+      end
+
+      # Ensures that the attribute can be set to the given values.
+      #
+      # == Options
+      #
+      # * <tt>:allow_nil</tt> - when supplied, validates if it allows nil or not.
+      # * <tt>:allow_blank</tt> - when supplied, validates if it allows blank or not.
+      # * <tt>:message</tt> - value the test expects to find in <tt>errors.on(:attribute)</tt>.
+      #   Regexp, string or symbol.  Default = <tt>I18n.translate('activerecord.errors.messages.invalid')</tt>
+      #
+      # == Examples
+      #
+      #   should_allow_values_for :isbn, "isbn 1 2345 6789 0", "ISBN 1-2345-6789-0"
+      #   it { should allow_values_for(:isbn, "isbn 1 2345 6789 0", "ISBN 1-2345-6789-0") }
+      #
+      def allow_values_for(attribute, *args, &block)
+        options = args.extract_options!
+        AllowValuesForMatcher.new(attribute, options.merge!(:in => args), &block).spec(self)
+      end
+
+    end
+  end
+end

data/lib/remarkable_mongomapper/matchers/validate_presence_of_matcher.rb

@@ -2,7 +2,6 @@ module Remarkable
   module MongoMapper
     module Matchers
       class ValidatePresenceOfMatcher < Remarkable::MongoMapper::Base
-        
         arguments :collection => :attributes, :as => :attribute
         optional  :message
 
@@ -19,6 +18,10 @@ module Remarkable
       
       # Ensures that the model cannot be saved if one of the attributes listed is not present.
       #
+      # == Options
+      #
+      # * <tt>:message</tt> - value the test expects to find in <tt>errors.on(:attribute)</tt>.
+      #   Regexp, string or symbol. Default = "can't be empty"
       #
       # == Examples
       #

data/lib/remarkable_mongomapper.rb

@@ -14,7 +14,9 @@ dir = File.dirname(__FILE__)
 Remarkable.add_locale File.join(dir, '..', 'locales', 'en.yml')
 
 require File.join(dir, 'remarkable_mongomapper', 'base')
- 
+require File.join(dir, 'remarkable_mongomapper', 'describe')
+# require File.join(dir, 'remarkable_mongomapper', 'human_names')
+
 # Add matchers
 Dir[File.join(dir, 'remarkable_mongomapper', 'matchers', '*.rb')].each do |file|
   require file

data/locales/en.yml

@@ -1,6 +1,26 @@
 en:
   remarkable:
     mongo_mapper:
+      describe:
+        each: "{{key}} is {{value}}"
+        prepend: "when "
+        connector: " and "
+      expectations:
+        allow_nil: "{{subject_name}} to {{not}}allow nil values for {{attribute}}"
+        allow_blank: "{{subject_name}} to {{not}}allow blank values for {{attribute}}"
+      optionals:
+        allow_nil:
+          positive: "allowing nil values"
+          negative: "not allowing nil values"
+        allow_blank:
+          positive: "allowing blank values"
+          negative: "not allowing blank values"
+      
+      allow_values_for:
+        description: "allow {{in}} as values for {{attributes}}"
+        expectations:
+          is_valid: "{{subject_name}} to be valid when {{attribute}} is set to {{value}}"
+          
       association:
         many: have many
         belongs_to: belong to
@@ -12,7 +32,7 @@ en:
           options_match: "{{subject_name}} records {{type}} {{association}} with options {{options}}, got {{actual}}"
           
       have_key:
-        description: "have key(s) {{attributes}}"
+        description: "have key(s) {{attributes}} with type {{type}}"
         expectations:
           has_key: "{{subject_name}} to have key named {{attribute}} with type {{type}}"
 

data/remarkable_mongomapper.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{remarkable_mongomapper}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nicolas M\303\251rouze", "Vincent Hellot", "Mathieu Fosse"]
-  s.date = %q{2009-07-29}
+  s.date = %q{2009-07-31}
   s.email = %q{dev@yeastymobs.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -20,14 +20,19 @@ Gem::Specification.new do |s|
      "VERSION",
      "lib/remarkable_mongomapper.rb",
      "lib/remarkable_mongomapper/base.rb",
+     "lib/remarkable_mongomapper/describe.rb",
+     "lib/remarkable_mongomapper/human_names.rb",
+     "lib/remarkable_mongomapper/matchers/allow_values_for_matcher.rb",
      "lib/remarkable_mongomapper/matchers/association_matcher.rb",
      "lib/remarkable_mongomapper/matchers/have_key_matcher.rb",
      "lib/remarkable_mongomapper/matchers/validate_presence_of_matcher.rb",
      "locales/en.yml",
      "remarkable_mongomapper.gemspec",
+     "spec/matchers/allow_values_for_matcher_spec.rb",
      "spec/matchers/association_matcher_spec.rb",
      "spec/matchers/have_key_matcher_spec.rb",
      "spec/matchers/validate_presence_of_matcher_spec.rb",
+     "spec/model_builder.rb",
      "spec/models.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -38,9 +43,11 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{MongoMapper Remarkable Matchers}
   s.test_files = [
-    "spec/matchers/association_matcher_spec.rb",
+    "spec/matchers/allow_values_for_matcher_spec.rb",
+     "spec/matchers/association_matcher_spec.rb",
      "spec/matchers/have_key_matcher_spec.rb",
      "spec/matchers/validate_presence_of_matcher_spec.rb",
+     "spec/model_builder.rb",
      "spec/models.rb",
      "spec/spec_helper.rb"
   ]

data/spec/matchers/allow_values_for_matcher_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe 'allow_values_for' do
+  include ModelBuilder
+
+  # Defines a model, create a validation and returns a raw matcher
+  def define_and_validate(options={})
+    @model = define_model :product do
+      include MongoMapper::Document
+      
+      key :title, String
+      key :category, String
+      
+      validates_format_of :title, options
+    end
+
+    allow_values_for(:title)
+  end
+
+  describe 'messages' do
+    before(:each){ @matcher = define_and_validate(:with => /X|Y|Z/) }
+
+    it 'should contain a description' do
+      @matcher = allow_values_for(:title, "X", "Y", "Z")
+      @matcher.description.should == 'allow "X", "Y", and "Z" as values for title'
+    end
+
+    it 'should set is_valid? message' do
+      @matcher.in("A").matches?(subject)
+      @matcher.failure_message.should == 'Expected Product to be valid when title is set to "A"'
+    end
+
+    it 'should set allow_nil? message' do
+      @matcher.allow_nil.matches?(subject)
+      @matcher.failure_message.should == 'Expected Product to allow nil values for title'
+    end
+
+    it 'should set allow_blank? message' do
+      @matcher.allow_blank.matches?(subject)
+      @matcher.failure_message.should == 'Expected Product to allow blank values for title'
+    end
+  end
+
+  describe 'matchers' do
+    it { should define_and_validate(:with => /X|Y|Z/).in('X', 'Y', 'Z') }
+    it { should_not define_and_validate(:with => /X|Y|Z/).in('A') }
+  
+    it { should define_and_validate(:with => /X|Y|Z/, :message => 'valid').in('X', 'Y', 'Z').message('valid') }
+  
+    create_optional_boolean_specs(:allow_nil, self, :with => /X|Y|Z/)
+    create_optional_boolean_specs(:allow_blank, self, :with => /X|Y|Z/)
+  end
+  
+  describe 'macros' do
+    before(:each){ define_and_validate(:with => /X|Y|Z/) }
+    
+    should_allow_values_for :title, 'X'
+    should_not_allow_values_for :title, 'A'
+  end
+  
+  describe 'failures' do
+    it "should fail if any of the values are valid on invalid cases" do
+      define_and_validate(:with => /X|Y|Z/)
+      
+      lambda {
+        should_not allow_values_for(:title, 'A', 'X', 'B')
+      }.should raise_error(Spec::Expectations::ExpectationNotMetError, /Did not expect Product to be valid/)
+    end
+  end
+end
+

data/spec/matchers/have_key_matcher_spec.rb

@@ -9,7 +9,7 @@ describe 'have_key' do
 
     it 'should contain a description' do
       matcher = have_key(:title, String)
-      matcher.description.should == 'have key(s) title'
+      matcher.description.should == 'have key(s) title with type String'
     end
 
     it 'should set has_key? message' do

data/spec/model_builder.rb

@@ -0,0 +1,64 @@
+# This is based on Shoulda model builder for Test::Unit.
+#
+module ModelBuilder
+  def self.included(base)
+    return unless base.name =~ /^Spec/
+
+    base.class_eval do
+      after(:each) do
+        if @defined_constants
+          @defined_constants.each do |class_name| 
+            Object.send(:remove_const, class_name)
+          end
+        end
+      end
+    end
+
+    base.extend ClassMethods
+  end
+
+  def define_constant(class_name, &block)
+    class_name = class_name.to_s.camelize
+
+    klass = Class.new
+    Object.const_set(class_name, klass)
+
+    klass.class_eval(&block) if block_given?
+
+    @defined_constants ||= []
+    @defined_constants << class_name
+
+    klass
+  end
+
+  def define_model(name, columns = {}, &block)
+    instance = define_constant(name.to_s.classify, &block).new
+
+    self.class.subject { instance } if self.class.respond_to?(:subject)
+    instance
+  end
+
+  module ClassMethods
+    # This is a macro to run validations of boolean optionals such as :allow_nil
+    # and :allow_blank. This macro tests all scenarios. The specs must have a
+    # define_and_validate method defined.
+    #
+    def create_optional_boolean_specs(optional, base, options={})
+      base.describe "with #{optional} option" do
+        it { should define_and_validate(options.merge(optional => true)).send(optional)            }
+        it { should define_and_validate(options.merge(optional => false)).send(optional, false)    }
+        it { should_not define_and_validate(options.merge(optional => true)).send(optional, false) }
+        it { should_not define_and_validate(options.merge(optional => false)).send(optional)       }
+      end
+    end
+
+    def create_message_specs(base)
+      base.describe "with message option" do
+        it { should define_and_validate(:message => 'valid_message').message('valid_message') }
+        it { should_not define_and_validate(:message => 'not_valid').message('valid_message') }
+      end
+    end
+  end
+
+end
+

data/spec/models.rb

@@ -34,7 +34,7 @@ class Rating
 end
 
 class Site
-  include MongoMapper::EmbeddedDocument
+  include MongoMapper::Document
 end
 
 class Webiste

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require "rubygems"
 
-gem "mongomapper", "~> 0.2.0"
+gem "mongomapper", "~> 0.3.1"
 require "mongomapper"
 
 MongoMapper.database = "remarkable_mongomapper"
@@ -15,4 +15,5 @@ Spec::Runner.configure do |config|
 end
 
 require File.join(File.dirname(__FILE__), "..", "lib", "remarkable_mongomapper")
-require File.join(File.dirname(__FILE__), "models")
+require File.join(File.dirname(__FILE__), "models")
+require File.join(File.dirname(__FILE__), "model_builder")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yeastymobs-remarkable_mongomapper
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - "Nicolas M\xC3\xA9rouze"
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-29 00:00:00 -07:00
+date: 2009-07-31 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,14 +51,19 @@ files:
 - VERSION
 - lib/remarkable_mongomapper.rb
 - lib/remarkable_mongomapper/base.rb
+- lib/remarkable_mongomapper/describe.rb
+- lib/remarkable_mongomapper/human_names.rb
+- lib/remarkable_mongomapper/matchers/allow_values_for_matcher.rb
 - lib/remarkable_mongomapper/matchers/association_matcher.rb
 - lib/remarkable_mongomapper/matchers/have_key_matcher.rb
 - lib/remarkable_mongomapper/matchers/validate_presence_of_matcher.rb
 - locales/en.yml
 - remarkable_mongomapper.gemspec
+- spec/matchers/allow_values_for_matcher_spec.rb
 - spec/matchers/association_matcher_spec.rb
 - spec/matchers/have_key_matcher_spec.rb
 - spec/matchers/validate_presence_of_matcher_spec.rb
+- spec/model_builder.rb
 - spec/models.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -90,8 +95,10 @@ signing_key:
 specification_version: 3
 summary: MongoMapper Remarkable Matchers
 test_files: 
+- spec/matchers/allow_values_for_matcher_spec.rb
 - spec/matchers/association_matcher_spec.rb
 - spec/matchers/have_key_matcher_spec.rb
 - spec/matchers/validate_presence_of_matcher_spec.rb
+- spec/model_builder.rb
 - spec/models.rb
 - spec/spec_helper.rb