fog-core 1.24.0 → 1.25.0

data/lib/fog/core/association.rb

@@ -0,0 +1,15 @@
+module Fog
+  class Association < Collection
+    def initialize(associations = [])
+      @loaded = true
+      load(associations)
+    end
+
+    def load(associations)
+      return unless associations.kind_of?(Array)
+      associations.each do |association|
+        self << association
+      end
+    end
+  end
+end

data/lib/fog/core/associations/default.rb

@@ -1,15 +1,33 @@
 module Fog
   module Associations
+    # = Fog Default Association
+    #
+    # This class has the shared behavior between all association models.
     class Default
-      attr_reader :model, :name
+      attr_reader :model, :name, :aliases, :as, :association_class
 
-      def initialize(model, name, collection_name)
+      def initialize(model, name, collection_name, options)
         @model = model
         @name = name
         model.associations[name] = collection_name
+        @aliases = options.fetch(:aliases, [])
+        @as = options.fetch(:as, name)
+        @association_class = options.fetch(:association_class, Fog::Association)
         create_setter
         create_getter
+        create_aliases
+        create_mask
+      end
+
+      def create_aliases
+        Array(aliases).each do |alias_name|
+          model.aliases[alias_name] = name
+        end
+      end
+
+      def create_mask
+        model.masks[name] = as
       end
     end
   end
-end
+end

data/lib/fog/core/associations/many_identities.rb

@@ -1,5 +1,10 @@
 module Fog
   module Associations
+    # = Fog Multiple Association
+    #
+    # This class handles multiple association between the models.
+    # It expects the provider to return a collection of ids.
+    # The association models will be loaded based on the collection of ids.
     class ManyIdentities < Default
       def create_setter
         model.class_eval <<-EOS, __FILE__, __LINE__
@@ -15,12 +20,13 @@ module Fog
         model.class_eval <<-EOS, __FILE__, __LINE__
           def #{name}
             return [] if associations[:#{name}].nil?
-            Array(associations[:#{name}]).map do |association|
+            data = Array(associations[:#{name}]).map do |association|
               service.send(self.class.associations[:#{name}]).get(association)
             end
+            #{association_class}.new(data)
           end
         EOS
       end
     end
   end
-end
+end

data/lib/fog/core/associations/many_models.rb

@@ -1,5 +1,9 @@
 module Fog
   module Associations
+    # = Fog Multiple Association
+    #
+    # This class handles multiple association between the models.
+    # It expects the provider to map the attribute with a collection of objects.
     class ManyModels < Default
       def create_setter
         model.class_eval <<-EOS, __FILE__, __LINE__
@@ -12,10 +16,11 @@ module Fog
       def create_getter
         model.class_eval <<-EOS, __FILE__, __LINE__
           def #{name}
-            Array(associations[:#{name}])
+            data = associations[:#{name}]
+            #{association_class}.new(data)
           end
         EOS
       end
     end
   end
-end
+end

data/lib/fog/core/associations/one_identity.rb

@@ -1,5 +1,10 @@
 module Fog
   module Associations
+    # = Fog Single Association
+    #
+    # This class handles single association between the models.
+    # It expects the provider to return only the id of the association.
+    # The association model will be loaded based on the id initialized.
     class OneIdentity < Default
       def create_setter
         model.class_eval <<-EOS, __FILE__, __LINE__
@@ -19,4 +24,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/core/associations/one_model.rb

@@ -1,5 +1,9 @@
 module Fog
   module Associations
+    # = Fog Single Association
+    #
+    # This class handles single association between the models.
+    # It expects the provider to map the attribute with an initialized object.
     class OneModel < Default
       def create_setter
         model.class_eval <<-EOS, __FILE__, __LINE__
@@ -18,4 +22,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/core/attributes.rb

@@ -1,7 +1,6 @@
 module Fog
   module Attributes
     module ClassMethods
-
       def _load(marshalled)
         new(Marshal.load(marshalled))
       end
@@ -22,45 +21,47 @@ module Fog
         @default_values ||= {}
       end
 
+      def masks
+        @masks ||= {}
+      end
+
       def attribute(name, options = {})
-        type = options.fetch(:type, 'default').to_s.capitalize
-        Fog::Attributes::const_get(type).new(self, name, options)
+        type = options.fetch(:type, "default").to_s.capitalize
+        Fog::Attributes.const_get(type).new(self, name, options)
       end
 
-      def has_one(name, collection_name)
-        Fog::Associations::OneModel.new(self, name, collection_name)
+      def has_one(name, collection_name, options = {})
+        Fog::Associations::OneModel.new(self, name, collection_name, options)
       end
 
-      def has_many(name, collection_name)
-        Fog::Associations::ManyModels.new(self, name, collection_name)
+      def has_many(name, collection_name, options = {})
+        Fog::Associations::ManyModels.new(self, name, collection_name, options)
       end
 
-      def has_one_identity(name, collection_name)
-        Fog::Associations::OneIdentity.new(self, name, collection_name)
+      def has_one_identity(name, collection_name, options = {})
+        Fog::Associations::OneIdentity.new(self, name, collection_name, options)
       end
 
-      def has_many_identities(name, collection_name)
-        Fog::Associations::ManyIdentities.new(self, name, collection_name)
+      def has_many_identities(name, collection_name, options = {})
+        Fog::Associations::ManyIdentities.new(self, name, collection_name, options)
       end
 
       def identity(name, options = {})
         @identity = name
-        self.attribute(name, options)
+        attribute(name, options)
       end
 
       def ignore_attributes(*args)
-        @ignored_attributes = args.collect {|attr| attr.to_s }
+        @ignored_attributes = args.map(&:to_s)
       end
 
       def ignored_attributes
         @ignored_attributes ||= []
       end
-
     end
 
     module InstanceMethods
-
-      def _dump(level)
+      def _dump(_level)
         Marshal.dump(attributes)
       end
 
@@ -72,16 +73,20 @@ module Fog
         @associations ||= {}
       end
 
+      def masks
+        self.class.masks
+      end
+
       def all_attributes
-        self.class.attributes.inject({}) do |hash, attribute|
-          hash[attribute] = send(attribute)
+        self.class.attributes.reduce({}) do |hash, attribute|
+          hash[masks[attribute]] = send(attribute)
           hash
         end
       end
 
       def all_associations
-        self.class.associations.keys.inject({}) do |hash, association|
-          hash[association] = associations[association] || send(association)
+        self.class.associations.keys.reduce({}) do |hash, association|
+          hash[masks[association]] = associations[association] || send(association)
           hash
         end
       end
@@ -97,23 +102,22 @@ module Fog
       end
 
       def identity
-        send(self.class.instance_variable_get('@identity'))
+        send(self.class.instance_variable_get("@identity"))
       end
 
       def identity=(new_identity)
-        send("#{self.class.instance_variable_get('@identity')}=", new_identity)
+        send("#{self.class.instance_variable_get("@identity")}=", new_identity)
       end
 
       def merge_attributes(new_attributes = {})
-        for key, value in new_attributes
-          unless self.class.ignored_attributes.include?(key)
-            if aliased_key = self.class.aliases[key]
-              send("#{aliased_key}=", value)
-            elsif self.respond_to?("#{key}=",true)
-              send("#{key}=", value)
-            else
-              attributes[key] = value
-            end
+        new_attributes.each_pair do |key, value|
+          next if self.class.ignored_attributes.include?(key)
+          if self.class.aliases[key]
+            send("#{self.class.aliases[key]}=", value)
+          elsif self.respond_to?("#{key}=", true)
+            send("#{key}=", value)
+          else
+            attributes[key] = value
           end
         end
         self
@@ -151,20 +155,16 @@ module Fog
       end
 
       def requires_one(*args)
-        missing = missing_attributes(args)
-        if missing.length == args.length
-          raise(ArgumentError, "#{missing[0...-1].join(", ")} or #{missing[-1]} are required for this operation")
-        end
+        return unless missing_attributes(args).length == args.length
+        raise(ArgumentError, "#{missing[0...-1].join(", ")} or #{missing[-1]} are required for this operation")
       end
 
       protected
 
       def missing_attributes(args)
         missing = []
-        for arg in [:service] | args
-          unless send("#{arg}") || attributes.has_key?(arg)
-            missing << arg
-          end
+        ([:service] | args).each do |arg|
+          missing << arg unless send("#{arg}") || attributes.key?(arg)
         end
         missing
       end
@@ -176,13 +176,10 @@ module Fog
       private
 
       def remap_attributes(attributes, mapping)
-        for key, value in mapping
-          if attributes.key?(key)
-            attributes[value] = attributes.delete(key)
-          end
+        mapping.each_pair do |key, value|
+          attributes[value] = attributes.delete(key) if attributes.key?(key)
         end
       end
-
     end
   end
 end

data/lib/fog/core/attributes/array.rb

@@ -1,5 +1,9 @@
 module Fog
   module Attributes
+    # = Fog Array Attribute
+    #
+    # This class handles Array attributes from the providers,
+    # converting values to Array objects
     class Array < Default
       def create_setter
         model.class_eval <<-EOS, __FILE__, __LINE__
@@ -18,4 +22,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/core/attributes/boolean.rb

@@ -1,5 +1,9 @@
 module Fog
   module Attributes
+    # = Fog Boolean Attribute
+    #
+    # This class handles Boolean attributes from the providers,
+    # converting values to Boolean objects
     class Boolean < Default
       def create_setter
         model.class_eval <<-EOS, __FILE__, __LINE__
@@ -15,4 +19,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/core/attributes/default.rb

@@ -1,7 +1,11 @@
 module Fog
   module Attributes
+    # = Fog Default Attribute
+    #
+    # This class handles the attributes without a type force.
+    # The attributes returned from the provider will keep its original values.
     class Default
-      attr_reader :model, :name, :squash, :aliases, :default
+      attr_reader :model, :name, :squash, :aliases, :default, :as
 
       def initialize(model, name, options)
         @model = model
@@ -10,10 +14,12 @@ module Fog
         @squash = options.fetch(:squash, false)
         @aliases = options.fetch(:aliases, [])
         @default = options[:default]
+        @as = options.fetch(:as, name)
         create_setter
         create_getter
         create_aliases
         set_defaults
+        create_mask
       end
 
       def create_setter
@@ -63,6 +69,10 @@ module Fog
       def set_defaults
         model.default_values[name] = default unless default.nil?
       end
+
+      def create_mask
+        model.masks[name] = as
+      end
     end
   end
-end
+end

data/lib/fog/core/attributes/float.rb

@@ -1,5 +1,9 @@
 module Fog
   module Attributes
+    # = Fog Float Attribute
+    #
+    # This class handles Float attributes from the providers,
+    # converting values to Float objects
     class Float < Default
       def create_setter
         model.class_eval <<-EOS, __FILE__, __LINE__
@@ -10,4 +14,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/core/attributes/integer.rb

@@ -1,5 +1,9 @@
 module Fog
   module Attributes
+    # = Fog Integer Attribute
+    #
+    # This class handles Integer attributes from the providers,
+    # converting values to Integer objects
     class Integer < Default
       def create_setter
         model.class_eval <<-EOS, __FILE__, __LINE__
@@ -10,4 +14,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/core/attributes/string.rb

@@ -1,5 +1,9 @@
 module Fog
   module Attributes
+    # = Fog String Attribute
+    #
+    # This class handles String attributes from the providers,
+    # converting values to String objects
     class String < Default
       def create_setter
         model.class_eval <<-EOS, __FILE__, __LINE__
@@ -10,4 +14,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/core/attributes/time.rb

@@ -1,5 +1,9 @@
 module Fog
   module Attributes
+    # = Fog Time Attribute
+    #
+    # This class handles Time attributes from the providers,
+    # converting values to Time objects
     class Time < Default
       def create_setter
         model.class_eval <<-EOS, __FILE__, __LINE__
@@ -16,4 +20,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/core/attributes/timestamp.rb

@@ -1,5 +1,9 @@
 module Fog
   module Attributes
+    # = Fog Timestamp Attribute
+    #
+    # This class handles Timestamp attributes from the providers,
+    # converting Integer and String values as a real Timestamp objects
     class Timestamp < Default
       def create_setter
         model.class_eval <<-EOS, __FILE__, __LINE__
@@ -14,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end