guard-yardstick 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2b65ff449257c6508ede703082ebc309690e91b
-  data.tar.gz: 90ee226dc8b0fa7deb328aa2d5dda9e0b8df5f9c
+  metadata.gz: 8e3b3c837c2dcc1689f6fcf69dfdb490336fd772
+  data.tar.gz: d9a5c380e96e93dcd52a059228344c1ba3e29115
 SHA512:
-  metadata.gz: 2669c512c36a804723bc50d36c11ee0a767fb2194bada96faae9ace24927c625b1311c3a4203097d69028afb43481b10662a5661c8aecf5ce025d75d89cb0995
-  data.tar.gz: 36e589b4289dfe0cd9d654c260fdfba4adfe8bccb859311c6ca97f0db14b5909e6f5f318cce3ebdc346dc8ba78fab8a9b4ceb66bdc3b7b18508b65ad37bd0c7d
+  metadata.gz: 06f4880fd79bbeed1c8b0f310216d9b14902ea4fe65228c2001b333e4eb19341f0d9d60a64b607c35028050277f53b926bbccfd15c1b7a0c31aa7f1e233ad5e3
+  data.tar.gz: f7e3971af14c793bf6685fe416350a6d17c670dcd284d18dcfafc36441c60345193eeb4e9f2c53a57e86c45f3630506010f1608d444c16e9f7af31d5d5d74840

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 group :development do
   gem 'guard'
   gem 'guard-rubocop'
+  gem 'guard-rspec'
   gem 'rubocop'
 end
 

data/Guardfile

@@ -10,3 +10,29 @@ guard :rubocop, all_on_start: true, cli: ['--display-cop-name']do
   watch(/^(|Rakefile|Guardfile)/)
   watch(/.+\.rb$/)
 end
+
+# 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)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # 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/README.md

@@ -38,10 +38,13 @@ Please read the [Guard usage documentation](https://github.com/guard/guard#readm
 
 ## Options
 
-There is currently only a single option that can be passed to this guard. *all_on_start* which is *true* by default.
+*all_on_start:* Same as on any other Guard plugin. Run yardstick on all files on start or not.
+
+*path:* Tells yardstick which paths to run the yardoc analysis on. Defaults to yardsticks default of *'lib'* directory.
+
 
 ```ruby
-guard :yardstick, all_on_start: false do
+guard :yardstick, all_on_start: false, path: ['app', 'config', 'lib'] do
   # ...
 end
 ```

data/lib/guard/yardstick/templates/Guardfile

@@ -1,5 +1,9 @@
+# Options to guard-yardstick
+# all_on_start: true
+# path: ['app', 'config', 'lib']
 guard :yardstick do
   # Typical Rails setup
+  # Set path option to ['app', 'config', 'lib']
   # watch(%r{^app\/(.+)\.rb$})
   # watch(%r{^config\/initializers\/(.+)\.rb$})
   watch(%r{^lib\/(.+)\.rb$})

data/lib/guard/yardstick/version.rb

@@ -4,8 +4,8 @@ module Guard
   module YardstickVersion
     # http://semver.org/
     MAJOR = 0
-    MINOR = 0
-    PATCH = 3
+    MINOR = 1
+    PATCH = 0
 
     # Returns a formatted version string
     #

data/lib/guard/yardstick.rb

@@ -18,7 +18,10 @@ module Guard
       super
 
       @options = {
-        all_on_start: true
+        all_on_start: true,
+        # Taken from yardsitck:
+        # https://github.com/dkubb/yardstick/blob/0aa394dd64baf5155775e6be5018d6c9844654b7/lib/yardstick/config.rb#L167
+        path:         ['lib/**/*.rb']
       }.merge(args)
     end
 
@@ -36,8 +39,7 @@ module Guard
     # @return [Void]
     def run_all
       UI.info 'Inspecting Yarddoc in all files'
-
-      inspect_with_yardstick
+      inspect_with_yardstick(options[:path])
     end
 
     # Will run when files are added
@@ -75,8 +77,9 @@ module Guard
     #
     # @api private
     # @return [Void]
-    def inspect_with_yardstick(_paths = [])
-      measurements = ::Yardstick.measure
+    def inspect_with_yardstick(paths)
+      config = ::Yardstick::Config.coerce(path: paths)
+      measurements = ::Yardstick.measure(config)
       measurements.puts
     rescue => error
       UI.error 'The following exception occurred while running ' \

data/spec/yardstick_spec.rb

@@ -14,6 +14,11 @@ RSpec.describe Guard::Yardstick do
         subject { super()[:all_on_start] }
         it { should be_truthy }
       end
+
+      describe '[:path]' do
+        subject { super()[:path] }
+        it { should eq(['lib/**/*.rb']) }
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-yardstick
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Nathan Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -76,7 +76,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -108,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Guard plugin for Yardstick

data/.rubocop.yml

@@ -1,10 +0,0 @@
-# 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