mcmire-shoulda-matchers 2.5.0

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

@@ -0,0 +1,261 @@
+module Shoulda
+  module Matchers
+    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
+      #
+      #     # Test::Unit
+      #     class PhoneTest < ActiveSupport::TestCase
+      #       should have_db_column(:camera_aperture).
+      #         with_options(precision: 1, null: false)
+      #     end
+      #
+      # @return [HaveDbColumnMatcher]
+      #
+      def have_db_column(column)
+        HaveDbColumnMatcher.new(column)
+      end
+
+      # @private
+      class HaveDbColumnMatcher
+        def initialize(column)
+          @column = column
+          @options = {}
+        end
+
+        def of_type(column_type)
+          @options[:column_type] = column_type
+          self
+        end
+
+        def with_options(opts = {})
+          %w(precision limit default null scale primary).each do |attribute|
+            if opts.key?(attribute.to_sym)
+              @options[attribute.to_sym] = opts[attribute.to_sym]
+            end
+          end
+          self
+        end
+
+        def matches?(subject)
+          @subject = subject
+          column_exists? &&
+            correct_column_type? &&
+            correct_precision? &&
+            correct_limit? &&
+            correct_default? &&
+            correct_null? &&
+            correct_scale? &&
+            correct_primary?
+        end
+
+        def failure_message
+          "Expected #{expectation} (#{@missing})"
+        end
+        alias failure_message_for_should failure_message
+
+        def failure_message_when_negated
+          "Did not expect #{expectation}"
+        end
+        alias failure_message_for_should_not failure_message_when_negated
+
+        def description
+          desc = "have db column named #{@column}"
+          desc << " of type #{@options[:column_type]}"    if @options.key?(:column_type)
+          desc << " of precision #{@options[:precision]}" if @options.key?(:precision)
+          desc << " of limit #{@options[:limit]}"         if @options.key?(:limit)
+          desc << " of default #{@options[:default]}"     if @options.key?(:default)
+          desc << " of null #{@options[:null]}"           if @options.key?(:null)
+          desc << " of primary #{@options[:primary]}"     if @options.key?(:primary)
+          desc << " of scale #{@options[:scale]}"         if @options.key?(:scale)
+          desc
+        end
+
+        protected
+
+        def column_exists?
+          if model_class.column_names.include?(@column.to_s)
+            true
+          else
+            @missing = "#{model_class} does not have a db column named #{@column}."
+            false
+          end
+        end
+
+        def correct_column_type?
+          return true unless @options.key?(:column_type)
+
+          if matched_column.type.to_s == @options[:column_type].to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of type #{matched_column.type}, not #{@options[:column_type]}."
+            false
+          end
+        end
+
+        def correct_precision?
+          return true unless @options.key?(:precision)
+
+          if matched_column.precision.to_s == @options[:precision].to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of precision #{matched_column.precision}, " <<
+                       "not #{@options[:precision]}."
+            false
+          end
+        end
+
+        def correct_limit?
+          return true unless @options.key?(:limit)
+
+          if matched_column.limit.to_s == @options[:limit].to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of limit #{matched_column.limit}, " <<
+                       "not #{@options[:limit]}."
+            false
+          end
+        end
+
+        def correct_default?
+          return true unless @options.key?(:default)
+
+          if matched_column.default.to_s == @options[:default].to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of default #{matched_column.default}, " <<
+                       "not #{@options[:default]}."
+            false
+          end
+        end
+
+        def correct_null?
+          return true unless @options.key?(:null)
+
+          if matched_column.null.to_s == @options[:null].to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of null #{matched_column.null}, " <<
+                       "not #{@options[:null]}."
+            false
+          end
+        end
+
+        def correct_scale?
+          return true unless @options.key?(:scale)
+
+          if actual_scale.to_s == @options[:scale].to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} "
+            @missing << "of scale #{actual_scale}, not #{@options[:scale]}."
+            false
+          end
+        end
+
+        def correct_primary?
+          return true unless @options.key?(:primary)
+
+          if matched_column.primary == @options[:primary]
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} "
+            if @options[:primary]
+              @missing << 'that is not primary, but should be'
+            else
+              @missing << 'that is primary, but should not be'
+            end
+            false
+          end
+        end
+
+        def matched_column
+          model_class.columns.detect { |each| each.name == @column.to_s }
+        end
+
+        def model_class
+          @subject.class
+        end
+
+        def actual_scale
+          matched_column.scale
+        end
+
+        def expectation
+          expected = "#{model_class.name} to #{description}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,149 @@
+module Shoulda
+  module Matchers
+    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
+      #
+      # @return [HaveDbIndexMatcher]
+      #
+      def have_db_index(columns)
+        HaveDbIndexMatcher.new(columns)
+      end
+
+      # @private
+      class HaveDbIndexMatcher
+        def initialize(columns)
+          @columns = normalize_columns_to_array(columns)
+          @options = {}
+        end
+
+        def unique(unique)
+          @options[:unique] = unique
+          self
+        end
+
+        def matches?(subject)
+          @subject = subject
+          index_exists? && correct_unique?
+        end
+
+        def failure_message
+          "Expected #{expectation} (#{@missing})"
+        end
+        alias failure_message_for_should failure_message
+
+        def failure_message_when_negated
+          "Did not expect #{expectation}"
+        end
+        alias failure_message_for_should_not failure_message_when_negated
+
+        def description
+          if @options.key?(:unique)
+            "have a #{index_type} index on columns #{@columns.join(' and ')}"
+          else
+            "have an index on columns #{@columns.join(' and ')}"
+          end
+        end
+
+        protected
+
+        def index_exists?
+          ! matched_index.nil?
+        end
+
+        def correct_unique?
+          return true unless @options.key?(:unique)
+
+          is_unique = matched_index.unique
+
+          is_unique = !is_unique unless @options[:unique]
+
+          unless is_unique
+            @missing = "#{table_name} has an index named #{matched_index.name} " <<
+            "of unique #{matched_index.unique}, not #{@options[:unique]}."
+          end
+
+          is_unique
+        end
+
+        def matched_index
+          indexes.detect { |each| each.columns == @columns }
+        end
+
+        def model_class
+          @subject.class
+        end
+
+        def table_name
+          model_class.table_name
+        end
+
+        def indexes
+          ::ActiveRecord::Base.connection.indexes(table_name)
+        end
+
+        def expectation
+          "#{model_class.name} to #{description}"
+        end
+
+        def index_type
+          if @options[:unique]
+            'unique'
+          else
+            'non-unique'
+          end
+        end
+
+        def normalize_columns_to_array(columns)
+          Array.wrap(columns).map(&:to_s)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+module Shoulda
+  module Matchers
+    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
+      #
+      # @return [HaveReadonlyAttributeMatcher]
+      #
+      def have_readonly_attribute(value)
+        HaveReadonlyAttributeMatcher.new(value)
+      end
+
+      # @private
+      class HaveReadonlyAttributeMatcher
+        def initialize(attribute)
+          @attribute = attribute.to_s
+        end
+
+        attr_reader :failure_message, :failure_message_when_negated
+
+        alias failure_message_for_should failure_message
+        alias failure_message_for_should_not failure_message_when_negated
+
+        def matches?(subject)
+          @subject = subject
+          if readonly_attributes.include?(@attribute)
+            @failure_message_when_negated = "Did not expect #{@attribute} to be read-only"
+            true
+          else
+            if readonly_attributes.empty?
+              @failure_message = "#{class_name} attribute #{@attribute} " <<
+                'is not read-only'
+            else
+              @failure_message = "#{class_name} is making " <<
+                "#{readonly_attributes.to_a.to_sentence} " <<
+                "read-only, but not #{@attribute}."
+            end
+            false
+          end
+        end
+
+        def description
+          "make #{@attribute} read-only"
+        end
+
+        private
+
+        def readonly_attributes
+          @readonly_attributes ||= (@subject.class.readonly_attributes || [])
+        end
+
+        def class_name
+          @subject.class.name
+        end
+      end
+    end
+  end
+end