git-approvals 0.2.0 → 0.2.1

data/git-approvals.gemspec

@@ -20,6 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'awesome_print', '1.1.0'
 
+  # soft dependencies
+  spec.add_development_dependency 'uglifier',    '~> 2.1.1'
+
   spec.add_development_dependency 'bundler',     '~> 1.3'
   spec.add_development_dependency 'rspec',       '~> 2.13.0'
   spec.add_development_dependency 'guard-rspec', '~> 2.5.2'

data/lib/git/approvals/approval.rb

@@ -2,18 +2,91 @@ require 'open3'
 
 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
 
-      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 )
-        }
-      }
+      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
+
+        protected
+
+        ##
+        # The hash of registered formatters by name.
+        def formatters
+          @formatters ||= { }
+        end
+      end
+
+      ##
+      # 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
+      end
+
+      ##
+      # 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 )
+      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 }
+      end
 
       def initialize( path, options={} ) # :nodoc:
         @path, @options = path, options
@@ -25,14 +98,17 @@ module Git
       attr_reader :path, :options
 
       ##
-      #
+      # Diffs the given string with this approval file. If the
+      # file has not been checked in, this method will raise an
+      # exception. Otherwise, the supplied block will only be
+      # 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 )
 
         # Write the new string to the file.
         File.open path, 'w' do |f|
-          f << FORMATTERS[ format ][ string ]
+          f << self.class.format( format, string )
         end
 
         # If the file hasn't been checked in, raise an error.

data/lib/git/approvals/version.rb

@@ -1,5 +1,5 @@
 module Git
   module Approvals
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 end

data/spec/fixtures/asset.js

@@ -0,0 +1,3 @@
+(function() {
+  return "IT WERKS";
+})();

data/spec/git/approvals/approval_spec.rb

@@ -69,5 +69,9 @@ describe Git::Approvals::Approval do
       approval = described_class.new './spec/fixtures/hash.json', :format => :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.diff( '(function(){return "IT WERKS";})();' ){ |diff| fail diff }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-approvals
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -27,6 +27,22 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +164,7 @@ files:
 - lib/git/approvals/version.rb
 - lib/rspec/approvals.rb
 - spec/fixtures/array.txt
+- spec/fixtures/asset.js
 - spec/fixtures/hash.json
 - spec/fixtures/hash.txt
 - spec/fixtures/string.txt
@@ -184,6 +201,7 @@ specification_version: 3
 summary: Simple git-powered approval tests.
 test_files:
 - spec/fixtures/array.txt
+- spec/fixtures/asset.js
 - spec/fixtures/hash.json
 - spec/fixtures/hash.txt
 - spec/fixtures/string.txt