acfs 0.42.0 → 0.43.0

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

@@ -0,0 +1,33 @@
+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
+    TRUE_VALUES = %w(true on yes 1)
+
+    # @api public
+    #
+    # Cast given object to boolean.
+    #
+    # @param [Object] obj Object to cast.
+    # @return [TrueClass, FalseClass] Casted boolean.
+    #
+    def cast_type(obj)
+      return true if obj.is_a? TrueClass
+      return false if obj.is_a? FalseClass
+
+      TRUE_VALUES.include? obj.to_s
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+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] obj Object to cast.
+    # @return [DateTime] Casted object as DateTime.
+    #
+    def cast_type(obj)
+      if nil_allowed? && obj.blank?
+        nil
+      elsif obj.is_a? ::DateTime
+        obj
+      elsif obj.is_a?(Time) || obj.is_a?(Date)
+        ::DateTime.iso8601 obj.iso8601
+      else
+        ::DateTime.iso8601 obj
+      end
+    end
+  end
+end

data/lib/acfs/{model → resource}/attributes/dict.rb

@@ -1,5 +1,4 @@
-module Acfs::Model::Attributes
-
+module Acfs::Resource::Attributes
   # @api public
   #
   # Dict attribute type. Use it in your model as an attribute type:
@@ -11,7 +10,6 @@ module Acfs::Model::Attributes
   #   end
   #
   class Dict < Base
-
     # @api public
     #
     # Cast given object to a dict/hash.

data/lib/acfs/{model → resource}/attributes/float.rb

@@ -1,17 +1,14 @@
-module Acfs::Model::Attributes
-
+module Acfs::Resource::Attributes
   # @api public
   #
   # Float attribute type. Use it in your model as an attribute type:
   #
   # @example
-  #   class User
-  #     include Acfs::Model
+  #   class User < Acfs::Resource
   #     attribute :name, :float
   #   end
   #
   class Float < Base
-
     # @api public
     #
     # Cast given object to float.
@@ -20,7 +17,7 @@ module Acfs::Model::Attributes
     # @return [Float] Casted object as float.
     #
     def cast_type(obj)
-      obj.to_f
+      Float obj
     end
   end
 end

data/lib/acfs/{model → resource}/attributes/integer.rb

@@ -1,17 +1,14 @@
-module Acfs::Model::Attributes
-
+module Acfs::Resource::Attributes
   # @api public
   #
   # Integer attribute type. Use it in your model as an attribute type:
   #
   # @example
-  #   class User
-  #     include Acfs::Model
+  #   class User < Acfs::Resource
   #     attribute :name, :integer
   #   end
   #
   class Integer < Base
-
     # @api public
     #
     # Cast given object to integer.
@@ -20,7 +17,7 @@ module Acfs::Model::Attributes
     # @return [Fixnum] Casted object as fixnum.
     #
     def cast_type(obj)
-      obj.to_i
+      Integer obj
     end
   end
 end

data/lib/acfs/{model → resource}/attributes/list.rb

@@ -1,17 +1,14 @@
-module Acfs::Model::Attributes
-
+module Acfs::Resource::Attributes
   # @api public
   #
   # List attribute type. Use it in your model as an attribute type:
   #
   # @example
-  #   class User
-  #     include Acfs::Model
+  #   class User < Acfs::Resource
   #     attribute :name, :list
   #   end
   #
   class List < Base
-
     # @api public
     #
     # Cast given object to a list.

data/lib/acfs/{model → resource}/attributes/string.rb

@@ -1,17 +1,15 @@
-module Acfs::Model::Attributes
-
+module Acfs::Resource::Attributes
   # @api public
   #
-  # String attribute type. Use it in your model as an attribute type:
+  # String attribute type. Use it in your model as
+  # an attribute type:
   #
   # @example
-  #   class User
-  #     include Acfs::Model
+  #   class User < Acfs::Resource
   #     attribute :name, :string
   #   end
   #
   class String < Base
-
     # @api public
     #
     # Cast given object to string.

data/lib/acfs/{model → resource}/attributes/uuid.rb

@@ -1,16 +1,16 @@
-module Acfs::Model::Attributes
-
+module Acfs::Resource::Attributes
   # @api public
   #
   # UUID attribute type. Use it in your model as an attribute type:
   #
   # @example
-  #   class User
-  #     include Acfs::Model
+  #   class User < Acfs::Resource
   #     attribute :id, :uuid
   #   end
   #
   class UUID < Base
+    #
+    REGEXP = /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/i
 
     # @api public
     #
@@ -32,10 +32,20 @@ module Acfs::Model::Attributes
     # @return [String] Casted object as UUID.
     #
     def cast_type(obj)
-      obj = obj.to_s
-      return nil if nil_allowed? and obj == ''
-      raise ArgumentError.new "given String `#{obj}` does not look like a UUID" unless obj =~ /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/i
-      obj
+      cast_string obj.to_s
+    end
+
+    private
+
+    def cast_string(str)
+      if nil_allowed? && str.blank?
+        return nil
+      elsif str =~ REGEXP
+        str
+      else
+        raise ArgumentError.new "given String `#{str}` " \
+                                'does not look like a UUID'
+      end
     end
   end
 

data/lib/acfs/resource/dirty.rb

@@ -0,0 +1,47 @@
+class Acfs::Resource
+  #
+  # Thin wrapper around ActiveModel::Dirty
+  #
+  module Dirty
+    extend ActiveSupport::Concern
+    include ActiveModel::Dirty
+
+    # @api private
+    #
+    # Resets all changes. Does not touch previous changes.
+    #
+    def reset_changes
+      changed_attributes.clear
+    end
+
+    # @api private
+    #
+    # Save current changes as previous changes and reset
+    # current one.
+    #
+    def swap_changes
+      @previously_changed = changes
+      reset_changes
+    end
+
+    # @api private
+    #
+    def save!(*)
+      super.tap {|_| swap_changes }
+    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/{model → resource}/initialization.rb

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

data/lib/acfs/{model → resource}/loadable.rb

@@ -1,5 +1,4 @@
-module Acfs::Model
-
+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}.
@@ -17,10 +16,10 @@ module Acfs::Model
     #
     # Check if model is loaded or if request is still queued.
     #
-    # @return [ Boolean ] True if resource is loaded, false otherwise.
+    # @return [Boolean] True if resource is loaded, false otherwise.
     #
     def loaded?
-      !!@loaded
+      @loaded.nil? ? false : @loaded
     end
 
     # @api private

data/lib/acfs/{model → resource}/locatable.rb

@@ -1,5 +1,4 @@
-module Acfs::Model
-
+class Acfs::Resource
   # Provide methods for generation URLs for resources.
   #
   # @example
@@ -12,36 +11,36 @@ module Acfs::Model
   module Locatable
     extend ActiveSupport::Concern
 
+    #
     module ClassMethods
-
       # @overload url(suffix)
       #   @deprecated
-      #   Return URL for this class of resource. Given suffix will be appended.
+      #   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 [ String ] suffix Suffix to append to URL.
-      #   @return [ String ] Generated URL.
+      #   @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.
+      #   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.
+      #   @option opts [Symbol] :action Operation action,
+      #     usually `:list`, `:create`, `:read`, `:update` or`:delete`.
+      #   @return [String] Generated URL.
       #
       def url(suffix = nil, opts = {})
-        if Hash === suffix
-          opts, suffix = suffix, nil
-        end
+        opts, suffix = suffix, nil if suffix.is_a? Hash
 
         opts[:action] = :list if suffix
 
@@ -50,8 +49,8 @@ module Acfs::Model
         url
       end
 
-      # Return a location object able to build the URL for this resource and
-      # given action.
+      # Return a location object able to build the URL for this
+      # resource and given action.
       #
       # @example
       #   class Identity < ::Acfs::Resource
@@ -73,8 +72,8 @@ module Acfs::Model
       #   => 'http://service/users/42/identities'
       #
       # @param opts [Hash] Options.
-      # @option opts [Symbol] :action Operation action, usually `:list`, `:create`, `:read`,
-      #   `:update` or`:delete`.
+      # @option opts [Symbol] :action Operation action,
+      #   usually `:list`, `:create`, `:read`, `:update` or`:delete`.
       #
       # @return [Location] Location object.
       #
@@ -89,8 +88,6 @@ module Acfs::Model
             return path
           when :read, :update, :delete
             return "#{path}/:id"
-          else
-            nil
         end
       end
     end
@@ -109,9 +106,11 @@ module Acfs::Model
     # @see ClassMethods#url
     #
     def url(opts = {})
-      return nil if need_primary_key? && !has_primary_key?
+      return nil if need_primary_key? && !primary_key?
 
-      self.class.service.location(self.class, opts.reverse_merge(action: :read)).build(attributes).str
+      self.class.service
+        .location(self.class, opts.reverse_merge(action: :read))
+        .build(attributes).str
     end
 
     # @api private
@@ -122,7 +121,7 @@ module Acfs::Model
 
     # @api private
     # Return true if resource has a primary key (id) set.
-    def has_primary_key?
+    def primary_key?
       respond_to?(:id) && !id.nil?
     end
   end

data/lib/acfs/{model → resource}/operational.rb

@@ -1,5 +1,4 @@
-module Acfs::Model
-
+class Acfs::Resource
   # @api private
   #
   # Provide methods for creating and processing CRUD operations and
@@ -12,8 +11,8 @@ module Acfs::Model
     extend ActiveSupport::Concern
     delegate :operation, to: :'self.class'
 
+    #
     module ClassMethods
-
       # Invoke CRUD operation.
       def operation(action, opts = {}, &block)
         Acfs.runner.process ::Acfs::Operation.new self, action, opts, &block