chef-gen-flavors 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f72906ef7e1128c8a165ff27e2552452e9dff66d
-  data.tar.gz: 52ff5b57d993cd32c412f05f74ad8f407b308d64
+  metadata.gz: add24d646e518bc09136c0a9408a401b5cf2061b
+  data.tar.gz: a18a07d894bc08162243b83a3eeffb10721459dc
 SHA512:
-  metadata.gz: 44a3d2d8706036b51de5769e26e8746e9a404949d6735563ddc7c23989aeac9dd13041f01fa09fc1a98fe5c1e73e73bed1a1282c381eeccd5227c3ffa4aa938c
-  data.tar.gz: 9350287247b69bcf12a3a80b7099c9cf965b2ca9cff1956958c80b08ce0cba13133d318a7cb8872a9ce22b80ba7f322c6bbff88d6d82c4b9f2b21a1560cd7ad4
+  metadata.gz: 057890d70675eaff78246d63fe20c1e4a3f90407da51c763676a61e42c758068c662eae72c0d5563914a1732609b0bb7e42968435298a5b2d730547d3e8cf48e
+  data.tar.gz: b5b3e8661789f468ec57a5c9ba91da998a34bee40be504c5a504625d3ac94a538945ffdd0cc93c5cb371ded68d5559c0f0b5cebb6fe41ab0ce739a5c219c4954

data/History.md

@@ -1,4 +1,8 @@
-# Changelog for chef-gen-template
+# Changelog for chef-gen-flavors
+
+## 0.6.0
+
+* copy the contents of the code generator to a temporary path.  This is foundational work for allow snippets to include content as well as resource declarations
 
 ## 0.5.0
 

data/README.md

@@ -115,6 +115,12 @@ The directory structure of a plugin looks like this:
             └── flavor
                 └── example.rb
 
+It is important that the name of the directory in which your generator
+cookbook lives matches the name in metadata.rb.  ChefDK uses the last
+element of the path as the cookbook name, so if you put your cookbook
+in a folder called 'cookbook' but your metadata.rb declares the name
+as 'code_generator', ChefDK won't be able to find your recipe.
+
 ## ALTERNATE code_generator PATHS
 
 By default, the code_generator cookbook is assumed to live in a directory
@@ -154,6 +160,21 @@ For compatibility with all platforms supported by ChefDK, plugins should use
 the methods in the `File` class to construct relative paths rather than
 assuming what the path separator should be.
 
+## GENERATOR PATH COPY
+
+When #path is called, chef-gen-flavors makes a copy of the selected
+generator cookbook to a temporary path, which is what gets returned
+and used by ChefDK.  This path is cleaned up at exit unless the environment
+variable CHEFGEN_NOCLEANTMP is set.
+
+This temporary path is set as an attribute in the ChefDK Generator
+context, and can be retrieved in a flavor by calling
+
+    ChefDK::Generator.context.generator_path
+
+This is foundational work to allow snippets to include content as well
+as declarations of what files they will render.
+
 ## FLAVOR BASE CLASS
 
 Inside of your plugin's code_generator cookbook, you can do anything that

data/lib/chef_gen/flavors.rb

@@ -1,3 +1,4 @@
+require 'tmpdir'
 require 'little-plugger'
 
 require 'chef_gen/flavor'
@@ -7,14 +8,14 @@ module ChefGen
   # a plugin framework for creating ChefDK generator flavors
   class Flavors
     # the version of the gem
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
 
     extend LittlePlugger path: 'chef_gen/flavor',
                          module: ChefGen::Flavor
 
     class << self
-      # return the path to to the code_generator cookbook for
-      # the selected ChefGen Flavor
+      # return the path to to the copy of the generator cookbook
+      # for the selected ChefGen Flavor
       # @return [String] the path to the code_generator cookbook
       def path
         # then take a copy so we can augment it
@@ -26,7 +27,10 @@ module ChefGen
                    fail('no ChefGen flavors found!')
         path = generator_path(selected)
         $stdout.puts "using ChefGen flavor '#{selected}' in #{path}"
-        path
+        copy = copy_generator_dir(path, selected)
+        ChefDK::Generator.add_attr_to_context('generator_path', copy)
+        $stdout.puts "using copy of generator in #{copy}"
+        copy
       end
 
       private
@@ -156,6 +160,23 @@ module ChefGen
           spec.gem_dir, 'lib', 'chef-dk', 'skeletons', 'code_generator'
         )
       end
+
+      # recursively copies the generator cookbook to a temporary
+      # directory.  Sets up an at_exit handler to remove the
+      # temporary directory unless CHEFGEN_NOCLEANTMP is set
+      # in the environment.
+      # @param srcdir [String] the path to the generator cookbook
+      # @return [String] the temporary path to generate from
+      def copy_generator_dir(srcdir, selected)
+        dstdir = Dir.mktmpdir('chefgen_flavor.')
+        at_exit {
+          $stdout.puts "cleaning up generator copy in ${dstdir}"
+          FileUtils.rm_rf(dstdir)
+        } unless ENV.key?('CHEFGEN_NOCLEANTMP')
+        $stdout.puts "copying #{srcdir} to #{dstdir}"
+        FileUtils.cp_r(srcdir, dstdir)
+        File.join(dstdir, File.basename(srcdir))
+      end
     end
   end
 end

data/spec/lib/chef_gen/flavors_spec.rb

@@ -103,14 +103,30 @@ RSpec.describe ChefGen::Flavors do
   it 'should default the code_generator path' do
     ChefGen::Flavors.disregard_plugin :baz
     ENV['CHEFGEN_FLAVOR'] = 'Foo'
-    expect(ChefGen::Flavors.path)
-      .to match(%r{spec/support/fixtures/code_generator$})
+    expect(FileUtils).to receive(:cp_r).with(
+      %r{spec/support/fixtures/code_generator$}, String
+    )
+    ChefGen::Flavors.path
   end
 
   it 'should respect an overridden code_generator path' do
     ChefGen::Flavors.disregard_plugin :baz
     ENV['CHEFGEN_FLAVOR'] = 'Bar'
+    expect(FileUtils).to receive(:cp_r).with(
+      %r{spec/support/fixtures/code_generator_2$}, String
+    )
+    ChefGen::Flavors.path
+  end
+
+  it 'should copy the code_generator to a temp directory' do
+    ChefGen::Flavors.disregard_plugin :baz
+    ENV['CHEFGEN_FLAVOR'] = 'Foo'
+    tmpdir = Dir.tmpdir
+    expect(FileUtils).to receive(:cp_r).with(
+      %r{spec/support/fixtures/code_generator$},
+      %r{#{tmpdir}/chefgen_flavor\..+$}
+    )
     expect(ChefGen::Flavors.path)
-      .to match(%r{spec/support/fixtures/code_generator_2$})
+      .to match(%r{#{tmpdir}/chefgen_flavor\..+$})
   end
 end

data/spec/spec_helper.rb

@@ -49,6 +49,7 @@ module ChefDKGeneratorContext
     allow(@ctx).to receive(:cookbook_name).and_return('foo')
     allow(@ctx).to receive(:have_git).and_return(true)
     allow(@ctx).to receive(:skip_git_init).and_return(false)
+    allow(@ctx).to receive(:generator_path=)
     allow(ChefDK::Generator).to receive(:context).and_return(@ctx)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-gen-flavors
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - James FitzGibbon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: little-plugger