jammit-core 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Jeremy Ashkenas, DocumentCloud
+
+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

@@ -0,0 +1,24 @@
+==
+       _  _   __  __ __  __ ___ _____ 
+    _ | |/_\ |  \/  |  \/  |_ _|_   _|
+   | || / _ \| |\/| | |\/| || |  | |  
+    \__/_/ \_\_|  |_|_|  |_|___| |_|
+    
+    
+  Jammit is an industrial strength asset packaging library for Rails,
+  providing both the CSS and JavaScript concatenation and compression
+  that you'd expect, as well as ahead-of-time gzipping, built-in JavaScript
+  template support, and optional Data-URI / MHTML image embedding.
+  
+  Installation:
+  gem install jammit
+  
+  For documentation, usage, and examples, see:
+  http://documentcloud.github.com/jammit/
+  
+  To suggest a feature or report a bug:
+  http://github.com/documentcloud/jammit/issues/
+  
+  For internal source docs, see:
+  http://documentcloud.github.com/jammit/doc/
+  

data/README.rdoc

@@ -0,0 +1,17 @@
+= jammit-core
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Christocracy. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jammit-core"
+    gem.summary = %Q{A non-Rails fork of the Jammit asset-packager}
+    gem.description = %Q{A non-Rails fork of the Jammit asset-packager for use with any Ruby framework}
+    gem.email = "christocracy@gmail.com"
+    gem.homepage = "http://github.com/christocracy/jammit-core"
+    gem.authors = ["Christocracy"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.files =  FileList["[A-Z]*", "{bin,generators,lib,test,js}/**/*", 'lib/jeweler/templates/.gitignore']
+    gem.add_dependency "yui-compressor"
+    gem.add_dependency "closure-compiler"
+    gem.add_dependency "extlib"
+    gem.add_dependency "json"
+    
+    # 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: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jammit-core #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/bin/jammit

@@ -0,0 +1,13 @@
+#!/usr/local/bin/ruby
+
+# Check if an older version of extjs-mvc is installed
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'jammit-core'
+require 'jammit-core/cli'
+
+begin
+  Jammit::CLI.start
+rescue Jammit::Error => e
+  Jammit.ui.error(e.message)
+  exit e.status_code
+end

data/lib/assets.example.yml

@@ -0,0 +1,14 @@
+output_folder:          public
+base_url:               base_url
+package_assets:         on          # (on, off, always)
+embed_assets:           on          # (on, off, datauri)
+compress_assets:        false
+gzip_assets:            false
+package_path:           packages    # (defaults to assets)
+javascript_compressor:  closure     # (yui, closure)
+compressor_options:
+  compilation_level: ADVANCED_OPTIMIZATIONS
+
+javascripts:
+    
+stylesheets:

data/lib/jammit-core.rb

@@ -0,0 +1,219 @@
+$LOAD_PATH.push File.expand_path(File.dirname(__FILE__))
+
+# @Jammit@ is the central namespace for all Jammit classes, and provides access
+# to all of the configuration options.
+module Jammit
+
+  VERSION               = "0.4.3"
+
+  ROOT                  = File.expand_path(File.dirname(__FILE__))
+
+  ASSET_ROOT            = File.expand_path(".") unless defined?(ASSET_ROOT)
+
+  PUBLIC_ROOT           = File.join(ASSET_ROOT, 'public')
+
+  DEFAULT_CONFIG_PATH   = File.join(ASSET_ROOT, 'config')
+  
+  DEFAULT_CONFIG_FILENAME = 'assets.yml'
+  
+  DEFAULT_PACKAGE_PATH  = "assets"
+
+  DEFAULT_JST_SCRIPT    = File.join(ROOT, 'lib/jammit/jst.js')
+
+  DEFAULT_JST_COMPILER  = "template"
+
+  DEFAULT_JST_NAMESPACE = "window.JST"
+
+  AVAILABLE_COMPRESSORS = [:yui, :closure]
+
+  DEFAULT_COMPRESSOR    = :yui
+  
+  SUFFIX                = 'all'
+  DEBUG_SUFFIX          = 'all-debug'
+  
+  autoload :UI,         'jammit-core/ui'
+  autoload :Config,     'jammit-core/config'
+  
+  class Error < StandardError
+    def self.status_code(code = nil)
+      return @code unless code
+      @code = code
+    end
+
+    def status_code
+      self.class.status_code
+    end
+  end
+  
+  # Jammit raises @AppNotFound when trying to run outside of an application
+  class AppNotFound   < Error; status_code(1) ; end
+  
+  # Jammit raises a @PackageNotFound@ exception when a non-existent package is
+  # requested by a browser -- rendering a 404.
+  class PackageNotFound < Error; status_code(2) ; end
+
+  # Jammit raises a ConfigurationNotFound exception when you try to load the
+  # configuration of an assets.yml file that doesn't exist.
+  class ConfigurationNotFound < Error; status_code(3) ; end
+  
+  # Jammit raises AlreadyConfigred if trying to over-write an existing configuration file
+  class AlreadyConfigured < Error; status_code(4) ; end
+  
+  # Jammit raises an OutputNotWritable exception if the output directory for
+  # cached packages is locked.
+  class OutputNotWritable < Error; status_code(4) ; end
+
+  class << self
+    attr_reader :configuration
+    attr_writer :ui
+    attr_writer :options
+    
+    
+    def configure
+      @configured ||= begin
+        ##
+        # perform some config here?
+        #
+        #configure_gem_home_and_path
+        true
+      end
+    end
+    
+    ##
+    # Ensure we're running within a rails app unless generating a new app ($ xmvc generate app foo)
+    #
+    def ensure_in_app
+      unless ARGV.empty? || ARGV.first == 'help' || (File.exists?('app') && File.exists?('config') && File.exists?('config/environment.json'))
+        raise Jammit::AppNotFound.new("This command must be executed from the root of an extjs-mvc application")
+      end
+    end
+
+    def ui
+      @ui ||= UI.new
+    end
+    
+    def options
+      @options
+    end
+    
+    def asset_root
+      unless @asset_root      
+        if (options && options[:asset_root])
+          @asset_root = options[:asset_root]
+        else
+          @asset_root = ASSET_ROOT
+        end
+      end
+      
+      #@asset_root ||= (options && options[:asset_root]) ? options[:asset_root] : ASSET_ROOT   
+      @asset_root
+    end
+    
+    def public_root
+      @public_root ||= File.join(asset_root, 'public')
+    end
+    
+    def config_path
+      @config_path ||= File.join(asset_root, 'config', DEFAULT_CONFIG_FILENAME)
+    end
+    
+    def package_path
+      @package_path ||= (@options && @options[:package_path]) ? @options[:package_path] : config[:package_path]
+    end
+    
+    # Load the complete asset configuration from the specified @config_path@.
+
+    def config
+      unless @config
+        # Normalize config
+        @config = Jammit::Config.load.to_mash
+                      
+        @config[:output_folder]         = (@config[:output_folder]) ? File.join(asset_root, @config[:output_folder]) : public_root
+        @config[:package_path]          = @config[:package_path] || Jammit::DEFAULT_PACKAGE_PATH
+        @config[:embed_assets]          = @config[:embed_assets] || @config[:embed_images]
+        @config[:compress_assets]       = !(@config[:compress_assets] == false)
+        @config[:gzip_assets]           = !(@config[:gzip_assets] == false)  
+        @config[:mhtml_enabled]         = @config[:embed_assets] && @config[:embed_assets] != "datauri"
+        @config[:compressor_options]    = (@config[:compressor_options] || {}).to_mash
+        @config[:css_compressor_options]  = (@config[:css_compressor_options] || {}).to_mash
+        @config[:javascript_compressor] = get_javascript_compressor(@config[:javascript_compressor].to_sym)
+        @config[:package_assets]        = get_package_assets(@config[:package_assets])
+        @config[:template_function]     = get_template_function(@config[:template_function])
+        @config[:include_jst_script]    = @config[:template_function] == Jammit::DEFAULT_JST_COMPILER
+        @config[:template_namespace]    = get_template_namespace(@config[:template_namespace])
+        @config[:suffix]                = SUFFIX unless @config[:suffix]
+        @config[:debug_suffix]          = DEBUG_SUFFIX unless @config[:debug_suffix]
+      end
+      @config
+    end
+
+    def config=(config)
+      @config = config
+    end
+    
+    # The YUI Compressor requires Java > 1.4, and Closure requires Java > 1.6.
+    def check_java_version
+      java = @config[:compressor_options][:java] || 'java'
+      @config[:css_compressor_options][:java] ||= java if @config[:compressor_options][:java]
+      version = (`#{java} -version 2>&1`)[/\d+\.\d+/]
+      disable_compression if !version ||
+        (@config[:javascript_compressor] == :closure && version < '1.6') ||
+        (@config[:javascript_compressor] == :yui && version < '1.4')
+    end
+    
+    # If we don't have a working Java VM, then disable asset compression and
+    # complain loudly.
+    def disable_compression
+      @config[:compress_assets] = false
+      Jammit.ui.warn("Asset compression disabled -- Java unavailable.")
+    end
+    
+    # Turn asset packaging on or off, depending on configuration and environment.
+    def get_package_assets(value)
+      package_env = !defined?(Rails) || !Rails.env.development?
+      (value == true || value.nil?) ? package_env : (value == 'always') ? true : false
+    end
+    
+    # Assign the JST template function, unless explicitly turned off.
+    def get_template_function(value)
+      (value == true || value.nil?) ? DEFAULT_JST_COMPILER : value == false ? '' : value
+    end
+      
+    # Ensure that the JavaScript compressor is a valid choice.
+    def get_javascript_compressor(value)
+      Jammit::AVAILABLE_COMPRESSORS.include?(value) ? value : Jammit::DEFAULT_COMPRESSOR
+    end
+
+    # Set the root JS object in which to stash all compiled JST.
+    def get_template_namespace(value)
+      (value == true || value.nil?) ? Jammit::DEFAULT_JST_NAMESPACE : value.to_s
+    end
+    
+    # Force a reload by resetting the Packager and reloading the configuration.
+    # In development, this will be called as a before_filter before every request.
+    def reload!
+      Thread.current[:jammit_packager] = nil
+      @config = Config.load(config[:config_path], true)
+    end
+
+    # Keep a global (thread-local) reference to a @Jammit::Packager@, to avoid
+    # recomputing asset lists unnecessarily.
+    def packager    
+      Thread.current[:jammit_packager] ||= Packager.new
+    end
+
+    # Generate the base filename for a version of a given package.
+    def filename(package, extension, suffix=nil)
+      suffix_part  = suffix ? "-#{suffix}" : ''
+      "#{package}#{suffix_part}.#{extension}"
+    end
+
+    # Generates the server-absolute URL to an asset package.
+    def asset_url(package, extension, suffix=nil, mtime=nil)
+      timestamp = mtime ? "?#{mtime.to_i}" : ''
+      "/#{package_path}/#{filename(package, extension, suffix)}#{timestamp}"
+    end
+  end
+end
+
+require 'jammit-core/dependencies'

data/lib/jammit-core/cli.rb

@@ -0,0 +1,87 @@
+require 'thor'
+require 'yaml'
+
+module Jammit
+  class CLI < Thor
+    ARGV = ::ARGV.dup
+
+    desc "init", "Initialize a project for jammit-core"
+    def init
+      Jammit::Config.dispatch(:create)
+    end
+    
+    desc "config", "Manage Jammit configuration file.  Use jammit config show, jammit config set <name> <value>"
+    def config(cmd, *params)
+      Jammit::Config.dispatch(cmd.to_sym, *params)
+    end
+    
+    desc "build", "Compile assets"
+    def build(package = :all, *params)
+      package = package.to_s    
+      case package
+      when "all"
+        Jammit.packager.force = true #Jammit.configuration[:force]
+        Jammit.packager.precache_all(Jammit.config[:output_folder], Jammit.config[:base_url])
+      else
+        Jammit.packager.force = true
+        Jammit.packager.precache(package, Jammit.config[:output_folder], Jammit.config[:base_url])
+      end
+    end
+    
+    def initialize(args=ARGV, options={}, config={})
+              
+      Jammit.ui = UI::Shell.new(shell)
+      super
+
+      #@options = {
+      #  :config_path    => Jammit::DEFAULT_CONFIG_PATH,
+      #  :output_folder  => nil,
+      #  :base_url       => nil,
+      #  :force          => false
+      #}
+      
+      if options.kind_of? Hash
+        Jammit.options = options
+      end
+      
+      #Jammit.packager.force = @options[:force]
+      #Jammit.packager.precache_all(@options[:output_folder], @options[:base_url])
+      
+    end
+    
+    private
+
+    # Uses @OptionParser@ to grab the options: *--output*, *--config*, and
+    # *--base-url*...
+    def parse_options
+      #@options = {
+      #  :config_path    => Jammit::DEFAULT_CONFIG_PATH,
+      #  :output_folder  => nil,
+      #  :base_url       => nil,
+      #  :force          => false
+      #}
+      
+      #@option_parser = OptionParser.new do |opts|
+      #  opts.on('-o', '--output PATH', 'output folder for packages (default: "public/assets")') do |output_folder|
+      #    @options[:output_folder] = output_folder
+      #  end
+      #  opts.on('-c', '--config PATH', 'path to assets.yml (default: "config/assets.yml")') do |config_path|
+      #    @options[:config_path] = config_path
+      ##  end
+      #  opts.on('-u', '--base-url URL', 'base URL for MHTML (ex: "http://example.com")') do |base_url|
+      #    @options[:base_url] = base_url
+      #  end
+      #  opts.on('-f', '--force', 'force a rebuild of all assets') do |force|
+      #    @options[:force] = force
+      #  end
+      #  opts.on_tail('-v', '--version', 'display Jammit version') do
+      #    puts "Jammit version #{Jammit::VERSION}"
+      #    exit
+      #  end
+      #end
+      #@option_parser.banner = BANNER
+      #@option_parser.parse!(ARGV)
+    end
+    
+  end
+end