stitch-plus 1.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODQ4NjliZmJmZjhhNjlkZGEwOTBiYTBmOTIwYzZjZDQwNGQzNWU1Mg==
+  data.tar.gz: !binary |-
+    ODliZTkyMTRhZWMzMjBlYTNhYzRhNTQwOWQ4MTZhODEwM2Q1MjhjNQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDA3ODVlYjhmMzFmYzQ5ZWFmYzA5ODdjNzkxZWNlYWE3OGU4OTJmZWQ3Zjlj
+    YWJmNjE5MDcwNWQ3ZTA4OGY5NmM2MTQ0YzA1Nzk2NzU5ZDY5ZGU2ZWE1ZjJm
+    YTcyODllZWMwMWI3MGY1ZjQ1Y2VjNjhiYjNjNDY4MDBjZTg3OGU=
+  data.tar.gz: !binary |-
+    MGY0ZWUzOTQ5YTQ3ZTFhNzk5YmMyNjM0ZjVhNzc2NGQ5ZTJmYmY4N2Q5NWQ2
+    ZjFmNjhlNDYxMGQzNGM4YWZkZTBlMTQwYWMyMzQ4NDUyN2EyYTZhYTg4ODk0
+    Y2MxOGMxMzY5ZDQ3MTVlN2NmY2MzZDAxOWY0YWIzYWU2NzAxYmI=

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test/all.js
+.DS_Store
+test/javascripts/*.js

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 1.0.0
+- initial release
+
+## 1.0.1
+- Fixed fingerprints.
+- set_options is now a public method
+- changed option `write` to `output`
+
+## 1.0.2
+- Renamed 'build' method to 'compile' to be consistent with Stitch and Uglify.
+- Renamed old 'compile' to 'write' since it actually writes files.
+- Options can be accessed now for easier inspection
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stitchplus.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Mathis
+
+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,175 @@
+# Stitch Plus
+
+A CommonJS JavaScript package management solution powered by [Stitch-rb](https://github.com/maccman/stitch-rb). Stitch Plus adds some nice features including:
+
+- Optionally [uglify](https://github.com/lautis/uglifier) javascript output.
+- Each build is fingerprinted with a comment to avoid unnecessary compiling.
+- Easily fingerprint the file name for cache busting power.
+- Remove previously generated files with each compile.
+- Designed to integrate with Guard via [guard-stitch-plus](https://github.com/imathis/guard-stitch-plus).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stitch-plus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stitch-plus
+
+## Usage
+
+```ruby
+# options can be a hash or a path to a yaml file
+s = StitchPlus.new(options)
+
+# Returns compiled javascript
+s.compile
+
+# Writes compiled javascript to disk (`output` config determines filename)
+s.write
+
+# Get compiled filename
+s.output_file #> javascripts/app-f1408932717b4b16eb97969d34961213.js
+
+# Return the array of javascripts to be compiled
+s.all_files
+
+# Return the fingerprint to be used
+s.file_fingerprint
+
+# Permanently modify the config options
+s.set_options({output: 'foo.js'})
+
+# Return a hash of the options
+s.options
+
+```
+
+All methods will accept an options hash which will temporarily override previous options options, for example:
+
+
+```
+s.write({fingerprint: 'false'})
+```
+
+This will disable fingerprinting of the filename temporarily and write to app.js instead of the fingerprinted filename.
+
+
+## Configuration
+
+You can configure StichPlus as like this.
+
+| Config           | Description                                                                | Default     |
+|:-----------------|:---------------------------------------------------------------------------|:------------|
+| `dependencies`   | Array of files/directories to be added first as global javascripts         | nil         |
+| `paths`          | Array of directories where javascripts will be wrapped as CommonJS modules | nil         |
+| `output`         | A path to write the compiled javascript                                    | 'all.js'    |
+| `fingerprint`    | Add a fingerprint to the file name for super cache busting power           | false       |
+| `cleanup`        | Automatically remove previously compiled files                             | true        |
+| `uglify`         | Smash javascript using the Uglifier gem                                    | false       |
+| `uglify_options` | Options for the Uglifier gem. See the [Uglifier docs](https://github.com/lautis/uglifier#usage) for details. | {}       |
+
+### Reading configuration from a file
+
+Stitch can also read configurations from a YAML file. For example, you could
+create a `stitch.yml` containing the following:
+
+```yaml
+stitch:
+  dependencies: ['javascripts/dependencies']
+  paths: ['javascripts/modules']
+  output: 'javascripts/app.js'
+  fingerprint: true
+```
+
+Then you could call stitch like this:
+
+```ruby
+js = StitchPlus.new('stitch.yml').compile
+```
+
+### Regarding "Dependencies"
+
+When using `dependencies`, order matters, directories are globbed, and files will only be included once for each listing. For example, if you are working on something with jQuery and Backbone.js, your dependencies might look like this:
+
+```
+dependencies: ['js/deps/jquery.js', 'js/deps/underscore.js', 'js/deps/backbone.js', 'js/deps']
+```
+
+This will add—in order—jQuery, Underscore.js and Backbone.js, followed by any other files in the `js/deps` directory.
+
+
+### Regarding "Paths"
+
+Javascrpts which are included as paths will be added to the output javascript, after any dependencies, and will be wrapped up as CommonJS modules. Stitch will add its
+own require function which allows these scripts to be loaded as modules, then it will write each script as a member of a hash, with the file path as the key. For
+example.
+
+A the script `js/deps/test-module.js` containing the following:
+
+```js
+var Test = {
+  init: function(){
+    console.log('initialized!');
+  }
+}
+
+module.exports = Test;
+```
+
+will be added to the hash and surrounded with the following:
+
+```js
+"test-module": function(exports, require, module) {
+  // the original script
+}
+```
+
+This allows other scripts to load the module with
+
+```js
+test = require('test-module')
+test.init() // logs 'initialized!' to the console
+```
+
+Author's note: I feel like `paths` is a stupid name for this option, but I have left it as-is to be consistent with Stitch.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2013 Brandon Mathis
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/stitch-plus/version.rb

@@ -0,0 +1,3 @@
+module StitchPlusVersion
+  VERSION = "1.0.2"
+end

data/lib/stitch-plus.rb

@@ -0,0 +1,226 @@
+require 'digest/md5'
+require 'stitch-rb'
+require 'colorator'
+require 'yaml'
+
+class StitchPlus
+  attr_accessor :options
+
+  def initialize(options={})
+
+    @options = {
+      :dependencies   => nil,
+      :paths          => nil,
+      :output         => 'all.js',
+      :fingerprint    => false,
+      :cleanup        => true,
+      :uglify         => false,
+      :uglify_options => {}
+    }
+
+    set_options(options)
+
+    begin
+      require 'coffee-script'
+      @has_coffee = true
+    rescue LoadError
+    end
+
+  end
+
+  # Set or temporarily set options
+  def set_options(options={}, temporary=false)
+    @old_options = @options if temporary
+
+    # If options is a file path, read options from yaml
+    if options.class == String and File.exist? options
+      options = load_options(options)
+    end
+
+    @options = @options.merge symbolize_keys(options)
+
+    if @options[:uglify]
+      begin
+        require 'uglifier'
+        @uglifier = Uglifier.new(@options[:uglify_options])
+      rescue LoadError
+      end
+    end
+
+    @options
+  end
+
+  def temp_options(options)
+    set_options(options, true)
+  end
+
+  # Compile javascripts, uglifying if necessary
+  def compile
+
+    if all_files.join().match(/\.coffee/) and !@has_coffee
+      error "Cannot compile coffeescript".red
+      error "Add ".white + "gem 'coffee-script'".yellow + " to your Gemfile."
+    end
+
+    if @options[:uglify] and !@uglifier
+      error "Cannot uglify javascript".red
+      error "Add ".white + "gem 'uglifier'".yellow + " to your Gemfile."
+    end
+
+    begin
+      js = Stitch::Package.new(:dependencies => dependencies, :paths => @options[:paths]).compile
+      js = @uglifier.compile(js) if @uglifier
+      js
+    rescue StandardError => e
+      error "Stitch failed to compile".red
+      error e
+      false
+    end
+  end
+
+  # Write compiled javascripts to disk
+  def write(options=nil)
+    temp_options(options) if options
+
+    @fingerprint = file_fingerprint
+    @file = output_file
+
+    js = "/* Build fingerprint: #{@fingerprint} */\n" + build
+
+    if has_fingerprint(@file, @fingerprint)
+      info "Stitch " + "identical ".green + @file
+      reset_options if options
+      true
+    else
+      begin
+        write_msg = (File.exists?(@file) ? "overwrite " : "created ").yellow + @file
+        cleanup(@file) if @options[:cleanup]
+
+        File.open(@file, 'w') { |f| f.write js }
+
+        info "Stitch " + write_msg
+        true
+      rescue StandardError => e
+        error "Stitch failed to write #{@file}".red
+        error e
+        reset_options if options
+        false
+      end
+    end
+
+  end
+
+  # return the compiled js path including fingerprint if necessary
+  def output_file(options=nil)
+    temp_options(options) if options
+    file = @options[:output]
+
+    if @options[:fingerprint]
+      @fingerprint ||= file_fingerprint
+      basename = File.basename(file).split(/(\..+)$/).join("-#{@fingerprint}")
+      dir = File.dirname(file)
+      file = File.join(dir, basename)
+    end
+
+    reset_options if options
+    file
+  end
+
+  # Get a list of all files to be stitched
+  def all_files(options=nil)
+    temp_options(options) if options
+    files = []
+    files << dependencies if @options[:dependencies]
+    files << Dir.glob(File.join(@options[:paths], '**/*')) if @options[:paths]
+    reset_options if options
+    files.flatten.uniq
+  end
+
+  # Get and MD5 hash of files including order of dependencies
+  def file_fingerprint(options=nil)
+    temp_options(options) if options
+    fingerprint = Digest::MD5.hexdigest(all_files.map! { |path| "#{File.mtime(path).to_i}" }.join + @options.to_s)
+    reset_options if options
+    fingerprint
+  end
+
+  private
+  
+  # Remove existing generated files with the same options[:output] name
+  def cleanup(file)
+    match = File.basename(@options[:output]).split(/(\..+)$/).map { |i| i.gsub(/\./, '\.')}
+    Dir.glob(File.join(File.dirname(@options[:output]), '**/*')).each do |item|
+      if File.basename(item) != File.basename(file) and File.basename(item).match /^#{match[0]}(-.+)?#{match[1]}/i
+        info "Stitch " + "deleted ".red + item
+        FileUtils.rm(item)
+      end
+    end
+  end
+
+
+  # Determine if the file has a fingerprint
+  def has_fingerprint(file, fingerprint)
+    File.size?(file) && File.open(file) {|f| f.readline} =~ /#{fingerprint}/
+  end
+
+  # Return all files included as dependencies, globbing as necessary
+  def dependencies
+    if @options[:dependencies]
+      deps = [] << @options[:dependencies]
+      deps.flatten.collect { |item|
+        item = File.join(item,'**/*') if File.directory?(item)
+        Dir.glob item
+      }.flatten.uniq.collect { |item|
+        File.directory?(item) ? nil : item
+      }.compact
+    else
+      false
+    end
+  end
+
+  def info(message)
+    if defined?(Guard::UI)
+      Guard::UI.info message
+    else
+      puts message
+    end
+  end
+
+  def error(message)
+    if defined?(Guard::UI)
+      Guard::UI.error message
+    else
+      puts message
+    end
+  end
+
+  def reset_options
+    if @old_options
+      @options = @old_options
+      @old_options = nil
+    end
+  end
+
+  def load_options(file)
+    options = YAML::load(File.open(file)) if File.exist? file
+    options = options['stitch'] unless options['stitch'].nil?
+    options
+  end
+
+  def symbolize_keys(hash)
+    hash.inject({}){|result, (key, value)|
+      new_key = case key
+                when String then key.to_sym
+                else key
+                end
+    new_value = case value
+                when Hash then symbolize_keys(value)
+                else value
+                end
+    result[new_key] = new_value
+    result
+    }
+  end
+
+end
+

data/stitchplus.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stitch-plus/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "stitch-plus"
+  gem.version       = StitchPlusVersion::VERSION
+  gem.authors       = ["Brandon Mathis"]
+  gem.email         = ["brandon@imathis.com"]
+  gem.description   = %q{A nicer way to combine and uglify javascript with fingerprinting and modularization. Powered by Stitch.}
+  gem.summary       = %q{A nicer way to combine and uglify javascript with fingerprinting and modularization. Powered by Stitch.}
+  gem.homepage      = "https://github.com/imathis/stitch-plus"
+  gem.license       = "MIT"
+
+  gem.add_runtime_dependency 'stitch-rb', '>= 0.0.8'
+  gem.add_runtime_dependency 'colorator', '>= 0.1'
+  
+  gem.files         = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+end

data/test/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'stitch-plus', :path => "../"
+gem 'coffee-script'
+gem 'uglifier'
+
+

data/test/javascripts/dependencies/foo.coffee

@@ -0,0 +1,3 @@
+unless window.awesome?
+  console.log 'hi guys'
+  

data/test/javascripts/dependencies/test.js

@@ -0,0 +1,4 @@
+var test = function (message){
+  console.log(message || 'test');
+}
+

data/test/javascripts/modules/test-module.js

@@ -0,0 +1,7 @@
+var Widget = {
+  init: function(){
+    console.log('new widget!');
+  }
+}
+
+module.exports = Widget;

data/test/stitch.yml

@@ -0,0 +1,5 @@
+stitch:
+  dependencies: ['javascripts/dependencies']
+  paths: ['javascripts/modules']
+  output: 'javascripts/app.js'
+  fingerprint: true

data/test/test.rb

@@ -0,0 +1,9 @@
+require '../lib/stitch-plus'
+
+
+s = StitchPlus.new('stitch.yml')
+
+puts "Javascripts to be compiled:"
+puts s.all_files.map { |f| "  #{f}"}
+
+puts s.compile

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: stitch-plus
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stitch-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: colorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: A nicer way to combine and uglify javascript with fingerprinting and
+  modularization. Powered by Stitch.
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stitch-plus.rb
+- lib/stitch-plus/version.rb
+- stitchplus.gemspec
+- test/Gemfile
+- test/javascripts/dependencies/foo.coffee
+- test/javascripts/dependencies/test.js
+- test/javascripts/modules/test-module.js
+- test/stitch.yml
+- test/test.rb
+homepage: https://github.com/imathis/stitch-plus
+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.0.7
+signing_key: 
+specification_version: 4
+summary: A nicer way to combine and uglify javascript with fingerprinting and modularization.
+  Powered by Stitch.
+test_files: []