rspec-coldep 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69c210795fa47ca6ed4d38abfd61aa5b7e96dac6
+  data.tar.gz: 92d099583fca68f93374903f58f151d0145e6086
+SHA512:
+  metadata.gz: f55c2593719069b03299275813c6ed02f356ae78fb1b541219cdde5e32a71900cc08dae5e717bb13742a48380fe65cdfbbfd6b91ff9aa25983ed7d66a061fd62
+  data.tar.gz: 87627d9119fc465b076a337680444686b71f891f3c166b090b0b81fb7da56d706aee501d783d3946422742e192c56f6e0b14a67cd881632665ee8c17fe76ea1d

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-coldep.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Daubert
+
+MIT License
+
+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,60 @@
+# RSpec-ColDep
+
+Col(laborators) & Dep(endencies)
+
+Syntax for specifing RSpec stubs and test doubles that mimicks how they are used.
+
+This is an experiment to see if test setup code can more explicitly document the dependencies and collaborators of objects under test.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-coldep'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-coldep
+
+## Documenting dependencies stubs constants
+
+RSpec-ColDep syntax documents dependencies of the object under test and creates stubs based on the example usage provided via block:
+
+    dependency 'User' do
+      User.find('1234') == 'a single fake user'
+      User.all == 'a couple fake users'
+    end
+
+is effectively the same as:
+
+    User.stub(:find).with('1234').and_return('a single fake user')
+    User.stub(:all).and_return('a couple fake users')
+
+## Documenting collaborators builds test doubles
+
+RSpec-ColDep syntax documents a collaborator's interface with the object under test and builds a test double based on the example usage provided via block:
+
+    fake_user = collaborator do |user|
+      user.first_name == 'Billy'
+      user.last_name == 'Jean'
+    end
+
+is effectively the same as:
+
+    fake_user = double(first_name: 'Billy', last_name: 'Jean')
+
+## How is this beneficial?
+
+This is just an experiment and may very well be a terrible idea. The thought that this gem explores is the ability to define dependencies and collaborating objects by writing code that documents how they are used without being litered by mocking framework method names like `stub`, `with`, `and_returns`, etc.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rspec/coldep.rb

@@ -0,0 +1,37 @@
+module RSpec
+  module Coldep
+    class StubBuilder
+      def initialize(target)
+        @target = target
+      end
+
+      def method_missing(method, *args, &block)
+        @stub = [method, args]
+        self
+      end
+
+      def ==(return_value)
+        @target.stub(@stub[0]).with(*@stub[1]).and_return(return_value)
+      end
+    end
+
+    module Helpers
+      def collaborator(name = nil)
+        double(name).tap do |fake|
+          yield StubBuilder.new(fake)
+        end
+      end
+
+      def dependency(stub_class_name)
+        fake = double
+        stub_const(stub_class_name, StubBuilder.new(fake))
+        yield
+        stub_const(stub_class_name, fake)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Coldep::Helpers
+end

data/rspec-coldep.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-coldep"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Matt Daubert"]
+  spec.email         = ["mdaubert@gmail.com"]
+  spec.description   = %q{RSpec mocking syntax using collaborators and dependencies}
+  spec.summary       = %q{Mock how you code, code how you mock.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rspec/coldep'

data/spec/usage_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'usage' do
+  it 'mocks an undefined constant' do
+    dependency 'User' do
+      User.find('1234') == 'a single fake user'
+      User.all == 'a couple fake users'
+    end
+
+    expect(User.find('1234')).to eq('a single fake user')
+    expect(User.all).to eq('a couple fake users')
+  end
+
+  it 'creates a test double' do
+    user = collaborator do |user|
+      user.first_name == 'Billy'
+      user.last_name == 'Jean'
+    end
+
+    expect(user.first_name).to eq('Billy')
+    expect(user.last_name).to eq('Jean')
+  end
+
+  it 'allows defining collaborators inside of dependencies' do
+    dependency 'User' do
+      User.find('1234') == collaborator do |user|
+        user.permalink == '1234-billy-jean'
+      end
+    end
+
+    expect(User.find('1234').permalink).to eq('1234-billy-jean')
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rspec-coldep
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Daubert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RSpec mocking syntax using collaborators and dependencies
+email:
+- mdaubert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/coldep.rb
+- rspec-coldep.gemspec
+- spec/spec_helper.rb
+- spec/usage_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Mock how you code, code how you mock.
+test_files:
+- spec/spec_helper.rb
+- spec/usage_spec.rb