garcun 0.0.2

data/lib/garcon/chef/validations.rb

@@ -0,0 +1,76 @@
+# encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# 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 'uri'
+
+# Resource validations.
+#
+module Garcon
+  module Resource
+    module Validations
+      module ClassMethods
+        # Callback for source URL validation.
+        #
+        # @return [Proc]
+        #
+        def source_callbacks
+          { 'Source must be an absolute URI' => ->(src) { valid_source?(src) }}
+        end
+
+        # Validate that the source attribute is an absolute URI or file and not
+        # an not empty string.
+        #
+        # @param [String]
+        #
+        # @return [Boolean]
+        #
+        def valid_source?(source)
+          absolute_uri?(source) ? true : ::File.exist?(source)
+        end
+
+        # Boolean, true if source is an absolute URI, false otherwise.
+        #
+        # @param [String] source
+        #
+        # @return [Boolean]
+        #
+        def absolute_uri?(source)
+          source =~ URI::ABS_URI && URI.parse(source).absolute?
+        rescue URI::InvalidURIError
+          false
+        end
+
+        # Hook called when module is included, extends a descendant with class
+        # and instance methods.
+        #
+        # @param [Module] descendant
+        #   The module or class including Garcon::Resource::Validations
+        #
+        # @return [self]
+        #
+        def included(descendant)
+          super
+          descendant.extend ClassMethods
+        end
+      end
+
+      extend ClassMethods
+    end
+  end
+end

data/lib/garcon/chef_inclusions.rb

@@ -0,0 +1,151 @@
+# encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# 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_relative 'chef/chef_helpers'
+require_relative 'chef/log'
+require_relative 'chef/node'
+require_relative 'chef/secret_bag'
+require_relative 'chef/validations'
+
+require_relative 'chef/resource/attribute'
+require_relative 'chef/resource/base_dsl'
+require_relative 'chef/resource/blender'
+require_relative 'chef/resource/lazy_eval'
+require_relative 'chef/resource/resource_name'
+
+module Garcon
+  # Extend Resource with class and instance methods.
+  #
+  module Resource
+    include BaseDSL
+    include LazyEval
+    include Validations
+    include ResourceName
+    include Garcon::UrlHelper
+    include Garcon::FileHelper
+
+    module ClassMethods
+      # Interpolate node attributes automatically.
+      #
+      def interpolate(namespace = nil)
+        node.set[namespace] = interpolate(Garcon.config.stash[namespace])
+      end
+
+      # Combine a resource and provider class for quick and easy oven baked
+      # goodness. Never has cooking been this fun since the invention of the
+      # grocery store!
+      #
+      def blender
+        include Garcon::Resource::Blender
+      end
+
+      # Hook called when module is included, extends a descendant with class
+      # and instance methods.
+      #
+      # @param [Module] descendant
+      #   the module or class including Garcon
+      #
+      # @return [self]
+      #
+      # @api private
+      def included(descendant)
+        super
+        descendant.extend ClassMethods
+      end
+    end
+
+    extend ClassMethods
+  end
+
+  # Extend Provider with class and instance methods.
+  #
+  module Provider
+    include BaseDSL
+    include Garcon::Retry
+    include Garcon::Timeout
+    include Garcon::UrlHelper
+    include Garcon::FileHelper
+    include Garcon::ChefHelpers
+  end
+
+  # Hook called when module is included, extends a descendant with class
+  # and instance methods.
+  #
+  # @param [Module] descendant
+  #   the module or class including Garcon
+  #
+  # @return [self]
+  #
+  # @api private
+  def self.included(descendant)
+    super
+    if descendant < Chef::Resource
+      descendant.class_exec { include Garcon::Resource }
+    elsif descendant < Chef::Provider
+      descendant.class_exec { include Garcon::Provider }
+    end
+  end
+end
+
+def Garcon(opts = {})
+  if opts.is_a?(Class)
+    opts = { parent: opts }
+  end
+
+  mod = Module.new
+
+  def mod.name
+    super || 'Garcon'
+  end
+
+  mod.define_singleton_method(:included) do |base|
+    super(base)
+    base.class_exec { include Garcon }
+    if base < Chef::Resource
+      base.interpolate(opts[:node], opts[:namespace]) if opts[:interpolate]
+      base.blender if opts[:blender]
+    end
+  end
+
+  mod
+end
+
+unless Chef::Recipe.ancestors.include?(Garcon::ChefHelpers)
+  Chef::Recipe.send(:include,   Garcon::ChefHelpers)
+  Chef::Resource.send(:include, Garcon::ChefHelpers)
+  Chef::Provider.send(:include, Garcon::ChefHelpers)
+end
+
+unless Chef::Recipe.ancestors.include?(Garcon::Interpolation)
+  Chef::Recipe.send(:include,   Garcon::Interpolation)
+  Chef::Resource.send(:include, Garcon::Interpolation)
+  Chef::Provider.send(:include, Garcon::Interpolation)
+end
+
+unless Chef::Resource.method_defined?(:run_now)
+  Chef::Resource.send(:include, Garcon::RunNow::Mixin)
+end
+
+require_relative 'chef/provider/civilize'
+require_relative 'chef/provider/download'
+require_relative 'chef/provider/house_keeping'
+require_relative 'chef/provider/node_cache'
+require_relative 'chef/provider/partial'
+require_relative 'chef/provider/recovery'
+require_relative 'chef/provider/zip_file'

data/lib/garcon/configuration.rb

@@ -0,0 +1,138 @@
+# encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# 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 Garcon
+  # Configuration instance
+  #
+  class Configuration
+
+    # Access the minimum number of threads setting for this instance.
+    attr_accessor :min_threads
+
+    # Access the maximum number of threads setting for this instance.
+    attr_accessor :max_threads
+
+    # @!attribute [rw] auto_terminate_global_executors
+    #   @return [Boolean] Defines if global executors should be auto-terminated
+    #     with an `at_exit` callback. When set to `false` it will be the
+    #     application programmer's responsibility to ensure that the global
+    #     thread pools are shutdown properly prior to application exit.
+    attr_accessor :auto_terminate_global_executors
+
+    # @!attribute [rw] auto_terminate_all_executors
+    #   @return [Boolean] Defines if global executors should be auto-terminated
+    #     with an `at_exit` callback. When set to `false` it will be the
+    #     application programmer's responsibility to ensure that the global
+    #     thread pools are shutdown properly prior to application exit.
+    attr_accessor :auto_terminate_all_executors
+
+    # Global thread pool optimized for short, fast *operations*.
+    #
+    # @!attribute [ro] global_fast_executor
+    #   @return [ThreadPoolExecutor] the thread pool
+    attr_reader :global_fast_executor
+
+    # Global thread pool optimized for long, blocking (IO) *tasks*.
+    #
+    # @!attribute [ro] global_io_executor
+    #   @return [ThreadPoolExecutor] the thread pool
+    attr_reader :global_io_executor
+
+    # Global thread pool user for global *timers*.
+    #
+    # @!attribute [ro] global_timer_set
+    #   @return [Garcon::TimerSet] the thread pool
+    attr_reader :global_timer_set
+
+    # Initialized a configuration instance.
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def initialize(opts = {})
+      @min_threads = opts.fetch(:min_threads, [2, Garcon.processor_count].max)
+      @max_threads = opts.fetch(:max_threads,     Garcon.processor_count * 100)
+
+      @crypto = Crypto::Configuration.new
+      @secret = Secret::Configuration.new
+
+      @auto_terminate_global_executors = AtomicBoolean.new(true)
+      @auto_terminate_all_executors    = AtomicBoolean.new(true)
+
+      @global_fast_executor = Delay.new do
+        Garcon.new_fast_executor(
+          stop_on_exit: @auto_terminate_global_executors.value)
+      end
+
+      @global_io_executor = Delay.new do
+        Garcon.new_io_executor(
+          stop_on_exit: @auto_terminate_global_executors.value)
+      end
+
+      @global_timer_set = Delay.new do
+        TimerSet.new(stop_on_exit: @auto_terminate_global_executors.value)
+      end
+
+      yield self if block_given?
+    end
+
+    # Access the crypto for this instance and optional configure a
+    # new crypto with the passed block.
+    #
+    # @example
+    #   Garcon.config do |c|
+    #     c.crypto.password = "!mWh0!s@y!m"
+    #     c.crypto.salt     = "9e5f851900cad8892ac8b737b7370cbe"
+    #   end
+    #
+    # @return [Crypto]
+    #
+    # @api private
+    def crypto(&block)
+      @crypto = Crypto::Configuration.new(&block) if block_given?
+      @crypto
+    end
+
+    # Access the secret stash hash cash store for this instance and optional
+    # configure a new secret with the passed block.
+    #
+    # @return [Secret]
+    #
+    # @api private
+    def secret(&block)
+      @secret = Secret::Configuration.new(&block) if block_given?
+      @secret
+    end
+
+    # @api private
+    def to_h
+      { crypto:                          crypto,
+        secret:                          secret,
+        blender:                         blender,
+        min_threads:                     min_threads,
+        max_threads:                     max_threads,
+        global_timer_set:                global_timer_set,
+        global_io_executor:              global_io_executor,
+        global_fast_executor:            global_fast_executor,
+        auto_terminate_all_executors:    auto_terminate_all_executors,
+        auto_terminate_global_executors: auto_terminate_global_executors
+      }.freeze
+    end
+  end
+end

data/lib/garcon/core_ext.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# 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_relative 'core_ext/array'
+require_relative 'core_ext/binding'
+require_relative 'core_ext/boolean'
+require_relative 'core_ext/enumerable'
+require_relative 'core_ext/file'
+require_relative 'core_ext/filetest'
+require_relative 'core_ext/hash'
+require_relative 'core_ext/kernel'
+require_relative 'core_ext/lazy'
+require_relative 'core_ext/method_access'
+require_relative 'core_ext/nil'
+require_relative 'core_ext/numeric'
+require_relative 'core_ext/object'
+require_relative 'core_ext/pathname'
+require_relative 'core_ext/process'
+require_relative 'core_ext/random'
+require_relative 'core_ext/string'
+require_relative 'core_ext/struct'
+require_relative 'core_ext/symbol'
+require_relative 'core_ext/time'

data/lib/garcon/core_ext/array.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# 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.
+#
+
+class Array
+  # Get or set state of object. You can think of #object_state as an in-code
+  # form of marshalling.
+  #
+  def object_state(data=nil)
+    data ? replace(data) : dup
+  end
+end

data/lib/garcon/core_ext/binding.rb

@@ -0,0 +1,64 @@
+# encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# 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.
+#
+
+class Binding
+
+  # Returns the call stack, same format as Kernel#caller()
+  #
+  def caller( skip=0 )
+    eval("caller(#{skip})")
+  end
+
+  # Return the line number on which the binding was created.
+  #
+  def __LINE__
+    Kernel.eval("__LINE__", self)
+  end
+
+  # Returns file name in which the binding was created.
+  #
+  def __FILE__
+    Kernel.eval("__FILE__", self)
+  end
+
+  # Return the directory of the file in which the binding was created.
+  #
+  def __DIR__
+    File.dirname(self.__FILE__)
+  end
+
+  # Retreive the current running method.
+  #
+  def __method__
+    Kernel.eval("__method__", self)
+  end
+
+  # Retreive the current running method.
+  #
+  def __callee__
+    Kernel.eval("__callee__", self)
+  end
+
+  # Returns the call stack, in array format.
+  def callstack(level=1)
+    eval( "callstack( #{level} )" )
+  end
+  alias_method :call_stack, :callstack
+end
+