curly_bracket_parser 0.9.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 378a04d38936fc44f74b1f4f970d098865a2a48c32cc61632c2fcf399fcec705
-  data.tar.gz: 68afedba437f8b335793bb45f1bb64c6c7b5a6846e33224b52eed05db042fe49
+  metadata.gz: dbc6e9152c4a5928dd20a24cc8cb59ace5b9c5b5b66204b118061b28cff3f33b
+  data.tar.gz: 851fa1b633944e37968d31755b786939bea79afa624b4e2135167bb3e832555c
 SHA512:
-  metadata.gz: 955864e2612341beb012f20e79aa439ec44c90e59e39bb0b54bcd813b0d680f22d8c24f23337697e1d4caabbed4dfdc5f2791ac8358afabd985d66914941b47c
-  data.tar.gz: 750d7cbd409660d96ad623c9b86d8fed53f9efae81cb268a2bf0b77454ad80abfd515f16bb6d15e1b9d4f7aca6c055bf6dee6e0a75fbdd6368d59292f3f0198d
+  metadata.gz: 162491b1ca8833964b29e38482806b479f6f1ab5d9f0505368ce83b219e9fe3953d2a03aac4d592ade1ad5182365ca344c471f5847cb9abd36a849dd0c8925f5
+  data.tar.gz: 697839790e56524019c7e35a2ebb58f441f27f74458cfbf2d6f4bf1e91d038e777368b9a637f20c2d48d7fe022baa3d8188ac439d400bf524989cb28731812a3

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Matthäus J. N. Beyrle
+Copyright (c) 2020-2021 Matthäus J. N. Beyrle
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,9 @@
 # curly_bracket_parser
+![Gem](https://img.shields.io/gem/v/curly_bracket_parser?color=default&style=plastic&logo=ruby&logoColor=red)
+![Gem](https://img.shields.io/gem/dt/curly_bracket_parser?color=blue&style=plastic)
+[![License: MIT](https://img.shields.io/badge/License-MIT-gold.svg?style=plastic&logo=mit)](LICENSE)
 
-Ruby gem providing a simple parser to replace curly brackets `{{like_this}}` inside strings like URLs, texts or even files easily.
+> Ruby gem providing a simple parser to replace curly brackets `{{like_this}}` inside strings like URLs, texts or even files easily.
 
 Additional support for build-in filters and custom filters make them more powerful. `{{example|my_filter}}`
 

data/lib/curly_bracket_parser/version.rb

@@ -1,3 +1,3 @@
 module CurlyBracketParser
-  VERSION = '0.9.2'.freeze
+  VERSION = '1.0.4'.freeze
 end

data/lib/curly_bracket_parser.rb

@@ -37,10 +37,14 @@ module CurlyBracketParser
   def self.parse(string, variables, unresolved_vars: :raise, replace_pattern: "##\\1##")
     variables ||= {}
     result_string = string.clone
+    # symbolize keys
+    variables = variables.map { |key, value| [key.to_sym, value] }.to_h
     if CurlyBracketParser.any_variable_included? string
       loop do
-        variables(string).each do |string_var|
-          name, filter = decode_variable(string_var)
+        variables(result_string).each do |string_var|
+          dec = decode_variable(string_var)
+          name = dec[:name]
+          filter = dec[:filter]
           if variables[name.to_sym]
             value = if filter
                       process_filter(filter, variables[name.to_sym])
@@ -54,7 +58,9 @@ module CurlyBracketParser
           end
         end
         # break if no more given variable is available
-        break unless any_variable_included?(string) && includes_one_variable_of(variables, string)
+        unless any_variable_included?(result_string) && includes_one_variable_of(variables.keys, result_string)
+          break
+        end
       end
       case unresolved_vars
       when :raise
@@ -212,11 +218,16 @@ module CurlyBracketParser
   # Unregister / remove an existing default variable
   #
   # @param [String] name of the variable
+  # @return [Boolean] true if variable existed and was unregistered, false if it didn't exist
   def self.unregister_default_var(name)
     @@registered_default_vars ||= {}
     name = name.to_s
-    @@registered_default_vars.delete(name)
-    nil
+    if @@registered_default_vars[name]
+      @@registered_default_vars.delete(name)
+      true
+    else
+      false
+    end
   end
 
   #----------------------------------------------------------------------------------------------------
@@ -247,26 +258,30 @@ module CurlyBracketParser
   #   '{{var_name|filter_name}}' => { name: 'var_name', filter: 'filter_name' }
   #
   # @param [String] variable
-  # @return [Array(String, String)] name, filter
+  # @return [Hash<String => String>] name, filter
   def self.decode_variable(variable)
-    var = decoded_variables(variable).first
-    [var.keys.first, var.values.first]
+    decoded_variables(variable).first
   end
 
   #----------------------------------------------------------------------------------------------------
 
-  # scans the given url for variables with pattern '{{var}}'
+  # Scans the given url for variables with pattern '{{var|optional_filter}}'
+  #
+  # @example
+  #   'The variable {{my_var|my_filter}} is inside this string' => [{ name: "my_var", filter: "my_filter"}]
+  #
   # @param [String] string to scan
   # @return [Array<Hash<Symbol => String>>] array of variable names and its filters
   def self.decoded_variables(string)
-    var_name = 0
-    var_filter = 1
-    string.scan(VARIABLE_DECODER_REGEX).map { |e| { "#{e[var_name].strip}": e[var_filter].strip != '' ? e[var_filter].strip : nil } }.flatten
+    var_name_index = 0
+    var_filter_index = 1
+    string.scan(VARIABLE_DECODER_REGEX).map { |e| { name: "#{e[var_name_index].strip}", filter: e[var_filter_index].strip != '' ? e[var_filter_index].strip : nil } }.flatten
   end
 
   #----------------------------------------------------------------------------------------------------
 
-  # scans the given url for variables with pattern '{{var}}'
+  # Scans the given url for variables with pattern '{{var|optional_filter}}'
+  #
   # @param [String] string to scan
   # @return [Array<String>] array of variable names and its filters
   def self.variables(string)
@@ -276,7 +291,8 @@ module CurlyBracketParser
   #----------------------------------------------------------------------------------------------------
 
   # Check if any variable is included in the given string
-  # @param [Object] string
+  #
+  # @param [String] string name of variable to check for
   # @return [Boolean] true if any variable is included in the given string, otherwise false
   def self.any_variable_included?(string)
     string.match(VARIABLE_REGEX) != nil
@@ -285,12 +301,13 @@ module CurlyBracketParser
   #----------------------------------------------------------------------------------------------------
 
   # Check if one of the given variable names is included in the given string
+  #
   # @param [Array<String>] variable_names
-  # @param [String] string
+  # @param [String] string name of variable to check for
   # @return [Boolean] true if one given variable name is included in given the string, otherwise false
   def self.includes_one_variable_of(variable_names, string)
     decoded_variables(string).each do |dvar|
-      return true if variable_names.include?(dvar[:name])
+      return true if variable_names.map(&:to_sym).include?(dvar[:name].to_sym)
     end
     false
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curly_bracket_parser
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Matthäus Beyrle
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-10 00:00:00.000000000 Z
+date: 2022-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucky_case
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Simple parser to replace variables inside templates/strings and files