git-approvals 0.2.2 → 0.3.0

data/git-approvals.gemspec

@@ -18,10 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'awesome_print', '1.1.0'
+  spec.add_dependency 'tilt', '~> 1.4.1'
 
   # soft dependencies
-  spec.add_development_dependency 'uglifier',    '~> 2.1.1'
+  spec.add_development_dependency 'awesome_print', '~> 1.1.0'
+  spec.add_development_dependency 'uglifier',      '~> 2.1.1'
+  spec.add_development_dependency 'sass',          '~> 3.2.9'
 
   spec.add_development_dependency 'bundler',     '~> 1.3'
   spec.add_development_dependency 'rspec',       '~> 2.13.0'

data/lib/git/approvals/approval.rb

@@ -1,106 +1,46 @@
 require 'open3'
+require 'pathname'
+require 'tilt'
 
 module Git
   module Approvals
-    ##
-    # The base class for approval errors.
-    class ApprovalError < StandardError; end
-
-    ##
-    # Raised when an unregistered formatter is requested.
-    class UnknownFormat < ApprovalError
-      def initialize( name )
-        super "There is no registered formatter named '#{name}'."
-      end
-    end
-
-    ##
-    # Raised when a formatter's soft dependencies are missing.
-    class MissingSoftDependency < ApprovalError
-      def initialize( name, dependency )
-        super <<-EOS
-The format '#{name}' requires #{dependency}.
-To use this formatter, make sure to load the dependency:
-
-  require '#{dependency}'
-EOS
-      end
-    end
 
     ##
     #
-    class Approval
-
-      class << self
-
-        ##
-        # Registers a new formatter block by name. The block
-        # is expected to return a deterministic string
-        # representation of an object.
-        def register_formatter( name, &block )
-          formatters[ name.to_sym ] = block
-        end
-
-        ##
-        # Looks up the formatter named `name` and attempts to
-        # format `object`. Raises a helpful error message if
-        # a formatter's soft dependency cannot be loaded.
-        def format( name, object )
-          formatters[ name ][ object ]
-        rescue NoMethodError => e
-          raise UnknownFormat, name
-        rescue LoadError => e
-          raise MissingSoftDependency.new name,
-            e.message[ /^cannot load such file -- (.*)$/, 1 ]
-        end
+    class Approval < Pathname
 
-        protected
+      def initialize( path, options={} ) # :nodoc:
+        @options = options
 
-        ##
-        # The hash of registered formatters by name.
-        def formatters
-          @formatters ||= { }
-        end
-      end
+        path = Pathname( path )
+        path = munge_format( path )
+        path = munge_filename( path )
 
-      ##
-      # The `txt` format requires the `awesome_print` gem.
-      # It is suitable for formatting most native ruby types.
-      register_formatter :txt do |object|
-        require 'awesome_print'
-        object.awesome_inspect :plain => true, :indent => -2
+        super path.to_path
       end
+      attr_reader :options
 
       ##
-      # The `json` format requires the `json` library.
-      # It is suitable for formatting JSON strings.
-      register_formatter :json do |object|
-        require 'json'
-        JSON.pretty_generate JSON.parse( object )
+      # Makes sure the given pathname has an extension.
+      def munge_format( path )
+        ext = [ options[ :format ], path.extname, 'txt' ].detect do |arg|
+          !arg.nil? && !arg.empty?
+        end
+        ext = ext.to_s
+        ext = '.' + ext unless ext.start_with?( '.' )
+        path.sub_ext ext
       end
 
       ##
-      # The `js` format requires the `uglifier` gem.
-      # It is suitable for formatting javascript.
-      register_formatter :js do |object|
-        require 'uglifier'
-        Uglifier.compile object,
-          :output => {
-            :beautify     => true,
-            :indent_level => 2,
-            :comments     => :all,
-            :space_colon  => true
-          }
-      end
-
-      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
+      # Makes sure the given pathname has the correct filename.
+      def munge_filename( path )
+        if filename = options[ :filename ]
+          dir, base = path.split
+          dir.join( filename + base.extname )
+        else
+          path
+        end
       end
-      attr_reader :path, :options
 
       ##
       # Diffs the given string with this approval file. If the
@@ -109,20 +49,20 @@ EOS
       # called if the diff fails, meaning there are differences.
       def diff( string, &block )
         # Make sure the directory of the file exists.
-        FileUtils.mkdir_p File.dirname( path )
+        dirname.mkpath
 
         # Write the new string to the file.
-        File.open path, 'w' do |f|
-          f << self.class.format( format, string )
+        open 'w' do |f|
+          f << Tilt.new( to_path ).render( 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
+        sh "git ls-files #{to_path} --error-unmatch" do |err|
+          raise Errno::ENOENT, to_path
         end
 
         # If the file has changed, call the block.
-        sh "git diff --exit-code #{path}" do |err|
+        sh "git diff --exit-code #{to_path}" do |err|
           block.call err
         end
       end
@@ -135,13 +75,13 @@ EOS
         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
+
+    ##
+    # Register all formatters as tilt templates.
+    Tilt.register AwesomePrintFormatter, 'txt'
+    Tilt.register JSONFormatter,         'json'
+    Tilt.register UglifierFormatter,     'js'
+    Tilt.register SassFormatter,         'css'
   end
 end

data/lib/git/approvals/awesome_print_formatter.rb

@@ -0,0 +1,28 @@
+require 'tilt'
+
+module Git
+  module Approvals
+    class AwesomePrintFormatter < Tilt::Template
+
+      def self.engine_initialized?
+        defined?(::AwesomePrint)
+      end
+
+      def initialize_engine
+        require_template_library 'awesome_print'
+      end
+
+      def prepare
+      end
+
+      def evaluate( context, locals, &block )
+        # TODO use locals as options to the formatter
+        # TODO require awesome_print/inspector to not pollute kernel, etc
+        context.awesome_inspect \
+          :plain  => true,
+          :indent => -2
+      end
+    end
+  end
+end
+

data/lib/git/approvals/json_formatter.rb

@@ -0,0 +1,24 @@
+require 'tilt'
+
+module Git
+  module Approvals
+    class JSONFormatter < Tilt::Template
+
+      def self.engine_initialized?
+        defined?(::JSON)
+      end
+
+      def initialize_engine
+        require_template_library 'json'
+      end
+
+      def prepare
+      end
+
+      def evaluate( context, locals, &block )
+        # TODO use locals as options to the formatter
+        ::JSON.pretty_generate( ::JSON.parse( context ) )
+      end
+    end
+  end
+end

data/lib/git/approvals/rspec.rb

@@ -0,0 +1,50 @@
+require 'git-approvals'
+
+begin
+  gem 'rspec-core', '>= 2.12.0'
+rescue Gem::LoadError => e
+  raise 'rspec/approvals requires rspec-core >= 2.12.0. Please upgrade rspec.'
+end
+
+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/lib/git/approvals/sass_formatter.rb

@@ -0,0 +1,29 @@
+require 'tilt'
+
+module Git
+  module Approvals
+    class SassFormatter < Tilt::Template
+
+      def self.engine_initialized?
+        defined?(::Sass::Engine)
+      end
+
+      def initialize_engine
+        require_template_library 'sass'
+      end
+
+      def prepare
+      end
+
+      def evaluate( context, locals, &block )
+        # TODO use locals as options to the formatter
+        ::Sass::Engine.new( context, {
+          :syntax     => :scss,
+          :cache      => false,
+          :read_cache => false,
+          :style      => :expanded
+        } ).render
+      end
+    end
+  end
+end

data/lib/git/approvals/uglifier_formatter.rb

@@ -0,0 +1,30 @@
+require 'tilt'
+
+module Git
+  module Approvals
+    class UglifierFormatter < Tilt::Template
+
+      def self.engine_initialized?
+        defined?(::Uglifier)
+      end
+
+      def initialize_engine
+        require_template_library 'uglifier'
+      end
+
+      def prepare
+      end
+
+      def evaluate( context, locals, &block )
+        # TODO use locals as options to the formatter
+        ::Uglifier.compile context,
+          :output => {
+            :beautify     => true,
+            :indent_level => 2,
+            :comments     => :all,
+            :space_colon  => true
+          }
+      end
+    end
+  end
+end

data/lib/git/approvals/version.rb

@@ -1,5 +1,5 @@
 module Git
   module Approvals
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   end
 end

data/lib/git/approvals.rb

@@ -2,7 +2,11 @@ require 'git/approvals/version'
 
 module Git
   module Approvals
-    autoload :Approval, 'git/approvals/approval'
-    autoload :Utils,    'git/approvals/utils'
+    autoload :Approval,              'git/approvals/approval'
+    autoload :AwesomePrintFormatter, 'git/approvals/awesome_print_formatter.rb'
+    autoload :JSONFormatter,         'git/approvals/json_formatter.rb'
+    autoload :SassFormatter,         'git/approvals/sass_formatter.rb'
+    autoload :UglifierFormatter,     'git/approvals/uglifier_formatter.rb'
+    autoload :Utils,                 'git/approvals/utils'
   end
 end

data/lib/rspec/approvals.rb

@@ -1,50 +1 @@
-require 'git-approvals'
-
-begin
-  gem 'rspec-core', '>= 2.12.0'
-rescue Gem::LoadError => e
-  raise 'rspec/approvals requires rspec-core >= 2.12.0. Please upgrade rspec.'
-end
-
-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
+require 'git/approvals/rspec'

data/spec/fixtures/asset.css

@@ -0,0 +1,3 @@
+html, body {
+  font-family: "Helvetica Neue";
+}

data/spec/git/approvals/approval_spec.rb

@@ -2,13 +2,28 @@ require 'spec_helper'
 
 describe Git::Approvals::Approval do
 
-  describe 'initialize' do
+  describe '#initialize' do
     subject { described_class.new './foo/bar.txt' }
 
-    its( :path    ){ should == './foo/bar.txt' }
+    its( :to_path ){ should == './foo/bar.txt' }
     its( :options ){ should == { } }
   end
 
+  describe '#options' do
+    describe ':format' do
+      it 'replaces the extension' do
+        subject = described_class.new 'foo/bar.txt', :format => :json
+        subject.to_path.should == 'foo/bar.json'
+      end
+    end
+    describe ':filename' do
+      it 'replaces the filename' do
+        subject = described_class.new 'foo/bar.txt', :filename => 'baz'
+        subject.to_path.should == 'foo/baz.txt'
+      end
+    end
+  end
+
   describe '#diff' do
     subject { described_class.new './foo/bar.txt' }
 
@@ -41,17 +56,6 @@ describe Git::Approvals::Approval do
     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'
@@ -66,15 +70,22 @@ describe Git::Approvals::Approval do
       approval.diff( { :foo => 'bar', :quux => 'bar' } ){ |diff| fail diff }
     end
     it 'formats json' do
-      approval = described_class.new './spec/fixtures/hash.json', :format => :json
+      approval = described_class.new './spec/fixtures/hash.json'
       approval.diff( '{"foo":"bar","baz":"quux"}' ){ |diff| fail diff }
     end
     it 'formats javascript' do
-      approval = described_class.new './spec/fixtures/asset.js', :format => :js
+      approval = described_class.new './spec/fixtures/asset.js'
       approval.diff( <<-EOS ){ |diff| fail diff }
       // Comments are preserved
       (function(){return {status:"IT WERKS"};})();
       EOS
     end
+    it 'formats css' do
+      approval = described_class.new './spec/fixtures/asset.css'
+      approval.diff( <<-EOS ){ |diff| fail diff }
+      // Comments are preserved
+      html,body{font-family:"Helvetica Neue";}
+      EOS
+    end
   end
 end

data/spec/{rspec/approvals_spec.rb → git/approvals/rspec_spec.rb}

@@ -4,13 +4,13 @@ require 'rspec/approvals'
 describe 'RSpec integration' do
 
   it 'provides the correct approval directory' do
-    approval_directory.should == './spec/rspec/approvals_spec'
+    approval_directory.should == './spec/git/approvals/rspec_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'
+    approval_path.should == './spec/git/approvals/rspec_spec/rspec_integration/provides_the_correct_approval_path'
   end
 
   describe '#verify' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-approvals
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,38 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-11 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.1
 - !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
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
@@ -43,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.9
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -160,19 +192,25 @@ files:
 - lib/git-approvals.rb
 - lib/git/approvals.rb
 - lib/git/approvals/approval.rb
+- lib/git/approvals/awesome_print_formatter.rb
+- lib/git/approvals/json_formatter.rb
+- lib/git/approvals/rspec.rb
+- lib/git/approvals/sass_formatter.rb
+- lib/git/approvals/uglifier_formatter.rb
 - lib/git/approvals/utils.rb
 - lib/git/approvals/version.rb
 - lib/rspec/approvals.rb
 - spec/fixtures/array.txt
+- spec/fixtures/asset.css
 - spec/fixtures/asset.js
 - spec/fixtures/hash.json
 - spec/fixtures/hash.txt
 - spec/fixtures/string.txt
 - spec/git/approvals/approval_spec.rb
+- spec/git/approvals/rspec_spec.rb
+- spec/git/approvals/rspec_spec/rspec_integration/verify/fails_when_changed.txt
+- spec/git/approvals/rspec_spec/rspec_integration/verify/passes_when_unchanged.txt
 - 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:
@@ -201,14 +239,15 @@ specification_version: 3
 summary: Simple git-powered approval tests.
 test_files:
 - spec/fixtures/array.txt
+- spec/fixtures/asset.css
 - spec/fixtures/asset.js
 - spec/fixtures/hash.json
 - spec/fixtures/hash.txt
 - spec/fixtures/string.txt
 - spec/git/approvals/approval_spec.rb
+- spec/git/approvals/rspec_spec.rb
+- spec/git/approvals/rspec_spec/rspec_integration/verify/fails_when_changed.txt
+- spec/git/approvals/rspec_spec/rspec_integration/verify/passes_when_unchanged.txt
 - 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: