jsrequire 0.0.5 → 0.1.0

data/README.mkd

@@ -0,0 +1,74 @@
+jsrequire
+=========
+
+
+A small lib to add a require functionality to JavaScript files.
+
+
+#### Features
+
+* Dependencies are solved from one or multiple files
+* Multiple loadpaths for js file lookup
+* Simple assets collector for stylesheets
+* Support for namespaces like ExtJS requires it
+
+
+A JavaScript file
+-----------------
+
+On top of a file add something like:
+
+    /* require foo/bar */
+    /* css baz */
+
+This requires the js file foo/bar.js and the stylesheet baz.css. 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]
+
+
+A view file
+-----------
+
+e.g. in a Haml view template
+
+    - 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/VERSION

@@ -1 +1 @@
-0.0.5
+0.1.0

data/jsrequire.gemspec

@@ -5,22 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jsrequire}
-  s.version = "0.0.5"
+  s.version = "0.1.0"
 
   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.date = %q{2010-05-07}
   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"
+     "README.mkd"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.mkd",
      "Rakefile",
      "VERSION",
      "jsrequire.gemspec",
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "test/fixtures/javascripts/a.js",
      "test/fixtures/javascripts/c.js",
      "test/fixtures/javascripts/file.with.dot.js",
+     "test/fixtures/javascripts/hook.js",
      "test/fixtures/javascripts/namespace/a.js",
      "test/fixtures/javascripts/namespace/json_reader.js",
      "test/fixtures/javascripts/namespace/norequire.js",
@@ -41,15 +42,17 @@ Gem::Specification.new do |s|
      "test/fixtures/javascripts/requirecss.js",
      "test/fixtures/stylesheets/style.css",
      "test/helper.rb",
+     "test/test_hooks.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.rubygems_version = %q{1.3.6}
   s.summary = %q{Organizes requirements of assets in JavaScript files}
   s.test_files = [
     "test/helper.rb",
+     "test/test_hooks.rb",
      "test/test_jsrequire.rb"
   ]
 

data/lib/jsrequire.rb

@@ -11,6 +11,13 @@ class JsRequire
 
     loadpaths = [loadpaths] unless loadpaths.is_a?(Array)
     @additional_loadpaths = JsRequire::normalize_filepaths(loadpaths.compact)
+
+    @preprocessors = Hash.new { |h,k| h[k] = [] }
+  end
+
+
+  def on(action = nil, &block)
+    @preprocessors[action] << block
   end
 
 
@@ -135,6 +142,17 @@ class JsRequire
     raise FileNotFoundInLoadpath, "File '#{filename}' not found in loadpaths '#{loadpaths.join("', '")}'."
   end
 
+  def exec_preprocessor(action, parameter)
+    trigger = Proc.new do |cb|
+      res = cb.call(action, parameter)
+      action, parameter = res if res.is_a?(Array) && res.size == 2
+    end
+
+    @preprocessors[action].each(&trigger)
+    @preprocessors[nil].each(&trigger)
+
+    [action, parameter]
+  end
 
   def extract_dependencies(filename)
     is_require = true
@@ -142,11 +160,19 @@ class JsRequire
 
     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"
+        line = f.gets
+        if line =~ /^\s*\/\*\s*(\w+)(.+)\*\/\s*$/
+          action = $1.strip
+          parameter = $2.strip
+
+          # fire callbacks
+          #
+          action, parameter = exec_preprocessor(action, parameter)
+
+          case action
+          when "require" then js << "#{parameter}.js"
+          when "css"     then @stylesheets[filename] << parameter + ".css"
+          end
         else
           is_require = false
         end

data/test/fixtures/javascripts/hook.js

@@ -0,0 +1,2 @@
+/* view hello world */
+

data/test/helper.rb

@@ -5,6 +5,12 @@ require 'shoulda'
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+begin
+  require 'redgreen'
+rescue Exception
+end
+
+
 require 'jsrequire'
 
 class Test::Unit::TestCase

data/test/test_hooks.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/helper.rb'
+
+class TestHooks < Test::Unit::TestCase
+
+  def setup
+    @fixtures_dir = File.join(File.dirname(__FILE__), "fixtures")
+  end
+
+  def require(file, &block)
+    @jsrequire = JsRequire.new
+
+    yield
+
+    data = @jsrequire.resolve_dependencies(File.join(@fixtures_dir + "/javascripts", file))
+  end
+
+
+  context "hooks" do
+
+    should "register hook successfully" do
+      @jsrequire = JsRequire.new
+      @jsrequire.on { |action, parameter| }
+    end
+
+    should "execute general hook" do
+      called = false
+
+      require("hook.js") do
+        @jsrequire.on do |action, parameter|
+          assert_equal "view", action
+          assert_equal "hello world", parameter
+          called = true
+        end
+      end
+
+      assert called, "Callback was not called"
+    end
+
+    should "execute specific hook" do
+      called = false
+      require("hook.js") do
+        @jsrequire.on("view") do |action, parameter|
+          assert_equal "view", action
+          assert_equal "hello world", parameter
+          called = true
+        end
+      end
+
+      assert called, "Callback was not called"
+    end
+
+    should "call specific hook before general" do
+      specific_called = false
+      general_called = false
+
+      require("hook.js") do
+        @jsrequire.on do |action, parameter|
+          assert specific_called, "Specific was not called before"
+          general_called = true
+        end
+        @jsrequire.on("view") do |action, parameter|
+          assert !general_called, "General was called before"
+          specific_called = true
+        end
+      end
+
+      assert general_called && specific_called, "Callbacks were not called"
+    end
+
+    should "rewrite line to require" do
+      called = false
+      deps = require("hook.js") do
+        @jsrequire.on("view") do |action, params|
+          called = true
+          ["require", "norequire"]
+        end
+      end
+
+      assert called, "Callback not fired"
+      assert_equal 2, deps[:javascripts].size
+      assert_match /norequire\.js$/, deps[:javascripts].first
+    end
+
+    should "rewrite line to require" do
+      called = false
+      deps = require("hook.js") do
+        @jsrequire.on("view") do |action, params|
+          called = true
+          ["require", "norequire"]
+        end
+      end
+
+      assert called, "Callback not fired"
+      assert_equal 2, deps[:javascripts].size
+      assert_match /norequire\.js$/, deps[:javascripts].first
+    end
+
+  end
+
+end
+

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: jsrequire
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - aekym
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 +01:00
+date: 2010-05-07 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -21,12 +26,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.mkd
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.mkd
 - Rakefile
 - VERSION
 - jsrequire.gemspec
@@ -35,6 +40,7 @@ files:
 - test/fixtures/javascripts/a.js
 - test/fixtures/javascripts/c.js
 - test/fixtures/javascripts/file.with.dot.js
+- test/fixtures/javascripts/hook.js
 - test/fixtures/javascripts/namespace/a.js
 - test/fixtures/javascripts/namespace/json_reader.js
 - test/fixtures/javascripts/namespace/norequire.js
@@ -47,6 +53,7 @@ files:
 - test/fixtures/javascripts/requirecss.js
 - test/fixtures/stylesheets/style.css
 - test/helper.rb
+- test/test_hooks.rb
 - test/test_jsrequire.rb
 has_rdoc: true
 homepage: http://github.com/aekym/jsrequire
@@ -61,21 +68,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Organizes requirements of assets in JavaScript files
 test_files: 
 - test/helper.rb
+- test/test_hooks.rb
 - test/test_jsrequire.rb

data/README.rdoc

@@ -1,50 +0,0 @@
-= 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.
-