guard-mirror 0.1.3 → 0.2.0

data/README.md

@@ -0,0 +1,94 @@
+guard-mirror
+============
+
+A CoffeeScript, Stylus, and Jade (HTML and JST) Guard that mirrors your source
+files (.coffee/.styl/.jade/.jst.jadet) in another location (public/www/etc...).
+guard-mirror also can compress the files on the fly for use in production with
+a simple `compress: true` option. Google Closure Compiler is used for JS and
+YUI Compressor for CSS. Jade -> HTML files are automatically shrinkwrapped.
+Sprockets is used for file requiring and concatination so all of the same
+Sprockets syntax can be used.
+
+I created this to help with PhoneGap/Cordova development and it's working out really nice!
+
+Installation
+------------
+
+In your `Gemfile`...
+
+```ruby
+source :rubygems
+
+gem 'guard-mirror'
+# Optionally a notifier like Growl. Syntax/parse errors will be displayed in
+# notifications which becomes very handy!
+# Use the `notify: false` option to turn this off
+# gem 'growl'
+```
+
+If you want to use nib, you'll have to have the module installed. I recommend adding a `package.json` file to your root directory with something like...
+
+```json
+{
+  "name": "app-name",
+  "version": "0.0.1",
+  "author": "Your Name <you@example.com>",
+  "dependencies": [
+    "coffee-script",
+    "stylus",
+    "nib",
+    "jade"
+  ]
+}
+```
+
+And then running...
+
+```bash
+cd to/your/root
+npm install
+```
+
+Configuration
+-------------
+
+In your `Guardfile`...
+
+```ruby
+guard :mirror,
+    paths: ['src/js/templates', 'src/js'],
+    # If a target is specified, only this file will be compiled when any
+    # watched file changes.
+    target: 'app.coffee',
+    dest: 'www',
+    compress: true do
+  watch %r{^src/js/(.+\..+)}
+end
+
+guard :mirror,
+    paths: ['src/css'],
+    target: 'app.styl',
+    dest: 'www',
+    # nib is supported with this flag
+    nib: true,
+    compress: true do
+  watch %r{^src/css/(.+\..+)}
+end
+
+guard :mirror,
+    paths: ['src/html'],
+    dest: 'www' do
+  watch(%r{^src/html/(.+\..+)}) { |m| m[1] }
+end
+```
+
+Running It
+----------
+
+```bash
+bundle update
+bundle --binstubs
+bin/guard
+```
+
+Profit!

data/lib/guard/mirror/jade/html_compiler.rb

@@ -0,0 +1,7 @@
+module ::Jade
+  class HtmlCompiler < Compiler
+    def compile(template)
+      context.eval("jade.compile(#{template.to_json}, #{@options.to_json})()")
+    end
+  end
+end

data/lib/guard/mirror/jade/template.rb

@@ -0,0 +1,18 @@
+module ::Jade
+  class Template
+
+  private
+
+    def compile_function
+      if file.end_with? '.html.jade'
+        Template.default_mime_type = 'text/html'
+        compiler = HtmlCompiler
+      else
+        Template.default_mime_type = 'application/javascript'
+        compiler = Compiler
+      end
+
+      compiler.new(client: false, filename: file).compile data
+    end
+  end
+end

data/lib/guard/mirror.rb

@@ -3,8 +3,8 @@ require 'guard/guard'
 require 'sprockets'
 require 'coffee_script'
 require 'jade'
-require "#{File.dirname __FILE__}/../jade/html_compiler.rb"
-require "#{File.dirname __FILE__}/../jade/html_template.rb"
+require_relative 'mirror/jade/html_compiler'
+require_relative 'mirror/jade/template'
 require 'stylus'
 require 'closure-compiler'
 require 'yui/compressor'
@@ -16,15 +16,25 @@ module ::Guard
       super
 
       @options = {
-        compress: false
+        notify: true
       }.merge options
 
       @env = ::Sprockets::Environment.new
+
+      # CoffeeScript is baked into sprockets so we can skip that, but register
+      # these other guys.
       @env.register_mime_type 'text/html', '.html'
-      @env.register_engine '.jade', ::Jade::HtmlTemplate
-      @env.register_engine '.jadet', ::Jade::Template
+
+      # The problem (awesomeness) with Jade is that it can export HTML or an
+      # anonymous function for use as a JST. Use `.html.jade` for HTML and
+      # `.jst.jade` for a jade template.
+      @env.register_engine '.jade', ::Jade::Template
+
       @env.register_engine '.styl', ::Tilt::StylusTemplate
 
+      # Turn on nib on demand
+      Stylus.use :nib if @options[:nib]
+
       @options[:paths].each { |path| @env.append_path path }
 
       if @options[:compress]
@@ -57,20 +67,24 @@ module ::Guard
       (@options[:target] ? [@options[:target]] : paths).each do |path|
         dest = src_to_dest path
         dirname = File.dirname dest
-        UI.info "Mirroring #{path}..."
+        UI.info "IN -> #{path}..."
         FileUtils.mkdir_p dirname unless File.directory? dirname
         File.open(dest, 'w') do |f|
           f.write(
             begin
               @env[path]
             rescue => e
-              Notifier.notify e.message, title: 'guard-mirror', image: :failed
+              if @options[:nofify]
+                Notifier.notify e.message,
+                  title: 'guard-mirror',
+                  image: :failed
+              end
               UI.error e.message
               e.message
             end
           )
         end
-        UI.info "Saved to #{dest}."
+        UI.info "OUT -> #{dest}"
       end
     end
 
@@ -78,9 +92,9 @@ module ::Guard
 
     def src_to_dest path
       path = path
-        .sub(/\.coffee|\.jst\.jadet/, '.js')
+        .sub(/\.coffee|\.jst\.jade/, '.js')
         .sub(/\.styl/, '.css')
-        .sub /\.jade/, '.html'
+        .sub /\.html\.jade/, '.html'
       File.expand_path "#{@options[:dest]}/#{path}"
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-mirror
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -146,9 +146,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- lib/guard/mirror/jade/html_compiler.rb
+- lib/guard/mirror/jade/template.rb
 - lib/guard/mirror.rb
-- lib/jade/html_compiler.rb
-- lib/jade/html_template.rb
 homepage: https://github.com/caseywebdev/guard-mirror
 licenses: []
 post_install_message: 

data/lib/jade/html_compiler.rb

@@ -1,8 +0,0 @@
-module ::Jade
-  class HtmlCompiler < Compiler
-    def compile(template)
-      template = template.read if template.respond_to?(:read)
-      template = context.eval("jade.compile(#{template.to_json}, #{@options.to_json})()")
-    end
-  end
-end

data/lib/jade/html_template.rb

@@ -1,11 +0,0 @@
-module ::Jade
-  class HtmlTemplate < Template
-    self.default_mime_type = 'text/html'
-
-  private
-
-    def compile_function
-      Jade::HtmlCompiler.new(client: false, filename: file).compile data
-    end
-  end
-end