rspec-rails-assign 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Samuel Cochran
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# RSpec Rails Assign
+
+## Motivation
+
+This is ugly:
+
+```ruby
+subject { get :show }
+specify { subject and assigns[:blah].should be_present }
+specify { subject and assigns[:blah].should == "something" }
+specify { subject and assigns[:blah].should =~ /thi/ }
+specify { subject and assigns[:blah].should be_a String }
+```
+
+Instead:
+
+```ruby
+subject { get :show }
+it { should assign :blah }
+it { should assign :blah => "something" }
+it { should assign :blah => /thi/ }
+it { should assign :blah => is_a(String) }
+```
+
+It's more like a subject modifier, a la `its`, but inline and allowing nicely described specs:
+
+```
+MyController
+  #show
+    should assign @blah
+    should assign @blah == "something"
+    should assign @blah =~ /thi/
+    should assign @blah to be a kind of String
+```
+
+And presents nice diffs when it fails:
+
+```
+  1) MyController#show assign @blah to == "something"
+     Failure/Error: it { should assign :blah => "something" }
+       expected: "something"
+            got: "other" (using ==)
+```
+
+## License
+
+The MIT License, see [LICENSE][license].

data/lib/rspec-rails-assign.rb

@@ -0,0 +1,4 @@
+require 'rspec/rails'
+require 'rspec/rails/matchers/assign'
+
+RSpec::Rails::ControllerExampleGroup.send :include, RSpec::Rails::Matchers::Assign

data/lib/rspec/rails/matchers/assign.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+module RSpec::Rails::Matchers::Assign
+  private
+
+  # +nodoc+
+  class AssignMatcher
+    attr_accessor :actual, :operator, :expected
+
+    def initialize scope, name, expected=nil
+      @scope = scope
+      @actual = nil
+
+      if name.is_a? Hash
+        raise ArgumentError, "must test at least one assignment" unless name.size
+        raise ArgumentError, "can only test one assign at a time" if name.size > 1
+
+        @name, expected = name.first
+      else
+        @name = name
+      end
+
+      @expected = [expected]
+      @operator = nil
+    end
+
+    def description
+      if @expected.first.nil?
+        "assign @#{@name}"
+      elsif @expected.first.respond_to? :matches?
+        "assign @#{@name} to #{@expected.first.description}"
+      else
+        "assign @#{@name} #{@operator} #{@expected.first.inspect}"
+      end
+    end
+
+    def failure_message_for_should
+      if @expected.first.nil?
+        "expected to assign @#{@name}"
+      elsif ['==','===', '=~'].include?(operator)
+        "expected: #{expected.first.inspect}\n     got: #{actual.inspect} (using #{operator})"
+      elsif @expected.first.respond_to? :matches?
+        "expected: #{actual.inspect} to #{@expected.first.description}"
+      else
+        "expected: #{operator} #{expected.first.inspect}\n     got: #{operator.gsub(/./, ' ')} #{actual.inspect}"
+      end
+    end
+
+    def failure_message_for_should_not
+      if @expected.first.nil?
+        "expected not to assign @#{@name}"
+      elsif @expected.first.respond_to? :matches?
+        "expected: #{actual.inspect} to not #{@expected.first.description}"
+      else
+        "expected not: #{operator} #{expected.first.inspect}\n         got: #{operator.gsub(/./, ' ')} #{actual.inspect}"
+      end
+    end
+
+    def diffable?
+      not (@expected.first.is_a?(Regexp) or @expected.first.respond_to? :matches?)
+    end
+
+    def matches? actual
+      @actual = actual.assigns[@name]
+
+      if @expected.first.nil?
+        @actual.present?
+      elsif @operator
+        @actual.send @operator, @expected.first
+      elsif @expected.first.is_a? Regexp
+        @operator = "=~"
+        @actual =~ @expected.first
+      elsif @expected.first.respond_to? :matches?
+        @expected.first.matches? @actual
+      else
+        @operator = "=="
+        @actual == @expected.first
+      end
+    end
+
+    ['==', '===', '=~', '>', '>=', '<', '<='].each do |operator|
+      define_method operator do |expected|
+        raise ArgumentError, "can't use expected value and an opertator" if @expected.present?
+        @operator = operator
+        @expected = [expected]
+        self
+      end
+    end
+  end
+
+  # +nodoc+
+  class AssignMetaMatcher
+    def initialize scope, name, matcher
+      @scope = scope
+      @name = name
+      @matcher = matcher
+    end
+
+    def matches? actual
+      @actual = actual.assigns[@name]
+      @matcher.matches? @actual
+    end
+
+    def description
+      "assign @#{@name} to #{@matcher.description}"
+    end
+
+    def method_missing name, *args, &block
+      @matcher.send name, *args, &block
+    end
+  end
+
+  public
+
+  # Lets you write:
+  #
+  #      subject { get :show }
+  #      it { should assign(:blah) }
+  #      it { should assign(:blah =>"something") }
+  #
+  # or, more interestingly:
+  #
+  #      it { should assign(:blah) == "something" }
+  #      it { should assign(:blah => is_a(String)) }
+  #      it { should assign(:blah => satisfy { |value| Thing.exists? :blah => value }) }
+  #
+  def assign *args, &block
+    AssignMatcher.new self, *args, &block
+  end
+
+  def method_missing(method, *args, &block)
+    # Allow infinitive forms of `be_<predicate>` matchers.
+    return ::RSpec::Matchers::BePredicate.new(method.to_s.sub("is", "be"), *args, &block) if method.to_s =~ /\Ais_(.*)\Z/
+    super
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: rspec-rails-assign
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Samuel Cochran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70284572197740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70284572197740
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70284572197280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70284572197280
+description: A subject-oriented way to match assignments in controller examples.
+email:
+- sj26@sj26.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec/rails/matchers/assign.rb
+- lib/rspec-rails-assign.rb
+- README.md
+- LICENSE
+homepage: http://github.com/sj26/rspec-rails-assign
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: RSpec Rails assign matcher
+test_files: []
+has_rdoc: