curly_bracket_parser 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d129cee0f2fe16c754b7b4f10d31505d8279dc4399c03e94bab98f9c86b9c60
-  data.tar.gz: 4477f5908c20c4f3513705dd973f702a6addd118f8aab221cab9bc3c751167f4
+  metadata.gz: 7e5f953c9b35c41ca0b623017a51fd7d9d122cdcd02654306a95bcd0b32d7a2e
+  data.tar.gz: cfb7e3120bb559ee8dcb2c4840c98dc8d741b18d1ad6a287b77e6930025462f0
 SHA512:
-  metadata.gz: 633664bae5c9062f5d71a0ec643db1c957b936e88a5fae88a7dda9cbb80d12d2682e37d4b8da33cd1c7a1fdd52e28a169a792bdb66ae004fb716fef4cb595c22
-  data.tar.gz: a6aebeae6ee35a392fe90b8d6d59838abb4bb49097ef2048c4e62fcddd95c61837cffc20c5367d8a3a77a4f2b3035ddbea12ae1b7ab7b249957200836ba876cf
+  metadata.gz: 67b58ee971ab43ffa2f2c5f71dc413c9ed9c96fdf61678eb4fa6dd1a3c5f20051cda50622c95bede909b27aeab94aa50a588372c9bd2171cd65374f2cc31d1da
+  data.tar.gz: 19c1dbddc62920667d6cfbdadaea54927b8402c3b7cc3ab0797e2d65fc4b0349fe9bbd5e0092fb0df600dcec5006b9eb166d54282e03e4d7a9b629ecae2af363

data/README.md

@@ -1,10 +1,10 @@
 # curly_bracket_parser
 
-Ruby gem with 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}}`
 
-Using [LuckyCase](https://github.com/magynhard/lucky_case), all its case formats are supported as filter.
+Using [LuckyCase](https://github.com/magynhard/lucky_case), all its case formats are supported as filter by default.
 
 
 
@@ -13,7 +13,7 @@ Using [LuckyCase](https://github.com/magynhard/lucky_case), all its case formats
 # Contents
 
 * [Installation](#installation)
-* [Usage](#usage)
+* [Usage examples](#usage)
 * [Documentation](#documentation)
 * [Contributing](#contributing)
 
@@ -91,7 +91,7 @@ Use `#parse_file!` instead to write the parsed string directly into the file!
 
 You can define default variables, which will be replaced automatically without passing them by parameters, but can be overwritten with parameters.
 
-Because of providing blocks, your variables can dynamically depend on other states.
+Because of providing blocks, your variables can dynamically depend on other states (e.g. current date).
 
 ```ruby
     CurlyBracketParser.register_default_var('version') do

data/lib/curly_bracket_parser.rb

@@ -32,7 +32,7 @@ module CurlyBracketParser
   # @param [String] string to parse
   # @param [Hash<Symbol => String>] variables <key: 'value'>
   # @param [Symbol] unresolved_vars :raise, :keep, :replace => define how to act when unresolved variables within the string are found.
-  # @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.
+  # @param [String] replace_pattern pattern used when param unresolved_vars is set to :replace. You can include the var name \\1 and filter \\2. Empty string to remove unresolved variables.
   # @return [String, UnresolvedVariablesError] parsed string
   def self.parse(string, variables, unresolved_vars: :raise, replace_pattern: "##\\1##")
     variables ||= {}
@@ -103,7 +103,7 @@ module CurlyBracketParser
   #
   # @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
+  # @raise [FilterAlreadyRegisteredError] if filter does already exist
   def self.register_filter(filter, &block)
     @@registered_filters ||= {}
     filter = filter.to_s
@@ -112,10 +112,13 @@ module CurlyBracketParser
     else
       @@registered_filters[filter] = block
     end
+    nil
   end
 
   #----------------------------------------------------------------------------------------------------
 
+  # Process the given value with the given filter
+  #
   # @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
@@ -155,19 +158,6 @@ module CurlyBracketParser
 
   #----------------------------------------------------------------------------------------------------
 
-  # 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

data/lib/curly_bracket_parser/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curly_bracket_parser
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Matthäus Beyrle
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucky_case