guard-compat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e239e5c4419c41da77a177d350c96c06492aaca6
+  data.tar.gz: e3913cafe922668c788278b72f59d00037cae4fb
+SHA512:
+  metadata.gz: 5e55139a5d038f3c4bf67af5ae3615ccaa273c466ca45f7ba372a09a217c37d5594583ca2baed30d13079849f819271386c39de69e4f79aa8825e735cf893024
+  data.tar.gz: 949dc35946c588259b2b3eebe9d4b7f954b8b0fac40092e921cffd25df28fb16819c35e3d2ac6ca6d37b01e84caa1394d6282de841bebdc777c670471584b6c2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format doc

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from:
+  - .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - guard-compat.gemspec

data/.rubocop_todo.yml

@@ -0,0 +1,10 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-12-05 08:15:00 +0100 using RuboCop version 0.27.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in guard-compat.gemspec
+gemspec
+
+group :development do
+  gem 'rspec', require: false
+  gem 'rubocop', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cezary Baginski
+
+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,47 @@
+# Guard::Compat
+
+Currently, provides only a test helper for testing custom Guard plugins.
+
+## Installation
+
+Add this to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'guard-compat', require: false
+end
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Put the following notes in your plugin file (e.g. `lib/guard/myplugin.rb`):
+
+```ruby
+# Do NOT require "guard/plugin"
+# It will either be required or a stub will be supplied by the test class
+```
+
+And in your plugin tests (e.g. `spec/lib/guard/myplugin_spec.rb`):
+
+```ruby
+require 'guard/compat/test/helper'
+require 'guard/myplugin'
+
+# And your tests instantiating your plugin go here...
+```
+## Example
+
+See `lib/guard/example.rb` for an example plugin implementation.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/guard/guard-compat/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false unless ENV.key?('CI')
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+task default: [:spec, :rubocop]

data/guard-compat.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/compat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'guard-compat'
+  spec.version       = Guard::Compat::VERSION
+  spec.authors       = ['Cezary Baginski']
+  spec.email         = ['cezary@chronomantic.net']
+  spec.summary       = 'Tools for developing Guard compatible plugins'
+  spec.description   = 'Helps creating valid Guard plugins and testing them'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/guard/compat.rb

@@ -0,0 +1,7 @@
+require 'guard/compat/version'
+
+module Guard
+  module Compat
+    # Your code goes here...
+  end
+end

data/lib/guard/compat/example.rb

@@ -0,0 +1,15 @@
+# NOTE: Do NOT require "guard/plugin" - it will either be already required, or
+# a stub will be supplied by the test class
+
+module Guard
+  class MyPlugin < Plugin
+    def start
+      Guard::Notifier.notify('foo', title: 'bar')
+      Guard::UI.info('foo')
+      Guard::UI.warning('foo')
+      Guard::UI.error('foo')
+      Guard::UI.debug('foo')
+      Guard::UI.deprecation('foo')
+    end
+  end
+end

data/lib/guard/compat/test/helper.rb

@@ -0,0 +1,38 @@
+# Minimal stub allowing a plugin to work
+module Guard
+  class Plugin
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+    end
+  end
+
+  class Notifier
+    def self.notify(_msg, _options)
+      fail NotImplementedError, 'stub this method in your tests'
+    end
+  end
+
+  class UI
+    def self.info(_msg)
+      fail NotImplementedError, 'stub this method in your tests'
+    end
+
+    def self.warning(_msg)
+      fail NotImplementedError, 'stub this method in your tests'
+    end
+
+    def self.error(_msg)
+      fail NotImplementedError, 'stub this method in your tests'
+    end
+
+    def self.debug(_msg)
+      fail NotImplementedError, 'stub this method in your tests'
+    end
+
+    def self.deprecation(_msg)
+      fail NotImplementedError, 'stub this method in your tests'
+    end
+  end
+end

data/lib/guard/compat/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module Compat
+    VERSION = '0.0.1'
+  end
+end

data/spec/guard/compat/example_spec.rb

@@ -0,0 +1,31 @@
+# This is the only file the plugin should require
+require 'guard/compat/test/helper'
+require 'guard/compat/example'
+
+RSpec.describe Guard::MyPlugin, exclude_stubs: [Guard::Plugin] do
+  let(:options) { { foo: :bar } }
+  subject { described_class.new(options) }
+
+  before do
+    allow(Guard::Notifier).to receive(:notify)
+    %w(info warning error deprecation debug).each do |type|
+      allow(Guard::UI).to receive(type.to_sym)
+    end
+  end
+
+  it 'passes options' do
+    expect(subject.options).to include(foo: :bar)
+  end
+
+  it 'uses the notifier' do
+    expect(Guard::Notifier).to receive(:notify).with('foo', title: 'bar')
+    subject.start
+  end
+
+  %w(info warning error deprecation debug).each do |type|
+    it "outputs #{type} messages" do
+      expect(Guard::UI).to receive(type.to_sym).with('foo')
+      subject.start
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,73 @@
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_doubled_constant_names = true
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run focus: ENV['CI'] != 'true'
+
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: guard-compat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cezary Baginski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Helps creating valid Guard plugins and testing them
+email:
+- cezary@chronomantic.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-compat.gemspec
+- lib/guard/compat.rb
+- lib/guard/compat/example.rb
+- lib/guard/compat/test/helper.rb
+- lib/guard/compat/version.rb
+- spec/guard/compat/example_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Tools for developing Guard compatible plugins
+test_files:
+- spec/guard/compat/example_spec.rb
+- spec/spec_helper.rb