acfs 1.3.3 → 1.6.0

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+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.is_a?(::String) && value.respond_to?(:to_datetime)
+        value.to_datetime
+      else
+        ::DateTime.iso8601 value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+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

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Acfs::Resource::Attributes
+  # @api public
+  #
+  # List attribute type. Use it in your model as an attribute type:
+  #
+  # @example
+  #   class User < Acfs::Resource
+  #     attribute :name, :list
+  #   end
+  #
+  class List < Base
+    # @api public
+    #
+    # Cast given object to a list.
+    #
+    # @param [Object] value Object to cast.
+    # @return [Fixnum] Casted object as list.
+    # @raise [TypeError] If object cannot be casted to a list.
+    #
+    def cast_value(value)
+      return [] if value.blank?
+
+      if value.is_a?(::Array)
+        value
+      elsif value.respond_to?(:to_ary)
+        value.to_ary
+      elsif value.respond_to?(:to_a)
+        value.to_a
+      else
+        Array(value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Acfs::Resource::Attributes
+  # @api public
+  #
+  # String attribute type. Use it in your model as
+  # an attribute type:
+  #
+  # @example
+  #   class User < Acfs::Resource
+  #     attribute :name, :string
+  #   end
+  #
+  class String < Base
+    # @api public
+    #
+    # Cast given object to string.
+    #
+    # @param [Object] value Object to cast.
+    # @return [String] Casted string.
+    #
+    def cast_value(value)
+      value.to_s
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Acfs::Resource::Attributes
+  # @api public
+  #
+  # UUID attribute type. Use it in your model as an attribute type:
+  #
+  # @example
+  #   class User < Acfs::Resource
+  #     attribute :id, :uuid
+  #   end
+  #
+  class UUID < Base
+    UUID_REGEXP = /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/i.freeze
+
+    # @api public
+    #
+    # Check if given object looks like a UUID, eg:
+    #   `450b7a40-94ad-11e3-baa8-0800200c9a66`
+    # Valid UUIDs are 16 byte numbers represented as
+    #  a hexadecimal string in five sub-groups seperated
+    #  by a dash. Each group has to consist of a fixed
+    #  number of hexadecimal digits:
+    #   | Group | Digits |
+    #   | -----:|:------ |
+    #   |     1 | 8      |
+    #   |     2 | 4      |
+    #   |     3 | 4      |
+    #   |     4 | 4      |
+    #   |     5 | 12     |
+    #
+    # @param [Object] value Object to cast.
+    # @return [String] Casted object as UUID.
+    #
+    def cast_value(value)
+      if value.blank?
+        nil
+      elsif value.to_s =~ UUID_REGEXP
+        value
+      else
+        raise TypeError.new "Invalid UUID: `#{value}'"
+      end
+    end
+  end
+
+  # Lower-case alias for automatic type lookup
+  Uuid = UUID
+end

data/lib/acfs/resource/dirty.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Acfs::Resource
+  #
+  # Thin wrapper around ActiveModel::Dirty
+  #
+  module Dirty
+    extend ActiveSupport::Concern
+    include ActiveModel::Dirty
+
+    # @api private
+    #
+    def reset_changes
+      clear_changes_information
+    end
+
+    # @api private
+    #
+    def save!(**kwargs)
+      super(**kwargs).tap {|_| changes_applied }
+    end
+
+    # @api private
+    #
+    def loaded!
+      reset_changes
+      super
+    end
+
+    # @api private
+    #
+    def write_raw_attribute(name, value, opts = {})
+      attribute_will_change!(name) if opts[:change].nil? || opts[:change]
+      super
+    end
+  end
+end

data/lib/acfs/resource/initialization.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Acfs::Resource
+  #
+  # Initialization drop-in for pre-4.0 ActiveModel.
+  #
+  module Initialization
+    #
+    # @api public
+    #
+    # Initializes a new model with the given `params`.
+    #
+    # @example
+    #   class User < Acfs::Resource
+    #     attribute :name
+    #     attribute :email, default: ->{ "#{name}@dom.tld" }
+    #     attribute :age, :integer, default: 18
+    #   end
+    #
+    #   user = User.new({name: 'bob'})
+    #   user.name  # => "bob"
+    #   user.email # => "bob@dom.tld"
+    #   user.age   # => 18
+    #
+    # @param attributes [Hash{Symbol => Object}] Attributes to set on resource.
+    #
+    def initialize(attributes = {})
+      write_attributes(attributes) if attributes
+    end
+  end
+end

data/lib/acfs/resource/loadable.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class Acfs::Resource
+  # Provides method to check for loading state of resources.
+  # A resource that is created but not yet fetched will be loaded
+  # after running {Acfs::Global#run Acfs.run}.
+  #
+  # @example
+  #   user = User.find 5
+  #   user.loaded? # => false
+  #   Acfs.run
+  #   user.loaded? # => true
+  #
+  module Loadable
+    extend ActiveSupport::Concern
+
+    # @api public
+    #
+    # Check if model is loaded or if request is still queued.
+    #
+    # @return [Boolean] True if resource is loaded, false otherwise.
+    #
+    def loaded?
+      @loaded.nil? ? false : @loaded
+    end
+
+    # @api private
+    #
+    # Mark model as loaded.
+    #
+    def loaded!
+      @loaded = true
+    end
+  end
+end

data/lib/acfs/resource/locatable.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+class Acfs::Resource
+  # Provide methods for generation URLs for resources.
+  #
+  # @example
+  #   class User
+  #     service AccountService # With base URL `http://acc.svr`
+  #   end
+  #   User.url    # => "http://acc.svr/users"
+  #   User.url(5) # => "http://acc.svr/users/5"
+  #
+  module Locatable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # @overload url(suffix)
+      #   @deprecated
+      #   Return URL for this class of resource. Given suffix
+      #   will be appended.
+      #
+      #   @example
+      #     User.url    # => "http://users.srv.org/users"
+      #     User.url(5) # => "http://users.srv.org/users/5"
+      #
+      #   @param suffix [String] Suffix to append to URL.
+      #   @return [String] Generated URL.
+      #
+      # @overload url(opts = {})
+      #   Return URL for this class of resources. Given options
+      #   will be used to replace URL path arguments and to
+      #   determine the operation action.
+      #
+      #   @example
+      #     User.url(id: 5, action: :read) # => "http://users.srv.org/users/5"
+      #     User.url(action: :list) # => "http://users.srv.org/users"
+      #
+      #   @param opts [Hash] Options.
+      #   @option opts [Symbol] :action Operation action,
+      #     usually `:list`, `:create`, `:read`, `:update` or`:delete`.
+      #   @return [String] Generated URL.
+      #
+      def url(suffix = nil, **opts)
+        if suffix.is_a? Hash
+          opts = suffix
+          suffix = nil
+        end
+
+        kwargs = {}
+        kwargs[:path] = opts[:path] if opts.key?(:path)
+        kwargs[:action] = opts.delete(:action) if opts.key?(:action)
+        kwargs[:action] = :list if suffix
+
+        url  = location(**kwargs).build(opts.stringify_keys).str
+        url += "/#{suffix}" if suffix.to_s.present?
+        url
+      end
+
+      # Return a location object able to build the URL for this
+      # resource and given action.
+      #
+      # @example
+      #   class Identity < ::Acfs::Resource
+      #     service MyService, path: 'users/:user_id/identities'
+      #   end
+      #
+      #   location = Identity.location(action: :read)
+      #   location.arguments
+      #   => [:user_id, :id]
+      #
+      #   location.raw_url
+      #   => 'http://service/users/:user_id/identities/:id'
+      #
+      #   location = Identity.location(action: :list)
+      #   location.arguments
+      #   => [:user_id]
+      #
+      #   location.build(user_id: 42)
+      #   => 'http://service/users/42/identities'
+      #
+      # @param opts [Hash] Options.
+      # @option opts [Symbol] :action Operation action,
+      #   usually `:list`, `:create`, `:read`, `:update` or`:delete`.
+      #
+      # @return [Location] Location object.
+      #
+      def location(**opts)
+        service.location(self, **opts)
+      end
+
+      # @api private
+      def location_default_path(action, path)
+        case action
+          when :list, :create
+            path
+          when :read, :update, :delete
+            "#{path}/:id"
+        end
+      end
+    end
+
+    # Return URL for this resource. Resource if will be appended
+    # as suffix if present.
+    #
+    # @example
+    #   user.new.url # => "http://users.srv.org/users"
+    #
+    #   user = User.find 5
+    #   Acfs.run
+    #   user.url # => "http://users.srv.org/users/5"
+    #
+    # @return [ String ] Generated URL.
+    # @see ClassMethods#url
+    #
+    def url(**opts)
+      return nil if need_primary_key? && !primary_key?
+
+      self.class.service
+          .location(self.class, **opts, action: :read)
+          .build(attributes).str
+    end
+
+    # @api private
+    # Return true if resource needs a primary key (id) for singular actions.
+    def need_primary_key?
+      true
+    end
+
+    # @api private
+    # Return true if resource has a primary key (id) set.
+    def primary_key?
+      respond_to?(:id) && !id.nil?
+    end
+  end
+end