guard-yardstick 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70281bd8873f56a754d7b1676d0e10b4b6ac57d5
+  data.tar.gz: 98a6e991a4391e003ce0eb11975e33301841b1c8
+SHA512:
+  metadata.gz: 66ff4161396f810a48d794758c848ce15be8b65f3f53378478d35ec4eb0078965d98abcaff75898e39744964c2357fa3566c5d44b19485556a9b396e5012ae49
+  data.tar.gz: 00e4bd3594619dae551aa8b20a6f084fc0bb1821130f66124f0d4d2eb509c37dc1bec88acb963119d26ac02cf9818f234fe8bb1bfa083a0b272aa0870a027af5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in guard-yardstick.gemspec
+gemspec
+
+group :development do
+  gem 'guard'
+end

data/Guardfile

@@ -0,0 +1,6 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :yardstick do
+  watch(%r{.+\.rb$})
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathan Lee
+
+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,49 @@
+# guard-yardstick
+
+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
+group :development do
+  gem 'guard-yardstick'
+end
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install guard-yardstick
+```
+
+## Usage
+
+Please read the [Guard usage documentation](https://github.com/guard/guard#readme).
+
+## Options
+
+You can pass some options in `Guardfile` like the following example:
+
+```ruby
+guard :yardstick, all_on_start: false, cli: ['app/**/*.rb', 'lib/**/*.rb'] do
+  # ...
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/guard-yardstick.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/yardstick/version'
+
+Gem::Specification.new do |spec|
+  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.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.add_runtime_dependency 'guard',     '>= 2.0'
+  spec.add_runtime_dependency 'yardstick', '>= 0.9'
+
+  # spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/guard/yardstick/version.rb

@@ -0,0 +1,14 @@
+module Guard
+  # A workaround for declaring `class Yardstick`
+  # before `class Yardstick < Guard` in yardstick.rb
+  module YardstickVersion
+    # http://semver.org/
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    def self.to_s
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+end

data/lib/guard/yardstick.rb

@@ -0,0 +1,35 @@
+require 'guard'
+require 'guard/plugin'
+
+module Guard
+  class Yardstick < Plugin
+
+    def initialize(options = {})
+      super
+
+      @options = {
+        all_on_start: true,
+        cli: ['./**/*.rb']
+      }.merge(options)
+    end
+
+    def start
+      run_all if @options[:all_on_start]
+    end
+
+    def run_all
+      UI.info 'Inspecting Yarddoc in all files'
+      system(build_command)
+    end
+
+    private
+
+    def build_command
+      cli = options[:cli].join(' ')
+
+      "bundle exec yardstick #{cli}"
+    end
+
+   end
+
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: guard-yardstick
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: yardstick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Guard::Yardstick automatically checks your code for missing yardocs when
+  files are modified.
+email:
+- nathan@globalphobia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-yardstick.gemspec
+- lib/guard/yardstick.rb
+- lib/guard/yardstick/version.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: Guard plugin for Yardstick
+test_files: []
+has_rdoc: