jim 0.1.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Aaron Quint
+
+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

@@ -0,0 +1,87 @@
+= jim
+
+jim is your friendly javascript library manager. 
+He downloads, stores, bundles, vendors and compresses.
+
+== What is a jim?
+
+I'm frustrated with a lot of copy and pasting JS files from one directory to another and downloading new versions to who knows where and only really being able to use sprockets in Rails and lots of other small annoying things about the existing JS package/asset managers. 
+
+Jim uses a lot of stolen ideas from a lot of great projects. Namely:
+
+* version management and flexible project fetching from rip
+* asset compression from jammit and sprockets
+* Gemfile and bundle from bundler
+
+The goals are simple:
+
+* Install a file, archive, git repo, etc from a local path or a URL into a common directory stored with a specific name and version number. Because should be able to install anything from anywhere, theres no need for a central package host.
+* Specify the local and installed files required for a project by name and version number in a single place. Dependencies for each project are not managed by the system, the onus is on you to specify them in the order you want them. _The project does not have to be in Ruby or even have a backend system._
+* Run a command to bundle all the required files into a single file.
+* Run a command to bundle the files _and_ run them through a JavaScript compressor.
+
+So far I've accomplished the goals, but this is all very very very beta and the API is sure to change and thing straight-up might not work.
+
+== Usage
+
+From anywhere, install a project:
+
+  // From a URL
+  $ jim install http://code.jquery.com/jquery-1.4.2.js
+  // From a zip (with name and version)
+  $ jim install http://github.com/jquery/jquery-metadata/zipball/master jquery-metadata 2.0
+
+In your project run:
+
+  $ jim init
+
+Which create an empty "Jimfile". Open it up and add your requirements:
+
+  // bundled_path: public/javascripts/bundled.js
+  // compressed_path: public/javascripts/compressed.js
+  // vendor_dir: public/javascripts/vendor
+
+  jquery 1.4.2
+  jquery-metadata 2.0
+  // a local file (comments are fine)
+  app.js
+  
+If its a rack project, mount the Jim::Rack middleware which gives you live updates of your bundled and compressed js files:
+
+  use Jim::Rack, :bundled_uri => '/javascripts/bundled-live.js', 
+                 :compressed_uri => '/javascripts/compressed-live.js'
+  
+
+Otherwise and also before deploys, etc, use the command line tool from your project's dir:
+
+  $ jim bundle 
+  // or
+  $ jim compress
+
+Run `jim commands` for a full list of commands.
+
+== You're probably wondering
+
+==== Why not implement it in JavaScript itself?
+
+CommonJS has certainly come a long way in a year, but in general the file system support and variety of libraries just isnt completely there yet for this type of project (IMHO). Also, I love Ruby and writing this was actually fun and pretty fast. 
+
+With that said, I would gladly welcome anyone cloning the API in CommonJS (I'm just being lazy about it)
+
+==== Does it work with __ library or __ development platform?
+
+Probably?? Its all very new at this point so please test it out and let me know.
+
+== 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 Aaron Quint. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'jim'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jim"
+    gem.version = Jim::VERSION
+    gem.summary = %Q{jim is your friendly javascript library manager}
+    gem.description = %Q{jim is your friendly javascript library manager. He downloads, stores, bundles, vendors and compresses.}
+    gem.email = "aaron@quirkey.com"
+    gem.homepage = "http://github.com/quirkey/jim"
+    gem.authors = ["Aaron Quint"]
+    gem.add_dependency "downlow", ">= 0.1.1"
+    gem.add_development_dependency "shoulda", ">= 0"
+    # 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 = "jim #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/jim

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'jim'
+
+cli = Jim::CLI.new(ARGV)
+puts cli.run

data/jim.gemspec

@@ -0,0 +1,83 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jim}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Quint"]
+  s.date = %q{2010-02-19}
+  s.default_executable = %q{jim}
+  s.description = %q{jim is your friendly javascript library manager. He downloads, stores, bundles, vendors and compresses.}
+  s.email = %q{aaron@quirkey.com}
+  s.executables = ["jim"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "bin/jim",
+     "jim.gemspec",
+     "lib/jim.rb",
+     "lib/jim/bundler.rb",
+     "lib/jim/cli.rb",
+     "lib/jim/index.rb",
+     "lib/jim/installer.rb",
+     "lib/jim/rack.rb",
+     "lib/jim/templates/commands",
+     "lib/jim/templates/jimfile",
+     "lib/jim/version_parser.rb",
+     "test/fixtures/infoincomments.js",
+     "test/fixtures/jimfile",
+     "test/fixtures/jquery-1.4.1.js",
+     "test/fixtures/jquery.color.js",
+     "test/fixtures/jquery.metadata-2.0.zip",
+     "test/fixtures/mustache.js/mustache.js",
+     "test/fixtures/mustache.js/package.json",
+     "test/fixtures/noversion.js",
+     "test/helper.rb",
+     "test/test_jim_bundler.rb",
+     "test/test_jim_cli.rb",
+     "test/test_jim_index.rb",
+     "test/test_jim_installer.rb",
+     "test/test_jim_version_parser.rb"
+  ]
+  s.homepage = %q{http://github.com/quirkey/jim}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{jim is your friendly javascript library manager}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_jim_bundler.rb",
+     "test/test_jim_cli.rb",
+     "test/test_jim_index.rb",
+     "test/test_jim_installer.rb",
+     "test/test_jim_version_parser.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<downlow>, [">= 0.1.1"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<downlow>, [">= 0.1.1"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<downlow>, [">= 0.1.1"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/lib/jim.rb

@@ -0,0 +1,31 @@
+require 'downlow'
+require 'logger'
+require 'yajl'
+
+module Jim
+  VERSION = '0.1.0'
+  
+  class Error < RuntimeError; end
+  class FileExists < Error; end
+  
+  def self.logger=(logger)
+    @logger = logger
+  end
+  
+  def self.logger
+    @logger ||= LOGGER if defined?(LOGGER)
+    if !@logger
+      @logger           = Logger.new(STDOUT)
+      @logger.level     = Logger::INFO
+      @logger.formatter = Proc.new {|s, t, n, msg| "#{msg}\n"}
+      @logger
+    end
+    @logger
+  end
+  
+  autoload :Installer, 'jim/installer'
+  autoload :Index, 'jim/index'
+  autoload :Bundler, 'jim/bundler'
+  autoload :VersionParser, 'jim/version_parser'
+  autoload :CLI, 'jim/cli'
+end

data/lib/jim/bundler.rb

@@ -0,0 +1,102 @@
+module Jim
+  class Bundler
+    class MissingFile < Jim::Error; end
+    
+    attr_accessor :jimfile, :index, :requirements, :paths, :options 
+   
+    def initialize(jimfile, index, options = {})
+      self.jimfile      = jimfile.is_a?(Pathname) ? jimfile.read : jimfile
+      self.index        = index || Jim::Index.new
+      self.options      = {}
+      self.requirements = []
+      parse_jimfile
+      self.options.merge(options)
+      self.add(options[:vendor_dir]) if options[:vendor_dir]
+      self.paths        = []
+    end
+    
+    def resolve!
+      self.requirements.each do |search|
+        name, version = search.strip.split(/\s+/)
+        path = self.index.find(name, version)
+        if !path
+          raise(MissingFile, 
+          "Could not find #{name} #{version} in any of these paths #{index.directories.join(':')}")
+        end
+        self.paths << path
+      end
+      paths
+    end
+    
+    def bundle!(to = nil)
+      resolve! if paths.empty?
+      to = options[:bundled_path] if to.nil? && options[:bundled_path]
+      io = io_for_path(to)
+      logger.info "bundling to #{to}" if to
+      paths.each do |path|
+        io << path.read << "\n"
+      end
+      io
+    end
+    
+    def compress!(to = nil)
+      to = options[:compressed_path] if to.nil? && options[:compressed_path]
+      io = io_for_path(to)
+      logger.info "compressing to #{to}"
+      io << js_compress(bundle!(false))
+      io
+    end
+    
+    def vendor!(dir = nil)
+      resolve! if paths.empty?
+      dir ||= options[:vendor_dir]
+      dir ||= 'vendor' # default
+      logger.info "vendoring to #{dir}"
+      paths.each do |path|
+        Jim::Installer.new(path, dir, :shallow => true).install
+      end
+    end
+    
+    private
+    def io_for_path(to)
+      case to
+      when IO
+        to
+      when Pathname
+        to.dirname.mkpath
+        to.open('w')
+      when String
+        to = Pathname.new(to)
+        io_for_path(to)
+      else
+        ""
+      end
+    end
+   
+    def parse_jimfile
+      jimfile.each_line do |line|
+        if /^\/\/\s?([^\:]+)\:\s(.*)$/.match line
+          self.options[$1.to_sym] = $2.strip
+        elsif line !~ /^\// && line.strip != ''
+          self.requirements << line
+        end
+      end
+    end
+    
+    def js_compress(uncompressed)
+      if options[:compressor] == 'yui'
+        require "yui/compressor"
+        compressor = ::YUI::JavaScriptCompressor.new
+      else 
+        require 'closure-compiler'
+        compressor = ::Closure::Compiler.new
+      end
+      compressor.compress(uncompressed)
+    end
+    
+    def logger
+      Jim.logger
+    end
+    
+  end
+end

data/lib/jim/cli.rb

@@ -0,0 +1,143 @@
+module Jim
+  class CLI
+    
+    attr_accessor :jimfile, :jimhome, :force
+    
+    def initialize(args)
+      @output = ""
+      # set the default jimhome
+      self.jimhome = Pathname.new(ENV['JIMHOME'] || '~/.jim').expand_path
+      # parse the options
+      self.jimfile = Pathname.new('Jimfile')
+      @args = parse_options(args)
+      ## try to run based on args
+    end
+    
+    def run
+      command = @args.shift
+      if command && respond_to?(command)
+        self.send(command, *@args)
+      elsif command.nil? || command.strip == ''
+        cheat
+      else 
+        @output << "No action found for #{command}. Run -h for help."
+      end
+      @output
+    rescue Jim::FileExists => e
+      @output << "#{e.message} already exists, bailing. Use --force if you're sure"
+    rescue => e
+      @output << e.message + " (#{e.class})"
+    end
+    
+    def commands
+      logger.info "Usage: jim [options] [command] [args]\n"
+      logger.info "Commands:"
+      logger.info template('commands')
+    end
+    
+    def cheat
+      logger.info "Usage: jim [options] [command] [args]\n"
+      logger.info "Commands:"
+      logger.info template('commands').find_all {|l| l.match(/^\w/) }.join("")
+      logger.info "run commands for details"
+    end
+    
+    def init(dir = nil)
+      dir = Pathname.new(dir || '')
+      jimfile_path = dir + 'Jimfile'
+      if jimfile_path.readable? && !force
+        raise Jim::FileExists(jimfile_path)
+      else
+        File.open(jimfile_path, 'w') do |f|
+          f << template('Jimfile')
+        end
+        logger.info "wrote Jimfile to #{jimfile_path}"
+      end
+    end
+    
+    def install(url, name = false, version = false)
+      Jim::Installer.new(url, jimhome, :force => force, :name => name, :version => version).install
+    end
+    
+    def bundle(to = nil)
+      path = bundler.bundle!(to)
+    end
+    
+    def compress(to = nil)
+      path = bundler.compress!(to)
+    end
+    
+    def list
+      logger.info "Getting list of installed files in #{index.directories.join(':')}"
+      list = index.list
+      logger.info "Installed:\n#{list.collect {|i| "#{i[0]} (#{i[1].join(', ')})"}.join("\n")}"
+    end
+    
+    def resolve
+      resolved = bundler.resolve!
+      logger.info "Files:\n#{resolved.join("\n")}"
+      resolved
+    end
+    
+    def vendor(dir = nil)
+      bundler.vendor!(dir)
+    end
+    
+    private
+    def parse_options(runtime_args)
+      OptionParser.new("", 24, '  ') do |opts|
+        opts.banner = "Usage: jim [options] [command] [args]"
+
+        opts.separator ""
+        opts.separator "jim options:"
+        
+        opts.on("--jimhome path/to/home", "set the install path/JIMHOME dir (default ~/.jim)") {|h| 
+          self.jimhome = Pathname.new(h)
+        }
+
+        opts.on("-j", "--jimfile path/to/jimfile", "load specific Jimfile at path (default ./Jimfile)") { |j|
+          self.jimfile = Pathname.new(j)
+        }
+        
+        opts.on("-f", "--force", "force file creation/overwrite") {|f|
+          self.force = true
+        }
+        
+        opts.on("-d", "--debug", "set log level to debug") {|d|
+          logger.level = Logger::DEBUG
+        }
+        
+        opts.on("-v", "--version", "print version") {|d|
+          puts "jim #{Jim::VERSION}"
+          exit
+        }
+        
+        opts.on_tail("-h", "--help", "Show this message. Run jim commands for list of commands.") do
+          puts opts.help
+          exit
+        end
+
+      end.parse! runtime_args
+    rescue OptionParser::MissingArgument => e
+      logger.warn "#{e}, run -h for options"
+      exit
+    end
+    
+    def index
+      @index ||= Jim::Index.new(jimhome + 'lib')
+    end
+    
+    def bundler
+      @bundler ||= Jim::Bundler.new(jimfile, index)
+    end
+    
+    def template(path)
+      (Pathname.new(__FILE__).dirname + 'templates' + path).read
+    end
+    
+    def logger
+      Jim.logger
+    end
+    
+  end
+end