javascript_auto_include 0.1.0 → 0.2.0

data/Gemfile

@@ -1,8 +1,12 @@
 source "http://rubygems.org"
 
-gem 'actionpack', '>= 3.0.0', :require => 'action_pack'
+gem 'rails', '~> 3.0.7'
 
 group :development do
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
+  gem 'bundler'
+  gem 'jeweler'
+end
+
+group :test, :development do
+  gem 'rspec-rails', '>= 2.6.rc'
 end

data/Gemfile.lock

@@ -2,42 +2,92 @@ GEM
   remote: http://rubygems.org/
   specs:
     abstract (1.0.0)
-    actionpack (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
+    actionmailer (3.0.8)
+      actionpack (= 3.0.8)
+      mail (~> 2.2.19)
+    actionpack (3.0.8)
+      activemodel (= 3.0.8)
+      activesupport (= 3.0.8)
       builder (~> 2.1.2)
       erubis (~> 2.6.6)
-      i18n (~> 0.4)
+      i18n (~> 0.5.0)
       rack (~> 1.2.1)
-      rack-mount (~> 0.6.13)
-      rack-test (~> 0.5.6)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.3)
-      activesupport (= 3.0.3)
+    activemodel (3.0.8)
+      activesupport (= 3.0.8)
       builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activesupport (3.0.3)
+      i18n (~> 0.5.0)
+    activerecord (3.0.8)
+      activemodel (= 3.0.8)
+      activesupport (= 3.0.8)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.8)
+      activemodel (= 3.0.8)
+      activesupport (= 3.0.8)
+    activesupport (3.0.8)
+    arel (2.0.10)
     builder (2.1.2)
+    diff-lcs (1.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
     git (1.2.5)
-    i18n (0.4.2)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
+    i18n (0.5.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rack (1.2.1)
-    rack-mount (0.6.13)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.3)
+    rack-mount (0.6.14)
       rack (>= 1.0.0)
     rack-test (0.5.7)
       rack (>= 1.0)
+    rails (3.0.8)
+      actionmailer (= 3.0.8)
+      actionpack (= 3.0.8)
+      activerecord (= 3.0.8)
+      activeresource (= 3.0.8)
+      activesupport (= 3.0.8)
+      bundler (~> 1.0)
+      railties (= 3.0.8)
+    railties (3.0.8)
+      actionpack (= 3.0.8)
+      activesupport (= 3.0.8)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
     rake (0.8.7)
-    tzinfo (0.3.24)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rspec-rails (2.6.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.27)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (>= 3.0.0)
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
+  bundler
+  jeweler
+  rails (~> 3.0.7)
+  rspec-rails (>= 2.6.rc)

data/README.markdown

@@ -6,37 +6,69 @@
 
 Should be as easy as:
 
-  $ gem install javascript_auto_include
+    $ gem install javascript_auto_include
   
 Or in your Gemfile:
 
-  $ gem 'javascript_auto_include', '~> 0.1.0'
+    $ gem 'javascript_auto_include' 
 
 ## Usage
 
-Put in your layout's head just like you would with javascript_include_tag
+### javascript_auto_include_tag
 
-### Basic
+#### Basic
 
-  <%= javascript_auto_include_tag :defaults %>
+    <%= javascript_auto_include_tag :defaults %>
   
 ... will insert the default javascripts (just like `javascript_include_tag`) and also look for an action-specifc javascript file at public/javascripts/:controller/:action.js. If it exists, it will be included as well.
 
-### With custom pattern
+#### Custom pattern
 
-  <%= javascript_auto_include_tag :defaults, :pattern => ':controller_:action.js' %>
+    <%= javascript_auto_include_tag :defaults, :pattern => ':controller_:action.js' %>
 
 ... will work just like shown above but alter the search path according to the supplied pattern: public/javascripts/:controller_:action.js (e.g. public/javascripts/album_new.js)
 
-### Compatibility
+### javascript_auto_include
 
-`javascript_auto_include_tag` uses Rails' `javascript_include_tag` helper and passes on all options (:concat, :cache, ...) and keys (:defaults, :all, ...) supplied.
+#### Basic
+
+    <%= javascript_auto_include :defaults %>
+
+... will insert the default javascripts (just like `javascript_include_tag`) and also look for an action-specifc javascript file at public/javascripts/:controller/:action.js. If it exists, it will be included as well.
+
+In addition to what +javascript_auto_include_tag+ does it will also scan the sourc files' header and include those files name there as well. For that to happen your js-file's header should look something like this:
+
+    /*
+     * [...]
+     *
+     * Depends:
+     *	 jquery.ui.core.js
+     *  jquery.ui.mouse.js
+     *  jquery.ui.widget.js
+     */
+
+For erformance reasons all dependencies identified will be stored in the config/dependencies directory of your ::Rails.root. In production environments `javascript_auto_include` will automatically pick minified versions if they exist (e.g. use jquery.ui.core.min.js instead of jquery.ui.core.js)
+
+#### Custom pattern
+
+    <%= javascript_auto_include :defaults, :pattern => ':controller_:action.js' %>
+
+... will work just like shown above but alter the search path according to the supplied pattern: public/javascripts/:controller_:action.js (e.g. public/javascripts/album_new.js)
+
+#### Forcing re-scan
+
+    <%= javascript_auto_include :defaults, :force => true %>
+
+... will force +javascript_auto_include+ to parse the javascript headers again even if dependencies exists in config/depdencies/jquery.ui.core.yml)
+
+## Compatibility
+
+Both use Rails' `javascript_include_tag` helper and pass on all options (:concat, :cache, ...) and keys (:defaults, :all, ...) supplied.
 
 ## TODO
 
-I just extracted this from a current project. It still lacks specs and testing but so far it seems to work for me. 
+Right now it does what I want it to. But you decide. Go fork! 
 
 ## Copyright
 
-Copyright (c) 2011 Ulf Möhring <hello@ulfmoehring.net>. See LICENSE.txt for
-further details.
+Copyright (c) 2011 Ulf Möhring <hello@ulfmoehring.net>. See LICENSE.txt for further details.

data/Rakefile

@@ -19,6 +19,6 @@ Jeweler::Tasks.new do |gem|
   gem.description = "Rails helper for automatically including javascript files. Looks up assets in public/javascripts based on the current controller/action pair."
   gem.email = "hello@ulfmoehring.net"
   gem.authors = ["Ulf Moehring"]
-  gem.add_runtime_dependency 'actionpack', '>= 3.0.0'
+  gem.files = FileList["[A-Z]*","{lib,spec}/**/*"]
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/javascript_auto_include.rb

@@ -1,11 +1,15 @@
 module JavascriptAutoInclude
+  # Load model backend
+  require 'javascript_auto_include/dependency'
+  require 'javascript_auto_include/source_file'
+  
+  # Tie into Rails
   class Railtie < Rails::Railtie
     initializer "javascript_auto_include.action_controller" do |app|
       require 'javascript_auto_include/helpers/action_controller'
       ActionController::Base.send(:include, JavascriptAutoInclude::Helpers::ActionController)
       ActionController::Base.send(:before_filter, :identify_controller_and_action)
     end
-    
     initializer "javascript_auto_include.action_view" do |app|
       require 'javascript_auto_include/helpers/action_view'
       ActionView::Base.send(:include, JavascriptAutoInclude::Helpers::ActionView)

data/lib/javascript_auto_include/dependency.rb

@@ -0,0 +1,13 @@
+class Dependency < Array
+  
+  # Override inherited << method to only add existing files
+  def << obj
+    if File.exists?("#{::Rails.root}#{File::SEPARATOR}public#{File::SEPARATOR}javascripts#{File::SEPARATOR}#{obj}") || File.exists?("#{::Rails.root}#{File::SEPARATOR}public#{File::SEPARATOR}javascripts#{File::SEPARATOR}#{obj}.js")
+      super(obj)
+    else
+      ::Rails.logger.warn "'#{obj}' wasn't found in '#{::Rails.root}#{File::SEPARATOR}public#{File::SEPARATOR}javascripts' but seems to be required. Your app might not work as expected."
+      self
+    end
+  end
+
+end

data/lib/javascript_auto_include/helpers/action_view.rb

@@ -2,32 +2,37 @@ module JavascriptAutoInclude
   module Helpers
     # = ActionView helpers
     # 
-    # This module contains the helper +javascript_auto_include_tag+, which inserts the javascript
-    # include tag(s) into a view.
-    # 
-    # == Basic usage
-    #
-    #   <%= javascript_auto_include_tag :defaults %>
+    # This module contains the helpers +javascript_auto_include_tag+ and +javascript_auto_include+. Both provide convenient automatisms
+    # for including javascript source tags in yoru views.
     #
-    # ... will insert the default javascripts (just like javascript_include_tag) and also look for an
-    # action-specifc javascript file at public/javascripts/:controller/:action.js. If it exists, it will
-    # be included as well.
-    #
-    # == Using your own pattern
-    #
-    #   <%= javascript_auto_include_tag :defaults, :pattern => ':controller_:action.js' %>
+    # == Basic usage
     #
-    # ... will work just like shown above but alter the search path according to the supplied pattern:
-    # public/javascripts/:controller_:action.js (e.g. public/javascripts/album_new.js)
+    # See helpers below for instructions
     #
     # == Compatibility
     #
-    # +javascript_auto_include_tag+ uses Rails' javascript_include_tag helper and passes on all options
+    # Both helpers use Rails' javascript_include_tag helper and pass on all options
     # (:concat, :cache, ...) and keys (:defaults, :all, ...) supplied
     #
     module ActionView
-      
-      def javascript_auto_include_tag(*sources) #:nodoc:
+      # = javascript_auto_include_tag
+      #
+      # == Basic usage
+      #
+      #   <%= javascript_auto_include_tag :defaults %>
+      #
+      # ... will insert the default javascripts (just like javascript_include_tag) and also look for an
+      # action-specifc javascript file at public/javascripts/:controller/:action.js. If it exists, it will
+      # be included as well.
+      #
+      # == Using your own pattern
+      #
+      #   <%= javascript_auto_include_tag :defaults, :pattern => ':controller_:action.js' %>
+      #
+      # ... will work just like shown above but alter the search path according to the supplied pattern:
+      # public/javascripts/:controller_:action.js (e.g. public/javascripts/album_new.js)
+      #
+      def javascript_auto_include_tag(*sources)
         options = sources.extract_options!.stringify_keys
         pattern = options.key?("pattern") ? options.delete("pattern") : ":controller#{File::SEPARATOR}:action"
         
@@ -36,7 +41,55 @@ module JavascriptAutoInclude
         sources << auto_javascript_file if File.exists?(Rails.root.join('public','javascripts',auto_javascript_file))
         javascript_include_tag(*sources << options)
       end
-      
+      # = javascript_auto_include_tag
+      #
+      # == Basic usage
+      #
+      #   <%= javascript_auto_include :defaults %>
+      #
+      # ... will insert the default javascripts (just like javascript_include_tag) and also look for an
+      # action-specifc javascript file at public/javascripts/:controller/:action.js. If it exists, it will
+      # be included as well.
+      #
+      # In addition to what +javascript_auto_include_tag+ does it will also scan the sourc files' header and include those
+      # files name there as well. For that to happen your js-file's header should look something like this:
+      # /*
+      # * [...]
+      # *
+      # * Depends:
+      # *	 jquery.ui.core.js
+      # *  jquery.ui.mouse.js
+      # *  jquery.ui.widget.js
+      # */
+      #
+      # For erformance reasons all dependencies identified will be stored in the config/dependencies directory of your ::Rails.root.
+      # In production environments +javascript_auto_include+ will automatically pick minified versions if they exist (e.g. use
+      # jquery.ui.core.min.js instead of jquery.ui.core.js)
+      #
+      # == Using your own pattern
+      #
+      #   <%= javascript_auto_include :defaults, :pattern => ':controller_:action.js' %>
+      #
+      # ... will work just like shown above but alter the search path according to the supplied pattern:
+      # public/javascripts/:controller_:action.js (e.g. public/javascripts/album_new.js)
+      #
+      # == Forcing re-scan
+      #
+      #   <%= javascript_auto_include :defaults, :force => true %>
+      #
+      # ... will force +javascript_auto_include+ to parse the javascript headers again even if dependencies exists in
+      # config/depdencies/jquery.ui.core.yml)
+      #
+      def javascript_auto_include(*sources) #:nodoc:
+        options = sources.extract_options!.stringify_keys
+        pattern = options.key?("pattern") ? options.delete("pattern") : ":controller#{File::SEPARATOR}:action"
+        force = options.key?("force") ? options.delete("force") : false
+        
+        source = SourceFile.new(expand_javascript_sources(sources << pattern.sub(":controller",$CONTROLLER).sub(":action",$ACTION)))
+        sources = source.dependencies(force)
+        
+        javascript_include_tag(*sources << options)
+      end  
     end
   end
 end

data/lib/javascript_auto_include/source_file.rb

@@ -0,0 +1,61 @@
+require 'yaml'
+
+class SourceFile
+  
+  # Retrieve javascript file as full path
+  def initialize(files)  
+    Dir.mkdir("#{::Rails.root}#{File::SEPARATOR}config#{File::SEPARATOR}dependencies") unless Dir.exists?("#{::Rails.root}#{File::SEPARATOR}config#{File::SEPARATOR}dependencies")
+    @config_files = files.collect { |file| [file, "#{::Rails.root}#{File::SEPARATOR}config#{File::SEPARATOR}dependencies#{File::SEPARATOR}#{file}.yml"] }
+    @source_files = files.collect { |file| [file, "#{::Rails.root}#{File::SEPARATOR}public#{File::SEPARATOR}javascripts#{File::SEPARATOR}#{file}#{file.match(/\.js$/) ? '' : '.js' }"] }
+    @dependencies = Dependency.new
+  end
+  
+  # Read dependencies from config file or scan source file
+  def dependencies(force = false)
+    0.upto(@source_files.size-1) do |i|
+      if force || !config_exists?(i)
+        @dependencies += read_from_source(@source_files[i], @config_files[i]) if File.exists?(@source_files[i][1])
+      else
+        @dependencies += read_from_config(@config_files[i])
+      end
+    end
+    ENV["RAILS_ENV"] == 'production' ? minify(@dependencies.uniq) : @dependencies.uniq
+  end
+  
+  private
+    # Checks whether config file exists
+    def config_exists?(index)
+      File.exists?(@config_files[index][1])
+    end
+    
+    # Read previously identified dependencies from cache
+    def read_from_config(config)
+      YAML.load_file(config[1]).to_a << config[0]
+    end
+    
+    # Scan comment section of a javascript source file for dependencies and save result in config file
+    def read_from_source(source, config)
+      start = false
+      dependencies = []
+      File.open(source[1],'r') do |source_file|
+        while (line = source_file.gets)
+          break if line.match(/^ \*\//)
+          dependencies << line.match(/^ \*[\t ](.*\.js)/).captures.first if start && line.match(/^ \*[\t ].*\.js/)
+          start = true if line.match(/^ \* Depends:/)
+        end
+      end
+      File.open(config[1],'w') do |config_file|
+        YAML.dump(dependencies.to_a, config_file)
+      end
+      return dependencies << source[0]
+    end
+    
+    # Looks for minified file versions
+    def minify(sources)
+      sources.each do |source|
+        minified_version = source.match(/\.js$/) ? source.gsub('.js','.min.js') : "#{source}.min.js"
+        sources[sources.index(source)] = (File.exists?("#{::Rails.root}#{File::SEPARATOR}public#{File::SEPARATOR}javascripts#{File::SEPARATOR}#{minified_version}") ? minified_version : source)
+      end
+      return sources
+    end
+end

data/spec/dependency_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Dependency do
+  
+  before(:each) do
+    @dependency = Dependency.new
+  end
+  
+  it "stores existing files" do
+    @dependency << 'jquery.js'
+    @dependency.to_a.should eq(['jquery.js'])
+  end
+  
+  it "rejects non-existing files" do
+    @dependency << 'prototype.js'
+    @dependency.to_a.should eq([])
+  end
+  
+end