jsrequire 0.0.5

data/.document

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

data/.gitignore

@@ -0,0 +1,26 @@
+*.bundle
+*.o
+*.orig
+*.rb~
+*.so
+*.swp
+*.tmproj
+*~
+.DS_Store
+.idea
+.loadpath
+.project
+/data
+/index
+config/database.yml
+coverage
+index/*
+log/*.log
+log/*.pid
+log/mongrel.pid
+Makefile
+mkmf.log
+out
+pkg/*
+tmp
+tmp.pot~

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 aekym
+
+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,50 @@
+= jsrequire
+
+A small lib to add a require functionality to JavaScript files. On top of a file add something like:
+
+/* require foo/bar */
+
+This includes the file foo/bar.js into the file. Dependencies are resolved in right order of require statments over all files.
+
+## controller
+
+# resolve js dependencies
+
+path_to_js = "/absolute/path/to/javascripts"
+
+jsrequire = JsRequire.new
+dependencies = jsrequire.resolve_dependencies(File.join(path_to_js, "foo.js"))
+
+
+# rewrite js paths for web usage
+
+@javascripts = JsRequire::web_path_helper(dependencies[:javascripts],
+  path_to_js => "/public/javascripts"
+})
+
+@stylesheets = dependencies[:stylesheets]
+
+
+## haml view
+
+- for css in @stylesheets
+  %link{:rel => "stylesheet", :href => css, :type => "text/css"}
+
+- for js in @javascripts
+  %script{:type => "text/javascript", :src => js}
+
+
+== 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 aekym. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jsrequire"
+    gem.summary = %Q{Organizes requirements of assets in JavaScript files}
+    gem.description = %Q{Organizes requirements of assets in JavaScript files, resolved dependencies of js files and helps include depending css files.}
+    gem.email = "me@aekym.com"
+    gem.homepage = "http://github.com/aekym/jsrequire"
+    gem.authors = ["aekym"]
+  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 = "jsrequire #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/jsrequire.gemspec

@@ -0,0 +1,66 @@
+# 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{jsrequire}
+  s.version = "0.0.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["aekym"]
+  s.date = %q{2010-02-05}
+  s.description = %q{Organizes requirements of assets in JavaScript files, resolved dependencies of js files and helps include depending css files.}
+  s.email = %q{me@aekym.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "jsrequire.gemspec",
+     "lib/jsrequire.rb",
+     "test/fixtures/different-place/b.js",
+     "test/fixtures/javascripts/a.js",
+     "test/fixtures/javascripts/c.js",
+     "test/fixtures/javascripts/file.with.dot.js",
+     "test/fixtures/javascripts/namespace/a.js",
+     "test/fixtures/javascripts/namespace/json_reader.js",
+     "test/fixtures/javascripts/namespace/norequire.js",
+     "test/fixtures/javascripts/norequire.js",
+     "test/fixtures/javascripts/norequire.with.dot.in.name.js",
+     "test/fixtures/javascripts/require_filename_with_dot.js",
+     "test/fixtures/javascripts/require_filename_with_js.js",
+     "test/fixtures/javascripts/require_namespaced_file.js",
+     "test/fixtures/javascripts/require_non_existing_file.js",
+     "test/fixtures/javascripts/requirecss.js",
+     "test/fixtures/stylesheets/style.css",
+     "test/helper.rb",
+     "test/test_jsrequire.rb"
+  ]
+  s.homepage = %q{http://github.com/aekym/jsrequire}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Organizes requirements of assets in JavaScript files}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_jsrequire.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
+    else
+    end
+  else
+  end
+end
+

data/lib/jsrequire.rb

@@ -0,0 +1,177 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+class JsRequire
+
+  class FileNotFoundInLoadpath < ArgumentError; end
+
+
+  def initialize(loadpaths = nil)
+    @extract_loadpaths = []
+
+    loadpaths = [loadpaths] unless loadpaths.is_a?(Array)
+    @additional_loadpaths = JsRequire::normalize_filepaths(loadpaths.compact)
+  end
+
+
+  # resolve dependencies of js input files
+  #
+  # returns a hash with js and css dependencies
+  #
+  # js files are returned with absolute filepaths,
+  # css files not. css files are returned as given
+  # by the parsed require statement.
+  #
+  # e.g.
+  #
+  # {
+  #   :javascripts => ["/foo/bar.js"],
+  #   :stylesheets => ["style.css"]
+  # }
+  #
+  def resolve_dependencies(files)
+    @stylesheets = Hash.new { |h,k| h[k] = [] }
+    @extract_loadpaths = extract_loadpaths(files)
+
+    js = extract_dependencies_recursive(JsRequire::normalize_filepaths(files))
+
+    {
+      :javascripts => js,
+      :stylesheets => @stylesheets.map { |k,v| v }.flatten.uniq.sort
+    }
+  end
+
+
+  # convert absolute filepaths to relatives by
+  # cutting the absolute path to the webroot
+  #
+  # returns the webroot relative filepaths
+  #
+  # web_path_helper(["/foo/bar.js"], {"/foo" => "/javascripts"})
+  #   => ["/javascripts/bar.js"]
+  #
+  # @param webroots: array of strings to remove the prefix path
+  #                  or a hash to replace with defined string
+  #
+  def self.web_path_helper(files, webroots)
+    webroots = [webroots] unless webroots.is_a?(Enumerable)
+
+    files.map do |f|
+      rel_file = nil
+      webroots.each do |wr, replacement|
+        wr = normalize_filepath(wr)
+        rel_file = f.sub(/^#{Regexp.escape wr}/, replacement || '')
+        break if rel_file != f
+      end
+      rel_file || f
+    end
+  end
+
+
+  # builds namespaces from script files by pathnames
+  # when the <namespace_prefix> is found in path.
+  #
+  # e.g.
+  #
+  # namespace_helper(["/foo/bar/quux/file1.js", "/foo/bar/baz/file2.js"], "bar")
+  #   => ["bar.baz", "bar.quux"]
+  #
+  # Interessting for ExtJs#namespace
+  #
+  def self.namespace_helper(files, namespace_prefix)
+    files.inject([]) do |arr,js|
+      if js =~ /\/(#{namespace_prefix}\/.+)$/
+        file = File.dirname($1).gsub("/", ".")
+        arr << file
+      end
+      arr
+    end.sort.uniq
+  end
+
+
+
+  protected
+
+
+  def self.normalize_filepath(file)
+    File.expand_path(file)
+  end
+
+
+  def self.normalize_filepaths(files)
+    files.map { |f| normalize_filepath(f) }
+  end
+
+
+  def extract_loadpaths(files)
+    JsRequire::normalize_filepaths(files.map { |f| File.dirname(f) }.uniq)
+  end
+
+
+
+  def is_file?(filename)
+    File.file?(filename) && File.readable?(filename) && filename =~ /^\//
+  end
+
+
+  def find_file(filename)
+    return filename if is_file?(filename)
+
+    loadpaths = @extract_loadpaths + @additional_loadpaths
+    loadpaths.each do |path|
+      file = File.expand_path(filename, path)
+      return file if is_file?(file)
+    end
+
+    # fallback for namespaced files
+    if filename =~ /\./
+      loadpaths.each do |path|
+        ext = File.extname(filename)
+        file = File.expand_path(filename.gsub(/#{ext}$/, '').gsub('.', '/') + ext, path)
+        return file if is_file?(file)
+      end
+    end
+
+    raise FileNotFoundInLoadpath, "File '#{filename}' not found in loadpaths '#{loadpaths.join("', '")}'."
+  end
+
+
+  def extract_dependencies(filename)
+    is_require = true
+    js = []
+
+    File.open(filename, "r") do |f|
+      begin
+        case line = f.gets
+        when /^\s*\/\*\s*require\s*(\S+)\s*\*\/\s*$/
+          js << "#{$1}.js"
+        when /^\s*\/\*\s*css\s*(\S+)\s*\*\/\s*$/
+          @stylesheets[filename] << $1 + ".css"
+        else
+          is_require = false
+        end
+
+      end while is_require
+    end
+
+    js.uniq.map { |f| find_file(f) }
+  end
+
+
+  def extract_dependencies_recursive(files, included_files = [])
+    js = []
+    files.each do |f|
+      file = find_file(f)
+
+      unless included_files.include?(file)
+        js += extract_dependencies_recursive(extract_dependencies(file), js + [file] + included_files)
+        js << file
+      end
+    end
+
+    js
+  end
+
+
+end
+

data/test/fixtures/different-place/b.js

@@ -0,0 +1,2 @@
+/* require norequire */
+

data/test/fixtures/javascripts/a.js

@@ -0,0 +1,2 @@
+/* require b */
+

data/test/fixtures/javascripts/c.js

@@ -0,0 +1,3 @@
+/* require a */
+/* require b */
+

data/test/fixtures/javascripts/require_filename_with_dot.js

@@ -0,0 +1 @@
+/* require file.with.dot */

data/test/fixtures/javascripts/require_filename_with_js.js

@@ -0,0 +1 @@
+/* require namespace.json_reader */

data/test/fixtures/javascripts/require_namespaced_file.js

@@ -0,0 +1,3 @@
+/* require namespace.a */
+
+

data/test/fixtures/javascripts/require_non_existing_file.js

@@ -0,0 +1,2 @@
+/* require afileyouwillneverfind */
+

data/test/fixtures/javascripts/requirecss.js

@@ -0,0 +1,2 @@
+/* css style */
+

data/test/helper.rb

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

data/test/test_jsrequire.rb

@@ -0,0 +1,155 @@
+require File.dirname(__FILE__) + '/helper.rb'
+
+class TestJsRequire < Test::Unit::TestCase
+
+  def setup
+    @fixtures_dir = File.join(File.dirname(__FILE__), "fixtures")
+  end
+
+
+  def assert_requires(file, javascripts, stylesheets = [])
+    @jsrequire = JsRequire.new
+    data = @jsrequire.resolve_dependencies(File.join(@fixtures_dir + "/javascripts", file))
+
+    expect = [file, javascripts].flatten.map { |js| File.expand_path(js, @fixtures_dir + "/javascripts") }.sort
+    assert_equal expect, data[:javascripts].sort
+    assert_equal stylesheets, data[:stylesheets]
+  end
+
+  context "#resolve_dependencies" do
+
+    should "return the basic hash with empty results" do
+      @jsrequire = JsRequire.new
+      data = @jsrequire.resolve_dependencies([])
+
+      assert !data.include?(:bernd)
+
+      assert data.include?(:javascripts)
+      assert data.include?(:stylesheets)
+    end
+
+    should "require nothing" do
+      assert_requires("norequire.js", [])
+    end
+
+    should "require recursive dependencies" do
+      file = File.join(@fixtures_dir, "javascripts/a.js")
+
+      @jsrequire = JsRequire.new File.join(@fixtures_dir, "different-place")
+      data = @jsrequire.resolve_dependencies(file)
+
+      expect = ["javascripts/norequire.js", "different-place/b.js", "javascripts/a.js"].map { |js| File.expand_path(js, @fixtures_dir) }
+      assert_equal expect, data[:javascripts]
+    end
+
+    should "require recursive dependencies in right order" do
+      files = ["different-place/b.js", "javascripts/c.js"].map { |f| File.join(@fixtures_dir, f) }
+
+      @jsrequire = JsRequire.new File.join(@fixtures_dir, "different-place")
+      data = @jsrequire.resolve_dependencies(files)
+
+      expect = ["javascripts/norequire.js", "different-place/b.js", "javascripts/a.js", "javascripts/c.js"].map { |js| File.expand_path(js, @fixtures_dir) }
+      assert_equal expect, data[:javascripts]
+    end
+
+    should "require one css file" do
+      assert_requires("requirecss.js", [], ["style.css"])
+    end
+
+    should "resolve dependencies from loadpath with source file from different place" do
+      loadpath = File.join(@fixtures_dir, "javascripts")
+      @jsrequire = JsRequire.new(loadpath)
+
+      source_file = File.join(@fixtures_dir, "different-place/b.js")
+      dep = @jsrequire.resolve_dependencies(source_file)
+
+      files = ["javascripts/norequire.js", "different-place/b.js"].map { |f| File.expand_path(f, @fixtures_dir) }
+      assert_equal files, dep[:javascripts]
+    end
+
+    should "not be able to resolve dependent files because of missing loadpath" do
+      @jsrequire = JsRequire.new
+      source_file = File.join(@fixtures_dir, "different-place/b.js")
+      required_file_found = true
+
+      begin
+        dep = @jsrequire.resolve_dependencies(source_file)
+      rescue JsRequire::FileNotFoundInLoadpath
+        required_file_found = false
+      end
+
+      assert !required_file_found, "load of required files should fail"
+    end
+
+    should "throw an exception when requiring a non existing file" do
+      assert_raises JsRequire::FileNotFoundInLoadpath do
+        assert_requires("require_non_existing_file.js", [])
+      end
+    end
+
+    should "be able to require a file via namespaces" do
+      assert_requires("require_namespaced_file.js", "namespace/a.js")
+    end
+
+    should "be able to require a file with dots in filename" do
+      assert_requires("require_filename_with_dot.js", "file.with.dot.js")
+    end
+
+    should "be able to require namespaced files starting with 'js'" do
+      assert_requires("require_filename_with_js.js", "namespace/json_reader.js")
+    end
+
+    should "check loadpaths" do
+      additional_loadpath = File.join(@fixtures_dir, "different-place")
+      extracted_loadpath = File.join(@fixtures_dir, "javascripts")
+      files = ["norequire.js", "requirecss.js"].map { |f| File.join(extracted_loadpath, f) }
+      @jsrequire = JsRequire.new(additional_loadpath)
+      @jsrequire.resolve_dependencies(files)
+
+      extracted_loadpaths = [File.expand_path(extracted_loadpath)]
+      assert_equal extracted_loadpaths, @jsrequire.instance_eval("@extract_loadpaths")
+
+      additional_loadpaths = [File.expand_path(additional_loadpath)]
+      assert_equal additional_loadpaths, @jsrequire.instance_eval("@additional_loadpaths")
+    end
+
+  end
+
+
+
+  context "helper methods" do
+
+    should "#web_path_helper" do
+      loadpath = File.join(@fixtures_dir, "javascripts")
+      @jsrequire = JsRequire.new(loadpath)
+
+      source_file = File.join(@fixtures_dir, "different-place/b.js")
+      dep = @jsrequire.resolve_dependencies(source_file)
+
+      absolute_files = ["javascripts/norequire.js", "different-place/b.js"].map { |f| File.expand_path(f, @fixtures_dir) }
+      assert_equal absolute_files, dep[:javascripts]
+
+      relative_files = ["/javascripts/norequire.js", "/different-place/b.js"]
+      assert_equal relative_files, JsRequire::web_path_helper(dep[:javascripts], @fixtures_dir)
+
+      relative_files = ["/javascripts/norequire.js", "/different-place/b.js"]
+      assert_equal relative_files, JsRequire::web_path_helper(dep[:javascripts], [@fixtures_dir])
+
+      other_relative_files = ["/bernd/norequire.js", "/baerbel/b.js"]
+      assert_equal other_relative_files, JsRequire::web_path_helper(dep[:javascripts], {
+        File.join(@fixtures_dir, "javascripts") => "/bernd",
+        File.join(@fixtures_dir, "different-place") => "/baerbel"
+      })
+    end
+
+    should "#namespace_helper" do
+      js = ["/platform/public/javascripts/si/module/Hastenichtgesehen.js", "/platform/public/javascripts/si/desktop/Wurstwaren.js", "/platform/public/javascripts/si/applet/GeradNeu.js"]
+      ns = ["si.applet", "si.desktop", "si.module"]
+
+      assert_equal ns, JsRequire::namespace_helper(js, "si")
+    end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: jsrequire
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+platform: ruby
+authors: 
+- aekym
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-05 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Organizes requirements of assets in JavaScript files, resolved dependencies of js files and helps include depending css files.
+email: me@aekym.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- jsrequire.gemspec
+- lib/jsrequire.rb
+- test/fixtures/different-place/b.js
+- test/fixtures/javascripts/a.js
+- test/fixtures/javascripts/c.js
+- test/fixtures/javascripts/file.with.dot.js
+- test/fixtures/javascripts/namespace/a.js
+- test/fixtures/javascripts/namespace/json_reader.js
+- test/fixtures/javascripts/namespace/norequire.js
+- test/fixtures/javascripts/norequire.js
+- test/fixtures/javascripts/norequire.with.dot.in.name.js
+- test/fixtures/javascripts/require_filename_with_dot.js
+- test/fixtures/javascripts/require_filename_with_js.js
+- test/fixtures/javascripts/require_namespaced_file.js
+- test/fixtures/javascripts/require_non_existing_file.js
+- test/fixtures/javascripts/requirecss.js
+- test/fixtures/stylesheets/style.css
+- test/helper.rb
+- test/test_jsrequire.rb
+has_rdoc: true
+homepage: http://github.com/aekym/jsrequire
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Organizes requirements of assets in JavaScript files
+test_files: 
+- test/helper.rb
+- test/test_jsrequire.rb