ardm 0.0.1

data/lib/ardm/property/csv.rb

@@ -0,0 +1,35 @@
+require 'ardm/property/string'
+require 'ardm/property/support/dirty_minder'
+
+if RUBY_VERSION >= '1.9.0'
+  require 'csv'
+else
+  require 'fastercsv'  # must be ~>1.5
+  CSV = FasterCSV unless defined?(CSV)
+end
+
+module Ardm
+  class Property
+    class Csv < String
+      load_as ::Array
+
+      def load(value)
+        case value
+        when ::String then CSV.parse(value)
+        when ::Array  then value
+        end
+      end
+
+      def dump(value)
+        case value
+          when ::Array
+            CSV.generate { |csv| value.each { |row| csv << row } }
+          when ::String then value
+        end
+      end
+
+      include ::Ardm::Property::DirtyMinder
+
+    end # class Csv
+  end # class Property
+end # module Ardm

data/lib/ardm/property/date.rb

@@ -0,0 +1,12 @@
+require 'ardm/property/object'
+
+module Ardm
+  class Property
+    class Date < Object
+      load_as         ::Date
+      dump_as         ::Date
+      coercion_method :to_date
+
+    end # class Date
+  end # class Property
+end # module Ardm

data/lib/ardm/property/datetime.rb

@@ -0,0 +1,12 @@
+require 'ardm/property/object'
+
+module Ardm
+  class Property
+    class DateTime < Object
+      load_as         ::DateTime
+      dump_as         ::DateTime
+      coercion_method :to_datetime
+
+    end # class DateTime
+  end # class Property
+end # module Ardm

data/lib/ardm/property/decimal.rb

@@ -0,0 +1,38 @@
+require 'bigdecimal'
+
+module Ardm
+  class Property
+    class Decimal < Numeric
+      load_as         BigDecimal
+      dump_as         BigDecimal
+      coercion_method :to_decimal
+
+      DEFAULT_PRECISION = 10
+      DEFAULT_SCALE     = 0
+
+      precision(DEFAULT_PRECISION)
+      scale(DEFAULT_SCALE)
+
+    protected
+
+      def initialize(model, name, options = {})
+        super
+
+        [ :scale, :precision ].each do |key|
+          unless @options.key?(key)
+            warn "options[#{key.inspect}] should be set for #{self.class}, defaulting to #{send(key).inspect} (#{caller.first})"
+          end
+        end
+
+        unless @scale >= 0
+          raise ArgumentError, "scale must be equal to or greater than 0, but was #{@scale.inspect}"
+        end
+
+        unless @precision >= @scale
+          raise ArgumentError, "precision must be equal to or greater than scale, but was #{@precision.inspect} and scale was #{@scale.inspect}"
+        end
+      end
+
+    end # class Decimal
+  end # class Property
+end # module Ardm

data/lib/ardm/property/discriminator.rb

@@ -0,0 +1,65 @@
+require 'ardm/property/class'
+
+module Ardm
+  class Property
+    class Discriminator < Class
+      load_as   ::Class
+      dump_as   ::String
+      default   lambda { |resource, property| resource.class }
+      required  true
+
+      # ActiveRecord just stores the string name of the class.
+      # We dump false for a bad value because it results in a
+      # class that isn't in the "dump_as".
+      #
+      # Expects the class name to be a valid class name that is
+      # loaded and available.
+      def dump(value)
+        dumped = typecast(value)
+        dumped.name if dumped.is_a?(::Class)
+      end
+
+      def load(value)
+        typecast(value)
+      end
+
+      # @api private
+      def bind
+        model.inheritance_column = field
+        model.extend Model unless model < Model
+      end
+
+      module Model
+        def inherited(model)
+          super  # setup self.descendants
+          #set_discriminator_scope_for(model)
+        end
+
+        def new(*args, &block)
+          if args.size == 1 && args.first.kind_of?(Hash)
+            discriminator = properties.discriminator
+
+            if discriminator_value = args.first[discriminator.name]
+              model = discriminator.typecast(discriminator_value)
+
+              if model.kind_of?(Model) && !model.equal?(self)
+                return model.new(*args, &block)
+              end
+            end
+          end
+
+          super
+        end
+
+      private
+
+        def set_discriminator_scope_for(model)
+          discriminator = self.properties.discriminator
+          model.scoped.with_default_scope.update_all(discriminator.field => model.descendants.dup << model)
+        rescue ::ActiveRecord::ConnectionNotEstablished => e
+          puts "Error was raised but it seems to be an ActiveRecord 3.2 error, fixed in 4:\n#{e}"
+        end
+      end
+    end # class Discriminator
+  end # class Property
+end # module Ardm

data/lib/ardm/property/enum.rb

@@ -0,0 +1,51 @@
+require 'ardm/property/object'
+require 'ardm/property/support/flags'
+
+module Ardm
+  class Property
+    class Enum < Object
+      include Flags
+
+      load_as ::Object
+      dump_as ::Integer
+
+      def initialize(model, name, options = {})
+        @flag_map = {}
+
+        flags = options.fetch(:flags, self.class.flags)
+        flags.each_with_index do |flag, i|
+          @flag_map[i + 1] = flag
+        end
+
+        if self.class.accepted_options.include?(:set) && !options.include?(:set)
+          options[:set] = @flag_map.values_at(*@flag_map.keys.sort)
+        end
+
+        super
+      end
+
+      def load(value)
+        flag_map[value.to_i]
+      end
+
+      def dump(value)
+        case value
+        when ::Array then value.collect { |v| dump(v) }
+        else              flag_map.invert[typecast(value)]
+        end
+      end
+
+      def typecast(value)
+        return if value.nil?
+        # Attempt to typecast using the class of the first item in the map.
+        case flag_map[1]
+        when ::Symbol then value.to_sym
+        when ::String then value.to_s
+        when ::Fixnum then value.to_i
+        else               value
+        end
+      end
+
+    end # class Enum
+  end # class Property
+end # module Ardm

data/lib/ardm/property/epoch_time.rb

@@ -0,0 +1,38 @@
+require 'ardm/property/time'
+
+module Ardm
+  class Property
+    class EpochTime < Time
+      dump_as ::Integer
+
+      def load(value)
+        if value.kind_of?(::Numeric)
+          ::Time.at(value.to_i)
+        else
+          value
+        end
+      end
+
+      def dump(value)
+        value.to_i if value
+      end
+
+      def typecast(value)
+        case value
+          when ::Time               then value
+          when ::Numeric, /\A\d+\z/ then ::Time.at(value.to_i)
+          when ::DateTime           then datetime_to_time(value)
+          when ::String             then ::Time.parse(value)
+        end
+      end
+
+    private
+
+      def datetime_to_time(datetime)
+        utc = datetime.new_offset(0)
+        ::Time.utc(utc.year, utc.month, utc.day, utc.hour, utc.min, utc.sec)
+      end
+
+    end # class EpochTime
+  end # class Property
+end # module Ardm

data/lib/ardm/property/file_path.rb

@@ -0,0 +1,25 @@
+require 'pathname'
+require 'ardm/property/string'
+
+module Ardm
+  class Property
+    class FilePath < String
+      load_as Pathname
+
+      length 255
+
+      def load(value)
+        Pathname.new(value) unless Ardm::Ext.blank?(value)
+      end
+
+      def dump(value)
+        value.to_s unless Ardm::Ext.blank?(value)
+      end
+
+      def typecast(value)
+        load(value)
+      end
+
+    end # class FilePath
+  end # class Property
+end # module Ardm

data/lib/ardm/property/flag.rb

@@ -0,0 +1,65 @@
+require 'ardm/property/object'
+require 'ardm/property/support/flags'
+
+module Ardm
+  class Property
+    class Flag < Object
+      include Flags
+
+      load_as ::Object
+      dump_as ::Integer
+
+      def initialize(model, name, options = {})
+        super
+
+        @flag_map = {}
+
+        flags = options.fetch(:flags, self.class.flags)
+        flags.each_with_index do |flag, i|
+          flag_map[i] = flag
+        end
+      end
+
+      def load(value)
+        return [] if value.nil? || value <= 0
+
+        begin
+          matches = []
+
+          0.upto(flag_map.size - 1) do |i|
+            matches << flag_map[i] if value[i] == 1
+          end
+
+          matches.compact
+        rescue TypeError, Errno::EDOM
+          []
+        end
+      end
+
+      def dump(value)
+        unless value.nil?
+          flags = Array(value).map { |flag| flag.to_sym }
+          flags.uniq!
+
+          flag = 0
+
+          flag_map.invert.values_at(*flags).each do |i|
+            next if i.nil?
+            flag += (1 << i)
+          end
+
+          flag
+        end
+      end
+
+      def typecast(value)
+        case value
+          when nil     then nil
+          when ::Array then value.map { |v| v.to_sym }
+          else [value.to_sym]
+        end
+      end
+
+    end # class Flag
+  end # class Property
+end # module Ardm

data/lib/ardm/property/float.rb

@@ -0,0 +1,18 @@
+require 'ardm/property/numeric'
+
+module Ardm
+  class Property
+    class Float < Numeric
+      load_as         ::Float
+      dump_as         ::Float
+      coercion_method :to_float
+
+      DEFAULT_PRECISION = 10
+      DEFAULT_SCALE     = nil
+
+      precision(DEFAULT_PRECISION)
+      scale(DEFAULT_SCALE)
+
+    end # class Float
+  end # class Property
+end # module Ardm

data/lib/ardm/property/integer.rb

@@ -0,0 +1,24 @@
+require 'ardm/property/numeric'
+
+module Ardm
+  class Property
+    class Integer < Numeric
+      load_as         ::Integer
+      dump_as         ::Integer
+      coercion_method :to_integer
+
+      accept_options :serial
+
+    protected
+
+      # @api semipublic
+      def initialize(model, name, options = {})
+        if options.key?(:serial) && !kind_of?(Serial)
+          raise "Integer #{name} with explicit :serial option is deprecated, use Serial instead (#{caller[2]})"
+        end
+        super
+      end
+
+    end # class Integer
+  end # class Property
+end # module Ardm

data/lib/ardm/property/invalid_value_error.rb

@@ -0,0 +1,22 @@
+module Ardm
+  class Property
+    # Exception raised when Ardm is about to work with
+    # invalid property values.
+    class InvalidValueError < StandardError
+      attr_reader :property, :value
+
+      def initialize(property, value)
+        msg = "Invalid value %s for property %s (%s) on model %s" %
+          [ value.inspect,
+            property.name.inspect,
+            property.class.name,
+            property.model.name
+          ]
+        super(msg)
+        @property = property
+        @value = value
+      end
+
+    end # class InvalidValueError
+  end # class Property
+end # module Ardm

data/lib/ardm/property/ip_address.rb

@@ -0,0 +1,35 @@
+require 'ipaddr'
+require 'ardm/property/string'
+
+module Ardm
+  class Property
+    class IPAddress < String
+      load_as IPAddr
+
+      length 39
+
+      def load(value)
+        if value.nil? || value_loaded?(value)
+          value
+        elsif value.is_a?(::String)
+          unless value.empty?
+            IPAddr.new(value)
+          else
+            IPAddr.new("0.0.0.0")
+          end
+        else
+          raise ArgumentError.new("+value+ must be nil or a String")
+        end
+      end
+
+      def dump(value)
+        value.to_s unless value.nil?
+      end
+
+      def typecast(value)
+        load(value) unless value.nil?
+      end
+
+    end # class IPAddress
+  end # class Property
+end # module Ardm

data/lib/ardm/property/json.rb

@@ -0,0 +1,49 @@
+require 'ardm/property/text'
+require 'ardm/property/support/dirty_minder'
+require 'multi_json'
+
+module Ardm
+  class Property
+    class Json < Text
+      load_as ::Object
+
+      def load(value)
+        if value.nil? || value_loaded?(value)
+          value
+        elsif value.is_a?(::String)
+          typecast(value)
+        else
+          raise ArgumentError.new("+value+ of a property of JSON type must be nil or a String")
+        end
+      end
+
+      def dump(value)
+        if value.nil? || value.is_a?(::String)
+          value
+        else
+          MultiJson.dump(value)
+        end
+      end
+
+      def typecast(value)
+        return if value.nil?
+
+        if value_loaded?(value)
+          value
+        else
+          MultiJson.load(value.to_s)
+        end
+      end
+
+      def value_loaded?(value)
+        value.kind_of?(::Array) || value.kind_of?(::Hash)
+      end
+
+      include ::Ardm::Property::DirtyMinder
+
+    end # class Json
+
+    JSON = Json
+
+  end # class Property
+end # module Ardm

data/lib/ardm/property/lookup.rb

@@ -0,0 +1,29 @@
+require 'ardm/property'
+
+module Ardm
+  class Property
+    module Lookup
+
+      # Provides transparent access to the Properties defined in
+      # {Property}.
+      #
+      # @param [Symbol] name
+      #   The name of the property to lookup.
+      #
+      # @return [Property]
+      #   The property with the given name.
+      #
+      # @raise [NameError]
+      #   The property could not be found.
+      #
+      # @api private
+      #
+      # @since 1.0.1
+      #
+      def const_missing(name)
+        Property.find_class(name.to_s) || super
+      end
+
+    end # module Lookup
+  end # class Property
+end # module Ardm

data/lib/ardm/property/numeric.rb

@@ -0,0 +1,40 @@
+require 'ardm/property/object'
+
+module Ardm
+  class Property
+    class Numeric < Object
+      accept_options :precision, :scale, :min, :max
+
+      attr_reader :precision, :scale, :min, :max
+
+      DEFAULT_NUMERIC_MIN = 0
+      DEFAULT_NUMERIC_MAX = 2**31-1
+
+    protected
+
+      def initialize(model, name, options = {})
+        super
+
+        if kind_of?(Decimal) || kind_of?(Float)
+          @precision = @options.fetch(:precision)
+          @scale     = @options.fetch(:scale)
+
+          unless @precision > 0
+            raise ArgumentError, "precision must be greater than 0, but was #{@precision.inspect}"
+          end
+        end
+
+        if @options.key?(:min) || @options.key?(:max)
+          @min = @options.fetch(:min, self.class::DEFAULT_NUMERIC_MIN)
+          @max = @options.fetch(:max, self.class::DEFAULT_NUMERIC_MAX)
+
+          if @max < DEFAULT_NUMERIC_MIN && !@options.key?(:min)
+            raise ArgumentError, "min should be specified when the max is less than #{DEFAULT_NUMERIC_MIN}"
+          elsif @max < @min
+            raise ArgumentError, "max must be less than the min, but was #{@max} while the min was #{@min}"
+          end
+        end
+      end
+    end # class Numeric
+  end # class Property
+end # module Ardm

data/lib/ardm/property/object.rb

@@ -0,0 +1,36 @@
+require 'ardm/property'
+
+module Ardm
+  class Property
+    class Object < Property
+      load_as         ::Object
+      dump_as         ::Object
+      coercion_method :to_object
+
+      # @api semipublic
+      def dump(value)
+        instance_of?(Object) ? marshal(value) : value
+      end
+
+      # @api semipublic
+      def load(value)
+        typecast(instance_of?(Object) ? unmarshal(value) : value)
+      end
+
+      # @api semipublic
+      def marshal(value)
+        [ Marshal.dump(value) ].pack('m') unless value.nil?
+      end
+
+      # @api semipublic
+      def unmarshal(value)
+        Marshal.load(value.unpack('m').first) unless value.nil?
+      end
+
+      # @api private
+      def to_child_key
+        self.class
+      end
+    end
+  end
+end

data/lib/ardm/property/paranoid_boolean.rb

@@ -0,0 +1,18 @@
+require 'ardm/property/boolean'
+require 'ardm/property/support/paranoid_base'
+
+module Ardm
+  class Property
+    class ParanoidBoolean < Boolean
+      default false
+      lazy    true
+
+      # @api private
+      def bind
+        model.send(:include, Ardm::Property::ParanoidBase)
+        model.set_paranoid_property(name) { true }
+        model.set_paranoid_scope(model.arel_table[name].eq(false))
+      end
+    end # class ParanoidBoolean
+  end # class Property
+end # module Ardm

data/lib/ardm/property/paranoid_datetime.rb

@@ -0,0 +1,17 @@
+require 'ardm/property/datetime'
+require 'ardm/property/support/paranoid_base'
+
+module Ardm
+  class Property
+    class ParanoidDateTime < DateTime
+      lazy true
+
+      # @api private
+      def bind
+        model.send(:include, Ardm::Property::ParanoidBase)
+        model.set_paranoid_property(name) { ::DateTime.now }
+        model.set_paranoid_scope(model.arel_table[name].eq(nil))
+      end
+    end # class ParanoidDateTime
+  end # class Property
+end # module Ardm

data/lib/ardm/property/regexp.rb

@@ -0,0 +1,22 @@
+require 'ardm/property/string'
+
+module Ardm
+  class Property
+    class Regexp < String
+      load_as ::Regexp
+
+      def load(value)
+        ::Regexp.new(value) unless value.nil?
+      end
+
+      def dump(value)
+        value.source unless value.nil?
+      end
+
+      def typecast(value)
+        load(value)
+      end
+
+    end
+  end
+end

data/lib/ardm/property/serial.rb

@@ -0,0 +1,16 @@
+require 'ardm/property/integer'
+
+module Ardm
+  class Property
+    class Serial < Integer
+      serial true
+      min    1
+
+      # @api private
+      def to_child_key
+        Property::Integer
+      end
+
+    end # class Text
+  end # class Property
+end # module Ardm