frise 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59666a0c683f8357e7da23de68bd0cc07b386299943e772dd40d9d641ac2d8c7
-  data.tar.gz: 6827402a3f207d909845c0fa386f61cd3d32b989206e15d22b58202830406c88
+  metadata.gz: 89f413918114d497ca91dc779d1e02e5abe17283c50541a2c5f41e530262a1c8
+  data.tar.gz: 249420e836978cd01c7639ba72d9bb8d23bafde1e36c0bd2f2a4d39325a4bb5a
 SHA512:
-  metadata.gz: 75c11d0c64a9d0a7f37c3b7702ab2000c09d76900c8c58477bc2426ea47ef766b3c03f77c0fd15928fd55a636009fe33f6e2e19efe8f6454945a3a22ea8b86b3
-  data.tar.gz: 582bb37e6e27f4da44aa496321abf66def05ca151218680c776772fc893824f03ab61ed6e11d3c2006853bd627d53f378eb79f3190033d69869a8ee574184177
+  metadata.gz: 013403a018b4536d8d4a15359a7f95dc8aaab9962313206666653d8b3fb6f6a59d2e4b9e43502480da9d19a1e5fa2b8a4b080fa6aa6837d52a7c99bd33f9ea44
+  data.tar.gz: 21e416ce8cb88cafcd7ac40b715ab574cd028a7ffc094f85785c0a8cb116ae73763df6380f0cc9f25935cb81d938a1f5f763b831d69dfa13da7e24ec22235ed0

data/.github/workflows/CI.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 2.6, 2.7, 3 ]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: ${{ matrix.ruby }}
+          parallel: true
+
+  finish:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+          parallel-finished: true

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: '2.3'
+  NewCops: enable
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 Metrics:

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+### 0.6.0 (April 7, 2022)
+
+- Breaking changes
+  - Liquid parsing is now strict ([#29](https://github.com/velocidi/frise/pull/29)).
+  - Update liquid gem to `5.3.0` ([#29](https://github.com/velocidi/frise/pull/29)).
+
+- New features
+  - Add `json` liquid filter ([#28](https://github.com/velocidi/frise/pull/28)).
+
+### 0.5.1 (March 28, 2022)
+
+- Breaking changes
+  - Increase minimum required ruby version to 2.6.0 ([#22](https://github.com/velocidi/frise/pull/22)).
+- Bug fixes
+  - Fix YAML.safe_load call arguments error in ruby 3.1 ([#26](https://github.com/velocidi/frise/pull/26)).
+
+### 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/frise.gemspec

@@ -18,14 +18,15 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features|example)/})
   end
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 2.6.0'
 
-  spec.add_dependency 'liquid', '~> 4.0'
+  spec.add_dependency 'liquid', '~> 5.3.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'rubocop', '0.77.0'
-  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'rubocop', '~> 1.10'
+  spec.add_development_dependency 'simplecov', '~> 0.18'
+  spec.add_development_dependency 'simplecov-lcov', '0.8.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/frise/defaults_loader.rb

@@ -10,20 +10,20 @@ 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)
-      class_name = obj.class.to_s
-      return 'String' if class_name == 'Hash' && !obj[@content_include_sym].nil?
-      return 'Boolean' if %w[TrueClass FalseClass].include? class_name
-      return 'Integer' if %w[Fixnum Bignum].include? class_name
-      class_name
-    end
-
+    # rubocop:disable Lint/DuplicateBranch
     def merge_defaults_obj(config, defaults)
       config_class = widened_class(config)
       defaults_class = widened_class(defaults)
@@ -34,9 +34,13 @@ module Frise
       elsif config.nil?
         if defaults_class != 'Hash' then defaults
         elsif defaults['$optional'] then nil
-        else merge_defaults_obj({}, defaults)
+        else
+          merge_defaults_obj({}, defaults)
         end
 
+      elsif config == @delete_sym
+        config
+
       elsif defaults_class == 'Array' && config_class == 'Array'
         defaults + config
 
@@ -56,12 +60,13 @@ module Frise
 
       elsif defaults_class != config_class
         raise "Cannot merge config #{config.inspect} (#{widened_class(config)}) " \
-          "with default #{defaults.inspect} (#{widened_class(defaults)})"
+              "with default #{defaults.inspect} (#{widened_class(defaults)})"
 
       else
         config
       end
     end
+    # rubocop:enable Lint/DuplicateBranch
 
     def merge_defaults_obj_at(config, at_path, defaults)
       at_path.reverse.each { |key| defaults = { key => defaults } }
@@ -77,5 +82,15 @@ module Frise
       defaults = Parser.parse(defaults_file, symbol_table) || {}
       merge_defaults_obj_at(config, at_path, defaults)
     end
+
+    private
+
+    def widened_class(obj)
+      class_name = obj.class.to_s
+      return 'String' if class_name == 'Hash' && !obj[@content_include_sym].nil?
+      return 'Boolean' if %w[TrueClass FalseClass].include? class_name
+      return 'Integer' if %w[Fixnum Bignum].include? class_name
+      class_name
+    end
   end
 end

data/lib/frise/loader/lazy.rb

@@ -12,11 +12,9 @@ module Frise
         @__target_object__ ||= @callable.call
       end
 
-      # rubocop:disable Style/MethodMissingSuper
       def method_missing(method_name, *args, &block)
         __target_object__.send(method_name, *args, &block)
       end
-      # rubocop:enable Style/MethodMissingSuper
 
       def respond_to_missing?(method_name, include_private = false)
         __target_object__.respond_to?(method_name, include_private)

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,15 +42,15 @@ 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
 
     private
 
     def process_includes(config, at_path, root_config, global_vars, include_confs_stack = [])
-      return config unless config.class == Hash
+      return config unless config.instance_of?(Hash)
 
       # process $content_include directives
       config, content_include_confs = extract_content_include(config, at_path)
@@ -65,26 +68,28 @@ 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.to_h { |k, v| [k, process_includes(v, at_path + [k], root_config, global_vars)] }
+            else
+              Lazy.new do
+                include_conf = include_confs.first
+                rest_include_confs = include_confs[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)
-      return schema unless schema.class == Hash
+      return schema unless schema.instance_of?(Hash)
 
       schema, included_schemas = extract_include(schema, at_path)
       if included_schemas.empty?
-        schema.map { |k, v| [k, process_schema_includes(v, at_path + [k], global_vars)] }.to_h
+        schema.to_h { |k, v| [k, process_schema_includes(v, at_path + [k], global_vars)] }
       else
         included_schemas.each do |defaults_conf|
           schema = Parser.parse(defaults_conf['file'], global_vars).merge(schema)
@@ -94,13 +99,13 @@ module Frise
     end
 
     def process_schemas(config, at_path, global_vars)
-      return config unless config.class == Hash
+      return config unless config.instance_of?(Hash)
 
-      config = config.map do |k, v|
+      config = config.to_h 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
+      end
 
       config, schema_files = extract_schema(config, at_path)
       schema_files.each do |schema_file|
@@ -145,10 +150,10 @@ module Frise
       end
     end
 
-    def extract_special(config, key, at_path)
+    def extract_special(config, key, at_path, &block)
       case config[key]
       when nil then [config, []]
-      when Array then [config.reject { |k| k == key }, config[key].map { |e| yield e }]
+      when Array then [config.reject { |k| k == key }, config[key].map(&block)]
       else raise "At #{build_path(at_path)}: illegal value for #{key}: #{config[key].inspect}"
       end
     end
@@ -160,6 +165,18 @@ module Frise
       config.merge(head => merge_at(config[head], tail, to_merge))
     end
 
+    # returns the config without the keys whose values are @delete_sym
+    # @delete_sym given as array elements are not handled.
+    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
@@ -167,10 +184,10 @@ module Frise
     #   - `global_vars`: the global variables
     #   - `include_conf`: the $include or $content_include configuration
     def build_symbol_table(root_config, at_path, config, global_vars, include_conf)
-      extra_vars = (include_conf['vars'] || {}).map { |k, v| [k, root_config.dig(*v.split('.'))] }.to_h
+      extra_vars = (include_conf['vars'] || {}).transform_values { |v| root_config.dig(*v.split('.')) }
       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/parser.rb

@@ -10,13 +10,18 @@ module Frise
     class << self
       def parse(file, symbol_table = nil)
         return nil unless File.file? file
-        YAML.safe_load(parse_as_text(file, symbol_table), [], [], true) || {}
+        YAML.safe_load(parse_as_text(file, symbol_table), aliases: true) || {}
       end
 
       def parse_as_text(file, symbol_table = nil)
         return nil unless File.file? file
         content = File.read(file)
-        content = Liquid::Template.parse(content).render with_internal_vars(file, symbol_table) if symbol_table
+        template = Liquid::Template.parse(content, error_mode: :strict)
+        if symbol_table
+          content = template.render!(with_internal_vars(file, symbol_table), {
+                                       strict_filters: true
+                                     })
+        end
         content
       end
 

data/lib/frise/validator.rb

@@ -14,6 +14,8 @@ module Frise
     attr_reader :errors
 
     def initialize(root, validators = nil)
+      super()
+
       @root = root
       @validators = validators
       @errors = []
@@ -33,7 +35,7 @@ module Frise
 
     def get_full_schema(schema)
       case schema
-      when Hash then
+      when Hash
         default_type = schema[:enum] || schema[:one_of] ? 'Object' : 'Hash'
         { type: default_type }.merge(schema)
       when Symbol then { type: 'Object', validate: schema }
@@ -93,7 +95,7 @@ module Frise
     def validate_enum(full_schema, obj, path)
       if full_schema[:enum] && !full_schema[:enum].include?(obj)
         add_validation_error(path, "invalid value #{obj.inspect}. " \
-          "Accepted values are #{full_schema[:enum].map(&:inspect).join(', ')}")
+                                   "Accepted values are #{full_schema[:enum].map(&:inspect).join(', ')}")
         return false
       end
       true
@@ -124,7 +126,7 @@ module Frise
     def validate_remaining_keys(full_schema, obj, path, processed_keys)
       expected_types = get_expected_types(full_schema)
       if expected_types.size == 1 && expected_types[0].ancestors.member?(Enumerable)
-        hash = obj.is_a?(Hash) ? obj : Hash[obj.map.with_index { |x, i| [i, x] }]
+        hash = obj.is_a?(Hash) ? obj : obj.map.with_index { |x, i| [i, x] }.to_h
         hash.each do |key, value|
           validate_object(path, key, full_schema[:all_keys]) if full_schema[:all_keys] && !key.is_a?(Symbol)
 
@@ -156,17 +158,27 @@ module Frise
     def self.parse_symbols(obj)
       case obj
       when Array then obj.map { |e| parse_symbols(e) }
-      when Hash then Hash[obj.map { |k, v| [parse_symbols(k), parse_symbols(v)] }]
-      when String then obj.start_with?('$') ? obj[1..-1].to_sym : obj
+      when Hash then obj.to_h { |k, v| [parse_symbols(k), parse_symbols(v)] }
+      when String then obj.start_with?('$') ? obj[1..].to_sym : obj
       else obj
       end
     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)
+    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 } }
 
@@ -188,11 +200,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
 
@@ -202,6 +214,8 @@ module Frise
     attr_reader :errors
 
     def initialize(errors)
+      super()
+
       @errors = errors
     end
   end

data/lib/frise/version.rb

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

data/lib/frise.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'liquid/liquid'
+
 require 'frise/defaults_loader'
 require 'frise/loader/lazy'
 require 'frise/loader'

data/lib/liquid/json_filter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'json'
+
+# Converts a variable into its JSON representation
+module JsonFilter
+  def json(object)
+    JSON.dump(object)
+  end
+end

data/lib/liquid/liquid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'liquid'
+
+require_relative 'json_filter'
+
+Liquid::Template.register_filter(JsonFilter)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frise
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Velocidi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-29 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 5.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 5.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,86 +39,86 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: '0.18'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.16'
-description: 
+        version: 0.8.0
+description:
 email:
 - hello@velocidi.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/CI.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -132,11 +132,14 @@ files:
 - lib/frise/parser.rb
 - lib/frise/validator.rb
 - lib/frise/version.rb
+- lib/liquid/json_filter.rb
+- lib/liquid/liquid.rb
 homepage: https://github.com/velocidi/frise
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,16 +147,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Ruby config library with schema validation, default values and templating
 test_files: []

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-before_install:
-  - gem install bundler