RubyGems - require_assets - Versions diffs - 0.1.0 - Mend

require_assets 0.1.0

Files changed (12) hide show

data/.document ADDED Viewed

@@ -0,0 +1,6 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE
+rails/*

data/.gitignore ADDED Viewed

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+## TEXTMATE
+*.tmproj
+tmtags
+## EMACS
+*~
+\#*
+.\#*
+## VIM
+*.swp
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+## PROJECT::SPECIFIC
+doc
+.yardoc

data/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+Copyright (c) 2008 Ezra Zygmuntowicz
+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.rdoc ADDED Viewed

@@ -0,0 +1,54 @@
+= require_assets
+Ruby on Rails helpers to add asset links to views. Extracted from merb-assets Merb plugin.
+== Quick overview of the API
+* {RequireAssets::Helpers#require_js require_js} is smart(-er) way to do includes just once per page no matter how many times partial use it.
+* {RequireAssets::Helpers#require_css require_css} is like require_js but for CSS.
+* {RequireAssets::Helpers#include_required_js include_required_js} generates script tags for previously included files.
+* {RequireAssets::Helpers#include_required_css include_required_css} generates link tags for previously included files.
+== Examples
+{RequireAssets::Helpers#require_js require_js} and {RequireAssets::Helpers#require_css require_css},  {RequireAssets::Helpers#include_required_js include_required_js} and {RequireAssets::Helpers#include_required_css include_required_css} require assets just once:
+In your application layout:
+  include_required_js
+In your controller layout:
+  require_js 'posts'
+The require_js method can be used to require any JavaScript file anywhere in your templates. Regardless of how many times a single script is included with require_js, it will only be included once in the header.
+  # File: app/views/layouts/application.html.erb
+  <html>
+    <head>
+      <%= include_required_js %>
+      <%= include_required_css %>
+    </head>
+    <body>
+     <%= yield %>
+    </body>
+  </html>
+  # File: app/views/whatever/index.html.erb
+  <% require_js  'this' -%>
+  <% require_css 'that', 'another_one' -%>
+   # Will generate the following in the final page...
+   <html>
+     <head>
+       <script src="/javascripts/this.js" type="text/javascript"></script>
+       <link href="/stylesheets/that.css" media="screen" rel="stylesheet" type="text/css"/>
+       <link href="/stylesheets/another_one.css" media="screen" rel="stylesheet" type="text/css"/>
+     </head>
+     .
+     .
+     .
+   </html>

data/Rakefile ADDED Viewed

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "require_assets"
+    gem.summary = 'Ruby on Rails helpers to add asset links to views.'
+    gem.description = 'Ruby on Rails helpers to add asset links to views. Extracted from merb-assets Merb plugin.'
+    gem.email = "jeremy.burks@gmail.com"
+    gem.homepage = "http://github.com/jrun/require_assets"
+    gem.authors = ["Jeremy Burks"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.files += FileList['rails/*']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+task :spec => :check_dependencies
+task :default => :spec
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION ADDED Viewed

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

data/lib/require_assets.rb ADDED Viewed

@@ -0,0 +1,98 @@
+module RequireAssets
+  module Helpers
+    # The require_js method can be used to require any JavaScript file anywhere in
+    # your templates. Regardless of how many times a single script is included
+    # with require_js, Rails will only include it once in the header.
+    #
+    # @param [#to_s] JavaScript files to include
+    #
+    # @example
+    #   <% require_js('jquery') %>
+    #   # A subsequent call to include_required_js will render...
+    #   # => <script src="/javascripts/jquery.js" type="text/javascript"></script>
+    #
+    # @example
+    #   <% require_js('jquery', 'effects', 'validation') %>
+    #
+    #   # A subsequent call to include_required_js will render...
+    #   # => <script src="/javascripts/jquery.js" type="text/javascript"></script>
+    #   #    <script src="/javascripts/effects.js" type="text/javascript"></script>
+    #   #    <script src="/javascripts/validation.js" type="text/javascript"></script>
+    #
+    def require_js(*js)
+      @required_js ||= []
+      @required_js |= js
+    end
+    # The require_css method can be used to require any CSS file anywhere in
+    # your templates. Regardless of how many times a single stylesheet is
+    # included with require_css, Rails will only include it once in the header.
+    #
+    # @param [#to_s] CSS files to include
+    #
+    # @example
+    #   <% require_css('style') %>
+    #   # A subsequent call to include_required_css will render...
+    #   # => <link href="/stylesheets/style.css" media="screen" rel="Stylesheet" type="text/css"/>
+    #
+    # @example
+    #   <% require_css('style', 'ie-specific') %>
+    #   # A subsequent call to include_required_css will render...
+    #   # => <link href="/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css"/>
+    #   #    <link href="/stylesheets/ie-specific.css" media="screen" rel="stylesheet" type="text/css"/>
+    #
+    def require_css(*css)
+      @required_css ||= []
+      @required_css |= css
+    end
+    # A method used in the layout of an application to create +<script>+ tags
+    # to include JavaScripts required in in templates and subtemplates using
+    # require_js.
+    #
+    # @return [String] The JavaScript tag
+    #
+    # @example
+    #   # my_action.html.erb has a call to require_js 'jquery'
+    #   # File: layout/application.html.erb
+    #   include_required_js
+    #   # => <script src="/javascripts/jquery.js" type="text/javascript"></script>
+    #
+    # @example
+    #   # my_action.html.erb has a call to require_js 'jquery', 'effects', 'validation'
+    #   # File: layout/application.html.erb
+    #   include_required_js
+    #   # => <script src="/javascripts/jquery.js" type="text/javascript"></script>
+    #   #    <script src="/javascripts/effects.js" type="text/javascript"></script>
+    #   #    <script src="/javascripts/validation.js" type="text/javascript"></script>
+    #
+    def include_required_js
+      return '' if @required_js.nil?
+      javascript_include_tag(*@required_js)
+    end
+    # A method used in the layout of an application to create +<link>+ tags for
+    # CSS stylesheets required in in templates and subtemplates using
+    # require_css.
+    #
+    # @return [String] The CSS tag
+    #
+    # @example
+    #   # my_action.html.erb has a call to require_css 'style'
+    #   # File: layout/application.html.erb
+    #   include_required_css
+    #   # => <link href="/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css"/>
+    #
+    # @example
+    #   # my_action.html.erb has a call to require_js 'style', 'ie-specific'
+    #   # File: layout/application.html.erb
+    #   include_required_css
+    #   # => <link href="/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css"/>
+    #        <link href="/stylesheets/ie-specific.css" media="screen" rel="stylesheet" type="text/css"/>
+    #
+    def include_required_css
+      return '' if @required_css.nil?
+      stylesheet_link_tag(*@required_css)
+    end
+  end
+end

data/rails/init.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require 'require_assets'
+ActionView::Base.class_eval do
+  include ::RequireAssets::Helpers
+end

data/spec/require_assets_spec.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+describe "RequireAssets" do
+end

data/spec/spec.opts ADDED Viewed

	@@ -0,0 +1 @@
1	+ --color

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'require_assets'
+require 'spec'
+require 'spec/autorun'
+Spec::Runner.configure do |config|
+end

metadata ADDED Viewed

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: require_assets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Burks
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-11-22 00:00:00 -06:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  type: :development
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.9
+    version:
+- !ruby/object:Gem::Dependency
+  name: yard
+  type: :development
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+description: Ruby on Rails helpers to add asset links to views. Extracted from merb-assets Merb plugin.
+email: jeremy.burks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/require_assets.rb
+- rails/init.rb
+- spec/require_assets_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jrun/require_assets
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+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.3.5
+signing_key:
+specification_version: 3
+summary: Ruby on Rails helpers to add asset links to views.
+test_files:
+- spec/require_assets_spec.rb
+- spec/spec_helper.rb