jac 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8f6cffab29062b76d447fff5f941bebe410deb1f
-  data.tar.gz: b940de7ad2090b3c32b6c8012acfc9f1ef4fe764
+SHA256:
+  metadata.gz: 8aaaff9c5e46908f214469f894732bdbd178bdc92e91549180d7f3a45157e2e2
+  data.tar.gz: d6c97e79b6a72e363777af65b5d9e18fb7a2545dd56b3a523ed25d9c1cf33482
 SHA512:
-  metadata.gz: 87be3a20069dadd3e4cb4118ffe24cb6eaa3c25eb574e12bc14e3631132b505199f3bc74efd3eba1bb8cefd8e91d0f37e8c098a3749905f696e6281195b56407
-  data.tar.gz: 9360da4e099d453bfa85f1a8b6f3a65252403fa5e48a36b01e89bfd69ef4715874c93fd5d138059374612908d38e8b9c36ae92271b8b80dd8072393e320f3a62
+  metadata.gz: b2244d961c0c82fb75ae3dffc5ce7f42763533f0bc2794062ab2a0766ade890eca579aa7dbf49f28bb2759014b3daaf2f4fa077a5a1d1dde730b8e73226ae635
+  data.tar.gz: 6118f96a703d7a4049b404f6635bf78c878665a2f292cc7c5fc3b6812aa14ec9f2ba62c14118b6cf2f183c31466ea2a6510fda92efdae529586aff56e3c25f30

data/lib/jac/configuration.rb

@@ -177,14 +177,28 @@ module Jac
   # If profile name matches multiple generic profiles it not defined
   # which profile will be used.
   module Configuration
+    # Name of top level profile. ^top profile is implicit
+    # it automaticly merged on top of resulting configuration
+    TOP_PROFILE_NAME = '^top'.freeze
+    # Name of base level profile. ^base profile is implicit
+    # resulting configuration automaticly merged on top of it.
+    BASE_PROFILE_NAME = '^base'.freeze
+    # Any configuration set always contains `default` profile
+    # which is loaded when no profile requested.
+    DEFAULT_PROFILE_NAME = 'default'.freeze
+    # List of default profiles. Having this list we can easily create default
+    # configuration.
+    BASIC_PROFILES = [
+      TOP_PROFILE_NAME,
+      BASE_PROFILE_NAME,
+      DEFAULT_PROFILE_NAME
+    ].freeze
+    # Key where all inherited profiles listed
+    EXTENDS_KEY = 'extends'.freeze
+
     # Reads and evaluates configuration for given set of streams
     # and profile
     class ConfigurationReader
-      # Any configuration set always contains `default` profile
-      # which is loaded when no profile requested.
-      DEFAULT_PROFILE_NAME = 'default'.freeze
-      # Creates "empty" config
-      DEFAULT_CONFIGURATION = -> () { { DEFAULT_PROFILE_NAME => {} } }
       attr_reader :merger
       # Creates configuration reader
       # @param [Array] streams of pairs containing YAML document and provided
@@ -200,12 +214,22 @@ module Jac
       def read(*profile)
         result = @streams
                  .flat_map { |stream, _name| read_stream(stream) }
-                 .inject(DEFAULT_CONFIGURATION.call) { |acc, elem| update(acc, elem) }
-        OpenStruct.new(evaluate(resolve(profile, result)).merge('profile' => profile))
+                 .inject(default_configuration) { |acc, elem| update(acc, elem) }
+        # Keep original profile name
+        original_profile = profile
+        # Add implicit profiles
+        profile =
+          [Configuration::BASE_PROFILE_NAME, profile, Configuration::TOP_PROFILE_NAME].flatten
+        OpenStruct.new(evaluate(resolve(profile, result).merge('profile' => original_profile)))
       end
 
       private
 
+      # Creates empty configuration object.
+      def default_configuration
+        Configuration::BASIC_PROFILES.inject({}) { |acc, elem| acc.update(elem => {}) }
+      end
+
       def read_stream(stream)
         # Each stream consists of one or more documents
         YAML.parse_stream(stream).children.flat_map do |document|
@@ -256,9 +280,6 @@ module Jac
 
     # Describes profile resolving strategy
     class ProfileResolver
-      # Key where all inherited profiles listed
-      EXTENDS_KEY = 'extends'.freeze
-
       attr_reader :config, :merger
 
       def initialize(config)
@@ -273,8 +294,8 @@ module Jac
             raise(ArgumentError, msg)
           end
           profile_values = find_profile(elem)
-          # Find all inheritors
-          extends = *profile_values[EXTENDS_KEY] || []
+          # Find all parent_profiles
+          extends = parent_profiles(profile_values)
           # We can do not check extends. Empty profile returns {}
           # Inherited values goes first
           inherited = merger.merge(acc, resolve(extends, resolved + [elem]))
@@ -282,6 +303,17 @@ module Jac
         end
       end
 
+      # Fetches list of parent profile
+      # @param [Hash] values current profile values
+      # @return [Array] of profile names
+      def parent_profiles(values)
+        extends = *values[Configuration::EXTENDS_KEY] || []
+        [Configuration::TOP_PROFILE_NAME, Configuration::BASE_PROFILE_NAME].each do |implicit|
+          raise(ArgumentError, "`#{implicit}` is not allowed here") if extends.include?(implicit)
+        end
+        extends
+      end
+
       def find_profile(profile_name)
         return config[profile_name] if config.key?(profile_name)
         # First and last chars are '/'
@@ -317,8 +349,6 @@ module Jac
                               .keys
                               .select { |k| k[0] == '/' && k[-1] == '/' }
                               .map { |k| [k, Regexp.new(k[1..-2])] }
-
-        @generic_profiles
       end
     end
 
@@ -326,29 +356,27 @@ module Jac
     # when referencing profile inside evaluated
     # expressions
     class EvaluationContext
-      def initialize(evaluator)
+      def initialize(hash, evaluator)
         @evaluator = evaluator
-      end
-
-      def respond_to_missing?(_meth, _args, &_block)
-        true
-      end
-
-      def method_missing(meth, *args, &block)
-        # rubocop ispection hack
-        return super unless respond_to_missing?(meth, args, &block)
-        @evaluator.evaluate(meth.to_s)
+        hash.each_key do |key|
+          exp = <<-EVAL.strip_indent
+          def #{key}
+            @evaluator.evaluate("#{key}")
+          end
+          EVAL
+          eval(exp, binding)
+        end
       end
     end
 
     # Evaluates all strings inside resolved profile
     # object
     class ConfigurationEvaluator
-      def initialize(src_object, dst_object)
+      def initialize(src_object)
         @object = src_object
-        @evaluated = dst_object
-        @context = EvaluationContext.new(self)
-        resolve_object
+        @evaluated = {}
+        # Initialize context object with root
+        @context = EvaluationContext.new(@object, self)
       end
 
       def evaluate(key)
@@ -364,27 +392,32 @@ module Jac
       alias conf c
       alias cfg c
 
-      private
-
-      def resolve_object
+      def evaluate_values
+        @ctx_object = @context
         @object.each_key { |k| evaluate(k) }
         # Cleanup accidentally created values (when referencing missing values)
         @evaluated.delete_if { |k, _v| !@object.key?(k) }
       end
 
-      def get_binding(obj)
+      private
+
+      def get_binding(object)
         binding
       end
 
-      def evaluate_deep(object)
+      def evaluate_deep(object) # rubocop:disable Metrics/MethodLength
         case object
         when String
           eval_string(object)
         when Array
-          object.map { |e| evaluate_deep(e) }
+          contextual(object) do
+            object.map { |e| evaluate_deep(e) }
+          end
         when Hash
           # Evaluating values only by convention
-          object.inject({}) { |acc, elem| acc.update(elem.first => evaluate_deep(elem.last)) }
+          contextual(object) do
+            object.inject({}) { |acc, elem| acc.update(elem.first => evaluate_deep(elem.last)) }
+          end
         else
           object
         end
@@ -392,17 +425,40 @@ module Jac
 
       def eval_string(o)
         evaluated = /#\{.+?\}/.match(o) do
-          eval('"' + o + '"', get_binding(self))
+          eval('"' + o + '"', get_binding(@ctx_object))
         end
 
         evaluated || o
       end
 
+      def respond_to_missing?(meth, args, &block)
+        @ctx_object && @ctx_object.respond_to?(meth, args, &block)
+      end
+
+      def method_missing(meth, *args, &block)
+        # rubocop inspection hack
+        return super unless respond_to_missing?(meth, args, &block)
+        @ctx_object.send(meth, *args, &block)
+      end
+
+      # Keeps track of current context objects
+      # This trick allows us to reference local variables
+      # using `self` calls.
+      # @param ctx [Object] object to use in current evaluation
+      # @param &block [Proc] evaluation logic
+      # @return [Object] result of evaluation
+      def contextual(ctx)
+        memo = @ctx_object
+        @ctx_object = ctx
+        result = yield
+        @ctx_object = memo
+
+        result
+      end
+
       class << self
         def evaluate(o)
-          dst = {}
-          ConfigurationEvaluator.new(o, dst)
-          dst
+          ConfigurationEvaluator.new(o).evaluate_values
         end
       end
     end
@@ -424,7 +480,7 @@ module Jac
       # names to read
       # @return [OpenStruct] instance which contains all resolved profile fields
       def read(profile, *streams)
-        profile = [ConfigurationReader::DEFAULT_PROFILE_NAME] if profile.empty?
+        profile = [Configuration::DEFAULT_PROFILE_NAME] if profile.empty?
         ConfigurationReader.new(streams).read(*profile)
       end
 

data/lib/jac/version.rb

@@ -0,0 +1,3 @@
+module Jac
+  VERSION = [0, 0, 4].freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jac
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - ilya.arkhanhelsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2018-08-06 00:00:00.000000000 Z
 dependencies: []
 description: Profile based configuration lib
 email: ilya.arkhanhelsky@vizor-games.com
@@ -20,6 +20,7 @@ files:
 - lib/jac/configuration.rb
 - lib/jac/merger.rb
 - lib/jac/parser.rb
+- lib/jac/version.rb
 homepage: https://github.com/vizor-games/jac
 licenses:
 - MIT
@@ -40,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Just Another Configuration Lib