axiom-types 0.0.1

data/config/roodi.yml

@@ -0,0 +1,16 @@
+---
+AbcMetricMethodCheck:            { score: 6.0 }
+AssignmentInConditionalCheck:    { }
+CaseMissingElseCheck:            { }
+ClassLineCountCheck:             { line_count: 129 }
+ClassNameCheck:                  { pattern: !ruby/regexp '/\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/' }
+ClassVariableCheck:              { }
+CyclomaticComplexityBlockCheck:  { complexity: 3 }
+CyclomaticComplexityMethodCheck: { complexity: 3 }
+EmptyRescueBodyCheck:            { }
+ForLoopCheck:                    { }
+MethodLineCountCheck:            { line_count: 5 }
+MethodNameCheck:                 { pattern: !ruby/regexp '/\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|<<|[+*&|-])\z/' }
+ModuleLineCountCheck:            { line_count: 111 }
+ModuleNameCheck:                 { pattern: !ruby/regexp '/\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/' }
+ParameterNumberCheck:            { parameter_count: 2 }

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/lib/axiom-types.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'axiom/types'

data/lib/axiom/types.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+require 'bigdecimal'
+require 'date'
+require 'set'
+
+require 'backports'
+require 'ice_nine'
+require 'descendants_tracker'
+
+module Axiom
+  module Types
+
+    # Represent an undefined argument
+    Undefined = Object.new.freeze
+
+    # A true proposition
+    Tautology = proc { true }.freeze
+
+    # A false proposition
+    Contradiction = proc { false }.freeze
+
+    # Finalize Axiom::Types::Type subclasses
+    #
+    # @example
+    #   Axiom::Types.finalize  # => Axiom::Types
+    #
+    # @return [Axiom::Types]
+    #
+    # @api public
+    def self.finalize
+      Type.descendants.each(&:finalize)
+      self
+    end
+
+  end # module Types
+end # module Axiom
+
+require 'axiom/types/support/options'
+
+require 'axiom/types/value_comparable'
+require 'axiom/types/length_comparable'
+require 'axiom/types/encodable'
+
+require 'axiom/types/type'
+
+require 'axiom/types/object'
+
+require 'axiom/types/numeric'
+
+require 'axiom/types/array'
+require 'axiom/types/boolean'
+require 'axiom/types/class'
+require 'axiom/types/date'
+require 'axiom/types/date_time'
+require 'axiom/types/decimal'
+require 'axiom/types/float'
+require 'axiom/types/hash'
+require 'axiom/types/integer'
+require 'axiom/types/set'
+require 'axiom/types/string'
+require 'axiom/types/symbol'
+require 'axiom/types/time'
+
+require 'axiom/types/version'

data/lib/axiom/types/array.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Represents an array type
+    class Array < Object
+      primitive       ::Array
+      coercion_method :to_array
+
+    end # class Array
+  end # module Types
+end # module Axiom

data/lib/axiom/types/boolean.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Represents a boolean type
+    class Boolean < Object
+      coercion_method :to_boolean
+
+      includes true, false
+
+    end # class Boolean
+  end # module Types
+end # module Axiom

data/lib/axiom/types/class.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Represents a Class type
+    class Class < Object
+      primitive       ::Class
+      coercion_method :to_class
+
+    end # class Class
+  end # module Types
+end # module Axiom

data/lib/axiom/types/date.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Represents a date type
+    class Date < Object
+      extend ValueComparable
+
+      primitive       ::Date
+      coercion_method :to_date
+
+      minimum primitive.new(1, 1, 1)
+      maximum primitive.new(9999, 12, 31)
+
+    end # class Date
+  end # module Types
+end # module Axiom

data/lib/axiom/types/date_time.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Represents a date time type
+    class DateTime < Object
+      extend ValueComparable
+
+      # The maximum seconds for DateTime
+      MAXIMUM_SECONDS = 60 - Rational(1, 10**12)
+
+      primitive       ::DateTime
+      coercion_method :to_datetime
+
+      minimum primitive.new(1, 1, 1)
+      maximum primitive.new(9999, 12, 31, 23, 59, MAXIMUM_SECONDS)
+
+    end # class DateTime
+  end # module Types
+end # module Axiom

data/lib/axiom/types/decimal.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Represents a decimal type
+    class Decimal < Numeric
+      primitive       ::BigDecimal
+      coercion_method :to_decimal
+
+    end # class Decimal
+  end # module Types
+end # module Axiom

data/lib/axiom/types/encodable.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Add encoding constraints to a type
+    module Encodable
+      # stub module for ruby 1.8
+    end
+
+    module Encodable
+
+      # Hook called when module is extended
+      #
+      # Add #encoding DSL method to descendant and set the default to UTF-8.
+      #
+      # @param [Class<Axiom::Types::Type>] descendant
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def self.extended(descendant)
+        super
+        descendant.accept_options :encoding
+        descendant.encoding Encoding::UTF_8
+      end
+
+      private_class_method :extended
+
+      # Finalize by setting up a primitive constraint
+      #
+      # @return [Axiom::Types::Encodable]
+      #
+      # @api private
+      def finalize
+        return self if frozen?
+        ascii_compatible? ? has_ascii_compatible_encoding : has_encoding
+        super
+      end
+
+    private
+
+      # Test if the encoding is ascii compatible
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def ascii_compatible?
+        encoding.ascii_compatible?
+      end
+
+      # Add constraint for the ascii compatible encoding
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def has_ascii_compatible_encoding
+        constraint do |object|
+          object.encoding.equal?(encoding) || object.to_s.ascii_only?
+        end
+      end
+
+      # Add constraint for the encoding
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def has_encoding
+        constraint { |object| object.encoding.equal?(encoding) }
+      end
+
+    end if RUBY_VERSION >= '1.9'
+
+  end # module Types
+end # module Axiom

data/lib/axiom/types/float.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Represents a decimal type
+    class Float < Numeric
+      primitive       ::Float
+      coercion_method :to_float
+
+    end # class Float
+  end # module Types
+end # module Axiom

data/lib/axiom/types/hash.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Represents a hash type
+    class Hash < Object
+      primitive       ::Hash
+      coercion_method :to_hash
+      accept_options  :key_type, :value_type
+
+      key_type   Object
+      value_type Object
+
+      # Finalize by setting up constraints for the key and value
+      #
+      # @return [Axiom::Types::Object]
+      #
+      # @api private
+      def self.finalize
+        return self if frozen?
+        key_type.finalize
+        value_type.finalize
+        matches_key_and_value_types
+        super
+      end
+
+      # Add a constraints for the key and value
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def self.matches_key_and_value_types
+        constraint do |object|
+          object.all? do |key, value|
+            key_type.include?(key) && value_type.include?(value)
+          end
+        end
+      end
+
+      private_class_method :matches_key_and_value_types
+
+    end # class Hash
+  end # module Types
+end # module Axiom

data/lib/axiom/types/integer.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Represents a decimal type
+    class Integer < Numeric
+      primitive       ::Integer
+      coercion_method :to_integer
+
+    end # class Integer
+  end # module Types
+end # module Axiom

data/lib/axiom/types/length_comparable.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Add a minimum and maximum length constraint to a type
+    module LengthComparable
+
+      # Hook called when module is extended
+      #
+      # Add #minimum_length and #maximum_length DSL methods to descendant.
+      #
+      # @param [Class<Axiom::Types::Type>] descendant
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def self.extended(descendant)
+        super
+        descendant.accept_options :minimum_length, :maximum_length
+      end
+
+      # Finalize by setting up a length range constraint
+      #
+      # @return [Axiom::Types::LengthComparable]
+      #
+      # @api private
+      def finalize
+        return self if frozen?
+        has_length_within_range
+        super
+      end
+
+    private
+
+      # Add a constraint for a length within a range
+      #
+      # @return [undefined]
+      #
+      # @todo freeze the minimum_length and maximum_length
+      #
+      # @api private
+      def has_length_within_range
+        constraint do |object|
+          object.length.between?(minimum_length, maximum_length)
+        end
+      end
+
+    end # module LengthComparable
+  end # module Types
+end # module Axiom

data/lib/axiom/types/numeric.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Represents a numeric type
+    class Numeric < Object
+      primitive       ::Numeric
+      coercion_method :to_numeric
+
+    end # class Numeric
+  end # module Types
+end # module Axiom

data/lib/axiom/types/object.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Axiom
+  module Types
+
+    # Represents an object type
+    class Object < Type
+      accept_options  :primitive, :coercion_method
+      primitive       ::Object.superclass || ::Object
+      coercion_method :to_object
+
+      # Finalize by setting up a primitive constraint
+      #
+      # @return [Axiom::Types::Object]
+      #
+      # @api private
+      def self.finalize
+        return self if frozen?
+        inherits_from_primitive
+        super
+      end
+
+      # Add a constraint for the primitive
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def self.inherits_from_primitive
+        constraint(&primitive.method(:===))
+      end
+
+      private_class_method :inherits_from_primitive
+
+    end # class Object
+  end # module Types
+end # module Axiom