curly_bracket_parser 0.9.2 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 378a04d38936fc44f74b1f4f970d098865a2a48c32cc61632c2fcf399fcec705
-  data.tar.gz: 68afedba437f8b335793bb45f1bb64c6c7b5a6846e33224b52eed05db042fe49
+  metadata.gz: c287b3fc82c91116b7c0ca2f982b81bac5c37e4ca286cd1ea8606de75e0c214f
+  data.tar.gz: 04f59765b1f59ea540d1e152bbc88c0294ca5adc681f30bf1efed3a117cb3afa
 SHA512:
-  metadata.gz: 955864e2612341beb012f20e79aa439ec44c90e59e39bb0b54bcd813b0d680f22d8c24f23337697e1d4caabbed4dfdc5f2791ac8358afabd985d66914941b47c
-  data.tar.gz: 750d7cbd409660d96ad623c9b86d8fed53f9efae81cb268a2bf0b77454ad80abfd515f16bb6d15e1b9d4f7aca6c055bf6dee6e0a75fbdd6368d59292f3f0198d
+  metadata.gz: 685345c3a8551e0749742550f2dae6784501fefa07318b8e76b2b30fd743c96d1571d2550bee0731a1c1609d82055ec39ff943a6aebf3c39db435d4686d8e01c
+  data.tar.gz: a19c4ffb4fe23ce4945023604aeb34ee28a88bd6f89cf2df08f5eab63151fbb0f1ec6b7ec337f6cc8c0b8d2b57c8dacbfec19cbec7b70b22d68cc8b4caf965c6

data/lib/curly_bracket_parser.rb

@@ -40,7 +40,9 @@ module CurlyBracketParser
     if CurlyBracketParser.any_variable_included? string
       loop do
         variables(string).each do |string_var|
-          name, filter = decode_variable(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])
@@ -212,11 +214,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 +254,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 +287,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,8 +297,9 @@ 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|

data/lib/curly_bracket_parser/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curly_bracket_parser
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.9
 platform: ruby
 authors:
 - Matthäus Beyrle