redjs-sprockets 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25b78f55679dd13fd1322548704040a1a5b26b56
+  data.tar.gz: abe6a1b8cdf72b94af2fd1474f853b88eebc9c37
+SHA512:
+  metadata.gz: e3aeb49fb330efbc99e9e78f317d2ca8f4fa39f47ea91911f9d3a24f8ffa177085b4710b2ad207c22dfa0a8778aed204711dfc9ce3d765712626bb8605a59711
+  data.tar.gz: 687240293795a24312436592e8141b7332bad5b91a51bad71029b61c84a966d9e771df712c0e1880745b2c46838e3a6ccbdc3ef34186aafbdc4f175849e9cf00

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dmitry Maganov
+
+MIT License
+
+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,84 @@
+# redjs-sprockets
+
+## Installation
+
+### Common
+Add 'redjs-sprockets' to a gemfile
+~~~ruby
+gem 'redjs-sprockets'
+~~~
+
+Require 'redjs-sprockets' in a javascript manifest before any .red file
+~~~js
+//= require redjs-sprockets
+~~~
+
+### Specific
+
+#### Rails
+For Rails that is all.
+
+#### Middleman
+Activate the extension
+~~~ruby
+# config.rb
+activate :redjs_sprockets
+~~~
+
+#### Bare Sprockets
+On any other platform, which include Sprockets, you can activate redjs like this
+~~~ruby
+# pass a Sprockets::Base instance as an argument to the Redjs::Sprockets.register method
+Redjs::Sprockets.register my_sprockets_instance
+~~~
+
+## Usage
+Add the '.red' extension after '.js' for files that will be using the Redjs dependecy manager.  
+In those files four functions will be available.
+
+#### $require( path_to_file )
+Return a value associated with the file.  
+Will add the specified file to required ones, identical to the sprockets '//= require' directive.  
+Path to file can't be a variable, it must be a string.  
+Can be relative.
+
+#### $requires( path_to_file )
+Return a value associated with the file.  
+Without issuing a sprockets directive.  
+You must ensure inclusion of required file yourself.  
+Path can be varialbe.
+
+#### $define( value )
+Assotiate the value with a file.  
+If the value is a function, its execution result will be assotiated.
+
+#### $defines( key, value )
+Assotiate the value with the key.
+
+### Example
+
+~~~js
+// app/assets/javascripts/some/folder/a.js.red
+
+$define( 34 );
+~~~
+
+~~~js
+// app/assets/javascripts/other/folder/b.js.red
+
+expect( $require( 'some/folder/a' ) ).to.equal( 34 );
+~~~
+
+## How It Works
+
+### Preprocessor
+It searches for '$require' and '$define' directives.  
+For '$require' - add the specified pathname to required assets.  
+For '$define' - insert a file pathname as the first argument.  
+If there is no '$define' in a file, then it appends '$define({ pathname }, void 0)' to the end.
+
+### JS side
+Nothing fancy to see there.  
+Pretty dumb.  
+Because required assets are included first, there is no need for asynchronous loading or fancy things like that.  
+If you need them for some reason, you can just write your implementation and replace 'redjs-sprockets' in your js manifest.

data/lib/javascripts/redjs-sprockets.js

@@ -0,0 +1,28 @@
+( function ( context ) {
+
+  var reds = {};
+
+  var $require = function ( key ) {
+
+    if ( reds.hasOwnProperty( key ) ) return reds[ key ];
+
+    throw new Error( '$require "' + key + '" failed' );
+
+  }
+
+  var $define = function ( key, val, force ) {
+
+    if ( reds.hasOwnProperty( key ) && ! force ) throw new Error( 'module with key "' + key + '" already exists' );
+
+    if ( typeof val == 'function' ) val = val();
+
+    reds[ key ] = val;
+
+  }
+
+  context.$require = $require;
+  context.$requires = $require;
+  context.$define = $define;
+  context.$defines = $define;
+
+} )( this );

data/lib/redjs/platforms/middleman.rb

@@ -0,0 +1,32 @@
+require 'middleman-core'
+require 'pry'
+
+
+module Redjs
+
+  module Platforms
+
+    class Middleman < ::Middleman::Extension
+
+      def initialize ( app, options_hash = {}, &block )
+
+        super
+
+        ::Tilt.register 'red', Redjs::Sprockets
+
+        app.after_configuration do
+
+          Redjs::Sprockets.register sprockets
+
+        end
+
+      end
+
+    end
+
+  end
+
+end
+
+
+::Middleman::Extensions.register :redjs_sprockets, Redjs::Platforms::Middleman

data/lib/redjs/platforms/rails.rb

@@ -0,0 +1,20 @@
+require 'rails/engine'
+
+
+module Redjs
+
+  module Platforms
+
+    class Rails < ::Rails::Engine
+
+      initializer 'redjs_rails.setup_engine', group: :all do | app |
+
+        Redjs::Sprockets.register app.assets
+
+      end
+
+    end
+
+  end
+
+end

data/lib/redjs/processor.rb

@@ -0,0 +1,44 @@
+require 'pathname'
+
+
+module Redjs
+
+  class Processor
+
+    def self.process ( path, data )
+
+      required = []
+
+      unless data.gsub! /\$define\s*\(/, "\\0'#{ path }',"
+
+        unless data =~ /\$defines\s*\(\s*['"]#{ path }['"]/
+
+          data += "\n" + "$define('#{ path }',void 0);"
+
+        end
+
+      end
+
+      data.gsub! /(\$require\s*\(\s*['"])([^'"]+)(['"]\s*\))/ do
+
+        asset_path = $2
+
+        if asset_path[ 0 ] == '.'
+
+          asset_path = Pathname.new( path ).dirname + asset_path
+
+        end
+
+        required << asset_path unless asset_path == path
+
+        "#{ $1 }#{ asset_path }#{ $3 }"
+
+      end
+
+      { data: data, required: required }
+
+    end
+
+  end
+
+end

data/lib/redjs/sprockets/v2.rb

@@ -0,0 +1,33 @@
+require 'tilt'
+
+
+module Redjs
+
+  class Sprockets < Tilt::Template
+
+    self.default_mime_type = 'application/javascript'
+
+    def evaluate ( context, locals )
+
+      result = Redjs::Processor.process context.logical_path, data
+
+      result[ :required ].each{ | required_path | context.require_asset required_path }
+
+      result[ :data ]
+
+    end
+
+    def prepare
+    end
+
+    def self.register ( sprockets )
+
+      sprockets.register_engine 'red', self
+
+      sprockets.append_path Redjs::JAVASCRIPTS_PATH
+      
+    end
+
+  end
+
+end

data/lib/redjs/sprockets/v3.rb

@@ -0,0 +1,31 @@
+require 'set'
+
+
+module Redjs
+
+  class Sprockets
+
+    def self.call ( input )
+
+      result = Redjs::Processor.process input[ :filename ], input[ :data ]
+
+      required = result[ :required ].map{ | path | input[ :environment ].resolve path }
+
+      { 
+        data: result[ :data ],
+        required: Set.new( input[ :metadata ][ :required ] ) + required
+      }
+
+    end
+
+    def self.register ( sprockets )
+
+      sprockets.register_engine '.red', self, mime_type: 'application/javascript'
+
+      sprockets.append_path Redjs::JAVASCRIPTS_PATH
+
+    end
+
+  end
+
+end

data/lib/redjs/version.rb

@@ -0,0 +1,5 @@
+module Redjs
+
+  VERSION = '0.0.2'
+  
+end

data/lib/redjs-sprockets.rb

@@ -0,0 +1,15 @@
+require 'sprockets'
+require 'pathname'
+
+module Redjs
+
+  JAVASCRIPTS_PATH = Pathname.new( __FILE__ ).dirname.join( 'javascripts' ).to_s
+
+end
+
+require 'redjs/version'
+require 'redjs/processor'
+require 'redjs/sprockets/v' + Sprockets::VERSION[ 0 ]
+
+require 'redjs/platforms/rails' if defined? Rails
+require 'redjs/platforms/middleman' if defined? Middleman

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: redjs-sprockets
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dmitry Maganov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+description: Require by path, Define without key. Permissive towards Sprockets directives
+  and global scope pollution.
+email:
+- vonagam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/javascripts/redjs-sprockets.js
+- lib/redjs-sprockets.rb
+- lib/redjs/platforms/middleman.rb
+- lib/redjs/platforms/rails.rb
+- lib/redjs/processor.rb
+- lib/redjs/sprockets/v2.rb
+- lib/redjs/sprockets/v3.rb
+- lib/redjs/version.rb
+homepage: https://github.com/vonagam/redjs-sprockets
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: JS dependency sugar for Sprockets.
+test_files: []