mcmire-shoulda-matchers 2.5.0

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

@@ -0,0 +1,181 @@
+module Shoulda
+  module Matchers
+    module ActiveRecord
+      # The `serialize` matcher tests usage of the `serialize` macro.
+      #
+      #     class Product < ActiveRecord::Base
+      #       serialize :customizations
+      #     end
+      #
+      #     # 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 { should serialize(:specifications).as(ProductSpecsSerializer) }
+      #     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 { should serialize(:options).as_instance_of(ProductOptionsSerializer) }
+      #     end
+      #
+      #     # Test::Unit
+      #     class ProductTest < ActiveSupport::TestCase
+      #       should serialize(:options).as_instance_of(ProductOptionsSerializer)
+      #     end
+      #
+      # @return [SerializeMatcher]
+      #
+      def serialize(name)
+        SerializeMatcher.new(name)
+      end
+
+      # @private
+      class SerializeMatcher
+        def initialize(name)
+          @name = name.to_s
+          @options = {}
+        end
+
+        def as(type)
+          @options[:type] = type
+          self
+        end
+
+        def as_instance_of(type)
+          @options[:instance_type] = type
+          self
+        end
+
+        def matches?(subject)
+          @subject = subject
+          serialization_valid? && type_valid?
+        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
+          description = "serialize :#{@name}"
+          description += " class_name => #{@options[:type]}" if @options.key?(:type)
+          description
+        end
+
+        protected
+
+        def serialization_valid?
+          if model_class.serialized_attributes.keys.include?(@name)
+            true
+          else
+            @missing = "no serialized attribute called :#{@name}"
+            false
+          end
+        end
+
+        def class_valid?
+          if @options[:type]
+            klass = model_class.serialized_attributes[@name]
+            if klass == @options[:type]
+              true
+            else
+              if klass.respond_to?(:object_class) && klass.object_class == @options[:type]
+                true
+              else
+                @missing = ":#{@name} should be a type of #{@options[:type]}"
+                false
+              end
+            end
+          else
+            true
+          end
+        end
+
+        def model_class
+          @subject.class
+        end
+
+        def instance_class_valid?
+          if @options.key?(:instance_type)
+            if model_class.serialized_attributes[@name].class == @options[:instance_type]
+              true
+            else
+              @missing = ":#{@name} should be an instance of #{@options[:type]}"
+              false
+            end
+          else
+            true
+          end
+        end
+
+        def type_valid?
+          class_valid? && instance_class_valid?
+        end
+
+        def expectation
+          expectation = "#{model_class.name} to serialize the attribute called :#{@name}"
+          expectation += " with a type of #{@options[:type]}" if @options[:type]
+          expectation += " with an instance of #{@options[:instance_type]}" if @options[:instance_type]
+          expectation
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/assertion_error.rb

@@ -0,0 +1,19 @@
+module Shoulda
+  module Matchers
+    if Gem.ruby_version >= Gem::Version.new('1.8') && Gem.ruby_version < Gem::Version.new('1.9')
+      require 'test/unit'
+      # @private
+      AssertionError = Test::Unit::AssertionFailedError
+    elsif defined?(Test::Unit::AssertionFailedError)
+      # Test::Unit has been loaded already, so we use it
+      # @private
+      AssertionError = Test::Unit::AssertionFailedError
+    elsif Gem.ruby_version >= Gem::Version.new("1.9")
+      require 'minitest/unit'
+      # @private
+      AssertionError = MiniTest::Assertion
+    else
+      raise 'No unit test library available'
+    end
+  end
+end

data/lib/shoulda/matchers/error.rb

@@ -0,0 +1,6 @@
+module Shoulda
+  module Matchers
+    # @private
+    class Error < StandardError; end
+  end
+end

data/lib/shoulda/matchers/integrations/rspec.rb

@@ -0,0 +1,20 @@
+# :enddoc:
+require 'rspec/core'
+
+RSpec.configure do |config|
+  if defined?(::ActiveRecord)
+    require 'shoulda/matchers/active_record'
+    require 'shoulda/matchers/active_model'
+    config.include Shoulda::Matchers::ActiveRecord
+    config.include Shoulda::Matchers::ActiveModel
+
+  elsif defined?(::ActiveModel)
+    require 'shoulda/matchers/active_model'
+    config.include Shoulda::Matchers::ActiveModel
+  end
+
+  if defined?(::ActionController)
+    require 'shoulda/matchers/action_controller'
+    config.include Shoulda::Matchers::ActionController
+  end
+end

data/lib/shoulda/matchers/integrations/test_unit.rb

@@ -0,0 +1,30 @@
+if defined?(ActionController) && defined?(ActionController::TestCase)
+  require 'shoulda/matchers/action_controller'
+
+  ActionController::TestCase.class_eval do
+    include Shoulda::Matchers::ActionController
+    extend Shoulda::Matchers::ActionController
+
+    def subject
+      @controller
+    end
+  end
+end
+
+if defined?(ActiveRecord) && defined?(ActiveSupport::TestCase)
+  require 'shoulda/matchers/active_record'
+
+  ActiveSupport::TestCase.class_eval do
+    include Shoulda::Matchers::ActiveRecord
+    extend Shoulda::Matchers::ActiveRecord
+  end
+end
+
+if defined?(ActiveModel) && defined?(ActiveSupport::TestCase)
+  require 'shoulda/matchers/active_model'
+
+  ActiveSupport::TestCase.class_eval do
+    include Shoulda::Matchers::ActiveModel
+    extend Shoulda::Matchers::ActiveModel
+  end
+end

data/lib/shoulda/matchers/rails_shim.rb

@@ -0,0 +1,50 @@
+module Shoulda
+  module Matchers
+    # @private
+    class RailsShim
+      def self.layouts_ivar
+        if action_pack_major_version >= 4
+          '@_layouts'
+        else
+          '@layouts'
+        end
+      end
+
+      def self.flashes_ivar
+        if action_pack_major_version >= 4
+          :@flashes
+        else
+          :@used
+        end
+      end
+
+      def self.clean_scope(klass)
+        if active_record_major_version == 4
+          klass.all
+        else
+          klass.scoped
+        end
+      end
+
+      def self.validates_confirmation_of_error_attribute(matcher)
+        if active_model_major_version == 4
+          matcher.confirmation_attribute
+        else
+          matcher.attribute
+        end
+      end
+
+      def self.active_record_major_version
+        ::ActiveRecord::VERSION::MAJOR
+      end
+
+      def self.active_model_major_version
+        ::ActiveModel::VERSION::MAJOR
+      end
+
+      def self.action_pack_major_version
+        ::ActionPack::VERSION::MAJOR
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/version.rb

@@ -0,0 +1,6 @@
+module Shoulda
+  module Matchers
+    # @private
+    VERSION = '2.5.0'.freeze
+  end
+end

data/lib/shoulda/matchers/warn.rb

@@ -0,0 +1,8 @@
+module Shoulda
+  module Matchers
+    # @private
+    def self.warn(msg)
+      Kernel.warn "Warning from shoulda-matchers:\n\n#{msg}"
+    end
+  end
+end

data/shoulda-matchers.gemspec

@@ -0,0 +1,23 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'shoulda/matchers/version'
+
+Gem::Specification.new do |s|
+  s.name        = "mcmire-shoulda-matchers"
+  s.version     = Shoulda::Matchers::VERSION.dup
+  s.authors     = ["Tammer Saleh", "Joe Ferris", "Ryan McGeary", "Dan Croak",
+                   "Matt Jankowski", "Stafford Brunk"]
+  s.date        = Time.now.strftime("%Y-%m-%d")
+  s.email       = "support@thoughtbot.com"
+  s.homepage    = "http://thoughtbot.com/community/"
+  s.summary     = "Making tests easy on the fingers and eyes"
+  s.license     = "MIT"
+  s.description = "Making tests easy on the fingers and eyes"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 1.9.2'
+  s.add_dependency('activesupport', '>= 3.0.0')
+end

data/spec/shoulda/matchers/action_controller/filter_param_matcher_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Shoulda::Matchers::ActionController::FilterParamMatcher do
+  it 'accepts filtering a filtered parameter' do
+    filter(:secret)
+
+    expect(nil).to filter_param(:secret)
+  end
+
+  it 'rejects filtering an unfiltered parameter' do
+    filter(:secret)
+    matcher = filter_param(:other)
+
+    expect(matcher.matches?(nil)).to eq false
+
+    expect(matcher.failure_message).to match(/Expected other to be filtered.*secret/)
+  end
+
+  def filter(param)
+    Rails.application.config.filter_parameters = [param]
+  end
+end

data/spec/shoulda/matchers/action_controller/redirect_to_matcher_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Shoulda::Matchers::ActionController::RedirectToMatcher do
+  context 'a controller that redirects' do
+    it 'accepts redirecting to that url' do
+      expect(controller_redirecting_to('/some/url')).to redirect_to('/some/url')
+    end
+
+    it 'rejects redirecting to a different url' do
+      expect(controller_redirecting_to('/some/url')).
+        not_to redirect_to('/some/other/url')
+    end
+
+    it 'accepts redirecting to that url in a block' do
+      expect(controller_redirecting_to('/some/url')).
+        to redirect_to('somewhere') { '/some/url' }
+    end
+
+    it 'rejects redirecting to a different url in a block' do
+      expect(controller_redirecting_to('/some/url')).
+        not_to redirect_to('somewhere else') { '/some/other/url' }
+    end
+
+    def controller_redirecting_to(url)
+      build_response { redirect_to url }
+    end
+  end
+
+  context 'a controller that does not redirect' do
+    it 'rejects redirecting to a url' do
+      controller = build_response { render text: 'hello' }
+
+      expect(controller).not_to redirect_to('/some/url')
+    end
+  end
+
+  it 'provides the correct description when provided a block' do
+    matcher = redirect_to('somewhere else') { '/some/other/url' }
+
+    expect(matcher.description).to eq 'redirect to somewhere else'
+  end
+end

data/spec/shoulda/matchers/action_controller/render_template_matcher_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Shoulda::Matchers::ActionController::RenderTemplateMatcher do
+  include ActionController::TemplateAssertions
+
+  context 'a controller that renders a template' do
+    it 'accepts rendering that template' do
+      expect(controller_with_show).to render_template(:show)
+    end
+
+    it 'rejects rendering a different template' do
+      expect(controller_with_show).not_to render_template(:index)
+    end
+
+    it 'accepts rendering that template in the given context' do
+      expect(controller_with_show).to render_template(:show).in_context(self)
+    end
+
+    it 'rejects rendering a different template in the given context' do
+      expect(controller_with_show).not_to render_template(:index).in_context(self)
+    end
+
+    def controller_with_show
+      build_response(action: 'show') { render }
+    end
+  end
+
+  context 'a controller that renders a partial' do
+    it 'accepts rendering that partial' do
+      expect(controller_with_customer_partial).
+        to render_template(partial: '_customer')
+    end
+
+    it 'rejects rendering a different template' do
+      expect(controller_with_customer_partial).
+        not_to render_template(partial: '_client')
+    end
+
+    it 'accepts rendering that template in the given context' do
+      expect(controller_with_customer_partial).
+        to render_template(partial: '_customer').in_context(self)
+    end
+
+    it 'rejects rendering a different template in the given context' do
+      expect(controller_with_customer_partial).
+        not_to render_template(partial: '_client').in_context(self)
+    end
+
+    def controller_with_customer_partial
+      build_response(partial: '_customer') { render partial: 'customer' }
+    end
+  end
+
+  context 'a controller that does not render partials' do
+    it 'accepts not rendering a partial' do
+      controller = build_response(action: 'show') { render }
+
+      expect(controller).to render_template(partial: false)
+    end
+  end
+
+  context 'a controller that renders a partial several times' do
+    it 'accepts rendering that partial twice' do
+      controller = build_response(partial: '_customer') do
+        render partial: 'customer', collection: [1,2]
+      end
+
+      expect(controller).to render_template(partial: '_customer', count: 2)
+    end
+  end
+
+  context 'a controller that does not render a template' do
+    it 'rejects rendering a template' do
+      expect(build_response { render nothing: true }).
+        not_to render_template(:show)
+    end
+  end
+end