guard-yardstick 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8e3b3c837c2dcc1689f6fcf69dfdb490336fd772
-  data.tar.gz: d9a5c380e96e93dcd52a059228344c1ba3e29115
+SHA256:
+  metadata.gz: 45459e4845319647f61ae3292f4ea7d77f0d4232031e1f4784cbe3ae84f88076
+  data.tar.gz: a1bf0c8c29630a98c27cd4d1972d3755fca69d10fc1deb2d376aea47f70cf795
 SHA512:
-  metadata.gz: 06f4880fd79bbeed1c8b0f310216d9b14902ea4fe65228c2001b333e4eb19341f0d9d60a64b607c35028050277f53b926bbccfd15c1b7a0c31aa7f1e233ad5e3
-  data.tar.gz: f7e3971af14c793bf6685fe416350a6d17c670dcd284d18dcfafc36441c60345193eeb4e9f2c53a57e86c45f3630506010f1608d444c16e9f7af31d5d5d74840
+  metadata.gz: 7c921eed30033ecbfa0f02b2a2f487bd3dcde502ebfdc6127b5b85f3a7a4b7072731a11544ffdf24de22110e1f35dd6a09d628222fec87b0662a8982febc3345
+  data.tar.gz: c33d8a4e0517564e7eff2e981ac4c0cf45c2b231dd10bce84bc7496f884a1aaea944fdf850f359f00e1c34815f1cb8ec50b16c3c277a9d43111749f780fdfb2d

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+measurements

data/.yardstick.yml

@@ -0,0 +1,14 @@
+---
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude:
+      - Guard::YardstickVersion.to_s
+  ApiTag::Inclusion:
+    enabled: true
+    exclude:
+      - Guard::YardstickVersion.to_s
+  Summary::Delimiter:
+    enabled: true
+    exclude:
+      - Guard::Yardstick#yardstick_config

data/Gemfile

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in guard-yardstick.gemspec
 gemspec
 
 group :development do
-  gem 'guard'
-  gem 'guard-rubocop'
-  gem 'guard-rspec'
-  gem 'rubocop'
+  gem 'guard-rspec',   require: false
+  gem 'guard-rubocop', require: false
 end
 
 group :development, :test do
-  gem 'rspec'
+  gem 'rspec',     require: false
+  gem 'rubocop',   require: false
+  gem 'yardstick', require: false
 end

data/Guardfile

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard :yardstick do
+guard :yardstick, config: '.yardstick.yml' do
   watch(/.+\.rb$/)
+  watch('.yardstick.yml') { 'lib' }
 end
 
-guard :rubocop, all_on_start: true, cli: ['--display-cop-name']do
+guard :rubocop, all_on_start: true, cli: ['--display-cop-name'] do
   watch('guard-yardstick.gemspec')
   watch(/^(|Rakefile|Guardfile)/)
   watch(/.+\.rb$/)

data/README.md

@@ -10,7 +10,7 @@ Add `guard-yardstick` to your `Gemfile`:
 
 ```ruby
 group :development do
-  gem 'guard-yardstick'
+  gem 'guard-yardstick', require: false
 end
 ```
 
@@ -40,11 +40,11 @@ Please read the [Guard usage documentation](https://github.com/guard/guard#readm
 
 *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.
+*config:* Tells yardstick where to find yardsticks configuration file if present.
 
 
 ```ruby
-guard :yardstick, all_on_start: false, path: ['app', 'config', 'lib'] do
+guard :yardstick, config: './.yardstick.yml' do
   # ...
 end
 ```

data/Rakefile

@@ -1 +1,25 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
+require 'yardstick/rake/measurement'
+yardstick_options = YAML.load_file('.yardstick.yml')
+
+Yardstick::Rake::Measurement.new(:yardstick_measure, yardstick_options)
+
+require 'yardstick/rake/verify'
+
+Yardstick::Rake::Verify.new(:yardstick, yardstick_options)
+
+task default: %i[spec rubocop yardstick]

data/guard-yardstick.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'guard/yardstick/version'
 

data/lib/guard/yardstick.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'guard/compat/plugin'
 require 'yardstick'
+require 'yaml'
 
 module Guard
   # A guard plugin to run yardstick on every save
@@ -19,9 +22,7 @@ module Guard
 
       @options = {
         all_on_start: true,
-        # Taken from yardsitck:
-        # https://github.com/dkubb/yardstick/blob/0aa394dd64baf5155775e6be5018d6c9844654b7/lib/yardstick/config.rb#L167
-        path:         ['lib/**/*.rb']
+        config: nil
       }.merge(args)
     end
 
@@ -39,7 +40,7 @@ module Guard
     # @return [Void]
     def run_all
       UI.info 'Inspecting Yarddoc in all files'
-      inspect_with_yardstick(options[:path])
+      inspect_with_yardstick
     end
 
     # Will run when files are added
@@ -70,18 +71,18 @@ module Guard
       displayed_paths = paths.map { |path| smart_path(path) }
       UI.info "Inspecting Yarddocs: #{displayed_paths.join(' ')}"
 
-      inspect_with_yardstick(paths)
+      inspect_with_yardstick(path: paths)
     end
 
     # Runs yardstick and outputs results to STDOUT
     #
     # @api private
     # @return [Void]
-    def inspect_with_yardstick(paths)
-      config = ::Yardstick::Config.coerce(path: paths)
+    def inspect_with_yardstick(yardstick_options = {})
+      config = ::Yardstick::Config.coerce(yardstick_config(yardstick_options))
       measurements = ::Yardstick.measure(config)
       measurements.puts
-    rescue => error
+    rescue StandardError => error
       UI.error 'The following exception occurred while running ' \
                "guard-yardstick: #{error.backtrace.first} " \
                "#{error.message} (#{error.class.name})"
@@ -98,5 +99,16 @@ module Guard
         path
       end
     end
+
+    # Merge further options with yardstick config file.
+    #
+    # @api private
+    # @return [Hash] Hash of options for yardstick measurement
+    def yardstick_config(extra_options = {})
+      return options unless options[:config]
+
+      yardstick_options = YAML.load_file(options[:config])
+      yardstick_options.merge(extra_options)
+    end
   end
 end

data/lib/guard/yardstick/templates/Guardfile

@@ -1,10 +1,23 @@
+# frozen_string_literal: true
+
 # Options to guard-yardstick
 # all_on_start: true
-# path: ['app', 'config', 'lib']
+# config: nil
 guard :yardstick do
   # Typical Rails setup
-  # Set path option to ['app', 'config', 'lib']
+  # Set path option for yardstick in ,yardstick.yml
+  # ---
+  # path:
+  #   - app
+  #   - config
+  #   - lib
+  # # Also check out the rules config
+  # # https://github.com/dkubb/yardstick#4-configuration
+  #
+  # and pass in the location of the yaml file using the config option
+  # config: '.yardstick.yml'
   # watch(%r{^app\/(.+)\.rb$})
   # watch(%r{^config\/initializers\/(.+)\.rb$})
+  # watch('.yardstick.yml') { 'lib' }
   watch(%r{^lib\/(.+)\.rb$})
 end

data/lib/guard/yardstick/version.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Guard
   # A workaround for declaring `class Yardstick`
   # before `class Yardstick < Guard` in yardstick.rb
   module YardstickVersion
     # http://semver.org/
-    MAJOR = 0
-    MINOR = 1
+    MAJOR = 1
+    MINOR = 0
     PATCH = 0
 
     # Returns a formatted version string
@@ -12,7 +14,6 @@ module Guard
     # @example
     #   Guard::YardstickVersion.to_s # => '0.0.0.2'
     #
-    # @api public
     # @return [String]
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'guard/yardstick'
 require 'guard/compat/test/helper'
 

data/spec/yardstick_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Guard::Yardstick do
@@ -14,11 +16,6 @@ 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.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nathan Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2018-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".yardstick.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -107,11 +108,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Guard plugin for Yardstick
 test_files:
 - spec/spec_helper.rb
 - spec/yardstick_spec.rb
-has_rdoc: