frise 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59666a0c683f8357e7da23de68bd0cc07b386299943e772dd40d9d641ac2d8c7
-  data.tar.gz: 6827402a3f207d909845c0fa386f61cd3d32b989206e15d22b58202830406c88
+  metadata.gz: 86558df34daa0ba92e7e7a1863ceb5124ea52c39dc82a85924c4db1bd89cf127
+  data.tar.gz: fd286367be54e292a6df52daa6f5255810d6e3980bce538d0c2391d5fdab9ca9
 SHA512:
-  metadata.gz: 75c11d0c64a9d0a7f37c3b7702ab2000c09d76900c8c58477bc2426ea47ef766b3c03f77c0fd15928fd55a636009fe33f6e2e19efe8f6454945a3a22ea8b86b3
-  data.tar.gz: 582bb37e6e27f4da44aa496321abf66def05ca151218680c776772fc893824f03ab61ed6e11d3c2006853bd627d53f378eb79f3190033d69869a8ee574184177
+  metadata.gz: c48f86d8190c30bf650055dfa7749ecdf9d2545f4a6c34593c29e402c0da06dd5420eb8244c3f112f8501564a5bf26798acae2fbeb006c10bb1c4eb5dc4e7c1a
+  data.tar.gz: 679a4edb6364662160f4e1d6872c8949e3fd6338433da50de5a109addec0a31dec69b3013ca4038fbb40283383b15f160ecf4723c546dea53ab6a8d75db6f77c

data/.travis.yml

@@ -5,5 +5,6 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
 before_install:
   - gem install bundler

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.4.1 (July 7, 2020)
+
+- New features
+  - `$delete` directive is now available in config files, allowing users to delete parts of the
+    config sub-tree ([#20](https://github.com/velocidi/frise/pull/20)).
+
 ### 0.4.0 (November 29, 2019)
 
 - Breaking changes

data/lib/frise/defaults_loader.rb

@@ -10,10 +10,11 @@ module Frise
   class DefaultsLoader
     SYMBOLS = %w[$all $optional].freeze
 
-    def initialize(include_sym: '$include', content_include_sym: '$content_include', schema_sym: '$schema')
+    def initialize(include_sym: '$include', content_include_sym: '$content_include', schema_sym: '$schema', delete_sym: '$delete')
       @include_sym = include_sym
       @content_include_sym = content_include_sym
       @schema_sym = schema_sym
+      @delete_sym = delete_sym
     end
 
     def widened_class(obj)
@@ -37,6 +38,9 @@ module Frise
         else merge_defaults_obj({}, defaults)
         end
 
+      elsif config == @delete_sym
+        config
+
       elsif defaults_class == 'Array' && config_class == 'Array'
         defaults + config
 

data/lib/frise/loader.rb

@@ -13,6 +13,7 @@ module Frise
     def initialize(include_sym: '$include',
                    content_include_sym: '$content_include',
                    schema_sym: '$schema',
+                   delete_sym: '$delete',
                    pre_loaders: [],
                    validators: nil,
                    exit_on_fail: true)
@@ -20,6 +21,7 @@ module Frise
       @include_sym = include_sym
       @content_include_sym = content_include_sym
       @schema_sym = schema_sym
+      @delete_sym = delete_sym
       @pre_loaders = pre_loaders
       @validators = validators
       @exit_on_fail = exit_on_fail
@@ -27,7 +29,8 @@ module Frise
       @defaults_loader = DefaultsLoader.new(
         include_sym: include_sym,
         content_include_sym: content_include_sym,
-        schema_sym: schema_sym
+        schema_sym: schema_sym,
+        delete_sym: delete_sym
       )
     end
 
@@ -39,8 +42,8 @@ module Frise
         config = pre_loader.call(config)
       end
 
-      config = process_includes(config, [], config, global_vars) if @include_sym
-      config = process_schemas(config, [], global_vars) if @schema_sym
+      config = process_includes(config, [], config, global_vars) unless @include_sym.nil?
+      config = process_schemas(config, [], global_vars) unless @schema_sym.nil?
       config
     end
 
@@ -65,18 +68,19 @@ module Frise
       # process $include directives
       config, next_include_confs = extract_include(config, at_path)
       include_confs = next_include_confs + include_confs_stack
-      if include_confs.empty?
-        config.map { |k, v| [k, process_includes(v, at_path + [k], root_config, global_vars)] }.to_h
-      else
-        Lazy.new do
-          include_conf = include_confs.first
-          rest_include_confs = include_confs[1..-1]
-          symbol_table = build_symbol_table(root_config, at_path, config, global_vars, include_conf)
-          included_config = Parser.parse(include_conf['file'], symbol_table)
-          config = @defaults_loader.merge_defaults_obj(config, included_config)
-          process_includes(config, at_path, merge_at(root_config, at_path, config), global_vars, rest_include_confs)
-        end
-      end
+      res = if include_confs.empty?
+              config.map { |k, v| [k, process_includes(v, at_path + [k], root_config, global_vars)] }.to_h
+            else
+              Lazy.new do
+                include_conf = include_confs.first
+                rest_include_confs = include_confs[1..-1]
+                symbol_table = build_symbol_table(root_config, at_path, config, global_vars, include_conf)
+                included_config = Parser.parse(include_conf['file'], symbol_table)
+                config = @defaults_loader.merge_defaults_obj(config, included_config)
+                process_includes(config, at_path, merge_at(root_config, at_path, config), global_vars, rest_include_confs)
+              end
+            end
+      @delete_sym.nil? ? res : omit_deleted(res)
     end
 
     def process_schema_includes(schema, at_path, global_vars)
@@ -160,6 +164,17 @@ module Frise
       config.merge(head => merge_at(config[head], tail, to_merge))
     end
 
+    # returns the config without the keys whose values are @delete_sym
+    def omit_deleted(config)
+      config.each_with_object({}) do |(k, v), new_hash|
+        if v.is_a?(Hash)
+          new_hash[k] = omit_deleted(v)
+        else
+          new_hash[k] = v unless v == @delete_sym
+        end
+      end
+    end
+
     # builds the symbol table for the Liquid renderization of a file, based on:
     #   - `root_config`: the root of the whole config
     #   - `at_path`: the current path
@@ -170,7 +185,7 @@ module Frise
       extra_vars = (include_conf['vars'] || {}).map { |k, v| [k, root_config.dig(*v.split('.'))] }.to_h
       extra_consts = include_conf['constants'] || {}
 
-      (config ? merge_at(root_config, at_path, config) : root_config)
+      omit_deleted(config ? merge_at(root_config, at_path, config) : root_config)
         .merge(global_vars)
         .merge(extra_vars)
         .merge(extra_consts)

data/lib/frise/validator.rb

@@ -163,7 +163,7 @@ module Frise
     end
 
     def self.validate_obj(config, schema, options = {})
-      validate_obj_at(config, [], schema, options)
+      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)
@@ -188,11 +188,11 @@ module Frise
     end
 
     def self.validate(config, schema_file, options = {})
-      validate_obj_at(config, [], Parser.parse(schema_file) || { allow_unknown_keys: true }, 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 = {})
-      validate_obj_at(config, at_path, Parser.parse(schema_file) || { allow_unknown_keys: true }, options)
+      validate_obj_at(config, at_path, Parser.parse(schema_file) || { allow_unknown_keys: true }, **options)
     end
   end
 

data/lib/frise/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Frise
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frise
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Velocidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-29 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -151,8 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby config library with schema validation, default values and templating