git-approvals 0.1.2

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

@@ -0,0 +1,2 @@
+$: << './lib'
+require 'git-approvals'

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch( %r{^spec/.+_spec\.rb$} )
+  watch( %r{^lib/(.+)\.rb$}     ){ |m| "spec/#{m[1]}_spec.rb" }
+  watch( 'spec/spec_helper.rb'  ){ 'spec' }
+  watch( 'Gemfile.lock'         ){ 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeremy Ruppel
+
+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,57 @@
+# Git::Approvals
+
+Simple git-powered approval tests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'git-approvals'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install git-approvals
+
+## Usage
+
+>  TODO describe standalone usage
+
+### With RSpec
+
+In your spec_helper.rb or wherever, simply `require 'rspec/approvals'`.
+Now you can use the `verify` expectation in your specs:
+
+`spec/foo_spec.rb`
+
+``` ruby
+require 'spec_helper'
+
+describe Foo do
+
+  example 'bar' do
+    verify { Foo.bar }
+  end
+end
+```
+
+The result of `Foo.bar` will be written to `spec/foo_spec/foo/bar.txt`.
+The test will fail because the file is not checked in to your git repo,
+meaning you haven't approved it yet, so add it to approve it:
+
+`git add spec/foo_spec/foo_bar.txt`
+
+Another test run shows that the test now passes. On the next test run, the
+same file will be written out. If git says the file has changed, the
+test will fail.
+
+## 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/git-approvals.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git/approvals/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "git-approvals"
+  spec.version       = Git::Approvals::VERSION
+  spec.authors       = ["Jeremy Ruppel"]
+  spec.email         = ["jeremy.ruppel@gmail.com"]
+  spec.description   = %q{Simple git-powered approval tests. With RSpec integration.}
+  spec.summary       = %q{Simple git-powered approval tests.}
+  spec.homepage      = 'https://github.com/jeremyruppel/git-approvals'
+  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_dependency 'awesome_print', '1.1.0'
+
+  spec.add_development_dependency 'bundler',     '~> 1.3'
+  spec.add_development_dependency 'rspec',       '~> 2.13.0'
+  spec.add_development_dependency 'guard-rspec', '~> 2.5.2'
+  spec.add_development_dependency 'rb-fsevent',  '~> 0.9'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+end

data/lib/git/approvals/approval.rb

@@ -0,0 +1,66 @@
+require 'open3'
+
+module Git
+  module Approvals
+    class Approval
+
+      FORMATTERS = {
+        :txt => lambda { |object|
+          require 'awesome_print'
+          object.awesome_inspect :plain => true, :indent => 2
+        },
+        :json => lambda { |string|
+          require 'json'
+          JSON.pretty_generate JSON.parse( string )
+        }
+      }
+
+      def initialize( path, options={} ) # :nodoc:
+        @path, @options = path, options
+
+        # rewrite the extension for the file based on the format
+        @path.chomp! File.extname( @path )
+        @path << '.' << format.to_s
+      end
+      attr_reader :path, :options
+
+      ##
+      #
+      def diff( string, &block )
+        # Make sure the directory of the file exists.
+        FileUtils.mkdir_p File.dirname( path )
+
+        # Write the new string to the file.
+        File.open path, 'w' do |f|
+          f << FORMATTERS[ format ][ string ]
+        end
+
+        # If the file hasn't been checked in, raise an error.
+        sh "git ls-files #{path} --error-unmatch" do |err|
+          raise Errno::ENOENT, path
+        end
+
+        # If the file has changed, call the block.
+        sh "git diff --exit-code #{path}" do |err|
+          block.call err
+        end
+      end
+
+      ##
+      # Shells out the given command. If the command exits with success,
+      # does nothing. If the command does not exit with success, yields
+      # the error output to the block.
+      def sh( cmd )
+        out, cmd = Open3.capture2e cmd
+        yield out if !cmd.success?
+      end
+
+      ##
+      # The format of this approval. Determines the file extension
+      # and also the formatter to use when writing the approval file.
+      def format
+        options[ :format ] || :txt
+      end
+    end
+  end
+end

data/lib/git/approvals/utils.rb

@@ -0,0 +1,17 @@
+module Git
+  module Approvals
+    module Utils
+
+      ##
+      # Converts a string into a string that can be used as a filename.
+      def filenamify( string )
+        string
+          .gsub( /([a-z])([A-Z])/, '\1_\2' )
+          .gsub( /\W+/, '_' )
+          .gsub( /^_|_$/, '' )
+          .downcase
+      end
+      module_function :filenamify
+    end
+  end
+end

data/lib/git/approvals/version.rb

@@ -0,0 +1,5 @@
+module Git
+  module Approvals
+    VERSION = '0.1.2'
+  end
+end

data/lib/git/approvals.rb

@@ -0,0 +1,8 @@
+require 'git/approvals/version'
+
+module Git
+  module Approvals
+    autoload :Approval, 'git/approvals/approval'
+    autoload :Utils,    'git/approvals/utils'
+  end
+end

data/lib/git-approvals.rb

@@ -0,0 +1 @@
+require 'git/approvals'

data/lib/rspec/approvals.rb

@@ -0,0 +1,44 @@
+require 'git-approvals'
+
+module RSpec
+  module Approvals
+
+    ##
+    # Verifies that the result of the block is the same as the approved
+    # version.
+    def verify( options={}, &block )
+      approval = Git::Approvals::Approval.new( approval_path, options )
+      approval.diff( block.call ) do |err|
+        ::RSpec::Expectations.fail_with err
+      end
+    rescue Errno::ENOENT => e
+      ::RSpec::Expectations.fail_with e.message
+      EOS
+    end
+
+    ##
+    # The path to the approval for this example
+    def approval_path
+      File.join approval_directory, approval_filename
+    end
+
+    ##
+    # The approval filename
+    def approval_filename
+      parts = [ example, *example.example_group.parent_groups ].map do |ex|
+        Git::Approvals::Utils.filenamify ex.description
+      end
+      File.join parts.to_a.reverse
+    end
+
+    ##
+    # The directory containing this spec's approvals
+    def approval_directory
+      example.file_path.sub /\.rb$/, ''
+    end
+  end
+
+  ##
+  #
+  configure { |config| config.include RSpec::Approvals }
+end

data/spec/fixtures/array.txt

@@ -0,0 +1,5 @@
+[
+  [0] :foo,
+  [1] :bar,
+  [2] :baz
+]

data/spec/fixtures/hash.json

@@ -0,0 +1,4 @@
+{
+  "foo": "bar",
+  "baz": "quux"
+}

data/spec/fixtures/hash.txt

@@ -0,0 +1,4 @@
+{
+  :foo => "bar",
+  :baz => "quux"
+}

data/spec/fixtures/string.txt

@@ -0,0 +1 @@
+"IT WERKS"

data/spec/git/approvals/approval_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Git::Approvals::Approval do
+
+  describe 'initialize' do
+    subject { described_class.new './foo/bar.txt' }
+
+    its( :path    ){ should == './foo/bar.txt' }
+    its( :options ){ should == { } }
+  end
+
+  describe '#diff' do
+    subject { described_class.new './foo/bar.txt' }
+
+    before { FileUtils.stub :mkdir_p => true }
+    before { File.stub :open => true }
+
+    it 'raises an exception when the file is not checked in' do
+      Open3.should_receive( :capture2e ).with( 'git ls-files ./foo/bar.txt --error-unmatch' ) do
+        [ '', double( 'status', :success? => false ) ]
+      end
+      expect { |block| subject.diff '', &block }.to raise_error( Errno::ENOENT, 'No such file or directory - ./foo/bar.txt' )
+    end
+    it 'calls the block when the file has been changed' do
+      Open3.should_receive( :capture2e ).with( 'git ls-files ./foo/bar.txt --error-unmatch' ) do
+        [ '', double( 'status', :success? => true ) ]
+      end
+      Open3.should_receive( :capture2e ).with( 'git diff --exit-code ./foo/bar.txt' ) do
+        [ 'error verbatim', double( 'status', :success? => false ) ]
+      end
+      expect { |block| subject.diff '', &block }.to yield_with_args( 'error verbatim' )
+    end
+    it 'does nothing when the file has not been changed' do
+      Open3.should_receive( :capture2e ).with( 'git ls-files ./foo/bar.txt --error-unmatch' ) do
+        [ '', double( 'status', :success? => true ) ]
+      end
+      Open3.should_receive( :capture2e ).with( 'git diff --exit-code ./foo/bar.txt' ) do
+        [ '', double( 'status', :success? => true ) ]
+      end
+      expect { |block| subject.diff '', &block }.not_to yield_control
+    end
+  end
+
+  describe 'extensions' do
+    it 'leaves the extension if specified' do
+      approval = described_class.new './foo/bar.txt'
+      approval.path.should == './foo/bar.txt'
+    end
+    it 'uses the format extension if provided' do
+      approval = described_class.new './foo/bar.baz', :format => :txt
+      approval.path.should == './foo/bar.txt'
+    end
+  end
+
+  describe 'formats' do
+    it 'formats strings' do
+      approval = described_class.new './spec/fixtures/string.txt'
+      approval.diff( 'IT WERKS' ){ |diff| fail diff }
+    end
+    it 'formats arrays' do
+      approval = described_class.new './spec/fixtures/array.txt'
+      approval.diff( [ :foo, :bar, :baz ] ){ |diff| fail diff }
+    end
+    it 'formats hashes' do
+      approval = described_class.new './spec/fixtures/hash.txt'
+      approval.diff( { :foo => 'bar', :baz => 'quux' } ){ |diff| fail diff }
+    end
+    it 'formats json' do
+      approval = described_class.new './spec/fixtures/hash.json', :format => :json
+      approval.diff( '{"foo":"bar","baz":"quux"}' ){ |diff| fail diff }
+    end
+  end
+end

data/spec/git/approvals/utils_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Git::Approvals::Utils do
+
+  describe '#filenameify' do
+    {
+      'Foo'     => 'foo',
+      'Foo Bar' => 'foo_bar',
+      'FooBar'  => 'foo_bar',
+      '#foo'    => 'foo',
+      'foo#'    => 'foo'
+    }.each do |original, filename|
+      it 'converts "%s" to "%s"' % [ original, filename ] do
+        described_class.filenamify( original ).should == filename
+      end
+    end
+  end
+end

data/spec/rspec/approvals_spec/rspec_integration/verify/fails_when_changed.txt

@@ -0,0 +1 @@
+"IT WERKS"

data/spec/rspec/approvals_spec/rspec_integration/verify/passes_when_unchanged.txt

@@ -0,0 +1 @@
+"IT WERKS"

data/spec/rspec/approvals_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'rspec/approvals'
+
+describe 'RSpec integration' do
+
+  it 'provides the correct approval directory' do
+    approval_directory.should == './spec/rspec/approvals_spec'
+  end
+  it 'provides the correct approval filename' do
+    approval_filename.should == 'rspec_integration/provides_the_correct_approval_filename'
+  end
+  it 'provides the correct approval path' do
+    approval_path.should == './spec/rspec/approvals_spec/rspec_integration/provides_the_correct_approval_path'
+  end
+
+  describe '#verify' do
+    # make sure to clean up any failed fixtures
+    after { `git checkout #{approval_directory}` }
+
+    it 'passes when unchanged' do
+      verify { 'IT WERKS' }
+    end
+    it 'fails when changed' do
+      expect { verify { 'IT BROKE' } }.to raise_error( RSpec::Expectations::ExpectationNotMetError )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'git-approvals'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: git-approvals
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Ruppel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.2
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple git-powered approval tests. With RSpec integration.
+email:
+- jeremy.ruppel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pryrc
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- git-approvals.gemspec
+- lib/git-approvals.rb
+- lib/git/approvals.rb
+- lib/git/approvals/approval.rb
+- lib/git/approvals/utils.rb
+- lib/git/approvals/version.rb
+- lib/rspec/approvals.rb
+- spec/fixtures/array.txt
+- spec/fixtures/hash.json
+- spec/fixtures/hash.txt
+- spec/fixtures/string.txt
+- spec/git/approvals/approval_spec.rb
+- spec/git/approvals/utils_spec.rb
+- spec/rspec/approvals_spec.rb
+- spec/rspec/approvals_spec/rspec_integration/verify/fails_when_changed.txt
+- spec/rspec/approvals_spec/rspec_integration/verify/passes_when_unchanged.txt
+- spec/spec_helper.rb
+homepage: https://github.com/jeremyruppel/git-approvals
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: Simple git-powered approval tests.
+test_files:
+- spec/fixtures/array.txt
+- spec/fixtures/hash.json
+- spec/fixtures/hash.txt
+- spec/fixtures/string.txt
+- spec/git/approvals/approval_spec.rb
+- spec/git/approvals/utils_spec.rb
+- spec/rspec/approvals_spec.rb
+- spec/rspec/approvals_spec/rspec_integration/verify/fails_when_changed.txt
+- spec/rspec/approvals_spec/rspec_integration/verify/passes_when_unchanged.txt
+- spec/spec_helper.rb
+has_rdoc: