knife-foodcritic 0.1.1

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in knife-foodcritic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Edmund Dipple
+
+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,4 @@
+knife-foodcritic
+================
+
+A knife plugin that generates boiler plate code for developing and testing custom foodcritic rules

data/Rakefile

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

data/knife-foodcritic.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knife-foodcritic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knife-foodcritic"
+  spec.version       = KnifeFoodcritic::VERSION
+  spec.authors       = ["Edmund Dipple"]
+  spec.email         = ["elmundio1987@gmail.com"]
+  spec.homepage      = "http://www.devopsninjas.com"
+  spec.license       = "GPL"
+  spec.summary       = "A knife plugin for Chef that generates boiler plate code to help develop and test custom foodcritic rules"
+  spec.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 exist."
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "chef"
+
+end

data/lib/chef/knife/create_foodcritic_rule.rb

@@ -0,0 +1,112 @@
+require 'chef/knife'
+require 'chef/knife/cookbook_create'
+
+module Foodcritic
+  class FoodcriticRuleCreate < Chef::Knife
+
+    banner "knife foodcritic rule create"
+
+      option :foodcritic_desc,
+      :short => '-r VALUE',
+      :long => '--description VALUE',
+      :default => "A very nice rule",
+      :description => "What the rule is checking for"
+      
+
+    def run
+
+      unless name_args.size == 1
+        puts "You need to name the rule (eg. FOURTH004)"
+        show_usage
+        exit 1
+      end
+
+      foodcritic_path = File.expand_path("./foodcritic")
+      ruleID = name_args.first
+      ruleDesc = config[:foodcritic_desc]
+
+      create_foodcritic_rule(foodcritic_path, ruleID, ruleDesc)
+      create_specs(foodcritic_path, ruleID)
+      create_cookbook(foodcritic_path, ruleID)
+      
+    end
+
+    def create_foodcritic_rule(foodcritic_path, ruleID, ruleDesc)
+
+      rule = File.join(foodcritic_path, "lib","Fourth", "#{ruleID.upcase}.rb")
+
+      unless File.exists?(rule)
+
+        puts "** Creating #{ruleID} at #{rule}"
+
+        File.open(rule, 'w') do |file|
+          file.write <<-EOH
+rule "#{ruleID.upcase}", '#{ruleDesc}' do 
+  tags %w{}
+  recipe do |ast,filename|
+    #Your rule logic here
+  end
+end
+          EOH
+        end
+      end
+    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)
+        File.open(valid_recipe, 'w') do |file|
+          file.write <<-EOH
+#
+# Cookbook Name:: #{ruleID.downcase}
+# Recipe:: valid
+#
+# Copyright #{Time.now.year}
+#
+EOH
+        end
+      end
+
+    end
+
+    def create_specs(foodcritic_path, ruleID)
+
+      spec = File.join(foodcritic_path, "spec","rules", "#{ruleID.upcase}_spec.rb")
+
+      puts "** Creating spec file at #{spec}"
+
+      unless File.exists?(spec)
+        File.open(spec, 'w') do |file|
+          file.write <<-EOH
+require_relative '../spec_helper'
+
+RSpec.describe :#{ruleID.upcase} do
+  let(:fc_run) do
+  foodcritic_run('#{ruleID.upcase}')
+  end
+  
+  it "generates a warning against the default recipe" do
+    expect(warnings(fc_run)).to include('default.rb')
+  end
+
+  it "does not generate a warning against a valid recipe" do
+    expect(warnings(fc_run)).to_not include('valid.rb')
+  end
+end
+          EOH
+        end
+      end
+
+    end
+
+  end
+end

data/lib/knife-foodcritic/version.rb

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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: knife-foodcritic
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Edmund Dipple
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '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
+  exist.
+email:
+- elmundio1987@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- knife-foodcritic.gemspec
+- lib/chef/knife/create_foodcritic_rule.rb
+- lib/knife-foodcritic/version.rb
+homepage: http://www.devopsninjas.com
+licenses:
+- GPL
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1645001205914449469
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1645001205914449469
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A knife plugin for Chef that generates boiler plate code to help develop
+  and test custom foodcritic rules
+test_files: []