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

data/lib/parameter_substitution/formatters/cgi_unescape.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::CgiUnescape < ParameterSubstitution::Formatters::Base
+  def self.description
+    "Url-decodes the string, preserves nil."
+  end
+
+  def self.format(value)
+    value && CGI.unescape(value.to_s)
+  end
+end

data/lib/parameter_substitution/formatters/compare_string.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::CompareString < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "Compares the field to a string and returns results based on the comparison"
+  end
+
+  def self.has_parameters?
+    true
+  end
+
+  def initialize(compare_value, true_value, false_value)
+    @compare_value = compare_value
+    @true_value = true_value
+    @false_value = false_value
+  end
+
+  def format(value)
+    value.to_s.casecmp(@compare_value) == 0 ? @true_value : @false_value
+  end
+end

data/lib/parameter_substitution/formatters/date_time_custom.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require "parameter_substitution/formatters/date_time_format"
+
+class ParameterSubstitution::Formatters::DateTimeCustom < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.has_parameters?
+    true
+  end
+
+  def self.description
+    "Formats a Date String with the provided formatting, converts it's time zone, and then converts it to the desired formatting string."
+  end
+
+  def initialize(from_formatting_string, to_formatting_string, from_time_zone, to_time_zone)
+    @parse_options = { from_formatting: from_formatting_string, from_time_zone: from_time_zone }
+    @to_formatting = to_formatting_string
+    @to_time_zone  = to_time_zone
+  end
+
+  def format(value)
+    self.class.parse_to_time(value, @parse_options)&.in_time_zone(@to_time_zone)&.strftime(@to_formatting).to_s # rubocop:disable Lint/SafeNavigationChain
+  end
+end

data/lib/parameter_substitution/formatters/date_time_format.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateTimeFormat < ParameterSubstitution::Formatters::Base
+  MINIMUM_INTEGER_TIME = Time.new(2000, 0o1, 0o1).to_i
+
+  class << self
+    def parse_to_time(value, parse_options = nil)
+      from_custom_time(value, parse_options) ||
+        from_yyyymmddhhmmssss(value) ||
+        from_unix_time_ms(value) ||
+        from_unix_time_sec(value) ||
+        from_parse(value)
+    rescue ArgumentError => ex
+      ex.message =~ /invalid date/ || ex.message =~ /argument out of range/ or raise
+      nil
+    end
+
+    def from_yyyymmddhhmmssss(value)
+      candidate = value.to_s.strip
+      candidate =~ /\d{14}/ && DateTime.strptime(candidate[0, 14], '%Y%m%d%H%M%S')
+    end
+
+    def from_unix_time_sec(value)
+      (value.to_f > MINIMUM_INTEGER_TIME) && Time.zone.at(value.to_f)
+    end
+
+    def from_unix_time_ms(value)
+      (value.to_i / 1000 > MINIMUM_INTEGER_TIME) && Time.zone.at(value.to_f / 1000)
+    end
+
+    def from_parse(value)
+      Time.zone.parse(value.to_s)
+    end
+
+    def from_custom_time(value, parse_options)
+      # parse_options = { from_formatting: "%m-%d-%Y %h %m %z", from_time_zone: "Pacific Time (US & Canada)" }
+      if parse_options && parse_options[:from_formatting]
+        from_time_zone_with_dst = parse_options[:from_time_zone].presence && parse_time_zone_offset(parse_options[:from_time_zone])
+        DateTime.strptime("#{value} #{from_time_zone_with_dst}", parse_options[:from_formatting])
+      end
+    end
+
+    private
+
+    def parse_time_zone_offset(from_time_zone)
+      if (time_zone = ActiveSupport::TimeZone.new(from_time_zone))
+        time_zone.now.formatted_offset
+      else
+        raise "Invalid from_time_zone argument #{from_time_zone} See ActiveSupport::TimeZone"
+      end
+    end
+  end
+end

data/lib/parameter_substitution/formatters/date_time_iso8601.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateTimeIso8601 < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "iso8601 - 2017-04-11T15:55:10+00:00"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.iso8601
+  end
+end

data/lib/parameter_substitution/formatters/date_time_iso8601_zulu.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateTimeIso8601Zulu < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "iso8601 - 2017-04-11T07:00Z"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.strftime("%Y-%m-%dT%TZ")
+  end
+end

data/lib/parameter_substitution/formatters/date_time_strftime.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateTimeStrftime < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.has_parameters?
+    true
+  end
+
+  def self.description
+    "Formats a DateTime with the provided format string."
+  end
+
+  def initialize(formatting_string)
+    @formatting_string = formatting_string
+  end
+
+  def format(value)
+    self.class.parse_to_time(value)&.strftime(@formatting_string).to_s
+  end
+end

data/lib/parameter_substitution/formatters/date_time_unix_timestamp.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateTimeUnixTimestamp < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "unix timestamp"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.to_i
+  end
+end

data/lib/parameter_substitution/formatters/date_time_us_all_slashes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateTimeUsAllSlashes < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "MM/DD/YYYY/hh/mm/ss"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.strftime("%m/%d/%Y/%H/%M/%S").to_s
+  end
+end

data/lib/parameter_substitution/formatters/date_time_us_normal.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateTimeUsNormal < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "MM/DD/YYYY hh:mm"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.strftime("%m/%d/%Y %H:%M").to_s
+  end
+end

data/lib/parameter_substitution/formatters/date_time_us_seconds.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateTimeUsSeconds < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "MM/DD/YYYY hh:mm:ss"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.strftime("%m/%d/%Y %H:%M:%S").to_s
+  end
+end

data/lib/parameter_substitution/formatters/date_time_us_short_am_pm.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateTimeUsShortAmPm < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "MM/DD/YYYY hh:mm PM"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.strftime('%-m/%-d/%y %l:%M %p').to_s
+  end
+end

data/lib/parameter_substitution/formatters/date_time_us_short_year.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateTimeUsShortYear < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "MM/DD/YY hh:mm"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.strftime("%m/%d/%y %H:%M").to_s
+  end
+end

data/lib/parameter_substitution/formatters/date_time_utc_year_first_dashes_seconds.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateTimeUtcYearFirstDashesSeconds < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "2017-04-11 15:55:10 (UTC)"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.utc&.strftime('%Y-%m-%d %H:%M:%S')
+  end
+end

data/lib/parameter_substitution/formatters/date_us_dashes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateUsDashes < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "MM-DD-YYYY"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.strftime("%m-%d-%Y").to_s
+  end
+end

data/lib/parameter_substitution/formatters/date_us_normal.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateUsNormal < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "MM/DD/YYYY"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.strftime("%m/%d/%Y").to_s
+  end
+end

data/lib/parameter_substitution/formatters/date_year_first_dashes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DateYearFirstDashes < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "YYYY-MM-DD"
+  end
+
+  def self.format(value)
+    parse_to_time(value)&.strftime("%Y-%m-%d").to_s
+  end
+end

data/lib/parameter_substitution/formatters/downcase.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::Downcase < ParameterSubstitution::Formatters::Base
+  def self.description
+    "Converts to string and downcases the values, preserves nil."
+  end
+
+  def self.format(value)
+    value&.to_s&.downcase
+  end
+end

data/lib/parameter_substitution/formatters/duration_as_seconds.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DurationAsSeconds < ParameterSubstitution::Formatters::Base
+  def self.description
+    "Converts a duration to an integer value of seconds"
+  end
+
+  def self.format(value)
+    parse_duration(value)
+  end
+end

data/lib/parameter_substitution/formatters/duration_as_time.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DurationAsTime < ParameterSubstitution::Formatters::Base
+  def self.description
+    "Converts a duration in seconds into hh:mm:ss"
+  end
+
+  def self.format(duration)
+    Time.at(parse_duration(duration)).utc.strftime("%H:%M:%S")
+  end
+end

data/lib/parameter_substitution/formatters/duration_grouped_by_description.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::DurationGroupedByDescription < ParameterSubstitution::Formatters::Base
+  DURATION_DESCRIPTIONS = [
+    [30.seconds, "<30sec"],
+    [60.seconds, "30-60sec"],
+    [5.minutes, "1-5min"],
+    [10.minutes, "5-10min"],
+    [20.minutes, "10-20min"],
+    [30.minutes, "20-30min"],
+    [60.minutes, "30-60min"],
+    [nil,        ">60min"]
+  ].freeze
+
+  def self.description
+    "Converts a duration in seconds into one of the following: #{DURATION_DESCRIPTIONS.map(&:last).join(',')}"
+  end
+
+  def self.format(duration)
+    fixed_duration = parse_duration(duration)
+    DURATION_DESCRIPTIONS.find { |max_duration, _description| !max_duration || fixed_duration.to_i < max_duration }.last
+  end
+end

data/lib/parameter_substitution/formatters/greater_than_value.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::GreaterThanValue < ParameterSubstitution::Formatters::Base
+  def self.description
+    "Compares numerical values and returns results based on the comparison"
+  end
+
+  def self.has_parameters?
+    true
+  end
+
+  def initialize(compare_value, true_value, false_value)
+    @compare_value = compare_value
+    @true_value = true_value
+    @false_value = false_value
+  end
+
+  def format(value)
+    self.class.parse_duration(value) > @compare_value.to_i ? @true_value : @false_value
+  end
+end

data/lib/parameter_substitution/formatters/if_nil.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::IfNil < ParameterSubstitution::Formatters::Base
+  def self.description
+    "Takes one new_value parameter. If the input is nil, the input is replaced with new_value."
+  end
+
+  def self.has_parameters?
+    true
+  end
+
+  def initialize(new_value)
+    @new_value = new_value
+  end
+
+  def format(value)
+    value.nil? ? @new_value : value
+  end
+end

data/lib/parameter_substitution/formatters/if_truthy.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::IfTruthy < ParameterSubstitution::Formatters::Base
+  TRUTHY_VALUES = [true, "true", "t", 1, "1", "on", "yes"].freeze
+
+  def self.description
+    "If the input is truthy (i.e. #{TRUTHY_VALUES.inspect}) then the input is replaced with the first argument. Otherwise, the input is replaced with the second argument."
+  end
+
+  def self.has_parameters?
+    true
+  end
+
+  def initialize(value_if_true, value_if_false)
+    @value_if_true = value_if_true
+    @value_if_false = value_if_false
+  end
+
+  def format(value)
+    if TRUTHY_VALUES.include?(downcase_if_string(value))
+      @value_if_true
+    else
+      @value_if_false
+    end
+  end
+
+  :private
+
+  def downcase_if_string(value)
+    if value.is_a?(String)
+      value.downcase
+    else
+      value
+    end
+  end
+end

data/lib/parameter_substitution/formatters/in_timezone.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class ParameterSubstitution::Formatters::InTimezone < ParameterSubstitution::Formatters::DateTimeFormat
+  def self.description
+    "Converts a date time to the specified time zone."
+  end
+
+  def self.has_parameters?
+    true
+  end
+
+  def initialize(destination_timezone)
+    @destination_timezone = destination_timezone
+  end
+
+  def format(value)
+    if (value_as_time = self.class.parse_to_time(value))
+      value_as_time.in_time_zone(@destination_timezone).strftime('%Y-%m-%d %H:%M:%S')
+    else
+      value
+    end
+  end
+end