guard-rails_best_practices 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem 'guard', '>= 0.8.4'
+gem 'rails_best_practices', '>= 1.1.0'
+
+# Specify your gem's dependencies in guard-rails_best_practices.gemspec
+gemspec

data/README.md

@@ -0,0 +1,45 @@
+# Guard - Rails Best Practices
+
+BDD your [Rails Best Practices](http://rails-bestpractices.com/) checklist alongside your specs 
+with [Guard](https://github.com/guard/guard).
+
+By adding your own checklists, this can be a great way to enforce those code style documents that everyone on your
+team has forgotten!
+
+## Install
+
+In your Rails 3.0+ application, add the `guard`, `rails_best_practices`, and `guard-rails_best_practices` gems to your `Gemfile`:
+
+    group :development do
+      gem 'rails_best_practices'
+      gem 'guard'
+      gem 'guard-rails_best_practices'
+    end
+
+Add guard definitions to your `Guardfile` by running:
+
+    guard init rails_best_practices
+
+Guard will now inform you of Rails Best Practices warnings.
+
+## Options
+
+These options are available (with the following defaults):
+
+    options[:vendor]   = true # Include vendor/
+    options[:spec]     = true # Include spec/
+    options[:test]     = true # Include test/
+    options[:features] = true # Include features/
+    options[:exclude]  = '' # Exclude [PATTERN]
+    options[:run_at_start] = true # Run checklist when guard starts
+  
+See https://github.com/flyerhzm/rails_best_practices for details.
+
+It is recommended that you run `rails_best_practices -g` to generate a `rails_best_practices.yml` file for your application,
+so you can tune the checklists to your own unique tastes.
+
+You can also extend `rails_best_practices` by [writing your own checklists](https://github.com/flyerhzm/rails_best_practices/wiki/How-to-write-your-own-check-list) .
+
+## Authors
+
+[Logan Koester](http://github.com/logankoester)

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task :default => :build

data/guard-rails_best_practices.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "guard/guard-rails_best_practices/version"
+
+Gem::Specification.new do |s|
+  s.name        = "guard-rails_best_practices"
+  s.version     = Guard::Rails_best_practices::VERSION
+  s.authors     = ["Logan Koester"]
+  s.email       = ["lkoester@agoragames.com"]
+  s.homepage    = ""
+  s.summary     = %q{Guard for rails_best_practices, a code metric tool to check the quality of rails code.}
+  s.description = %q{Guard for rails_best_practices, a code metric tool to check the quality of rails code.}
+
+  s.rubyforge_project = "guard-rails_best_practices"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_runtime_dependency "rails_best_practices"
+  s.add_runtime_dependency "guard"
+end

data/lib/guard/guard-rails_best_practices/templates/Guardfile

@@ -0,0 +1,3 @@
+guard 'rails_best_practices' do
+  watch(%r{^app/(.+)\.rb$})
+end

data/lib/guard/guard-rails_best_practices/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  class Rails_best_practices
+    VERSION = "0.1.0"
+  end
+end

data/lib/guard/rails_best_practices.rb

@@ -0,0 +1,65 @@
+require 'guard'
+require 'guard/guard'
+require File.join(File.dirname(__FILE__), "guard-rails_best_practices/version")
+
+module Guard
+  class Rails_best_practices < Guard
+    autoload :Notifier, 'guard/annotate/notifier'
+
+    def initialize(watchers = [], options = {})
+      super
+      options[:vendor]   = true   if options[:vendor].nil?
+      options[:spec]     = true   if options[:spec].nil?
+      options[:test]     = true   if options[:test].nil?
+      options[:features] = true   if options[:features].nil?
+      options[:exclude]  = ''     if options[:exclude].nil?
+
+      options[:run_at_start] = true if options[:run_at_start].nil?
+    end
+
+    def start
+      run_bestpractices if options[:run_at_start]
+    end
+
+    def stop
+      true
+    end
+
+    def reload
+      run_bestpractices
+    end
+
+    def run_all
+      run_bestpractices
+    end
+
+    def run_on_change(paths)
+      run_bestpractices
+    end
+
+    def run_on_deletion(paths)
+    end
+
+    def notify?
+      !!options[:notify]
+    end
+
+  private
+    def run_bestpractices
+      UI.info 'Running Rails Best Practices checklist', :reset => true
+      started_at = Time.now
+
+      cmd = 'rails_best_practices'
+      cmd += ' --vendor'   if options[:vendor]
+      cmd += ' --spec'     if options[:spec]
+      cmd += ' --test'     if options[:test]
+      cmd += ' --features' if options[:features]
+      cmd += " --exclude #{options[:exclude]}" unless options[:exclude].blank?
+      @result = system(cmd)
+
+      Notifier::notify( @result, Time.now - started_at ) if notify?
+      @result
+    end
+
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: guard-rails_best_practices
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Logan Koester
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-06 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails_best_practices
+  requirement: &14030460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14030460
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &14029980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14029980
+description: Guard for rails_best_practices, a code metric tool to check the quality
+  of rails code.
+email:
+- lkoester@agoragames.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- guard-rails_best_practices.gemspec
+- lib/guard/guard-rails_best_practices/templates/Guardfile
+- lib/guard/guard-rails_best_practices/version.rb
+- lib/guard/rails_best_practices.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: guard-rails_best_practices
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Guard for rails_best_practices, a code metric tool to check the quality of
+  rails code.
+test_files: []