sinatra-minify 0.1.1 → 0.2.0

data/Rakefile

@@ -50,3 +50,17 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+namespace :minify do
+  desc "Builds the example files in test/fixtures/exampleapp"
+  task :build_example do
+    $:.unshift File.dirname(__FILE__) + '/lib'
+
+    require 'test/fixtures/exampleapp/app'
+    puts "Building..."
+
+    files = Sinatra::Minify::Package.build(App)
+    files.each { |f| puts " * #{File.basename f}" }
+    puts "Construction complete!"
+  end
+end

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/sinatra/minify.rb

@@ -1,4 +1,6 @@
 require 'sinatra/base'
+require 'yaml'
+require 'forwardable'
 
 begin
   require 'jsmin'
@@ -8,8 +10,10 @@ end
 
 module Sinatra
   module Minify
-    autoload :Builder, 'sinatra/minify/builder'
-    autoload :Helpers, 'sinatra/minify/helpers'
+    autoload :Config,     'sinatra/minify/config'
+    autoload :Package,    'sinatra/minify/package'
+    autoload :Compressor, 'sinatra/minify/compressor'
+    autoload :Helpers,    'sinatra/minify/helpers'
 
     def self.registered( app )
       app.helpers Helpers

data/lib/sinatra/minify/compressor.rb

@@ -0,0 +1,54 @@
+module Sinatra
+  module Minify
+    class Compressor
+      attr :type, :package, :file
+
+      def initialize(type, file, package)
+        @type        = type.to_s
+        @file        = file
+        @package     = package
+        @command     = :"minify_#{@type}"
+
+        raise ArgumentError  if not ['js', 'css'].include?(type)
+      end
+
+      # Rebuilds the minified .min.* files.
+      def build
+        File.open(file, 'w') { |f| f.write minify(concatenated) }
+        file
+      end
+
+      # Deletes all minified files.
+      def clean
+        File.unlink(file)  if File.exists?(file)
+      end
+  
+    private
+      # TODO: decouple this further?
+      def concatenated
+        package.files.map { |f| File.read(f) }.join("\n").strip
+      end
+
+      def minify(src)
+        send @command, src
+      end
+
+      def minify_css(src)
+        src.gsub!(/\s+/, " ")         
+        src.gsub!(/\/\*(.*?)\*\//, "")
+        src.gsub!(/\} /, "}\n")       
+        src.gsub!(/\n$/, "")          
+        src.gsub!(/[ \t]*\{[ \t]*/, "{")
+        src.gsub!(/;[ \t]*\}/, "}") 
+
+        src.gsub!(/[ \t]*([,|{|}|>|:|;])[ \t]*/,"\\1") # Tersify
+        src.gsub!(/[ \t]*\n[ \t]*/, "") # Hardcore mode (no NLs)
+        src.strip
+      end
+
+      def minify_js(src)
+        JSMin.minify(src).strip
+      end
+    end
+  end
+end

data/lib/sinatra/minify/config.rb

@@ -0,0 +1,34 @@
+module Sinatra
+  module Minify
+    class Config
+      def initialize(type, app_class = ::Main)
+        @settings = app_class   
+        @type     = type.to_s
+      end
+
+      def js_url
+        @settings.js_url
+      end
+
+      def css_url
+        @settings.css_url
+      end
+
+      def public_dir(*args)
+        root_path(@settings.send("#{@type}_path"), *args)
+      end
+
+      def public_url(path)
+        File.join(@settings.send("#{@type}_url"), path).squeeze('/')
+      end
+
+      def root_path(*args)
+        File.join(File.dirname(@settings.app_file), *args)
+      end
+
+      def sets
+        YAML.load_file(root_path("config/assets.yml"))[@type]
+      end
+    end
+  end
+end

data/lib/sinatra/minify/helpers.rb

@@ -1,14 +1,13 @@
 module Sinatra
   module Minify
     module Helpers
-      def js_assets( set )
-        Builder.new(self.class).js_assets set
+      def js_assets(set)
+        Package.new(:js, set, self.class).html
       end
 
-      def css_assets( set )
-        Builder.new(self.class).css_assets set
+      def css_assets(set)
+        Package.new(:css, set, self.class).html
       end
     end
   end
 end
-

data/lib/sinatra/minify/package.rb

@@ -0,0 +1,107 @@
+module Sinatra
+  module Minify
+    class Package
+      GlobNoMatchError = Class.new(StandardError)
+
+      attr :type, :set, :compressor, :filename
+
+      class << self
+        # Deletes all the different packaged and minified files
+        # You may pass in a different application object 
+        # e.g.
+        #
+        #   Sinatra::Minify::Package.clean(HelloWorld)
+        #
+        # as long as the appication has registered Sinatra::Minify
+        # 
+        # The files will be based on config/assets.yml
+        #
+        # See test/fixtures/exampleapp/config/assets.yml for an example
+        def clean(app_class = ::Main)
+          all(:js, app_class).each  { |p| p.compressor.clean }
+          all(:css, app_class).each { |p| p.compressor.clean }
+        end
+      
+        # Packages and minifies all of the files declared on config/assets.yml
+        # 
+        # Returns all of the minified files
+        def build(app_class = ::Main)
+          ret = []
+          ret << all(:js, app_class).map  { |p| p.compressor.build }
+          ret << all(:css, app_class).map { |p| p.compressor.build }
+          ret.flatten
+        end
+        
+      private
+        def all(type, app_class = ::Main)
+          config = Config.new(type, app_class)
+          config.sets.keys.map do |set|
+            Package.new(type, set, app_class)
+          end
+        end
+      end
+
+      extend Forwardable
+      def_delegators :@config, :public_url, :public_dir, :sets, :js_url, :css_url
+
+      def initialize(type, set, app_class = ::Main)
+        @type       = type.to_s
+        @app_class  = app_class 
+        @set        = set
+        @config     = Config.new(@type, app_class)
+        @filename   = "#{set}.min.#{type}" 
+        @compressor = Compressor.new(@type, public_dir(@filename), self)
+
+      end
+
+      def html
+        if @app_class.minify?
+          file = public_dir(filename)
+          @compressor.build  unless File.exists?(file)
+          mtime = File.mtime(file).to_i
+
+          asset_include_tag public_url(filename), mtime
+        else
+          enumerate_all_assets
+        end
+      end
+
+      def files
+        specs = sets[set]
+        globs = Array(specs).map { |s| public_dir(s) }
+
+        globs.map { |glob| 
+          list = Dir[glob]
+
+          if list.empty? and glob.include?('*')
+            raise GlobNoMatchError, "The spec `#{glob}` does not match any files."
+          end
+
+          list.empty? ? glob : list
+        }.flatten.uniq
+      end
+
+    private
+      def enumerate_all_assets
+        files.map { |file|
+          mtime = File.mtime(file).to_i  if File.exist?(file)
+
+          asset_include_tag(
+            public_url(file.gsub(/^#{Regexp.escape(public_dir)}/, '')), mtime
+          )
+        }.join("\n")
+      end
+
+      def asset_include_tag(path, mtime)
+        case type
+        when 'js'
+          "<script src='#{js_url}/#{path}?#{mtime}' type='text/javascript'></script>"
+        when 'css'
+          "<link rel='stylesheet' href='#{css_url}/#{path}?#{mtime}' media='screen' />"
+        else
+          raise ArgumentError, "only js/css are supported"
+        end
+      end
+    end
+  end
+end

data/lib/tasks.rake

@@ -3,7 +3,8 @@ namespace :minify do
   task :build do
     require 'init'
     puts "Building..."
-    files = Sinatra::Minify::Builder.new.build
+
+    files = Sinatra::Minify::Package.build
     files.each { |f| puts " * #{File.basename f}" }
     puts "Construction complete!"
   end

data/sinatra-minify.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra-minify}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["sinefunc"]
@@ -22,10 +22,13 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/sinatra/minify.rb",
-     "lib/sinatra/minify/builder.rb",
+     "lib/sinatra/minify/compressor.rb",
+     "lib/sinatra/minify/config.rb",
      "lib/sinatra/minify/helpers.rb",
+     "lib/sinatra/minify/package.rb",
      "lib/tasks.rake",
      "sinatra-minify.gemspec",
+     "test/fixtures/control/style-default-compressed.css",
      "test/fixtures/exampleapp/app.rb",
      "test/fixtures/exampleapp/config/assets.yml",
      "test/fixtures/exampleapp/public/css/style-default.css",

data/test/fixtures/control/style-default-compressed.css

@@ -0,0 +1 @@
+div,dl,dt,dd,ul,ol,li,form,fieldset,input,th,td{margin:0;padding:0}pre,p,blockquote,h1,h2,h3,h4,h5,h6{margin:1em 0 1em 0}blockquote{border-left:solid 2px #ccc;padding:0 1em;margin-left:0.2em;color:#888}h1{font-size:1.4em}h2{font-size:1.3em}h3{font-size:1.2em}h4{font-size:1.1em}h5{font-size:0.9em}h6{font-size:0.9em}ol,ul{margin-left:2em}html,body{margin:0;padding:0}body,td,input,textarea{font-family:arial,helvetica,sans-serif;font-size:1em}body{font-size:0.85em;line-height:1.6em;background:#6ba241;color:#333}#all{margin:0 auto;width:auto;position:relative}a{color:#393;text-decoration:none;font-weight:bold;padding:1px}a:visited{color:#393}a:hover{color:#393;text-decoration:underline}a img{border:0}#what-we-do,#who-we-are,#content{overflow:hidden}#header>.c,#what-we-do>.c,#who-we-are>.c,#footer>.c{width:940px;margin:0 auto;overflow:hidden}#header{background:#f8fbf4 url(bg-header.png) center bottom repeat-x;padding:10px 0 130px 0}#what-we-do{background:#f0f6e9;padding:30px 0 0 0}#who-we-are{background:#6ba241 url(bg-stripe.png) center top repeat-x;padding:90px 0 30px 0;color:#d3e3c6;text-shadow:1px 1px #5c843d}#footer{background:#444;padding:50px 0 50px 0;color:#bbb}#header{overflow:hidden}#header #logo{float:left;margin-right:75px;margin-left:75px}#header h1{background:url(text.png) 0 0 no-repeat;width:511px;height:95px;text-indent:-9999px;margin:0;padding:0;display:block;float:left}#contact-header{border-bottom:solid 1px #ccc;margin-bottom:90px;padding:0 0 4px 0;text-align:right;color:#aaa;font-size:0.9em}#contact-header em{margin:0 12px 0 10px;color:#ccc}#contact-header a{color:#888;text-decoration:underline}#contact-header a:hover{color:#6b6}#content h2{float:left;width:240px}#content ul,#content li{margin:0;padding:0;display:block}#what-we-do>.c ul{float:left;width:700px;overflow:hidden}#what-we-do li{float:left;width:340px}#what-we-do li.left{margin-right:20px}#what-we-do li h3{font-size:1.4em}#what-we-do li h4{font-family:georgia,times,serif;font-style:italic;color:#777;font-weight:normal;font-size:1.2em;line-height:1.4em;margin:0.8em 0 0 0}#what-we-do li p{margin:3px 0 2em 0}#what-we-do #do-build,#what-we-do #do-scale{padding-bottom:1.5em}#what-we-do h2{background:url(text.png) 0 -400px no-repeat;height:18px;text-indent:-9999px;margin:0;padding:0;display:block}#what-we-do h3{background:url(text.png) 0 0 no-repeat;height:21px;text-indent:-9999px;margin:0;padding:0;display:block}#do-build h3{background-position:0 -200px}#do-scale h3{background-position:0 -250px}#do-craft h3{background-position:0 -300px}#do-train h3{background-position:0 -350px}#who-we-are>.c div{float:left;width:560px;overflow:hidden}#who-we-are h3{font-size:1.4em;line-height:1.5em;color:white;background:url(text.png) 0 -550px no-repeat;width:521px;height:73px;text-indent:-9999px;margin:0;padding:0;display:block;padding-bottom:7px}#who-we-are h2{background:url(text.png) 0 -450px no-repeat;height:18px;text-indent:-9999px;margin:0;padding:0;display:block}#footer{text-align:center}#footer a{font-size:1.3em;color:white;font-weight:normal}#footer span{display:block;font-size:1.2em;color:#888;margin-bottom:3px;font-family:georgia;font-style:italic}

data/test/fixtures/exampleapp/app.rb

@@ -11,7 +11,7 @@ class App < Sinatra::Base
   set :app_file, __FILE__
 
   register Sinatra::Minify
-
+  enable :raise_errors
   get '/' do
     "Hello"
   end

data/test/fixtures/exampleapp/public/js/script-2.js

@@ -1 +1 @@
-aoeu = 234 /* Test */;
+aoeu = 456 /* Test */;

data/test/test_minify.rb

@@ -9,10 +9,6 @@ class TestMinify < Test::Unit::TestCase
     last_response.body
   end
 
-  def builder
-    Sinatra::Minify::Builder.new app
-  end
-
   should "rock pants off" do
     get '/'
     assert_match "Hello", output
@@ -23,6 +19,34 @@ class TestMinify < Test::Unit::TestCase
     assert_match /\/js\/script-1.js\?/, output
     assert_match /\/js\/script-2.js\?/, output
   end
+  
+  describe "Package.all(:js)" do
+    setup do
+      @packages = Sinatra::Minify::Package.send(:all, :js, App)
+    end
+  
+    should "have only one package" do
+      assert_equal 1, @packages.size
+    end
+
+    should "return base as the only package" do
+      assert_equal 'base', @packages.first.set
+    end
+  end
+
+  describe "Package.all(:css)" do
+    setup do
+      @packages = Sinatra::Minify::Package.send(:all, :css, App)
+    end
+  
+    should "have only one package" do
+      assert_equal 1, @packages.size
+    end
+
+    should "return base as the only package" do
+      assert_equal 'base', @packages.first.set
+    end
+  end
 
   describe "In a production environment" do
     def setup
@@ -41,12 +65,31 @@ class TestMinify < Test::Unit::TestCase
 
   describe "Building files" do
     def setup
-      builder.clean
-      builder.build
+      Sinatra::Minify::Package.clean(App)
+      Sinatra::Minify::Package.build(App)
+    end
+
+    should "at least create the files" do
+      assert File.exist?(File.dirname(App.app_file) + '/public/js/base.min.js')
+      assert File.exist?(File.dirname(App.app_file) + '/public/css/base.min.css')
+    end
+
+    should "include the css file in base.min.css" do
+      control = File.read('test/fixtures/control/style-default-compressed.css')
+      unknown = File.read(File.dirname(App.app_file) + '/public/css/base.min.css')
+
+      assert unknown.include?(control)
     end
 
-    should "Build properly" do
-      assert true
+    should "include the script-1 file first in base.min.js" do
+      unknown = File.read(File.dirname(App.app_file) + '/public/js/base.min.js')
+      assert_equal 0, unknown.index('aoeu=234;')
+    end
+
+    should "include the script-2 file second in base.min.js" do
+      unknown = File.read(File.dirname(App.app_file) + '/public/js/base.min.js')
+
+      assert_equal 9, unknown.index('aoeu=456;')
     end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - sinefunc
@@ -44,10 +44,13 @@ files:
 - Rakefile
 - VERSION
 - lib/sinatra/minify.rb
-- lib/sinatra/minify/builder.rb
+- lib/sinatra/minify/compressor.rb
+- lib/sinatra/minify/config.rb
 - lib/sinatra/minify/helpers.rb
+- lib/sinatra/minify/package.rb
 - lib/tasks.rake
 - sinatra-minify.gemspec
+- test/fixtures/control/style-default-compressed.css
 - test/fixtures/exampleapp/app.rb
 - test/fixtures/exampleapp/config/assets.yml
 - test/fixtures/exampleapp/public/css/style-default.css

data/lib/sinatra/minify/builder.rb

@@ -1,224 +0,0 @@
-require 'yaml'
-
-module Sinatra
-  module Minify
-    class Builder
-      # Returns the root path of the main Sinatra application.
-      # Mimins the root_path functionality of Monk.`
-      def root_path(*args)
-        File.join(File.dirname(settings.app_file), *args)
-      end
-
-      # Deletes all minified files.
-      def clean
-        [:js, :css].each do |type|
-          assets_config(type).keys.each do |set|
-            prefix = type == :js ? settings.js_path : settings.css_path
-            path = root_path File.join(prefix, "#{set}.min.#{type}")
-            File.unlink path  if File.exists? path
-          end
-        end
-      end
-
-      # Rebuilds the minified .min.js and .min.css files.
-      def build
-        out = []
-        [:js, :css].each do |type|
-          assets_config(type).keys.each do |set|
-            prefix = type == :js ? settings.js_path : settings.css_path
-            path = root_path(prefix, "#{set}.min.#{type}")
-            File.open(path, 'w') { |f| f.write compress(type, set) }
-            out << path
-          end
-        end
-        out
-      end
-
-      def initialize(app_class = ::Main)
-        @app_class = app_class
-      end
-
-      def settings
-        @app_class
-      end
-
-      # Returns the file sets for a given type as defined in the `assets.yml` config file.
-      #
-      # Params:
-      #  - `type` (Symbol/string) - Can be either `:js` or `:css`
-      #
-      def assets_config(type)
-        YAML.load_file(root_path("config/assets.yml"))[type.to_s]
-      end
-
-      # Returns HTML code with `<script>` tags to include the scripts in a given `set`.
-      # In a production environment, this tries to include the minified version of the
-      # files. If it doesn't exist, it falls back to the original files.
-      #
-      # Params:
-      #   - `set` (String) - The set name, as defined in `config/assets.yml`.
-      #
-      # Example:
-      #
-      #   <%= js_assets 'base' %>
-      #
-      def js_assets( set )
-        min_file = root_path(settings.js_path, "#{set}.min.js")
-        min_path = "/#{settings.js_url}/#{set}.min.js".squeeze("/")
-        if settings.minify? and File.exists? min_file
-          mtime = File.mtime(min_file).to_i
-          "<script src='#{min_path}?#{mtime}' type='text/javascript'></script>\n"
-        else
-          js_assets_all set
-        end
-      end
-
-      def js_assets_all(set)
-        assets(:js, set).map { |script|
-          "<script src='#{script[:url]}' type='text/javascript'></script>"
-        }.join("\n")
-      end
-
-      # Returns HTML code with `<link>` tags to include the stylesheets in a given `set`.
-      # In a production environment, this tries to include the minified version of the
-      # files. If it doesn't exist, it falls back to the original files.
-      #
-      # Params:
-      #   - `set` (String) - The set name, as defined in `config/assets.yml`.
-      #
-      # Example:
-      #
-      #   <%= css_assets 'base' %>
-      #
-      def css_assets( set )
-        min_file = root_path settings.css_path, "#{set}.min.css"
-        min_path = "/#{settings.css_url}/#{set}.min.css".squeeze("/")
-        if settings.minify? and File.exists? min_file
-          mtime = File.mtime(file).to_i
-          "<link rel='stylesheet' href='#{min_path}?#{mtime}' media='screen' />\n"
-        else
-          css_assets_all set
-        end
-      end
-
-      def css_assets_all(set)
-        assets(:css, set).map { |sheet| 
-          "<link rel='stylesheet' href='#{sheet[:url]}' media='screen' />" 
-        }.join("\n")
-      end
-
-      # Returns the raw consolidated CSS/JS contents of a given type/set
-      def combine(type, set)
-        assets(type, set).map { |asset| File.open(asset[:path]).read }.join("\n").strip
-      end
-
-      # Returns compressed code
-      def compress(type, set)
-        code = combine(type, set)
-        if type == :js
-          minify_js code
-        elsif type == :css
-          minify_css code
-        else
-          raise ArgumentError, "type should be one of :js or :css"
-        end
-      end
-
-      def minify_css( src )
-        src.gsub! /\s+/, " "
-        src.gsub! /\/\*(.*?)\*\//, ""
-        src.gsub! /\} /, "}\n"
-        src.gsub! /\n$/, ""
-        src.gsub! /[ \t]*\{[ \t]*/, "{"
-        src.gsub! /;[ \t]*\}/, "}"
-        src.gsub! /[ \t]*([,|{|}|>|:|;])[ \t]*/,"\\1" # Tersify
-        src.gsub! /[ \t]*\n[ \t]*/, "" # Hardcore mode (no NLs)
-        src.strip
-      end
-
-      def minify_js(src)
-        JSMin.minify src
-      end
-
-
-      # Returns the file path of where assets of a certain type are stored.
-      #
-      # Params:
-      #   - `type` (Symbol)  - Either `:js` or `:css`.
-      #
-      # Example:
-      #   get_path :js
-      #   # Possible value: "/home/rsc/myproject/public/js" 
-      #
-      def get_path(type)
-        path = (type == :js) ? settings.js_path : settings.css_path
-        root_path path.squeeze('/')
-      end
-
-      # Returns the URL for a given filename and a type.
-      #
-      # Params:
-      #   - `type` (Symbol)  - Either `:js` or `:css`.
-      #
-      # Example:
-      #   get_url :js, '/path/to/file.js'
-      #
-      def get_url(type, filename)
-        prefix = (type == :js) ? settings.js_url : settings.css_url
-        path   = filename.gsub(/^#{Regexp.escape(get_path(type))}/, '')
-        File.join(prefix, path).squeeze('/')
-      end
-
-      # Returns a list of assets of a given type for a given set.
-      #
-      # Params:
-      #   - `type` (Symbol)  - Either `:js` or `:css`.
-      #   - `set` (String)   - The set name, as defined in `config/assets.yml`.
-      #
-      # Returns:
-      #   An array of objects.
-      #
-      #  Example:
-      #
-      #     puts assets(:js, 'base').to_json
-      #     # Possible output:
-      #     # [ { 'url': '/js/app.js', 'path': '/home/rsc/projects/assets/public/js/app.js' },
-      #     #   { 'url': '/js/main.js', 'path': '/home/rsc/projects/assets/public/js/main.js' },
-      #     #   ...
-      #     # ]
-      #
-      # See also:
-      #   - js_assets
-      #
-      def assets(type, set)
-        # type is either :js or :css
-        specs = assets_config(type)[set]
-        path  = get_path(type)
-        done  = []
-        # `specs` will be a list of filespecs. Find all files that
-        # match all specs.
-        [specs].flatten.inject([]) do |ret, spec|
-          filepath = "#{path}/#{spec}"
-          files    = Dir[filepath]
-
-          # Add it anyway if it doesn't match anything
-          unless files.any? || done.include?(filepath) || filepath.include?('*')
-            ret  << { :url => get_url(type, filepath), :path => filepath }
-            done << filepath
-          end
-
-          files.each do |filename|
-            unless done.include? filename
-              ret << {
-                :url  => [get_url(type, filename), File.mtime(filename).to_i].join('?'),
-                :path => filename
-              }
-              done << filename
-            end
-          end
-          ret
-        end
-      end
-    end
-  end
-end