guard-hologram 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bdc168d46de456a5feca932b3924cf15e5c425b8
+  data.tar.gz: 3957a3f6d387a7a527fff388fa63a36adc20fd9e
+SHA512:
+  metadata.gz: c835b3562802989522918e8160b71f8d8cfbbd159302c3797ada65fb910e50441ae73bcb519bf615dccf3aeb999b5491cfae27b8e97e11d071cc654a1a6d048d
+  data.tar.gz: c22c09e5294eefa69e6fba457199e86b0b2788dbb50e515e9b31272b405b8c2707cbe3cd9b6bfa8899ddd7da6aaaae0b20e7d6d6d5130e9ece0716b5b49fad7a

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ken Mayer
+
+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,49 @@
+# Guard::Hologram
+
+Guard plugin for the https://github.com/trulia/hologram gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'guard-hologram', :require => false
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install guard-hologram
+
+## Setup
+
+    guard init
+    
+## Usage
+
+    bundle exec guard
+    
+## Configuration
+
+    | Option      | Definition                               | Default             |
+    |-------------|------------------------------------------|---------------------|
+    | config_path | relative path to your configuration file | hologram_config.yml |
+    
+### Sample Guardfile
+
+```ruby
+guard "hologram", config_path: "hologram.yml" do
+  watch(%r{app/assets/stylesheets/.*css})
+  watch(%r{app/views/docs/styleguide/doc_assets/.+})
+  watch('hologram.yml')
+end
+```
+
+## 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-hologram.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/hologram/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-hologram"
+  spec.version       = Guard::HologramVersion::VERSION
+  spec.authors       = ["Ken Mayer", "Greg Cobb"]
+  spec.email         = ["ken@bitwrangler.com"]
+  spec.description   = %q{Guard plugin for the Hologram gem (https://github.com/trulia/hologram)}
+  spec.summary       = %q{Guard plugin for the Hologram gem}
+  spec.homepage      = "https://github.com/kmayer/guard-hologram"
+  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_dependency "guard", "~> 2.0"
+  spec.add_dependency "hologram"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/guard/hologram.rb

@@ -0,0 +1,99 @@
+require "guard/hologram/version"
+require "guard"
+require "guard/plugin"
+
+module Guard
+  class Hologram < Plugin
+    include HologramVersion
+    attr_reader :options
+
+    DEFAULT_OPTIONS = {
+      config_path: "hologram_config.yml"
+    }
+    # 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 [Hash] options the custom Guard plugin options
+    # @option options [Array<Guard::Watcher>] watchers the Guard plugin file watchers
+    # @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(options = {})
+      super
+      @options = DEFAULT_OPTIONS.merge(options)
+    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
+      system *"bundle exec hologram #{options[:config_path]}".split or throw :task_has_failed
+    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)
+      run_all
+    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)
+      run_all
+    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)
+      run_all
+    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
+  end
+end

data/lib/guard/hologram/templates/Guardfile

@@ -0,0 +1 @@
+guard "hologram"

data/lib/guard/hologram/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module HologramVersion
+    VERSION = "1.0.0"
+  end
+end

data/spec/guard/hologram_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+module Guard
+  describe Hologram do
+    let(:options) { {} }
+    subject(:hologram) { Guard::Hologram.new(options) }
+
+    describe "#start" do
+      it "does not call #run_all" do
+        hologram.should_not_receive(:run_all)
+        hologram.start
+      end
+    end
+
+    describe "#run_all" do
+      it "builds the styleguide" do
+        hologram.should_receive(:system).with(*"bundle exec hologram hologram_config.yml".split) { true }
+        hologram.run_all
+      end
+
+      context "with a custom config option" do
+        let(:options) { {config_path: "path/to/config/file.yml"} }
+
+        it "builds the styleguide" do
+          hologram.should_receive(:system).with(*"bundle exec hologram path/to/config/file.yml".split) { true }
+          hologram.run_all
+        end
+      end
+
+      it "raises an error if the build fails" do
+        hologram.should_receive(:system) { false }
+        expect { hologram.run_all }.to throw_symbol(:task_has_failed)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec'
+require 'guard/hologram'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  config.before(:each) do
+    ENV["GUARD_ENV"] = 'test'
+  #  @fixture_path = Pathname.new(File.expand_path('../fixtures/', __FILE__))
+    @lib_path = Pathname.new(File.expand_path('../../lib/', __FILE__))
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: guard-hologram
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ken Mayer
+- Greg Cobb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: hologram
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Guard plugin for the Hologram gem (https://github.com/trulia/hologram)
+email:
+- ken@bitwrangler.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-hologram.gemspec
+- lib/guard/hologram.rb
+- lib/guard/hologram/templates/Guardfile
+- lib/guard/hologram/version.rb
+- spec/guard/hologram_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kmayer/guard-hologram
+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.14
+signing_key: 
+specification_version: 4
+summary: Guard plugin for the Hologram gem
+test_files:
+- spec/guard/hologram_spec.rb
+- spec/spec_helper.rb