guard-yield 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60a538e31149860b0a0877b63fe892f945c849c0
+  data.tar.gz: dca6f2aa3c6fa7643493a183da8d1fe5303a9542
+SHA512:
+  metadata.gz: 01ce9fbc2d6418571b950b7cb54724d29728ae753c459d89b254b61c052482e3d4561ea5a7732a9bda83cb299ec5e8ae9fa1cda15632c746ef23723766ab2740
+  data.tar.gz: 788d76725ca9801c5d93cb2c24d7813a2ef682a21ddc018ee0ace63530c1db1c034b3331d456a385da50628d6827f96f6f8e6f501331855cacde977c7b127867

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.2
+sudo: false

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in guard-yield.gemspec
+gemspec development_group: :gem_build_tools
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec', '~> 4.5', '>= 4.5.2'
+end
+
+group :gem_build_tools do
+  gem "rake", "~> 10.0"
+  gem "rspec", "~> 3.2"
+end

data/Guardfile

@@ -0,0 +1,48 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Cezary Baginski
+
+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,147 @@
+# Guard::Yield
+
+[![Build Status](https://travis-ci.org/e3/guard-yield.png?branch=master)](https://travis-ci.org/e2/guard-yield)
+[![Gem Version](http://img.shields.io/gem/v/guard-yield.svg)](http://badge.fury.io/rb/guard-yield)
+e
+
+A Guard pseudo-plugin to conveniently run *any* Ruby code - straight from your
+Guardfile (without writing your own plugin).
+
+## Installation
+
+in your Gemfile:
+
+```ruby
+group :development do
+  gem 'guard-yield'
+end
+```
+
+Install with:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install guard-yield
+
+
+## Usage
+
+Add snippets to your `Guardfile` with:
+
+    $ bundle exec guard init yield
+
+Then, edit/remove them and run:
+
+    $ bundle exec guard
+
+## Quick example
+
+```ruby
+  md5_summer = proc { |_, _, files| puts `md5sum #{files * ' '}` }
+  guard :yield, run_on_modifications: md5_summer do
+    watch('foo.rb')
+    watch('bar.rb')
+    watch('baz.rb')
+  end
+```
+
+Yes, you don't need to resort to hax with the `watch()` block or creating
+inline Guard plugins in your Guardfile. Especially for local one-shot pieces of
+code like this.
+
+## Tips
+
+Aside from supporting all the methods for Guard::Plugin:
+
+```
+:start
+:stop
+:run_all
+:reload
+:run_on_additions
+:run_on_modifications
+:run_on_removals
+:run_on_changes
+```
+
+there's a special `:object` option, that allows you to pass any object you like
+to *all* the methods.
+
+(Just check the logger example in the Guardfile).
+
+This means you can conveniently use any Ruby library inside your Guardfile -
+without writing a Guard plugin as a wrapper for it.
+
+Also, remember to use Guard's `throw(:task_has_failed)` to flag an error
+(otherwise Guard will disable your guard), e.g. :
+
+```ruby
+  my_syntax_checker = proc do |_, _, changes|
+    changes.each do |file|
+      system("ruby -c #{file}") || throw(:task_has_failed) # IMPORTANT!
+    end
+  end
+
+  guard :yield, run_on_modifications: &my_syntax_checker do
+    watch('foo.rb')
+    watch('bar.rb')
+  end
+```
+
+
+## FAQ
+
+> "Why not use the watch() block for running code?"
+
+1. That's not what it's for (you need the `return nil` hack at least)
+2. You don't have access to the guard object (even if it's your own)
+3. You can't pass data to the block (you just have the file)
+4. The dsl has it's own namespace - guard-yield side-steps that
+5. This cleanly separates rules (which can get complex) from behavior
+6. It really is just for substituting one change for another (not for code)
+
+Here's an example anyway (NOT RECOMMENDED!):
+
+```ruby
+# nil to prevent plugin for doing anything itself
+watch("foo.*") { |m| `cp #{m} #{m}.backup`; nil }
+```
+
+> "Why not use an inline Guard plugin inside the Guardfile?"
+
+Usually it's the Object-Oriented way to do things, and it's likely easier to
+extract into a gem.
+
+But if you don't want to create a full-blown gem, or you want the logic to be
+local, verbose and concise ... guard-yield will help.
+
+And as above - guard-yield allows you to prototype an interface to any Ruby
+library and use that directly in your Guardfile - and often with less code,
+classes and methods to get the job done.
+
+> "Why not just create a gem/lib for every task like that?"
+
+One reason is - you may quickly end up with too many gems to maintain (for no
+reason), while those gems will just be a thin, minimal front-end to a complex
+Ruby library.
+
+Basically it all boils down to how many options you want your guard plugin to
+handle - and how complex handling them is.
+
+Not every use case can be extracted into a nice generic gem useful for many
+people - that's why I created this gem.
+
+Have fun!
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/guard-yield.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "guard/yield"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/guard-yield.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/yield/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-yield"
+  spec.version       = Guard::Yield::VERSION
+  spec.authors       = ["Cezary Baginski"]
+  spec.email         = ["cezary@chronomantic.net"]
+
+  spec.summary       = %q{Guard plugin for running custom Ruby code}
+  spec.description   = %q{This plugin allows you to run any Ruby code within Guard - without writing your own plugin}
+  spec.homepage      = "https://github.com/guard/guard-yield"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('guard-compat', '~> 1.0')
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+end

data/lib/guard/yield.rb

@@ -0,0 +1,32 @@
+require "guard/compat/plugin"
+
+module Guard
+  class Yield < Plugin
+    PLUGIN_METHODS = %i(start stop run_all reload run_on_additions
+    run_on_modifications run_on_removals run_on_changes)
+
+    VALID_GUARD_OPTIONS = %i(watchers group callbacks)
+
+    VALID_OPTIONS = %i(object)
+
+    def initialize(options={})
+      valid_options = PLUGIN_METHODS + VALID_OPTIONS + VALID_GUARD_OPTIONS
+      options.keys.each do |key|
+        unless valid_options.include?(key)
+          raise ArgumentError, "Unknown option: #{key.inspect}"
+        end
+      end
+
+      super
+    end
+
+    PLUGIN_METHODS.each do |name|
+      define_method(name) do |*args|
+        block = self.options.fetch(name, nil)
+        next unless block
+        object = self.options.fetch(:object, self)
+        block.call object, name, *args
+      end
+    end
+  end
+end

data/lib/guard/yield/templates/Guardfile

@@ -0,0 +1,29 @@
+# Example 1: Run a single command whenever a file is added
+
+notifier = proc do |title, _, changes|
+  Guard::Notifier.notify(changes * ",", title: title )
+end
+
+guard :yield, { run_on_additions: notifier, object: "Add missing specs!" } do
+  watch(/^(.*)\.rb$/) { |m| "spec/#{m}_spec.rb" }
+end
+
+# Example 2: log all kinds of changes
+
+require 'logger'
+yield_options = {
+  object: ::Logger.new(STDERR), # passed to every other call
+
+  start: proc { |logger| logger.level = Logger::INFO },
+  stop: proc { |logger| logger.info "Guard::Yield - Done!" },
+
+  run_on_modifications: proc { |log, _, files| log.info "!! #{files * ','}" },
+  run_on_additions: proc { |log, _, files| log.warn "++ #{files * ','}" },
+  run_on_removals: proc { |log, _, files| log.error "xx #{files * ','}" },
+}
+
+guard :yield, yield_options do
+  watch(/^(.*)\.css$/)
+  watch(/^(.*)\.jpg$/)
+  watch(/^(.*)\.png$/)
+end

data/lib/guard/yield/version.rb

@@ -0,0 +1,8 @@
+require "guard/compat/plugin"
+require "guard/yield"
+
+module Guard
+  class Yield < Plugin
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: guard-yield
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cezary Baginski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: This plugin allows you to run any Ruby code within Guard - without writing
+  your own plugin
+email:
+- cezary@chronomantic.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- guard-yield.gemspec
+- lib/guard/yield.rb
+- lib/guard/yield/templates/Guardfile
+- lib/guard/yield/version.rb
+homepage: https://github.com/guard/guard-yield
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Guard plugin for running custom Ruby code
+test_files: []