chef-gen-flavor-base 0.9.0

data/lib/chef_gen/snippet/attributes.rb

@@ -0,0 +1,35 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # a cookbook that has attributes
+    class Attributes < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'attributes'
+
+      private
+
+      # initializes the snippet in setup mode
+      # @return [void]
+      # @api private
+      def initialize_setup
+        super
+        snippet_content_path = File.expand_path(File.join(static_content_path(__FILE__))) + '/.'
+        @flavor.class.do_add_content do
+          tocopy << [snippet_content_path]
+        end
+      end
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        @flavor.class.do_declare_resources do
+          directories << 'attributes'
+          templates_if_missing << File.join('attributes', 'default.rb')
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/chef_spec.rb

@@ -0,0 +1,121 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # creates a framework for ChefSpec unit testing
+    class ChefSpec < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'chef_spec'
+
+      private
+
+      # initializes the snippet in setup mode
+      # @return [void]
+      # @api private
+      def initialize_setup
+        super
+        snippet_content_path = File.expand_path(File.join(static_content_path(__FILE__))) + '/.'
+        @flavor.class.do_add_content do
+          tocopy << [snippet_content_path]
+        end
+      end
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        declare_files_templates
+        declare_chefignore_patterns
+        declare_cookbook_gems
+        declare_rake_tasks
+        declare_guard_sets
+      end
+
+      # declares directories, files and templates
+      # @return [void]
+      # @api private
+      def declare_files_templates
+        @flavor.class.do_declare_resources do
+          directories << 'spec'
+          directories << File.join('spec', 'recipes')
+          templates << '.rspec'
+          templates_if_missing << File.join('spec', 'spec_helper.rb')
+          templates_if_missing << File.join('spec', 'recipes', 'default_spec.rb')
+          templates_if_missing << File.join('spec', 'chef_runner_context.rb')
+        end
+      end
+
+      # declares chefignore patterns if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_chefignore_patterns
+        @flavor.class.do_declare_resources do
+          if snippet?('standard_ignore')
+            %w(
+              .rspec spec/* spec/fixtures/*
+            ).each do |e|
+              chefignore_patterns << e
+            end
+          end
+        end
+      end
+
+      # declares cookbook_gems if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_cookbook_gems
+        @flavor.class.do_declare_resources do
+          if snippet?('cookbook_base')
+            cookbook_gems['chefspec'] = '~> 4.1'
+            cookbook_gems['guard-rspec'] = '~> 4.5'
+            cookbook_gems['ci_reporter_rspec'] = '~> 1.0'
+          end
+        end
+      end
+
+      # declares rake tasks if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_rake_tasks
+        @flavor.class.do_declare_resources do
+          if snippet?('cookbook_base')
+            rake_tasks['chefspec'] = <<'END'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:chefspec)
+
+desc 'Generate ChefSpec coverage report'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task[:chefspec].invoke
+end
+task spec: :chefspec
+END
+          end
+        end
+      end
+
+      # declares guard sets if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_guard_sets
+        @flavor.class.do_declare_resources do
+          if snippet?('cookbook_base')
+            guard_sets['chefspec'] = <<'END'
+rspec_command = ENV.key?('DISABLE_PRY_RESCUE') ? 'rspec' : 'rescue rspec'
+guard :rspec, all_on_start: true, cmd: "bundle exec #{rspec_command}" do
+  watch(%r{^spec/recipes/.+_spec\.rb$})
+  watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+  watch(%r{^attributes/.+\.rb$})    { 'spec' }
+  watch(%r{^resources/.+\.rb$})     { 'spec' }
+  watch(%r{^providers/.+\.rb$})     { 'spec' }
+  watch(%r{^libraries/.+\.rb$})     { 'spec' }
+  watch(%r{^recipes/(.+)\.rb$})     { |m| "spec/recipes/#{m[1]}_spec.rb" }
+end
+END
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/cookbook_base.rb

@@ -0,0 +1,135 @@
+require 'chef_gen/snippet_base'
+
+require 'chef/mixin/params_validate'
+
+module ChefGen
+  module Snippet
+    # creates the basic files that every cookbook should have
+    # each file is managed through a separate method to allow for
+    # people to mix this in but turn off just one file
+    class CookbookBase < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'cookbook_base'
+
+      # @!attribute [rw] cookbook_gems
+      #   @return [Hash<String,String>] a map of gem names to constraints
+
+      # @!attribute [rw] gem_sources
+      #   @return [Array<String>] a list of gem sources
+
+      # @!attribute [rw] :berks_sources
+      #   @return [Array<String>] a list of cookbook sources
+
+      # @!attribute [rw] :rake_tasks
+      #   @return [Hash<String,String>] a map of task names to Rakefile bodies
+
+      private
+
+      # initializes the snippet in setup mode
+      # @return [void]
+      # @api private
+      def initialize_setup
+        super
+        snippet_content_path = File.expand_path(File.join(static_content_path(__FILE__))) + '/.'
+        @flavor.class.do_add_content do
+          tocopy << [snippet_content_path]
+        end
+      end
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        add_accessors
+        @flavor.class.do_declare_resources do
+          templates_if_missing << 'metadata.rb'
+          templates_if_missing << 'README.md'
+          templates_if_missing << 'CHANGELOG.md'
+        end
+        declare_gemfile
+        declare_berksfile
+        declare_rakefile
+        declare_chefignore_patterns
+      end
+
+      # defines accessors on the flavor for cookbook gems, gem sources,
+      # berks sources and rake tasks
+      # @return [void]
+      # @api private
+      def add_accessors
+        @flavor.class.send(:attr_accessor, :cookbook_gems)
+        @flavor.cookbook_gems = {
+          'rake' => '~> 10.4',
+          'berkshelf' => '~> 3.3'
+        }
+
+        @flavor.class.send(:attr_accessor, :gem_sources)
+        @flavor.gem_sources = %w(https://rubygems.org)
+
+        @flavor.class.send(:attr_accessor, :berks_sources)
+        @flavor.berks_sources = %w(https://supermarket.chef.io)
+
+        @flavor.class.send(:attr_accessor, :rake_tasks)
+        @flavor.rake_tasks = {}
+      end
+
+      # declares the Gemfile with lazy evaluation of the gem list
+      # @return [void]
+      # @api private
+      def declare_gemfile
+        @flavor.class.do_declare_resources do
+          # :nocov:
+          lazy_vars = Chef::DelayedEvaluator.new do
+            { gems: cookbook_gems, sources: gem_sources }
+          end
+          # :nocov:
+          add_templates(%w(Gemfile), :create, variables: lazy_vars)
+        end
+      end
+
+      # declares the Berksfile with lazy evaluation of the sources
+      # @return [void]
+      # @api private
+      def declare_berksfile
+        @flavor.class.do_declare_resources do
+          # :nocov:
+          lazy_vars = Chef::DelayedEvaluator.new do
+            { sources: berks_sources }
+          end
+          # :nocov:
+          add_templates(%w(Berksfile), :create, variables: lazy_vars)
+        end
+      end
+
+      # declares the Rakefile with lazy evaluation of the tasks
+      # @return [void]
+      # @api private
+      def declare_rakefile
+        @flavor.class.do_declare_resources do
+          # :nocov:
+          lazy_vars = Chef::DelayedEvaluator.new do
+            { tasks: rake_tasks }
+          end
+          # :nocov:
+          add_templates(%w(Rakefile), :create, variables: lazy_vars)
+        end
+      end
+
+      # adds patterns to chefignore patterns
+      # @return [void]
+      # @api private
+      def declare_chefignore_patterns
+        @flavor.class.do_declare_resources do
+          if snippet?('standard_ignore')
+            %w(
+              Gemfile Gemfile.lock Rakefile Berksfile Berksfile.lock
+            ).each do |e|
+              chefignore_patterns << e
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/debugging.rb

@@ -0,0 +1,26 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # adds gems useful for debugging cookbooks to the Gemfile
+    class Debugging < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'debugging'
+
+      private
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        @flavor.class.do_declare_resources do
+          cookbook_gems['pry'] = '~> 0.10'
+          cookbook_gems['pry-byebug'] = '~> 3.1'
+          cookbook_gems['pry-rescue'] = '~> 1.4'
+          cookbook_gems['pry-stack_explorer'] = '~> 0.4'
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/example_file.rb

@@ -0,0 +1,36 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # a sample cookbook_file source
+    class ExampleFile < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'example_file'
+
+      private
+
+      # initializes the snippet in setup mode
+      # @return [void]
+      # @api private
+      def initialize_setup
+        super
+        snippet_content_path = File.expand_path(File.join(static_content_path(__FILE__))) + '/.'
+        @flavor.class.do_add_content do
+          tocopy << [snippet_content_path]
+        end
+      end
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        @flavor.class.do_declare_resources do
+          directories << 'files'
+          directories << File.join('files', 'default')
+          files_if_missing << File.join('files', 'default', 'example.conf')
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/example_template.rb

@@ -0,0 +1,36 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # a sample template source
+    class ExampleTemplate < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'example_template'
+
+      private
+
+      # initializes the snippet in setup mode
+      # @return [void]
+      # @api private
+      def initialize_setup
+        super
+        snippet_content_path = File.expand_path(File.join(static_content_path(__FILE__))) + '/.'
+        @flavor.class.do_add_content do
+          tocopy << [snippet_content_path]
+        end
+      end
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        @flavor.class.do_declare_resources do
+          directories << 'templates'
+          directories << File.join('templates', 'default')
+          files_if_missing << File.join('templates', 'default', 'example.conf.erb')
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/git_init.rb

@@ -0,0 +1,36 @@
+require 'chef_gen/snippet_base'
+require 'chef_gen/flavor_base/resource_helpers'
+
+module ChefGen
+  module Snippet
+    # initializes a git repo
+    class GitInit < ChefGen::SnippetBase
+      include ChefGen::FlavorBase::ResourceHelpers
+
+      # the name of the snippet
+      NAME = 'git_init'
+
+      private
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        @flavor.class.do_declare_resources do
+          c = ChefDK::Generator.context
+          if c.have_git && !c.skip_git_init
+            dst = destination_path
+            # :nocov:
+            @recipe.send(:execute, 'initialize git repo') do
+              command('git init .')
+              cwd dst
+            end
+            # :nocov:
+            actions_taken << 'initialize git repo' if snippet?('actions_taken')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/guard.rb

@@ -0,0 +1,70 @@
+require 'chef_gen/snippet_base'
+
+require 'chef/mixin/params_validate'
+
+module ChefGen
+  module Snippet
+    # creates a guardfile and an accessor to define guard sets
+    class Guard < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'guard'
+
+      # @!attribute [rw] :guard_sets
+      #   @return [Hash<String,String>] a map of set names to Guardfile bodies
+
+      private
+
+      # initializes the snippet in setup mode
+      # @return [void]
+      # @api private
+      def initialize_setup
+        super
+        snippet_content_path = File.expand_path(File.join(static_content_path(__FILE__))) + '/.'
+        @flavor.class.do_add_content do
+          tocopy << [snippet_content_path]
+        end
+      end
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        add_accessors
+        declare_guardfile
+        declare_chefignore_patterns
+      end
+
+      # adds accessors to the flavor for guard sets
+      # @return [void]
+      # @api private
+      def add_accessors
+        @flavor.class.send(:attr_accessor, :guard_sets)
+        @flavor.guard_sets = {}
+      end
+
+      # declares the Guardfile with lazy evaluation of the guards
+      # @return [void]
+      # @api private
+      def declare_guardfile
+        @flavor.class.do_declare_resources do
+          # :nocov:
+          lazy_vars = Chef::DelayedEvaluator.new do
+            { guards: guard_sets }
+          end
+          # :nocov:
+          add_templates(%w(Guardfile), :create, variables: lazy_vars)
+        end
+      end
+
+      # adds patterns to chefignore patterns
+      # @return [void]
+      # @api private
+      def declare_chefignore_patterns
+        @flavor.class.do_declare_resources do
+          chefignore_patterns << 'Guardfile' if snippet?('standard_ignore')
+        end
+      end
+    end
+  end
+end