knife-foodcritic 0.1.1 → 0.2.0

data/README.md

@@ -2,3 +2,50 @@ knife-foodcritic
 ================
 
 A knife plugin that generates boiler plate code for developing and testing custom foodcritic rules
+
+Installation
+------------
+
+### Gem Install
+`knife-foodcritic` is available on rubygems. Add the following to your `Gemfile`:
+
+```ruby
+gem 'knife-foodcritic'
+```
+
+or install the gem manually:
+
+```bash
+gem install knife-foodcritic
+```
+
+Foodcritic Rule Create
+----------
+This function lets you easily create the necessary lib, spec and cookbook files necessary to develop and test a new foodcritic rule.
+
+#### Usage
+```bash
+knife foodcritic rule create ID [ --description DESCRIPTION ]
+````
+
+#### Example (Just passing in a rule ID)
+```text
+$ knife foodcritic rule create CUSTOM001
+** Creating Custom001 at /Users/edmundd/Development/lightyear/chef-repo/foodcritic/lib/Fourth/CUSTOM001.rb
+** Creating spec file at /Users/edmundd/Development/lightyear/chef-repo/foodcritic/spec/rules/CUSTOM001_spec.rb
+** Cookbooks directory: /Users/edmundd/Development/lightyear/chef-repo/foodcritic/cookbooks
+** Creating cookbook custom001
+** Creating metadata for cookbook: custom001
+** Creating README for cookbook: custom001
+```
+
+#### Example (Adding a rule description at creation time)
+```text
+$ knife foodcritic rule create CUSTOM001 --description "The best rule in the world"
+** Creating Custom001 at /Users/edmundd/Development/lightyear/chef-repo/foodcritic/lib/Fourth/CUSTOM001.rb
+** Creating spec file at /Users/edmundd/Development/lightyear/chef-repo/foodcritic/spec/rules/CUSTOM001_spec.rb
+** Cookbooks directory: /Users/edmundd/Development/lightyear/chef-repo/foodcritic/cookbooks
+** Creating cookbook custom001
+** Creating metadata for cookbook: custom001
+** Creating README for cookbook: custom001
+```

data/knife-foodcritic.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_dependency "chef"
+  spec.add_dependency "foodcritic", "~> 4.0.0"
 
 end

data/lib/chef/knife/create_foodcritic_rule.rb

@@ -28,15 +28,18 @@ module Foodcritic
       create_foodcritic_rule(foodcritic_path, ruleID, ruleDesc)
       create_specs(foodcritic_path, ruleID)
       create_cookbook(foodcritic_path, ruleID)
+      create_spec_helper(foodcritic_path)
       
     end
 
     def create_foodcritic_rule(foodcritic_path, ruleID, ruleDesc)
 
-      rule = File.join(foodcritic_path, "lib","Fourth", "#{ruleID.upcase}.rb")
+      rule = File.join(foodcritic_path, "rules", "#{ruleID.upcase}.rb")
 
       unless File.exists?(rule)
 
+        FileUtils.mkdir_p File.dirname(rule)
+
         puts "** Creating #{ruleID} at #{rule}"
 
         File.open(rule, 'w') do |file|
@@ -55,15 +58,21 @@ end
     def create_cookbook(foodcritic_path, ruleID)
 
       cookbook_folder = File.join(foodcritic_path, "cookbooks" )
-      puts "** Cookbooks directory: #{cookbook_folder}"
-      a = Chef::Knife::CookbookCreate.new
-      a.create_cookbook(cookbook_folder, ruleID.downcase, Chef::Config[:cookbook_copyright] , Chef::Config[:cookbook_license])
-      a.create_metadata(cookbook_folder, ruleID.downcase, Chef::Config[:cookbook_copyright], Chef::Config[:cookbook_email], Chef::Config[:cookbook_license], "md")
-      a.create_readme(cookbook_folder, ruleID.downcase, "md")
-
+     
+      
       valid_recipe = File.join(foodcritic_path, "cookbooks", ruleID.downcase, "recipes", "valid.rb")
 
       unless File.exists?(valid_recipe)
+
+        puts "** Cookbooks directory: #{cookbook_folder}"
+
+        FileUtils.mkdir_p File.dirname(cookbook_folder)
+          
+        a = Chef::Knife::CookbookCreate.new
+        a.create_cookbook(cookbook_folder, ruleID.downcase, Chef::Config[:cookbook_copyright] , Chef::Config[:cookbook_license])
+        a.create_metadata(cookbook_folder, ruleID.downcase, Chef::Config[:cookbook_copyright], Chef::Config[:cookbook_email], Chef::Config[:cookbook_license], "md")
+        a.create_readme(cookbook_folder, ruleID.downcase, "md")
+
         File.open(valid_recipe, 'w') do |file|
           file.write <<-EOH
 #
@@ -82,9 +91,14 @@ EOH
 
       spec = File.join(foodcritic_path, "spec","rules", "#{ruleID.upcase}_spec.rb")
 
-      puts "** Creating spec file at #{spec}"
+      
 
       unless File.exists?(spec)
+
+        puts "** Creating spec file at #{spec}"
+
+        FileUtils.mkdir_p File.dirname(spec)
+
         File.open(spec, 'w') do |file|
           file.write <<-EOH
 require_relative '../spec_helper'
@@ -108,5 +122,43 @@ end
 
     end
 
+    def create_spec_helper(foodcritic_path)
+
+      spec = File.join(foodcritic_path, "spec","spec_helper.rb") 
+
+      unless File.exists?(spec)
+
+        puts "** Creating spec helper file at #{spec}"
+
+        File.open(spec, 'w') do |file|
+          
+file.write %q{require 'rspec'
+require 'foodcritic'
+
+PROJECT_ROOT = File.expand_path(File.dirname(__FILE__))
+
+def foodcritic_run(ruleid)
+  fc = FoodCritic::Linter.new
+
+  cb_path = File.join(PROJECT_ROOT, '..' , 'cookbooks', ruleid.downcase)
+
+  opts = {
+    :cookbook_paths => cb_path,
+    :include_rules => File.join(PROJECT_ROOT,'..','rules',"#{ruleid}.rb"),
+    :tags => [ruleid.upcase]
+  }
+
+  fc.check(opts)
+end
+
+def warnings(fc_run)
+  fc_run.warnings.collect { |w| File.basename(w.match[:filename]) }.uniq
+end
+}
+        end
+      end
+
+    end
+
   end
 end

data/lib/chef/knife/delete_foodcritic_rule.rb

@@ -0,0 +1,53 @@
+require 'chef/knife'
+
+module Foodcritic
+  class FoodcriticRuleDelete < Chef::Knife
+
+    banner "knife foodcritic rule delete"  
+
+    def run
+
+      foodcritic_path = File.expand_path("./foodcritic")
+      ruleID = name_args.first
+
+      delete_foodcritic_rule(foodcritic_path, ruleID)
+      delete_specs(foodcritic_path, ruleID)
+      delete_cookbook(foodcritic_path, ruleID)
+      
+    end
+
+    def delete_foodcritic_rule(foodcritic_path, ruleID)
+      path = File.join(foodcritic_path, "lib","Fourth", "#{ruleID.upcase}.rb")
+
+      if File.exists? path
+        puts "** Deleting rule file at #{path}"
+        FileUtils.rm path
+      end
+
+    end
+
+    def delete_cookbook(foodcritic_path, ruleID)
+
+      path = File.join(foodcritic_path, "cookbooks", ruleID)
+      
+      if File.exists? path
+        puts "** Deleting cookbook at #{path}"
+        FileUtils.rm_rf path
+      end
+      
+    end
+
+    def delete_specs(foodcritic_path, ruleID)
+
+      
+      path = File.join(foodcritic_path, "spec","rules", "#{ruleID.upcase}_spec.rb")
+
+      if File.exists? path
+        puts "** Deleting spec file at #{path}"
+        FileUtils.rm path
+      end
+
+    end
+
+  end
+end

data/lib/knife-foodcritic/version.rb

@@ -1,3 +1,3 @@
 module KnifeFoodcritic
-  VERSION = "0.1.1"
-end
+  VERSION = "0.2.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-foodcritic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: foodcritic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 description: Knife-Foodcritic is a plugin for Chef::Knife which automatically generates
   a new rule file (with an optional description), example spec files and a cookbook
   to test the rule against. It also generates the spec_helper if it doesn't already
@@ -76,6 +92,7 @@ files:
 - Rakefile
 - knife-foodcritic.gemspec
 - lib/chef/knife/create_foodcritic_rule.rb
+- lib/chef/knife/delete_foodcritic_rule.rb
 - lib/knife-foodcritic/version.rb
 homepage: http://www.devopsninjas.com
 licenses:
@@ -92,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1645001205914449469
+      hash: 3583670318698646123
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -101,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1645001205914449469
+      hash: 3583670318698646123
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25