ruby-recorder 0.0.1

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/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3@recorder --create

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in recorder.gemspec
+gemspec
+
+group :development do
+  gem 'minitest'
+  #gem 'pry'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Bensoussan
+
+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,112 @@
+# Ruby Recorder
+
+Recorder dumps the result of your ruby code to a YAML file for faster tests or to compare the result between two execution.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-recorder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-recorder
+
+## Exemples
+
+### Refactor
+
+Imagine you want to refactor an endpoint on your backend api and want to make sure the response is the same:
+
+```
+  Recorder.config do |c|
+    c.verbose = true
+    c.stubb = false
+  end
+
+  # this will call your backend and 
+  # dump the result in parsing.yml
+  # let's say the response is : [{"username"=>"Michael Bensoussan"}]
+  Recorder.dump_to('refactor.yml') do
+    HTTParty.get('http://my_backend/users').parsed_response
+  end
+
+  # this will call your backend and compare the result to
+  # what's in refactor.yml ([{"username"=>"Michael Bensoussan"}])
+  # let's say the new response is [{"username"=>"Michael"}]
+  Recorder.dump_to('refactor.yml') do
+    HTTParty.get('http://my_backend/users').parsed_response
+  end
+
+```
+
+Executing this code will outputs a (colored) diff :
+
+```
+  Recorder: result is different from last run
+  ---
+  - username: Michael Bensoussan- username: Michael
+```
+
+### Faster tests
+
+The first time you run this test, you will call the backend but for all the following runs `Recorder` will load the result from the YAML file.
+
+```
+  class TestRecorder < MiniTest::Unit::TestCase
+
+    def setup
+      Recorder.config do |c|
+        c.verbose = true
+        c.stubb = true
+        c.records_dir = 'backend_responses/'
+      end
+    end
+
+    def test_users
+      users = Recorder.dump_to('refactor.yml') do
+        HTTParty.get('http://my_backend/users').parsed_response
+      end
+
+      assert_equal [{"username"=>"Michael Bensoussan"}], users
+    end
+
+  end
+```
+
+## Usage
+
+```
+  Recorder.config do |c|
+    c.verbose = true
+    c.records_dir = 'records/'
+    c.stubb = false
+  end
+```
+
+### records_dir
+
+The `records_dir` option sets the directory where your records will be saved.
+
+### stubb
+
+When `stubb = true`, your code will only be run once. Future runs will load the result from the yaml file.
+When `stubb = false`, your code will be run every time.
+
+### verbose
+
+The `verbose` option will outputs a nice diff (with the `differ` gem) if the output is different from the last run.
+Of course this only works if `stubb = false`.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/recorder.rb

@@ -0,0 +1,76 @@
+require "recorder/version"
+require 'yaml'
+require 'differ'
+require 'colored'
+
+module Recorder
+  Config = Struct.new(:records_dir, :verbose, :stubb)
+  @@config = Config.new
+
+  class << self
+    attr_reader :config
+
+    # Configure Recorder
+    #
+    # ==== Examples
+    #   Recorder.config do |c|
+    #     c.verbose = true
+    #     c.stubb = true
+    #     c.records_dir = 'records/'
+    #   end
+    def config(&block)
+      if block_given?
+        @@config = Config.new
+        @@config.tap(&block)
+      else
+        @@config
+      end
+    end
+
+    def dump_to file
+      if @@config.records_dir
+        Dir.mkdir @@config.records_dir unless File.directory? @@config.records_dir
+        file = File.join(@@config.records_dir, file)
+      end
+
+      if !@@config.stubb
+        result = yield
+        yaml_result = result.to_yaml
+        if File.exist? file
+          old_result = YAML.load_file(file)
+          if old_result != result
+            outputs "Recorder: result is different from last run".red
+            Differ.format = :color
+            outputs Differ.diff_by_line(yaml_result.to_s, old_result.to_s)
+          else
+            outputs "Recorder: result is the same".green
+          end
+        else
+          File.open(file, 'w' ) do |out|
+            YAML.dump(result, out)
+          end
+          outputs "Recorder: recorded in #{file}".green
+        end
+        return result
+      else
+        if File.exist? file
+          outputs "Recorder: loaded from #{file}".green
+          return YAML.load_file(file)
+        else
+          result = yield
+          yaml_result = result.to_yaml
+          File.open(file, 'w' ) do |out|
+            YAML.dump(result, out)
+          end
+          outputs "Recorder: recorded in #{file}".green
+          return result
+        end
+      end
+    end
+
+    private
+      def outputs msg
+        puts msg if @@config.verbose
+      end
+  end
+end

data/lib/recorder/version.rb

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

data/recorder.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/recorder/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael Bensoussan"]
+  gem.email         = ["mbensoussan.is@gmail.com"]
+  gem.description   = %q{Ruby Recorder dumps the result of your ruby code to a YAML file for faster tests or to compare the result between two execution.}
+  gem.summary       = %q{Dump your ruby to YAML for refactoring and faster tests}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ruby-recorder"
+  gem.require_paths = ["lib"]
+  gem.version       = Recorder::VERSION
+
+  gem.add_dependency('differ')
+  gem.add_dependency('colored')
+end

data/tests/recorder_tests.rb

@@ -0,0 +1,119 @@
+require 'recorder'
+
+require 'rubygems'
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/unit'
+
+class TestRecorder < MiniTest::Unit::TestCase
+  def test_no_verbose
+    Recorder.config do |c|
+      c.verbose = false
+    end
+    
+    assert_silent do
+      Recorder.dump_to('test_verbose.yml') do
+        [1, 2, 3]
+      end
+    end
+  end
+
+  def test_verbose
+    Recorder.config do |c|
+      c.verbose = false
+    end
+    
+    assert_output do
+      Recorder.dump_to('test_verbose.yml') do
+        [1, 2, 3]
+      end
+    end
+  end
+
+  def test_directory
+    assert_equal false, File.directory?('records')
+    
+    Recorder.config do |c|
+      c.records_dir = 'records/'
+    end
+
+    Recorder.dump_to('test_directory.yml') do
+      [1, 2, 3]
+    end
+
+    assert_equal true, File.exist?("records/test_directory.yml")
+  end
+
+  def test_no_stubb
+    Recorder.config do |c|
+      c.stubb = false
+    end
+
+    assert_output "TOTO\n" do
+      Recorder.dump_to('test_no_stubb.yml') do
+        -> {puts "TOTO"}.call
+      end
+    end
+
+    assert_output "TOTO\n" do
+      Recorder.dump_to('test_no_stubb.yml') do
+        -> {puts "TOTO"}.call
+      end
+    end
+
+    first_run = Recorder.dump_to('refactor.yml') do
+      [{"username"=>"Michael Bensoussan"}]
+    end
+
+    second_run = Recorder.dump_to('refactor.yml') do
+      [{"username"=>"Michael"}]
+    end
+
+    refute_equal first_run, second_run
+  end
+
+  def test_stubb
+    Recorder.config do |c|
+      c.stubb = true
+    end
+
+    assert_output "TOTO\n" do
+      Recorder.dump_to('test_stubb.yml') do
+        -> {puts "TOTO"}.call
+      end
+    end
+
+    # this won't be call
+    assert_silent do
+      Recorder.dump_to('test_stubb.yml') do
+        -> {puts "TOTO"}.call
+      end
+    end
+
+    first_run = Recorder.dump_to('refactor.yml') do
+      [{"username"=>"Michael Bensoussan"}]
+    end
+
+    second_run = Recorder.dump_to('refactor.yml') do
+      [{"username"=>"Michael"}]
+    end
+
+    assert_equal first_run, second_run
+  end
+end
+
+MiniTest::Unit.after_tests do
+  files_to_clean = [
+    "test_verbose.yml",
+    "records/test_directory.yml",
+    "test_no_stubb.yml",
+    "test_stubb.yml",
+    "refactor.yml"
+  ]
+  files_to_clean.each do |file|
+    File.delete(File::expand_path("../../#{file}", __FILE__))
+  end
+
+  records_dir = File::expand_path("../../records", __FILE__)
+  Dir.delete(records_dir) if File.directory?(records_dir)
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ruby-recorder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Bensoussan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: differ
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Recorder dumps the result of your ruby code to a YAML file for faster
+  tests or to compare the result between two execution.
+email:
+- mbensoussan.is@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/recorder.rb
+- lib/recorder/version.rb
+- recorder.gemspec
+- tests/recorder_tests.rb
+homepage: ''
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Dump your ruby to YAML for refactoring and faster tests
+test_files: []