paste 0.2.2 → 0.3.0

data/README.rdoc

@@ -13,14 +13,14 @@ Put all of your javascript files in <tt>app/javascripts</tt>. You can even make
 
 Now in your views, whenever you need javascript, just call
   <% javascript 'some/javascript/file' %>
-  <% css 'some/css/file' %>
-or	
+  <% stylesheet 'some/css/file' %>
+or
   <% javascript 'foo/bar', 'foo', 'baz' %>
-		
+
 And then in your layout file,
 
-  <%= paste_js_tags %>
-  <%= paste_css_tags %>
+  <%= javascript_tags %>
+  <%= stylesheet_tags %>
 
 And that's it!
 
@@ -28,15 +28,7 @@ I would recommend you add <tt>public/javascripts/*</tt> to the ignore list of yo
 
 == Behaviour
 
-Paste uses +stylesheet_link_tag+ with a <tt>:cache</tt> option set to a hash of the included CSS files. Normally this means that in production all CSS is concatenated into one file.
-
-=== Production
-For a Rails app, in production, <tt>Paste::JS::Unify</tt> is used to concatenate javascript. This means that +paste_js_tags+ will output only one tag. This tag will have the concatenation of all javascript required, including all of the dependencies (in the correct order).
-
-This is not compressed originally because it's generated on the fly. A cache file is written, however, so on a re-deploy you can rebuild all of the previously generated concatenations and Google's closure compiler is used for compression.
-
-=== Development
-For a Rails app in development, <tt>Paste::JS::Chain</tt> is used to paste javascripts together. This paster simply takes the list of javascripts and determines the dependencies and then generates a separate tag for each javascript file. This proves useful for debugging.
+Paste uses +stylesheet_link_tag+ and +javascript_include_tag+ with a <tt>:cache</tt> option set to a hash of the included files. Normally this means that in production all files are concatenated together.
 
 == Example
 
@@ -46,7 +38,7 @@ Assume that <tt>app/javascripts/jquery.js</tt> exists and we have these files:
 
   //= require <jquery>
   //= require <foo/bar>
-		
+
   $(function() {
     $('#foo').fadeIn().html($['BAR_VALUE']);
   });
@@ -58,10 +50,10 @@ Assume that <tt>app/javascripts/jquery.js</tt> exists and we have these files:
   $['BAR_VALUE'] = <%= Bar::BAR_VALUE %>;
 
 ==== app/views/foo/index.html.erb
-		
+
   <% javascript 'foo' %>
-  <% css 'foo' %>
-		
+  <% stylesheet 'foo' %>
+
   <div id='bar'>
     And the bar value for today is: <div id='foo'></div>
   </div>
@@ -71,31 +63,23 @@ For this example, whenever +foo/index.html.erb+ is rendered, the stylesheet +pub
 == Configuration
 
 The following are recognized options:
-  
+
   # These options are read by both Paste::JS and Paste::CSS
-  Paste::Glue.configure do |config|
+  Paste.configure do |config|
     config.root     # the root directory (defaults to Rails.root or the pwd)
 
     config.tmp_path # a temporary directory to use. Can be relative to the root
                     # or it can be an absolute path. Default: 'tmp/paste-cache'
-  end
 
-  Paste::JS.configure do |config|
-    config.destination # relative or absolute path of where to put javascripts.
-                       # Default: 'public/javascripts'
-    
-    config.load_path   # The load path for javascripts. This is where to find
-                       # the source files. Default: ['app/javascripts']
-    
+    config.js_destination # relative or absolute path of where to put
+                          # javascripts. Default: 'public/javascripts'
+
+    config.js_load_path   # The load path for javascripts. This is where to find
+                          # the source files. Default: ['app/javascripts']
+
     config.erb_path    # relative or absolute path of where to generate the
                        # ERB results to. Default: 'tmp/paste-cache/erb'
-    
-    config.cache_file  # The cache file for when pastes are made. This allows
-                       # the same pastes to be persisted through deployments
-                       # without regenerating on the first request. This is
-                       # a location relative to config.tmp_path
-                       # Default: sprockets.yml
-    
+
     config.parser      # The parser class to use when determining dependencies
                        # of javascripts. Default: Paste::Parser::Sprockets
   end
@@ -110,4 +94,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 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.
+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/lib/paste/cache.rb

@@ -0,0 +1,33 @@
+require 'active_support/core_ext/module/synchronization'
+require 'yaml'
+
+module Paste
+  module Cache
+
+    def rebuild
+      find_sources
+
+      @sources.reject!{ |_, parser| !File.exists? parser.file }
+
+      @sources.values.each &:copy_if_needed
+    end
+
+    def parser source
+      find_sources if @sources.nil?
+      @sources[find(source)]
+    end
+
+    protected
+
+    def find_sources
+      @sources ||= {}
+
+      load_path.each do |path|
+        Dir[path + '/**/*.js'].each do |file|
+          @sources[file] ||= config.parser.new(self, file.gsub(path + '/', ''))
+        end
+      end
+    end
+
+  end
+end

data/lib/paste/compress.rb

@@ -0,0 +1,71 @@
+require 'closure-compiler'
+require 'active_support/core_ext/hash/except'
+
+module Paste
+  module Compress
+    extend ActiveSupport::Concern
+
+    included do
+      # alias_method_chain :rebuild!, :compression
+    end
+
+    def rebuild_with_compression! options = {}
+      rebuild_without_compression!
+
+      results.keys.each do |result|
+        compress result, options
+      end
+    end
+
+    def compress result, options = {}
+      case options[:compress]
+        when 'google'
+          google_compress result, options.except(:compress)
+        when nil, false
+          # Compression not asked for
+        else
+          raise "Unknown compression technique: #{options[:compress]}"
+      end
+    end
+
+    protected
+
+    def has_java?
+      system 'java &> /dev/null'
+    end
+
+    def google_compress *args
+      has_java? ? google_compress_with_java(*args) :
+        google_compress_without_java(*args)
+    end
+
+    def google_compress_with_java result, options = {}
+      file, output = destination(result), ''
+      handle = File.open(file, 'a+')
+      File.open(file, 'r') do |f|
+        output = Closure::Compiler.new(options).compile f
+      end
+
+      File.open(file, 'w+') { |f| f << output.chomp }
+    end
+
+    def google_compress_without_java result, options = {}
+      file = destination result
+      uri  = URI.parse('http://closure-compiler.appspot.com/compile')
+      req  = Net::HTTP.post_form(uri,
+        :js_code           => File.read(file),
+        :compilation_level => options[:compilation_level] ||
+          'SIMPLE_OPTIMIZATIONS',
+        :output_format     => 'text',
+        :output_info       => 'compiled_code'
+      )
+
+      if req.is_a? Net::HTTPSuccess
+        File.open(file, 'w') { |f| f << req.body.chomp }
+      else
+        raise "Google couldn't compile #{result}!"
+      end
+    end
+
+  end
+end

data/lib/paste/erb_renderer.rb

@@ -0,0 +1,53 @@
+require 'erb'
+
+module Paste
+  module ERBRenderer
+
+    def render_all_erb
+      erb_sources.each { |s| render_erb s }
+    end
+
+    def render_erb source
+      to_generate = erb_path source.sub(/\.erb$/, '')
+      source      = find source
+
+      if !File.exists?(to_generate) ||
+          File.mtime(source) > File.mtime(to_generate)
+
+        FileUtils.mkdir_p File.dirname(to_generate)
+        contents = PasteERBHelper.new(File.read(source)).result
+        File.open(to_generate, 'w') { |f| f << contents }
+      end
+    end
+
+    protected
+
+    def erb_sources
+      sources = load_path.map do |path|
+        Dir[path + '/**/*.js.erb'].map do |erb|
+          erb.gsub(path + '/', '')
+        end
+      end
+      sources.flatten
+    end
+
+  end
+end
+
+# This needs to be outside of the module because we don't want to
+# force templates to always do ::Rails
+class PasteERBHelper < ERB
+  include ActionView::Helpers if defined?(ActionView::Helpers)
+
+  def config
+    Rails.application.config.action_controller if defined?(Rails)
+  end
+
+  def result *args
+    super binding
+  end
+
+  def controller
+    nil
+  end
+end

data/lib/paste/glue.rb

@@ -6,7 +6,50 @@ module Paste
 
     include ActiveSupport::Configurable
     include Resolver
-    include JS::ERBRenderer
-    
+    include ERBRenderer
+    include Cache
+
+    def initialize
+      config.js_load_path << erb_path
+    end
+
+    def paste *sources
+      js_dependencies  = []
+      css_dependencies = []
+
+      sources.each do |source|
+        in_order_traversal parser(source), js_dependencies, css_dependencies
+      end
+
+      {
+        :javascripts => js_dependencies,
+        :stylesheets => css_dependencies
+      }
+    end
+
+    protected
+
+    def in_order_traversal parser, js_deps, css_deps, current_path = []
+      return if js_deps.include? parser.source
+
+      if current_path.include? parser.source
+        raise "Circular dependency at #{parser.source}"
+      end
+
+      current_path.push parser.source
+
+      parser.js_dependencies.each do |dependency|
+        in_order_traversal parser(dependency), js_deps, css_deps, current_path
+      end
+
+      js_deps.push current_path.pop
+
+      parser.css_dependencies.each do |css_dep|
+        css_deps.push css_dep
+      end
+
+      css_deps.uniq!
+    end
+
   end
-end
+end

data/lib/paste/parser/sprockets.rb

@@ -4,37 +4,54 @@ module Paste
   module Parser
     class Sprockets
 
-      attr_reader :glue, :secretary, :sources
+      attr_reader :glue, :source, :file
 
-      delegate :concatenation, :to => :secretary
-
-      def initialize glue, sources
-        @glue      = glue
-        @sources   = sources
-        reset!
+      def initialize glue, source
+        @glue   = glue
+        @source = source
+        @file   = glue.find source
+        reset_if_needed
       end
 
       def js_dependencies
-        generate_dependencies if @js_dependencies.nil?
+        reset_if_needed
         @js_dependencies
       end
 
       def css_dependencies
-        generate_dependencies if @css_dependencies.nil?
+        reset_if_needed
         @css_dependencies
       end
 
-      def reset!
-        @js_dependencies = @css_dependencies = nil
-
-        @secretary = ::Sprockets::Secretary.new(
-          :root         => glue.root, 
-          :expand_paths => false,
-          :load_path    => glue.load_path,
-          :source_files => @sources.map{ |s| glue.find s }
-        )
-      rescue ::Sprockets::LoadError => e
-        raise ResolveError.new(e.message)
+      def copy_if_needed
+        dest = glue.destination(source)
+
+        if !File.exists?(dest) || File.mtime(dest) != File.mtime(@file)
+          FileUtils.mkdir_p File.dirname(dest)
+          FileUtils.cp @file, dest
+          File.utime File.mtime(@file), File.mtime(@file), dest
+        end
+      end
+
+      def reset_if_needed
+        if @js_dependencies.nil? || @css_dependencies.nil? ||
+            @last_updated.nil? || @last_updated < File.mtime(@file)
+
+          begin
+            @last_updated    = Time.now
+
+            @secretary = ::Sprockets::Secretary.new(
+              :root         => glue.root,
+              :expand_paths => false,
+              :load_path    => glue.load_path,
+              :source_files => [@file]
+            )
+
+            generate_dependencies
+          rescue ::Sprockets::LoadError => e
+            raise ResolveError.new(e.message)
+          end
+        end
       end
 
       protected
@@ -47,31 +64,20 @@ module Paste
       def generate_dependencies
         @js_dependencies  = []
         @css_dependencies = []
-        sources.each { |source| in_order_traversal source }
-      end
-
-      def in_order_traversal source, current_path = []
-        return if @js_dependencies.include? source
-        raise "Circular dependency at #{source}" if current_path.include? source
 
-        current_path.push source
+        source_file = ::Sprockets::SourceFile.new environment,
+            ::Sprockets::Pathname.new(environment, @file)
 
-        source_file = ::Sprockets::SourceFile.new environment, 
-            ::Sprockets::Pathname.new(environment, glue.find(source))
-        css_deps = []
         source_file.source_lines.each do |line|
           if line.require?
-            in_order_traversal line.require[/^.(.*).$/, 1], current_path
+            @js_dependencies << line.require[/^.(.*).$/, 1]
           elsif line.css_require?
-            css_deps << line.css_require
+            @css_dependencies << line.css_require
           end
         end
-      
-        @js_dependencies.push current_path.pop
-        @css_dependencies = @css_dependencies | css_deps
       end
 
-    end    
+    end
   end
 end
 

data/lib/paste/rails/helper.rb

@@ -3,26 +3,22 @@ require 'digest/sha1'
 module Paste
   module Rails
     module Helper
-      def paste_js_tags *javascripts
-        include_javascripts *javascripts
 
-        return '' if @javascripts.empty?
+      def javascript_tags *javascripts
+        include_javascripts *javascripts
 
         results = Paste::Rails.glue.paste *@javascripts
 
-        javascript_include_tag(*results[:javascript])
+        javascript_include_tag *add_cache_argument(results[:javascripts])
       end
 
-      def paste_css_tags *other_css
-        include_css *other_css
+      def stylesheet_tags *other_css
+        include_stylesheets *other_css
 
         results = Paste::Rails.glue.paste *(@javascripts ||= [])
-        all_css = (results[:css] + @css).uniq
+        all_css = (results[:stylesheets] + @css).uniq
 
-        cache = Digest::SHA1.hexdigest(all_css.sort.join)[0..12]
-        all_css << {:cache => cache} unless Paste::CSS.config.no_cache
-
-        stylesheet_link_tag *all_css
+        stylesheet_link_tag *add_cache_argument(all_css)
       end
 
       def include_javascripts *javascripts
@@ -35,20 +31,35 @@ module Paste
         @javascripts
       end
 
-      def include_css *css
+      def include_stylesheets *css
         @css ||= []
         @css += css.flatten
         @css.uniq!
       end
 
-      def included_css
+      def included_stylesheets
         @css
       end
 
       alias :include_javascript :include_javascripts
       alias :javascript :include_javascripts
-      
-      alias :css :include_css
+      alias :javascripts :include_javascripts
+
+      alias :stylesheet :include_stylesheets
+      alias :stylesheets :include_stylesheets
+      alias :include_stylesheet :include_stylesheets
+
+      protected
+
+      def add_cache_argument sources
+        if Paste.config.no_cache
+          sources
+        else
+          cache = Digest::SHA1.hexdigest(sources.sort.join)[0..12]
+          sources + [{:cache => cache}]
+        end
+      end
+
     end
   end
-end
+end

data/lib/paste/rails/railtie.rb

@@ -1,29 +1,29 @@
 module Paste
   module Rails
     class Railtie < ::Rails::Railtie
-  
+
       initializer 'paste_initializer' do
-        Paste::JS.config.root = ::Rails.root
+        Paste.config.root = ::Rails.root
         ActionView::Base.send :include, Helper
+        Paste::Rails.glue = Paste::Glue.new
 
         if ::Rails.env.development?
-          Paste::Rails.glue = Paste::JS::Chain.new
           config.app_middleware.use Paste::Rails::Updater
         else
-          Paste::Rails.glue = Paste::JS::Unify.new
           config.to_prepare do
             Paste::Rails.glue.render_all_erb
+            Paste::Rails.glue.rebuild
           end
         end
 
-        if Paste::JS.config.serve_assets
-          Paste::JS.config.destination = 'tmp/javascripts'
+        if Paste.config.serve_assets
+          Paste.config.js_destination = 'tmp/javascripts'
 
           # We want this serving to be at the very front
           config.app_middleware.insert_before Rack::Runtime,
               ::Rack::Static,
               :urls => ['/javascripts'],
-              :root => File.dirname(Paste::JS::Base.destination)
+              :root => File.dirname(Paste.config.js_destination)
         end
       end
 

data/lib/paste/rails/updater.rb

@@ -7,7 +7,9 @@ module Paste
       end
 
       def call env
+        Paste::Rails.glue.render_all_erb
         Paste::Rails.glue.rebuild
+
         @app.call env
       end
 

data/lib/paste/rails.rb

@@ -3,11 +3,11 @@ module Paste
     autoload :Helper,  'paste/rails/helper'
     autoload :Railtie, 'paste/rails/railtie'
     autoload :Updater, 'paste/rails/updater'
-    
+
     class << self
       attr_accessor_with_default :glue do
-        Paste::JS::Unify.new
+        Paste::Glue.new
       end
     end
   end
-end
+end

data/lib/paste/resolver.rb

@@ -13,20 +13,21 @@ module Paste
     end
 
     [:destination, :root, :erb_path, :tmp_path].each do |attribute|
+      config_attribute = attribute == :destination ? :js_destination : attribute
       self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{attribute} relative = ''
           if relative.blank?
-            resolve config.#{attribute}
+            resolve config.#{config_attribute}
           else
-            File.join resolve(config.#{attribute}), relative
+            File.join resolve(config.#{config_attribute}), relative
           end
         end
       RUBY
     end
 
     def load_path
-      config.load_path.map { |p| resolve p }
-    end 
+      config.js_load_path.map { |p| resolve p }
+    end
 
     def find source
       source += '.js' unless source.end_with?('.js') || source.end_with?('.erb')

data/lib/paste/tasks/paste.rake

@@ -1,11 +1,6 @@
 namespace :paste do
   desc 'Rebuild all cached javascripts'
   task :rebuild => :environment do
-    Paste::Rails.glue.rebuild!
-  end
-
-  desc 'Compress all cached javascripts'
-  task :compress => :environment do
-    Paste::Rails.glue.rebuild! :compress => 'google'
+    Paste::Rails.glue.rebuild
   end
 end

data/lib/paste/version.rb

@@ -1,3 +1,3 @@
 module Paste
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/paste.rb

@@ -5,31 +5,17 @@ require 'active_support/core_ext/module/attr_accessor_with_default'
 require 'active_support/core_ext/module/delegation'
 
 module Paste
+  autoload :Cache,       'paste/cache'
+  autoload :Compress,    'paste/compress'
+  autoload :ERBRenderer, 'paste/erb_renderer'
   autoload :Glue,        'paste/glue'
   autoload :NeedsUpdate, 'paste/needs_update'
   autoload :Rails,       'paste/rails'
   autoload :Resolver,    'paste/resolver'
   autoload :VERSION,     'paste/version'
 
-  module JS
-    autoload :Base,        'paste/js/base'
-    autoload :Cache,       'paste/js/cache'
-    autoload :Chain,       'paste/js/chain'
-    autoload :Compress,    'paste/js/compress'
-    autoload :ERBRenderer, 'paste/js/erb_renderer'
-    autoload :Unify,       'paste/js/unify'
-
-    class << self
-      delegate :configure, :config, :to => Base
-    end
-  end
-  
-  module CSS
-    autoload :Base, 'paste/css/base'
-
-    class << self
-      delegate :configure, :config, :to => Base
-    end
+  class << self
+    delegate :configure, :config, :to => Glue
   end
 
   module Parser
@@ -37,22 +23,17 @@ module Paste
   end
 end
 
-Paste::Glue.configure do |config|
+Paste.configure do |config|
   config.root        = Dir.pwd
   config.tmp_path    = 'tmp/paste-cache'
-end
 
-Paste::JS.configure do |config|
-  config.destination = 'public/javascripts'
-  config.load_path   = ['app/javascripts']
+  config.js_destination = 'public/javascripts'
+  config.js_load_path   = ['app/javascripts']
   config.erb_path    = 'tmp/paste-cache/erb'
-  config.cache_file  = 'sprockets.yml'
   config.parser      = Paste::Parser::Sprockets
-end
 
-Paste::CSS.configure do |config|
-  config.destination = 'public/stylesheets'
-  config.load_path   = ['app/stylesheets']
+  config.css_destination = 'public/stylesheets'
+  config.css_load_path   = ['app/stylesheets']
 end
 
 require 'paste/rails/railtie' if defined?(Rails)