rspec_candy 0.1.0

data/spec/shared/rspec_candy/helpers/stub_existing_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe RSpecCandy::Helpers::StubExisting do
+
+  describe Object do
+
+    describe '#stub_existing' do
+
+      it 'should stub an existing method' do
+        string = 'foo'
+        string.stub_existing(:upcase => 'BAR', :downcase => 'bar')
+        string.upcase.should == 'BAR'
+        string.downcase.should == 'bar'
+      end
+
+      it 'should raise an error when attempting to stub a non-existing method' do
+        string = 'foo'
+        expect do
+          string.stub_existing(:unknown => 'value')
+        end.to raise_error('Attempted to stub non-existing method #unknown on "foo"')
+      end
+
+    end
+
+  end
+
+end

data/spec/shared/support/matchers/pass_as_describe_block.rb

@@ -0,0 +1,32 @@
+class RSpecRemote
+  def self.run_describe_block(describe_block)
+    temp_path = nil
+    Tempfile.open(['example', '_spec.rb']) do |io|
+      io.write(<<-spec)
+        require 'spec_helper';
+        #{describe_block}
+      spec
+      temp_path = io.path
+    end
+    `rake SPEC=#{temp_path} 2>&1`
+  end
+end
+
+
+RSpecCandy::Switcher.define_matcher :pass_as_describe_block do
+
+  match do |describe_block|
+    rspec_out = RSpecRemote.run_describe_block(describe_block)
+    rspec_out.include?('0 failures')
+  end
+
+end
+
+RSpecCandy::Switcher.define_matcher :fail_as_describe_block do
+
+  match do |describe_block|
+    rspec_out = RSpecRemote.run_describe_block(describe_block)
+    rspec_out.include?('1 failure')
+  end
+
+end

data/spec/shared/support/matchers/pass_as_example.rb

@@ -0,0 +1,30 @@
+class RSpecRemote
+  def self.run_example(example)
+    run_describe_block(<<-describe_block)
+      describe 'context' do
+        it 'should pass' do
+          #{example}
+        end
+      end
+    describe_block
+  end
+end
+
+
+RSpecCandy::Switcher.define_matcher :pass_as_example do
+
+  match do |example|
+    rspec_out = RSpecRemote.run_example(example)
+    rspec_out.include?('0 failures')
+  end
+
+end
+
+RSpecCandy::Switcher.define_matcher :fail_as_example do
+
+  match do |example|
+    rspec_out = RSpecRemote.run_example(example)
+    rspec_out.include?('1 failure')
+  end
+
+end

data/template/spec_candy.rails2.rb

@@ -0,0 +1,171 @@
+Object.class_eval do
+
+  def should_receive_chain(*parts)
+    setup_expectation_chain(parts)
+  end
+
+  def self.new_with_stubs(attrs)
+    new.tap do |obj|
+      obj.stub_existing attrs
+    end
+  end
+
+  def stub_existing(attrs)
+    attrs.each do |method, value|
+      if respond_to?(method, true)
+        stub(method => value)
+      else
+        raise "Attempted to stub non-existing method ##{method} on a #{self.class.name}"
+      end
+    end
+  end
+
+  def should_receive_and_return(methods_and_values)
+    methods_and_values.each do |method, value|
+      should_receive(method).and_return(value)
+    end
+  end
+
+  def should_receive_all_with(methods_and_values)
+    methods_and_values.each do |method, value|
+      should_receive(method).with(value)
+    end
+  end
+
+  def should_not_receive_and_execute(method)
+    should_receive_and_execute(method, true)
+  end
+
+  def should_receive_and_execute(method, negate = false)
+    method_base = method.to_s.gsub(/([\?\!\=\[\]]+)$/, '')
+    method_suffix = $1
+
+    method_called = "_#{method_base}_called#{method_suffix}"
+    method_with_spy = "#{method_base}_with_spy#{method_suffix}"
+    method_without_spy = "#{method_base}_without_spy#{method_suffix}"
+
+    prototype = respond_to?(:singleton_class) ? singleton_class : metaclass
+    prototype.class_eval do
+
+      unless method_defined?(method_with_spy)
+
+        define_method method_called do
+        end
+
+        define_method method_with_spy do |*args, &block|
+          send(method_called, *args)
+          send(method_without_spy, *args, &block)
+        end
+        alias_method_chain method, :spy
+      end
+
+    end
+
+    expectation = negate ? :should_not_receive : :should_receive
+    send(expectation, method_called)
+  end
+
+  private
+
+  def setup_expectation_chain(parts)
+    obj = self
+    for part in parts
+      if part == parts.last
+        obj = add_expectation_chain_link(obj, part)
+      else
+        next_obj = Spec::Mocks::Mock.new('chain link')
+        add_expectation_chain_link(obj, part).at_least(:once).and_return(next_obj)
+        obj = next_obj
+      end
+    end
+    obj
+  end
+
+  def add_expectation_chain_link(obj, part)
+    if part.is_a?(Array)
+      obj.should_receive(part.first).with(*part[1..-1])
+    else
+      obj.should_receive(part)
+    end
+  end
+
+end
+
+Spec::Example::ExampleGroupMethods.class_eval do
+
+  # Improves it_should_behave_like in some ways:
+  # - It scopes the reused examples so #let und #subject does not bleed into the reusing example groups
+  # - It allows to parametrize the reused example group by appending a hash argument.
+  #   Every key/value pair in the hash will become a #let variable for the reused example group
+  # - You can call it with a block. It will be available to the reused example group as let(:block)
+  def it_should_act_like(shared_example_group, environment = {}, &block)
+    description = "as #{shared_example_group}"
+    description << " (#{environment.inspect})" if environment.present?
+    describe description do
+      environment.each do |name, value|
+        let(name) { value }
+      end
+      let(:block) { block } if block
+      it_should_behave_like(shared_example_group)
+    end
+  end
+
+end
+
+Spec::Rails::Example::ModelExampleGroup.class_eval do
+
+  def self.it_should_run_callbacks_in_order(*callbacks)
+    callbacks.push(:ordered => true)
+    it_should_run_callbacks(*callbacks)
+  end
+
+  def self.it_should_run_callbacks(*callbacks)
+    options = callbacks.last.is_a?(Hash) ? callbacks.pop : {}
+    reason = callbacks.pop if callbacks.last.is_a?(String)
+    hook = description_parts.last.sub(/^#/, '')
+    should = ['should run callbacks', callbacks.inspect, ('in order' if options[:ordered]), reason].compact.join ' '
+    send(:it, should) do
+      callbacks.each do |callback|
+        expectation = subject.should_receive(callback).once
+        expectation.ordered if options[:ordered]
+      end
+      run_state_machine_callbacks_from_prose(hook) || subject.run_callbacks(hook)
+    end
+  end
+
+  private
+
+  def run_state_machine_callbacks_from_prose(prose)
+    if parts = prose.match(/^(\w+) from ([\:\w]+) to ([\:\w]+)$/)
+      name = parts[1].to_sym
+      from = parts[2].sub(/^:/, '').to_sym
+      to = parts[3].sub(/^:/, '').to_sym
+      transition = StateMachine::Transition.new(subject, subject.class.state_machine, name, from, to)
+      transition.run_callbacks
+    end
+  end
+
+end
+
+ActiveRecord::Base.class_eval do
+
+  # Prevents the databse from being touched, but still runs all validations.
+  def keep_invalid!
+    errors.stub :empty? => false
+  end
+
+end
+
+Class.class_eval do
+
+  define_method :stub_any_instance do |stubs|
+    unstubbed_new = method(:new)
+    stub(:new).and_return do |*args|
+      unstubbed_new.call(*args).tap do |obj|
+        obj.stub stubs
+      end
+    end
+    stubs
+  end
+
+end

data/template/spec_candy.rails3.rb

@@ -0,0 +1,175 @@
+Object.class_eval do
+
+#  def should_receive_chain(*parts)
+#    setup_expectation_chain(parts)
+#  end
+#
+#  def should_not_receive_chain(*parts)
+#    setup_expectation_chain(parts, :negate => true)
+#  end
+#
+#  def self.new_with_stubs(attrs)
+#    new.tap { |obj| obj.stub(attrs) }
+#  end
+#
+#  def should_receive_and_return(methods_and_values)
+#    methods_and_values.each do |method, value|
+#      should_receive(method).and_return(value)
+#    end
+#  end
+#
+#  def self.new_and_store(options = {})
+#    new.tap do |record|
+#      record.send(:attributes=, options, false)
+#      record.save!(:validate => false)
+#    end
+#  end
+#
+#  def stub_existing(attrs)
+#    attrs.each do |method, value|
+#      if respond_to?(method, true)
+#        stub(method => value)
+#      else
+#        raise "Attempted to stub non-existing method ##{method} on a #{self.class.name}"
+#      end
+#    end
+#  end
+#
+#  def should_receive_and_execute(method, negate = false)
+#    method_base = method.to_s.gsub(/([\?\!\=\[\]]+)$/, '')
+#    method_suffix = $1
+#
+#    method_called = "_#{method_base}_called#{method_suffix}"
+#    method_with_spy = "#{method_base}_with_spy#{method_suffix}"
+#    method_without_spy = "#{method_base}_without_spy#{method_suffix}"
+#
+#    prototype = respond_to?(:singleton_class) ? singleton_class : metaclass
+#    prototype.class_eval do
+#
+#      unless method_defined?(method_with_spy)
+#
+#        define_method method_called do
+#        end
+#
+#        define_method method_with_spy do |*args, &block|
+#          send(method_called, *args)
+#          send(method_without_spy, *args, &block)
+#        end
+#        alias_method_chain method, :spy
+#      end
+#
+#    end
+#
+#    expectation = negate ? :should_not_receive : :should_receive
+#    send(expectation, method_called)
+#  end
+#
+  private
+
+  def setup_expectation_chain(parts, options = {})
+    obj = self
+    for part in parts
+      if part == parts.last
+        expectation = options[:negate] ? :should_not_receive : :should_receive
+        obj = add_expectation_chain_link(obj, expectation, part)
+      else
+        next_obj = RSpec::Mocks::Mock.new('chain link')
+        add_expectation_chain_link(obj, :stub, part).and_return(next_obj)
+        obj = next_obj
+      end
+    end
+    obj
+  end
+
+  def add_expectation_chain_link(obj, expectation, part)
+    if part.is_a?(Array)
+      obj.send(expectation, part.first).with(*part[1..-1])
+    else
+      obj.send(expectation, part)
+    end
+  end
+
+end
+
+RSpec::Core::ExampleGroup.class_eval do
+
+  def self.it_should_run_callbacks_in_order(*callbacks)
+    callbacks.push(:ordered => true)
+    it_should_run_callbacks(*callbacks)
+  end
+
+
+  # Improves it_should_behave_like in some ways:
+  # - It scopes the reused examples so #let und #subject does not bleed into the reusing example groups
+  # - It allows to parametrize the reused example group by appending a hash argument.
+  #   Every key/value pair in the hash will become a #let variable for the reused example group
+  # - You can call it with a block. It will be available to the reused example group as let(:block)
+  def self.it_should_act_like(shared_example_group, environment = {}, &block)
+    description = "as #{shared_example_group}"
+    description << " (#{environment.inspect})" if environment.present?
+    describe description do
+      environment.each do |name, value|
+        let(name) { value }
+      end
+      let(:block) { block } if block
+      it_should_behave_like(shared_example_group)
+    end
+  end
+
+  def self.it_should_run_callbacks(*callbacks)
+    options = callbacks.last.is_a?(Hash) ? callbacks.pop : {}
+    reason = callbacks.pop if callbacks.last.is_a?(String)
+    example_description = description
+    send(:it, ["should run callbacks", callbacks.inspect, ('in order' if options[:ordered]), reason].compact.join(' ')) do
+      # Set expectations
+      callbacks.each do |callback|
+        expectation = subject.should_receive(callback).once
+        expectation.ordered if options[:ordered]
+      end
+      run_state_machine_callbacks_from_prose(example_description) || run_active_record_callbacks_from_prose(example_description)
+    end
+  end
+
+  def run_active_record_callbacks_from_prose(prose)
+    hook = prose.split.last.sub(/^#/, '')
+    if hook.sub!(/_on_(create|update)$/, '')
+      condition = "validation_context == :#{$1}"
+    else
+      condition = nil
+    end
+    if hook == 'validate'
+      kind = 'before'
+      action = 'validate'
+    else
+      hook =~ /^(before|after|around)_(.*)$/
+      kind = $1
+      action = $2
+    end
+    # Run all matching callbacks
+    subject.send("_#{action}_callbacks").each do |callback|
+      if callback.kind.to_s == kind && (condition.nil? || callback.options[:if].include?(condition))
+        subject.send callback.filter.to_s.gsub(/[\(,\)]/, '').to_sym
+      end
+    end
+  end
+
+  def run_state_machine_callbacks_from_prose(prose)
+    if parts = prose.match(/^(\#\w+) from ([\:\w]+) to ([\:\w]+)$/)
+      name = parts[1].sub(/^#/, '').to_sym
+      from = parts[2].sub(/^:/, '').to_sym
+      to = parts[3].sub(/^:/, '').to_sym
+      transition = StateMachine::Transition.new(subject, subject.class.state_machine, name, from, to)
+      transition.run_callbacks
+    end
+  end
+
+end
+
+ActiveRecord::Base.class_eval do
+
+  # Prevents the database from being touched, but still runs all validations.
+  def keep_invalid!
+    errors.stub :empty? => false
+  end
+
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification 
+name: rspec_candy
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Henning Koch
+- Tobias Kraze
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: RSpec helpers and matchers we use in our daily work at makandra.
+email: henning.koch@makandra.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- lib/rspec_candy.rb
+- lib/rspec_candy/helpers/disposable_copy.rb
+- lib/rspec_candy/helpers/it_should_act_like.rb
+- lib/rspec_candy/helpers/new_with_stubs.rb
+- lib/rspec_candy/helpers/rails/create_without_callbacks.rb
+- lib/rspec_candy/helpers/rails/it_should_run_callbacks.rb
+- lib/rspec_candy/helpers/rails/prevent_storage.rb
+- lib/rspec_candy/helpers/should_receive_and_execute.rb
+- lib/rspec_candy/helpers/should_receive_and_return.rb
+- lib/rspec_candy/helpers/should_receive_chain.rb
+- lib/rspec_candy/helpers/stub_any_instance.rb
+- lib/rspec_candy/helpers/stub_existing.rb
+- lib/rspec_candy/switcher.rb
+- lib/rspec_candy/version.rb
+- rspec_candy.gemspec
+- spec/rspec1/Gemfile
+- spec/rspec1/Rakefile
+- spec/rspec1/app_root/config/boot.rb
+- spec/rspec1/app_root/config/database.yml
+- spec/rspec1/app_root/config/environment.rb
+- spec/rspec1/app_root/config/environments/in_memory.rb
+- spec/rspec1/app_root/config/environments/mysql.rb
+- spec/rspec1/app_root/config/environments/postgresql.rb
+- spec/rspec1/app_root/config/environments/sqlite.rb
+- spec/rspec1/app_root/config/environments/sqlite3.rb
+- spec/rspec1/app_root/config/initializers/state_machine.rb
+- spec/rspec1/app_root/config/routes.rb
+- spec/rspec1/app_root/log/.gitignore
+- spec/rspec1/rcov.opts
+- spec/rspec1/spec.opts
+- spec/rspec1/spec_helper.rb
+- spec/rspec2/.rspec
+- spec/rspec2/Gemfile
+- spec/rspec2/Rakefile
+- spec/rspec2/app_root/.gitignore
+- spec/rspec2/app_root/config/application.rb
+- spec/rspec2/app_root/config/boot.rb
+- spec/rspec2/app_root/config/database.yml
+- spec/rspec2/app_root/config/environment.rb
+- spec/rspec2/app_root/config/environments/in_memory.rb
+- spec/rspec2/app_root/config/environments/mysql.rb
+- spec/rspec2/app_root/config/environments/postgresql.rb
+- spec/rspec2/app_root/config/environments/sqlite.rb
+- spec/rspec2/app_root/config/environments/sqlite3.rb
+- spec/rspec2/app_root/config/environments/test.rb
+- spec/rspec2/app_root/config/initializers/backtrace_silencers.rb
+- spec/rspec2/app_root/config/initializers/inflections.rb
+- spec/rspec2/app_root/config/initializers/mime_types.rb
+- spec/rspec2/app_root/config/initializers/secret_token.rb
+- spec/rspec2/app_root/config/initializers/session_store.rb
+- spec/rspec2/app_root/config/initializers/state_machine.rb
+- spec/rspec2/app_root/config/locales/en.yml
+- spec/rspec2/app_root/config/routes.rb
+- spec/rspec2/app_root/log/.gitkeep
+- spec/rspec2/rcov.opts
+- spec/rspec2/spec_helper.rb
+- spec/shared/app_root/app/controllers/application_controller.rb
+- spec/shared/app_root/app/models/model.rb
+- spec/shared/app_root/app/models/state_machine_model.rb
+- spec/shared/app_root/config/initializers/state_machine.rb
+- spec/shared/app_root/db/migrate/001_create_model.rb
+- spec/shared/app_root/db/migrate/002_create_state_machine_model.rb
+- spec/shared/rspec_candy/helpers/disposable_copy_spec.rb
+- spec/shared/rspec_candy/helpers/it_should_act_like_spec.rb
+- spec/shared/rspec_candy/helpers/new_with_stubs_spec.rb
+- spec/shared/rspec_candy/helpers/rails/create_without_callbacks_spec.rb
+- spec/shared/rspec_candy/helpers/rails/it_should_run_callbacks_spec.rb
+- spec/shared/rspec_candy/helpers/rails/prevent_storage_spec.rb
+- spec/shared/rspec_candy/helpers/should_receive_and_execute_spec.rb
+- spec/shared/rspec_candy/helpers/should_receive_and_return_spec.rb
+- spec/shared/rspec_candy/helpers/should_receive_chain_spec.rb
+- spec/shared/rspec_candy/helpers/stub_any_instance_spec.rb
+- spec/shared/rspec_candy/helpers/stub_existing_spec.rb
+- spec/shared/support/matchers/pass_as_describe_block.rb
+- spec/shared/support/matchers/pass_as_example.rb
+- template/spec_candy.rails2.rb
+- template/spec_candy.rails3.rb
+homepage: https://github.com/makandra/rspec_candy
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: RSpec helpers and matchers we use in our daily work at makandra.
+test_files: []
+
+has_rdoc: