jekyll-stitch-plus 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWRkZDAxNzg4MjhlODA0OTUyZTRhNDJiYWQ2NGJkMjRjODUyYmNlZg==
+  data.tar.gz: !binary |-
+    ZGFmOWIxYmNkYWJiM2I3MTQxM2VkNjg1Yzk4ZjZjYTMzZmMwY2NiOQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NzZlYjhmNTY2ODFhZDFmZTBmNjNiNjgxYjE4ZGI2YjA5YmMyMGVjZDhiZWUx
+    ZjViZGFiZDU5ZjE3ZTNlNjA4YmRhMTI2NzNlMmVhYWIwNjNlM2RiODkzYTgw
+    ZjY3MmZhNDEwMzJjNzVmYmMwNmUxMWQ2MTNkOWVlZjc5ZTU1Mzg=
+  data.tar.gz: !binary |-
+    NmM5NDBjNjRlNTc1YmE1OTNlMmU2N2UyNWEyMGQ3Nzk4OGFmOTRhZTFlZWE1
+    ZmIyMDQ0ZGE2MjYzNjViNGRlMWFhZWRmOTE4NmJmZjA2MzZmOGIxYjJiMGY3
+    MDE2NTA4YjI4ZjYxMzQzZGRjMmMyNjgwZGJhYTNiNTQzY2RiOWM=

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-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,92 @@
+# Jekyll Stitch Plus
+
+Easily package javascripts into a single file, with support for fingerprinting, uglification and CommonJS wrapping for easy modularization. This plugin is powered by
+[Stitch Plus](https://github.com/imathis/stitch-plus) which is a fancy interface on top of [Stitch-rb](https://github.com/maccman/stitch-rb).
+
+### Install the Gem
+Add this line to your application's Gemfile:
+
+    gem 'jekyll-stitch-plus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-stitch-plus
+
+### Install the plugin
+
+Add a ruby file (perhaps named `jekyll-stitch-plus.rb`) to your Jekyll plugins directory add add `require 'jekyll-stitch-plus'` to the top.
+
+Next add `{% javascript_tag %}` to a template to render `<script src='/javascripts/all.js'></script>`
+
+## Configuration
+
+| 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 docs](https://github.com/lautis/uglifier#usage) for details. | {}       |
+
+To configure this plugin add Jekyll's YAML configuration file. Here's an example.
+
+```yaml
+# Set Jekyll's env to enable/disable Uglifier
+env: 'production'
+
+stitch:
+  dependencies: 
+    - 'js/lib/jquery.js'
+    - 'js/lib/underscore.js'
+    - 'js/lib'        # globs the js/lib dir
+  paths: 'js/modules' # globs the js/modules dir
+  output: 'js/site.js'
+  fingerprint: true
+```
+
+To uglify javascript output you must first install [the uglifier gem](https://github.com/lautis/uglifier) then set your Jekyll environment to production. There are two ways to do this;
+either set `env: production` in your Jekyll config, or set your shell JEKYLL_ENV to 'production' (case does not matter).
+
+Setting `uglify: true` (or false) in your Jekyll stitch config will always override any ENV setting. 
+
+If you're confused about paths and dependencies [read this](https://github.com/imathis/stitch-plus#regarding-dependencies).
+
+## 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/jekyll-stitch-plus.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-stitch-plus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-stitch-plus"
+  spec.version       = Jekyll::StitchPlusVersion::VERSION
+  spec.authors       = ["Brandon Mathis"]
+  spec.email         = ["brandon@imathis.com"]
+  spec.description   = %q{A Jekyll plugin for compiling javascripts with Stitch Plus}
+  spec.summary       = %q{A Jekyll plugin for compiling javascripts with Stitch Plus}
+  spec.homepage      = "https://github.com/octopress/jekyll-stitch-plus"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "jekyll", "~> 1.0.0"
+  spec.add_runtime_dependency "jekyll-page-hooks", "~> 1.0.2"
+  spec.add_runtime_dependency "stitch-plus", "~> 1.0.8"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/jekyll-stitch-plus.rb

@@ -0,0 +1,69 @@
+require "stitch-plus"
+require "fileutils"
+
+module Jekyll
+  class StitchPlus < Generator
+    def generate(site)
+      config = site.config
+
+      begin
+        require 'uglifier'
+        @uglifier = Uglifier.new(config['stitch']['uglify_options'])
+        if (ENV['JEKYLL_ENV'] || config['env']).downcase == 'production'
+          config['stitch']['uglify'] ||= true
+        end
+      rescue LoadError
+      end
+
+      stitch = ::StitchPlus.new(config['stitch'])
+      options = stitch.options
+
+      # Prepend source directory to file output config
+      path = File.join config['source'], options[:output]
+      stitch.set_options({output: path})
+
+      puts '' # Because Jekyll doesn't give a newline for other output
+      stitch.write
+
+      dir = File.dirname(options[:output])
+      filename = File.basename(stitch.last_write)
+
+      # Ensure the compiled file is written to the destination directory
+      site.static_files << StaticFile.new(site, site.source, dir, filename)
+
+      # Store the javascript tag for the liquid tag to retrieve
+      url = File.join (config['root'] || '/'), dir, filename
+      site.config['stitch']['js_tag'] = "<script src='#{url}'></script>"
+
+      # Don't copy static source files or deleted files to the destination directory
+      remove = stitch.all_files.map{ |f| File.join(site.source, f)}
+      remove.concat stitch.deleted
+      cleanup site, remove
+
+    end
+
+    # Remove files from Jekyll's static_files array
+    def cleanup(site, files)
+      if files.size > 0
+        site.static_files.clone.each do |sf|
+          if sf.kind_of?(Jekyll::StaticFile) and files.include? sf.path
+            site.static_files.delete(sf)
+          end
+        end
+      end
+    end
+
+
+  end
+  class StitchPlusTag < Liquid::Tag
+    def initialize(tag_name, text, tokens)
+      super
+    end
+
+    def render(context)
+      context.registers[:site].config['stitch']['js_tag']
+    end
+  end
+end
+
+Liquid::Template.register_tag('stitch_js_tag', Jekyll::StitchPlusTag)

data/lib/jekyll-stitch-plus/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module StitchPlusVersion
+    VERSION = "1.0.0"
+  end
+end

data/test/.gitignore

@@ -0,0 +1 @@
+_site

data/test/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'jekyll'
+gem 'coffee-script'
+gem 'jekyll-stitch-plus', path: "../"

data/test/_config.yml

@@ -0,0 +1,15 @@
+name: Your New Jekyll Site
+markdown: redcarpet
+pygments: true
+
+env: 'production'
+
+stitch:
+  dependencies: 
+    - 'js/lib/jquery.js'
+    - 'js/lib/underscore.js'
+    - 'js/lib'        # globs the js/lib dir
+  paths: 'js/modules' # globs the js/modules dir
+  output: 'js/site.js'
+  fingerprint: true
+

data/test/_layouts/default.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="utf-8">
+        <title>{{ page.title }}</title>
+        <meta name="viewport" content="width=device-width">
+        {% stitch_js_tag %}
+
+    </head>
+    <body>
+        {{ content }}
+    </body>
+</html>

data/test/_layouts/post.html

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+<h2>{{ page.title }}</h2>
+<p class="meta">{{ page.date | date_to_string }}</p>
+
+<div class="post">
+{{ content }}
+</div>

data/test/_plugins/jekyll-stitch-plus.rb

@@ -0,0 +1 @@
+require 'jekyll-stitch-plus'

data/test/index.html

@@ -0,0 +1,6 @@
+---
+layout: default
+title: Your New Jekyll Site
+---
+
+Test page

data/test/js/lib/foo.coffee

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

data/test/js/lib/test.js

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

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

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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-stitch-plus
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jekyll-page-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: stitch-plus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: A Jekyll plugin for compiling javascripts with Stitch Plus
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-stitch-plus.gemspec
+- lib/jekyll-stitch-plus.rb
+- lib/jekyll-stitch-plus/version.rb
+- test/.gitignore
+- test/Gemfile
+- test/_config.yml
+- test/_layouts/default.html
+- test/_layouts/post.html
+- test/_plugins/jekyll-stitch-plus.rb
+- test/index.html
+- test/js/lib/foo.coffee
+- test/js/lib/test.js
+- test/js/modules/test-module.js
+homepage: https://github.com/octopress/jekyll-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 Jekyll plugin for compiling javascripts with Stitch Plus
+test_files: []