jim 0.1.0 → 0.1.1

data/README.rdoc

@@ -22,6 +22,18 @@ The goals are simple:
 
 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.
 
+== Install
+
+jim is a rubygem:
+
+  $ gem install jim
+
+You can also clone the source from github and use jeweler to install locally (requires jeweler):
+
+  $ git clone git://github.com/quirkey/jim.git
+  $ cd jim
+  $ rake install
+
 == Usage
 
 From anywhere, install a project:
@@ -43,8 +55,8 @@ Which create an empty "Jimfile". Open it up and add your requirements:
 
   jquery 1.4.2
   jquery-metadata 2.0
-  // a local file (comments are fine)
-  app.js
+  // a local file, js/app.js (comments are fine)
+  js/app
   
 If its a rack project, mount the Jim::Rack middleware which gives you live updates of your bundled and compressed js files:
 
@@ -58,6 +70,8 @@ Otherwise and also before deploys, etc, use the command line tool from your proj
   // or
   $ jim compress
 
+In order for compress to work, you need either the yui-compressor gem or the closure-compiler gem. Closure is the default, add
+
 Run `jim commands` for a full list of commands.
 
 == You're probably wondering
@@ -72,6 +86,10 @@ With that said, I would gladly welcome anyone cloning the API in CommonJS (I'm j
 
 Probably?? Its all very new at this point so please test it out and let me know.
 
+== Thanks
+
+Thanks to Yehuda Katz for talking through some of the ideas with me.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.
@@ -80,7 +98,7 @@ Probably?? Its all very new at this point so please test it out and let me know.
   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.
+* Send me a pull request. Bonus points for topic branches
 
 == Copyright
 

data/Rakefile

@@ -16,7 +16,10 @@ begin
     gem.homepage = "http://github.com/quirkey/jim"
     gem.authors = ["Aaron Quint"]
     gem.add_dependency "downlow", ">= 0.1.1"
+    gem.add_dependency "yajl-ruby"
     gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "fakeweb", ">= 1.2.8"
+    gem.add_development_dependency "mocha"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/jim.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jim}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   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.date = %q{2010-02-20}
   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}
@@ -70,14 +70,23 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<downlow>, [">= 0.1.1"])
+      s.add_runtime_dependency(%q<yajl-ruby>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 1.2.8"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
     else
       s.add_dependency(%q<downlow>, [">= 0.1.1"])
+      s.add_dependency(%q<yajl-ruby>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+      s.add_dependency(%q<mocha>, [">= 0"])
     end
   else
     s.add_dependency(%q<downlow>, [">= 0.1.1"])
+    s.add_dependency(%q<yajl-ruby>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+    s.add_dependency(%q<mocha>, [">= 0"])
   end
 end
 

data/lib/jim/bundler.rb

@@ -1,10 +1,29 @@
 module Jim
+  # Bundler takes parses a Jimfile that specifies requirements as names and 
+  # versions and then can bundle, compress, or copy those files into specific dirs
+  # or files.
+  #
+  # A Jimfile has a really simple format:
+  #
+  #     // comments look like JS comments
+  #     // you can set options by adding comments that look like JSON pairs
+  #     // bundle_path: /path/to/bundle.js
+  #
+  #     // A requirement is just a name and an optional version
+  #     // requirements are resolved and bundled in order of specification
+  #     jquery 1.4.2
+  #     jquery.color
+  #     sammy 0.5.0
+  #
+  # 
   class Bundler
     class MissingFile < Jim::Error; end
-    
+
     attr_accessor :jimfile, :index, :requirements, :paths, :options 
-   
-    def initialize(jimfile, index, options = {})
+    
+    # create a new bundler instance passing in the Jimfile as a `Pathname` or a
+    # string. `index` is a Jim::Index
+    def initialize(jimfile, index = nil, options = {})
       self.jimfile      = jimfile.is_a?(Pathname) ? jimfile.read : jimfile
       self.index        = index || Jim::Index.new
       self.options      = {}
@@ -14,7 +33,8 @@ module Jim
       self.add(options[:vendor_dir]) if options[:vendor_dir]
       self.paths        = []
     end
-    
+
+    # resove the requirements specified into Jimfile or raise a MissingFile error
     def resolve!
       self.requirements.each do |search|
         name, version = search.strip.split(/\s+/)
@@ -27,7 +47,9 @@ module Jim
       end
       paths
     end
-    
+
+    # concatenate all the requirements into a single file and write to `to` or to the
+    # path specified in the :bundled_path option
     def bundle!(to = nil)
       resolve! if paths.empty?
       to = options[:bundled_path] if to.nil? && options[:bundled_path]
@@ -38,7 +60,10 @@ module Jim
       end
       io
     end
-    
+
+    # concatenate all the requirements into a single file then run through a JS 
+    # then write to `to` or to the path specified in the :bundled_path option.
+    # You can also use the YUI compressor by setting the option :compressor to 'yui'
     def compress!(to = nil)
       to = options[:compressed_path] if to.nil? && options[:compressed_path]
       io = io_for_path(to)
@@ -46,7 +71,9 @@ module Jim
       io << js_compress(bundle!(false))
       io
     end
-    
+
+    # copy each of the requirements into the dir specified with `dir` or the path
+    # specified with the :vendor_dir option
     def vendor!(dir = nil)
       resolve! if paths.empty?
       dir ||= options[:vendor_dir]
@@ -56,7 +83,7 @@ module Jim
         Jim::Installer.new(path, dir, :shallow => true).install
       end
     end
-    
+
     private
     def io_for_path(to)
       case to
@@ -72,7 +99,7 @@ module Jim
         ""
       end
     end
-   
+
     def parse_jimfile
       jimfile.each_line do |line|
         if /^\/\/\s?([^\:]+)\:\s(.*)$/.match line
@@ -82,21 +109,29 @@ module Jim
         end
       end
     end
-    
+
     def js_compress(uncompressed)
       if options[:compressor] == 'yui'
-        require "yui/compressor"
+        begin
+          require "yui/compressor"
+        rescue LoadError
+          raise "You must install the yui compressor gem to use the compressor\ngem install yui-compressor"
+        end
         compressor = ::YUI::JavaScriptCompressor.new
       else 
-        require 'closure-compiler'
+        begin
+          require 'closure-compiler'
+        rescue LoadError
+          raise "You must install the closure compiler gem to use the compressor\ngem install closure-compiler"
+        end
         compressor = ::Closure::Compiler.new
       end
       compressor.compress(uncompressed)
     end
-    
+
     def logger
       Jim.logger
     end
-    
+
   end
 end

data/lib/jim/cli.rb

@@ -1,8 +1,15 @@
+require 'optparse'
+
 module Jim
+  
+  # CLI handles the command line interface for the `jim` binary. 
+  # The layout is farily simple. Options are parsed using optparse.rb and 
+  # the different public methods represent 1-1 the commands provided by the bin.
   class CLI
     
     attr_accessor :jimfile, :jimhome, :force
     
+    # create a new instance with the args passed from the command line i.e. ARGV
     def initialize(args)
       @output = ""
       # set the default jimhome
@@ -13,6 +20,7 @@ module Jim
       ## try to run based on args
     end
     
+    # method called by the bin directly after initialization. 
     def run
       command = @args.shift
       if command && respond_to?(command)
@@ -29,12 +37,14 @@ module Jim
       @output << e.message + " (#{e.class})"
     end
     
+    # list the possible commands to the logger
     def commands
       logger.info "Usage: jim [options] [command] [args]\n"
       logger.info "Commands:"
       logger.info template('commands')
     end
     
+    # list the possible commands without detailed descriptions
     def cheat
       logger.info "Usage: jim [options] [command] [args]\n"
       logger.info "Commands:"
@@ -42,6 +52,7 @@ module Jim
       logger.info "run commands for details"
     end
     
+    # initialize the current dir with a new Jimfile
     def init(dir = nil)
       dir = Pathname.new(dir || '')
       jimfile_path = dir + 'Jimfile'
@@ -55,34 +66,40 @@ module Jim
       end
     end
     
+    # install the file/project `url` into `jimhome`
     def install(url, name = false, version = false)
       Jim::Installer.new(url, jimhome, :force => force, :name => name, :version => version).install
     end
     
+    # bundle the files specified in Jimfile into `to`
     def bundle(to = nil)
       path = bundler.bundle!(to)
     end
     
+    # compress the files specified in Jimfile into `to`
     def compress(to = nil)
       path = bundler.compress!(to)
     end
     
+    # copy/vendor all the files specified in Jimfile to `dir`
+    def vendor(dir = nil)
+      bundler.vendor!(dir)
+    end
+    
+    # list the installed projects and versions
     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
     
+    # list the files and their resolved paths specified in the Jimfile
     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|
@@ -124,7 +141,7 @@ module Jim
     end
     
     def index
-      @index ||= Jim::Index.new(jimhome + 'lib')
+      @index ||= Jim::Index.new(jimhome + 'lib', Dir.pwd)
     end
     
     def bundler

data/lib/jim/index.rb

@@ -1,4 +1,5 @@
 module Jim
+  # Index managages a list of directories which are searched to find requirements
   class Index
     attr_reader :directories
     

data/lib/jim/rack.rb

@@ -1,6 +1,14 @@
 require 'jim'
 
 module Jim
+  # Jim::Rack is a Rack middleware for allowing live bundling and compression
+  # of the requirements in your Jimfile without having to rebundle using the command
+  # line. You can specify a number of options:
+  #
+  # :jimfile: Path to your Jimfile (default ./Jimfile)
+  # :jimhome: Path to your JIMHOME directory (default ENV['JIMHOME'] or ~/.jim)
+  # :bundled_uri: URI to serve the bundled requirements
+  # :compressed_uri: URI to serve the compressed requirements
   class Rack
    
     def initialize(app, options = {})

data/lib/jim.rb

@@ -2,8 +2,9 @@ require 'downlow'
 require 'logger'
 require 'yajl'
 
+
 module Jim
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   
   class Error < RuntimeError; end
   class FileExists < Error; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jim
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Aaron Quint
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-19 00:00:00 -05:00
+date: 2010-02-20 00:00:00 -05:00
 default_executable: jim
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.1.1
     version: 
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
   type: :development
@@ -32,6 +42,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: jim is your friendly javascript library manager. He downloads, stores, bundles, vendors and compresses.
 email: aaron@quirkey.com
 executables: