roger_yuicompressor 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTU3ODZlMWM0ODgzMGVmYzQ0ZWM1NGMzYTYxODBiNDRkMmRlMDZiMA==
+    MjhlYzQ2NjU5MGU1NTI4MGI5YzE3NzdjMzFiZmY3OTgzMGE2NmViOQ==
   data.tar.gz: !binary |-
-    OTJmOGM2YWM5MTUyNzUzZmJiNDQ3NmEzN2NjOTAwOWZjNzNhZDhmOA==
+    NzJiZWFjZTJhOWVmNTQwNDg1OTFkYTA5YWUxNDhlOWI2YjEwMDgwNQ==
 SHA512:
   metadata.gz: !binary |-
-    MjlkNWRlOGJmYTdmNDkyZGNlN2ExNzRmOGYyZDMwZDQ1YmI4NzZlNTM2NDRj
-    ZWNlNDQzNWMxOTM0MGYxNzI1NmRhYTlkOTcwNjIwZDc2NmJjNDM5OThmNjA4
-    MjE4YzI3NGJlZWRjMTNkZTA4YjViZDVmOWJhZWI1MDk5ZDZmYTM=
+    MTUxNDcxOTI0NDQ2OWE3MzcyYTkyMmUzMWFmNTcxNjk1OGYzZTQ4NTY3MTc2
+    N2M5N2IyYTdhMjIwZDU0NDcxOWJjZTQ1NGY2MmMyYjRjODAxZWUzM2RiODhh
+    MGZjMjY5MWY3ODFmZWY4NTQ3M2Q4NDRhYTljMDJjODI4MzY2MmI=
   data.tar.gz: !binary |-
-    YmQyMWVlYWQ5N2QyOTM3MGU1ZTYwYzhhNWIxYzI4YTc0OGQ4YmUxMGQ5Y2Mx
-    NTNhMTc4Mjc4NWRlYTZiMzE1Y2M5NmE0NDk0MzEwZTQ3NGJlYWExYThhNTI2
-    MThhMDI2OTdlMzVjN2EwYThlMjE1ZDY0ZDMzMTg3Yzg3ZGQ4MWI=
+    YjE2NzFhM2I3YTVkMmY2ZjRlNjg2ZTkxZTZhMTJhMjMwOTk1OTUxODRjYThl
+    YWJkNDhjNzI4ZmQyNWYxMWUzYjYzYTJmNmM1YTBhMWNkNzA0ZjcyYTcwNTI5
+    MGY0YTc4MzE1ZmY4ZjI4ZWJmMGU0OGMyMzkwNTFmNjk1OTU2OGY=

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - rbx-2
+  - jruby
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: jruby
+  fast_finish: true

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## Version 1.1.0
+* Add support for minifying files with a suffix without overwriting the original.
+
 ## Version 1.0.1
 * Be more permissive in Roger versions
 

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    roger_yuicompressor (1.0.1)
+      roger (>= 0.11.0)
+      yui-compressor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    hpricot (0.8.6)
+    mime-types (2.3)
+    rack (1.5.2)
+    rake (10.3.2)
+    redcarpet (3.1.2)
+    roger (0.12.2)
+      hpricot (>= 0.6.4)
+      mime-types (~> 2.2)
+      rack (>= 1.0.0)
+      redcarpet (>= 3.1.1)
+      thor (~> 0.16.0)
+      tilt (~> 2.0.1)
+    thor (0.16.0)
+    tilt (2.0.1)
+    yui-compressor (0.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  roger_yuicompressor!

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/unit/**/*_test.rb']
+  t.verbose = true
+end

data/lib/roger_yuicompressor/processor.rb

@@ -1,5 +1,23 @@
+require 'roger/release'
+require 'yui/compressor'
+
 module RogerYuicompressor
-  class Yuicompressor < Roger::Release::Processors::Base
+  class Yuicompressor < ::Roger::Release::Processors::Base
+
+    attr_reader :options
+
+    def initialize(options={})
+      @options = {
+        :match => ["**/*.{css,js}"],
+        :skip =>  [/javascripts\/vendor\/.*\.js\Z/, /_doc\/.*/],
+        :delimiter => Regexp.escape("/* -------------------------------------------------------------------------------- */"),
+        :suffix => nil
+      }.update(options)
+
+      compressor_options = {:line_break => 80}
+      @css_compressor = YUI::CssCompressor.new(compressor_options) 
+      @js_compressor = YUI::JavaScriptCompressor.new(compressor_options)      
+    end
     
     # Compresses all JS and CSS files, it will keep all lines before
     # 
@@ -10,48 +28,69 @@ module RogerYuicompressor
     # @options options [Array] match Files to match, default to ["**/*.{css,js}"]
     # @options options [Regexp] :delimiter An array of header delimiters. Defaults to the one above. The delimiter will be removed from the output.
     # @options options [Array[Regexp]] :skip An array of file regular expressions to specifiy which files to skip. Defaults to [/javascripts\/vendor\/.\*.js\Z/, /_doc\/.*/]
+    # @options options [Nil|string] :suffix A string that will be added to the filename of the minified file, if set to nil will overwrite the existing file. Defaults to nil.
+    #   (example: test.js => test.min.js where :suffix => '.min').
     def call(release, options={})
-      options = {
-        :match => ["**/*.{css,js}"],
-        :skip =>  [/javascripts\/vendor\/.*\.js\Z/, /_doc\/.*/],
-        :delimiter => Regexp.escape("/* -------------------------------------------------------------------------------- */")
-      }.update(options)
-      
-      compressor_options = {:line_break => 80}
-      css_compressor = YUI::CssCompressor.new(compressor_options) 
-      js_compressor = YUI::JavaScriptCompressor.new(compressor_options)
-      
+      @options.update(options)
+            
       release.log self,  "Minifying #{options[:match].inspect}"
-      
+
+      raise(RuntimeError, "The given suffix #{@options[:suffix]} is invalid.") unless valid_suffix?(@options[:sufix])
+            
       # Add version numbers and minify the files
-      release.get_files(options[:match], options[:skip]).each do |f|
-        type = f[/\.([^.]+)\Z/,1]
+      release.get_files(options[:match], options[:skip]).each do |filename|
+        minify_file(filename, release)
+      end
+    end
+
+    # Retrieve the type of the file (based on extension)
+    # 
+    # @param [String] The name of the file incl. extension
+    def get_file_type(filename)
+      filename[/\.([^.]+)\Z/, 1]
+    end
+
+    # Check if a valid suffix is given
+    def valid_suffix?(suffix = nil)
+      suffix === nil || suffix.kind_of?(String)
+    end
+
+    # Read and minfiy the given file
+    def minify_file(file, release)
+      data = File.read(file);
+      type = get_file_type(file)
+
+      if @options[:suffix] != nil
+        output_file = file.sub(".#{type}", "") + @options[:suffix] + ".#{type}"
+      else
+        output_file = file
+      end
+
+      File.open(output_file, "w") do |fh| 
         
-        data = File.read(f);
-        File.open(f,"w") do |fh| 
-          
-          # Extract header and store for later use
-          header = data[/\A(.+?)\n#{options[:delimiter]}\s*\n/m,1]
-          minified = [header]
-    
-          # Actual minification
-          release.debug self,  "Minifying #{f}"
-          case type
-          when "css"
-            minified << css_compressor.compress(data)
-          when "js"
-            minified << js_compressor.compress(data)
-          else
-            release.warn self, "Error minifying: encountered unknown type \"#{type}\""
-            minified << data
-          end
-
-          fh.write minified.join("\n")
+        # Extract header and store for later use
+        header = data[/\A(.+?)\n#{options[:delimiter]}\s*\n/m,1]
+        minified = [header]
+  
+        # Actual minification
+        # release.debug self,  "Minifying #{file}"
+        case type
+        when "css"
+          minified << @css_compressor.compress(data)
+        when "js"
+          minified << @js_compressor.compress(data)
+        else
+          # release.warn self, "Error minifying: encountered unknown type \"#{type}\""
+          minified << data
         end
-      end
-      
+
+        fh.write minified.join("\n")
+      end      
+
+      output_file
     end
+
   end
 end
 
-Roger::Release::Processors.register(:yuicompressor, RogerYuicompressor::Yuicompressor)
+::Roger::Release::Processors.register(:yuicompressor, RogerYuicompressor::Yuicompressor)

data/roger_yuicompressor.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "roger_yuicompressor"
-  s.version = "1.0.1"
+  s.version = "1.1.0"
   
   s.authors = ["Flurin Egger"]
   s.email = ["info@digitpaint.nl", "flurin@digitpaint.nl"]  

data/test/unit/processor_test.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + "/../../lib/roger_yuicompressor/processor"
+require "test/unit"
+
+class ProcessorTest < Test::Unit::TestCase
+  
+  def setup
+    @processor = RogerYuicompressor::Yuicompressor.new
+    @tmp_file  = 'file.css'
+
+    # TEMP file creation
+    File.open(@tmp_file, 'w') do |tmp_file|
+      tmp_file.write('.selector { background: green; }')
+    end
+  end
+
+  # Just make sure we're dealing with the correct class
+  def test_setup
+    assert_kind_of(RogerYuicompressor::Yuicompressor, @processor, "Not initialized the correct class.")
+  end
+
+  # When no suffix is given, there is no suffix and 
+  # this default behaviour should be valid
+  def test_default_valid_suffix
+    assert(@processor.valid_suffix?, "The given suffix (#{@processor.options[:suffix]}) is not valid.")
+  end
+
+  # When the suffix '.min' is given it should be valid
+  def test_valid_suffix
+    assert(@processor.valid_suffix?(".min"), "Suffix '.min' should be valid.")
+    assert(@processor.valid_suffix?("-test"), "Suffix '-test' should be valid.")    
+  end
+
+  # Test that extension of file get correct extracted
+  def test_extracting_extension
+    assert_equal('rb', @processor.get_file_type('file.rb'))
+    assert_equal('js', @processor.get_file_type('file.min.js'))
+    assert_equal('css', @processor.get_file_type('file.css'))
+    assert_not_equal('min.js', @processor.get_file_type('file.min.js'))
+  end
+  
+  # Test default behaviour that minfied data is put in the original file
+  def test_default_behaviour_processor_minify
+    assert_equal('file.css', @processor.minify_file(@tmp_file, nil))
+  end
+
+  def test_behaviour_processor_minify
+    processor = RogerYuicompressor::Yuicompressor.new({:suffix => '.min'})
+    assert_equal('file.min.css', processor.minify_file(@tmp_file, nil))
+    
+    assert(File.exists?('file.min.css'))
+    assert(File.exists?('file.css'))
+  end
+
+  def teardown
+    File.delete('file.css') if File.exists?('file.css')
+    File.delete('file.min.css') if File.exists?('file.min.css')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roger_yuicompressor
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Flurin Egger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2014-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roger
@@ -46,12 +46,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .travis.yml
 - CHANGELOG.md
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - lib/roger_yuicompressor.rb
 - lib/roger_yuicompressor/processor.rb
 - roger_yuicompressor.gemspec
+- test/unit/processor_test.rb
 homepage: http://github.com/digitpaint/roger_yuicompressor
 licenses:
 - MIT
@@ -76,4 +81,5 @@ rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: Processor for using yuicompressor to minify CSS/JS
-test_files: []
+test_files:
+- test/unit/processor_test.rb