poise-derived 0 → 1.0.0

data/lib/poise_derived.rb

@@ -0,0 +1,22 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# 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.
+#
+
+
+module PoiseDerived
+  autoload :DSL, 'poise_derived/dsl'
+  autoload :LazyAttribute, 'poise_derived/lazy_attribute'
+  autoload :VERSION, 'poise_derived/version'
+end

data/lib/poise_derived/cheftie.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# 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.
+#
+
+require 'poise_derived/core_ext'
+require 'poise_derived/handler'

data/lib/poise_derived/core_ext.rb

@@ -0,0 +1,28 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# 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.
+#
+
+require 'poise_derived/core_ext/deep_merge'
+require 'poise_derived/core_ext/string'
+
+
+module PoiseDerived
+  # Here be dragons.
+  #
+  # @since 1.0.0
+  # @api private
+  module CoreExt
+  end
+end

data/lib/poise_derived/core_ext/deep_merge.rb

@@ -0,0 +1,55 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# 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.
+#
+
+require 'chef/mixin/deep_merge'
+
+require 'poise_derived/lazy_attribute'
+
+
+module PoiseDerived
+  module CoreExt
+    # Monkey-patch deep merge to carry over LazyAttribute on override. This means
+    # that if a lazy is set in a cookbook and then that attribute is overridden
+    # in a role or another cookbook, the override value gets wrapped in a
+    # LazyAttribute too so it will act as a template string. There is no way to
+    # put a block in JSON data so that would have to be explicit.
+    #
+    # @since 1.0.0
+    # @api private
+    module DeepMerge
+      def deep_merge!(source, dest)
+        if source.is_a?(PoiseDerived::LazyAttribute) && dest.is_a?(String)
+          source._override(dest)
+        else
+          super
+        end
+      end
+
+      def hash_only_merge!(merge_onto, merge_with)
+        if merge_onto.is_a?(PoiseDerived::LazyAttribute) && merge_with.is_a?(String)
+          merge_onto._override(merge_with)
+        else
+          super
+        end
+      end
+
+      # Kinder, gentler monkey patching. The singleton_class is the important
+      # one since everything in Chef calls these are module methods.
+      Chef::Mixin::DeepMerge.prepend(self)
+      Chef::Mixin::DeepMerge.singleton_class.prepend(self)
+    end
+  end
+end

data/lib/poise_derived/core_ext/string.rb

@@ -0,0 +1,35 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# 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.
+#
+
+require 'poise_derived/lazy_attribute'
+
+
+# Monkeypatch String so that our magic works in case statements. If you're
+# reading this, something has probably gone wrong. I'm so sorry.
+#
+# @since 1.0.0
+# @api private
+class String
+  old_method = method(:===)
+  define_singleton_method(:===) do |obj|
+    if obj.class <= ::PoiseDerived::LazyAttribute
+      true
+    else
+      old_method.call(obj)
+    end
+  end
+end
+

data/lib/poise_derived/dsl.rb

@@ -0,0 +1,45 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# 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.
+#
+
+require 'chef/node'
+
+require 'poise_derived/lazy_attribute'
+
+
+module PoiseDerived
+  module DSL
+    def _lazy_attribute(str=nil, &block)
+      PoiseDerived::LazyAttribute.new(self, str, &block)
+    end
+
+    # Install the DSL addition globally.
+    #
+    # @return [void]
+    def self.install
+      Chef::Log.debug('[poise-derived] Installing node DSL')
+      Chef::Node.prepend(self)
+      alias_method(:lazy, :_lazy_attribute)
+    end
+
+    # Disable the DSL extension so `node.lazy` will no longer work.
+    #
+    # @return [void]
+    def self.uninstall
+      Chef::Log.debug('[poise-derived] Uninstalling node DSL')
+      remove_method(:lazy)
+    end
+  end
+end

data/lib/poise_derived/handler.rb

@@ -0,0 +1,43 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# 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.
+#
+
+require 'chef/chef_class'
+require 'chef/event_dispatch/base'
+
+require 'poise_derived/dsl'
+
+
+module PoiseDerived
+  # A small event handler to install and uninstall our DSL addition so it only
+  # appears during attribute compilation. Is this a good idea?
+  #
+  # @api private
+  class Handler < Chef::EventDispatch::Base
+    include Singleton
+
+    def attribute_load_start(count)
+      PoiseDerived::DSL.install
+    end
+
+    def attribute_load_complete
+      PoiseDerived::DSL.uninstall
+    end
+
+    # Install event handler.
+    Chef::Log.debug('[poise-derived] Installing event handler')
+    Chef.run_context.events.register(self.instance)
+  end
+end

data/lib/poise_derived/lazy_attribute.rb

@@ -0,0 +1,125 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# 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.
+#
+
+
+module PoiseDerived
+  # A class to lazily evaluate node attributes either from format strings or
+  # code blocks.
+  #
+  # @example Cookbook attributes file
+  #   default['mycookbook']['version'] = '1.0'
+  #   default['mycookbook']['url'] = lazy 'https://example.com/myapp-%{mycookbook.version}.zip'
+  class LazyAttribute
+    # Parser regexp for format strings.
+    # @api private
+    FORMAT_STRING_REGEXP = /%\{([^}]+)\}/
+
+    def initialize(node, str=nil, &block)
+      unless (!!str) ^ (!!block)
+       raise ArgumentError.new('Either a string or block must be passed when creating a lazy attribute')
+      end
+      @node = node
+      @value = str || block
+    end
+
+    # Shorter inspect output for debugging so we don't vomit the node into the
+    # log or spec output.
+    #
+    # @return [String]
+    def inspect
+      if @value.is_a?(Proc)
+        "#<#{self.class.name} @value=proc>"
+      else
+        "#<#{self.class.name} @value=#{@value.inspect}>"
+      end
+    end
+
+    # Return a copy of this attribute with the same node context but an
+    # override value as the format string. This can't support blocks because of
+    # how it is called generally.
+    #
+    # @api private
+    # @see PoiseDerived::CoreExt
+    # @return [PoiseDerived::LazyAttribute]
+    def _override(str)
+      self.class.new(@node, str)
+    end
+
+    # @!group delegators
+    # Delegate to the lazy value.
+    # @api private
+    def method_missing(method, *args, &block)
+      _evaluate.send(method, *args, &block)
+    end
+
+    # Delegate to the lazy value.
+    # @api private
+    def respond_to_missing?(method, include_all)
+      _evaluate.respond_to?(method, include_all)
+    end
+
+    # Delegate to the lazy value.
+    # @api private
+    def to_s
+      _evaluate.to_s
+    end
+
+    # Make sure we implement to_str because that activates the == hack.
+    # @api private
+    def to_str
+      to_s
+    end
+
+    # Fake is_a? and kind_of? for params_validate and `_pv_kind_of`.
+    # @api private
+    def is_a?(klass)
+      return true if Object.instance_method(:is_a?).bind(self).call(klass)
+      klass <= String
+    end
+
+    # @api private
+    # @see is_a?
+    alias_method :kind_of?, :is_a?
+
+    # Specifically delegate == because not caught by method_missing.
+    # @api private
+    def ==(other)
+      _evaluate == other
+    end
+    # !@endgroup
+
+    private
+
+    # Evaluate the lazy attribute.
+    #
+    # @return [Object]
+    def _evaluate
+      return @evaluate_cache if defined?(@evaluate_cache)
+      @evaluate_cache = if @value.is_a?(Proc)
+        # Block mode, just run the block.
+        @node.instance_eval(&@value).to_s
+      else
+        # String mode, parse the template string and fill it in.
+        format_keys = @value.scan(FORMAT_STRING_REGEXP).inject({}) do |memo, (key)|
+          # Keys must be symbols because Ruby.
+          memo[key.to_sym] = key.split(/\./).inject(@node) {|n, k| n.nil? ? n : n[k] }
+          memo
+        end
+        @value % format_keys
+      end
+    end
+  end
+end

data/lib/poise_derived/version.rb

@@ -0,0 +1,20 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# 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.
+#
+
+
+module PoiseDerived
+  VERSION = '1.0.0'
+end

data/poise-derived.gemspec

@@ -0,0 +1,41 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# 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.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poise_derived/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'poise-derived'
+  spec.version = PoiseDerived::VERSION
+  spec.authors = ['Noah Kantrowitz']
+  spec.email = %w{noah@coderanger.net}
+  spec.description = 'A Chef cookbook for defining lazily evaluated node attributes.'
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/poise/poise-derived'
+  spec.license = 'Apache 2.0'
+
+  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 = %w{lib}
+
+  spec.add_dependency 'chef', '~> 12.3'
+  spec.add_dependency 'halite', '~> 1.0'
+
+  spec.add_development_dependency 'poise', '~> 2.0'
+  spec.add_development_dependency 'poise-boiler', '~> 1.0'
+end

data/test/cookbook/attributes/default.rb

@@ -0,0 +1,46 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# 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.
+#
+
+# Baseline for sanity.
+default['a']['value'] = 'a'
+
+default['b']['value'] = lazy 'b'
+
+default['c']['one'] = '1'
+default['c']['value'] = lazy '%{c.one}'
+
+default['d']['value'] = lazy { 'd' }
+
+default['e']['one'] = 1
+default['e']['two'] = '2'
+default['e']['value'] = lazy '%{e.one} %{e.two}'
+
+# This value is changed later.
+default['f']['one'] = '1'
+default['f']['value'] = lazy '%{f.one}'
+
+# This value is changed later.
+default['g']['one'] = '1'
+default['g']['value'] = lazy { node['g']['one'] }
+
+# This template is changed later.
+default['h']['one'] = '1'
+default['h']['two'] = '2'
+default['h']['value'] = lazy 'one %{h.one}'
+
+default['i']['one'] = '1'
+default['i']['two'] = lazy 'one %{i.one}'
+default['i']['value'] = lazy 'two %{i.two} 2'