curly_bracket_parser 0.1.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2581aa770602a42a73eb9f79f3840dd53609d2905a75db5aaf3a5b0dac1f018
-  data.tar.gz: 912c7fb9c2285515bf5b7af00da8c629222af329e68dd431f5cd649c20815df4
+  metadata.gz: 3d129cee0f2fe16c754b7b4f10d31505d8279dc4399c03e94bab98f9c86b9c60
+  data.tar.gz: 4477f5908c20c4f3513705dd973f702a6addd118f8aab221cab9bc3c751167f4
 SHA512:
-  metadata.gz: 05eba36a79347485fd42db86ecfe49824913b497a89b6f36aa3b2924c4b2b8b6b1fae89b4bb3099708f5b76488706d1d6da4ff035f0c41bbf52cb0633f96a624
-  data.tar.gz: 56a9306ca6375a6e7c4366781b638eb509918c2a101703de930d0f481a8661ef00e1054925c74ff845c3de0cd2ea51f6b7304f34a259aad27379a8a15fa51c3b
+  metadata.gz: 633664bae5c9062f5d71a0ec643db1c957b936e88a5fae88a7dda9cbb80d12d2682e37d4b8da33cd1c7a1fdd52e28a169a792bdb66ae004fb716fef4cb595c22
+  data.tar.gz: a6aebeae6ee35a392fe90b8d6d59838abb4bb49097ef2048c4e62fcddd95c61837cffc20c5367d8a3a77a4f2b3035ddbea12ae1b7ab7b249957200836ba876cf

data/README.md

@@ -1,15 +1,11 @@
 # curly_bracket_parser
 
-Simple parser to replace curly brackets `{{like_this}}` inside strings like URLs, texts or even files easily.
+Ruby gem with 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}}`
 
 Using [LuckyCase](https://github.com/magynhard/lucky_case), all its case formats are supported as filter.
 
-```diff
-- beta version
-```
-
 
 
 

data/lib/curly_bracket_parser.rb

@@ -1,7 +1,11 @@
 require 'lucky_case'
 
 require 'curly_bracket_parser/version'
+require_relative 'custom_errors/filter_already_registered_error'
+require_relative 'custom_errors/invalid_filter_error'
+require_relative 'custom_errors/invalid_variable_error'
 require_relative 'custom_errors/unresolved_variables_error'
+require_relative 'custom_errors/variable_already_registered_error'
 
 #
 # CurlyBracketParser
@@ -17,8 +21,8 @@ module CurlyBracketParser
   VARIABLE_DECODER_REGEX = /{{([^{}\|]+)\|?([^{}\|]*)}}/
   VARIABLE_REGEX = /{{[^{}]+}}/
 
-  VALID_FILTERS = [
-      LuckyCase::CASES.keys.map(&:to_s)
+  VALID_DEFAULT_FILTERS = [
+    LuckyCase::CASES.keys.map(&:to_s)
   ].flatten
 
   #----------------------------------------------------------------------------------------------------
@@ -31,13 +35,21 @@ module CurlyBracketParser
   # @param [String] replace_pattern pattern used when param unresolved_vars is set to :replace. You can include the var name \\1 and filter \\1. Empty string to remove unresolved variables.
   # @return [String, UnresolvedVariablesError] parsed string
   def self.parse(string, variables, unresolved_vars: :raise, replace_pattern: "##\\1##")
+    variables ||= {}
     result_string = string.clone
     if CurlyBracketParser.any_variable_included? string
       loop do
         variables(string).each do |string_var|
           name, filter = decode_variable(string_var)
           if variables[name.to_sym]
-            value = process_filter(variables[name.to_sym], filter)
+            value = if filter
+                      process_filter(filter, variables[name.to_sym])
+                    else
+                      variables[name.to_sym]
+                    end
+            result_string.gsub!(string_var, value)
+          elsif registered_default_var?(name.to_s)
+            value = process_default_var(name)
             result_string.gsub!(string_var, value)
           end
         end
@@ -89,42 +101,154 @@ module CurlyBracketParser
 
   # Register your custom filter to the filter list
   #
-  # @param [String] name of the filter, also used then in your strings, e.g. {{var_name|my_filter_name}}
+  # @param [String] filter name of the filter, also used then in your strings, e.g. {{var_name|my_filter_name}}
   # @param [Lambda] function of the filter to run the variable against
   # @return [Boolean] true if filter was added, false if it already exists
-  def self.register_filter(name, &block)
-    raise "NOT IMPLEMENTED YET!"
+  def self.register_filter(filter, &block)
+    @@registered_filters ||= {}
+    filter = filter.to_s
+    if valid_filter?(filter)
+      raise FilterAlreadyRegisteredError, "The given filter name '#{filter}' is already registered"
+    else
+      @@registered_filters[filter] = block
+    end
   end
 
   #----------------------------------------------------------------------------------------------------
 
-  def self.register_default_variable(name, &block)
-    raise "NOT IMPLEMENTED YET!"
+  # @param [String] filter name of the filter, also used then in your strings, e.g. {{var_name|my_filter_name}}
+  # @param [String] value string to apply the specified filter on
+  # @return [String] converted string with applied filter
+  def self.process_filter(filter, value)
+    @@registered_filters ||= {}
+    filter = filter.to_s
+    if @@registered_filters[filter]
+      @@registered_filters[filter].call(value)
+    elsif VALID_DEFAULT_FILTERS.include?(filter) && LuckyCase.valid_case_type?(filter)
+      LuckyCase.convert_case(value, filter)
+    else
+      message = "Invalid filter '#{filter}'. Valid filters are: #{self.valid_filters.join(' ')}"
+      raise InvalidFilterError, message
+    end
   end
 
   #----------------------------------------------------------------------------------------------------
 
-  def self.process_filter(value, filter)
-    return value unless filter
-    if VALID_FILTERS.include? filter
-      if LuckyCase.valid_case_type? filter
-        return LuckyCase.convert_case(value, filter)
-      else
-        raise "FILTER '#{filter}' NOT IMPLEMENTED YET!"
-      end
-    else
-      raise "Invalid filter '#{filter}'"
-    end
+  # Retrieve Array with valid filters
+  #
+  # @return [Array<String>] of valid filters
+  def self.valid_filters
+    all_filters = VALID_DEFAULT_FILTERS
+    @@registered_filters ||= {}
+    all_filters + @@registered_filters.keys.map(&:to_s)
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  # Check if a given filter is valid
+  #
+  # @param [String] name
+  # @return [Boolean] true if filter exists, otherwise false
+  def self.valid_filter?(name)
+    self.valid_filters.include? name
   end
 
   #----------------------------------------------------------------------------------------------------
 
+  # Check if given variable has a defined filter
+  # @example
+  #   {{variable|filter}}  => has filter, true
+  #   {{variable2}}        => has no filter, false
+  #
+  # @param [String] variable
+  # @return [Boolean] true if has a defined filter, otherwise false
   def self.has_filter?(variable)
     decode_variable(variable)[:filter] != nil
   end
 
   #----------------------------------------------------------------------------------------------------
 
+  # Return the given default variable by processing its block/proc
+  #
+  # @param [String] name of the variable to return
+  # @return [String] value of the variable
+  def self.process_default_var(name)
+    @@registered_default_vars ||= {}
+    name = name.to_s
+    if @@registered_default_vars[name]
+      @@registered_default_vars[name].call()
+    else
+      message = "Invalid default variable '#{name}'. Valid registered default variables are: #{self.registered_default_vars.join(' ')}"
+      raise InvalidVariableError, message
+    end
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  # Register a default variable to be replaced automatically by the given block value in future
+  # If the variable exists already, it will throw an VariableAlreadyRegisteredError
+  #
+  # @param [String] name of the default var
+  # @param [Proc] block
+  # @return [Proc] given block
+  def self.register_default_var(name, &block)
+    @@registered_default_vars ||= {}
+    name = name.to_s
+    if registered_default_var?(name)
+      raise VariableAlreadyRegisteredError, "The given variable name '#{name}' is already registered. If you want to override that variable explicitly, call #register_default_var! instead!"
+    else
+      @@registered_default_vars[name] = block
+    end
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  # Register a default variable to be replaced automatically by the given block value in future
+  # If the variable exists already, it will be overwritten
+  #
+  # @param [String] name of the default var
+  # @param [Proc] block
+  # @return [Proc] given block
+  def self.register_default_var!(name, &block)
+    @@registered_default_vars ||= {}
+    name = name.to_s
+    @@registered_default_vars[name] = block
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  # Unregister / remove an existing default variable
+  #
+  # @param [String] name of the variable
+  def self.unregister_default_var(name)
+    @@registered_default_vars ||= {}
+    name = name.to_s
+    @@registered_default_vars.delete(name)
+    nil
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  # Return an array of registered default variables
+  #
+  # @return [Array<String>]
+  def self.registered_default_vars
+    @@registered_default_vars ||= {}
+    @@registered_default_vars.keys.map(&:to_s)
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  # Check if the given variable is a registered default variable
+  #
+  # @param [String] name of the variable
+  # @return [Boolean] true if variable is registered, otherwise false
+  def self.registered_default_var?(name)
+    self.registered_default_vars.include? name
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
   # Return a hash containing separated name and filter of a variable
   #
   # @example
@@ -145,7 +269,7 @@ module CurlyBracketParser
   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
+    string.scan(VARIABLE_DECODER_REGEX).map { |e| { "#{e[var_name].strip}": e[var_filter].strip != '' ? e[var_filter].strip : nil } }.flatten
   end
 
   #----------------------------------------------------------------------------------------------------

data/lib/curly_bracket_parser/version.rb

@@ -1,3 +1,3 @@
 module CurlyBracketParser
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/lib/custom_errors/filter_already_registered_error.rb

@@ -0,0 +1,2 @@
+class FilterAlreadyRegisteredError < StandardError
+end

data/lib/custom_errors/invalid_filter_error.rb

@@ -0,0 +1,2 @@
+class InvalidFilterError < StandardError
+end

data/lib/custom_errors/invalid_variable_error.rb

@@ -0,0 +1,2 @@
+class InvalidVariableError < StandardError
+end

data/lib/custom_errors/variable_already_registered_error.rb

@@ -0,0 +1,2 @@
+class VariableAlreadyRegisteredError < StandardError
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curly_bracket_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Matthäus Beyrle
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-22 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucky_case
@@ -85,7 +85,11 @@ files:
 - curly_bracket_parser.gemspec
 - lib/curly_bracket_parser.rb
 - lib/curly_bracket_parser/version.rb
+- lib/custom_errors/filter_already_registered_error.rb
+- lib/custom_errors/invalid_filter_error.rb
+- lib/custom_errors/invalid_variable_error.rb
 - lib/custom_errors/unresolved_variables_error.rb
+- lib/custom_errors/variable_already_registered_error.rb
 homepage: https://github.com/magynhard/curly_bracket_parser
 licenses:
 - MIT