motion_virtus 1.0.0.beta0

data/lib/project/configuration.rb

@@ -0,0 +1,65 @@
+module Virtus
+
+  # A Configuration instance
+  class Configuration
+
+    # Access the coerce setting for this instance
+    attr_accessor :coerce
+
+    # Build new configuration instance using the passed block
+    #
+    # @example
+    #   Configuration.build do |config|
+    #     config.coerce = false
+    #   end
+    #
+    # @return [Configuration]
+    #
+    # @api public
+    def self.build(&block)
+      new.call(&block)
+    end
+
+    # Initialized a configuration instance
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def initialize
+      @coerce  = true
+      @coercer = Coercible::Coercer.new
+    end
+
+    # Provide access to the attributes and methods via the passed block
+    #
+    # @example
+    #   configuration.call do |config|
+    #     config.coerce = false
+    #   end
+    #
+    # @return [self]
+    #
+    # @api private
+    def call(&block)
+      block.call(self) if block_given?
+      self
+    end
+
+    # Access the coercer for this instance and optional configure a
+    # new coercer with the passed block
+    #
+    # @example
+    #   configuration.coercer do |config|
+    #     config.string.boolean_map = { true => '1', false => '0' }
+    #   end
+    #
+    # @return [Coercer]
+    #
+    # @api private
+    def coercer(&block)
+      @coercer = Coercible::Coercer.new(&block) if block_given?
+      @coercer
+    end
+
+  end # class Configuration
+end # module Virtus

data/lib/project/const_missing_extensions.rb

@@ -0,0 +1,16 @@
+module Virtus
+  module ConstMissingExtensions
+
+    # Hooks into const missing process to determine types of attributes
+    #
+    # @param [String] name
+    #
+    # @return [Class]
+    #
+    # @api private
+    def const_missing(name)
+      Attribute.determine_type(name) or super
+    end
+
+  end
+end

data/lib/project/extensions.rb

@@ -0,0 +1,101 @@
+module Virtus
+
+  # Extensions common for both classes and instances
+  module Extensions
+    WRITER_METHOD_REGEXP   = /=\z/.freeze
+    INVALID_WRITER_METHODS = %w[ == != === []= attributes= ].to_set.freeze
+
+    # A hook called when an object is extended with Virtus
+    #
+    # @param [Object] object
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def self.extended(object)
+      super
+      object.instance_eval do
+        extend InstanceMethods
+        extend attribute_set
+      end
+    end
+    private_class_method :extended
+
+    # Defines an attribute on an object's class
+    #
+    # @example
+    #    class Book
+    #      include Virtus
+    #
+    #      attribute :title,        String
+    #      attribute :author,       String
+    #      attribute :published_at, DateTime
+    #      attribute :page_count,   Integer
+    #      attribute :index                   # defaults to Object
+    #    end
+    #
+    # @param [Symbol] name
+    #   the name of an attribute
+    #
+    # @param [Class] type
+    #   the type class of an attribute
+    #
+    # @param [#to_hash] options
+    #   the extra options hash
+    #
+    # @return [self]
+    #
+    # @see Attribute.build
+    #
+    # @api public
+    def attribute(name, type, options = {})
+      attribute = Attribute.build(name, type, merge_options(options))
+      virtus_add_attribute(attribute)
+      self
+    end
+
+    # The list of writer methods that can be mass-assigned to in #attributes=
+    #
+    # @return [Set]
+    #
+    # @api private
+    def allowed_writer_methods
+      @allowed_writer_methods ||=
+        begin
+          allowed_writer_methods  = allowed_methods.grep(WRITER_METHOD_REGEXP).to_set
+          allowed_writer_methods -= INVALID_WRITER_METHODS
+          allowed_writer_methods.freeze
+        end
+    end
+
+  private
+
+    # Return an attribute set for that instance
+    #
+    # @return [AttributeSet]
+    #
+    # @api private
+    def attribute_set
+      @attribute_set ||= AttributeSet.new
+    end
+
+    # Add an attribute to the attribute set
+    #
+    # @return [AttributeSet]
+    #
+    # @api private
+    def virtus_add_attribute(attribute)
+      attribute_set << attribute
+    end
+
+    # Merge default options
+    #
+    # @return [Hash]
+    #
+    # @api private
+    def merge_options(options)
+      { :coerce => Virtus.coerce }.merge(options)
+    end
+
+  end # module Extensions
+end # module Virtus

data/lib/project/instance_methods.rb

@@ -0,0 +1,165 @@
+module Virtus
+
+  # Instance methods that are added when you include Virtus
+  module InstanceMethods
+
+    # Set attributes during initialization of an object
+    #
+    # @param [#to_hash] attributes
+    #   the attributes hash to be set
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def initialize(attributes = nil)
+      attribute_set.set(self, attributes) if attributes
+      set_default_attributes
+    end
+
+    # Returns a value of the attribute with the given name
+    #
+    # @example
+    #   class User
+    #     include Virtus
+    #
+    #     attribute :name, String
+    #   end
+    #
+    #   user = User.new(:name => 'John')
+    #   user[:name]  # => "John"
+    #
+    # @param [Symbol] name
+    #   a name of an attribute
+    #
+    # @return [Object]
+    #   a value of an attribute
+    #
+    # @api public
+    def [](name)
+      public_send(name)
+    end
+
+    # Sets a value of the attribute with the given name
+    #
+    # @example
+    #   class User
+    #     include Virtus
+    #
+    #     attribute :name, String
+    #   end
+    #
+    #   user = User.new
+    #   user[:name] = "John"  # => "John"
+    #   user.name             # => "John"
+    #
+    # @param [Symbol] name
+    #   a name of an attribute
+    #
+    # @param [Object] value
+    #   a value to be set
+    #
+    # @return [Object]
+    #   the value set on an object
+    #
+    # @api public
+    def []=(name, value)
+      public_send("#{name}=", value)
+    end
+
+    # Returns a hash of all publicly accessible attributes
+    #
+    # @example
+    #   class User
+    #     include Virtus
+    #
+    #     attribute :name, String
+    #     attribute :age,  Integer
+    #   end
+    #
+    #   user = User.new(:name => 'John', :age => 28)
+    #   user.attributes  # => { :name => 'John', :age => 28 }
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def attributes
+      attribute_set.get(self, &:public_reader?)
+    end
+    alias_method :to_hash, :attributes
+
+    # Mass-assign attribute values
+    #
+    # Keys in the +attributes+ param can be symbols or strings.
+    # All referenced Attribute writer methods *will* be called.
+    # Non-attribute setter methods on the receiver *will* be called.
+    #
+    # @example
+    #   class User
+    #     include Virtus
+    #
+    #     attribute :name, String
+    #     attribute :age,  Integer
+    #   end
+    #
+    #   user = User.new
+    #   user.attributes = { :name => 'John', 'age' => 28 }
+    #
+    # @param [#to_hash] attributes
+    #   a hash of attribute names and values to set on the receiver
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def attributes=(attributes)
+      attribute_set.set(self, attributes)
+    end
+
+    # Freeze object
+    #
+    # @return [self]
+    #
+    # @api public
+    #
+    # @example
+    #
+    #   class User
+    #     include Virtus
+    #
+    #     attribute :name, String
+    #     attribute :age,  Integer
+    #   end
+    #
+    #   user = User.new(:name => 'John', :age => 28)
+    #   user.frozen? # => false
+    #   user.freeze
+    #   user.frozen? # => true
+    #
+    # @api public
+    def freeze
+      set_default_attributes
+      super
+    end
+
+    # Set default attributes
+    #
+    # @return [self]
+    #
+    # @api private
+    def set_default_attributes
+      attribute_set.set_defaults(self)
+      self
+    end
+
+  private
+
+    # The list of allowed public methods
+    #
+    # @return [Array<String>]
+    #
+    # @api private
+    def allowed_methods
+      public_methods.map(&:to_s)
+    end
+
+  end # module InstanceMethods
+end # module Virtus

data/lib/project/module_builder.rb

@@ -0,0 +1,92 @@
+module Virtus
+
+  # Class to build a Virtus module with it's own configuration
+  #
+  # This allows for individual Virtus modules to be included in
+  # classes and not impacted by the global Virtus configuration,
+  # which is implemented using Virtus::Configuration.
+  class ModuleBuilder
+
+    # Return module
+    #
+    # @return [Module]
+    #
+    # @api private
+    attr_reader :module
+
+    # Return configuration
+    #
+    # @return [Configuration]
+    #
+    # @api private
+    attr_reader :configuration
+
+    # Builds a new Virtus module
+    #
+    # The block is passed to Virtus::Configuration
+    #
+    # @example
+    #   ModuleBuilder.call do |config|
+    #     # config settings
+    #   end
+    #
+    # @return [Module]
+    #
+    # @api public
+    def self.call(&block)
+      config  = Configuration.build(&block)
+      builder = new(config)
+      builder.add_included_hook
+      builder.module
+    end
+
+    # Initializes a new ModuleBuilder
+    #
+    # @param [Configuration] configuration
+    #
+    # @param [Module] mod
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def initialize(configuration, mod = Module.new)
+      @configuration = configuration
+      @module        = mod.send(:include, Virtus)
+    end
+
+    # Adds the .included hook to the anonymous module which then defines the
+    # .attribute method to override the default.
+    #
+    # @return [Module]
+    #
+    # @api private
+    def add_included_hook
+      attribute_proc = attribute_method(configuration)
+
+      self.module.define_singleton_method :included do |object|
+        super(object)
+        object.send :define_singleton_method, :attribute, attribute_proc
+      end
+    end
+
+    # Wrapper for the attribute method that is used in .add_included_hook
+    # The coercer is passed in the unused key :configured_coercer to allow the
+    # property encapsulation by Virtus::Attribute::Coercer, where the
+    # coercion method is known.
+    #
+    # @return [Proc(lambda)]
+    #
+    # @api private
+    def attribute_method(configuration)
+      lambda do |name, type, options = {}|
+        module_options = {
+          :coerce => configuration.coerce,
+          :configured_coercer => configuration.coercer
+        }
+
+        super(name, type, module_options.merge(options))
+      end
+    end
+
+  end # class ModuleBuilder
+end # module Virtus

data/lib/project/module_extensions.rb

@@ -0,0 +1,72 @@
+module Virtus
+
+  # Virtus module that can define attributes for later inclusion
+  #
+  module ModuleExtensions
+    include ConstMissingExtensions
+
+    # Define an attribute in the module
+    #
+    # @see Virtus::Extensions#attribute
+    #
+    # @return [self]
+    #
+    # @api private
+    def attribute(*args)
+      attribute_definitions << args
+      self
+    end
+
+  private
+
+    # Extend an object with Virtus methods and define attributes
+    #
+    # @param [Object] object
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def extended(object)
+      super
+      object.extend(Virtus)
+      define_attributes(object)
+      object.set_default_attributes
+    end
+
+    # Extend a class with Virtus methods and define attributes
+    #
+    # @param [Object] object
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def included(object)
+      super
+      object.module_eval { include Virtus }
+      define_attributes(object)
+    end
+
+    # Return attribute definitions
+    #
+    # @return [Array<Hash>]
+    #
+    # @api private
+    def attribute_definitions
+      @_attribute_definitions ||= []
+    end
+
+    # Define attributes on a class or instance
+    #
+    # @param [Object,Class] object
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def define_attributes(object)
+      attribute_definitions.each do |attribute_args|
+        object.attribute(*attribute_args)
+      end
+    end
+
+  end # module ModuleExtensions
+end # module Virtus

data/lib/project/stubs/date.rb

@@ -0,0 +1,2 @@
+class Date
+end

data/lib/project/stubs/date_time.rb

@@ -0,0 +1,2 @@
+class DateTime
+end

data/lib/project/stubs/decimal.rb

@@ -0,0 +1,2 @@
+class BigDecimal
+end

data/lib/project/stubs/ostruct.rb

@@ -0,0 +1,149 @@
+#
+# = ostruct.rb: OpenStruct implementation
+#
+# Author:: Yukihiro Matsumoto
+# Documentation:: Gavin Sinclair
+#
+# OpenStruct allows the creation of data objects with arbitrary attributes.
+# See OpenStruct for an example.
+#
+
+#
+# OpenStruct allows you to create data objects and set arbitrary attributes.
+# For example:
+#
+#   require 'ostruct' 
+#
+#   record = OpenStruct.new
+#   record.name    = "John Smith"
+#   record.age     = 70
+#   record.pension = 300
+#   
+#   puts record.name     # -> "John Smith"
+#   puts record.address  # -> nil
+#
+# It is like a hash with a different way to access the data.  In fact, it is
+# implemented with a hash, and you can initialize it with one.
+#
+#   hash = { "country" => "Australia", :population => 20_000_000 }
+#   data = OpenStruct.new(hash)
+#
+#   p data        # -> <OpenStruct country="Australia" population=20000000>
+#
+class OpenStruct
+  #
+  # Create a new OpenStruct object.  The optional +hash+, if given, will
+  # generate attributes and values.  For example.
+  #
+  #   require 'ostruct'
+  #   hash = { "country" => "Australia", :population => 20_000_000 }
+  #   data = OpenStruct.new(hash)
+  #
+  #   p data        # -> <OpenStruct country="Australia" population=20000000>
+  #
+  # By default, the resulting OpenStruct object will have no attributes. 
+  #
+  def initialize(hash=nil)
+    @table = {}
+    if hash
+      for k,v in hash
+        @table[k.to_sym] = v
+        new_ostruct_member(k)
+      end
+    end
+  end
+
+  # Duplicate an OpenStruct object members. 
+  def initialize_copy(orig)
+    super
+    @table = @table.dup
+  end
+
+  def marshal_dump
+    @table
+  end
+  def marshal_load(x)
+    @table = x
+    @table.each_key{|key| new_ostruct_member(key)}
+  end
+
+  def modifiable
+    if self.frozen?
+      raise TypeError, "can't modify frozen #{self.class}", caller(2)
+    end
+    @table
+  end
+  protected :modifiable
+
+  def new_ostruct_member(name)
+    name = name.to_sym
+    unless self.respond_to?(name)
+      self.__singleton_class.class_eval do
+        define_method(name) { @table[name] }
+        define_method("#{name}=") { |x| modifiable[name] = x }
+      end
+    end
+    name
+  end
+
+  def method_missing(mid, *args) # :nodoc:
+    mname = mid.id2name
+    len = args.length
+    if mname.chomp!('=')
+      if len != 1
+        raise ArgumentError, "wrong number of arguments (#{len} for 1)", caller(1)
+      end
+      modifiable[new_ostruct_member(mname)] = args[0]
+    elsif len == 0
+      @table[mid]
+    else
+      raise NoMethodError, "undefined method `#{mname}' for #{self}", caller(1)
+    end
+  end
+
+  #
+  # Remove the named field from the object.
+  #
+  def delete_field(name)
+    @table.delete name.to_sym
+  end
+
+  InspectKey = :__inspect_key__ # :nodoc:
+
+  #
+  # Returns a string containing a detailed summary of the keys and values.
+  #
+  def inspect
+    str = "#<#{self.class}"
+
+    ids = (Thread.current[InspectKey] ||= [])
+    if ids.include?(object_id)
+      return str << ' ...>'
+    end
+
+    ids << object_id
+    begin
+      first = true
+      for k,v in @table
+        str << "," unless first
+        first = false
+        str << " #{k}=#{v.inspect}"
+      end
+      return str << '>'
+    ensure
+      ids.pop
+    end
+  end
+  alias :to_s :inspect
+
+  attr_reader :table # :nodoc:
+  protected :table
+
+  #
+  # Compare this object and +other+ for equality.
+  #
+  def ==(other)
+    return false unless(other.kind_of?(OpenStruct))
+    return @table == other.table
+  end
+end