stockboy 0.5.0

data/lib/stockboy/translations/date.rb

@@ -0,0 +1,41 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Convert ISO-8601 and other recognized date-like strings to +Date+
+  #
+  # == Job template DSL
+  #
+  # Registered as +:date+. Use with:
+  #
+  #   attributes do
+  #     check_in as: :date
+  #   end
+  #
+  # @example
+  #   date = Stockboy::Translator::Date.new
+  #
+  #   record.check_in = "2012-01-01"
+  #   date.translate(record, :check_in) # => #<Date 2012-01-01>
+  #
+  #   record.check_in = "Jan 1, 2012"
+  #   date.translate(record, :check_in) # => #<Date 2012-01-01>
+  #
+  class Date < Stockboy::Translator
+
+    # @return [Date]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+      return nil if value.blank?
+
+      case value
+      when ::String then ::Date.parse(value)
+      when ::Time, ::DateTime then ::Date.new(value.year, value.month, value.day)
+      when ::Date then value
+      else nil
+      end
+    end
+
+  end
+end

data/lib/stockboy/translations/decimal.rb

@@ -0,0 +1,33 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Convert numeric strings to +BigDecimal+
+  #
+  # == Job template DSL
+  #
+  # Registered as +:decimal+. Use with:
+  #
+  #   attributes do
+  #     check_in as: :decimal
+  #   end
+  #
+  # @example
+  #   dec = Stockboy::Translator::Date.new
+  #
+  #   record.cost = "256.99"
+  #   dec.translate(record, :cost) # => #<BigDecimal 256.99>
+  #
+  class Decimal < Stockboy::Translator
+
+    # @return [BigDecimal]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+      return nil if value.blank?
+
+      BigDecimal.new(value, 10)
+    end
+
+  end
+end

data/lib/stockboy/translations/default_empty_string.rb

@@ -0,0 +1,38 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Translate missing values to empty string
+  #
+  # This is a useful fallback for translation errors.
+  #
+  # == Job template DSL
+  #
+  # Registered as +:or_empty+. Use with:
+  #
+  #   attributes do
+  #     product_code as: [->(r){raise "Invalid"}, :or_empty]
+  #   end
+  #
+  # @example
+  #   str = Stockboy::Translator::DefaultEmptyString.new
+  #
+  #   record.product_code = "ITEM"
+  #   str.translate(record, :product_code) # => "ITEM"
+  #
+  #   record.product_code = nil
+  #   str.translate(record, :product_code) # => ""
+  #
+  class DefaultEmptyString < Stockboy::Translator
+
+    # @return [String]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+      return "" if (value).blank?
+
+      return value
+    end
+
+  end
+end

data/lib/stockboy/translations/default_false.rb

@@ -0,0 +1,41 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Translate missing values to boolean false
+  #
+  # This is a useful fallback for translation errors from boolean fields.
+  #
+  # == Job template DSL
+  #
+  # Registered as +:or_false+. Use with:
+  #
+  #   attributes do
+  #     active as: [:boolean, :or_false]
+  #   end
+  #
+  # @example
+  #   bool = Stockboy::Translator::Boolean.new
+  #
+  #   record.active = nil
+  #   bool.translate(record, :active) # => false
+  #
+  #   record.active = false
+  #   bool.translate(record, :active) # => false
+  #
+  #   record.active = true
+  #   bool.translate(record, :active) # => true
+  #
+  class DefaultFalse < Stockboy::Translator
+
+    # @return [Boolean]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+
+      return false if value.nil?
+      return value
+    end
+
+  end
+end

data/lib/stockboy/translations/default_nil.rb

@@ -0,0 +1,38 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Translate missing values to nil
+  #
+  # This is a useful fallback for empty values that should be cleared to nil.
+  #
+  # == Job template DSL
+  #
+  # Registered as +:or_nil+. Use with:
+  #
+  #   attributes do
+  #     product_code as: [->(r){raise "Invalid"}, :or_nil]
+  #   end
+  #
+  # @example
+  #   str = Stockboy::Translator::DefaultNil.new
+  #
+  #   record.product_code = "ITEM"
+  #   str.translate(record, :product_code) # => "ITEM"
+  #
+  #   record.product_code = ""
+  #   str.translate(record, :product_code) # => nil
+  #
+  class DefaultNil < Stockboy::Translator
+
+    # @return [Object, NilClass]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+      return nil if (value).blank?
+
+      return value
+    end
+
+  end
+end

data/lib/stockboy/translations/default_true.rb

@@ -0,0 +1,41 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Translate missing values to boolean true
+  #
+  # This is a useful fallback for translation errors from boolean fields.
+  #
+  # == Job template DSL
+  #
+  # Registered as +:or_true+. Use with:
+  #
+  #   attributes do
+  #     active as: [:boolean, :or_true]
+  #   end
+  #
+  # @example
+  #   bool = Stockboy::Translator::Boolean.new
+  #
+  #   record.active = nil
+  #   bool.translate(record, :active) # => true
+  #
+  #   record.active = false
+  #   bool.translate(record, :active) # => false
+  #
+  #   record.active = true
+  #   bool.translate(record, :active) # => true
+  #
+  class DefaultTrue < Stockboy::Translator
+
+    # @return [Boolean]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+
+      return true if value.nil?
+      return value
+    end
+
+  end
+end

data/lib/stockboy/translations/default_zero.rb

@@ -0,0 +1,41 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Translate missing values to numeric zero
+  #
+  # This is a useful fallback for translation errors.
+  #
+  # == Job template DSL
+  #
+  # Registered as +:or_zero+. Use with:
+  #
+  #   attributes do
+  #     cost as: [->(r){raise "Invalid"}, :or_zero]
+  #   end
+  #
+  # @example
+  #   zero = Stockboy::Translator::DefaultZero.new
+  #
+  #   record.cost = 256
+  #   zero.translate(record, :cost) # => 256
+  #
+  #   record.cost = nil
+  #   zero.translate(record, :cost) # => 0
+  #
+  #   record.cost = ""
+  #   zero.translate(record, :cost) # => 0
+  #
+  class DefaultZero < Stockboy::Translator
+
+    # @return [Fixnum]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+      return 0 if value.blank?
+
+      return value
+    end
+
+  end
+end

data/lib/stockboy/translations/integer.rb

@@ -0,0 +1,33 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Translate string values to +Fixnum+
+  #
+  # == Job template DSL
+  #
+  # Registered as +:integer+. Use with:
+  #
+  #   attributes do
+  #     children as: :integer
+  #   end
+  #
+  # @example
+  #   num = Stockboy::Translator::Integer.new
+  #
+  #   record.children = "2"
+  #   num.translate(record, :children) # => 2
+  #
+  class Integer < Stockboy::Translator
+
+    # @return [Fixnum]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+      return nil if value.blank?
+
+      value.to_i
+    end
+
+  end
+end

data/lib/stockboy/translations/string.rb

@@ -0,0 +1,33 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Cleans string values by stripping surrounding whitespace
+  #
+  # == Job template DSL
+  #
+  # Registered as +:string+. Use with:
+  #
+  #   attributes do
+  #     name as: :string
+  #   end
+  #
+  # @example
+  #   str = Stockboy::Translator::String.new
+  #
+  #   record.name = "Arthur  "
+  #   str.translate(record, :name) # => "Arthur"
+  #
+  class String < Stockboy::Translator
+
+    # @return [String]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+      return "" if value.blank?
+
+      value.strip
+    end
+
+  end
+end

data/lib/stockboy/translations/time.rb

@@ -0,0 +1,41 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Convert ISO-8601 and other recognized time-like strings to +Time+
+  #
+  # Uses +ActiveSupport::TimeWithZone+ if available.
+  #
+  # == Job template DSL
+  #
+  # Registered as +:time+. Use with:
+  #
+  #   attributes do
+  #     arriving as: :time
+  #   end
+  #
+  # @example
+  #   time = Stockboy::Translator::Time.new
+  #
+  #   record.arriving = "2012-01-01 12:34:56 UTC"
+  #   time.translate(record, :arriving) # => #<Time 2012-01-01 12:34:56>
+  #
+  class Time < Stockboy::Translator
+
+    # @return [Time]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+      return nil if (value).blank?
+
+      clock.parse(value).to_time
+    end
+
+    private
+
+    def clock
+      ::Time.respond_to?(:zone) && ::Time.zone || ::DateTime
+    end
+
+  end
+end

data/lib/stockboy/translations/uk_date.rb

@@ -0,0 +1,51 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Translates numeric dates provided in UK (DMY) order
+  #
+  # Priority is given to small-endian (UK) order:
+  #
+  # * DD-MM-YYYY
+  # * DD-MM-YY
+  # * DD/MM/YYYY
+  # * DD/MM/YY
+  #
+  # == Job template DSL
+  #
+  # Registered as +:uk_date+. Use with:
+  #
+  #   attributes do
+  #     check_in as: :uk_date
+  #   end
+  #
+  # @example
+  #   date = Stockboy::Translator::UKDate.new
+  #
+  #   record.check_in = "1/2/12"
+  #   date.translate(record, :check_in) # => #<Date 2012-02-01>
+  #
+  class UKDate < Stockboy::Translator
+
+    # @return [Date]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+      return nil if value.blank?
+
+      ::Date.strptime(value, date_format(value))
+    end
+
+    private
+
+    def date_format(value)
+      x = value.include?(?/) ? ?/ : ?-
+      if value =~ %r"\d{1,2}(?:/|-)\d{1,2}(?:/|-)\d{2}$"
+        "%d#{x}%m#{x}%y"
+      else
+        "%d#{x}%m#{x}%Y"
+      end
+    end
+
+  end
+end

data/lib/stockboy/translations/us_date.rb

@@ -0,0 +1,51 @@
+require 'stockboy/translator'
+
+module Stockboy::Translations
+
+  # Translates numeric dates provided in US (MDY) order
+  #
+  # Priority is given to middle-endian (US) order:
+  #
+  # * MM-DD-YYYY
+  # * MM-DD-YY
+  # * MM/DD/YYYY
+  # * MM/DD/YY
+  #
+  # == Job template DSL
+  #
+  # Registered as +:us_date+. Use with:
+  #
+  #   attributes do
+  #     check_in as: :us_date
+  #   end
+  #
+  # @example
+  #   date = Stockboy::Translator::USDate.new
+  #
+  #   record.check_in = "2-1-12"
+  #   date.translate(record, :check_in) # => #<Date 2012-02-01>
+  #
+  class USDate < Stockboy::Translator
+
+    # @return [Date]
+    #
+    def translate(context)
+      value = field_value(context, field_key)
+      return nil if value.blank?
+
+      ::Date.strptime(value, date_format(value))
+    end
+
+    private
+
+    def date_format(value)
+      x = value.include?(?/) ? ?/ : ?-
+      if value =~ %r"\d{1,2}(?:/|-)\d{1,2}(?:/|-)\d{4}"
+        "%m#{x}%d#{x}%Y"
+      else
+        "%m#{x}%d#{x}%y"
+      end
+    end
+
+  end
+end