activerepresenter 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdd0c7efa14f672dba1fd48fb7e930fb382628cb552e7695601e26cd1e799f82
-  data.tar.gz: 7bf5638cfd3896aa45f7746154e8b6d41d796d152233b33d9e3506682cf75eb8
+  metadata.gz: d2747744f8459f07ebdfe15c26a152ea8da162d1f969734f4e57d881bdd4fafa
+  data.tar.gz: e8f959c5390fb1ea77ffec78ace4b69d874ad8fd2ef673f95bd93a27182c66ec
 SHA512:
-  metadata.gz: 6d354a1299513afbfc555bd93f9d5a212d038a047f3da5d6c0a77061b2249ba64f130e623e533de6bc7546c1c01a6a1af76a8a098a939381878a0bbb79249342
-  data.tar.gz: '048eb40b6d05b93227d5c318cdb01594b2df688cb68dfde1c76e8019090281b12fc30b080e3c406a7355197e0d1b0d34e51dc07485efa174727753e39ce53f28'
+  metadata.gz: 8c53e4051cd07c2c7e18b1aa37578f3c6d366050a45abbca576d7a784209d482bb2c5c2f752e8e95f7158888edb9aa37a425db84af2c72e2c6326226e82ad47f
+  data.tar.gz: b0771c5c2363e650012862099931c2e15071cd98409017f3874f0abfc4a1000ba2462fc1069411da35c7a10da8891a46448032fd6cbc5bbacc90a6a119a5d9f5

data/lib/active_representer/base.rb

@@ -4,6 +4,24 @@ require "active_model"
 require "active_support"
 
 module ActiveRepresenter
+  # == Action \Representer \Base
+  #
+  # This is a base class for a representer (wrapped object).
+  # It wraps the original object as `wrapped` attribute and
+  # you can add custom methods to the class (using the decorator pattern).
+  #
+  # In addition, `attr_field` / `attr_collection` can be used for attributes.
+  #
+  # attr_field:
+  #   Declare additional field and type to the objects.
+  #   You can get / set field's value (converted to corresponding).
+  #   It uses ActiveModel::Attributes internally.
+  #   See examples: AttrFieldTest in test/attr_field_test.
+  #
+  # attr_collection:
+  #   Declare sub (containing) object array like has many association.
+  #   If sub object's representer is found, sub objects will be wrapped by it.
+  #   See examples: AttrCollectionTest in test/attr_collection_test.
   class Base
     include ActiveModel::Model
     include ActiveModel::Attributes
@@ -13,60 +31,64 @@ module ActiveRepresenter
 
     delegate_missing_to :wrapped
 
-    class << self
-      def wrap(wrapped)
-        instance = new
-        instance.wrapped = wrapped
-        collection_names.each do |collection_name|
-          next if wrapped[collection_name].nil?
-          representer_klass = collections[collection_name]
-          collection_value = \
-            if representer_klass
-              wrapped[collection_name].map { |item| representer_klass.wrap(item) }
-            else
-              wrapped[collection_name]
-            end
-          instance.instance_variable_set("@#{collection_name}", collection_value)
-        end
-        attribute_names.each do |attribute_name|
-          instance.send("#{attribute_name}=", wrapped.send(attribute_name))
-        end
-        instance
-      end
+    def self.wrap(wrapped)
+      instance = new
+      instance.wrapped = wrapped
 
-      def attr_field(name, type = Type::Value.new, **options)
-        attribute(name, type, **options)
+      collection_names.each do |collection_name|
+        next if wrapped[collection_name].nil?
+        representer_klass = collections[collection_name]
+        collection_value = \
+          if representer_klass
+            wrapped[collection_name].map { |item| representer_klass.wrap(item) }
+          else
+            wrapped[collection_name]
+          end
+        instance.instance_variable_set("@#{collection_name}", collection_value)
       end
 
-      def attr_collection(name, **options)
-        unless name.is_a?(Symbol) || name.is_a?(String)
-          raise ArgumentError.new("collection's name must be a Symbol or a String")
-        end
-        representer_name = \
-          options[:representer_name] ? options[:representer_name] : guess_representrer_name(name.to_s)
-        raise ArgumentError.new("representer_name must be a String") unless representer_name.is_a?(String)
-        begin
-          representer = representer_name.constantize
-          collections[name.to_sym] = representer
-        rescue NameError => e
-          collections[name.to_sym] = nil
-        end
-        class_eval do
-          attr_reader name.to_sym
-        end
+      attribute_names.each do |attribute_name|
+        instance.send("#{attribute_name}=", wrapped.send(attribute_name))
       end
 
-      def collection_names
-        collections.keys
+      instance
+    end
+
+    def self.attr_field(name, type = Type::Value.new, **options)
+      attribute(name, type, **options)
+    end
+
+    def self.attr_collection(name, **options)
+      unless name.is_a?(Symbol) || name.is_a?(String)
+        raise ArgumentError.new("collection's name must be a Symbol or a String")
       end
 
-      def attribute_names
-        attribute_types.keys - ["wrapped"]
+      representer_name = \
+        options[:representer_name] ? options[:representer_name] : guess_representrer_name(name.to_s)
+      raise ArgumentError.new("representer_name must be a String") unless representer_name.is_a?(String)
+
+      begin
+        representer = representer_name.constantize
+        collections[name.to_sym] = representer
+      rescue NameError => e
+        collections[name.to_sym] = nil
       end
 
-      def guess_representrer_name(name)
-        "#{name.singularize.camelize}Representer"
+      class_eval do
+        attr_reader name.to_sym
       end
     end
+
+    def self.collection_names
+      collections.keys
+    end
+
+    def self.attribute_names
+      attribute_types.keys - ["wrapped"]
+    end
+
+    def self.guess_representrer_name(name)
+      "#{name.singularize.camelize}Representer"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerepresenter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ryo Hashimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler