shoulda-matchers 2.6.1 → 2.6.2

data/lib/shoulda/matchers/active_record/association_matchers.rb

@@ -0,0 +1,9 @@
+module Shoulda
+  module Matchers
+    module ActiveRecord
+      # @private
+      module AssociationMatchers
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/active_record/association_matchers/counter_cache_matcher.rb

@@ -1,7 +1,8 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
+    module ActiveRecord
       module AssociationMatchers
+        # @private
         class CounterCacheMatcher
           attr_accessor :missing_option
 
@@ -26,7 +27,7 @@ module Shoulda # :nodoc:
             end
           end
 
-          private
+          protected
 
           attr_accessor :subject, :counter_cache, :name
 

data/lib/shoulda/matchers/active_record/association_matchers/dependent_matcher.rb

@@ -1,7 +1,8 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
+    module ActiveRecord
       module AssociationMatchers
+        # @private
         class DependentMatcher
           attr_accessor :missing_option
 
@@ -26,7 +27,7 @@ module Shoulda # :nodoc:
             end
           end
 
-          private
+          protected
 
           attr_accessor :subject, :dependent, :name
 

data/lib/shoulda/matchers/active_record/association_matchers/inverse_of_matcher.rb

@@ -1,7 +1,8 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
+    module ActiveRecord
       module AssociationMatchers
+        # @private
         class InverseOfMatcher
           attr_accessor :missing_option
 
@@ -26,7 +27,7 @@ module Shoulda # :nodoc:
             end
           end
 
-          private
+          protected
 
           attr_accessor :subject, :inverse_of, :name
 

data/lib/shoulda/matchers/active_record/association_matchers/model_reflection.rb

@@ -4,6 +4,7 @@ module Shoulda
   module Matchers
     module ActiveRecord
       module AssociationMatchers
+        # @private
         class ModelReflection < SimpleDelegator
           def initialize(reflection)
             super(reflection)
@@ -44,7 +45,7 @@ module Shoulda
             end
           end
 
-          private
+          protected
 
           attr_reader :reflection, :subject
 

data/lib/shoulda/matchers/active_record/association_matchers/model_reflector.rb

@@ -1,7 +1,8 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
+    module ActiveRecord
       module AssociationMatchers
+        # @private
         class ModelReflector
           delegate :associated_class, :through?, :join_table,
             :association_relation, :polymorphic?, to: :reflection
@@ -46,7 +47,7 @@ module Shoulda # :nodoc:
             end
           end
 
-          private
+          protected
 
           attr_reader :subject, :name
 

data/lib/shoulda/matchers/active_record/association_matchers/option_verifier.rb

@@ -1,12 +1,11 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
+    module ActiveRecord
       module AssociationMatchers
+        # @private
         class OptionVerifier
           delegate :reflection, to: :reflector
 
-          attr_reader :reflector
-
           RELATION_OPTIONS = [:conditions, :order]
 
           def initialize(reflector)
@@ -42,7 +41,7 @@ module Shoulda # :nodoc:
             end
           end
 
-          private
+          protected
 
           attr_reader :reflector
 

data/lib/shoulda/matchers/active_record/association_matchers/order_matcher.rb

@@ -1,7 +1,8 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
+    module ActiveRecord
       module AssociationMatchers
+        # @private
         class OrderMatcher
           attr_accessor :missing_option
 
@@ -26,7 +27,7 @@ module Shoulda # :nodoc:
             end
           end
 
-          private
+          protected
 
           attr_accessor :subject, :order, :name
 

data/lib/shoulda/matchers/active_record/association_matchers/source_matcher.rb

@@ -1,7 +1,8 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
+    module ActiveRecord
       module AssociationMatchers
+        # @private
         class SourceMatcher
           attr_accessor :missing_option
 
@@ -26,7 +27,7 @@ module Shoulda # :nodoc:
             end
           end
 
-          private
+          protected
 
           attr_accessor :subject, :source, :name
 

data/lib/shoulda/matchers/active_record/association_matchers/through_matcher.rb

@@ -1,7 +1,8 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
+    module ActiveRecord
       module AssociationMatchers
+        # @private
         class ThroughMatcher
           attr_accessor :missing_option
 
@@ -48,7 +49,7 @@ module Shoulda # :nodoc:
             end
           end
 
-          private
+          protected
 
           attr_accessor :through, :name, :subject
 

data/lib/shoulda/matchers/active_record/have_db_column_matcher.rb

@@ -1,25 +1,89 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
-
-      # Ensures the database column exists.
+    module ActiveRecord
+      # The `have_db_column` matcher tests that the table that backs your model
+      # has a specific column.
+      #
+      #     class CreatePhones < ActiveRecord::Migration
+      #       def change
+      #         create_table :phones do |t|
+      #           t.string :supported_ios_version
+      #         end
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     describe Phone do
+      #       it { should have_db_column(:supported_ios_version) }
+      #     end
+      #
+      #     # Test::Unit
+      #     class PhoneTest < ActiveSupport::TestCase
+      #       should have_db_column(:supported_ios_version)
+      #     end
+      #
+      # #### Qualifiers
+      #
+      # ##### of_type
+      #
+      # Use `of_type` to assert that a column is defined as a certain type.
+      #
+      #     class CreatePhones < ActiveRecord::Migration
+      #       def change
+      #         create_table :phones do |t|
+      #           t.decimal :camera_aperture
+      #         end
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     describe Phone do
+      #       it do
+      #         should have_db_column(:camera_aperture).of_type(:decimal)
+      #       end
+      #     end
+      #
+      #     # Test::Unit
+      #     class PhoneTest < ActiveSupport::TestCase
+      #       should have_db_column(:camera_aperture).of_type(:decimal)
+      #     end
+      #
+      # ##### with_options
+      #
+      # Use `with_options` to assert that a column has been defined with
+      # certain options (`:precision`, `:limit`, `:default`, `:null`, `:scale`,
+      # or `:primary`).
+      #
+      #     class CreatePhones < ActiveRecord::Migration
+      #       def change
+      #         create_table :phones do |t|
+      #           t.decimal :camera_aperture, precision: 1, null: false
+      #         end
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     describe Phone do
+      #       it do
+      #         should have_db_column(:camera_aperture).
+      #           with_options(precision: 1, null: false)
+      #       end
+      #     end
       #
-      # Options:
-      # * <tt>of_type</tt> - db column type (:integer, :string, etc.)
-      # * <tt>with_options</tt> - same options available in migrations
-      #   (:default, :null, :limit, :precision, :scale)
+      #     # Test::Unit
+      #     class PhoneTest < ActiveSupport::TestCase
+      #       should have_db_column(:camera_aperture).
+      #         with_options(precision: 1, null: false)
+      #     end
       #
-      # Examples:
-      #   it { should_not have_db_column(:admin).of_type(:boolean) }
-      #   it { should have_db_column(:salary).
-      #                 of_type(:decimal).
-      #                 with_options(precision: 10, scale: 2) }
+      # @return [HaveDbColumnMatcher]
       #
       def have_db_column(column)
         HaveDbColumnMatcher.new(column)
       end
 
-      class HaveDbColumnMatcher # :nodoc:
+      # @private
+      class HaveDbColumnMatcher
         def initialize(column)
           @column = column
           @options = {}
@@ -189,7 +253,7 @@ module Shoulda # :nodoc:
         end
 
         def expectation
-          expected = "#{model_class.name} to #{description}"
+          "#{model_class.name} to #{description}"
         end
       end
     end

data/lib/shoulda/matchers/active_record/have_db_index_matcher.rb

@@ -1,27 +1,76 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
-
-      # Ensures that there are DB indices on the given columns or tuples of
-      # columns.
+    module ActiveRecord
+      # The `have_db_index` matcher tests that the table that backs your model
+      # has a index on a specific column.
+      #
+      #     class CreateBlogs < ActiveRecord::Migration
+      #       def change
+      #         create_table :blogs do |t|
+      #           t.integer :user_id
+      #         end
+      #
+      #         add_index :blogs, :user_id
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     describe Blog do
+      #       it { should have_db_index(:user_id) }
+      #     end
+      #
+      #     # Test::Unit
+      #     class BlogTest < ActiveSupport::TestCase
+      #       should have_db_index(:user_id)
+      #     end
+      #
+      # #### Qualifiers
+      #
+      # ##### unique
+      #
+      # Use `unique` to assert that the index is unique.
+      #
+      #     class CreateBlogs < ActiveRecord::Migration
+      #       def change
+      #         create_table :blogs do |t|
+      #           t.string :name
+      #         end
+      #
+      #         add_index :blogs, :name, unique: true
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     describe Blog do
+      #       it { should have_db_index(:name).unique(true) }
+      #     end
+      #
+      #     # Test::Unit
+      #     class BlogTest < ActiveSupport::TestCase
+      #       should have_db_index(:name).unique(true)
+      #     end
+      #
+      # Since it only ever makes since for `unique` to be `true`, you can also
+      # leave off the argument to save some keystrokes:
       #
-      # Options:
-      # * <tt>unique</tt> - whether or not the index has a unique
-      #   constraint. Use <tt>true</tt> to explicitly test for a unique
-      #   constraint.  Use <tt>false</tt> to explicitly test for a non-unique
-      #   constraint.
+      #     # RSpec
+      #     describe Blog do
+      #       it { should have_db_index(:name).unique }
+      #     end
       #
-      # Examples:
+      #     # Test::Unit
+      #     class BlogTest < ActiveSupport::TestCase
+      #       should have_db_index(:name).unique
+      #     end
       #
-      #   it { should have_db_index(:age) }
-      #   it { should have_db_index([:commentable_type, :commentable_id]) }
-      #   it { should have_db_index(:ssn).unique(true) }
+      # @return [HaveDbIndexMatcher]
       #
       def have_db_index(columns)
         HaveDbIndexMatcher.new(columns)
       end
 
-      class HaveDbIndexMatcher # :nodoc:
+      # @private
+      class HaveDbIndexMatcher
         def initialize(columns)
           @columns = normalize_columns_to_array(columns)
           @options = {}

data/lib/shoulda/matchers/active_record/have_readonly_attribute_matcher.rb

@@ -1,17 +1,31 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
-
-      # Ensures that the attribute cannot be changed once the record has been
-      # created.
+    module ActiveRecord
+      # The `have_readonly_attribute` matcher tests usage of the
+      # `attr_readonly` macro.
+      #
+      #     class User < ActiveRecord::Base
+      #       attr_readonly :password
+      #     end
+      #
+      #     # RSpec
+      #     describe User do
+      #       it { should have_readonly_attribute(:password) }
+      #     end
+      #
+      #     # Test::Unit
+      #     class UserTest < ActiveSupport::TestCase
+      #       should have_readonly_attribute(:password)
+      #     end
       #
-      #   it { should have_readonly_attribute(:password) }
+      # @return [HaveReadonlyAttributeMatcher]
       #
       def have_readonly_attribute(value)
         HaveReadonlyAttributeMatcher.new(value)
       end
 
-      class HaveReadonlyAttributeMatcher # :nodoc:
+      # @private
+      class HaveReadonlyAttributeMatcher
         def initialize(attribute)
           @attribute = attribute.to_s
         end

data/lib/shoulda/matchers/active_record/serialize_matcher.rb

@@ -1,21 +1,96 @@
-module Shoulda # :nodoc:
+module Shoulda
   module Matchers
-    module ActiveRecord # :nodoc:
-      # Ensure that the field becomes serialized.
+    module ActiveRecord
+      # The `serialize` matcher tests usage of the `serialize` macro.
       #
-      # Options:
-      # * <tt>:as</tt> - tests that the serialized attribute makes use of the class_name option.
+      #     class Product < ActiveRecord::Base
+      #       serialize :customizations
+      #     end
       #
-      # Example:
-      #   it { should serialize(:details) }
-      #   it { should serialize(:details).as(Hash) }
-      #   it { should serialize(:details).as_instance_of(ExampleSerializer) }
+      #     # RSpec
+      #     describe Product do
+      #       it { should serialize(:customizations) }
+      #     end
+      #
+      #     # Test::Unit
+      #     class ProductTest < ActiveSupport::TestCase
+      #       should serialize(:customizations)
+      #     end
+      #
+      # #### Qualifiers
+      #
+      # ##### as
+      #
+      # Use `as` if you are using a custom serializer class.
+      #
+      #     class ProductSpecsSerializer
+      #       def load(string)
+      #         # ...
+      #       end
+      #
+      #       def dump(options)
+      #         # ...
+      #       end
+      #     end
+      #
+      #     class Product < ActiveRecord::Base
+      #       serialize :specifications, ProductSpecsSerializer
+      #     end
+      #
+      #     # RSpec
+      #     describe Product do
+      #       it do
+      #         should serialize(:specifications).
+      #           as(ProductSpecsSerializer)
+      #       end
+      #     end
+      #
+      #     # Test::Unit
+      #     class ProductTest < ActiveSupport::TestCase
+      #       should serialize(:specifications).
+      #         as(ProductSpecsSerializer)
+      #     end
+      #
+      # ##### as_instance_of
+      #
+      # Use `as_instance_of` if you are using a custom serializer object.
+      #
+      #     class ProductOptionsSerializer
+      #       def load(string)
+      #         # ...
+      #       end
+      #
+      #       def dump(options)
+      #         # ...
+      #       end
+      #     end
+      #
+      #     class Product < ActiveRecord::Base
+      #       serialize :options, ProductOptionsSerializer.new
+      #     end
+      #
+      #     # RSpec
+      #     describe Product do
+      #       it do
+      #         should serialize(:options).
+      #           as_instance_of(ProductOptionsSerializer)
+      #       end
+      #     end
+      #
+      #     # Test::Unit
+      #     class ProductTest < ActiveSupport::TestCase
+      #       should serialize(:options).
+      #         as_instance_of(ProductOptionsSerializer)
+      #     end
+      #
+      # @return [SerializeMatcher]
       #
       def serialize(name)
         SerializeMatcher.new(name)
       end
 
-      class SerializeMatcher # :nodoc:
+      # @private
+      class SerializeMatcher
         def initialize(name)
           @name = name.to_s
           @options = {}