guard-preserves 0.1.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Rebel
+
+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,55 @@
+# Guard::Preserves
+
+This gem allows you to make changes to files in the preserves repository and
+have those changes automatically compiled if in a coffeescript file. The
+resulting files will then be copied to a directory with the same name as the
+modified package located in the directory specified by the `destination`
+option.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'guard-preserves'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+The `destination` must be provided. An optional `app_root` can be set, but
+defaults to the location of the Guardfile. If no watch is provided, all
+`.js` and `.coffee` files in the directory will be watched.
+
+````ruby
+guard 'preserves', destination: 'public/foo/lib' do
+  #optional watch('foo/src/foo.coffee')
+end
+````
+
+To start the guard run:
+
+````
+bundle exec guard --watchdir [absolute path to directory to watch]  --guardfile [absolute path to directory with guardfile]
+````
+
+For example, given a Rails application named 'cool-stuff' in the same parent
+directory as the preserves repo with the jam assets stored in
+`app/assets/javascripts/lib` with a Guardfile named
+`Preserves-Guardfile` that looks like
+
+````
+guard 'preserves', destination: 'app/assets/javascripts/lib'
+````
+
+run `bundle exec guard --watchdir ~/source/preserves --guardfile ~/source/cool-stuff/Preserves-Guardfile` to start the guard.
+
+
+## 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

data/Rakefile

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

data/guard-preserves.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/preserves/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-preserves"
+  spec.version       = Guard::PreservesVersion::VERSION
+  spec.authors       = ["Chris Rebel", "Colin Rymer"]
+  spec.email         = ["chrebel@gmail.com", "colin.rymer@gmail.com"]
+  spec.description   = %q{This gem provides a guard plug-in to watch the Preserves repo and compile/copy js files to the project it is included in.}
+  spec.summary       = %q{Preserves compiler/copier guard plugin}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'guard'
+end

data/lib/guard/preserves.rb

@@ -0,0 +1,118 @@
+require 'guard'
+require 'guard/guard'
+require 'json'
+require 'fileutils'
+
+module Guard
+  class Preserves < Guard
+    attr_reader :app_root, :destination
+    # Initializes a Guard plugin.
+    # Don't do any work here, especially as Guard plugins get initialized even if they are not in an active group!
+    #
+    # @param [Array<Guard::Watcher>] watchers the Guard plugin file watchers
+    # @param [Hash] options the custom Guard plugin options
+    # @option options [Symbol] group the group this Guard plugin belongs to
+    # @option options [Boolean] any_return allow any object to be returned from a watcher
+    #
+    def initialize(watchers = [], options = {})
+      @destination = options[:destination]
+      @app_root = options[:app_root] || File.dirname(::Guard.options[:guardfile])
+      watchers = [::Guard::Watcher.new(%r{^.+\.(js|coffee)$})] if watchers.empty?
+
+      super
+    end
+
+    # Called once when Guard starts. Please override initialize method to init stuff.
+    #
+    # @raise [:task_has_failed] when start has failed
+    # @return [Object] the task result
+    #
+    def start
+    end
+
+    # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
+    #
+    # @raise [:task_has_failed] when stop has failed
+    # @return [Object] the task result
+    #
+    def stop
+    end
+
+    # Called when `reload|r|z + enter` is pressed.
+    # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
+    #
+    # @raise [:task_has_failed] when reload has failed
+    # @return [Object] the task result
+    #
+    def reload
+    end
+
+    # Called when just `enter` is pressed
+    # This method should be principally used for long action like running all specs/tests/...
+    #
+    # @raise [:task_has_failed] when run_all has failed
+    # @return [Object] the task result
+    #
+    def run_all
+    end
+
+    # Default behaviour on file(s) changes that the Guard plugin watches.
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_change has failed
+    # @return [Object] the task result
+    #
+    def run_on_changes(paths)
+    end
+
+    # Called on file(s) additions that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_additions has failed
+    # @return [Object] the task result
+    #
+    def run_on_additions(paths)
+    end
+
+    # Called on file(s) modifications that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_modifications has failed
+    # @return [Object] the task result
+    #
+    def run_on_modifications(paths)
+      paths.each do |path|
+        package = package_name(path)
+        compile_package package if File.extname(path) == '.coffee'
+        copy_package package if File.extname(path) == '.js'
+      end
+    end
+
+    # Called on file(s) removals that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_removals has failed
+    # @return [Object] the task result
+    #
+    def run_on_removals(paths)
+    end
+
+    private
+    def package_name(path)
+      path.split('/').first
+    end
+
+    def compile_package(package)
+      ::Guard::UI.info "Compiling #{package}"
+      Dir.chdir package
+      `coffee -c --output ./ src/`
+      Dir.chdir '..'
+    end
+
+    def copy_package(package)
+        package_destination = File.join(app_root, destination, package)
+        ::Guard::UI.info "Copying #{package} to #{package_destination}"
+        FileUtils.mkdir_p package_destination
+        FileUtils.cp_r("#{package}/.", package_destination)
+    end
+  end
+end

data/lib/guard/preserves/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module PreservesVersion
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: guard-preserves
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Rebel
+- Colin Rymer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  name: bundler
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: rake
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: guard
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: This gem provides a guard plug-in to watch the Preserves repo and compile/copy
+  js files to the project it is included in.
+email:
+- chrebel@gmail.com
+- colin.rymer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-preserves.gemspec
+- lib/guard/preserves.rb
+- lib/guard/preserves/version.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Preserves compiler/copier guard plugin
+test_files: []