RubyGems - maiha-include_for - Versions diffs - 0.1 - Mend

maiha-include_for 0.1

Files changed (17) hide show

data/README ADDED Viewed

@@ -0,0 +1,108 @@
+IncludeFor
+==========
+create include or link tags automatically according to the given file names
+Usage
+=====
+  include_for "prototype.js"
+  # => '<script type="text/javascript" src="/javascripts/prototype.js"></script>'
+  include_for "application.css"
+  # => '<link type="text/css" rel="Stylesheet" media="screen" href="/stylesheets/application.css"/>'
+Example
+=======
+We can simpliy use the replacement of existing methods.
+  1. includes one file
+    <%= include_for "prototype.js" %>
+    # generates
+    <script type="text/javascript" src="/javascripts/prototype.js"></script>
+  2. plural files
+    <%= include_for "prototype.js", "controls.js" %>
+    # generates
+    <script type="text/javascript" src="/javascripts/prototype.js"></script>
+    <script type="text/javascript" src="/javascripts/controls.js"></script>
+  3. and css files
+    <%= include_for "prototype.js", "controls.js", "application.css" %>
+    # generates
+    <script type="text/javascript" src="/javascripts/prototype.js"></script>
+    <script type="text/javascript" src="/javascripts/controls.js"></script>
+    <link type="text/css" rel="Stylesheet" media="screen" href="/stylesheets/application.css"/>
+  4. avoid from including same file twice
+    <%= include_for "prototype.js", "prototype.js", "prototype.js"  %>
+    # generates
+    <script type="text/javascript" src="/javascripts/prototype.js"></script>
+  5. pass an option to the functions (:to is reserved key)
+    <%= include_for "application.js", :charset=>"UTF-8" %>
+    # generates
+    <script charset="UTF-8" type="text/javascript" src="/javascripts/application.js"></script>
+Advanced Usage
+==============
+And this plugin can also separate declaration and inclusion
+by using '<%' rather than '<%=' for declaration purpose.
+  * declaration for using some scripts
+    <% include_for "prototype.js" %>
+    # or in some your helpers
+    def auto_complete_zipcode(record, ...)
+      include_for "prototype.js"
+  * inclusion by using content_for mechanism
+    # in your layout file
+    <head>
+      <%= yield :header %>
+    </head>
+We'll get following code only in the case that we use "auto_complete_zipcode" method.
+    <head>
+      <script type="text/javascript" src="/javascripts/prototype.js"></script>
+    </head>
+And, We can avoid to force wasted javascripts when that method is not used.
+    <head>
+    </head>
+Of course, you can modify the grouping name in +to+ option. (default :header)
+    include_for "prototype.js"                  # stored to @content_for_header
+    include_for "powered-by.js", :to=>:footer   # stored to @content_for_footer
+    # in your layout file
+    <head>
+      <%= yield :header %>
+    </head>
+    <body>
+      <%= yield %>
+      <%= yield :footer %>
+    </body>
+Install
+=======
+git://github.com/maiha/include_for.git
+Author
+======
+Maiha <maiha@wota.jp>

data/Rakefile ADDED Viewed

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+desc 'Default: run unit tests.'
+task :default => :test
+desc 'Test the include_for plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+desc 'Generate documentation for the include_for plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IncludeFor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# Include hook code here
+ActionView::Base.class_eval do
+  include IncludeFor
+end

data/install.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ # Install hook code here

data/lib/include_for.rb ADDED Viewed

@@ -0,0 +1,33 @@
+# IncludeFor
+module IncludeFor
+  def include_for(*sources)
+    sources = sources.flatten
+    options = sources.last.is_a?(Hash) ? sources.pop.symbolize_keys : {}
+    group   = options.delete(:to) || :header
+    global_cache  = eval("@_include_for_#{options[:to]}_ ||= {}")
+    private_cache = {}
+    loadeds = sources.map do |source|
+      include_for_cache_or_find(group, source, options, global_cache, private_cache)
+    end
+    loadeds.compact
+  end
+  private
+    def include_for_source(source, options)
+      case source
+      when :defaults, /\.js$/ then javascript_include_tag(source, options)
+      when /\.css$/           then stylesheet_link_tag(source, options)
+      else source.to_s
+      end
+    end
+    def include_for_cache_or_find(group, source, options, global_cache, private_cache)
+      if private_cache[source]
+        nil
+      else
+        private_cache[source] ||= global_cache[source] ||=
+          returning(erb = include_for_source(source, options)) {content_for(group){erb}}
+      end
+    end
+end

data/spec/models/application.rb ADDED Viewed

@@ -0,0 +1,4 @@
+class Application
+end
+class ApplicationController
+end

data/spec/models/grouping.rb ADDED Viewed

@@ -0,0 +1,111 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+describe IncludeFor, 'ファイルはデフォルトで :header グループ' do
+  before(:each) do
+    @helper = Helper.new
+  end
+  it '1ファイルの指定' do
+    @helper.include_for('prototype.js')
+    @helper.instance_variable_get('@content_for_header').should ==
+      'javascript_include_tag:"prototype.js"'
+  end
+  it '複数のファイルを指定した場合' do
+    @helper.include_for('prototype.js', 'controls.js')
+    @helper.instance_variable_get('@content_for_header').should ==
+      ['javascript_include_tag:"prototype.js"',
+       'javascript_include_tag:"controls.js"'].join
+  end
+  it '複数のファイルを指定した場合(JSとCSS混在)' do
+    @helper.include_for('prototype.js', 'application.css', 'controls.js')
+    @helper.instance_variable_get('@content_for_header').should ==
+      ['javascript_include_tag:"prototype.js"',
+       'stylesheet_link_tag:"application.css"',
+       'javascript_include_tag:"controls.js"'].join
+  end
+  it '重複分は無視される' do
+    @helper.include_for('prototype.js', 'application.css', 'controls.js', 'application.css', 'prototype.js')
+    @helper.instance_variable_get('@content_for_header').should ==
+      ['javascript_include_tag:"prototype.js"',
+       'stylesheet_link_tag:"application.css"',
+       'javascript_include_tag:"controls.js"'].join
+  end
+end
+describe IncludeFor, ':header グループの明示' do
+  before(:each) do
+    @helper = Helper.new
+  end
+  it '1ファイルの指定' do
+    @helper.include_for('prototype.js', :to=>:header)
+    @helper.instance_variable_get('@content_for_header').should ==
+      'javascript_include_tag:"prototype.js"'
+  end
+  it '複数のファイルを指定した場合' do
+    @helper.include_for('prototype.js', 'controls.js', :to=>:header)
+    @helper.instance_variable_get('@content_for_header').should ==
+      ['javascript_include_tag:"prototype.js"',
+       'javascript_include_tag:"controls.js"'].join
+  end
+  it '複数のファイルを指定した場合(JSとCSS混在)' do
+    @helper.include_for('prototype.js', 'application.css', 'controls.js', :to=>:header)
+    @helper.instance_variable_get('@content_for_header').should ==
+      ['javascript_include_tag:"prototype.js"',
+       'stylesheet_link_tag:"application.css"',
+       'javascript_include_tag:"controls.js"'].join
+  end
+  it '重複分は無視される' do
+    @helper.include_for('prototype.js', 'application.css', 'controls.js', 'application.css', 'prototype.js', :to=>:header)
+    @helper.instance_variable_get('@content_for_header').should ==
+      ['javascript_include_tag:"prototype.js"',
+       'stylesheet_link_tag:"application.css"',
+       'javascript_include_tag:"controls.js"'].join
+  end
+end
+describe IncludeFor, '別のグループ名の場合' do
+  before(:each) do
+    @helper = Helper.new
+  end
+  it ':footerに追加しても同じ出力を得る' do
+    @helper.include_for('prototype.js', :to=>:footer).should ==
+      ['javascript_include_tag:"prototype.js"']
+  end
+  it ':footerに追加したものは:footerに入る' do
+    @helper.include_for('prototype.js', :to=>:footer)
+    @helper.instance_variable_get('@content_for_footer').should ==
+      ['javascript_include_tag:"prototype.js"'].join
+  end
+  it ':footerに追加したものは:headerには影響を与えない' do
+    @helper.include_for('prototype.js', :to=>:footer)
+    @helper.instance_variable_get('@content_for_header').should ==
+      nil
+  end
+  it ':headerと:footerにそれぞれ追加しても出力は独立している' do
+    @helper.include_for('prototype.js', :to=>:header)
+    @helper.include_for('controls.js', :to=>:footer)
+    @helper.include_for('application.css', :to=>:header)
+    @helper.include_for('defaults.css', :to=>:footer)
+    @helper.instance_variable_get('@content_for_header').should ==
+      ['javascript_include_tag:"prototype.js"',
+       'stylesheet_link_tag:"application.css"'].join
+    @helper.instance_variable_get('@content_for_footer').should ==
+      ['javascript_include_tag:"controls.js"',
+       'stylesheet_link_tag:"defaults.css"'].join
+  end
+end

data/spec/models/include_for.rb ADDED Viewed

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+describe IncludeFor, '直接JSファイル名を指定すると' do
+  before(:each) do
+    @helper = Helper.new
+  end
+  it 'javascript_include_tag の実行結果が配列で返る' do
+    @result = @helper.include_for('application.js')
+    @result.should ==
+      ['javascript_include_tag:"application.js"']
+  end
+  it '複数のファイルを指定できる' do
+    @result = @helper.include_for('prototype.js', 'controls.js')
+    @result.should ==
+      ['javascript_include_tag:"prototype.js"',
+       'javascript_include_tag:"controls.js"']
+  end
+  it '複数のファイルの順序も保存される' do
+    @result = @helper.include_for('controls.js', 'prototype.js')
+    @result.should ==
+      ['javascript_include_tag:"controls.js"',
+       'javascript_include_tag:"prototype.js"']
+  end
+  it '重複するファイルは最初の1つだけが有効になる' do
+    @result = @helper.include_for('controls.js', 'prototype.js',  'prototype.js')
+    @result.should ==
+      ['javascript_include_tag:"controls.js"',
+       'javascript_include_tag:"prototype.js"']
+  end
+  it '複数回に分割して実行すると最後だけが有効' do
+    @result = @helper.include_for('controls.js')
+    @result = @helper.include_for('prototype.js')
+    @result.should ==
+      ['javascript_include_tag:"prototype.js"']
+  end
+  it '複数回に分割して実行して最後が重複している場合でも返される' do
+    @result = @helper.include_for('prototype.js')
+    @result = @helper.include_for('controls.js')
+    @result = @helper.include_for('prototype.js')
+    @result.should ==
+      ['javascript_include_tag:"prototype.js"']
+  end
+end
+describe IncludeFor, '直接CSSファイル名を指定すると' do
+  before(:each) do
+    @helper = Helper.new
+  end
+  it 'stylesheet_link_tag の実行結果が配列で返る' do
+    @result = @helper.include_for('application.css')
+    @result.should ==
+      ['stylesheet_link_tag:"application.css"']
+  end
+  it '複数のファイルを指定できる' do
+    @result = @helper.include_for('prototype.css', 'controls.css')
+    @result.should ==
+      ['stylesheet_link_tag:"prototype.css"',
+       'stylesheet_link_tag:"controls.css"']
+  end
+  it '複数のファイルの順序も保存される' do
+    @result = @helper.include_for('controls.css', 'prototype.css')
+    @result.should ==
+      ['stylesheet_link_tag:"controls.css"',
+       'stylesheet_link_tag:"prototype.css"']
+  end
+  it '重複するファイルは最初の1つだけが有効になる' do
+    @result = @helper.include_for('controls.css', 'prototype.css',  'prototype.css')
+    @result.should ==
+      ['stylesheet_link_tag:"controls.css"',
+       'stylesheet_link_tag:"prototype.css"']
+  end
+end
+describe IncludeFor, '直接JSとCSSファイル名を指定すると' do
+  before(:each) do
+    @helper = Helper.new
+  end
+  it 'それぞれの結果が配列で返る' do
+    @result = @helper.include_for('prototype.js', 'application.css', 'controls.js', 'application.js')
+    @result.should ==
+      ['javascript_include_tag:"prototype.js"',
+       'stylesheet_link_tag:"application.css"',
+       'javascript_include_tag:"controls.js"',
+       'javascript_include_tag:"application.js"']
+  end
+end

data/spec/models/option.rb ADDED Viewed

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+describe IncludeFor, 'option付きのjs呼び出し' do
+  before(:each) do
+    @helper = Helper.new
+  end
+  it '1属性を指定' do
+    @result = @helper.include_for('application.js', :language=>"JavaScript")
+    @result.should == ['javascript_include_tag:"application.js",{:language=>"JavaScript"}']
+  end
+  it '2属性を指定' do
+    @result = @helper.include_for('application.js', :language=>"JavaScript", :charset=>"UTF-8")
+    @result.should == ['javascript_include_tag:"application.js",{:charset=>"UTF-8", :language=>"JavaScript"}']
+  end
+end
+describe IncludeFor, 'option付きのcss呼び出し' do
+  before(:each) do
+    @helper = Helper.new
+  end
+  it '1属性を指定' do
+    @result = @helper.include_for('application.css', :media=>"all")
+    @result.should == ['stylesheet_link_tag:"application.css",{:media=>"all"}']
+  end
+  it '2属性を指定' do
+    @result = @helper.include_for('application.css', :media=>"all", :charset=>"UTF-8")
+    @result.should == ['stylesheet_link_tag:"application.css",{:charset=>"UTF-8", :media=>"all"}']
+  end
+end

data/spec/models/special.rb ADDED Viewed

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+describe IncludeFor, '例外的な指定' do
+  before(:each) do
+    @helper = Helper.new
+  end
+  it ':defaults はシンボルとして受理される' do
+    @result = @helper.include_for(:defaults)
+    @result.should ==
+      ['javascript_include_tag::defaults']
+  end
+  it '末尾が js,css でない文字列はそのまま出力される' do
+    @result = @helper.include_for("alert('ok')")
+    @result.should ==
+      ["alert('ok')"]
+  end
+end

data/spec/schema.rb ADDED Viewed

@@ -0,0 +1,30 @@
+# This file is autogenerated. Instead of editing this file, please use the
+# migrations feature of ActiveRecord to incrementally modify your database, and
+# then regenerate this schema definition.
+ActiveRecord::Schema.define(:version => 2) do
+  create_table "cards", :force => true do |t|
+    t.column "type",       :string
+    t.column "no",         :integer
+    t.column "name",       :string
+    t.column "cost",       :integer
+    t.column "kind",       :string
+    t.column "hp",         :integer
+    t.column "power",      :integer
+    t.column "block",      :integer
+    t.column "counter",    :integer
+    t.column "capacity",   :integer
+    t.column "skill_name", :string
+    t.column "skill_cost", :integer
+    t.column "member",     :string
+    t.column "help",       :string
+  end
+  create_table "decks", :force => true do |t|
+    t.column "name", :string
+    t.column "kind", :string
+    t.column "word", :string
+  end
+end

data/spec/spec.opts ADDED Viewed

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,65 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+require 'rubygems'
+ENV["RAILS_ENV"] = "test"
+# require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
+gem 'activesupport'
+require 'active_support'
+gem 'actionpack'
+require 'action_controller'
+require 'action_view'
+gem 'rspec'
+# require 'autotest'
+# require 'autotest/redgreen'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/include_for")
+$: << File.expand_path(File.dirname(__FILE__) + "/models")
+class Helper
+  include IncludeFor
+  include ActionView::Helpers::CaptureHelper
+  def initialize
+    @counts = Hash.new(){0}
+  end
+  def count_for(type)
+    @counts[type]
+  end
+  ######################################################################
+  ### Mocks
+  def javascript_include_tag(*args)
+    @counts[:js] += 1
+    "javascript_include_tag:" + inspect_args(args)
+  end
+  def stylesheet_link_tag(*args)
+    @counts[:css] += 1
+    "stylesheet_link_tag:" + inspect_args(args)
+  end
+  private
+    def inspect_args(args)
+      options = args.last
+      if options.is_a?(Hash)
+        if options.blank?
+          # strip an empty hash argument
+          args.pop
+        else
+          # sort hash keys in inspect (dirty hack)
+          sorted = options.inspect.sub(/^\{/, '').sub(/\}$/, '').split(/, /).sort.join(', ')
+          return (args[0..-2].map(&:inspect) + ["{%s}" % sorted]).join(',')
+        end
+      end
+      args.map(&:inspect).join(',')
+    end
+end

data/tasks/include_for_tasks.rake ADDED Viewed

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :include_for do
+#   # Task goes here
+# end

data/test/include_for_test.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'test/unit'
+class IncludeForTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

data/uninstall.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ # Uninstall hook code here

metadata ADDED Viewed

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: maiha-include_for
+version: !ruby/object:Gem::Version
+  version: "0.1"
+platform: ruby
+authors:
+- maiha
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2008-06-05 00:00:00 -07:00
+default_executable:
+dependencies: []
+description: ""
+email: maiha@wota.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- Rakefile
+- init.rb
+- install.rb
+- lib/include_for.rb
+- spec/models/application.rb
+- spec/models/grouping.rb
+- spec/models/include_for.rb
+- spec/models/option.rb
+- spec/models/special.rb
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/include_for_tasks.rake
+- test/include_for_test.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/maiha/include_for
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.0.1
+signing_key:
+specification_version: 2
+summary: ""
+test_files: []