headjs-rails 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "rails", ">= 3.0.0"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.11)
+      activesupport (>= 2.3.6)
+      i18n (~> 0.5.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rails (>= 3.0.0)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 David Bittencourt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+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.

data/README.md

@@ -0,0 +1,47 @@
+# headjs-rails
+
+This gem adds a helper and a generator to facilitate the use of [Head JS](http://headjs.com) in your Rails 3 projects, the same way you would normally add javascript tags using Rails `javascript_include_tag` helper.
+
+## Usage
+
+In your Gemfile, add this line:
+
+    gem "headjs-rails"
+
+Then, run `bundle install`. To invoke the generator and install the latest Head JS files in your `public/javascripts` folder, run:
+
+    rails generate headjs:install
+
+Now just add headjs to your head, using default rails `javascript_include_tag('head.min')` for example, and put the rest of your scripts at the bottom of your layout with the `headjs_include_tag` method the gem provides. This method is a wrapper of `javascript_include_tag` and accepts the exact same methods, so it should work fine with any other gem/plugin that works with it.
+
+    headjs_include_tag(:defaults)
+    headjs_include_tag(:all)
+    headjs_include_tag('http://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js')
+    headjs_include_tag('jquery', 'jquery.ui', 'jquery.plugin', 'rails')
+    headjs_include_tag(:defaults, :cache => true)
+    headjs_include_tag(:defaults, 'jquery.ui', :cache => 'bundle')
+
+The sources will have labels automatically assigned based on the filename (removing .js, .min.js and any other parameter).
+
+    headjs_include_tag('jquery', 'rails')
+    # <script type="text/javascript">head.js( { 'jquery': '/javascripts/jquery.js?23495342' }, { 'rails': '/javascripts/rails.js?458292234' } );</script>
+    
+    headjs_include_tag(:defaults, :cache => 'bundle')
+    # <script type="text/javascript">head.js( { 'bundle': '/javascripts/bundle.js' } );</script>
+
+Don't forget to use `head.ready()` in any code that runs inside your views. More information in [Head JS API](http://headjs.com/#api).
+
+I also suggest you take a look at the [smurf gem](https://github.com/thumblemonks/smurf), a drop-in gem that automatically minifies Javascript (and CSS) when you use caching and rails default include tag helpers. It works fine with `headjs_include_tag` as well as it's just a wrapper of `javascript_include_tag`.
+
+## Testing
+
+Clone the repo, run `bundle install` and `rake test`.
+
+## Contributing to headjs-rails
+
+Fork the project and send pull requests.
+
+## Copyright
+
+Author: David Bittencourt. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "headjs-rails"
+  gem.homepage = "http://github.com/muitocomplicado/headjs-rails"
+  gem.license = "MIT"
+  gem.summary = %Q{Provides Rails 3 helper and generator for adding Head JS support.}
+  gem.description = %Q{This gem adds a helper and generator to facilitate the use of Head JS in your Rails 3 projects the same way you would normally add javascript tags using Rails default helpers.}
+  gem.email = "muitocomplicado@gmail.com"
+  gem.authors = ["David Bittencourt"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "headjs-rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/headjs-rails.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{headjs-rails}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Bittencourt"]
+  s.date = %q{2010-12-02}
+  s.description = %q{This gem adds a helper and generator to facilitate the use of Head JS in your Rails 3 projects the same way you would normally add javascript tags using Rails default helpers.}
+  s.email = %q{muitocomplicado@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "headjs-rails.gemspec",
+    "lib/generators/headjs/install/install_generator.rb",
+    "lib/headjs-rails.rb",
+    "lib/headjs-rails/tag_helper.rb",
+    "test/helper.rb",
+    "test/public/javascripts/jquery.js",
+    "test/public/javascripts/rails.js",
+    "test/test_generator.rb",
+    "test/test_tag_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/muitocomplicado/headjs-rails}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Provides Rails 3 helper and generator for adding Head JS support.}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_generator.rb",
+    "test/test_tag_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 3.0.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 3.0.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/generators/headjs/install/install_generator.rb

@@ -0,0 +1,32 @@
+module Headjs
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "This generator downloads and installs Head JS"
+      class_option :version, :type => :string, :default => "master", :desc => "Which version of Head JS to fetch"
+      @@default_version = "master"
+
+      def remove_headjs
+        %w(head.js head.min.js).each do |js|
+          remove_file "public/javascripts/#{js}"
+        end
+      end
+
+      def download_headjs
+        say_status("fetching", "Head JS (#{options.version})", :green)
+        get_headjs(options.version)
+      rescue OpenURI::HTTPError
+        say_status("warning", "could not find Head JS (#{options.version})", :yellow)
+        say_status("fetching", "Head JS (#{@@default_version})", :green)
+        get_headjs(@@default_version)
+      end
+
+    private
+
+      def get_headjs(version)
+        get "https://github.com/headjs/headjs/raw/#{version}/head.js",     "public/javascripts/head.js"
+        get "https://github.com/headjs/headjs/raw/#{version}/head.min.js", "public/javascripts/head.min.js"
+      end
+
+    end
+  end
+end

data/lib/headjs-rails.rb

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), 'headjs-rails', 'tag_helper')
+
+ActionController::Base.helper(Headjs::TagHelper)

data/lib/headjs-rails/tag_helper.rb

@@ -0,0 +1,21 @@
+module Headjs
+  
+  module TagHelper
+
+    def headjs_include_tag(*sources)
+      keys = []
+      content_tag :script, :type => Mime::JS do
+        "head.js( #{javascript_include_tag(*sources).scan(/src="([^"]+)"/).flatten.map { |src| 
+          key = URI.parse(src).path[%r{[^/]+\z}].gsub(/\.js$/,'').gsub(/\.min$/,'')
+          while keys.include?(key) do
+            key += '_' + key
+          end
+          keys << key
+          "{ '#{key}': '#{src}' }" 
+        }.join(', ')} );"
+      end
+    end
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rails/all'
+require 'shoulda'
+require 'rails/test_help'
+require 'rails/generators'
+require 'headjs-rails'
+

data/test/test_generator.rb

@@ -0,0 +1,31 @@
+require 'helper'
+require 'generators/headjs/install/install_generator'
+
+class Headjs::Generators::InstallGeneratorTest < Rails::Generators::TestCase
+  tests Headjs::Generators::InstallGenerator
+  destination File.join(File.dirname(__FILE__), 'tmp')
+  teardown :cleanup_destination_root
+  
+  context 'the Head JS install generator' do
+    
+    should 'download the default master Head JS files' do
+      run_generator %w(headjs:install)
+      assert_file 'public/javascripts/head.js'
+      assert_file 'public/javascripts/head.min.js'
+    end
+    
+    should 'download the versioned Head JS files' do
+      run_generator %w(headjs:install --version master)
+      assert_file 'public/javascripts/head.js'
+      assert_file 'public/javascripts/head.min.js'
+    end
+    
+  end
+  
+  private
+  
+  def cleanup_destination_root
+    FileUtils.rm_r(destination_root)
+  end
+
+end

data/test/test_tag_helper.rb

@@ -0,0 +1,72 @@
+require 'helper'
+
+module Headjs
+  
+  class TagHelperTest < Test::Unit::TestCase
+    
+    def setup
+      
+      ENV["RAILS_ASSET_ID"] = ''
+      ActionView::Helpers::AssetTagHelper.register_javascript_expansion :defaults => %w(jquery rails)
+      
+      public_dir = File.join(File.dirname(__FILE__), 'public')
+      @helpers = ActionController::Base.helpers
+      @helpers.config.perform_caching = false
+      @helpers.config.assets_dir = public_dir
+      @helpers.config.javascripts_dir = "#{public_dir}/javascripts"
+      
+      %w(all.js bundle.js).each do |js|
+        begin
+          File.delete(File.join(public_dir, 'javascripts', js))
+        rescue
+        end
+      end
+    
+    end
+    
+    def jquery
+      'http://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js'
+    end
+    
+    context "The Head JS helper include tag" do
+    
+      should "return a valid script tag" do
+        assert_equal "<script type=\"text/javascript\">head.js( { 'jquery': '#{jquery}' } );</script>", @helpers.headjs_include_tag(jquery)
+      end
+    
+      should "concatenate labels to avoid overwriting" do
+        assert_equal "<script type=\"text/javascript\">head.js( { 'jquery': '#{jquery}' }, { 'jquery_jquery': '#{jquery}' } );</script>", @helpers.headjs_include_tag(jquery, jquery)
+      end
+      
+      should "accept strings for local paths" do
+        assert_equal "<script type=\"text/javascript\">head.js( { 'jquery': '/javascripts/jquery.js' }, { 'rails': '/javascripts/other/rails.js' } );</script>", @helpers.headjs_include_tag('jquery', 'other/rails')
+      end
+      
+      should "accept :defaults registered expansions" do
+        assert_equal "<script type=\"text/javascript\">head.js( { 'jquery': '/javascripts/jquery.js' }, { 'rails': '/javascripts/rails.js' } );</script>", @helpers.headjs_include_tag(:defaults)
+      end
+      
+      should "accept :all expansion" do
+        assert_equal "<script type=\"text/javascript\">head.js( { 'jquery': '/javascripts/jquery.js' }, { 'rails': '/javascripts/rails.js' }, { 'application': '/javascripts/application.js' } );</script>", @helpers.headjs_include_tag(:all)
+      end
+      
+      should "accept a :cache => true parameter" do
+        @helpers.config.perform_caching = true
+        assert_equal "<script type=\"text/javascript\">head.js( { 'all': '/javascripts/all.js' } );</script>", @helpers.headjs_include_tag(:defaults, :cache => true)
+      end
+      
+      should "accept a :cache => bundle parameter" do
+        @helpers.config.perform_caching = true
+        assert_equal "<script type=\"text/javascript\">head.js( { 'bundle': '/javascripts/bundle.js' } );</script>", @helpers.headjs_include_tag(:defaults, :cache => 'bundle')
+      end
+      
+      should "work with random rails asset ids" do
+        ENV["RAILS_ASSET_ID"] = '123456789'
+        assert_equal "<script type=\"text/javascript\">head.js( { 'jquery': '/javascripts/jquery.js?#{ENV["RAILS_ASSET_ID"]}' }, { 'rails': '/javascripts/rails.js?#{ENV["RAILS_ASSET_ID"]}' } );</script>", @helpers.headjs_include_tag(:defaults)
+      end
+      
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: headjs-rails
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Bittencourt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-02 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  name: rails
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: shoulda
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id005
+description: This gem adds a helper and generator to facilitate the use of Head JS in your Rails 3 projects the same way you would normally add javascript tags using Rails default helpers.
+email: muitocomplicado@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- headjs-rails.gemspec
+- lib/generators/headjs/install/install_generator.rb
+- lib/headjs-rails.rb
+- lib/headjs-rails/tag_helper.rb
+- test/helper.rb
+- test/public/javascripts/jquery.js
+- test/public/javascripts/rails.js
+- test/test_generator.rb
+- test/test_tag_helper.rb
+has_rdoc: true
+homepage: http://github.com/muitocomplicado/headjs-rails
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides Rails 3 helper and generator for adding Head JS support.
+test_files: 
+- test/helper.rb
+- test/test_generator.rb
+- test/test_tag_helper.rb