guard-steering 0.0.2 → 0.0.3

data/README.md

@@ -1,38 +1,56 @@
-# Guard::Steering
+# Guard::Steering [![Build Status](https://secure.travis-ci.org/daaain/guard-steering.png)](http://travis-ci.org/daaain/guard-steering) [![Dependency Status](https://gemnasium.com/daaain/guard-steering.png)](https://gemnasium.com/daaain/guard-steering) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/daaain/guard-steering)
 
-Lets you configure a Guard that will run [Steering](https://github.com/pixeltrix/steering) whenever a [Handlebars.js](https://github.com/wycats/handlebars.js) template is added / updated.
+## About
+
+Lets you set up a [Guard](https://github.com/guard/guard) that will run [Steering](https://github.com/pixeltrix/steering) whenever a [Handlebars.js](https://github.com/wycats/handlebars.js) template is added / updated.
+
+The reason this Gem was born is developing a HTML5 based desktop application which relies on static compilation. Still wanting to get the benefit of having fast Handlebars templating, precompilation is now done development time instead of loading the templates and letting the full runtime JS do the work.
 
 ## Usage
 
-Edit the Gemfile so that it looks like:
+### Guardfile
+
+For some comprehensive examples and explanation see [Guard-Steering-examples](https://github.com/daaain/guard-steering-examples) or in case you're familiar with Handlebars and Guard just read on.
+
+Point the Guard watcher to your Handlebars template folder, set up the output folder in the options part and you're all set! Note: at the moment Guard::Steering won't rebuild your folder structure.
+
+	guard 'steering', :output_folder => "build/handlebars" do
+	 	watch(%r{^source/handlebars/.*\.handlebars$})
+	end
+
+### Gemfile
 
     source "http://rubygems.org"
     gem "guard"
-    gem "steering",
-        :git => 'git://github.com/daaain/steering.git', 
-        :branch => 'master'
-    gem 'guard-steering'
+    gem "steering"
+    gem "guard-steering"
 
-Note: Steering Gem needs to be able to work with files, at the moment that only works in [my fork](https://github.com/daaain/steering) (pull request pending).
-
-Then on your favourite shell type:
+### Set up Guard and let it run
 
     $ bundle install
-    $ bundle exec guard init
     $ bundle exec guard init steering
     $ bundle exec guard
 
-## Guardfile
+## Todo
 
-You can adapt your 'view' files like you want. Please read Guard doc for more info about Guardfile DSL.
-
-	guard 'steering', :output_folder => "build/handlebars" do
-	 	watch(%r{^source/handlebars/.*\.handlebars$})
-	end
+* Finish test suite
+* Fix bug with empty template being generated for deleted file
+* Add an example - WIP at https://github.com/daaain/guard-steering-sample
+* Investigate supporting rebuilding of folder tree in output folder from inside source folder
+* Add silent option
 
 ## Changelog
 
-### 0.0.2
+### 0.0.3
+* Got Travis working
+* Set tests up (still need to cover actual functionality)
+* Cleaned up documentation
+* Now compatible with [Guard 1.1+](https://github.com/guard/guard/wiki/Upgrade-guide-for-existing-guards-to-Guard-v1.1) APIs
+* Added 'register_partials' option, which automatically registers templates as partials too
+* Made it work with [static Guard compilation](https://github.com/guard/guard/wiki/Guard-Cookbook), so can be used from Rake or even a simple Ruby script
+* Fixed bug with 'run_at_start' option
+
+### 0.0.2 – last version to support Guard 1.0.x
 
 * Added versions to Gem dependencies.
 * Removed 'handlebars' extension requirement, this is now left to Guard watch pattern to filter.
@@ -41,4 +59,34 @@ You can adapt your 'view' files like you want. Please read Guard doc for more in
 
 ### 0.0.1
 
-Initial version.
+Initial version.
+
+## Sponsored by
+<a href="http://ustwo.co.uk">![ustwo™](http://cache.ustwo.co.uk/wordpress/wp-content/themes/ustwo1.4/images/logo.png)</a>
+
+ustwo™ design studios
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2012 Daniel Demmel, ustwo™
+
+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/steering.rb

@@ -13,15 +13,21 @@ module Guard
       super
       @options = {
         :run_at_start => true,
-        :output_folder => nil
+        :output_folder => nil,
+        :register_partials => false
       }.update(options)
+
+      @output_folder = !@options[:output_folder].nil? && @options[:output_folder]
+      # FIXME: if :output_folder is not defined "TypeError: can't convert false into String'" happens on the next line
+      Dir.mkdir(@output_folder) if !File.directory?(@output_folder) && !@output_folder.nil?
     end
 
     # Call once when Guard starts. Please override initialize method to init stuff.
     # @raise [:task_has_failed] when start has failed
     def start
-      UI.info("Guard::Steering has started watching your files")
-      run_all if options[:run_at_start]
+      UI.info("Guard::Steering has started watching your files with output folder set to '#{@output_folder}' (in case of 'nil' templates will be compiled to the folder where they are)")
+
+      run_all if @options[:run_at_start]
     end
 
     # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
@@ -33,7 +39,6 @@ module Guard
     # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
     # @raise [:task_has_failed] when reload has failed
     def reload
-      run_all
     end
 
     # Called when just `enter` is pressed
@@ -42,30 +47,34 @@ module Guard
     def run_all
       paths = Dir.glob("**/*.*")
       targets = Watcher.match_files(self, paths)  
-      run_on_change targets
+      run_on_changes targets
     end
 
-    # Called on file(s) modifications that the Guard watches.
+    # Called on file(s) changes that the Guard watches.
     # @param [Array<String>] paths the changes files or paths
-    # @raise [:task_has_failed] when run_on_change has failed
-    def run_on_change(paths)
-      run_steering paths
+    # @raise [:task_has_failed] when run_on_changes has failed
+    def run_on_changes(paths)
+      paths.each do |path|
+          # use output_folder or default back to watched file location
+          run_steering(path, @output_folder || File.dirname(path))
+      end
     end
 
     # Called on file(s) deletions that the Guard watches.
     # @param [Array<String>] paths the deleted files or paths
     # @raise [:task_has_failed] when run_on_change has failed
-    def run_on_deletion(paths)
+    def run_on_removals(paths)
+      paths.each do |path|
+        output_folder = @output_folder || File.dirname(path)
+        File.exists?(output_folder + "/" + File.basename(path) + ".js")
+        UI.info "Steering deleted #{File.basename(path)}.js from #{output_folder}"
+      end
     end
     
-    def run_steering(paths)
+    def run_steering(path, output_folder)
       begin
-        paths.each do |path|
-          output_folder = (!@options[:output_folder].nil? && @options[:output_folder]) || File.dirname(path)
-          Dir.mkdir(output_folder) unless File.directory?(output_folder)
-          ::Steering.compile_to_file(path, output_folder + "/" + File.basename(path) + ".js")
-          UI.info "Steering precompiled #{path} to #{output_folder}"
-        end
+        ::Steering.compile_to_file(path, output_folder + "/" + File.basename(path) + ".js", {:extension => '.handlebars', :partial => @options[:register_partials]})
+        UI.info "Steering precompiled #{path} to #{output_folder}"
       rescue Exception => e
         UI.error "Steering precompilation failed: #{e}"
         false

data/lib/guard/steering/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Guard
   module SteeringVersion
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-steering
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,56 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-10 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: steering
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-- !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.10.0
-  type: :development
+        version: 1.2.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 1.2.0
 description: Guard::Steering automatically runs the steering gem to precompile Handlebars.js
   templates
 email: