strockets 0.2.0 → 0.3.0

data/README.md

@@ -3,33 +3,49 @@
 Use Stitch allong with Sprockets
 
 ## Warning
-This is currently under revision so the gem's API might change
+This is currently under revision so the gem's API might change but at this state is very less likely
 
-## Usage
+## Installation
+
+### Rails 3.1
 
 Just include this gem in your Gemfile
 
 ```ruby
-gem 'sprockets'
+# Gemfile
+gem 'strockets'
 ```
 
-And all your javascript files will be compiled using Stitch/CommonJS.
-You can add 
+### Others
 
-```javascript
-// no-stitch
-```
+Add the gem to your Gemfile and register Strockets on your sprockets environment:
 
-on any file's first line to prevent it from being stitched.
+```ruby
+# Gemfile
+gem 'strockets'
 
-Alternatively you can enable the compatibility mode with
+# initializer_file.rb
+env.append_path Strockets.stitch_path
+env.register_postprocessor(
+  'application/javascript',
+  Strockets::StitchPostprocessor
+)
 
-```ruby
-Sprockets.compatibility_mode!
 ```
+## Usage
+
+By default Strockets will Stitch every file excluding application.js and those inside a vendor directory or a gem.
 
-to conditionaly stitch files that have the following header:
+But you can force the stitching of a file by adding a directive to your file's header like
 
 ```javascript
-// stitch
+//= stitch true|false
 ```
+
+## Configuration
+
+Strockets has the following options:
+
+ * `Strockets.namespace`: Which namespace to use
+ * `Strockets.defaults_to_stitch`: Default Action (to stitch or not to stitch)
+ * `Strockets.stitch_exceptions`: Which files shouldn't follow the default action

data/lib/strockets/{stitch.js → assets/stitch.js.erb}

@@ -1,5 +1,6 @@
+//= stitch false
 (function(/*! Stitch !*/) {
-  if (!this.require) {
+  if (!this.<%= Strockets.namespace %>) {
 
     var modules = {},
         cache = {},
@@ -46,11 +47,11 @@
           return path.split('/').slice(0, -1).join('/');
         };
 
-      this.require = function(name) {
+      this.<%= Strockets.namespace %> = function(name) {
         return require(name, '');
       }
 
-    this.require.define = function(bundle) {
+    this.<%= Strockets.namespace %>.define = function(bundle) {
       for (var key in bundle)
         modules[key] = bundle[key];
     };

data/lib/strockets/config.rb

@@ -1,11 +1,36 @@
 module Strockets
   module Config
-    def compatibility_mode?
-      @compatibility_mode || false
+    STITCH_EXCEPTIONS_ON_TRUE = [%r[/application.js], %r[/vendor/], %r[/gems/]]
+    STITCH_EXCEPTIONS_ON_FALSE = []
+
+    def namespace
+      @namespace || "require"
+    end
+
+    def namespace=(namespace)
+      @namespace = namespace
+    end
+
+    def defaults_to_stitch?
+      @defaults_to_stitch || true
+    end
+    alias_method :defaults_to_stitch, :defaults_to_stitch?
+
+    def defaults_to_stitch=(default)
+      @defaults_to_stitch = default
+    end
+
+    def stitch_exceptions
+      @stitch_exceptions ||
+        defaults_to_stitch? ? STITCH_EXCEPTIONS_ON_TRUE : STITCH_EXCEPTIONS_ON_FALSE
+    end
+
+    def stitch_exceptions=(stitch_exceptions)
+      @stitch_exceptions = stitch_exceptions
     end
 
-    def compatibility_mode!
-      @compatibility_mode = true
+    def stitch_path
+      File.expand_path("../assets",__FILE__)
     end
   end
 

data/lib/strockets/railtie.rb

@@ -0,0 +1 @@
+require 'strockets/railties/engine' if defined? Rails

data/lib/strockets/railties/engine.rb

@@ -0,0 +1,14 @@
+module Strockets
+  module Railties
+    class Engine < ::Rails::Engine
+      initializer 'strockets.configure_rails_initialization' do |app|
+        app.assets.append_path Strockets.stitch_path
+
+        app.assets.register_postprocessor(
+          'application/javascript',
+          Strockets::StitchPostprocessor
+        )
+      end
+    end
+  end
+end

data/lib/strockets/stitch_postprocessor.rb

@@ -0,0 +1,73 @@
+module Strockets
+  class StitchPostprocessor < Tilt::Template
+    HEADER_PATTERN = Sprockets::DirectiveProcessor::HEADER_PATTERN
+    DIRECTIVE_PATTERN = Sprockets::DirectiveProcessor::DIRECTIVE_PATTERN
+
+    def prepare; end
+
+    def evaluate(context, locals, &block)
+      @context = context
+
+      stitch? ? define : data
+    end
+
+    protected
+      attr_reader :context
+
+      def process_requires
+
+      end
+
+      def stitch?
+        stitch = directive?
+
+        if stitch.nil?
+          stitch = Strockets.defaults_to_stitch?
+          stitch = !stitch if exception?
+        end
+
+        stitch
+      end
+
+      def define
+        context.require_asset "stitch"
+
+        "\n#{ Strockets.namespace }.define({'#{
+          context.logical_path 
+        }': function(exports, require, module) {\n#{
+          indent(data)
+        }\n}});\n"
+      end
+
+      def exception?
+        Strockets.stitch_exceptions.any?{ |e| e.match(context.pathname.to_s) }
+      end
+
+      def directive?
+        header = context.pathname.read[HEADER_PATTERN, 0] || ""
+        header.lines.each do |line|
+          if directive = line[DIRECTIVE_PATTERN, 1]
+            name, *args = Shellwords.shellwords(directive)
+            if name == "stitch"
+              case args.first
+              when "true" then return true
+              when "false" then return false
+              end
+            end
+          end
+        end
+
+        nil
+      end
+
+      def indent(string)
+        string.gsub(/$(.)/m, "\\1  ").strip
+      end
+  end
+end
+
+class Sprockets::DirectiveProcessor
+  # This is just a placeholder to make Sprockets erase stitch directives
+  def process_stitch_directive(arg)
+  end
+end

data/lib/strockets/version.rb

@@ -1,3 +1,3 @@
 module Strockets
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/strockets.rb

@@ -1,5 +1,4 @@
 require "strockets/version"
 require "strockets/config"
-require "strockets/processor"
-require "strockets/bundle"
-require "strockets/environment"
+require "strockets/stitch_postprocessor"
+require "strockets/railtie"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strockets
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-14 00:00:00.000000000 Z
+date: 2012-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70297367288240 !ruby/object:Gem::Requirement
+  requirement: &70177853989400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70297367288240
+  version_requirements: *70177853989400
 - !ruby/object:Gem::Dependency
   name: sprockets
-  requirement: &70297367287720 !ruby/object:Gem::Requirement
+  requirement: &70177853988840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70297367287720
+  version_requirements: *70177853988840
 description: Use Stitch allong with Sprockets
 email:
 - me@sagmor.com
@@ -45,11 +45,11 @@ files:
 - README.md
 - Rakefile
 - lib/strockets.rb
-- lib/strockets/bundle.rb
+- lib/strockets/assets/stitch.js.erb
 - lib/strockets/config.rb
-- lib/strockets/environment.rb
-- lib/strockets/processor.rb
-- lib/strockets/stitch.js
+- lib/strockets/railtie.rb
+- lib/strockets/railties/engine.rb
+- lib/strockets/stitch_postprocessor.rb
 - lib/strockets/version.rb
 - strockets.gemspec
 homepage: https://github.com/sagmor/strockets
@@ -66,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2558210479809988184
+      hash: 4466840386315886126
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2558210479809988184
+      hash: 4466840386315886126
 requirements: []
 rubyforge_project: strockets
 rubygems_version: 1.8.10

data/lib/strockets/bundle.rb

@@ -1,13 +0,0 @@
-module Strockets
-  class Bundle < Tilt::Template
-    self.default_mime_type = 'application/javascript'
-
-    def prepare
-    end
-
-    def evaluate(scope, locals, &block)
-      File.read(File.expand_path('../stitch.js',__FILE__)) + data
-    end
-  end
-end
-

data/lib/strockets/environment.rb

@@ -1,17 +0,0 @@
-module Strockets
-  module Environment
-    def self.included(base)
-      base.send :alias_method, :initialize_without_stitch, :initialize
-      base.send :alias_method, :initialize, :initialize_with_stitch
-    end
-
-    def initialize_with_stitch(*args)
-      initialize_without_stitch(*args)
-
-      self.register_bundle_processor 'application/javascript', Bundle
-      self.register_postprocessor 'application/javascript', Processor
-    end
-  end
-end
-
-Sprockets::Environment.send :include, Strockets::Environment

data/lib/strockets/processor.rb

@@ -1,31 +0,0 @@
-module Strockets
-  class Processor < Tilt::Template
-    self.default_mime_type = 'application/javascript'
-
-    def prepare
-    end
-
-    def evaluate(scope, locals, &block)
-      if stitch? scope
-        "\nrequire.define({'#{ scope.logical_path }': function(exports, require, module) {\n" +
-        indent(data) +
-        "\n}});\n"
-      else
-        data
-      end
-    end
-
-    private
-      def stitch?(scope)
-        return false if scope.pathname.basename.to_s =~ /\.jst/ 
-
-        directive = File.open(scope.pathname){|f| f.readline}.downcase.gsub(/[^a-z\-]/,"") rescue nil
-
-        Strockets.compatibility_mode? ? directive == "stitch" : directive != "no-stitch"
-      end
-
-      def indent(string)
-        string.gsub(/$(.)/m, "\\1  ").strip
-      end
-  end
-end