acfs 0.42.0 → 0.43.0

data/lib/acfs/middleware/print.rb

@@ -1,10 +1,8 @@
 module Acfs
   module Middleware
-
     # Print resquests and response on terminal
     #
     class Print < Base
-
       def call(req)
         puts '-' * 80
         puts req.inspect

data/lib/acfs/middleware/serializer.rb

@@ -1,15 +1,14 @@
 module Acfs
   module Middleware
-
     # A base middleware that does not modify request or response.
     # Can be used as super class for custom middleware implementations.
     #
     class Serializer < Base
-      def encode(data)
+      def encode(_data)
         raise NotImplementedError
       end
 
-      def decode(data)
+      def decode(_data)
         raise NotImplementedError
       end
 
@@ -28,9 +27,7 @@ module Acfs
         request.headers['Accept'] = accept.join(',')
 
         request.on_complete do |response, nxt|
-          if mime == response.content_type
-            response.data = decode response.body
-          end
+          response.data = decode response.body if mime == response.content_type
 
           nxt.call response
         end

data/lib/acfs/operation.rb

@@ -1,5 +1,4 @@
 module Acfs
-
   # @api private
   #
   # Describes a CRUD operation. Handle request creation and response
@@ -51,7 +50,7 @@ module Acfs
     end
 
     def method
-      { read: :get, list: :get, update: :put, create: :post, delete: :delete }[action]
+      {read: :get, list: :get, update: :put, create: :post, delete: :delete}[action]
     end
 
     def request
@@ -59,8 +58,8 @@ module Acfs
                                          data: data, operation: self
       request.on_complete do |response|
         ::ActiveSupport::Notifications.instrument 'acfs.operation.complete',
-                                                  operation: self,
-                                                  response: response
+          operation: self,
+          response: response
 
         handle_failure response unless response.success?
         callback.call response.data, response

data/lib/acfs/request.rb

@@ -1,7 +1,6 @@
 require 'acfs/request/callbacks'
 
 module Acfs
-
   # Encapsulate all data required to make up a request to the
   # underlaying http library.
   #
@@ -12,7 +11,7 @@ module Acfs
     include Request::Callbacks
 
     def initialize(url, options = {}, &block)
-      @url = URI.parse(url.to_s).tap do |url|
+      @url = URI.parse(url.to_s).tap do |_url|
         @data    = options.delete(:data) || nil
         @format  = options.delete(:format) || :json
         @headers = options.delete(:headers) || {}
@@ -20,7 +19,7 @@ module Acfs
         @method  = options.delete(:method) || :get
       end.to_s
       @operation = options.delete(:operation) || nil
-      on_complete &block if block_given?
+      on_complete(&block) if block_given?
     end
 
     def data?

data/lib/acfs/request/callbacks.rb

@@ -1,6 +1,5 @@
 module Acfs
   class Request
-
     # Module containing callback handling for Requests.
     # Current the only callback type is `on_complete`:
     #
@@ -8,7 +7,6 @@ module Acfs
     #   request.on_complete { |response| ... }
     #
     module Callbacks
-
       # Add a new `on_complete` callback for this request.
       #
       # @example Set on_complete.
@@ -43,8 +41,9 @@ module Acfs
       end
 
       private
+
       def call_callback(res, index)
-        callbacks[index].call res, proc { |res| call_callback res, index + 1 } if index < callbacks.size
+        callbacks[index].call res, proc {|bres| call_callback bres, index + 1 } if index < callbacks.size
       end
     end
   end

data/lib/acfs/resource.rb

@@ -1,8 +1,37 @@
-module Acfs
+require 'active_model'
 
-  # Transition stub for `Model`.
-  #
-  class Resource
-    include Acfs::Model
+# @api public
+#
+class Acfs::Resource
+  require 'acfs/resource/initialization'
+  require 'acfs/resource/attributes'
+  require 'acfs/resource/dirty'
+  require 'acfs/resource/loadable'
+  require 'acfs/resource/locatable'
+  require 'acfs/resource/operational'
+  require 'acfs/resource/persistence'
+  require 'acfs/resource/query_methods'
+  require 'acfs/resource/service'
+  require 'acfs/resource/validation'
+
+  if ActiveModel::VERSION::MAJOR >= 4
+    include ActiveModel::Model
+  else
+    extend ActiveModel::Naming
+    extend ActiveModel::Translation
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
   end
+
+  include Initialization
+
+  include Attributes
+  include Loadable
+  include Persistence
+  include Locatable
+  include Operational
+  include QueryMethods
+  include Service
+  include Dirty
+  include Validation
 end

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

@@ -1,12 +1,12 @@
-module Acfs::Model
-
+class Acfs::Resource
+  #
   # = Acfs Attributes
   #
-  # Allows to specify attributes of a class with default values and type safety.
+  # Allows to specify attributes of a class with default
+  # values and type safety.
   #
   # @example
-  #   class User
-  #     include Acfs::Model
+  #   class User < Acfs::Resource
   #     attribute :name, :string, default: 'Anon'
   #     attribute :age, :integer
   #     attribute :special, My::Special::Type
@@ -27,7 +27,7 @@ module Acfs::Model
     # @see ClassMethods#attributes
     #
     def initialize(*attrs)
-      self.write_attributes self.class.attributes
+      write_attributes self.class.attributes
       reset_changes
       super
     end
@@ -37,14 +37,14 @@ module Acfs::Model
     # Returns ActiveModel compatible list of attributes and values.
     #
     # @example
-    #   class User
-    #     include Acfs::Model
+    #   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.
+    # @return [HashWithIndifferentAccess{Symbol => Object}]
+    #   Attributes and their values.
     #
     def attributes
       @attributes ||= HashWithIndifferentAccess.new
@@ -59,8 +59,9 @@ module Acfs::Model
     #   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`.
+    # @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
@@ -70,11 +71,11 @@ module Acfs::Model
     #
     # Read an attribute from instance variable.
     #
-    # @param [ Symbol, String ] name Attribute name.
-    # @return [ Object ] Attribute value.
+    # @param [Symbol, String] name Attribute name.
+    # @return [Object] Attribute value.
     #
     def read_attribute(name)
-      self.attributes[name.to_s]
+      attributes[name.to_s]
     end
 
     # @api public
@@ -89,11 +90,13 @@ module Acfs::Model
     # class definition.
     #
     # @example
-    #   user.write_attributes { :name => 'john', :email => lambda{ "#{name}@example.org" } }
+    #   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.
+    # @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 = {})
@@ -101,9 +104,11 @@ module Acfs::Model
         return false
       end
 
-      if opts.fetch(:unknown,:ignore) == :raise
+      if opts.fetch(:unknown, :ignore) == :raise
         if (attributes.keys.map(&:to_s) - self.class.attributes.keys).any?
-          raise ArgumentError.new "Unknown attributes: #{(attributes.keys - self.class.attributes.keys).map(&:inspect).join(', ')}"
+          missing = attributes.keys - self.class.attributes.keys
+          missing.map!(&:inspect)
+          raise ArgumentError.new "Unknown attributes: #{missing.join(', ')}"
         end
       end
 
@@ -145,9 +150,9 @@ module Acfs::Model
     # 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.
+    # @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]
@@ -164,15 +169,18 @@ module Acfs::Model
     # 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.
+    # @param [String, Symbol] name Attribute name.
+    # @param [Object] value Attribute value.
     #
     def write_raw_attribute(name, value, _ = {})
-      self.attributes[name.to_s] = 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
@@ -181,18 +189,18 @@ module Acfs::Model
       # Available types can be found in `Acfs::Model::Attributes::*`.
       #
       # @example
-      #   class User
-      #     include Acfs::Model
+      #   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.
+      # @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 or type.is_a? String
-          type = "::Acfs::Model::Attributes::#{type.to_s.classify}".constantize
+        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
@@ -200,20 +208,21 @@ module Acfs::Model
 
       # @api public
       #
-      # Return list of possible attributes and default values for this model class.
+      # Return list of possible attributes and default
+      # values for this model class.
       #
       # @example
-      #   class User
-      #     include Acfs::Model
+      #   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.
+      # @return [Hash{String => Object, Proc}]
+      #   Attributes with default values.
       #
       def attributes
-        Hash.new.tap do |attrs|
+        {}.tap do |attrs|
           defined_attributes.each do |key, attr|
             attrs[key] = attr.default_value
           end
@@ -221,7 +230,14 @@ module Acfs::Model
       end
 
       def defined_attributes
-        @attributes ||= {}.merge superclass.respond_to?(:defined_attributes) ? superclass.defined_attributes : {}
+        @attributes ||= begin
+          attributes = {}
+          if superclass.respond_to?(:defined_attributes)
+            attributes.merge superclass.defined_attributes
+          end
+
+          attributes
+        end
       end
 
       # @api public
@@ -229,32 +245,40 @@ module Acfs::Model
       # Return hash of attributes and there types.
       #
       # @example
-      #   class User
-      #     include Acfs::Model
+      #   class User < Acfs::Resource
       #     attribute :name, :string
       #     attribute :age, :integer, default: 25
       #   end
-      #   User.attributes # => { "name": Acfs::Model::Attributes::String, "age": Acfs::Model::Attributes::Integer }
+      #   User.attributes # => {"name": Acfs::Model::Attributes::String,
+      #                   #     "age":  Acfs::Model::Attributes::Integer}
       #
-      # @return [ Hash{ Symbol => Class } ] Attributes and their types.
+      # @return [Hash{Symbol => Class}] Attributes and their types.
       #
       def attribute_types
-        @attribute_types ||= {}.merge superclass.respond_to?(:attribute_types) ? superclass.attribute_types : {}
+        @attribute_types ||= begin
+          attribute_types = {}
+          if superclass.respond_to?(:attribute_types)
+            attribute_types.merge superclass.attribute_types
+          end
+
+          attribute_types
+        end
       end
 
       private
+
       def define_attribute(name, type, opts = {})
-        name             = name.to_s
-        attribute        = type.new opts
+        name      = name.to_s
+        attribute = type.new opts
 
         defined_attributes[name] = attribute
         define_attribute_method name
 
-        self.send :define_method, name do
+        send :define_method, name do
           read_attribute name
         end
 
-        self.send :define_method, :"#{name}=" do |value|
+        send :define_method, :"#{name}=" do |value|
           write_attribute name, value
         end
       end
@@ -266,5 +290,5 @@ end
 #
 Dir[File.dirname(__FILE__) + '/attributes/*.rb'].sort.each do |path|
   filename = File.basename(path)
-  require "acfs/model/attributes/#{filename}"
+  require "acfs/resource/attributes/#{filename}"
 end

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

@@ -1,5 +1,5 @@
-module Acfs::Model::Attributes
-
+module Acfs::Resource::Attributes
+  #
   class Base
     attr_reader :options
 
@@ -9,15 +9,19 @@ module Acfs::Model::Attributes
     end
 
     def nil_allowed?
-      !!options[:allow_nil]
+      options[:allow_nil]
     end
 
     def blank_allowed?
-      !!options[:allow_blank]
+      options[:allow_blank]
     end
 
     def default_value
-      options[:default].is_a?(Proc) ? options[:default] : cast(options[:default])
+      if options[:default].is_a? Proc
+        options[:default]
+      else
+        cast options[:default]
+      end
     end
 
     def cast(obj)
@@ -25,7 +29,7 @@ module Acfs::Model::Attributes
       cast_type obj
     end
 
-    def cast_type(obj)
+    def cast_type(_obj)
       raise NotImplementedError
     end
   end