evt-settings 0.5.0.0 → 2.1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15b240e6f595c283986941afb829ea499065593fdd50a27d5f32df7958d0c968
-  data.tar.gz: 44200ae8a2edb411af6613dcbcbe00e608abecc0ddc056811d0d05d16da886ce
+  metadata.gz: 68e0691d8994930cab7259e915ec865bab803c3ff7a025a3eea790c2e769a405
+  data.tar.gz: 5acd8233c2624f5a7883846b51b33ada95f40fa9c5ad64155597178a50d715e2
 SHA512:
-  metadata.gz: 8d665061ae5670648f42b5db434bb1b16b780617d1f7da6007ccad1858d4a83f5f474cd00409ebc98210cc6bddd22ec08a5e9906bf724fa1a8c871e1a1e35269
-  data.tar.gz: 2498f0a1856df3cec33430813fcb752b9bef27a56122f3fcdbd375b7fc6253a6e5e29014eff6ada9351705fcdd7c0184aca45c17036f030a1384459f3b1cf07c
+  metadata.gz: d3765bde5adcfc8f19023d246fdbccc07073d32aa5acf0ce7a8aa5b52bc37f3586541fe06091a34021ae1d1a737a225163438163f09930526232cb92ee2dcfdc
+  data.tar.gz: 259ba6bb657b7beed6fa5dd5dbffd12884819e2b8f5d94543f6ef2ceacdf47ae6001bcc2dbe0bdd23d2b880cb4307c464d0831f52fdfa75d26be8cb0027045fe

data/lib/settings.rb

@@ -1,14 +1,12 @@
 require 'pathname'
 require 'json'
 
-require 'log'
 require 'casing'
 require 'attribute'
-require 'confstruct'
 
-require 'settings/log'
-require 'settings/data_source/data_source'
+require 'settings/data_source'
 require 'settings/data_source/hash'
+require 'settings/data_source/env'
 require 'settings/data_source/file'
 require 'settings/data_source/build'
 require 'settings/registry'

data/lib/settings/controls.rb

@@ -1,3 +1,4 @@
 require 'settings/controls/subject'
 require 'settings/controls/data_source'
+require 'settings/controls/data'
 require 'settings/controls/settings'

data/lib/settings/controls/data.rb

@@ -0,0 +1,54 @@
+class Settings
+  module Controls
+    module Data
+      module Flat
+        module Single
+          def self.example
+            {
+              'some_setting' => 'some value'
+            }
+          end
+        end
+
+        module Multiple
+          def self.example
+            {
+              'some_setting' => 'some value',
+              'some_other_setting' => 'some other value',
+            }
+          end
+        end
+      end
+
+      module Hierarchical
+        def self.example
+          {
+            'some_namespace' => {
+              'some_setting' => 'some value'
+            }
+          }
+        end
+      end
+
+      module CamelCaseKeys
+        def self.example
+          {
+            'someNamespace' => {
+              'someSetting' => 'some value'
+            }
+          }
+        end
+      end
+
+      module SymbolKeys
+        def self.example
+          {
+            :some_namespace => {
+              :some_setting => 'some value'
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/settings/controls/data_source.rb

@@ -7,9 +7,17 @@ class Settings
         end
 
         def self.data
-          {
-            some_setting: 'some value'
-          }
+          Data::Flat::Single.example
+        end
+
+        module SymbolKeys
+          def self.example
+            ::Settings::DataSource::Hash.build(data)
+          end
+
+          def self.data
+            Data::SymbolKeys.example
+          end
         end
       end
 

data/lib/settings/controls/settings.rb

@@ -3,84 +3,44 @@ class Settings
     module Settings
       module SettingAttribute
         def self.example
-          ::Settings.new(data)
+          ::Settings.build(data)
         end
 
         def self.data
-          {
-            "some_setting" => "some value"
-          }
+          Data::Flat::Single.example
         end
       end
 
-      module SettingAttributes
+      module PartialMatch
         def self.example
-          ::Settings.new(data)
+          ::Settings.build(data)
         end
 
         def self.data
-          {
-            "some_setting" => "some value",
-            "some_other_setting" => "some other value",
-            "yet_another_setting" => "yet another value"
-          }
-        end
-
-        module Partial
-          def self.example
-            ::Settings.new(data)
-          end
-
-          def self.data
-            {
-              "some_setting" => "some value",
-              "some_other_setting" => "some other value",
-            }
-          end
+          Data::Flat::Multiple.example
         end
       end
 
-      module AccessorAttribute
+      module Namespace
         def self.example
-          ::Settings.new(data)
+          ::Settings.build(data)
         end
 
         def self.data
-          {
-            "some_accessor_attribute" => "some accessor value"
-          }
+          Data::Hierarchical.example
         end
       end
 
-      module Namespace
+      module AccessorAttribute
         def self.example
-          ::Settings.new(data)
+          ::Settings.build(data)
         end
 
         def self.data
           {
-            "some_namespace" => {
-              "some_setting" => "some value"
-            }
+            'some_accessor_attribute' => 'some accessor value'
           }
         end
-
-        module Override
-          def self.example
-            s = ::Settings.build(Namespace.data)
-            s.override(data)
-            s
-          end
-
-          def self.data
-            {
-              "some_namespace" => {
-                "some_setting" => "some overridden value",
-                "some_other_setting" => "some other value"
-              }
-            }
-          end
-        end
       end
     end
   end

data/lib/settings/{data_source/data_source.rb → data_source.rb}

@@ -1,11 +1,15 @@
 class Settings
   class DataSource
-    include Log::Dependency
-
     attr_reader :source
 
     def initialize(source)
       @source = source
     end
+
+    def self.build(source=nil)
+      source = canonize(source) if respond_to? :canonize
+
+      new(source)
+    end
   end
 end

data/lib/settings/data_source/build.rb

@@ -10,6 +10,7 @@ class Settings
       def self.type(input=nil)
         return Settings::DataSource::Hash if input.is_a?(::Hash)
         return Settings::DataSource::File if input.is_a?(String) || input.nil?
+        return Settings::DataSource::Env if input.instance_of?(Object)
 
         raise Settings::Error, "Input is not supported: #{input}"
       end

data/lib/settings/data_source/env.rb

@@ -0,0 +1,11 @@
+class Settings
+  class DataSource
+    class Env < DataSource
+      def get_data
+        source.map do |k, v|
+          [k.downcase, v]
+        end.to_h
+      end
+    end
+  end
+end

data/lib/settings/data_source/file.rb

@@ -1,22 +1,14 @@
 class Settings
   class DataSource
     class File < DataSource
-      def self.build(source=nil)
-        canonical = canonical(source)
-        validate(canonical)
-
-        new(canonical)
-      end
-
-      def self.canonical(source)
-        logger.trace { "Canonizing the file source (#{source})" }
+      def self.canonize(source)
+        canonized_filepath = canonize_filepath(source)
+        validate(canonized_filepath)
 
-        canonize(source).tap do |instance|
-          logger.debug { "Canonized the file source (#{source})" }
-        end
+        canonized_filepath
       end
 
-      def self.canonize(source)
+      def self.canonize_filepath(source)
         return default_filepath if source.nil?
         return source if full_path?(source)
 
@@ -59,58 +51,32 @@ class Settings
       end
 
       def self.validate(pathname)
-        logger.trace { "Validating the pathname (#{pathname})" }
-
         pathname = Pathname.new(pathname)
 
         unless pathname.file?
-          msg = "Settings cannot be read from #{pathname}. The file doesn't exist."
-          logger.error { msg }
-          raise Settings::Error, msg
+          raise Settings::Error, "Settings cannot be read from #{pathname}. The file doesn't exist."
         end
-
-        logger.trace { "Validated the pathname (#{pathname})" }
-      end
-
-      def self.logger
-        @logger ||= Log.get(self)
       end
 
       def get_data
-        logger.trace { "Reading file: #{source}" }
         file = ::File.open(source)
-        data = JSON.load(file).tap do
-          logger.debug { "Read file: #{source}" }
-        end
 
-        data = Casing::Underscore.(data)
+        data = JSON.load(file)
 
         hash_data_source = Hash.build data
         hash_data_source.get_data
       end
 
       module Defaults
-        def self.logger
-          @logger ||= Log.get(self)
-        end
-
         def self.filename
-          default_file = 'settings.json'
-          logger.debug { "Using the default settings file name (#{default_file})" }
-          default_file
+          'settings.json'
         end
       end
 
       module Directory
         module Defaults
-          def self.logger
-            @logger ||= Log.get(self)
-          end
-
           def self.pathname
-            default_dir = Dir.pwd
-            logger.debug { "Using the working directory default settings directory (#{default_dir})" }
-            default_dir
+            Dir.pwd
           end
         end
       end

data/lib/settings/data_source/hash.rb

@@ -1,18 +1,27 @@
 class Settings
   class DataSource
     class Hash < DataSource
-      def self.logger
-        @logger ||= Log.get(self)
+      def get_data
+        AssureStringKeys.(source)
       end
 
-      def self.build(source)
-        new(source)
-      end
+      module AssureStringKeys
+        def self.call(data)
+          new_data = {}
 
-      def get_data
-        logger.trace { "Converting the raw source data to Confstruct" }
-        Confstruct::Configuration.new(source).tap do |instance|
-          logger.debug { "Converted the raw source data to Confstruct" }
+          data.each do |key, value|
+            new_key = key.to_s
+
+            if value.is_a?(::Hash)
+              new_value = self.(value)
+            else
+              new_value = value
+            end
+
+            new_data[new_key] = new_value
+          end
+
+          new_data
         end
       end
     end

data/lib/settings/setting/assignment.rb

@@ -3,10 +3,6 @@ class Settings
     module Assignment
       extend self
 
-      def logger
-        @logger ||= Log.get(self)
-      end
-
       def assign(receiver, attribute, value, strict=false)
         settable = assure_settable(receiver, attribute, strict)
         if settable
@@ -17,11 +13,7 @@ class Settings
       end
 
       def assign_value(receiver, attribute, value)
-        logger.trace { "Assigning to #{attribute}" }
-        receiver.public_send("#{attribute}=", value).tap do
-          logger.debug { "Assigned to #{attribute}" }
-          logger.debug(tag: :data) { "#{attribute}: #{value}" }
-        end
+        receiver.public_send("#{attribute}=", value)
       end
 
       def setting?(receiver, attribute)
@@ -37,40 +29,22 @@ class Settings
         :"#{attribute.to_s}=" unless attribute.to_s.end_with? '='
       end
 
-      def digest(receiver, attribute, strict)
-        content = []
-        content << "Attribute: #{attribute}" if attribute
-        content << "Receiver: #{receiver.class.name}"
-        strict = "<not set>" if strict.nil?
-        content << "Strict: #{strict}"
-        content.join ', '
-      end
-
       module Object
         extend Assignment
 
-        def logger
-          @logger ||= Log.get(self)
-        end
-
         def self.assure_settable(receiver, attribute, strict=true)
-          logger.trace { "Approving attribute (#{digest(receiver, attribute, strict)})" }
-
           if strict
             setting = setting?(receiver, attribute)
             unless setting
-              logger.warn { "Can't set \"#{attribute}\". It isn't a setting of #{receiver.class.name}." }
               return false
             end
           end
 
           assignable = assignable? receiver, attribute
           unless assignable
-            logger.warn { "Can't set \"#{attribute}\". It isn't assignable to #{receiver.class.name}." }
             return false
           end
 
-          logger.debug { "\"#{attribute}\" can be set" }
           true
         end
       end
@@ -78,28 +52,19 @@ class Settings
       module Attribute
         extend Assignment
 
-        def logger
-          @logger ||= Log.get(self)
-        end
-
         def self.assure_settable(receiver, attribute, strict=true)
           if strict
             setting = setting? receiver, attribute
             unless setting
-              msg = "Can't set \"#{attribute}\". It isn't a setting of #{receiver.class.name}."
-              logger.error { msg }
-              raise msg
+              raise "Can't set \"#{attribute}\". It isn't a setting of #{receiver.class.name}."
             end
           end
 
-          assignable = assignable? receiver, attribute
+          assignable = assignable?(receiver, attribute)
           unless assignable
-            msg = "Can't set \"#{attribute}\". It isn't assignable to #{receiver.class.name}."
-            logger.error { msg }
-            raise msg
+            raise "Can't set \"#{attribute}\". It isn't assignable to #{receiver.class.name}."
           end
 
-          logger.debug { "\"#{attribute}\" can be set" }
           true
         end
       end

data/lib/settings/setting/macro.rb

@@ -2,13 +2,8 @@ class Settings
   module Setting
     module Macro
       def setting_macro(attribute)
-        logger = Log.get(self)
-
-        logger.trace { "Defining setting attribute: #{attribute}" }
         Attribute::Define.(self, attribute, :accessor)
-        Settings::Registry.register(self, attribute).tap do
-          logger.debug { "Defined setting attribute: #{attribute}" }
-        end
+        Settings::Registry.register(self, attribute)
       end
       alias :setting :setting_macro
     end

data/lib/settings/settings.rb

@@ -1,18 +1,12 @@
 class Settings
   class Error < RuntimeError; end
 
-  include Log::Dependency
-
   attr_reader :data
 
   def initialize(data)
     @data = data
   end
 
-  def self.logger
-    @logger ||= Log.get(self)
-  end
-
   def self.build(source=nil)
     source ||= implementer_source
 
@@ -20,41 +14,22 @@ class Settings
 
     data = data_source.get_data
 
+    data = Casing::Underscore.(data)
+
     instance = new(data)
 
     instance
   end
 
   def self.implementer_source
-    logger.trace { "Getting data source from the implementer" }
-
-    unless self.respond_to? :data_source
-      logger.trace { "Implementer doesn't provide a data_source" }
+    unless self.respond_to?(:data_source)
       return nil
     end
 
-    self.data_source.tap do |data_source|
-      logger.trace { "Got data source from the implementer (#{data_source})" }
-    end
-  end
-
-  def override(override_data)
-    logger.trace { "Overriding settings data" }
-    res = data.push!(override_data)
-    logger.debug { "Overrode settings data" }
-    logger.debug(tag: :data) { "Override data #{override_data}" }
-    res
-  end
-
-  def reset
-    logger.trace { "Resetting overridden settings data" }
-    res = data.pop!
-    logger.debug { "Reset overridden settings data" }
-    res
+    self.data_source
   end
 
   def set(receiver, *namespace, attribute: nil, strict: true)
-    logger.trace { "Setting #{receiver.class.name} (#{digest(namespace, attribute, strict)})" }
     unless attribute.nil?
       value = set_attribute(receiver, attribute, namespace, strict)
     else
@@ -64,8 +39,6 @@ class Settings
   end
 
   def set_attribute(receiver, attribute, namespace, strict)
-    logger.trace { "Setting #{receiver.class.name} attribute (#{digest(namespace, attribute, strict)})" }
-
     attribute = attribute.to_s if attribute.is_a?(Symbol)
 
     attribute_namespace = namespace.dup
@@ -74,35 +47,25 @@ class Settings
     value = get(attribute_namespace)
 
     if value.nil?
-      msg = "#{attribute_namespace} not found in the data"
-      logger.error { msg }
-      raise Settings::Error, msg
+      raise Settings::Error, "#{attribute_namespace} not found in the data"
     end
 
     Settings::Setting::Assignment::Attribute.assign(receiver, attribute.to_sym, value, strict)
 
-    logger.debug { "Set #{receiver.class.name} #{attribute} to #{value.inspect}" }
-
     value
   end
 
   def set_object(receiver, namespace, strict)
-    logger.trace { "Setting #{receiver.class.name} object (#{digest(namespace, nil, strict)})" }
-
     data = get(namespace)
 
     if data.nil?
-      msg = "#{namespace} not found in the data"
-      logger.error { msg }
-      raise Settings::Error, msg
+      raise Settings::Error, "#{namespace} not found in the data"
     end
 
     data.each do |attribute, value|
       Settings::Setting::Assignment::Object.assign(receiver, attribute.to_sym, value, strict)
     end
 
-    logger.debug { "Set #{receiver.class.name} object (#{digest(namespace, nil, strict)})" }
-
     receiver
   end
 
@@ -112,24 +75,16 @@ class Settings
 
   def get(*namespace)
     namespace.flatten!
-    logger.trace { "Getting #{namespace}" }
-
-    string_keys = namespace.map { |n| n.is_a?(String) ? n : n.to_s }
 
-    value = string_keys.inject(data) {|memo, k| memo ? memo[k] : nil }
+    keys = namespace.map { |n| n.is_a?(Symbol) ? n.to_s : n }
 
-    logger.debug { "Got #{namespace}" }
-    logger.debug(tag: :data) { "#{namespace}: #{value.inspect}" }
+    value = nil
+    if keys.empty?
+      value = data
+    else
+      value = data.dig(*keys)
+    end
 
     value
   end
-
-  def digest(namespace, attribute, strict)
-    content = []
-    content << "Namespace: #{namespace.join ', '}" unless namespace.empty?
-    content << "Attribute: #{attribute}" if attribute
-    strict = "<not set>" if strict.nil?
-    content << "Strict: #{strict}"
-    content.join ', '
-  end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: evt-settings
 version: !ruby/object:Gem::Version
-  version: 0.5.0.0
+  version: 2.1.1.1
 platform: ruby
 authors:
 - The Eventide Project
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-12 00:00:00.000000000 Z
+date: 2020-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: evt-log
+  name: evt-attribute
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: confstruct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: test_bench
   requirement: !ruby/object:Gem::Requirement
@@ -74,14 +60,15 @@ extra_rdoc_files: []
 files:
 - lib/settings.rb
 - lib/settings/controls.rb
+- lib/settings/controls/data.rb
 - lib/settings/controls/data_source.rb
 - lib/settings/controls/settings.rb
 - lib/settings/controls/subject.rb
+- lib/settings/data_source.rb
 - lib/settings/data_source/build.rb
-- lib/settings/data_source/data_source.rb
+- lib/settings/data_source/env.rb
 - lib/settings/data_source/file.rb
 - lib/settings/data_source/hash.rb
-- lib/settings/log.rb
 - lib/settings/registry.rb
 - lib/settings/setting.rb
 - lib/settings/setting/assignment.rb
@@ -91,7 +78,7 @@ homepage: https://github.com/eventide-project/settings
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,9 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Settings data access and assignment
 test_files: []

data/lib/settings/log.rb

@@ -1,9 +0,0 @@
-class Settings
-  class Log < ::Log
-    def tag!(tags)
-      tags << :settings
-      tags << :library
-      tags << :verbose
-    end
-  end
-end