curly_bracket_parser 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 437e9b2cda38fa373852f4b2f67a35428f99d5c78928820b539ae8c5ecf77d09
-  data.tar.gz: b11dd97f668eff6128b5ae0a9846189c7a8e6291953e7a475080fe705247e9f3
+  metadata.gz: e2581aa770602a42a73eb9f79f3840dd53609d2905a75db5aaf3a5b0dac1f018
+  data.tar.gz: 912c7fb9c2285515bf5b7af00da8c629222af329e68dd431f5cd649c20815df4
 SHA512:
-  metadata.gz: d8286bc6b15346a2babed4de6894be8fadad6c84c9d51ad759fdae906ecec41fdc50d28cf294fb3f8f1b67b6745bf6206e95d337f743ed82fc488cd77b4c6bea
-  data.tar.gz: 3aab318c0069bf40f73443eefb0245e53c35bbddfb6373883e921ae32e3ebd1b26050319ab24e6336baf98283023ee9232a36dd2655745ee3b018170836a490d
+  metadata.gz: 05eba36a79347485fd42db86ecfe49824913b497a89b6f36aa3b2924c4b2b8b6b1fae89b4bb3099708f5b76488706d1d6da4ff035f0c41bbf52cb0633f96a624
+  data.tar.gz: 56a9306ca6375a6e7c4366781b638eb509918c2a101703de930d0f481a8661ef00e1054925c74ff845c3de0cd2ea51f6b7304f34a259aad27379a8a15fa51c3b

data/README.md

@@ -1,9 +1,14 @@
 # curly_bracket_parser
 
-Simple parser to replace curly brackets {{like_this}} inside strings like URLs, Texts or even files easily.
+Simple parser to replace curly brackets `{{like_this}}` inside strings like URLs, texts or even files easily.
 
-alpha version ... to be done ...
+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
+```
 
 
 
@@ -36,23 +41,13 @@ Or install it yourself as:
 
     $ gem install curly_bracket_parser
     
-## Common information
-
-TODO
-
-
-
-
-
 
 <a name="usage"></a>
-## Usage
-
-TODO
+## Usage examples
 
-### Examples
+You can either parse variables inside strings or even directly in files.
 
-#### Basic
+### Basic
 
 ```ruby
     url = "https://my-domain.com/items/{{item_id}}"
@@ -60,7 +55,7 @@ TODO
     # => "https://my-domain.com/items/123"
 ```
 
-#### Filters
+### Filters
 
 ```ruby
     url = "https://my-domain.com/catalog/{{item_name|snake_case}}"
@@ -68,9 +63,51 @@ TODO
     # => "https://my-domain.com/catalog/mega_super_item"
 ```
 
-#### Globals
+For a list of built-in filters visit [LuckyCase](https://github.com/magynhard/lucky_case).
+
+#### Define your custom filter
+
+```ruby
+    CurlyBracketParser.register_filter('7times') do |string|
+      string.to_s * 7
+    end
+
+    text = "Paul went out and screamed: A{{scream|7times}}h"
+    final_text = CurlyBracketParser.parse text, scream: 'a'
+    # => "Paul went out and screamed: Aaaaaaaah"
+```
+
+### Files
+
+<ins>test.html</ins>
+```html
+<h1>{{title|sentence_case}}</h1>
+```
+
+```ruby
+    parsed_file = CurlyBracketParser.parse_file './test.html', title: 'WelcomeAtHome'
+    # => "<h1>Welcome at home</h1>"
+```
 
-TODO
+Use `#parse_file!` instead to write the parsed string directly into the file!
+
+### Default variables
+
+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.
+
+```ruby
+    CurlyBracketParser.register_default_var('version') do
+      '1.0.2'
+    end
+
+    text = "You are running version {{version}}"
+    CurlyBracketParser.parse text
+    # => "You are running version 1.0.2"
+    CurlyBracketParser.parse text, version: '0.7.0'
+    # => "You are running version 0.7.0"
+```
 
 
 

data/lib/curly_bracket_parser.rb

@@ -23,6 +23,8 @@ module CurlyBracketParser
 
   #----------------------------------------------------------------------------------------------------
 
+  # Parse given string and replace the included variables by the given variables
+  #
   # @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.
@@ -56,23 +58,47 @@ module CurlyBracketParser
 
   #----------------------------------------------------------------------------------------------------
 
-  def self.parse_file(path, variables, options = {})
-    raise "NOT IMPLEMENTED YET!"
+  # Parse the content of the file of the given path with #parse and return it.
+  # The original file keeps unmodified.
+  #
+  # @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.
+  # @return [String, UnresolvedVariablesError] parsed string
+  def self.parse_file(path, variables, unresolved_vars: :raise, replace_pattern: "##\\1##")
+    file_content = File.read path
+    parse(file_content, variables, unresolved_vars: unresolved_vars, replace_pattern: replace_pattern)
   end
 
-  def self.parse_file!(path, variables, options = {})
-    raise "NOT IMPLEMENTED YET!"
+  # Parse the content of the file of the given path with #parse and return it.
+  # The original file will be overwritten by the parsed content.
+  #
+  # @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.
+  # @return [String, UnresolvedVariablesError] parsed string
+  def self.parse_file!(path, variables, unresolved_vars: :raise, replace_pattern: "##\\1##")
+    parsed_file = parse_file path, variables, unresolved_vars: unresolved_vars, replace_pattern: replace_pattern
+    File.write path, parsed_file
+    parsed_file
   end
 
   #----------------------------------------------------------------------------------------------------
 
-  def self.register_filter(name, function)
+  # 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 [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!"
   end
 
   #----------------------------------------------------------------------------------------------------
 
-  def self.register_default_variable(name, function)
+  def self.register_default_variable(name, &block)
     raise "NOT IMPLEMENTED YET!"
   end
 
@@ -133,12 +159,19 @@ module CurlyBracketParser
 
   #----------------------------------------------------------------------------------------------------
 
+  # Check if any variable is included in the given string
+  # @param [Object] string
+  # @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
   end
 
   #----------------------------------------------------------------------------------------------------
 
+  # Check if one of the given variable names is included in the given string
+  # @param [Array<String>] variable_names
+  # @param [String] string
+  # @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])

data/lib/curly_bracket_parser/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curly_bracket_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Matthäus Beyrle
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-17 00:00:00.000000000 Z
+date: 2020-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucky_case