parameter_substitution 0.3.0.pre.1 → 1.1.0.pre.1

data/lib/parameter_substitution/substitution_expression.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'invoca/utils/array'
+
+class ParameterSubstitution
+  class SubstitutionExpression
+    attr_accessor :parameter_name, :method_calls, :context
+
+    def initialize(parameter_name, method_calls, context)
+      @context = context
+      @parameter_name, @method_calls = fixup_name_and_method_calls(parameter_name, method_calls)
+    end
+
+    def validate(_inside_quotes)
+      # TODO: - Chase down callers who pass allow_nil = false.  Can we get rid of them?
+      if !@context.allow_nil && @context.mapping_has_key?(@parameter_name) && @context.mapped_value(@parameter_name).nil?
+        raise ParameterSubstitution::ParseError, "Replacement parameter '#{@parameter_name}' is nil"
+      end
+
+      method_calls.each(&:validate)
+    end
+
+    def unknown_parameters(inside_quotes)
+      if !@context.mapping_has_key?(@parameter_name) && !(@context.destination_encoding == :json && inside_quotes)
+        @parameter_name
+      end
+    end
+
+    def evaluate(inside_quotes, only_expression: false)
+      if @context.mapping_has_key?(@parameter_name)
+        formatted_value = format(@context.mapped_value(@parameter_name), inside_quotes)
+        if @context.destination_encoding == :raw && formatted_value.nil?
+          only_expression ? '' : "#{@context.parameter_start}#{@parameter_name}#{@context.parameter_end}"
+        else
+          formatted_value
+        end
+      else
+        if @context.destination_encoding == :raw && only_expression
+          ''
+        else
+          "#{@context.parameter_start}#{@parameter_name}#{@context.parameter_end}"
+        end
+      end
+    end
+
+    def ends_inside_quotes(started_inside_quotes:)
+      started_inside_quotes
+    end
+
+    private
+
+    def fixup_name_and_method_calls(parameter_name, method_calls)
+      if args = try_parameter_name(parameter_name, method_calls)
+        args
+      else
+        [parameter_name, method_calls]
+      end
+    end
+
+    def try_parameter_name(parameter_name, method_calls)
+      if @context.mapping_has_key?(parameter_name)
+        [parameter_name, method_calls]
+      elsif !method_calls.empty? && method_calls.first.arguments.empty?
+        first_method = method_calls.first
+        remainder = method_calls[1..-1]
+        try_parameter_name(parameter_name + "." + first_method.name, remainder)
+      end
+    end
+
+    def format(lookup_value, inside_quotes)
+      raw_value = @method_calls.reduce(lookup_value) { |previous_value, method| method.call_method(previous_value) }
+      Encoder.encode(raw_value, @context.destination_encoding, source_encoding, @parameter_name, inside_quotes)
+    end
+
+    def source_encoding
+      @method_calls.last&.encoding || :text
+    end
+  end
+end

data/lib/parameter_substitution/text_expression.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution
+  class TextExpression
+    attr_accessor :value
+    def initialize(value)
+      @value = value
+    end
+
+    def evaluate(_inside_quotes, only_expression: false)
+      @value
+    end
+
+    def validate(_inside_quotes); end
+
+    def parameter_name
+      nil
+    end
+
+    def unknown_parameters(_inside_quotes)
+      nil
+    end
+
+    def ends_inside_quotes(started_inside_quotes:)
+      state = started_inside_quotes ? :InsideString : :OutsideString
+
+      @value.chars.each do |c|
+        case state
+
+        when :InsideString
+          if c == '"'
+            state = :OutsideString
+          elsif c == '\\'
+            state = :InsideStringGotBackslash
+          end
+
+        when :OutsideString
+          if c == '"'
+            state = :InsideString
+          end
+
+        when :InsideStringGotBackslash
+          state = :InsideString
+        else
+          raise "unexpected #{state}"
+        end
+      end
+
+      state != :OutsideString
+    end
+  end
+end

data/lib/parameter_substitution/transform.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'parslet'
+#
+# The transform takes the output from the parser and constructs an Abstract Syntax Tree
+# from the result.  In this case, the output is a list of either TextExpression or SubstitutionExpressions.
+#
+# See the parslet documentation for more detail.
+#
+
+class ParameterSubstitution
+  class Transform < Parslet::Transform
+    def initialize(context)
+      @context = context
+      super
+      define_instance_rules
+    end
+
+    #
+    # Argument lists
+    #
+    rule float_arg: simple(:float) do
+      float.to_f
+    end
+
+    rule int_arg: simple(:int) do
+      int.to_i
+    end
+
+    rule string_arg: simple(:string) do
+      # Strip all leading slashes.
+      ParameterSubstitution::Transform.unescape(string)
+    end
+
+    rule string_arg: sequence(:string) do
+      ""
+    end
+
+    rule nil_arg: simple(:_) do
+      nil
+    end
+
+    rule arg_list: sequence(:parameters) do
+      parameters
+    end
+
+    rule arg_list: simple(:parameter) do
+      [parameter]
+    end
+
+    #
+    # Method Call
+    #
+    rule(method_call: simple(:method_call), arg_list: sequence(:arg_list)) do
+      MethodCallExpression.new(method_call, arg_list)
+    end
+
+    rule(method_call: simple(:method_calls), arg_list: simple(:arg)) do
+      MethodCallExpression.new(method_call, [arg])
+    end
+
+    rule method_call: simple(:method_call) do
+      MethodCallExpression.new(method_call, [])
+    end
+
+    #
+    # The overall expression
+    #
+    rule text: simple(:text) do
+      TextExpression.new(text.to_s)
+    end
+
+    def self.unescape(string)
+      string.to_s.gsub(/\\(.)/) { |v| v[1] }
+    end
+
+    private
+
+    def define_instance_rules
+      # This rule must be defined on the instance so that it can access attributes on the instance.
+      # The definition also takes a parameter to the block so that the block is bound to the instance
+      rule expression: sequence(:parameters) do |dictionary|
+        ParameterSubstitution::Expression.new(dictionary[:parameters], @context)
+      end
+
+      rule raw_expression: sequence(:parameters) do |dictionary|
+        ParameterSubstitution::Expression.new(dictionary[:parameters], @context.duplicate_raw)
+      end
+
+      rule parameter_name: simple(:parameter_name),  method_calls: sequence(:method_calls) do |dictionary|
+        SubstitutionExpression.new(
+          ParameterSubstitution::Transform.unescape(dictionary[:parameter_name].to_s),
+          dictionary[:method_calls],
+          @context
+        )
+      end
+    end
+  end
+end

data/lib/parameter_substitution/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution
+  VERSION = "1.1.0.pre.1"
+end

metadata

@@ -1,27 +1,135 @@
 --- !ruby/object:Gem::Specification
 name: parameter_substitution
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre.1
+  version: 1.1.0.pre.1
 platform: ruby
 authors:
-- Bob Smith
-- James Ebentier
+- Invoca Development
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
-dependencies: []
+date: 2020-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: invoca-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: The substitution can be formatted using a syntax that looks like method
   calls
 email:
-- bob@invoca.com
-- jebentier@invoca.com
-- cmcgrath@invoca.com
+- development@invoca.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/parameter_substitution.rb
+- lib/parameter_substitution/configuration.rb
+- lib/parameter_substitution/context.rb
+- lib/parameter_substitution/encoder.rb
+- lib/parameter_substitution/expression.rb
+- lib/parameter_substitution/formatters/add_prefix.rb
+- lib/parameter_substitution/formatters/base.rb
+- lib/parameter_substitution/formatters/blank_if_nil.rb
+- lib/parameter_substitution/formatters/cgi_unescape.rb
+- lib/parameter_substitution/formatters/compare_string.rb
+- lib/parameter_substitution/formatters/date_time_custom.rb
+- lib/parameter_substitution/formatters/date_time_format.rb
+- lib/parameter_substitution/formatters/date_time_iso8601.rb
+- lib/parameter_substitution/formatters/date_time_iso8601_zulu.rb
+- lib/parameter_substitution/formatters/date_time_strftime.rb
+- lib/parameter_substitution/formatters/date_time_unix_timestamp.rb
+- lib/parameter_substitution/formatters/date_time_us_all_slashes.rb
+- lib/parameter_substitution/formatters/date_time_us_normal.rb
+- lib/parameter_substitution/formatters/date_time_us_seconds.rb
+- lib/parameter_substitution/formatters/date_time_us_short_am_pm.rb
+- lib/parameter_substitution/formatters/date_time_us_short_year.rb
+- lib/parameter_substitution/formatters/date_time_utc_year_first_dashes_seconds.rb
+- lib/parameter_substitution/formatters/date_us_dashes.rb
+- lib/parameter_substitution/formatters/date_us_normal.rb
+- lib/parameter_substitution/formatters/date_year_first_dashes.rb
+- lib/parameter_substitution/formatters/downcase.rb
+- lib/parameter_substitution/formatters/duration_as_seconds.rb
+- lib/parameter_substitution/formatters/duration_as_time.rb
+- lib/parameter_substitution/formatters/duration_grouped_by_description.rb
+- lib/parameter_substitution/formatters/greater_than_value.rb
+- lib/parameter_substitution/formatters/if_nil.rb
+- lib/parameter_substitution/formatters/if_truthy.rb
+- lib/parameter_substitution/formatters/in_timezone.rb
+- lib/parameter_substitution/formatters/json_parse.rb
+- lib/parameter_substitution/formatters/left.rb
+- lib/parameter_substitution/formatters/lookup.rb
+- lib/parameter_substitution/formatters/lower.rb
+- lib/parameter_substitution/formatters/manager.rb
+- lib/parameter_substitution/formatters/md5.rb
+- lib/parameter_substitution/formatters/mid.rb
+- lib/parameter_substitution/formatters/parse_time.rb
+- lib/parameter_substitution/formatters/right.rb
+- lib/parameter_substitution/formatters/sha256.rb
+- lib/parameter_substitution/formatters/split_after_colon.rb
+- lib/parameter_substitution/formatters/split_and_find.rb
+- lib/parameter_substitution/formatters/split_before_colon.rb
+- lib/parameter_substitution/formatters/time_with_seconds.rb
+- lib/parameter_substitution/formatters/trim.rb
+- lib/parameter_substitution/formatters/upper.rb
+- lib/parameter_substitution/method_call_expression.rb
+- lib/parameter_substitution/parse_error.rb
+- lib/parameter_substitution/parser.rb
+- lib/parameter_substitution/substitution_expression.rb
+- lib/parameter_substitution/text_expression.rb
+- lib/parameter_substitution/transform.rb
+- lib/parameter_substitution/version.rb
 homepage: https://github.com/Invoca/parameter_substitution
 licenses: []
 metadata:
@@ -41,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Handles parsing an input strings with embedded substitution parameters and