curly_bracket_parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 437e9b2cda38fa373852f4b2f67a35428f99d5c78928820b539ae8c5ecf77d09
+  data.tar.gz: b11dd97f668eff6128b5ae0a9846189c7a8e6291953e7a475080fe705247e9f3
+SHA512:
+  metadata.gz: d8286bc6b15346a2babed4de6894be8fadad6c84c9d51ad759fdae906ecec41fdc50d28cf294fb3f8f1b67b6745bf6206e95d337f743ed82fc488cd77b4c6bea
+  data.tar.gz: 3aab318c0069bf40f73443eefb0245e53c35bbddfb6373883e921ae32e3ebd1b26050319ab24e6336baf98283023ee9232a36dd2655745ee3b018170836a490d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode/
+/.idea/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at curly_bracket_parser.gemspec@mail.magynhard.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in curly_bracket_parser.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# curly_bracket_parser
+
+Simple parser to replace curly brackets {{like_this}} inside strings like URLs, Texts or even files easily.
+
+alpha version ... to be done ...
+
+
+
+
+
+
+# Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+
+
+
+
+<a name="installation"></a>
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'curly_bracket_parser'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install curly_bracket_parser
+    
+## Common information
+
+TODO
+
+
+
+
+
+
+<a name="usage"></a>
+## Usage
+
+TODO
+
+### Examples
+
+#### Basic
+
+```ruby
+    url = "https://my-domain.com/items/{{item_id}}"
+    final_url = CurlyBracketParser.parse url, item_id: 123
+    # => "https://my-domain.com/items/123"
+```
+
+#### Filters
+
+```ruby
+    url = "https://my-domain.com/catalog/{{item_name|snake_case}}"
+    final_url = CurlyBracketParser.parse url, item_name: 'MegaSuperItem'
+    # => "https://my-domain.com/catalog/mega_super_item"
+```
+
+#### Globals
+
+TODO
+
+
+
+
+<a name="documentation"></a>
+## Documentation
+Check out the doc at RubyDoc
+<a href="https://www.rubydoc.info/gems/curly_bracket_parser">https://www.rubydoc.info/gems/curly_bracket_parser</a>
+
+
+
+
+
+<a name="contributing"></a>
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/magynhard/curly_bracket_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+#
+# run default task to see tasks to build and publish gem
+#
+task :default do
+  system 'rake --tasks'
+end
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "curly_bracket_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/curly_bracket_parser.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'curly_bracket_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "curly_bracket_parser"
+  spec.version       = CurlyBracketParser::VERSION
+  spec.authors       = ["Matthäus Beyrle"]
+  spec.email         = ["curly_bracket_parser.gemspec@mail.magynhard.de"]
+
+  spec.summary       = %q{Simple parser to replace variables inside templates/strings and files}
+  spec.homepage      = "https://github.com/magynhard/curly_bracket_parser"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'lucky_case', '>= 0.2.2'
+
+  spec.add_development_dependency 'bundler',  '>= 1.14'
+  spec.add_development_dependency 'rake',     '>= 10.0'
+  spec.add_development_dependency 'rspec',    '>= 3.0'
+end

data/lib/curly_bracket_parser.rb

@@ -0,0 +1,151 @@
+require 'lucky_case'
+
+require 'curly_bracket_parser/version'
+require_relative 'custom_errors/unresolved_variables_error'
+
+#
+# CurlyBracketParser
+#
+# Parse variables with curly brackets within templates/strings or files
+#
+# Use filters for special cases
+#
+
+module CurlyBracketParser
+
+  # {{variable_name|optional_filter}}
+  VARIABLE_DECODER_REGEX = /{{([^{}\|]+)\|?([^{}\|]*)}}/
+  VARIABLE_REGEX = /{{[^{}]+}}/
+
+  VALID_FILTERS = [
+      LuckyCase::CASES.keys.map(&:to_s)
+  ].flatten
+
+  #----------------------------------------------------------------------------------------------------
+
+  # @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(string, variables, unresolved_vars: :raise, replace_pattern: "##\\1##")
+    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)
+            result_string.gsub!(string_var, value)
+          end
+        end
+        # break if no more given variable is available
+        break unless any_variable_included?(string) && includes_one_variable_of(variables, string)
+      end
+      case unresolved_vars
+      when :raise
+        if any_variable_included? result_string
+          raise UnresolvedVariablesError, "There are unresolved variables in the given string: #{variables(result_string)}"
+        end
+      when :replace
+        result_string.gsub!(VARIABLE_DECODER_REGEX, replace_pattern)
+      end
+    end
+    result_string
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  def self.parse_file(path, variables, options = {})
+    raise "NOT IMPLEMENTED YET!"
+  end
+
+  def self.parse_file!(path, variables, options = {})
+    raise "NOT IMPLEMENTED YET!"
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  def self.register_filter(name, function)
+    raise "NOT IMPLEMENTED YET!"
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  def self.register_default_variable(name, function)
+    raise "NOT IMPLEMENTED YET!"
+  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
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  def self.has_filter?(variable)
+    decode_variable(variable)[:filter] != nil
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  # Return a hash containing separated name and filter of a variable
+  #
+  # @example
+  #   '{{var_name|filter_name}}' => { name: 'var_name', filter: 'filter_name' }
+  #
+  # @param [String] variable
+  # @return [Array(String, String)] name, filter
+  def self.decode_variable(variable)
+    var = decoded_variables(variable).first
+    [var.keys.first, var.values.first]
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  # scans the given url for variables with pattern '{{var}}'
+  # @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
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  # scans the given url for variables with pattern '{{var}}'
+  # @param [String] string to scan
+  # @return [Array<String>] array of variable names and its filters
+  def self.variables(string)
+    string.scan(VARIABLE_REGEX).flatten
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  def self.any_variable_included?(string)
+    string.match(VARIABLE_REGEX) != nil
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  def self.includes_one_variable_of(variable_names, string)
+    decoded_variables(string).each do |dvar|
+      return true if variable_names.include?(dvar[:name])
+    end
+    false
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+end

data/lib/curly_bracket_parser/version.rb

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

data/lib/custom_errors/unresolved_variables_error.rb

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: curly_bracket_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthäus Beyrle
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lucky_case
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- curly_bracket_parser.gemspec@mail.magynhard.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- curly_bracket_parser.gemspec
+- lib/curly_bracket_parser.rb
+- lib/curly_bracket_parser/version.rb
+- lib/custom_errors/unresolved_variables_error.rb
+homepage: https://github.com/magynhard/curly_bracket_parser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Simple parser to replace variables inside templates/strings and files
+test_files: []