frise 0.2.0 → 0.3.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 658ef151a4948ba72f32f7dc5b51f5ddb3e6fb69
-  data.tar.gz: 8b7498f11685e3c5d1a4bbce70c732d8a62e8eb6
+SHA256:
+  metadata.gz: 72db98e097cb7abccf1a1208a53efa9a2486d49d3f58422a70e6f32ac7cbb2a8
+  data.tar.gz: 52f15d4c10262d54dc7534fa35c16abb66ad33d0498ceff612cc78124154fcf4
 SHA512:
-  metadata.gz: 998d82e9c1a58efb14b5edd44deb4c85c62ced21cec664f29cffa3753f3742fc9e876fad96c9c3902fa2fc6a55d57622695bfe579acb6abb246695f8f7fe8b91
-  data.tar.gz: f1a5e4ee436e6081a93fd204cfd7ee434aeb3d6ada5e90853f42467cf6339ca8a6c4dbc0b8d4b335d4e1d75e211e965736f84010cc3ffb31e6c37b668fafce9c
+  metadata.gz: 75b318b997eb2ab66dada979b270e468430ca372982d035bba4de12a68a0622f6897d928e173b67d7e046be2ecdee0d7b1374e0a0d50da55e80354d60285eb9f
+  data.tar.gz: b25a7625181eaf4d90f202ca0aa9dc9095ada98318272c2d5c999beb8ea28e0e7af397b1612692bd18709a59dca4cab758d30ee515563806d6def511500243e7

data/.rubocop.yml

@@ -1,2 +1,8 @@
+AllCops:
+  TargetRubyVersion: '2.3'
 Metrics:
   Enabled: false
+Naming/UncommunicativeBlockParamName:
+  Enabled: false
+Naming/UncommunicativeMethodParamName:
+  Enabled: false

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 2.1
-  - 2.2
   - 2.3
   - 2.4
+  - 2.5

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-### 0.2.0 (unreleased)
+### 0.2.0 (August 17, 2017)
 
 - New features
   - New schema types `$enum` and `$one_of` for specifying enumerations and values with multiple

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in frise.gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 def load_if_available(req_path)

data/frise.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'frise/version'
 
@@ -18,14 +18,14 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features|example)/})
   end
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_dependency 'liquid', '~> 3.0'
 
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'coveralls', '~> 0.8.21'
-  spec.add_development_dependency 'simplecov', '~> 0.14.1'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.4'
-  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+  spec.add_development_dependency 'rubocop', '~> 0.53.0'
+  spec.add_development_dependency 'simplecov', '~> 0.14.1'
 end

data/lib/frise.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'frise/defaults_loader'
+require 'frise/loader/lazy'
 require 'frise/loader'
 require 'frise/parser'
 require 'frise/validator'

data/lib/frise/defaults_loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'frise/parser'
 
 module Frise
@@ -7,6 +9,8 @@ module Frise
   # defaults and apply them to configuration objects.
   module DefaultsLoader
     class << self
+      SYMBOLS = %w[$all $optional].freeze
+
       def widened_class(obj)
         class_name = obj.class.to_s
         return 'Boolean' if %w[TrueClass FalseClass].include? class_name
@@ -33,7 +37,7 @@ module Frise
         elsif defaults.class == Hash && config.class == Hash
           new_config = {}
           (config.keys + defaults.keys).uniq.each do |key|
-            next if key.start_with?('$')
+            next if SYMBOLS.include?(key)
             new_config[key] = config[key]
             new_config[key] = merge_defaults_obj(new_config[key], defaults[key]) if defaults.key?(key)
             new_config[key] = merge_defaults_obj(new_config[key], defaults['$all']) unless new_config[key].nil?

data/lib/frise/loader.rb

@@ -1,60 +1,129 @@
+# frozen_string_literal: true
+
 require 'frise/defaults_loader'
+require 'frise/loader/lazy'
 require 'frise/parser'
 require 'frise/validator'
 
 module Frise
   # The entrypoint for loading configs from files according to the conventions defined for Frise.
   #
-  # The load method loads a configuration file, merges it with the applicable defaults and validates
-  # its schema. Other methods in Loader perform only parts of the process.
+  # The load method loads a configuration file, merges the applicable includes and validates its schema.
   class Loader
-    def initialize(schema_load_paths: [], defaults_load_paths: [], pre_loaders: [], validators: nil)
-      @schema_load_paths = schema_load_paths
-      @defaults_load_paths = defaults_load_paths
+    def initialize(include_sym: '$include', schema_sym: '$schema', pre_loaders: [], validators: nil, exit_on_fail: true)
+      @include_sym = include_sym
+      @schema_sym = schema_sym
       @pre_loaders = pre_loaders
       @validators = validators
+      @exit_on_fail = exit_on_fail
     end
 
-    def load(config_file, exit_on_fail = true, symbol_table = {})
-      config = Parser.parse(config_file, symbol_table) || {}
-      config_name = File.basename(config_file)
+    def load(config_file, global_vars = {})
+      config = Parser.parse(config_file, global_vars)
+      return nil unless config
 
       @pre_loaders.each do |pre_loader|
         config = pre_loader.call(config)
       end
 
-      config = merge_defaults(config, config_name, symbol_table)
-      validate(config, config_name, exit_on_fail)
+      config = process_includes(config, [], config, global_vars) if @include_sym
+      config = process_schemas(config, [], global_vars) if @schema_sym
+      config
     end
 
-    def merge_defaults(config, defaults_name, symbol_table = {})
-      merge_defaults_at(config, [], defaults_name, symbol_table)
-    end
+    private
 
-    def merge_defaults_at(config, at_path, defaults_name, symbol_table = {})
-      @defaults_load_paths.map do |defaults_dir|
-        defaults_file = File.join(defaults_dir, defaults_name)
-        config = DefaultsLoader.merge_defaults_at(
-          config, at_path, defaults_file, symbol_table.merge(config)
-        )
+    def process_includes(config, at_path, root_config, global_vars)
+      return config unless config.class == Hash
+
+      config, defaults_confs = extract_include(config)
+      if defaults_confs.empty?
+        config.map { |k, v| [k, process_includes(v, at_path + [k], root_config, global_vars)] }.to_h
+      else
+        Lazy.new do
+          defaults_confs.each do |defaults_conf|
+            extra_vars = (defaults_conf['vars'] || {}).map { |k, v| [k, root_config.dig(*v.split('.'))] }.to_h
+            extra_consts = defaults_conf['constants'] || {}
+            symbol_table = merge_at(root_config, at_path, config)
+                           .merge(global_vars).merge(extra_vars).merge(extra_consts).merge('_this' => config)
+
+            config = DefaultsLoader.merge_defaults_obj(config, Parser.parse(defaults_conf['file'], symbol_table))
+          end
+          process_includes(config, at_path, merge_at(root_config, at_path, config), global_vars)
+        end
       end
-      config
     end
 
-    def validate(config, schema_name, exit_on_fail = true)
-      validate_at(config, [], schema_name, exit_on_fail)
+    def process_schema_includes(schema, global_vars)
+      return schema unless schema.class == Hash
+
+      schema, included_schemas = extract_include(schema)
+      if included_schemas.empty?
+        schema.map { |k, v| [k, process_schema_includes(v, global_vars)] }.to_h
+      else
+        included_schemas.each do |defaults_conf|
+          schema = Parser.parse(defaults_conf['file'], global_vars).merge(schema)
+        end
+        process_schema_includes(schema, global_vars)
+      end
     end
 
-    def validate_at(config, at_path, schema_name, exit_on_fail = true)
-      @schema_load_paths.map do |schema_dir|
-        schema_file = File.join(schema_dir, schema_name)
-        errors = Validator.validate_at(config, at_path, schema_file,
-                                       validators: @validators,
-                                       print: exit_on_fail,
-                                       fatal: exit_on_fail)
+    def process_schemas(config, at_path, global_vars)
+      return config unless config.class == Hash
+
+      config = config.map do |k, v|
+        new_v = process_schemas(v, at_path + [k], global_vars)
+        return nil if !v.nil? && new_v.nil?
+        [k, new_v]
+      end.to_h
+
+      config, schema_files = extract_schema(config)
+      schema_files.each do |schema_file|
+        schema = Parser.parse(schema_file, global_vars)
+        schema = process_schema_includes(schema, global_vars)
+
+        errors = Validator.validate_obj(config,
+                                        schema,
+                                        path_prefix: at_path,
+                                        validators: @validators,
+                                        print: @exit_on_fail,
+                                        fatal: @exit_on_fail)
         return nil if errors.any?
       end
       config
     end
+
+    def extract_schema(config)
+      extract_special(config, @schema_sym) do |value|
+        case value
+        when String then value
+        else raise "Illegal value for a #{@schema_sym} element: #{value.inspect}"
+        end
+      end
+    end
+
+    def extract_include(config)
+      extract_special(config, @include_sym) do |value|
+        case value
+        when Hash then value
+        when String then { 'file' => value }
+        else raise "Illegal value for a #{@include_sym} element: #{value.inspect}"
+        end
+      end
+    end
+
+    def extract_special(config, key)
+      case config[key]
+      when nil then [config, []]
+      when Array then [config.reject { |k| k == key }, config[key].map { |e| yield e }]
+      else raise "Illegal value for #{key}: #{config[key].inspect}"
+      end
+    end
+
+    def merge_at(config, at_path, to_merge)
+      return config.merge(to_merge) if at_path.empty?
+      head, *tail = at_path
+      config.merge(head => merge_at(config[head], tail, to_merge))
+    end
   end
 end

data/lib/frise/loader/lazy.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Frise
+  class Loader
+    # A basic proxy object.
+    class Lazy < BasicObject
+      def initialize(&callable)
+        @callable = callable
+      end
+
+      def __target_object__
+        @__target_object__ ||= @callable.call
+      end
+
+      # rubocop:disable Style/MethodMissing
+      def method_missing(method_name, *args, &block)
+        __target_object__.send(method_name, *args, &block)
+      end
+      # rubocop:enable Style/MethodMissing
+    end
+  end
+end

data/lib/frise/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'liquid'
 require 'yaml'
 
@@ -9,9 +11,15 @@ module Frise
       def parse(file, symbol_table = nil)
         return nil unless File.file? file
         content = File.open(file).read
-        content = Liquid::Template.parse(content).render symbol_table if symbol_table
+        content = Liquid::Template.parse(content).render with_internal_vars(file, symbol_table) if symbol_table
         YAML.safe_load(content, [], [], true) || {}
       end
+
+      private
+
+      def with_internal_vars(file, symbol_table)
+        symbol_table.merge('_file_dir' => File.dirname(file))
+      end
     end
   end
 end

data/lib/frise/validator.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'frise/parser'
 require 'set'
@@ -164,32 +165,36 @@ module Frise
     end
 
     def self.validate_obj(config, schema, options = {})
-      validator = Validator.new(config, options[:validators])
-      validator.validate_object('', config, schema)
+      validate_obj_at(config, [], schema, options)
+    end
+
+    def self.validate_obj_at(config, at_path, schema, path_prefix: nil, validators: nil, print: nil, fatal: nil, raise_error: nil)
+      schema = parse_symbols(schema)
+      at_path.reverse.each { |key| schema = { key => schema, :allow_unknown_keys => true } }
+
+      validator = Validator.new(config, validators)
+      validator.validate_object((path_prefix || []).join('.'), config, schema)
 
       if validator.errors.any?
-        if options[:print]
+        if print
           puts "#{validator.errors.length} config error(s) found:"
           validator.errors.each do |error|
             puts " - #{error}"
           end
         end
 
-        exit 1 if options[:fatal]
-        raise ValidationError.new(validator.errors), 'Invalid configuration' if options[:raise_error]
+        exit 1 if fatal
+        raise ValidationError.new(validator.errors), 'Invalid configuration' if raise_error
       end
       validator.errors
     end
 
     def self.validate(config, schema_file, options = {})
-      schema = parse_symbols(Parser.parse(schema_file) || { allow_unknown_keys: true })
-      validate_obj(config, schema, options)
+      validate_obj_at(config, [], Parser.parse(schema_file) || { allow_unknown_keys: true }, options)
     end
 
     def self.validate_at(config, at_path, schema_file, options = {})
-      schema = parse_symbols(Parser.parse(schema_file) || { allow_unknown_keys: true })
-      at_path.reverse.each { |key| schema = { key => schema, :allow_unknown_keys => true } }
-      validate_obj(config, schema, options)
+      validate_obj_at(config, at_path, Parser.parse(schema_file) || { allow_unknown_keys: true }, options)
     end
   end
 

data/lib/frise/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Frise
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0.pre'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frise
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0.pre
 platform: ruby
 authors:
 - ShiftForward
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -53,61 +53,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.8.21
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 0.53.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 0.53.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.14.1
 description: 
 email:
 - info@shiftforward.eu
@@ -128,6 +128,7 @@ files:
 - lib/frise.rb
 - lib/frise/defaults_loader.rb
 - lib/frise/loader.rb
+- lib/frise/loader/lazy.rb
 - lib/frise/parser.rb
 - lib/frise/validator.rb
 - lib/frise/version.rb
@@ -143,15 +144,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby config library with schema validation, default values and templating