guard-stitch-plus 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzM4NjBmN2UxMDQyYjM3NzliMWM4NzM5ZDdlNDMzOTkyMTY5OTE5Nw==
+    ZjQ4NjZhNzM4NDM5NTMyNzkxMTI4ZTY3MmRkZmViYzQyNjc2ZDUxYQ==
   data.tar.gz: !binary |-
-    MjQ1NWVmZDUxZWUwMDg4NDA4NGU1Y2NmNGUxMzU0MGQ3ZGM5OTBiNw==
+    OTk0NDNhZjhhZmNlZWJhMTUzOGU3MWE2OGMxYTI5M2ZiMjc1NDllYg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OGFlODFkMDMzYzc2MDBiMWYxMDMyMmFkNGJiYjk4ZDI5NTEwZmRmYzM1MjJi
-    M2NhNmY1M2U1OTI1MzUzZGZhZjRlMzM4MjI3ZDM3ZDM2NDUxZmE1MjJhMmNk
-    MTA0MzYzZDJmYTI3OGEwMDhiMzc5NDcxMmQzMDI1ZDliMGFiZWI=
+    YTc2MTUyYmM5NmFhOTE5ZmExYWU4YTIxOTAxMWU1MGE0YTA4MjE3OTY2OTg5
+    MjBjN2YwMjMxNTdiY2E0ZWMwN2JjOWJiMGVjNzI1NDYwNjJmYmE3ZWNmNjY5
+    OWRlNDBkNWZiODYyMjZhMmQzM2YzMmMyZmEyZDIxNjkxOGQxYjE=
   data.tar.gz: !binary |-
-    ZmU5MmY2NGI0MWI4YmM4ZDkyYTAzYzNlMzVmZWI0YTRmMTEzOTkxNmNmNGM0
-    ZDMxZmM3OWU3YTQwNDJlZjA3ZGM3ZTA4OGY4OWU2ZTZlMDc0OGE2NzkxMGYy
-    MWJlYzM4M2M3YzVlZDRjNGQ1ZjdhOTNhYjRlYjcyMWQwMzQ5ODI=
+    NzQzNWVkYjdlZWM0MmJmMzliNDQ2Yzg5ZmM2ODZkNDM3MWJiMmViNGQ4Yjhh
+    MzIyMmI4OWVjOTA3YTE4NmQ4NjkyNjI5NGQ4ZmY2Mzk4OTMyN2JjN2YyMjI3
+    NmE5MmVjNTg3MTc2NmM0MDdjMmEyZDE0NDEyMjFkYWNhNmIzYjc=

data/.gitignore

@@ -17,3 +17,5 @@ test/version_tmp
 tmp
 .DS_Store
 test/javascripts/*.js
+_site
+js/*.js

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 1.0.0
+- initial release
+
+## 1.1.0
+- Added compatibility with jekyll-stitch-plus.
+- Added compatibility with guard-jekyll-plus.
+- Now handling file additions and removals correctly.

data/README.md

@@ -1,12 +1,12 @@
-# Guard::Stitchplus
+# Guard Stitch Plus
 
-Write a gem description
+A guard compiling and uglifying javascripts, powered by [stitch-plus](https://github.com/imathis/stitch-plus).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'guard-stitchplus'
+    gem 'guard-stitch-plus'
 
 And then execute:
 
@@ -14,11 +14,82 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install guard-stitchplus
+    $ gem install guard-stitch-plus
 
 ## Usage
 
-Write usage instructions here
+Add this guard to your Guardfile with `guard init stitch-plus`. Here's a sample Guardfile.
+
+```ruby
+stitch_config = {
+  output: 'javascripts/site.js',
+  dependencies: [
+    'javascripts/lib/jquery.js',
+    'javascripts/lib'
+  ],
+  paths: ['javascripts/modules'],
+  fingerprint: true,
+  uglify: true
+}
+
+guard 'stitch-plus', stitch_config do
+  watch /^javascripts/
+end
+```
+
+Whenever the guard is loaded or when a javascript file changes which is being watched, stitch-plus will:
+
+1. Add jquery.js, followed by any other javascript or coffeescript file in `javascripts/lib/`.
+2. Add a Require function and wrap all files in `javascripts/modules` in a CommonJS wrapper.
+3. Uglify the compiled javascript.
+4. Write it to a fingerprinted file at `javascripts/site-f1408932717b4b16eb97969d34961213.js`.
+
+### Using this with Jekyll?
+
+If you're using Jekyll, be sure to check out [jekyll-stitch-plus](https://github.com/octopress/jekyll-stitch-plus) which integrates smoothly with jekyll and also plays
+nicely with this guard plugin. In that case be sure to add your stitch-plus configuration to your Jekyll config file (usually _config.yml) and point your guard to that
+file as well.
+
+Your Jekyll YAML config file might look like this.
+
+```yaml
+stitch:
+  output: 'javascripts/site.js'
+  dependencies: 
+    - 'javascripts/lib/jquery.js'
+    - 'javascripts/lib'
+  paths: ['javascripts/modules']
+  fingerprint: true
+  uglify: true
+```
+
+Then your Guardfile would look like this.
+
+```ruby
+guard 'stitch-plus', config: '_config.yml' do
+  watch /^(javascripts|_config.yml)/
+end
+```
+
+Notice that the guard is also watching the Jekyll config file.
+
+## Configuration
+
+Configure stitch-plus by passing a hash of options or pointing it to a YAML config file. 
+
+| Config           | Description                                                                | Default     |
+|:-----------------|:---------------------------------------------------------------------------|:------------|
+| `config`         | A path to a YAML file containing stitch configurations                     | nil         |
+| `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. | {}       |
+
+Note: You can configure from the hash and a yaml file, but configurations loaded from a YAML file will override any settings in your config hash. For example, `{config: 'stitch.yml', uglify: false}` will be overwritten if the yaml file sets `uglify: true`.
+
 
 ## Contributing
 
@@ -27,3 +98,29 @@ Write usage instructions here
 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/lib/guard/stitch-plus.rb

@@ -6,23 +6,57 @@ module Guard
 
     def initialize (watchers=[], options={})
       super
-      @stitcher = ::StitchPlus.new(options.merge({guard: true}))
+      @options = options
     end
 
     def start
-      @stitcher.write
+      @stitcher = ::StitchPlus.new(@options.merge({guard: true}))
+      ENV['GUARD_STITCH_PLUS'] = 'true'
+      @stitch_files = stitch_files
+      write
     end
 
     def reload
-      @stitcher.write
+      write
     end
 
     def run_all
-      @stitcher.write
+      write
     end
 
-    def run_on_changes(_)
+    def run_on_removals(paths)
+      if (paths & @stitch_files).size > 0
+        write
+      end
+    end
+
+    def run_on_additions(paths)
+      @stitch_files = stitch_files
+      if (paths & @stitch_files).size > 0
+        write
+      end
+    end
+
+    def run_on_changes(paths)
+      @stitch_files = stitch_files
+      if @options[:config] and paths.include? @options[:config]
+        start
+      elsif (paths & @stitch_files).size > 0
+        write
+      end
+    end
+
+    def write
       @stitcher.write
+      ENV['GUARD_STITCH_PLUS_OUTPUT'] = @stitcher.last_write
+    end
+
+    private
+    
+    def stitch_files
+      all_files = @stitcher.all_files
+      ENV['GUARD_STITCH_PLUS_FILES'] = all_files.join(',')
+      all_files
     end
   end
 end

data/lib/guard/stitch-plus/templates/Guardfile

@@ -1,4 +1,16 @@
-guard 'stitch-plus', :dependencies => ['javascripts/dependencies/**/*'], :paths => ['javascripts/modules'] do
-  watch /^javascripts/
+# Read more about stitch-plus configuration at https://github.com/imathis/guard-stitch-plus
+#
+stitch_config = {
+  dependencies: [
+    'javascripts/lib/jquery.js',
+    'javascripts/lib'
+  ],
+  paths: ['javascripts/modules'],
+  output: 'javascripts/site.js',
+  uglify: true
+}
+
+guard 'stitch-plus', stitch_config do
+  watch /javascripts/
 end
 

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

@@ -1,5 +1,5 @@
 module Guard
   module StitchPlusVersion
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/test/Gemfile

@@ -1,6 +1,9 @@
 source 'https://rubygems.org'
 
-gem 'guard-stitch-plus', :path => "../"
-gem 'coffee-script'
+gem 'jekyll'
+gem 'guard-jekyll-plus'
+gem 'jekyll-stitch-plus'
+gem 'guard-stitch-plus', path: '../'
 gem 'uglifier'
-
+gem 'coffee-script'
+gem 'redcarpet'

data/test/Guardfile

@@ -1,7 +1,21 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'stitch-plus', config: 'stitch.yml' do
-  watch /^javascripts/
+
+# Add 
+stitch_config = {
+  dependencies: ['js/lib'],
+  paths: ['js/modules'],
+  output: 'js/site.js',
+  uglify: true
+}
+guard 'stitch-plus', stitch_config do
+  watch /js/
+end
+
+
+guard "jekyll-plus" do
+  watch /.*/
+  ignore %r{^_site/}
 end
 

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,12 @@
+<!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/_plugins/stitch-plus.rb

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

data/test/index.html

@@ -0,0 +1,13 @@
+---
+layout: default
+title: Your New Jekyll Site
+---
+
+<div id="home">
+  <h1>Blog Posts</h1>
+  <ul class="posts">
+    {% for post in site.posts %}
+      <li><span>{{ post.date | date_to_string }}</span> &raquo; <a href="{{ post.url }}">{{ post.title }}</a></li>
+    {% endfor %}
+  </ul>
+</div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-stitch-plus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-17 00:00:00.000000000 Z
+date: 2013-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -56,10 +57,13 @@ files:
 - lib/guard/stitch-plus/version.rb
 - test/Gemfile
 - test/Guardfile
-- test/javascripts/dependencies/foo.coffee
-- test/javascripts/dependencies/test.js
-- test/javascripts/modules/test-module.js
-- test/stitch.yml
+- test/_config.yml
+- test/_layouts/default.html
+- test/_plugins/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/imathis/guard-stitch-plus
 licenses:
 - MIT

data/test/stitch.yml

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