RubyGems - juicer-rails - Versions diffs - 0.1.0 - Mend

juicer-rails 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

data/.gitignore +21 -0
data/CHANGELOG.rdoc +4 -0
data/LICENSE +20 -0
data/README.rdoc +62 -0
data/Rakefile +2 -0
data/init.rb +1 -0
data/juicer-rails.gemspec +24 -0
data/lib/juicer-rails.rb +42 -0
data/lib/juicer-rails/collection.rb +110 -0
data/lib/juicer-rails/helper.rb +15 -0
data/lib/juicer-rails/railtie.rb +16 -0
data/lib/juicer-rails/version.rb +3 -0
data/test/helper.rb +10 -0
data/test/test_juicer-rails.rb +7 -0
metadata +101 -0

data/.gitignore ADDED

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

data/CHANGELOG.rdoc ADDED

@@ -0,0 +1,4 @@
+= CHANGELOG
+== 0.1.0 (26.01.2011)
+* initial release

data/LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michał Łomnicki
+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

@@ -0,0 +1,62 @@
+= juicer-rails
+Rails helper for Juicer - excellent asset packaging tool.
+https://github.com/cjohansen/juicer
+== Usage
+Create config/assets.yml file
+    js:
+      common:
+        - 'public/javascripts/jquery/jquery.js'
+        - 'public/javascripts/common.js'
+      myapp:
+        - 'public/javascripts/application.js'
+        - 'public/javascripts/dashboard.js'
+    css:
+      myapp:
+        - 'public/stylesheets/application.css'
+        - 'public/stylesheets/dialogs.css'
+juicer-rails provides 2 helper methods
+* merged_javascripts - includes merged javascript assets
+* merged_stylesheets - includes merged and cache-friendly stylesheet assets
+Include merged assets in your layout
+    <head>
+        ...
+        <%= merged_javascripts :common %>
+        <%= merged_javascripts :myapp %>
+        <%= merged_stylesheets :myapp %>
+    </head>
+Please note that assets will be compiled only in production environemnt unless
+<tt>always_compile</tt> options is set.
+== Configuration
+Create config/initializers/juicer-rails.rb
+    JuicerRails.setup do |config|
+        # config.always_compile = true
+        # add more options here
+    end
+Available options are:
+    * config_file - path of confiugration file. default: config/assets.yml
+    * config - configuration in YAML format. default: content of config_file
+    * environemnt - current environment name. default: Rails.env
+    * compile_environments - which environments triggers compiling assets. default: production
+    * always_compile - always compile assets, no matter the environemnt. default: false
+    * compiled_assets_directory - subdirectory of public directory where compiled assets are stored. default: assets
+== Copyright
+Copyright (c) 2010 Michał Łomnicki. See LICENSE for details.

data/Rakefile ADDED

	@@ -0,0 +1,2 @@
1	+ require 'bundler'
2	+ Bundler::GemHelper.install_tasks

data/init.rb ADDED

	@@ -0,0 +1 @@
1	+ require "juicer-rails"

data/juicer-rails.gemspec ADDED

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "juicer-rails/version"
+Gem::Specification.new do |s|
+  s.name        = "juicer-rails"
+  s.version     = JuicerRails::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michał Łomnicki"]
+  s.email       = ["michal.lomnicki@gmail.com"]
+  s.homepage    = "https://github.com/mlomnicki/juicer-rails"
+  s.summary     = "Rails helpers for Juicer"
+  s.description = "Juicer-rails adds helpers for easy embedding juicer-packaged assets"
+  s.rubyforge_project = "juicer-rails"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency("juicer", "~> 1.0")
+  s.add_dependency("actionpack", ">= 2.1")
+end

data/lib/juicer-rails.rb ADDED

@@ -0,0 +1,42 @@
+require 'juicer-rails/version'
+require 'juicer-rails/helper'
+require 'juicer-rails/railtie' if defined?(Rails::Railtie)
+module JuicerRails
+  # location of configuration files
+  mattr_accessor :config_file
+  # Rails 3 set this with Railtie. Rails.root is nil at this stage
+  # Rails 2 has Rails.root defined so we can use it
+  @@config_file = Rails.root.join('config/assets.yml') if Rails.root
+  mattr_accessor :config
+  @@config = YAML.load_file(config_file) if config_file
+  # Current environment
+  mattr_accessor :environment
+  @@environment = Rails.env
+  # Which environments triggers assets compilations
+  mattr_accessor :compile_environments
+  @@compile_environments = %w[production]
+  # Always compile assets
+  mattr_accessor :always_compile
+  @@always_compile = false
+  # relative path from RAILS_ROOT/public where compiled assets are stored
+  mattr_accessor :compiled_assets_directory
+  @@compiled_assets_directory = 'assets'
+  def self.perform_compilation?
+    always_compile || compile_environments.include?(environment)
+  end
+  def self.setup
+    yield self
+  end
+end
+ActionView::Base.send(:include, Juicer::Helper)

data/lib/juicer-rails/collection.rb ADDED

@@ -0,0 +1,110 @@
+require 'juicer'
+require 'fileutils'
+class Juicer::Collection
+  class << self
+    extend ActiveSupport::Memoizable
+    def dispatch(key, type)
+      if JuicerRails.perform_compilation?
+        compile(key, type)
+      else
+        embed_standalone(key, type)
+      end
+    end
+    def compile(key, type)
+      self.new(key, type).compile
+      destination_compiled_path(key, type).to_s
+    end
+    memoize :compile
+    # Embeds each asset as standalone file.
+    # The best mode for development purposes. No merging occurs
+    def embed_standalone(key, type)
+      dir = case type.to_s
+            when 'js' then 'javascripts'
+            when 'css' then 'stylesheets'
+            end
+      new(key, type).paths.collect { |p| Rails.root.join(p).relative_path_from(public_path.join(dir)).to_s }
+    end
+    def compiled_directory
+      public_path.join(JuicerRails.compiled_assets_directory)
+    end
+    def compiled_path(key, type)
+      compiled_directory.join("#{key}.#{type}")
+    end
+    def relative_compiled_path(key, type)
+      compiled_path(key, type).relative_path_from(public_path)
+    end
+    def destination_compiled_path(key, type)
+      "/#{relative_compiled_path(key, type)}"
+    end
+    def public_path
+      @public_path ||= Rails.root.join('public')
+    end
+  end
+  attr_reader :paths
+  def initialize(key, type, options = {})
+    @type = type
+    @key = key
+    @paths = JuicerRails.config[type.to_s][key.to_s]
+    @destination_dir = self.class.compiled_directory
+    @destination_path = self.class.compiled_path(key, type)
+    ensure_destination_directory_exists
+  end
+  # Produces production ready assets.
+  # Merges, appends timestamps for images, embeds images into stylesheets
+  # and tries to do everything what juicer can.
+  # TODO: only merging and cache buster are implemented at the moment
+  def compile
+    merge
+    bust_cache
+  end
+  # Depending on type merges and saves compiled asset
+  def merge
+    if @type == 'js'
+      merger = merge_javascripts
+    elsif @type == 'css'
+      merger = merge_stylesheets
+    end
+    save(merger)
+    self
+  end
+  def merge_javascripts
+    Juicer::Merger::JavaScriptMerger.new(@paths)
+  end
+  def merge_stylesheets
+    Juicer::Merger::StylesheetMerger.new(@paths, :document_root => Rails.root.join('public/stylesheets'))
+  end
+  def save(compiler)
+    compiler.save(@destination_path.to_s)
+    self
+  end
+  def bust_cache
+    Juicer::CssCacheBuster.new.save(@destination_path.to_s)
+    self
+  end
+  def ensure_destination_directory_exists
+    unless @destination_dir.exist?
+      FileUtils.mkdir_p(@destination_dir.to_s)
+    end
+  end
+end

data/lib/juicer-rails/helper.rb ADDED

@@ -0,0 +1,15 @@
+require 'juicer-rails/collection'
+module Juicer::Helper
+  def merged_javascripts(key)
+    javascript_include_tag(Juicer::Collection.dispatch(key, 'js'))
+  end
+  def merged_stylesheets(key)
+    stylesheet_link_tag(Juicer::Collection.dispatch(key, 'css'))
+  end
+end
+ActionView::Base.send(:include, Juicer::Helper)

data/lib/juicer-rails/railtie.rb ADDED

@@ -0,0 +1,16 @@
+require 'yaml'
+module JuicerRails
+  class Railtie < Rails::Railtie
+    initializer "juicer_rails.init" do
+      ::JuicerRails.setup do |juicer|
+        juicer.config_file ||= Rails.root.join('config/assets.yml')
+        juicer.config ||= YAML.load_file(juicer.config_file)
+      end
+    end
+  end
+end

data/lib/juicer-rails/version.rb ADDED

@@ -0,0 +1,3 @@
+module JuicerRails
+  VERSION = "0.1.0"
+end

data/test/helper.rb ADDED

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'juicer-rails'
+class Test::Unit::TestCase
+end

data/test/test_juicer-rails.rb ADDED

@@ -0,0 +1,7 @@
+require 'helper'
+class TestJuicerRails < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata ADDED

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: juicer-rails
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors:
+- "Micha\xC5\x82 \xC5\x81omnicki"
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-01-27 00:00:00 +01:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: juicer
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 2
+        - 1
+        version: "2.1"
+  type: :runtime
+  version_requirements: *id002
+description: Juicer-rails adds helpers for easy embedding juicer-packaged assets
+email:
+- michal.lomnicki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- init.rb
+- juicer-rails.gemspec
+- lib/juicer-rails.rb
+- lib/juicer-rails/collection.rb
+- lib/juicer-rails/helper.rb
+- lib/juicer-rails/railtie.rb
+- lib/juicer-rails/version.rb
+- test/helper.rb
+- test/test_juicer-rails.rb
+has_rdoc: true
+homepage: https://github.com/mlomnicki/juicer-rails
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project: juicer-rails
+rubygems_version: 1.3.6
+signing_key:
+specification_version: 3
+summary: Rails helpers for Juicer
+test_files: []