compat_resource 12.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ed9d768d08a398d70638978548f4de2b569f84c
+  data.tar.gz: 58695b3a1aebe67d20c95dee715aa309cd89d1b1
+SHA512:
+  metadata.gz: 764407ed4e04d4a840c616b6393c22f2264c00ee49d0a608257543d37b082d26cf71454e114232ecc221a76fdfe3b95bc738ed13b844ab6757474e81e6e874bd
+  data.tar.gz: 86304dde4a36458892c9966855af7d6c3e17d7254d224531c283f7f7ee0392912ee98706d33076faf38b7a33fe0b8a63991f4de7190e104f7805bb05dc29f074

data/CHANGELOG.md

@@ -0,0 +1 @@
+

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+gem 'stove', '3.2.5'
+if ENV['GEMFILE_MOD']
+  instance_eval(ENV['GEMFILE_MOD'])
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,23 @@
+# compat_resource cookbook
+
+This cookbook brings the custom resource syntax from Chef 12.5 down to earlier
+versions (12.0-12.5).
+
+This cookbook is early days. It has some [travis tests](https://travis-ci.org/jkeiser/compat_resource) verifying the test matrix of rubies and chef versions.
+
+## Usage
+
+To use this cookbook, put `depends 'compat_resource'` in the metadata.rb of your cookbook. Once this is done, you can use all the new custom resource features to define resources. It Just Works.
+
+For example, if you create resources/myresource.rb, myresource can use `property`, `load_current_value` and `action` (no need to create a provider). If you want to create Resource classes directly, extend from `ChefCompat::Resource` instead of `Chef::Resource`. Properties, current value loading, converge_if_changed, and resource_name will all function the same across versions.
+
+## Custom Resources?
+
+Curious about how to use custom resources? Here are the 12.5 docs:
+
+- Docs: https://docs.chef.io/custom_resources.html
+- Slides: https://docs.chef.io/decks/custom_resources.html
+
+## Contributing
+
+Try it! [File issues](https://github.com/jkeiser/compat_resource/issues) or fork and submit a pull request at https://github.com/jkeiser/compat_resource if you see issues.

data/Rakefile

@@ -0,0 +1,191 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'stove/rake_task'
+require 'fileutils'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = FileList['files/spec/**/*_spec.rb']
+end
+Stove::RakeTask.new
+
+task default: :spec
+
+#
+# "rake update" updates the copied_from_chef files so we can grab bugfixes or new features
+#
+CHEF_FILES = %w(chef/constants chef/delayed_evaluator chef/property
+                chef/resource chef/resource/action_class chef/provider chef/dsl/recipe
+                chef/mixin/params_validate)
+SPEC_FILES = %w(unit/property_spec.rb unit/property/state_spec.rb unit/property/validation_spec.rb
+                integration/recipes/resource_action_spec.rb
+                integration/recipes/resource_converge_if_changed_spec.rb
+                integration/recipes/resource_load_spec.rb)
+KEEP_FUNCTIONS = {
+  'chef/resource' => %w(
+    initialize
+
+    name
+
+    resource_name self.use_automatic_resource_name
+
+    identity state state_for_resource_reporter property_is_set reset_property
+    self.properties self.state_properties self.state_attr
+    self.identity_properties self.identity_property self.identity_attrs
+    self.property self.property_type
+    self.lazy
+
+    action allowed_actions self.allowed_actions self.default_action
+    self.action self.declare_action_class self.action_class
+
+    load_current_value current_value_does_not_exist
+    self.load_current_value
+  ),
+  'chef/provider' => %w(
+    initialize
+    converge_if_changed
+    self.use_inline_resources
+    self.include_resource_dsl
+    self.include_resource_dsl_module
+  ),
+}
+KEEP_INCLUDES = {
+  'chef/resource' => %w(Chef::Mixin::ParamsValidate),
+  'chef/provider' => [],
+}
+KEEP_CLASSES = {
+  'chef/provider' => %w(Chef::Provider),
+  'chef/dsl/recipe' => %w(Chef::Recipe::DSL::FullDSL),
+}
+SKIP_LINES = {
+  'chef/dsl/recipe' => [ /include Chef::Mixin::PowershellOut/ ]
+}
+PROCESS_LINES = {
+}
+# See chef_compat/resource for def. of resource_name and provider
+# See chef_compat/monkeypatches/chef/resource for def. of current_value
+
+task :update do
+  # Copy files from chef to chef_compat/chef, with a few changes
+  target_path = File.expand_path("../files/lib/chef_compat/copied_from_chef", __FILE__)
+  chef_gem_path = Bundler.environment.specs['chef'].first.full_gem_path
+  CHEF_FILES.each do |file|
+    output = StringIO.new
+    # Wrap the whole thing in a ChefCompat module
+    output.puts "require 'chef_compat/copied_from_chef'"
+    output.puts "module ChefCompat"
+    output.puts "module CopiedFromChef"
+
+    # Bring over the Chef file
+    chef_contents = IO.read(File.join(chef_gem_path, 'lib', "#{file}.rb"))
+    skip_until = nil
+    keep_until = nil
+    in_class = []
+    chef_contents.lines.each do |line|
+      if keep_until
+        keep_until = nil if keep_until === line
+      else
+
+        if skip_until
+          skip_until = nil if skip_until === line
+          next
+        end
+
+        # If this file only keeps certain functions, detect which function we are
+        # in and only keep those. Also strip comments outside functions
+
+        case line
+
+        # Skip modules and classes that aren't part of our list
+        when /\A(\s*)def\s+([A-Za-z0-9_.]+)/
+          if KEEP_FUNCTIONS[file] && !KEEP_FUNCTIONS[file].include?($2)
+            skip_until = /\A#{$1}end\s*$/
+            next
+          else
+            # Keep everything inside a function no matter what it is
+            keep_until = /\A#{$1}end\s*$/
+          end
+
+        # Skip comments and whitespace if we're narrowing the file (otherwise it
+        # looks super weird)
+        when /\A\s*#/, /\A\s*$/
+          next if KEEP_CLASSES[file] || KEEP_FUNCTIONS[file]
+
+        # Skip aliases/attrs/properties that we're not keeping
+        when /\A\s*(attr_reader|attr_writer|attr_accessor|property|alias)\s*:(\w+)/
+          next if KEEP_FUNCTIONS[file] && !KEEP_FUNCTIONS[file].include?($2)
+
+        # Skip includes and extends that we're not keeping
+        when /\A\s*(include|extend)\s*([A-Za-z0-9_:]+)/
+          next if KEEP_INCLUDES[file] && !KEEP_INCLUDES[file].include?($2)
+
+        end
+
+        next if SKIP_LINES[file] && SKIP_LINES[file].any? { |skip| skip === line }
+      end
+
+      # If we are at the end of a class, pop in_class
+      if in_class[-1] && in_class[-1][:until].match(line)
+        class_name = in_class.pop[:name]
+        # Don't bother printing classes/modules that we're not going to print anything under
+        next if KEEP_CLASSES[file] && !KEEP_CLASSES[file].any? { |c| c.start_with?(class_name) }
+
+      # Detect class open
+      elsif line =~ /\A(\s*)(class|module)(\s+)([A-Za-z0-9_:]+)(\s*<\s*([A-Za-z0-9_:]+))?.*$/
+        indent, type, space, class_name, _, superclass_name = $1, $2, $3, $4, $5, $6
+        full_class_name = in_class[-1] ? "#{in_class[-1][:name]}::#{class_name}" : class_name
+        in_class << { name: full_class_name, until: /\A#{indent}end\s*$/ }
+        superclass_name ||= "Object"
+
+        # Don't print the class open unless it contains stuff we'll keep
+        next if KEEP_CLASSES[file] && !KEEP_CLASSES[file].any? { |c| c.start_with?(full_class_name) }
+
+        # Fix the class to extend from its parent
+        original_class = "::#{full_class_name}"
+        if type == 'class'
+          line = "#{indent}#{type}#{space}#{class_name} < (defined?(#{original_class}) ? #{original_class} : #{superclass_name})"
+        else
+          # Modules have a harder time of it because of self methods
+          line += "#{indent}  if defined?(#{original_class})\n"
+          line += "#{indent}    require 'chef_compat/delegating_class'\n"
+          line += "#{indent}    extend DelegatingClass\n"
+          line += "#{indent}    @delegates_to = #{original_class}\n"
+          line += "#{indent}  end"
+        end
+
+      # If we're not in a class we care about, don't print stuff
+      elsif KEEP_CLASSES[file] && in_class[-1] && !KEEP_CLASSES[file].any? { |c| c == in_class[-1][:name] }
+        next
+      end
+
+      # Modify requires to overridden files to bring in the local version
+      if line =~ /\A(\s*require\s*['"])(.+)(['"]\s*)$/
+        if CHEF_FILES.include?($2)
+          line = "#{$1}chef_compat/copied_from_chef/#{$2}#{$3}"
+        else
+          next
+        end
+      end
+
+      line = PROCESS_LINES[file].call(line) if PROCESS_LINES[file]
+
+      output.puts line
+    end
+    # Close the ChefCompat module declaration from the top
+    output.puts "end"
+    output.puts "end"
+
+    # Write out the file in chef_compat
+    target_file = File.join(target_path, "#{file}.rb")
+    if !File.exist?(target_file) || IO.read(target_file) != output.string
+      puts "Writing #{target_file} ..."
+      FileUtils.mkdir_p(File.dirname(target_file))
+      File.open(target_file, "w") { |f| f.write(output.string) }
+    end
+  end
+
+  # SPEC_FILES.each do |file|
+  #   target_path = File.expand_path("../files/spec/copied_from_chef", __FILE__)
+  #   source_file = File.join(chef_gem_path, 'lib', "#{file}.rb")
+  #   target_file = File.join(target_path, "#{file}")
+  # end
+end

data/files/lib/chef_compat.rb

@@ -0,0 +1,5 @@
+require 'chef_compat/version'
+require 'chef_compat/resource'
+
+module ChefCompat
+end

data/files/lib/chef_compat/copied_from_chef.rb

@@ -0,0 +1,2 @@
+# Because resource does not include chef/provider, we have to do it here
+require 'chef_compat/copied_from_chef/chef/provider'