rspecproxies 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20e5e79a339c7c8ef8b996aa4ce57b02b093b566
-  data.tar.gz: 60228d6d6d959779e292a86e0094d65feebdb408
+  metadata.gz: 653a8207a9d33581245cf8d80ad0da672a1c7b1b
+  data.tar.gz: 34c8feeb474c18603ce170ac64f1474a7783f8f7
 SHA512:
-  metadata.gz: fde4298b0e9d55e12bbea57cec20e2dd9a0f64acc6a0574c2b9ab0197f34ac05fa805bdb41b0509eab6cd2f0df961b2e65b532101e30cd2ec90a448c8f256e1c
-  data.tar.gz: c6d64df427d70ed32067f63ddb749e1cba22a0340df33769362e8b5f3d4c02e2644c0ea3caf3640e75a529dffece2e467169df6493e29e5c522711b747ed0604
+  metadata.gz: afcc35da544a16f6361efae3853b9f5f13930b41112ebf3938824bf3bda64fe28f1be1e9d2bcdd9e3b95a36d6b081f1e6674d67a85460d231f682d8233aa4b88
+  data.tar.gz: f412b271caa87b567f928ebd725947f47829b597848d2301b299c7bb4975f40925aa2980fa95a221b7dabb50197d2b0381fc30263b415c511b5b6d4528b9a743

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+script: bundle exec rake
+

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -1,6 +1,12 @@
-# Rspecproxies
+# RSpecProxies
 
-Special RSpec extensions to simplify mocking by providing proxies
+Special RSpec extensions to simplify mocking by providing proxies.
+
+Here are the goals of mock proxies :
+
+* simplify mock setup
+* minimize method calls verifications
+* capture return values and calls
 
 ## Installation
 
@@ -18,7 +24,64 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Just as inspiration, here are a few sample usages :
+
+### Verify caching with capture_results_from
+
+```ruby
+it 'caches users' do
+  users = User.capture_results_from(:load)
+
+  controller.login('joe', 'secret')
+  controller.login('joe', 'secret')
+
+  expect(users).to have_exactly(2).items
+end
+```
+
+### Verify loaded data with capture_result_from
+
+```ruby
+it 'loads the actual user' do
+  capture_result_from(User, :load, into: :user)
+
+  controller.login('joe', 'secret')
+
+  expect(response).to redirect_to(@user.homepage)
+end
+```
+
+### Simulate unreliable network with on_call_to
+
+```ruby
+it 'retries on error' do
+   i = 0
+   Resource.on_call_to(:get) do |*args|
+      i++
+      raise RuntimeError.new if i % 3==0
+   end
+
+   resources = Resource.get_at_least(10)
+
+   expect(resources).to have_exactly(9).items
+end
+```
+
+### Setup deep stubs with proxy_chain
+
+```ruby
+it 'rounds the completion ratio' do
+   RenderingTask.proxy_chain(:load, :completion_ratio) {|s| s.and_return(0.2523) }
+
+   renderingController.show
+
+   expect(response).to include('25%')
+end
+```
+
+### Get best of both worlds with in memory databases
+
+Combine proxies with an inmemory database (like SQLite) while testing, and you'll get clear, straightforward and fast tests !
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rspecproxies/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module RSpecProxies
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/rspecproxies.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard-rspec"
 end

data/spec/rspecproxies/proxies_spec.rb

@@ -0,0 +1,96 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+module RSpecProxies
+
+  class User
+    def self.load(name)
+      User.new(name)
+    end
+
+    def initialize(name)
+      @name = name
+    end
+    attr_reader :name
+
+    def url
+      case name
+      when 'Joe'
+        'http://www.greatjoe.net'
+      when 'Jim'
+        'http://www.bigjim.net'
+      when 'Joe'
+        "http://www.#{name}.net"
+      end
+    end
+
+    def ==(o)
+      o.class == self.class && o.name == self.name
+    end
+
+  end
+
+  class ProfileController
+
+    def render(name)
+      view_for(User.load(name))
+    end
+
+    private
+
+    def view_for(user)
+      "<html><body><a href='#{user.url}'>#{user.name}</a></body></html>"
+    end
+  end
+
+  describe 'proxies' do
+
+    before :each do
+      @controller = ProfileController.new
+    end
+
+    it 'hooks on return from a method' do
+      user = nil
+      User.on_result_from(:load) {|u| user = u}
+
+      @controller.render('Joe')
+
+      expect(user).to eq(User.new('Joe'))
+    end
+
+    it 'has a shortcut to collect return values from a method' do
+      users = User.capture_results_from(:load)
+
+      @controller.render('Joe')
+      @controller.render('Jim')
+
+      expect(users).to eq([User.new('Joe'), User.new('Jim')])
+    end
+
+    it 'has a shortcut to collect the latest return value from a method' do
+      capture_result_from(User, :load, into: :user)
+
+      html = @controller.render('Joe')
+
+      expect(html).to include(@user.url)
+    end
+
+    it 'hooks on arguments before a method call' do
+      User.on_call_to(:load) do |name|
+        raise RuntimeError.new if name == 'Jim'
+      end
+
+      expect(@controller.render('Joe')).not_to be_nil
+      expect{@controller.render('Jim')}.to raise_error(RuntimeError)
+    end
+
+    it "can setup deep stubs on yet unloaded instances" do
+      User.proxy_chain(:load, :url) {|s| s.and_return('http://pirates.net')}
+
+      html = @controller.render('Jack')
+
+      expect(html).to include('http://pirates.net')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# -*- encoding: utf-8 -*-
+
+require 'rspecproxies'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspecproxies
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Philou
@@ -31,7 +31,7 @@ cert_chain:
   yLcl1cmm5ALtJ/+Bkkmp0i4amXeTDMvq9r8PBsVsQwxYOYJBP+Umxz3PX6HjFHrQ
   XdkXx3oZ
   -----END CERTIFICATE-----
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -75,6 +75,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !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: guard-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: Proxy doubles for RSpec
 email:
 - philippe.bourgau@gmail.com
@@ -83,7 +111,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -91,6 +122,8 @@ files:
 - lib/rspecproxies/proxies.rb
 - lib/rspecproxies/version.rb
 - rspecproxies.gemspec
+- spec/rspecproxies/proxies_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/philou/rspecproxies
 licenses:
 - MIT
@@ -115,4 +148,6 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Special RSpec extensions to simplify mocking by providing proxies
-test_files: []
+test_files:
+- spec/rspecproxies/proxies_spec.rb
+- spec/spec_helper.rb