guard-yardstick 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e30961fcbd2719308deb781c609e613e325916bd
-  data.tar.gz: 4dbe259bcf095ed6070b663d2d52559635f82f6a
+  metadata.gz: b2b65ff449257c6508ede703082ebc309690e91b
+  data.tar.gz: 90ee226dc8b0fa7deb328aa2d5dda9e0b8df5f9c
 SHA512:
-  metadata.gz: e772938511c6cf800bdf781bb3b39552e442b8cfd236dc5039b8a04aac0006d7a8e7b460523c974624b161e4a15e2d093039a98a57225c59ecfc4e8bde7a3053
-  data.tar.gz: 4627760f097b90789312114bcf2bd2016e129ffe7d25517baf38143827e5e0bab4ea19ba4000b70e62727b7543112eb2b6bffdaa7058299034af883324a19eb4
+  metadata.gz: 2669c512c36a804723bc50d36c11ee0a767fb2194bada96faae9ace24927c625b1311c3a4203097d69028afb43481b10662a5661c8aecf5ce025d75d89cb0995
+  data.tar.gz: 36e589b4289dfe0cd9d654c260fdfba4adfe8bccb859311c6ca97f0db14b5909e6f5f318cce3ebdc346dc8ba78fab8a9b4ceb66bdc3b7b18508b65ad37bd0c7d

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-04-23 14:11:59 -0600 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: 3
+Style/RegexpLiteral:
+  MaxSlashes: 0

data/Gemfile

@@ -5,4 +5,10 @@ gemspec
 
 group :development do
   gem 'guard'
+  gem 'guard-rubocop'
+  gem 'rubocop'
+end
+
+group :development, :test do
+  gem 'rspec'
 end

data/Guardfile

@@ -2,5 +2,11 @@
 # More info at https://github.com/guard/guard#readme
 
 guard :yardstick do
-  watch(%r{.+\.rb$})
+  watch(/.+\.rb$/)
+end
+
+guard :rubocop, all_on_start: true, cli: ['--display-cop-name']do
+  watch('guard-yardstick.gemspec')
+  watch(/^(|Rakefile|Guardfile)/)
+  watch(/.+\.rb$/)
 end

data/README.md

@@ -6,8 +6,6 @@ guard-yardstick will automatically check your code for missing yardocs
 
 ## Installation
 
-Please make sure to have [Guard](https://github.com/guard/guard) installed before continue.
-
 Add `guard-yardstick` to your `Gemfile`:
 
 ```ruby
@@ -30,14 +28,20 @@ $ gem install guard-yardstick
 
 ## Usage
 
-Please read the [Guard usage documentation](https://github.com/guard/guard#readme).
+After correctly installing the gem initialize your Guardfile as follows.
+
+```sh
+$ bundle exec guard init yardstick
+```
+
+Please read the [Guard usage documentation](https://github.com/guard/guard#readme) for further details.
 
 ## Options
 
-You can pass some options in `Guardfile` like the following example:
+There is currently only a single option that can be passed to this guard. *all_on_start* which is *true* by default.
 
 ```ruby
-guard :yardstick, all_on_start: false, cli: ['app/**/*.rb', 'lib/**/*.rb'] do
+guard :yardstick, all_on_start: false do
   # ...
 end
 ```

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/guard-yardstick.gemspec

@@ -4,23 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'guard/yardstick/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "guard-yardstick"
+  spec.name          = 'guard-yardstick'
   spec.version       = Guard::YardstickVersion
-  spec.authors       = ["Nathan Lee"]
-  spec.email         = ["nathan@globalphobia.com"]
-  spec.description   = 'Guard::Yardstick automatically checks your code for missing yardocs ' \
-                       'when files are modified.'
-  spec.summary       = %q{Guard plugin for Yardstick}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Nathan Lee']
+  spec.email         = ['nathan@globalphobia.com']
+  spec.description   = 'Guard::Yardstick automatically checks your code for ' \
+                       ' missing yardocs when files are modified.'
+  spec.summary       = 'Guard plugin for Yardstick'
+  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.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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_runtime_dependency 'guard',     '>= 2.0'
-  spec.add_runtime_dependency 'yardstick', '>= 0.9'
+  spec.add_runtime_dependency 'guard',        '>= 2.0'
+  spec.add_runtime_dependency 'guard-compat', '>= 1.2'
+  spec.add_runtime_dependency 'yardstick',    '>= 0.9'
 
   # spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

data/lib/guard/yardstick/templates/Guardfile

@@ -0,0 +1,6 @@
+guard :yardstick do
+  # Typical Rails setup
+  # watch(%r{^app\/(.+)\.rb$})
+  # watch(%r{^config\/initializers\/(.+)\.rb$})
+  watch(%r{^lib\/(.+)\.rb$})
+end

data/lib/guard/yardstick/version.rb

@@ -5,8 +5,15 @@ module Guard
     # http://semver.org/
     MAJOR = 0
     MINOR = 0
-    PATCH = 2
+    PATCH = 3
 
+    # Returns a formatted version string
+    #
+    # @example
+    #   Guard::YardstickVersion.to_s # => '0.0.0.2'
+    #
+    # @api public
+    # @return [String]
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')
     end

data/lib/guard/yardstick.rb

@@ -1,38 +1,67 @@
-require 'guard'
-require 'guard/plugin'
+require 'guard/compat/plugin'
 require 'yardstick'
 
 module Guard
+  # A guard plugin to run yardstick on every save
   class Yardstick < Plugin
-
-    def initialize(options = {})
+    # A hash of options for configuring the plugin
+    #
+    # @api private
+    # @return [Hash]
+    attr_reader :options
+
+    # Initializes guard-yardstick
+    #
+    # @api private
+    # @return [Guard::Yardstick]
+    def initialize(args = {})
       super
 
       @options = {
         all_on_start: true
-      }.merge(options)
+      }.merge(args)
     end
 
+    # When guard starts will run all files if :all_on_start is set
+    #
+    # @api private
+    # @return [Void]
     def start
-      run_all if @options[:all_on_start]
+      run_all if options[:all_on_start]
     end
 
+    # Will run all files through yardstick
+    #
+    # @api private
+    # @return [Void]
     def run_all
       UI.info 'Inspecting Yarddoc in all files'
 
       inspect_with_yardstick
     end
 
+    # Will run when files are added
+    #
+    # @api private
+    # @return [Void]
     def run_on_additions(paths)
       run_partially(paths)
     end
 
+    # Will run when files are changed
+    #
+    # @api private
+    # @return [Void]
     def run_on_modifications(paths)
       run_partially(paths)
     end
 
     private
 
+    # Runs yardstick on a partial set of paths passed in by guard
+    #
+    # @api private
+    # @return [Void]
     def run_partially(paths)
       return if paths.empty?
 
@@ -42,14 +71,23 @@ module Guard
       inspect_with_yardstick(paths)
     end
 
-    def inspect_with_yardstick(paths = [])
+    # Runs yardstick and outputs results to STDOUT
+    #
+    # @api private
+    # @return [Void]
+    def inspect_with_yardstick(_paths = [])
       measurements = ::Yardstick.measure
       measurements.puts
     rescue => error
-      UI.error 'The following exception occurred while running guard-yardstick: ' \
-               "#{error.backtrace.first} #{error.message} (#{error.class.name})"
+      UI.error 'The following exception occurred while running ' \
+               "guard-yardstick: #{error.backtrace.first} " \
+               "#{error.message} (#{error.class.name})"
     end
 
+    # Returns a path with pwd removed if needed
+    #
+    # @api private
+    # @return [String]
     def smart_path(path)
       if path.start_with?(Dir.pwd)
         Pathname.new(path).relative_path_from(Pathname.getwd).to_s
@@ -57,7 +95,5 @@ module Guard
         path
       end
     end
-
-   end
-
+  end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+require 'guard/yardstick'
+require 'guard/compat/test/helper'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will
+# cause this file to always be loaded, without a need to explicitly require
+# it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# 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_partial_doubles = true
+  end
+
+  # 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
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  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

data/spec/yardstick_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe Guard::Yardstick do
+  subject(:guard) { Guard::Yardstick.new(options) }
+  let(:options) { {} }
+
+  describe '#options' do
+    subject { super().options }
+
+    context 'by default' do
+      let(:options) { {} }
+
+      describe '[:all_on_start]' do
+        subject { super()[:all_on_start] }
+        it { should be_truthy }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-yardstick
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nathan Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-22 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: yardstick
   requirement: !ruby/object:Gem::Requirement
@@ -52,8 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Guard::Yardstick automatically checks your code for missing yardocs when
-  files are modified.
+description: Guard::Yardstick automatically checks your code for  missing yardocs
+  when files are modified.
 email:
 - nathan@globalphobia.com
 executables: []
@@ -61,6 +75,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -68,7 +84,10 @@ files:
 - Rakefile
 - guard-yardstick.gemspec
 - lib/guard/yardstick.rb
+- lib/guard/yardstick/templates/Guardfile
 - lib/guard/yardstick/version.rb
+- spec/spec_helper.rb
+- spec/yardstick_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -89,9 +108,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Guard plugin for Yardstick
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/yardstick_spec.rb
 has_rdoc: