guard-inch 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7d0c2af97d4c06943943aa99362760a689cb9c3
-  data.tar.gz: 00cfbf450fdf28ea20a494f85627ebc4a0370718
+  metadata.gz: 7c2280e2482faaf6bc7b00fe6712cdf3ad06e2b0
+  data.tar.gz: 1b872a9ac91d488ca9796c4685769a85a9ada1bb
 SHA512:
-  metadata.gz: 086c614e9cd7a3a1f7895a76b0c6b70240c7baf3ccdb6a1e4b8acb7cc31a9a41d89f8e3fcbe22e5b4ae38462ec0f682e04ad97514171ab432ce22d5158d6d33e
-  data.tar.gz: b9d2535b9feb7ff52185c32d8239fe46cefcde435e4a489866c73bee6ce53a502b922341cef962ce4920626982f36781fb83a3fc730cf009921b0bfe4d4cc1da
+  metadata.gz: f7f8dae49a8630d02bac221a89a5f675454a267429b29429bb4aff55e0c27bcaeab4cfc1a9fd2b24b2fbe72ba6e4511e760e302abd5e0f2a25a8406578c1f5d8
+  data.tar.gz: acd123ee4b94a4cc8dec6bb08bf4266de52fafc68bbd356679bd9b2190c2a2777aeccafc7edad7643a0503cbade818c1a13a6fd591f7cf636a047755092c245f

data/guard-inch.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 1"
 
-  spec.add_runtime_dependency "guard"
-  spec.add_runtime_dependency "inch"
+  spec.add_runtime_dependency "guard", "~> 0"
+  spec.add_runtime_dependency "inch", "~> 0"
 end

data/lib/guard/inch.rb

@@ -2,8 +2,12 @@ require "guard/inch/version"
 require 'guard'
 require 'guard/plugin'
 
+# The guard namespace
 module Guard
+  # A guard plugin for the Inch documentation lint tool
   class Inch < Plugin
+    # configure a new instance of the plugin
+    # @param [Hash] options the guard plugin options
     def initialize(options = {})
       super
       @options = options
@@ -11,6 +15,7 @@ module Guard
       @all_type = options[:all_type] || :none
     end
 
+    # On start, display a message and optionally run the documentation lint
     def start
       message = 'Guard::Inch is running'
       message << ' in pedantic mode' if options[:pedantic]
@@ -18,6 +23,7 @@ module Guard
       run_all if options[:all_on_start]
     end
 
+    # Run all of the documentation lints
     def run_all
       return unless options[:all_type]
       args = case options[:all_type]
@@ -31,12 +37,15 @@ module Guard
       args << ' .'
       run_inch args
     end
+
+    # Run the lints for changes files
+    # @param [Array<String>] paths the paths of changed files
     def run_on_changes(paths)
       flags = ''
       flags << '--pedantic ' if options[:pedantic]
       run_inch "#{flags} #{paths.join(' ')}"
     end
-    
+
     private
 
     # run the inch tool with the specified argument string

data/lib/guard/inch/version.rb

@@ -1,5 +1,7 @@
+# The guard namespace
 module Guard
+  # The Inch Plugin Version namespace
   module InchVersion
-    VERSION = "0.1.0"
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: guard-inch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Craig Hills
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: This gem is a Guard plugin, which integrates the inch documentation measurement
@@ -74,7 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -93,17 +93,17 @@ 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.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A guard plugin to run the inch documentation measurement tool.