jquery_tag 0.1.3 → 0.2.0

data/.gitignore

@@ -1,4 +1,6 @@
 pkg/*
+doc
+.yardoc
 *.gem
 .bundle
 .rvmrc

data/README.markdown

@@ -1,22 +1,36 @@
 # Jquery_tag
-a Rails Helper for togglin' between a local jquery.js file located in /public/javascripts/jquery.js or the hosted script on Google's CDN.
-Also supports the same behaviour for a local jquery-ui.js file or the CDN version.
+A Helper gem for both Rails and Sinatra for toggling between a local jquery.js file or the hosted script on Google's CDN based on your application environment, avoiding network dependency during development and bandwidth usage when your application goes live.
+It also supports the same behavior for a loading the jQuery UI script.
 
 To know more about the benefits of using a CDN for your common Javascript frameworks, check [this Chris Coyier post](http://css-tricks.com/google-cdn-naming/) at [CSS-Tricks](http://css-tricks.com).
 
 ## Installation
-Just add the `jquery_tag` to your Gemfile and run `bundle install`.
-To download the latest jQuery scripts, check the [jquery-rails](https://github.com/indirect/jquery-rails) gem.
+If you're using [Bundler](http://gembundler.com), just add the `jquery_tag` to your Gemfile and run `bundle install`. If not, `gem install jquery_tag` and `require 'jquery_tag'` inside your application code.
+
+To download the latest jQuery script to your application just run `jquery_tag` command inside your Terminal and the script will be downloaded to `public/javascripts/jquery.js`. You can check the available options running it with the `-h` flag.
 
 ## Usage
-Inside your views
+Inside your views, you can just call the `jquery_tag` method.
 
     <%= jquery_tag %>
 
-Accepted options:
+It accepts a some configuration options by using the following symbols:
 
-    :version          # Overrides the script version on the CDN URL. Defaults do '1.4.4'
+    :version          # Overrides the script version on the CDN URL. Defaults do '1.5.0'
     :file             # Path for the local script. Defaults do 'jquery.js'
-    :ui               # Loads the jquery-ui file. Accepts a true value for loading a 'jquery-ui.js' file or a String for the local path.
+    :ui               # Loads jQuery UI. Accepts a true value for loading a 'jquery-ui.js' file or a String for the local path.
+
+Any other arguments will be passed along to the `javascript_include_tag` helper, if inside a Rails application. The [Sinatra Helper](https://github.com/lucasmazza/jquery-tag/blob/master/lib/jquery_tag/helpers/sinatra_helper.rb) currently ignores any extra option.
+
+## Sinatra
+To use the `jquery_tag` on your [Sinatra](http://www.sinatrarb.com/) applications, just include the `JqueryTag::SinatraHelper` on your application
+
+    require 'jquery_tag' # if your not using Bundler.
+
+    class Application < Sinatra::Base
+      helpers do
+        include JqueryTag::SinatraHelper
+      end
+    end
 
-Any other arguments will be passed along to the `javascript_include_tag` helper.
+Just call the `jquery_tag` helper inside your views or layouts, as in the example above. Your local scripts should be located inside a `./public/javascripts/` folder (or whatever the Sinatra public path is configured on your application).

data/bin/jquery_tag

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+require 'jquery_tag/installer'
+
+JqueryTag::Installer.new(ARGV.dup).start

data/jquery_tag.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Lucas Mazza"]
   s.email       = ["luc4smazza@gmail.com"]
   s.homepage    = "http://rubygems.org/gems/jquery_tag"
-  s.summary     = "jQuery script tag helper for Rails"
+  s.summary     = "jQuery script tag helper for Rails and Sinatra"
   s.description = "Helper gem that toggles between local jquery script and Google CDN version based on your app environment"
 
   s.required_rubygems_version = ">= 1.3.6"

data/lib/jquery_tag/helper.rb

@@ -0,0 +1,67 @@
+module JqueryTag # :nodoc:
+  ## +jQueryTag::Helper+ is the abstract base for real Helper module
+  ## that should be used.
+  ##
+  ## This Module is responsible for the argument parsing and the public api
+  ## of the +jquery_tag+ method, that you should use inside your views and layouts.
+  ##
+  ## == Usage
+  ## inside your application.html.erb, just above the closing body tag.
+  ##  <%= jquery_tag %>
+  ## During development, the given helper will render something like this:
+  ##  <script type="text/javascript" src="/javascripts/jquery.js"></script>
+  ## Your application will be using a local version of jQuery, avoiding any network usage. Once you
+  ## shift to production mode, the ouput will be:
+  ##  <script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.5.0/jquery.min.js"></script>
+  ## Reducing your server bandwidth load and sharing the same cached file from many other sites.
+  ##
+  ## == Dependencies
+  ## +jQueryTag::Helper+ relies on two other methods that should be implemented:
+  ##
+  ## * +production?+ - it should return +true+ if the application is on  production mode. Otherwise, false.
+  ## * +javascript_tag(paths, options)+ - responsible for building the tags for the given paths array. Any other option should be passed on the second argument, a options hash.
+  module Helper
+
+    ## Builds the proper script tags for a suitable url or path for both jQuery or jQuery UI scripts.
+    ##
+    ## @option :file [String] an alternative path for the local jquery.js file. Defaults to `jquery.js`
+    ## @option :version [String] tells the helper to target a different version of jQuery hosted on Google's CDN. Defaults to JqueryTag.version
+    ## @option :ui [String, TrueClass] loads the jQuery UI File. Can be a [TrueClass] or a [String], overriding the local path for the script.
+    ## Any other argument will be delivered to the +javascript_tag+ method.
+    ##
+    ## @return [String] the html tags to include scripts
+    def jquery_tag(*arguments)
+      options = extract_options(arguments)
+      paths = []
+      paths << jquery_file(options[:file], options[:version])
+      paths << jquery_ui_file(options[:ui]) if options[:ui]
+
+      javascript_tag(paths, arguments)
+    end
+
+    private
+
+    def extract_options(arguments)
+      keys = [:file, :version, :ui]
+      if arguments.last.is_a?(Hash)
+        options = Hash[keys.map { |o| [o, arguments.last.delete(o)] }]
+        arguments.pop if arguments.last.empty?
+      else
+        options = {}
+      end
+      options
+    end
+
+    def jquery_file(path, version)
+      path ||= 'jquery.js'
+      version ||= JqueryTag.version
+      production? ? "//ajax.googleapis.com/ajax/libs/jquery/#{version}/jquery.min.js" : path
+    end
+
+    def jquery_ui_file(path)
+      path = path.is_a?(String) ? path : "jquery-ui.js"
+      version = JqueryTag.ui_version
+      production? ? "//ajax.googleapis.com/ajax/libs/jqueryui/#{version}/jquery-ui.min.js" : path
+    end
+  end
+end

data/lib/jquery_tag/helpers/rails_helper.rb

@@ -0,0 +1,22 @@
+module JqueryTag # :nodoc:
+  ## The Helper implementation for +Ruby on Rails+ applications.
+  ## Will be included on +ActionView::Base+ automatically on gem loading.
+  module RailsHelper
+    include JqueryTag::Helper
+
+    ## Delegates the verification to +Rails.env+
+    ## @return [Boolean] true if the current Rails environment is production.
+    def production?
+      Rails.env.production?
+    end
+
+    ## Builds the script tags using the +javascript_included_tag+ method from Rails.
+    ## @param [Array] paths_or_urls The paths for the local files or the CDN urls.
+    ## @param [Hash] options any other option that should be delivered to +javascript_include_tag+.
+    ## @return [String] the concatenated html tags
+    def javascript_tag(paths_or_urls, options = {})
+      arguments = paths_or_urls + [options].flatten
+      javascript_include_tag(arguments)
+    end
+  end
+end

data/lib/jquery_tag/helpers/sinatra_helper.rb

@@ -0,0 +1,32 @@
+module JqueryTag # :nodoc:
+  ## The Helper implementation for +Sinatra+ applications.
+  ## you should manually include this Module as a helper inside your application
+  ##  class MyApp < Sinatra::Base
+  ##    helpers do
+  ##      include JqueryTag::SinatraHelper
+  ##    end
+  ##  end
+  module SinatraHelper
+    include JqueryTag::Helper
+
+    ## Delegates the verification to Sinatra +settings+ object and check it's environment value.
+    ## @return [Boolean] true if the application is in the production environment.
+    def production?
+      settings.environment == :production
+    end
+
+    ## A Simple helper that concatenates the html for the script tags.
+    ## @param [Array] paths_or_urls The paths for the local files or the CDN urls.
+    ## @param [Hash] options the current implementation doesn't use the options hash.
+    ## @return [String] the concatenated html tags
+    def javascript_tag(paths_or_urls, options = {})
+      paths_or_urls.map { |path| build_tag(path) }.join
+    end
+
+    private
+    def build_tag(path_or_url)
+      path_or_url = "/javascripts/#{path_or_url}" unless production?
+      %Q{<script type="text/javascript" src="#{path_or_url}"></script>}
+    end
+  end
+end

data/lib/jquery_tag/installer.rb

@@ -0,0 +1,43 @@
+require 'jquery_tag'
+require 'optparse'
+require 'open-uri'
+
+module JqueryTag #:nodoc:
+  # +JqueryTag::Installer+ is the class called by the +jquery_tag+ command line
+  # to download the latest version of the jQuery script to your public/javascripts folder.
+  class Installer
+
+    attr_reader :path, :version, :arguments
+
+    def initialize(arguments)
+      @version = JqueryTag.version
+      @path = File.expand_path("public/javascripts/jquery.js")
+      @arguments = arguments
+    end
+
+    # Parses the arguments given by arguments array using +OptionParser+
+    # and downloads the script file.
+    def start
+      parse!
+      run
+    end
+
+    private
+
+    def parse!
+      OptionParser.new do |opts|
+        opts.banner = "Usage: jquery_tag [-v VERSION] [-p PATH]"
+        opts.on("-v", "--version VERSION", "Sets the target version to download. Defaults '#{JqueryTag.version}'.") { |v| @version = v }
+        opts.on("-p", "--path PATH", "The path to save the script file. Defaults to 'public/javascripts/jquery.js'.") { |path| @path = path }
+        opts.on("-h", "--help", "Outputs this message.") { puts opts; exit }
+      end.parse!(arguments)
+    end
+
+    def run
+      content = open("http://ajax.googleapis.com/ajax/libs/jquery/#{version}/jquery.js") { |io| io.binmode.read }
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, "w") { |file| file.write(content) }
+      puts "jQuery #{version} downloaded to #{path}"
+    end
+  end
+end

data/lib/jquery_tag/version.rb

@@ -1,3 +1,3 @@
-module JqueryTag
-  VERSION = "0.1.3"
+module JqueryTag #:nodoc:
+  VERSION = "0.2.0" # :nodoc:
 end

data/lib/jquery_tag.rb

@@ -1,3 +1,12 @@
-require 'jquery_tag/view_helpers'
+require 'jquery_tag/helper'
+require 'jquery_tag/helpers/rails_helper'
+require 'jquery_tag/helpers/sinatra_helper'
 
-ActionView::Base.send(:include, JqueryTag::ViewHelpers)
+module JqueryTag # :nodoc:
+  ## @return [String] the current (mostly latest) version of jQuery.
+  def self.version;    '1.5.0'; end
+  ## @return [String] the current (mostly latest) version of jQuery UI.
+  def self.ui_version; '1.8.9'; end
+end
+
+ActionView::Base.send(:include, JqueryTag::RailsHelper) if defined? Rails

data/spec/{jquery_tag_spec.rb → rails_helper_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe JqueryTag::ViewHelpers do
-  include JqueryTag::ViewHelpers
+describe JqueryTag::RailsHelper do
+  include JqueryTag::RailsHelper
 
-  context "development" do
+  context "in development environment" do
     before { development! }
 
     it "renders a local jquery.js file" do
@@ -11,9 +11,14 @@ describe JqueryTag::ViewHelpers do
       jquery_tag
     end
 
+    it "delegates any other arguments and options" do
+      expects_include_with ['jquery.js', {:cached => true}]
+      jquery_tag :cached => true
+    end
+
     it "delegates any other arguments" do
-      expects_include_with ['jquery.js', 'application.js']
-      jquery_tag 'application.js'
+      expects_include_with ['jquery.js', 'other.js', {:cached => true}]
+      jquery_tag 'other.js', :cached => true
     end
 
     it "accepts a different path for the local jquery file" do
@@ -32,7 +37,7 @@ describe JqueryTag::ViewHelpers do
     end
   end
 
-  context "production" do
+  context "in production environment" do
     before { production! }
 
     it "uses the google CDN path" do

data/spec/sinatra_helper_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe JqueryTag::SinatraHelper do
+  include JqueryTag::SinatraHelper
+
+  context "in development environment" do
+    before { development! }
+
+    it "renders a local jquery.js file" do
+      jquery_tag.should == %Q{<script type="text/javascript" src="/javascripts/jquery.js"></script>}
+    end
+
+    it "delegates any other arguments"
+
+    it "accepts a different path for the local jquery file" do
+      jquery_tag(:file => "frameworks/jquery.min.js").should == %Q{<script type="text/javascript" src="/javascripts/frameworks/jquery.min.js"></script>}
+    end
+
+    it "renders the jquery-ui.js file" do
+      expected = %Q{<script type="text/javascript" src="/javascripts/jquery.js"></script>}
+      expected << %Q{<script type="text/javascript" src="/javascripts/jquery-ui.js"></script>}
+      jquery_tag(:ui => true).should == expected
+    end
+
+    it "receives a path to the jquery-ui.js file" do
+      expected = %Q{<script type="text/javascript" src="/javascripts/jquery.js"></script>}
+      expected << %Q{<script type="text/javascript" src="/javascripts/frameworks/jquery-ui.js"></script>}
+      jquery_tag(:ui => 'frameworks/jquery-ui.js').should == expected
+    end
+  end
+
+  context "in production environment" do
+    before { production! }
+
+    it "uses the google CDN path" do
+      expected = %Q{<script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.5.0/jquery.min.js"></script>}
+      jquery_tag.should == expected
+    end
+
+    it "accepts a different version for the jquery script" do
+      expected = %Q{<script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.0.0/jquery.min.js"></script>}
+      jquery_tag(:version => '1.0.0').should == expected
+    end
+
+    it "uses the google CDN path for the jquery ui script" do
+      expected = %Q{<script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.5.0/jquery.min.js"></script>}
+      expected << %Q{<script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jqueryui/1.8.9/jquery-ui.min.js"></script>}
+      jquery_tag(:ui => true).should == expected
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,17 +1,24 @@
-require 'jquery_tag/view_helpers'
+require 'jquery_tag'
 
 module Rails
 end
 
 module SpecHelper
+
+  def settings
+    @_settings ||= mock
+  end
+
   def production!
+    settings.stub(:environment) { :production }
     Rails.stub_chain(:env, :production?) { true }
   end
-  
+
   def development!
+    settings.stub(:environment) { :development }
     Rails.stub_chain(:env, :production?) { false }
   end
-  
+
   def expects_include_with(*args)
     should_receive(:javascript_include_tag).with(*args)
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jquery_tag
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Lucas Mazza
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-03 00:00:00 -02:00
+date: 2011-02-17 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,8 +51,8 @@ dependencies:
 description: Helper gem that toggles between local jquery script and Google CDN version based on your app environment
 email: 
 - luc4smazza@gmail.com
-executables: []
-
+executables: 
+- jquery_tag
 extensions: []
 
 extra_rdoc_files: []
@@ -62,11 +62,16 @@ files:
 - Gemfile
 - README.markdown
 - Rakefile
+- bin/jquery_tag
 - jquery_tag.gemspec
 - lib/jquery_tag.rb
+- lib/jquery_tag/helper.rb
+- lib/jquery_tag/helpers/rails_helper.rb
+- lib/jquery_tag/helpers/sinatra_helper.rb
+- lib/jquery_tag/installer.rb
 - lib/jquery_tag/version.rb
-- lib/jquery_tag/view_helpers.rb
-- spec/jquery_tag_spec.rb
+- spec/rails_helper_spec.rb
+- spec/sinatra_helper_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/jquery_tag
@@ -100,9 +105,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.1
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: jQuery script tag helper for Rails
+summary: jQuery script tag helper for Rails and Sinatra
 test_files: []
 

data/lib/jquery_tag/view_helpers.rb

@@ -1,26 +0,0 @@
-module JqueryTag
-  module ViewHelpers
-    def jquery_tag(*args)
-
-      options = args.first.is_a?(Hash) ? args.pop : {}
-
-      args.unshift(jquery_ui_file(options[:ui])) if options[:ui]
-      args.unshift(jquery_file(options[:file], options[:version]))
-
-      javascript_include_tag args
-   end
-
-   private
-   def jquery_file(path, version)
-     path ||= 'jquery.js'
-     version ||= '1.5.0'
-     Rails.env.production? ? "//ajax.googleapis.com/ajax/libs/jquery/#{version}/jquery.min.js" : path
-   end
-
-   def jquery_ui_file(path)
-     path = path.is_a?(String) ? path : "jquery-ui.js"
-     version = '1.8.9'
-     Rails.env.production? ? "//ajax.googleapis.com/ajax/libs/jqueryui/#{version}/jquery-ui.min.js" : path
-   end
-  end
-end