sleeping_king_studios-tasks 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc8e07d6f211c9e3dbf15ddc93b851b6b27114987be947ee082ed67271997d47
-  data.tar.gz: b33121e54e1c6ce5d4c76b03e205985bcee11d551dc958f00acc73fc81b40eb8
+  metadata.gz: c9380cfb581917cac00ae5102325dd895fcbd1364b4d8a53844f9ead55a41173
+  data.tar.gz: 69647411117043bf53bf24c4f47231de7d970de6c3adff412cc4a5228af7939e
 SHA512:
-  metadata.gz: 78f51530a5a325edcd1fca06464a01424fcce2de696e5d365d961bc8a871bfdde893c33b0d230cd1ff8fa67384ef269fdab25618582d98287f6e4c68d8d88366
-  data.tar.gz: b5c7433200eb5c7fb91530136405d52b739491f953aeabc438e8c0d4b5cdbb29003c824a37e1c43deda991624c9e546997e83893751c2996a94d68c065653046
+  metadata.gz: 563983af6ab016118a21b810e8c5b2f61ef915ddee3bdce425f8945c5bf2bfb5dfc21a14acf8a07a7c08776443fd0cf7e46e5f96ff2c708a88f0834e4d856e51
+  data.tar.gz: 0b2d75151cc7513903514ed8f60041c5b7e73b2723373ceedb7f904a65059e8815f100f9cb54f745c6619274650f3ca7b2da063b50082b5548159fcf0d3918d9

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.3.0
+
+- Fix deprecation warnings in Ruby 2.7.
+- Add support for Thor 1.0.
+
 ## 0.2.0
 
 ### Ci

data/lib/sleeping_king_studios/tasks/process_runner.rb

@@ -29,8 +29,8 @@ module SleepingKingStudios::Tasks
     end # method base_command
 
     def build_command **kwargs
-      env  = build_environment(kwargs)
-      opts = build_options(kwargs)
+      env  = build_environment(**kwargs)
+      opts = build_options(**kwargs)
 
       "#{env} #{base_command} #{opts}".strip
     end # method build_command
@@ -52,7 +52,7 @@ module SleepingKingStudios::Tasks
     end # method build_options
 
     def stream_process command
-      Bundler.with_clean_env do
+      unbundled_env do
         IO.popen(command) do |io|
           loop do
             char = io.getc
@@ -60,11 +60,21 @@ module SleepingKingStudios::Tasks
             char ? print(char) : break
           end # loop
         end # popen
-      end # with_clean_env
+      end # with_unbundled_env
     end # method stream_process
 
     def tools
       SleepingKingStudios::Tools::Toolbelt.new
     end # method tools
+
+    def unbundled_env
+      # :nocov:
+      if Bundler.respond_to?(:with_unbundled_env)
+        Bundler.with_unbundled_env { yield }
+      else
+        Bundler.with_clean_env { yield }
+      end
+      # :nocov:
+    end
   end # class
 end # module

data/lib/sleeping_king_studios/tasks/version.rb

@@ -11,7 +11,7 @@ module SleepingKingStudios
       # Major version.
       MAJOR = 0
       # Minor version.
-      MINOR = 2
+      MINOR = 3
       # Patch version.
       PATCH = 0
       # Prerelease version.

data/lib/sleeping_king_studios/tools/toolbox/configuration.rb

@@ -0,0 +1,280 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/tools/core_tools'
+require 'sleeping_king_studios/tools/toolbox'
+
+# :nocov:
+module SleepingKingStudios::Tools::Toolbox
+  # Abstract base class for defining configuration objects.
+  class Configuration # rubocop:disable Metrics/ClassLength
+    # Class methods for configuration objects.
+    module ClassMethods
+      DEFAULT_OPTION = Object.new.freeze
+
+      # Defines a nested namespace for the configuration object.
+      #
+      # A namespace is represented by a nested configuration object, which has
+      # its own options and namespaces.
+      #
+      # @param namespace_name [String] The name of the namespace.
+      #
+      # @yield namespace If a block is given, that block will be executed in the
+      #   context of the newly created namespace.
+      #
+      # @return [Configuration] the created namespace object.
+      def namespace(namespace_name, &block)
+        guard_abstract_class!
+
+        namespace =
+          (@namespaces ||= {}).fetch(namespace_name) do
+            @namespaces[namespace_name] = define_namespace namespace_name
+          end
+
+        namespace.instance_exec(namespace, &block) if block_given?
+
+        namespace
+      end
+
+      # Defines an option for the configuration object.
+      #
+      # A configuration option has a name and a value. It can be defined with a
+      # default value, or to allow or prohibit nil values or restrict possible
+      # values to a given set.
+      #
+      # @param option_name [String] The name of the option.
+      # @param allow_nil [true, false] If false, setting the option value to nil
+      #   or an empty value will raise an error, as will trying to access the
+      #   value when it has not been set. Defaults to false.
+      # @param default [Object] The default value for the option. If this is not
+      #   set, the default value for the option will be nil.
+      # @param enum [Array] An enumerable list of valid values for the option.
+      def option(
+        option_name,
+        allow_nil: false,
+        default:   DEFAULT_OPTION,
+        enum:      nil
+      )
+        guard_abstract_class!
+
+        options = {
+          allow_nil: allow_nil,
+          default:   default,
+          enum:      enum
+        }
+
+        define_option_accessor option_name, options
+        define_option_mutator  option_name, options
+
+        option_name.intern
+      end
+
+      private
+
+      def define_namespace(namespace_name)
+        namespace =
+          Class.new(SleepingKingStudios::Tools::Toolbox::Configuration)
+
+        define_namespace_accessor(namespace_name, namespace)
+
+        namespace
+      end
+
+      def define_namespace_accessor(namespace_name, namespace_class)
+        namespace_ivar = :"@#{namespace_name}"
+
+        define_method namespace_name do |&block|
+          if instance_variable_defined?(namespace_ivar)
+            return instance_variable_get(namespace_ivar).tap do |config|
+              block&.call(config)
+            end
+          end
+
+          initialize_namespace(namespace_name, namespace_class, &block)
+        end
+      end
+
+      def define_option_accessor(option_name, options)
+        define_method option_name do
+          get_value(option_name, options)
+        end
+      end
+
+      def define_option_mutator(option_name, options)
+        writer_name = :"#{option_name}="
+
+        define_method writer_name do |value|
+          set_value(option_name, value, options)
+        end
+      end
+
+      def guard_abstract_class!
+        return unless self == SleepingKingStudios::Tools::Toolbox::Configuration
+
+        raise "can't define namespace or option on abstract class"
+      end
+    end
+    extend ClassMethods
+
+    DEFAULT_OPTION = ClassMethods::DEFAULT_OPTION
+
+    # @param data [Hash, Object] The data source used to populate configuration
+    #   values. Can be a Hash or a data object. If the data source is nil, or no
+    #   data source is given, values will be set to their respective defaults.
+    #
+    # @yieldparam [Class] The singleton class of the new configuration object.
+    def initialize(data = nil)
+      @data           = convert_data_to_struct(data)
+      @root_namespace = self
+
+      return unless block_given?
+
+      SleepingKingStudios::Tools::CoreTools
+        .deprecate('Configuration#initialize with a block')
+
+      yield(singleton_class)
+    end
+
+    def [](key)
+      send(key) if respond_to?(key)
+    end
+
+    def []=(key, value)
+      send(:"#{key}=", value) if respond_to?(key)
+    end
+
+    def dig(*keys)
+      keys.reduce(self) do |config, key|
+        value = config[key]
+
+        return value if value.nil?
+
+        value
+      end
+    end
+
+    def fetch(key, default = DEFAULT_OPTION)
+      return send(key) if respond_to?(key)
+
+      return default unless default == DEFAULT_OPTION
+
+      return yield(key) if block_given?
+
+      raise KeyError, "key not found: #{key.inspect}"
+    end
+
+    protected
+
+    attr_accessor :root_namespace
+
+    private
+
+    attr_reader :data
+
+    def blank_value?(value)
+      value.nil? || (value.respond_to?(:empty?) && value.empty?)
+    end
+
+    def convert_data_to_struct(data)
+      return data unless data.is_a?(Hash)
+
+      return Object.new if data.empty?
+
+      obj = Struct.new(*data.keys).new
+
+      data.each do |key, value|
+        val = value.is_a?(Hash) ? convert_data_to_struct(value) : value
+
+        obj.send :"#{key}=", val
+      end
+
+      obj
+    end
+
+    def evaluate_default(default)
+      return default unless default.is_a?(Proc)
+
+      root_namespace.instance_exec(&default)
+    end
+
+    def get_default_value(options)
+      value = evaluate_default(options[:default])
+
+      validate_value value, options
+
+      value
+    end
+
+    def get_method_value(name, options)
+      value = data.send(name)
+
+      if value.nil? && options[:default] != DEFAULT_OPTION
+        value = evaluate_default(options[:default])
+      end
+
+      validate_value(value, options)
+
+      value
+    end
+
+    def get_value(name, options)
+      if data.respond_to?(name)
+        get_method_value(name, options)
+      elsif instance_variable_defined?(:"@#{name}")
+        instance_variable_get(:"@#{name}")
+      elsif options[:default] != DEFAULT_OPTION
+        get_default_value(options)
+      else
+        validate_value(nil, options)
+
+        nil
+      end
+    end
+
+    def initialize_namespace(namespace_name, namespace_class, &block)
+      data   = get_value(namespace_name, default: Object.new)
+      config = namespace_class.new(data)
+
+      config.root_namespace = root_namespace || self
+
+      instance_variable_set(:"@#{namespace_name}", config)
+
+      block.call(config) if block_given?
+
+      config
+    end
+
+    def invalid_value_message(value, options)
+      array_tools   = ::SleepingKingStudios::Tools::ArrayTools
+      valid_options =
+        array_tools
+        .humanize_list(
+          options[:enum].map(&:inspect),
+          last_separator: ' or '
+        )
+
+      "expected option to be #{valid_options}, but was #{value.inspect}"
+    end
+
+    def set_value(name, value, options)
+      writer_name = :"#{name}="
+
+      validate_value value, options
+
+      if data.respond_to?(writer_name)
+        data.send(writer_name, value)
+      else
+        # Store values locally if data source is immutable.
+        instance_variable_set(:"@#{name}", value)
+      end
+    end
+
+    def validate_value(value, options)
+      return if blank_value?(value) && options[:allow_nil]
+
+      return unless options[:enum] && !options[:enum].include?(value)
+
+      raise invalid_value_message(value, options)
+    end
+  end
+end
+# :nocov:

metadata

@@ -1,49 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: sleeping_king_studios-tasks
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2020-07-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.19'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.19'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: sleeping_king_studios-tools
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +248,7 @@ files:
 - lib/sleeping_king_studios/tasks/task.rb
 - lib/sleeping_king_studios/tasks/task_group.rb
 - lib/sleeping_king_studios/tasks/version.rb
+- lib/sleeping_king_studios/tools/toolbox/configuration.rb
 homepage: http://sleepingkingstudios.com
 licenses:
 - MIT
@@ -281,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A tasks toolkit for rapid development.