jsdm 0.3.2 → 0.4.0

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2009, 2010 Border Stylo
+Copyright (c) 2010 Min Huang
+
+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.md

@@ -0,0 +1,73 @@
+Description
+===========
+
+JSDM is a JavaScript dependency management library written in Ruby - that is
+all.  It does not do anything special; in fact, it could be used to manage
+dependencies for any language as you can change what JSDM considers a
+comment or a require statement.  JSDM will also...
+
+* Perform topological sort to report circular dependencies to you.
+* Allow you to have globs in your require statements.
+* Allow you to specify load paths.
+
+Installation
+============
+To install from source:
+
+    rake clobber
+    rake package
+    gem install pkg/jsdm-*.gem
+
+To install from rubygems.org:
+
+    gem install jsdm
+
+Usage
+=====
+In your Javascript files, put #require directives in comments at the top of
+your file (note that they must be the non-whitespace characters in your file
+for JSDM to process them correctly):
+
+    // #require jquery.js
+    // #require MyLibrary1.js
+    // #require MyLibrary2.js
+    // #require other/*.js
+    // #require thing/**/*.js
+
+Next you will need to tell JSDM which directories contain your Javascript
+files (this is your load path).
+
+    jsdm = JSDM.new :load_path => %w(path_1 path_2 path_3)
+
+Here is an example for using JSDM to concatenate all your sources into one
+big JavaScript file:
+
+    require 'jsdm'
+
+    jsdm = JSDM.new :load_path => %w(path_1 path_2 path_3 path_4)
+    File.open('result.js', 'w') do |out|
+      jsdm.sources.each do |f|
+        out.puts "// Filename: #{f}"
+        out.puts File.read(f)
+      end
+    end
+
+Here is an example that finds all the dependencies for file foo.js so it
+can generate the script tags for that file:
+
+    require 'jsdm'
+
+    Dir.chdir '/path/to/local/js/files' do
+      jsdm = JSDM.new :load_path => '.'
+      jsdm.dependencies_for('foo.js') do |f|
+        puts "<script src='/path/to/server/js/files/#{f}' />"
+      end
+    end
+
+License
+=======
+The following is retained from BorderStylo's licensing terms:
+
+JSDM version 0.2.20 and above is licensed under the MIT license.
+
+No license is granted for versions previous to 0.2.20.

data/Rakefile

@@ -1,42 +1,41 @@
 require 'fileutils'
 require 'rake'
+require 'rake/clean'
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
 
 spec = Gem::Specification.new do |s|
-  s.platform     = Gem::Platform::RUBY
-  s.name         = "jsdm"
-  s.author       = "Min Huang"
-  s.email        = "min.huang@alumni.usc.edu"
-  s.files        = Dir["lib/**/*"] + %w(Rakefile)
-  s.require_path = "lib"
-  s.has_rdoc     = true
-  s.homepage     = "http://www.borderstylo.com/#{s.name}"
-  s.version      = "0.3.2"
-  s.summary      = "Javascript dependency manager"
-  s.description  = "Use #require statements to declare dependencies"
+  s.platform          = Gem::Platform::RUBY
+  s.name              = 'jsdm'
+  s.author            = 'Min Huang'
+  s.email             = 'min.huang@alumni.usc.edu'
+  s.files             = Dir["{lib,doc,bin,ext}/**/*"].delete_if { |f|
+                          /\/rdoc(\/|$)/i.match f
+                        } + %w(Rakefile LICENSE README.md)
+  s.require_path      = 'lib'
+  s.has_rdoc          = true
+  s.homepage          = "http://www.borderstylo.com/#{s.name}"
+  s.version           = '0.4.0'
+  s.summary           = 'Javascript dependency manager'
+  s.description       = 'Use #require statements to declare dependencies'
+  s.rubyforge_project = 'jsdm'
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.need_tar_bz2 = true
 end
 
-desc "Clean the build"
-task :clean do
-  FileUtils.rm_rf "pkg", :verbose => true
-end
-
-desc "Run tests (no arg), or single test (with arg)"
+desc 'Run tests (no arg), or single test (with arg)'
 task :test, :name do |t, args|
-  opts = args.name.nil? ? "" : "-n test_#{args.name}"
+  opts = args.name.nil? ? '' : "-n test_#{args.name}"
   cmd = "ruby test/run_tests.rb #{opts}"
   puts cmd
-  system(cmd) || raise("Build error")
+  system(cmd) || raise('Build error')
 end
 
-task :install => [:test, :package] do
+task :install => :package do
   g = "pkg/#{spec.name}-#{spec.version}.gem"
   system "sudo gem install -l #{g}"
 end
 
-task :default => :test
+task :default => :package

data/lib/jsdm.rb

@@ -4,32 +4,40 @@ require 'jsdm/errors'
 require 'jsdm/preprocessor'
 
 class JSDM
-  attr_accessor :load_path,
+  attr_accessor :options,
                 :sources,
                 :requires,
                 :preprocessor,
                 :manager,
-                :resolver,
-                :ext
+                :resolver
 
-  def initialize(load_path = [], options = {})
-    self.load_path    = load_path
+  def initialize(opts = {})
+    defaults = {
+      :randomize       => true,
+      :load_path       => '.',
+      :extension       => 'js',
+      :comment_pattern => Preprocessor.comment_pattern,
+      :require_pattern => Preprocessor.require_pattern
+    }
+    self.options      = defaults.merge opts
     self.sources      = []
     self.preprocessor = nil
     self.manager      = nil
     self.resolver     = nil
-    self.ext          = options[:ext].nil? ? 'js' : options[:ext]
-    process!
+    unless options[:load_path].is_a?(Array)
+      options[:load_path] = [options[:load_path]]
+    end
+    process
   end
 
-  def process!
-    self.sources      = load_path.map { |path| Dir["#{path}/**/*.#{ext}"] }.
-                                  flatten.
-                                  sort
-    self.sources      = sources.sort { rand }
-    self.preprocessor = Preprocessor.new       sources
+  def process
+    self.sources      = options[:load_path].map { |path|
+                          Dir[File.join(path, '**', "*.#{options[:extension]}")]
+                        }.flatten
+    self.sources      = sources.sort { rand } if options[:randomize]
+    self.preprocessor = Preprocessor.new       sources, options
     self.manager      = DependencyManager.new  sources
-    self.resolver     = DependencyResolver.new load_path
+    self.resolver     = DependencyResolver.new options[:load_path]
     self.requires     = preprocessor.process
     begin
       source = nil
@@ -47,21 +55,19 @@ class JSDM
     sources
   end
 
-  def sources_for(source)
-    ds = manager.dependencies_of(source)
-    ds.push(source)
-    ds
+  def dependencies
+    manager.dependencies
   end
 
-  def requires_for(source)
-    requires.select { |r| r.first == source }.first.last
+  def dependencies_for(source)
+    manager.dependencies_for(source)
   end
 
-  def dependencies
-    manager.dependencies
+  def sources_for(source)
+    dependencies_for(source) << source
   end
 
-  def self.same_file?(a, b)
-    File.expand_path(a) == File.expand_path(b)
+  def requires_for(source)
+    requires.select { |r| r.first == source }.first.last
   end
 end

data/lib/jsdm/dependency_manager.rb

@@ -15,17 +15,17 @@ class JSDM
     end
 
     def add_dependency(source, dependency)
-      unless JSDM.same_file? dependency, source
+      unless same_file? dependency, source
         dependencies << [dependency, source]
       end
     end
 
-    def dependencies_of(source, acc = [])
+    def dependencies_for(source, acc = [])
        ds = dependencies.select { |d| d.last == source }.
                          map { |d| d.first }
        return acc if ds.empty?
        acc = acc | ds
-       ds.each { |d| acc = acc | dependencies_of(d, acc) }
+       ds.each { |d| acc = acc | dependencies_for(d, acc) }
        acc
     end
 
@@ -38,5 +38,11 @@ class JSDM
       raise CircularDependencyError.new(loops) unless loops.empty?
       result[:sorted]
     end
+
+    private
+
+    def same_file?(a, b)
+      File.expand_path(a) == File.expand_path(b)
+    end
   end
 end

data/lib/jsdm/dependency_resolver.rb

@@ -9,15 +9,14 @@ class JSDM
     end
 
     def process(entries)
-      entries = entries.map { |entry| process_single entry }
-      entries = entries.flatten
-      entries
+      entries.map { |entry| process_single entry }.
+              flatten
     end
 
     def process_single(entry)
-      resolved = load_path.map { |path| Dir["#{path}/#{entry.strip}"] }
-      resolved = resolved.drop_while { |sources| sources.empty? }
-      resolved = resolved.first
+      resolved = load_path.map { |path| Dir[File.join(path, entry.strip)] }.
+                           drop_while { |sources| sources.empty? }.
+                           first
       raise FileNotFoundError.new(entry) if resolved.nil? || resolved.empty?
       resolved
     end

data/lib/jsdm/preprocessor.rb

@@ -1,19 +1,22 @@
 class JSDM
   class Preprocessor
-    attr_accessor :sources, :comment_pattern, :require_pattern
+    attr_accessor :sources, :options
 
-    def initialize(sources)
+    def initialize(sources, options = {})
+      defaults = {
+        :comment_pattern => Preprocessor.comment_pattern,
+        :require_pattern => Preprocessor.require_pattern
+      }
       self.sources = sources
-      self.comment_pattern = /^\s*\/\/\s*/
-      self.require_pattern = /#{comment_pattern}#\s*require\s*/
+      self.options = defaults.merge options
     end
 
     def process_single(source)
       File.open(source).
            each_line.
-           take_while { |line| line =~ comment_pattern }.
-           select { |line| line =~ require_pattern }.
-           map { |line| line.sub!(require_pattern, "").split(",") }.
+           take_while { |line| line =~ options[:comment_pattern] }.
+           select { |line| line =~ options[:require_pattern] }.
+           map { |line| line.sub!(options[:require_pattern], '').split(',') }.
            flatten.
            map { |entry| entry.strip }
     end
@@ -21,5 +24,13 @@ class JSDM
     def process
       sources.map { |source| [source, process_single(source)] }
     end
+
+    class << self
+      attr_accessor :comment_pattern, :require_pattern
+      private :comment_pattern=, :require_pattern=
+    end
+
+    self.comment_pattern = /^\s*\/\/\s*/
+    self.require_pattern = /#{self.comment_pattern}#\s*require\s*/
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Min Huang
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-30 00:00:00 -07:00
+date: 2010-05-31 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,8 @@ files:
 - lib/jsdm/natural_loops.rb
 - lib/jsdm/dependency_resolver.rb
 - Rakefile
+- LICENSE
+- README.md
 has_rdoc: true
 homepage: http://www.borderstylo.com/jsdm
 licenses: []
@@ -61,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: jsdm
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3