remarkable_activerecord 3.0.0 → 3.0.1

data/README

@@ -1,2 +1,82 @@
-Remarkable ActiveRecord
-=======================
+= Remarkable ActiveRecord
+
+Remarkable ActiveRecord is a collection of matchers to ActiveRecord. Why use
+Remarkable?
+
+* The only one with matchers for all ActiveRecord validations, with support to
+  all options;
+
+* Matchers for all ActiveRecord associations. The only one which supports all
+  these options:
+
+    :through, :class_name, :foreign_key, :dependent, :join_table, :uniq,
+    :readonly, :validate, :autosave, :counter_cache, :polymorphic
+
+  Besides in Remarkable 3.0 matchers became much smarter. Whenever :join_table
+  or :through is given as option, it checks if the given table exists. Whenever
+  :foreign_key or :counter_cache is given, it checks if the given column exists;
+
+* Tests and more tests. We have a huge tests suite ready to run and tested in
+  ActiveRecord 2.1.2, 2.2.2 and 2.3.2;
+
+* Great documentation;
+
+* I18n.
+
+== Examples
+
+All Remarkable macros can be accessed in two different ways. For those who prefer the Shoulda style, let’s look at some model tests:
+
+  describe Post do
+    should_belong_to :user
+    should_have_many :comments
+    should_have_and_belong_to_many :tags
+
+    should_validate_presence_of :body
+    should_validate_presence_of :title
+    should_validate_uniqueness_of :title, :allow_blank => true
+  end
+
+For those who likes more the Rspec way can simply do:
+
+  describe Post do
+    it { should belong_to(:user) }
+    it { should have_many(:comments) }
+    it { should have_and_belong_to_many(:tags) }
+
+    it { should validate_presence_of(:body) }
+    it { should validate_presence_of(:title) }
+    it { should validate_uniqueness_of(:title, :allow_blank => true) }
+  end
+
+== I18n
+
+All matchers come with I18n support. If you want to translate your matchers,
+grab make a copy of locale/en.yml and start to translate it.
+
+Then add your new locale file to Remarkable:
+
+  Remarkable.add_locale 'path/to/my_locale.yml'
+
+And then:
+
+  Remarkable.locale = :my_locale
+
+== Using it outside Rails
+
+If you want to use Remarkable ActiveRecord outside Rails, you have to remember
+a few things:
+
+  1. Internationalization is powered by the I18n gem. If you are using it with Rails,
+     it will use the built in gem, otherwise you will have to install the gem by hand:
+
+        gem sources -a http://gems.github.com
+        sudo gem install svenfuchs-i18n
+
+  2. Include the matchers. Remarkable Rails gem is the responsable to add
+     ActiveRecord matchers to rspec. If you are not using it, you have to do:
+
+        Remarkable.include_matchers!(Remarkable::ActiveRecord, Spec::Example::ExampleGroup)
+
+     This will make ActiveRecord matchers available in all rspec example groups.
+

data/lib/remarkable_activerecord/base.rb

@@ -2,6 +2,14 @@ module Remarkable
   module ActiveRecord
     class Base < Remarkable::Base
 
+      # Provides a way to send options to all ActiveRecord matchers.
+      #
+      #   validates_presence_of(:name).with_options(:allow_nil => false)
+      #
+      # Is equivalent to:
+      #
+      #   validates_presence_of(:name, :allow_nil => false)
+      #
       def with_options(opts={})
         @options.merge!(opts)
         self
@@ -205,7 +213,7 @@ module Remarkable
         # Changes how collection are interpolated to provide localized names
         # whenever is possible.
         #
-        def collection_interpolation
+        def collection_interpolation #:nodoc:
           described_class = if @subject
             subject_class
           elsif @spec

data/lib/remarkable_activerecord/human_names.rb

@@ -1,7 +1,7 @@
 if defined?(Spec)
-  module Spec
-    module Example
-      module ExampleGroupMethods
+  module Spec #:nodoc:
+    module Example #:nodoc:
+      module ExampleGroupMethods #:nodoc:
 
         # This allows "describe User" to use the I18n human name of User.
         #

data/lib/remarkable_activerecord/matchers/allow_mass_assignment_of_matcher.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class AllowMassAssignmentOfMatcher < Remarkable::ActiveRecord::Base
+      class AllowMassAssignmentOfMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :attributes, :as => :attribute
 
         collection_assertions :is_protected?, :is_accessible?

data/lib/remarkable_activerecord/matchers/allow_values_for_matcher.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class AllowValuesForMatcher < Remarkable::ActiveRecord::Base
+      class AllowValuesForMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :attributes, :as => :attribute
 
         optional :message

data/lib/remarkable_activerecord/matchers/association_matcher.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class AssociationMatcher < Remarkable::ActiveRecord::Base
+      class AssociationMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :macro, :collection => :associations, :as => :association
 
         optionals :through, :class_name, :foreign_key, :dependent, :join_table, :as

data/lib/remarkable_activerecord/matchers/have_column_matcher.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class HaveColumnMatcher < Remarkable::ActiveRecord::Base
+      class HaveColumnMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :columns, :as => :column
 
         optional :type, :default, :precision, :limit, :scale, :sql_type

data/lib/remarkable_activerecord/matchers/have_index_matcher.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class HaveIndexMatcher < Remarkable::ActiveRecord::Base
+      class HaveIndexMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :columns, :as => :column
 
         optional :unique, :default => true

data/lib/remarkable_activerecord/matchers/have_readonly_attributes_matcher.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class HaveReadonlyAttributesMatcher < Remarkable::ActiveRecord::Base
+      class HaveReadonlyAttributesMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :attributes, :as => :attribute
         collection_assertions :is_readonly?
 

data/lib/remarkable_activerecord/matchers/have_scope_matcher.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class HaveScopeMatcher < Remarkable::ActiveRecord::Base
+      class HaveScopeMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :scope_name
         assertions :is_scope?, :options_match?
 

data/lib/remarkable_activerecord/matchers/validate_acceptance_of_matcher.rb

@@ -1,8 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class ValidateAcceptanceOfMatcher < Remarkable::ActiveRecord::Base
-
+      class ValidateAcceptanceOfMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :attributes, :as => :attribute
 
         optional :accept, :message

data/lib/remarkable_activerecord/matchers/validate_associated_matcher.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class ValidateAssociatedMatcher < Remarkable::ActiveRecord::Base
+      class ValidateAssociatedMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :associations, :as => :association, :block => :block
         optional  :message, :builder
 

data/lib/remarkable_activerecord/matchers/validate_confirmation_of_matcher.rb

@@ -1,8 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class ValidateConfirmationOfMatcher < Remarkable::ActiveRecord::Base
-
+      class ValidateConfirmationOfMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :attributes, :as => :attribute
 
         optional :message

data/lib/remarkable_activerecord/matchers/validate_exclusion_of_matcher.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), 'allow_values_for_matcher')
 module Remarkable
   module ActiveRecord
     module Matchers
-      class ValidateExclusionOfMatcher < AllowValuesForMatcher
+      class ValidateExclusionOfMatcher < AllowValuesForMatcher #:nodoc:
 
         default_options :message => :exclusion
 

data/lib/remarkable_activerecord/matchers/validate_inclusion_of_matcher.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), 'allow_values_for_matcher')
 module Remarkable
   module ActiveRecord
     module Matchers
-      class ValidateInclusionOfMatcher < AllowValuesForMatcher
+      class ValidateInclusionOfMatcher < AllowValuesForMatcher #:nodoc:
 
         default_options :message => :inclusion
 

data/lib/remarkable_activerecord/matchers/validate_length_of_matcher.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class ValidateLengthOfMatcher < Remarkable::ActiveRecord::Base
+      class ValidateLengthOfMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :attributes, :as => :attribute
 
         optional :within, :alias => :in

data/lib/remarkable_activerecord/matchers/validate_numericality_of_matcher.rb

@@ -1,8 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class ValidateNumericalityOfMatcher < Remarkable::ActiveRecord::Base
-
+      class ValidateNumericalityOfMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :attributes, :as => :attribute
 
         optional :equal_to, :greater_than_or_equal_to, :greater_than,

data/lib/remarkable_activerecord/matchers/validate_presence_of_matcher.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class ValidatePresenceOfMatcher < Remarkable::ActiveRecord::Base
+      class ValidatePresenceOfMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :attributes, :as => :attribute
         optional  :message
 

data/lib/remarkable_activerecord/matchers/validate_uniqueness_of_matcher.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module ActiveRecord
     module Matchers
-      class ValidateUniquenessOfMatcher < Remarkable::ActiveRecord::Base
+      class ValidateUniquenessOfMatcher < Remarkable::ActiveRecord::Base #:nodoc:
         arguments :collection => :attributes, :as => :attribute
 
         optional :message

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: remarkable_activerecord
 version: !ruby/object:Gem::Version 
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors: 
 - Carlos Brando
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-09 00:00:00 +02:00
+date: 2009-04-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.0.0
+        version: 3.0.1
     version: 
 description: "Remarkable ActiveRecord: collection of matchers and macros with I18n for ActiveRecord"
 email: