benhutton-remarkable_activerecord 4.0.0.alpha6

data/lib/remarkable/active_record/matchers/have_index_matcher.rb

@@ -0,0 +1,73 @@
+module Remarkable
+  module ActiveRecord
+    module Matchers
+      class HaveIndexMatcher < Remarkable::ActiveRecord::Base #:nodoc:
+        arguments :collection => :columns, :as => :column
+
+        optional :table_name
+        optional :unique, :default => true
+
+        collection_assertions :index_exists?, :is_unique?
+
+        protected
+
+          def index_exists?
+            !matched_index.nil?
+          end
+
+          def is_unique?
+            return true unless @options.key?(:unique)
+            return @options[:unique] == matched_index.unique, :actual => matched_index.unique
+          end
+
+          def matched_index
+            columns = [@column].flatten.map(&:to_s)
+            indexes.detect { |ind| ind.columns == columns }
+          end
+
+          def indexes
+            @indexes ||= ::ActiveRecord::Base.connection.indexes(current_table_name)
+          end
+
+          def interpolation_options
+            @subject ? { :table_name => current_table_name } : {}
+          end
+
+        private
+
+          def current_table_name
+            @options[:table_name] || subject_class.table_name
+          end
+
+      end
+
+      # Ensures the database column has specified index.
+      #
+      # == Options
+      #
+      # * <tt>unique</tt> - when supplied, tests if the index is unique or not
+      # * <tt>table_name</tt> - when supplied, tests if the index is defined for the given table
+      #
+      # == Examples
+      #
+      #   it { should have_index(:ssn).unique(true) }
+      #   it { should have_index([:name, :email]).unique(true) }
+      #
+      #   should_have_index :ssn, :unique => true, :limit => 9, :null => false
+      #
+      #   should_have_index :ssn do |m|
+      #     m.unique
+      #     m.limit = 9
+      #     m.null = false
+      #   end
+      #
+      def have_index(*args, &block)
+        HaveIndexMatcher.new(*args, &block).spec(self)
+      end
+      alias :have_indices    :have_index
+      alias :have_db_index   :have_index
+      alias :have_db_indices :have_index
+
+    end
+  end
+end

data/lib/remarkable/active_record/matchers/have_readonly_attributes_matcher.rb

@@ -0,0 +1,30 @@
+module Remarkable
+  module ActiveRecord
+    module Matchers
+      class HaveReadonlyAttributesMatcher < Remarkable::ActiveRecord::Base #:nodoc:
+        arguments :collection => :attributes, :as => :attribute
+        collection_assertions :is_readonly?
+
+        private
+
+          def is_readonly?
+            readonly = subject_class.readonly_attributes || []
+            return readonly.include?(@attribute.to_s), :actual => readonly.to_a.inspect
+          end
+      end
+
+      # Ensures that the attribute cannot be changed once the record has been
+      # created.
+      #
+      # == Examples
+      #
+      #   it { should have_readonly_attributes(:password, :admin_flag) }
+      #
+      def have_readonly_attributes(*attributes, &block)
+        HaveReadonlyAttributesMatcher.new(*attributes, &block).spec(self)
+      end
+      alias :have_readonly_attribute :have_readonly_attributes
+
+    end
+  end
+end

data/lib/remarkable/active_record/matchers/have_scope_matcher.rb

@@ -0,0 +1,101 @@
+module Remarkable
+  module ActiveRecord
+    module Matchers
+      class HaveScopeMatcher < Remarkable::ActiveRecord::Base #:nodoc:
+        arguments :scope_name
+        assertions :is_scope?, :options_match?
+
+        optionals :with, :splat => true
+        
+        # Chained scopes taken from: http://m.onkey.org/2010/1/22/active-record-query-interface
+        optionals :where, :having, :select, :group, :order, :limit, :offset, :joins, :includes, :lock, :readonly, :from
+
+        protected
+
+          def is_scope?
+            @scope_object = if @options.key?(:with)
+              @options[:with] = [ @options[:with] ] unless Array === @options[:with]
+              subject_class.send(@scope_name, *@options[:with])
+            else
+              subject_class.send(@scope_name)
+            end
+
+            @scope_object.class == ::ActiveRecord::Relation && @scope_object.arel 
+          end
+
+          def options_match?
+            @options.empty? || @scope_object.arel.to_sql == arel(subject_class, @options.except(:with)).to_sql
+          end
+
+          def interpolation_options
+            { 
+              :options => (subject_class.respond_to?(:scoped) ? arel(subject_class, @options.except(:with)).to_sql : '{}'),
+              :actual  => (@scope_object ? @scope_object.arel.to_sql : '{}')
+            }
+          end
+
+        private
+          def arel(model, scopes = nil)
+            return model.scoped unless scopes
+            scopes.inject(model.scoped) do |chain, (cond, option)|
+              chain.send(cond, option)
+            end.arel
+          end
+
+      end
+
+      # Ensures that the model has a named scope that returns an Relation object capable
+      # of building into relational algebra. 
+      #
+      # == Options
+      #
+      # * <tt>with</tt> - Options to be sent to the named scope
+      #
+      # All options that the named scope would scope with Arel: 
+      # :where, :having, :select, :group, :order, :limit, :offset, :joins, :includes, :lock, :readonly, :from
+      #
+      # Matching is done by constructing the Arel objects and testing for equality.
+      #
+      # == Examples
+      # 
+      #   it { should have_scope(:visible, :where => {:visible => true}) }
+      #   it { should have_scope(:visible).where(:visible => true) }
+      #
+      # Passes for
+      #
+      #   scope :visible, where(:visible => true)
+      #
+      # Or for
+      #
+      #   scope :visible, lambda { where(:visible => true) }
+      #
+      # Or for
+      #
+      #   def self.visible
+      #     where(:visible => true)
+      #   end
+      #
+      #
+      # You can test lambdas or methods that return ActiveRecord#scoped calls by fixing
+      # a defined parameter.
+      #
+      #   it { should have_scope(:recent, :with => 5) }
+      #   it { should have_scope(:recent, :with => 1) }
+      #
+      # Passes for
+      #
+      #   scope :recent, lambda {|c| limit(c)}
+      #
+      # Or for
+      #
+      #   def self.recent(c)
+      #     limit(c)
+      #   end
+      #
+      def have_scope(*args, &block)
+        HaveScopeMatcher.new(*args, &block).spec(self)
+      end
+
+    end
+  end
+end

data/lib/remarkable/active_record/matchers/validate_associated_matcher.rb

@@ -0,0 +1,100 @@
+module Remarkable
+  module ActiveRecord
+    module Matchers
+      class ValidateAssociatedMatcher < Remarkable::ActiveRecord::Base #:nodoc:
+        arguments :collection => :associations, :as => :association, :block => true
+
+        optional :message
+        optional :builder, :block => true
+
+        collection_assertions :find_association?, :is_valid?
+        default_options :message => :invalid
+
+        protected
+
+          def find_association?
+            reflection = @subject.class.reflect_on_association(@association)
+
+            raise ScriptError, "Could not find association #{@association} on #{subject_class}." unless reflection
+
+            associated_object = if builder = @options[:builder] || @block
+              builder.call(@subject)
+            elsif [:belongs_to, :has_one].include?(reflection.macro)
+              @subject.send(:"build_#{@association}") rescue nil
+            else
+              @subject.send(@association).build rescue nil
+            end
+
+            raise ScriptError, "The association object #{@association} could not be built. You can give me " <<
+                               ":builder as option or a block which returns an association." unless associated_object
+
+            raise ScriptError, "The associated object #{@association} is not invalid. You can give me " <<
+                               ":builder as option or a block which returns an invalid association." if associated_object.valid?
+
+            return true
+          end
+
+          def is_valid?
+            return false if @subject.valid?
+
+            error_message_to_expect = error_message_from_model(@subject, @association, @options[:message])
+
+            assert_contains(@subject.errors[@association], error_message_to_expect)
+          end
+      end
+
+      # Ensures that the model is invalid if one of the associations given is
+      # invalid. It tries to build the association automatically. In has_one
+      # and belongs_to cases, it will build it like this:
+      #
+      #   @model.build_association
+      #   @project.build_manager
+      #
+      # In has_many and has_and_belongs_to_many to cases it will build it like
+      # this:
+      #
+      #   @model.association.build
+      #   @project.tasks.build
+      #
+      # The object returned MUST be invalid and it's likely the case, since the
+      # associated object is empty when calling build. However, if the associated
+      # object has to be manipulated to be invalid, you will have to give :builder
+      # as option or a block to manipulate it:
+      #
+      #   should_validate_associated(:tasks) do |project|
+      #     project.tasks.build(:captcha => 'i_am_a_bot')
+      #   end
+      #
+      # In the case above, the associated object task is only invalid when the
+      # captcha attribute is set. So we give a block to the matcher that tell
+      # exactly how to build an invalid object.
+      #
+      # The example above can also be written as:
+      #
+      #   should_validate_associated :tasks, :builder => proc{ |p| p.tasks.build(:captcha => 'i_am_a_bot') }
+      #
+      # == Options
+      #
+      # * <tt>:builder</tt> - a proc to build the association
+      #
+      # * <tt>:message</tt> - value the test expects to find in <tt>errors[:attribute]</tt>.
+      #   Regexp, string or symbol.  Default = <tt>I18n.translate('activerecord.errors.messages.invalid')</tt>
+      #
+      # == Examples
+      #
+      #   should_validate_associated :tasks
+      #   should_validate_associated :tasks, :builder => proc{ |p| p.tasks.build(:captcha => 'i_am_a_bot') }
+      #
+      #   should_validate_associated :tasks do |m|
+      #     m.builder { |p| p.tasks.build(:captcha => 'i_am_a_bot') }
+      #   end
+      #
+      #   it { should validate_associated(:tasks) }
+      #   it { should validate_associated(:tasks, :builder => proc{ |p| p.tasks.build(:captcha => 'i_am_a_bot') }) }
+      #
+      def validate_associated(*args, &block)
+        ValidateAssociatedMatcher.new(*args, &block).spec(self)
+      end
+    end
+  end
+end

data/lib/remarkable/active_record/matchers/validate_uniqueness_of_matcher.rb

@@ -0,0 +1,233 @@
+module Remarkable
+  module ActiveRecord
+    module Matchers
+      class ValidateUniquenessOfMatcher < Remarkable::ActiveRecord::Base #:nodoc:
+        arguments :collection => :attributes, :as => :attribute
+
+        optional :message
+        optional :scope, :splat => true
+        optional :case_sensitive, :allow_nil, :allow_blank, :default => true
+
+        collection_assertions :find_first_object?, :responds_to_scope?, :is_unique?, :case_sensitive?,
+                              :valid_with_new_scope?, :allow_nil?, :allow_blank?
+
+        default_options :message => :taken
+
+        before_assert do
+          @options[:scope] = [*@options[:scope]].compact if @options[:scope]
+        end
+
+        private
+
+          # Tries to find an object in the database. If allow_nil and/or allow_blank
+          # is given, we must find a record which is not nil or not blank.
+          #
+          # We should also ensure that the object retrieved from the database
+          # is not the @subject.
+          #
+          # If any of these attempts fail, an error is raised.
+          #
+          def find_first_object?
+            conditions, message = if @options[:allow_nil]
+              [ ["#{@attribute} IS NOT NULL"], " with #{@attribute} not nil" ]
+            elsif @options[:allow_blank]
+              [ ["#{@attribute} != ''"], " with #{@attribute} not blank" ]
+            else
+              [ [], "" ]
+            end
+
+            unless @subject.new_record?
+              primary_key = subject_class.primary_key
+
+              message    << " which is different from the subject record (the object being validated is the same as the one in the database)"
+              conditions << "#{subject_class.primary_key} != '#{@subject.send(primary_key)}'"
+            end
+
+            options = conditions.empty? ? {} : { :conditions => conditions.join(' AND ') }
+
+            return true if @existing = subject_class.find(:first, options)
+            raise ScriptError, "could not find a #{subject_class} record in the database" + message
+          end
+
+          # Set subject scope to be equal to the object found.
+          #
+          def responds_to_scope?
+            (@options[:scope] || []).each do |scope|
+              setter = :"#{scope}="
+
+              return false, :method => setter unless @subject.respond_to?(setter)
+              return false, :method => scope  unless @existing.respond_to?(scope)
+
+              @subject.send(setter, @existing.send(scope))
+            end
+            true
+          end
+
+          # Check if the attribute given is valid and if the validation fails for equal values.
+          #
+          def is_unique?
+            @value = @existing.send(@attribute)
+            return bad?(@value)
+          end
+
+          # If :case_sensitive is given and it's false, we swap the case of the
+          # value used in :is_unique? and see if the test object remains valid.
+          #
+          # If :case_sensitive is given and it's true, we swap the case of the
+          # value used in is_unique? and see if the test object is not valid.
+          #
+          # This validation will only occur if the test object is a String.
+          # 
+          def case_sensitive?
+            return true unless @value.is_a?(String)
+            assert_good_or_bad_if_key(:case_sensitive, @value.swapcase)
+          end
+
+          # Now test that the object is valid when changing the scoped attribute.
+          #
+          def valid_with_new_scope?
+            (@options[:scope] || []).each do |scope|
+              setter = :"#{scope}="
+
+              previous_scope_value = @subject.send(scope)
+              @subject.send(setter, new_value_for_scope(scope))
+              return false, :method => scope unless good?(@value)
+
+              @subject.send(setter, previous_scope_value)
+            end
+            true
+          end
+
+          # Change the existing object attribute to nil to run allow nil
+          # validations. If we find any problem while updating the @existing
+          # record, it's because we can't save nil values in the database. So it
+          # passes when :allow_nil is false, but should raise an error when
+          # :allow_nil is true
+          #
+          def allow_nil?
+            return true unless @options.key?(:allow_nil)
+
+            begin
+              @existing.update_attribute(@attribute, nil)
+            rescue ::ActiveRecord::StatementInvalid => e
+              raise ScriptError, "You declared that #{@attribute} accepts nil values in validate_uniqueness_of, " <<
+                                 "but I cannot save nil values in the database, got: #{e.message}" if @options[:allow_nil]
+              return true
+            end
+
+            super
+          end
+
+          # Change the existing object attribute to blank to run allow blank
+          # validation. It uses the same logic as :allow_nil.
+          #
+          def allow_blank?
+            return true unless @options.key?(:allow_blank)
+
+            begin
+              @existing.update_attribute(@attribute, '')
+            rescue ::ActiveRecord::StatementInvalid => e
+              raise ScriptError, "You declared that #{@attribute} accepts blank values in validate_uniqueness_of, " <<
+                                 "but I cannot save blank values in the database, got: #{e.message}" if @options[:allow_blank]
+              return true
+            end
+
+            super
+          end
+
+          # Returns a value to be used as new scope. It deals with four different
+          # cases: date, time, boolean and stringfiable (everything that can be
+          # converted to a string and the next value makes sense)
+          #
+          def new_value_for_scope(scope)
+            column_type = if @existing.respond_to?(:column_for_attribute)
+              @existing.column_for_attribute(scope)
+            else
+              nil
+            end
+
+            case column_type.type
+              when :int, :integer, :float, :decimal
+                new_value_for_stringfiable_scope(scope)
+              when :datetime, :timestamp, :time
+                Time.now + 10000
+              when :date
+                Date.today + 100
+              when :boolean
+                !@existing.send(scope)
+              else
+                new_value_for_stringfiable_scope(scope)
+            end
+          end
+
+          # Returns a value to be used as scope by generating a range of values
+          # and searching for them in the database.
+          #
+          def new_value_for_stringfiable_scope(scope)
+            values = [(@existing.send(scope) || 999).next.to_s]
+
+            # Generate a range of values to search in the database
+            100.times do
+              values << values.last.next
+            end
+            conditions = { scope => values, @attribute => @value }
+
+            # Get values from the database, get the scope attribute and map them to string.
+            db_values = subject_class.find(:all, :conditions => conditions, :select => scope)
+            db_values.map!{ |r| r.send(scope).to_s }
+
+            if value_to_return = (values - db_values).first
+              value_to_return
+            else
+              raise ScriptError, "Tried to find an unique scope value for #{scope} but I could not. " << 
+                                 "The conditions hash was #{conditions.inspect} and it returned all records."
+            end
+          end
+      end
+
+      # Ensures that the model cannot be saved if one of the attributes listed
+      # is not unique.
+      #
+      # Requires an existing record in the database. If you supply :allow_nil as
+      # option, you need to have in the database a record which is not nil in the
+      # given attributes. The same is required for allow_blank option.
+      #
+      # Notice that the record being validate should not be the same as in the
+      # database. In other words, you can't do this:
+      #
+      #   subject { Post.create!(@valid_attributes) }
+      #   should_validate_uniqueness_of :title
+      #
+      # But don't worry, if you eventually do that, a helpful error message
+      # will be raised.
+      #
+      # == Options
+      #
+      # * <tt>:scope</tt> - field(s) to scope the uniqueness to.
+      # * <tt>:case_sensitive</tt> - the matcher look for an exact match.
+      # * <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[:attribute]</tt>.
+      #   Regexp, string or symbol.  Default = <tt>I18n.translate('activerecord.errors.messages.taken')</tt>
+      #
+      # == Examples
+      #
+      #   it { should validate_uniqueness_of(:keyword, :username) }
+      #   it { should validate_uniqueness_of(:email, :scope => :name, :case_sensitive => false) }
+      #   it { should validate_uniqueness_of(:address, :scope => [:first_name, :last_name]) }
+      #
+      #   should_validate_uniqueness_of :keyword, :username
+      #   should_validate_uniqueness_of :email, :scope => :name, :case_sensitive => false
+      #   should_validate_uniqueness_of :address, :scope => [:first_name, :last_name]
+      #
+      #   should_validate_uniqueness_of :email do |m|
+      #     m.scope = name
+      #     m.case_sensitive = false
+      #   end
+      #
+      def validate_uniqueness_of(*attributes, &block)
+        ValidateUniquenessOfMatcher.new(*attributes, &block).spec(self)
+      end
+    end
+  end
+end