camcorder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de005ffb4a08afb00954a1998d9258193f3bbb73
+  data.tar.gz: 4d9d1e6af8707afc904d62cd8605ce40734ef1dc
+SHA512:
+  metadata.gz: 94cef4dab926fa7768e79a1c9c50003368b2ce14aa2c4a5757d8a2d5f467c9cbbd871bc7aa94fd43bd80f88ae8ac0fe47d335fb929123cbaae53c06695fa6505
+  data.tar.gz: ca4ed1520d25bcc8eba17733a289c76d563f48a564e3e4f08af4d441028f41be32f5ac8796672e96bdb17316aecee38dd82ee4512150929194fb8052e770556f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.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,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in camcorder.gemspec
+gemspec
+
+group :test, :development do
+  gem 'rspec'
+  gem 'pry'
+  gem 'byebug'
+  gem 'maybe'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gordon L. Hempton
+
+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,79 @@
+# Camcorder
+
+Need to have VCR-like functionality for more than just http? Wait no more. This gem allows you to record arbitrary method invocations from arbitrary objects.
+
+```ruby
+require 'camcorder'
+
+imap = Camcorder::Proxy.new(Net::IMAP, imap_host, imap_port, imap_ssl, nil, false)
+imap.login(username, decrypted_password)
+imap.search(query)
+imap.disconnect
+```
+
+The above code will create an actual `Net::IMAP` object the first time around. Subsequent invocations will not, instead using recorded values.
+
+For convenience, Camcorder provides a way to intercept the constructor for a class:
+
+```ruby
+require 'camcorder'
+
+Camcorder.intercept_constructor(Net::IMAP)
+
+imap = Net::IMAP.new(imap_host, imap_port, imap_ssl, nil, false)
+imap.login(username, decrypted_password)
+imap.search(query)
+imap.disconnect
+```
+
+## Side Effects
+
+By default, Camcorder matches up a method invocation to a recording based on the passed in arguments. Methods with side effects need to be explicitly noted:
+
+```ruby
+require 'camcorder'
+
+Camcorder.intercept_constructor(Net::IMAP) do
+  methods_with_side_effects :examine, :select
+end
+
+imap = Net::IMAP.new(imap_host, imap_port, imap_ssl, nil, false)
+imap.login(username, decrypted_password)
+imap.select('INBOX')
+imap.search(query)
+imap.select('Sent Items') # will cause the `search` call below to return a different value
+imap.search(query)
+imap.disconnect
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'camcorder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install camcorder
+
+## Usage with Rspec
+
+In your `spec_helper.rb` file:
+
+```
+require 'camcorder/rspec'
+
+Camcorder.configuration.recordings_dir = 'spec/recordings'
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/camcorder/fork )
+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/camcorder.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'camcorder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "camcorder"
+  spec.version       = Camcorder::VERSION
+  spec.authors       = ["Gordon L. Hempton"]
+  spec.email         = ["ghempton@gmail.com"]
+  spec.summary       = "VCR-like recording for arbitrary method invocations."
+  spec.description   = "VCR-like recording for arbitrary method invocations."
+  spec.homepage      = "https://github.com/ghempton/camcorder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5"
+  spec.add_development_dependency "rake"
+end

data/lib/camcorder.rb

@@ -0,0 +1,76 @@
+require "camcorder/version"
+require 'camcorder/errors'
+require 'camcorder/proxy'
+require 'camcorder/recorder'
+require 'camcorder/configuration'
+
+#
+# Provides similar functionality as the VCR gem but works on arbitrary objects.
+# This is useful for things like Net::IMAP and Net::SMTP which cannot be
+# captured by VCR.
+#
+module Camcorder
+  
+  def self.default_recorder
+    @default_recorder
+  end
+  
+  def self.default_recorder=(value)
+    @default_recorder = value
+  end
+  
+  def self.config
+    @config ||= Configuration.new
+  end
+  
+  #
+  # Creates a proxy subclass for the particular class
+  #
+  def self.proxy_class(klass, recorder=nil, &block)
+    Class.new(Proxy) do
+      class << self
+        attr_reader :klass
+        attr_reader :recorder
+      end
+      @klass = klass
+      @recorder = recorder
+      def initialize(*args)
+        recorder = self.class.recorder || Camcorder.default_recorder
+        super(recorder, self.class.klass, *args)
+      end
+      self.class_eval &block if block
+    end
+  end
+  
+  #
+  # Rewrites the `new` method on the passed in class to always return proxies.
+  #
+  def self.intercept_constructor(klass, recorder=nil, &block)
+    proxy_class = self.proxy_class(klass, recorder) do
+      def _initialize
+        @instance ||= klass._new(*@init_args)
+      end
+      self.class_eval &block if block
+    end
+    
+    klass.class_eval do
+      @proxy_class = proxy_class
+      class << self
+        alias_method :_new, :new
+        def new(*args)
+          @proxy_class.new(*args)
+        end
+      end
+    end
+  end
+  
+  def self.deintercept_constructor(klass)
+    klass.class_eval do
+      class << self
+        alias_method :new, :_new
+        remove_method :_new
+      end
+    end
+  end
+  
+end

data/lib/camcorder/configuration.rb

@@ -0,0 +1,13 @@
+module Camcorder
+  
+  class Configuration
+  
+    attr_accessor :recordings_dir
+    
+    def initialize
+      @recordings_dir = ''
+    end
+    
+  end
+  
+end

data/lib/camcorder/errors.rb

@@ -0,0 +1,51 @@
+module Camcorder
+  
+  class Error < StandardError; end
+  
+  class RecordingError < Error
+    attr_reader :key
+    def initialize(key)
+      @key = key
+    end
+    def message
+      "Recording for key #{key} has changed"
+    end
+  end
+  
+  class ProxyRecordingError < Error
+    attr_reader :klass, :name, :args, :side_effects
+    def initialize(klass, name, args, side_effects)
+      @klass = klass
+      @name = name
+      @args = args
+      @side_effects = side_effects
+    end
+    def message
+      "Recording for #{klass}.#{name} with args: #{args} and side_effects=#{side_effects} has changed. Consider using using `methods_with_side_effects`."
+    end
+  end
+  
+  class PlaybackError < Error
+    attr_reader :key
+    def initialize(key)
+      @key = key
+    end
+    def message
+      "Cannot find key '#{key}' for playback"
+    end
+  end
+  
+  class ProxyPlaybackError < Error
+    attr_reader :klass, :name, :args, :side_effects
+    def initialize(klass, name, args, side_effects)
+      @klass = klass
+      @name = name
+      @args = args
+      @side_effects = side_effects
+    end
+    def message
+      "Cannot find recording for #{klass}.#{name} with args: #{args} and side_effects=#{side_effects}"
+    end
+  end
+  
+end

data/lib/camcorder/proxy.rb

@@ -0,0 +1,76 @@
+module Camcorder
+
+  #
+  # Proxy which records all external methods
+  #
+  class Proxy
+    
+    attr_reader :klass
+    attr_reader :instance
+    attr_reader :recorder
+    attr_reader :side_effects
+    
+    def initialize(recorder, klass, *args)
+      @klass = klass
+      @init_args = args
+      @recorder = recorder
+      _add_side_effects(@init_args)
+    end
+    
+    def _initialize
+      @instance ||= klass.new(*@init_args)
+    end
+    
+    def _add_side_effects(args)
+      @side_effects = _hash_with_side_effects(args)
+    end
+    
+    def _hash_args(args)
+      Digest::MD5.hexdigest(YAML.dump(args))
+    end
+    
+    def _hash_with_side_effects(args)
+      if side_effects
+        args = args + [side_effects]
+      end
+      _hash_args(args)
+    end
+    
+    def _record(name, args, &block)
+      hash = _hash_with_side_effects(args)
+      key = "#{klass.name}-#{name}-#{hash}"
+      recorder.record key do
+        yield
+      end
+    rescue PlaybackError => e
+      raise ProxyPlaybackError.new(klass, name, args, side_effects)
+    rescue RecordingError => e
+      raise ProxyRecordingError.new(klass, name, args, side_effects)
+    end
+    
+    def method_missing(name, *args)
+      _record(name, args) do
+        _initialize.send name, *args
+      end
+    end
+    
+    def respond_to?(name)
+      super || _initialize.respond_to?(name)
+    end
+    
+    #
+    # These methods have "side effects" and will cause subsequent invocations of
+    # all methods to be re-recorded.
+    #
+    def self.methods_with_side_effects(*names)
+      names.each do |name|
+        define_method name do |*args|
+          _add_side_effects(args)
+          method_missing(name, *args)
+        end
+      end
+    end
+    
+  end
+
+end

data/lib/camcorder/recorder.rb

@@ -0,0 +1,71 @@
+require 'yaml'
+
+module Camcorder
+  
+  class Recorder
+
+    attr_reader :recordings
+    attr_reader :filename
+
+    def initialize(filename)
+      @filename = filename
+      @recordings = {}
+      @changed = false
+    end
+
+    def transaction(&block)
+      start
+      yield
+      commit
+    end
+
+    def start
+      if File.exists?(filename)
+        @recordings = YAML.load_file(filename)
+        @replaying = true
+      else
+        @recordings = {}
+        @replaying = false
+      end
+    end
+
+    def commit
+      return unless @changed
+      FileUtils.mkdir_p File.dirname(filename)
+      File.open(filename, 'w') {|f| YAML.dump(recordings, f) }
+    end
+
+    def record(key, &block)
+      if @replaying
+        if recordings.has_key?(key)
+          recordings[key]
+        else
+          raise PlaybackError.new(key)
+        end
+      else
+        result = yield
+        @changed = true
+        if recordings.has_key?(key)
+          if !deep_equals(recordings[key], result)
+            raise RecordingError(key)
+          end
+        else
+          # Make sure we store a copy of the result so future destructive mutations
+          # do not change this value
+          recordings[key] = deep_clone(result)
+        end
+        result
+      end
+    end
+
+    def deep_clone(value)
+      YAML.load(YAML.dump(value))
+    end
+    
+    def deep_equals(a, b)
+      YAML.dump(a) == YAML.dump(b)
+    end
+
+  end
+
+end

data/lib/camcorder/rspec.rb

@@ -0,0 +1,24 @@
+#
+# Setup the camcorder before every test
+#
+RSpec.configure do |config|
+  
+  recording_name_for = lambda do |metadata|
+    description = metadata[:description]
+
+    if example_group = metadata[:example_group]
+      [recording_name_for[example_group], description].reject{|d| !d || d == ''}.join('/')
+    else
+      description
+    end
+  end
+  
+  config.around(:each) do |example|
+    name = recording_name_for[example.metadata].gsub(/[^\w\-\/]+/, '_')
+    filename = File.join(Camcorder.config.recordings_dir, "#{name}.yml")
+    Camcorder.default_recorder = Camcorder::Recorder.new(filename)
+    Camcorder.default_recorder.transaction do
+      example.run
+    end
+  end
+end

data/lib/camcorder/version.rb

@@ -0,0 +1,3 @@
+module Camcorder
+  VERSION = "0.0.1"
+end

data/spec/camcorder/proxy_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+
+describe Camcorder::Proxy do
+  
+  subject{ Camcorder::Proxy.new(Camcorder.default_recorder, TestObject) }
+  
+  context 'when recording exists' do
+  
+    it 'should not call methods on actual instance' do
+      
+      expect_any_instance_of(TestObject).to_not receive(:simple_method)
+      expect(subject.simple_method).to eql(['A', 'B', 'C'])
+      
+    end
+    
+  end
+  
+  context 'when recording does not exist' do
+    
+    after(:all) do
+      File.delete('spec/recordings/Camcorder_Proxy/when_recording_does_not_exist/should_call_methods_on_actual_instance_and_record.yml')
+    end
+    
+    it 'should call methods on actual instance and record' do
+      
+      expect_any_instance_of(TestObject).to receive(:simple_method).and_call_original
+      expect(subject.simple_method).to eql(['A', 'B', 'C'])
+      
+    end
+    
+  end
+  
+  
+  describe '.methods_with_side_effects' do
+    
+    subject {
+      Class.new(Camcorder::Proxy) do
+        methods_with_side_effects :method_with_side_effects
+      end.new(Camcorder.default_recorder, TestObject)
+    }
+    
+    it 'should re-record for each invocation' do
+      
+      a = subject.method_with_side_effects
+      b = subject.method_with_side_effects
+      expect(a).to_not eq(b)
+      
+    end
+    
+    
+  end
+  
+  
+  
+end

data/spec/camcorder/recorder_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+
+describe Camcorder::Recorder do
+  
+  subject{ Camcorder::Recorder.new(filename) }
+  
+  describe '.transaction' do
+    
+    let(:key) { 'key' }
+    
+    context 'when recording exists' do
+      
+      let(:filename) { 'spec/fixtures/should_exist.yml'}
+      
+      it 'should return recorded value' do
+        subject.transaction do
+          result = subject.record 'key' do
+            raise 'should not get here'
+          end
+          expect(result).to eq('dis be da result')
+        end
+      end
+      
+      it 'should error on unknown key' do
+        expect {
+          subject.transaction do
+            result = subject.record 'another-key' do
+              raise 'should not get here'
+            end
+          end
+        }.to raise_error
+      end
+      
+    end
+    
+    context 'when no recording exists' do
+      
+      let(:filename) { 'spec/fixtures/should_not_exist.yml'}
+      
+      after do
+        File.delete(filename)
+      end
+      
+      it 'should create recording' do
+        
+        expect(File.exists?(filename)).to be_false
+        subject.transaction do
+          subject.record 'key' do
+            'dis be da result'
+          end
+        end
+        expect(File.exists?(filename)).to be_true
+        
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/camcorder_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Camcorder do
+  
+  describe 'constructor interception' do
+    
+    before do
+      Camcorder.intercept_constructor(TestObject)
+    end
+    
+    after do
+      Camcorder.deintercept_constructor(TestObject)
+    end
+    
+    describe '.new' do
+    
+      it 'should return a proxy' do
+        obj = TestObject.new
+        expect(obj).to be_a(Camcorder::Proxy)
+        expect(obj.simple_method).to eql(['A', 'B', 'C'])
+      end
+      
+    end
+    
+    context 'with multiple classes' do
+      
+      before do
+        Camcorder.intercept_constructor(TestObject2)
+      end
+      
+      after do
+        Camcorder.deintercept_constructor(TestObject2)
+      end
+      
+      describe '.new' do
+      
+        it 'should return proxies' do
+          obj = TestObject.new
+          obj2 = TestObject2.new(2)
+          
+          expect(obj2).to be_a(Camcorder::Proxy)
+          expect(obj2.simple_method).to eql([1, 2, 3])
+          
+          expect(obj).to be_a(Camcorder::Proxy)
+          expect(obj.simple_method).to eql(['A', 'B', 'C'])
+        end
+        
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/fixtures/should_exist.yml

@@ -0,0 +1,2 @@
+---
+key: dis be da result

data/spec/recordings/Camcorder/constructor_interception/_new/should_return_a_proxy.yml

@@ -0,0 +1,5 @@
+---
+TestObject-simple_method-cdc941172e4d28939f6513e81222285c:
+- A
+- B
+- C

data/spec/recordings/Camcorder/constructor_interception/with_multiple_classes/_new/should_return_proxies.yml

@@ -0,0 +1,9 @@
+---
+TestObject2-simple_method-4de0fd48a5b0c805e290ecc39c85f9e7:
+- 1
+- 2
+- 3
+TestObject-simple_method-cdc941172e4d28939f6513e81222285c:
+- A
+- B
+- C

data/spec/recordings/Camcorder_Proxy/_methods_with_side_effects/should_re-record_for_each_invocation.yml

@@ -0,0 +1,3 @@
+---
+TestObject-method_with_side_effects-663f267dd7915410d1fce869a1bb0039: 1
+TestObject-method_with_side_effects-4ad0eb78b76e60e313f8d7b40194d3fc: 2

data/spec/recordings/Camcorder_Proxy/when_recording_exists/should_not_call_methods_on_actual_instance.yml

@@ -0,0 +1,5 @@
+---
+TestObject-simple_method-cdc941172e4d28939f6513e81222285c:
+- A
+- B
+- C

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'json'
+require 'rspec'
+
+require 'camcorder'
+require 'camcorder/rspec'
+
+require 'support/test_object'
+require 'support/test_object2'
+require 'byebug'
+
+Camcorder.config.recordings_dir = 'spec/recordings'

data/spec/support/test_object.rb

@@ -0,0 +1,17 @@
+class TestObject
+  
+  attr_reader :count
+  
+  def initialize()
+    @count = 0
+  end
+  
+  def simple_method
+    ['A', 'B', 'C']
+  end
+  
+  def method_with_side_effects
+    @count += 1
+  end
+  
+end

data/spec/support/test_object2.rb

@@ -0,0 +1,11 @@
+class TestObject2
+  
+  def initialize(count)
+    @count = count
+  end
+  
+  def simple_method
+    [1, 2, 3]
+  end
+  
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: camcorder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gordon L. Hempton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: VCR-like recording for arbitrary method invocations.
+email:
+- ghempton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- camcorder.gemspec
+- lib/camcorder.rb
+- lib/camcorder/configuration.rb
+- lib/camcorder/errors.rb
+- lib/camcorder/proxy.rb
+- lib/camcorder/recorder.rb
+- lib/camcorder/rspec.rb
+- lib/camcorder/version.rb
+- spec/camcorder/proxy_spec.rb
+- spec/camcorder/recorder_spec.rb
+- spec/camcorder_spec.rb
+- spec/fixtures/should_exist.yml
+- spec/recordings/Camcorder/constructor_interception/_new/should_return_a_proxy.yml
+- spec/recordings/Camcorder/constructor_interception/with_multiple_classes/_new/should_return_proxies.yml
+- spec/recordings/Camcorder_Proxy/_methods_with_side_effects/should_re-record_for_each_invocation.yml
+- spec/recordings/Camcorder_Proxy/when_recording_exists/should_not_call_methods_on_actual_instance.yml
+- spec/spec_helper.rb
+- spec/support/test_object.rb
+- spec/support/test_object2.rb
+homepage: https://github.com/ghempton/camcorder
+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.2.0
+signing_key: 
+specification_version: 4
+summary: VCR-like recording for arbitrary method invocations.
+test_files:
+- spec/camcorder/proxy_spec.rb
+- spec/camcorder/recorder_spec.rb
+- spec/camcorder_spec.rb
+- spec/fixtures/should_exist.yml
+- spec/recordings/Camcorder/constructor_interception/_new/should_return_a_proxy.yml
+- spec/recordings/Camcorder/constructor_interception/with_multiple_classes/_new/should_return_proxies.yml
+- spec/recordings/Camcorder_Proxy/_methods_with_side_effects/should_re-record_for_each_invocation.yml
+- spec/recordings/Camcorder_Proxy/when_recording_exists/should_not_call_methods_on_actual_instance.yml
+- spec/spec_helper.rb
+- spec/support/test_object.rb
+- spec/support/test_object2.rb