acfs 1.3.2 → 1.3.3

data/lib/acfs/resource/attributes.rb

@@ -1,268 +0,0 @@
-class Acfs::Resource
-  #
-  # = Acfs Attributes
-  #
-  # Allows to specify attributes of a class with default
-  # values and type safety.
-  #
-  # @example
-  #   class User < Acfs::Resource
-  #     attribute :name, :string, default: 'Anon'
-  #     attribute :age, :integer
-  #     attribute :special, My::Special::Type
-  #   end
-  #
-  # For each attribute a setter and getter will be created and values will be
-  # type casted when set.
-  #
-  module Attributes
-    extend ActiveSupport::Concern
-    include ActiveModel::AttributeMethods
-
-    # @api public
-    #
-    # Write default attributes defined in resource class.
-    #
-    # @see #write_attributes
-    # @see ClassMethods#attributes
-    #
-    def initialize(*attrs)
-      write_attributes self.class.attributes
-      reset_changes
-      super
-    end
-
-    # @api public
-    #
-    # Returns ActiveModel compatible list of attributes and values.
-    #
-    # @example
-    #   class User < Acfs::Resource
-    #     attribute :name, type: String, default: 'Anon'
-    #   end
-    #   user = User.new(name: 'John')
-    #   user.attributes # => { "name" => "John" }
-    #
-    # @return [HashWithIndifferentAccess{Symbol => Object}]
-    #   Attributes and their values.
-    #
-    def attributes
-      @_attrs ||= HashWithIndifferentAccess.new
-    end
-
-    # @api public
-    #
-    # Update all attributes with given hash. Attribute values will be casted
-    # to defined attribute type.
-    #
-    # @example
-    #   user.attributes = { :name => 'Adam' }
-    #   user.name # => 'Adam'
-    #
-    # @param [Hash{String, Symbol => Object}, #each{|key, value|}]
-    #   Attributes to set in resource.
-    # @see #write_attributes Delegates attributes hash to {#write_attributes}.
-    #
-    def attributes=(attributes)
-      write_attributes attributes
-    end
-
-    # @api public
-    #
-    # Read an attribute from instance variable.
-    #
-    # @param [Symbol, String] name Attribute name.
-    # @return [Object] Attribute value.
-    #
-    def read_attribute(name)
-      attributes[name.to_s]
-    end
-
-    # @api public
-    #
-    # Write a hash of attributes and values.
-    #
-    # If attribute value is a `Proc` it will be evaluated in the context
-    # of the resource after all non-proc attribute values are set. Values
-    # will be casted to defined attribute type.
-    #
-    # The behavior is used to apply default attributes from resource
-    # class definition.
-    #
-    # @example
-    #   user.write_attributes name: 'john', email: ->{ "#{name}@example.org" }
-    #   user.name  # => 'john'
-    #   user.email # => 'john@example.org'
-    #
-    # @param [Hash{String, Symbol => Object, Proc}, #each{|key, value|}]
-    #   Attributes to write.
-    #
-    # @see #write_attribute Delegates attribute values to `#write_attribute`.
-    #
-    def write_attributes(attributes, opts = {})
-      unless attributes.respond_to?(:each) && attributes.respond_to?(:keys)
-        return false
-      end
-
-      if opts.fetch(:unknown, :ignore) == :raise
-        if (attributes.keys.map(&:to_s) - self.class.attributes.keys).any?
-          missing = attributes.keys - self.class.attributes.keys
-          missing.map!(&:inspect)
-          raise ArgumentError.new "Unknown attributes: #{missing.join(', ')}"
-        end
-      end
-
-      procs = {}
-
-      attributes.each do |key, _|
-        if attributes[key].is_a? Proc
-          procs[key] = attributes[key]
-        else
-          write_local_attribute key, attributes[key], opts
-        end
-      end
-
-      procs.each do |key, proc|
-        write_local_attribute key, instance_exec(&proc), opts
-      end
-
-      true
-    end
-
-    # @api private
-    #
-    # Check if a public getter for attribute exists that should be called to
-    # write it or of {#write_attribute} should be called directly. This is
-    # necessary as {#write_attribute} should go though setters but can also
-    # handle unknown attribute that will not have a generated setter method.
-    #
-    def write_local_attribute(name, value, opts = {})
-      method = "#{name}="
-      if respond_to? method, true
-        public_send method, value
-      else
-        write_attribute name, value, opts
-      end
-    end
-
-    # @api public
-    #
-    # Write single attribute with given value. Value will be casted
-    # to defined attribute type.
-    #
-    # @param [String, Symbol] name Attribute name.
-    # @param [Object] value Value to write.
-    # @raise [ArgumentError] If no attribute with given name is defined.
-    #
-    def write_attribute(name, value, opts = {})
-      attr_type = self.class.defined_attributes[name.to_s]
-      if attr_type
-        write_raw_attribute name, attr_type.cast(value), opts
-      else
-        write_raw_attribute name, value, opts
-      end
-    end
-
-    # @api private
-    #
-    # Write an attribute without checking type or existence or casting
-    # value to attributes type. Value be stored in an instance variable
-    # named after attribute name.
-    #
-    # @param [String, Symbol] name Attribute name.
-    # @param [Object] value Attribute value.
-    #
-    def write_raw_attribute(name, value, _ = {})
-      attributes[name.to_s] = value
-    end
-
-    #
-    module ClassMethods
-      ATTR_CLASS_BASE = '::Acfs::Resource::Attributes'.freeze
-
-      #
-      # @api public
-      #
-      # Define a model attribute by name and type. Will create getter and
-      # setter for given attribute name. Existing methods will be overridden.
-      #
-      # Available types can be found in `Acfs::Model::Attributes::*`.
-      #
-      # @example
-      #   class User < Acfs::Resource
-      #     attribute :name, :string, default: 'Anon'
-      #     attribute :email, :string, default: lambda{ "#{name}@example.org"}
-      #   end
-      #
-      # @param [#to_sym] name Attribute name.
-      # @param [Symbol, String, Class] type Attribute
-      #   type identifier or type class.
-      #
-      def attribute(name, type, opts = {})
-        if type.is_a?(Symbol) || type.is_a?(String)
-          type = "#{ATTR_CLASS_BASE}::#{type.to_s.classify}".constantize
-        end
-
-        define_attribute name.to_sym, type, opts
-      end
-
-      # @api public
-      #
-      # Return list of possible attributes and default
-      # values for this model class.
-      #
-      # @example
-      #   class User < Acfs::Resource
-      #     attribute :name, :string
-      #     attribute :age, :integer, default: 25
-      #   end
-      #   User.attributes # => { "name": nil, "age": 25 }
-      #
-      # @return [Hash{String => Object, Proc}]
-      #   Attributes with default values.
-      #
-      def attributes
-        defined_attributes.each_with_object({}) do |(key, attr), hash|
-          hash[key] = attr.default_value
-        end
-      end
-
-      def defined_attributes
-        if superclass.respond_to?(:defined_attributes)
-          superclass.defined_attributes.merge(local_attributes)
-        else
-          local_attributes
-        end
-      end
-
-      private
-
-      def local_attributes
-        @local_attributes ||= {}
-      end
-
-      def define_attribute(name, type, opts = {})
-        name      = name.to_s
-        attribute = type.new opts
-
-        local_attributes[name] = attribute
-        define_attribute_method name
-
-        send :define_method, name do
-          read_attribute name
-        end
-
-        send :define_method, :"#{name}=" do |value|
-          write_attribute name, value
-        end
-      end
-    end
-  end
-end
-
-# Load attribute type classes.
-#
-Dir[File.dirname(__FILE__) + '/attributes/*.rb'].sort.each do |path|
-  filename = File.basename(path)
-  require "acfs/resource/attributes/#{filename}"
-end

data/lib/acfs/resource/attributes/base.rb

@@ -1,28 +0,0 @@
-module Acfs::Resource::Attributes
-  #
-  class Base
-    attr_reader :default
-
-    def initialize(default: nil)
-      @default = default
-    end
-
-    def cast(value)
-      cast_value(value) unless value.nil?
-    end
-
-    def default_value
-      if default.respond_to? :call
-        default
-      else
-        cast default
-      end
-    end
-
-    private
-
-    def cast_value(_value)
-      raise NotImplementedError
-    end
-  end
-end

data/lib/acfs/resource/attributes/boolean.rb

@@ -1,37 +0,0 @@
-module Acfs::Resource::Attributes
-  # @api public
-  #
-  # Boolean attribute type. Use it in your model as an attribute type:
-  #
-  # @example
-  #   class User < Acfs::Resource
-  #     attribute :name, :boolean
-  #   end
-  #
-  # Given objects will be converted to string. The following strings
-  # are considered true, everything else false:
-  #
-  #  true, on, yes
-  #
-  class Boolean < Base
-    FALSE_VALUES = [false, 0, '0', 'f', 'F', 'false', 'FALSE', 'off', 'OFF', 'no', 'NO'].to_set
-
-    # @api public
-    #
-    # Cast given object to boolean.
-    #
-    # @param [Object] value Object to cast.
-    # @return [TrueClass, FalseClass] Casted boolean.
-    #
-    def cast_value(value)
-      return true if value == true
-      return false if value == false
-
-      if value.blank?
-        nil
-      else
-        !FALSE_VALUES.include?(value)
-      end
-    end
-  end
-end

data/lib/acfs/resource/attributes/date_time.rb

@@ -1,31 +0,0 @@
-module Acfs::Resource::Attributes
-  # @api public
-  #
-  # DateTime attribute type. Use it in your model as
-  # an attribute type:
-  #
-  # @example
-  #   class User < Acfs::Resource
-  #     attribute :name, :date_time
-  #   end
-  #
-  class DateTime < Base
-
-    # @api public
-    #
-    # Cast given object to DateTime.
-    #
-    # @param [Object] value Object to cast.
-    # @return [DateTime] Casted object as DateTime.
-    #
-    def cast_value(value)
-      if value.blank?
-        nil
-      elsif value.acts_like?(:time) || value.acts_like?(:date)
-        value.to_datetime
-      else
-        ::DateTime.iso8601 value
-      end
-    end
-  end
-end

data/lib/acfs/resource/attributes/dict.rb

@@ -1,37 +0,0 @@
-module Acfs::Resource::Attributes
-  # @api public
-  #
-  # Dict attribute type. Use it in your model as an attribute type:
-  #
-  # @example
-  #   class User
-  #     include Acfs::Model
-  #     attribute :opts, :dict
-  #   end
-  #
-  class Dict < Base
-    # @api public
-    #
-    # Cast given object to a dict/hash.
-    #
-    # @param [Object] value Object to cast.
-    # @return [Hash] Casted object as hash.
-    # @raise [TypeError] If object cannot be casted to a hash.
-    #
-    def cast_value(value)
-      return {} if value.blank?
-
-      if value.is_a?(Hash)
-        value
-      elsif value.respond_to?(:serializable_hash)
-        value.serializable_hash
-      elsif value.respond_to?(:to_hash)
-        value.to_hash
-      elsif value.respond_to?(:to_h)
-        value.to_h
-      else
-        Hash(value)
-      end
-    end
-  end
-end

data/lib/acfs/resource/attributes/float.rb

@@ -1,31 +0,0 @@
-module Acfs::Resource::Attributes
-  # @api public
-  #
-  # Float attribute type. Use it in your model as an attribute type:
-  #
-  # @example
-  #   class User < Acfs::Resource
-  #     attribute :name, :float
-  #   end
-  #
-  class Float < Base
-    # @api public
-    #
-    # Cast given object to float.
-    #
-    # @param [Object] value Object to cast.
-    # @return [Float] Casted object as float.
-    #
-    def cast_value(value)
-      return 0.0 if value.blank?
-
-      case value
-        when ::Float then value
-        when "Infinity" then ::Float::INFINITY
-        when "-Infinity" then -::Float::INFINITY
-        when "NaN" then ::Float::NAN
-        else Float(value)
-      end
-    end
-  end
-end

data/lib/acfs/resource/attributes/integer.rb

@@ -1,27 +0,0 @@
-module Acfs::Resource::Attributes
-  # @api public
-  #
-  # Integer attribute type. Use it in your model as an attribute type:
-  #
-  # @example
-  #   class User < Acfs::Resource
-  #     attribute :name, :integer
-  #   end
-  #
-  class Integer < Base
-    # @api public
-    #
-    # Cast given object to integer.
-    #
-    # @param [Object] value Object to cast.
-    # @return [Fixnum] Casted object as fixnum.
-    #
-    def cast_value(value)
-      if value.blank?
-        0
-      else
-        Integer(value)
-      end
-    end
-  end
-end