activerepresenter 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdd0c7efa14f672dba1fd48fb7e930fb382628cb552e7695601e26cd1e799f82
-  data.tar.gz: 7bf5638cfd3896aa45f7746154e8b6d41d796d152233b33d9e3506682cf75eb8
+  metadata.gz: 2ed4527a2a221a276e499bd089f9dc3006ce9cd77df82e3942bf315dc911a0fe
+  data.tar.gz: 44872f2fe052f02eaef244303814a9e62123238d879c140c6ce29a7e010c4f77
 SHA512:
-  metadata.gz: 6d354a1299513afbfc555bd93f9d5a212d038a047f3da5d6c0a77061b2249ba64f130e623e533de6bc7546c1c01a6a1af76a8a098a939381878a0bbb79249342
-  data.tar.gz: '048eb40b6d05b93227d5c318cdb01594b2df688cb68dfde1c76e8019090281b12fc30b080e3c406a7355197e0d1b0d34e51dc07485efa174727753e39ce53f28'
+  metadata.gz: 4157653ae694c4c5c60a2dd203037cbc644792a8a32524d96864c71b785a072ce9e34776f5aad38ae390be7ce0be5588322a6a3a0a43e21688e741e5e7c0d6c3
+  data.tar.gz: 05537aca1745b016fef2660ed2693dfac117c3f3c1df85966549be0955fc57ca2a777c930f39f61dc8ce16e4262c2a8b2ec0a672accc41c8a7331d3042e30946

data/activerepresenter.gemspec

@@ -24,8 +24,8 @@ Gem::Specification.new do |s|
   s.test_files  = s.files.grep(/^test/)
 
   s.add_dependency "bundler", ">= 1.3"
-  s.add_dependency "activemodel", ">= 5.2", "< 6.1"
-  s.add_dependency "activesupport", ">= 5.2", "< 6.1"
+  s.add_dependency "activemodel", ">= 5.2", "< 6.2"
+  s.add_dependency "activesupport", ">= 5.2", "< 6.2"
   s.add_development_dependency "rake", ">= 12.3.3"
   s.add_development_dependency "test-unit", ">= 3.3"
 end

data/lib/active_representer/base.rb

@@ -4,69 +4,141 @@ 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_one:
+  #   Declare an associated object like has one association.
+  #   If a representer for the object is found, the object will be wrapped by the representer.
+  #   See examples: AttrOneTest in test/attr_one_test.
+  #
+  # attr_many:
+  #   Declare associated objects like has many association.
+  #   If a representer for the objects is found, the objects will be wrapped by the representer.
+  #   See examples: AttrCollectionTest in test/attr_collection_test.
   class Base
     include ActiveModel::Model
     include ActiveModel::Attributes
 
     attribute :wrapped
+    class_attribute :ones, default: {}
     class_attribute :collections, default: {}
 
     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
+    def self.inherited(subclass)
+      subclass.ones = {}
+      subclass.collections = {}
+    end
+
+    def self.wrap(wrapped)
+      instance = new
+      instance.wrapped = wrapped
+
+      one_names.each do |one_name|
+        next if wrapped[one_name].nil?
+        representer_klass = ones[one_name]
+        one_value = \
+          if representer_klass
+            representer_klass.wrap(wrapped[one_name])
+          else
+            wrapped[one_name]
+          end
+        instance.instance_variable_set("@#{one_name}", one_value)
       end
 
-      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_one(name, **options)
+      check_name_type(name)
+      representer_name = specify_or_guess_representer_name(options[:representer_name], name)
+
+      begin
+        representer = representer_name.constantize
+        ones[name.to_sym] = representer
+      rescue NameError
+        ones[name.to_sym] = nil
+      end
+
+      class_eval do
+        attr_reader name.to_sym
+      end
+    end
+
+    def self.attr_collection(name, **options)
+      check_name_type(name)
+      representer_name = specify_or_guess_representer_name(options[:representer_name], name)
+
+      begin
+        representer = representer_name.constantize
+        collections[name.to_sym] = representer
+      rescue NameError
+        collections[name.to_sym] = nil
       end
 
-      def attribute_names
-        attribute_types.keys - ["wrapped"]
+      class_eval do
+        attr_reader name.to_sym
       end
+    end
+
+    singleton_class.send(:alias_method, :attr_many, :attr_collection)
+
+    def self.one_names
+      ones.keys
+    end
+
+    def self.collection_names
+      collections.keys
+    end
 
-      def guess_representrer_name(name)
-        "#{name.singularize.camelize}Representer"
+    def self.attribute_names
+      attribute_types.keys - ["wrapped"]
+    end
+
+    def self.check_name_type(name)
+      unless name.is_a?(Symbol) || name.is_a?(String)
+        raise ArgumentError.new("collection's name must be a Symbol or a String")
       end
     end
+
+    def self.guess_representrer_name(name)
+      "#{name.singularize.camelize}Representer"
+    end
+
+    def self.specify_or_guess_representer_name(specified_name, wrapped_name)
+      specified_name ? specified_name.to_s : guess_representrer_name(wrapped_name.to_s)
+    end
   end
 end

data/test/attr_collection_test.rb

@@ -11,7 +11,7 @@ end
 
 class UserRepresenter < ActiveRepresenter::Base
   attr_collection :activities
-  attr_collection :notifications
+  attr_many :notifications
 
   def full_name
     "#{first_name} #{last_name}"
@@ -71,4 +71,14 @@ class AttrCollectionTest < Test::Unit::TestCase
     notification = representer.notifications.first
     assert_instance_of(OpenStruct, notification)
   end
+
+  test "representer class include :activities and :notifications in collection_names array" do
+    collection_names = UserRepresenter.collection_names
+    assert_equal(collection_names, [:activities, :notifications])
+  end
+
+  test "base class doesn't have any entries in collection_names array" do
+    collection_names = ActiveRepresenter::Base.collection_names
+    assert_equal(collection_names, [])
+  end
 end

data/test/attr_one_test.rb

@@ -0,0 +1,44 @@
+require "test/unit"
+require "ostruct"
+require "active_support/time"
+require_relative "../lib/active_representer/base.rb"
+
+class ProfileRepresenter < ActiveRepresenter::Base
+  def email_sent_on
+    email_sent_at.to_date
+  end
+end
+
+class UserRepresenter < ActiveRepresenter::Base
+  attr_one :profile
+end
+
+class AttrOneTest < Test::Unit::TestCase
+  test "profile is represented" do
+    user = OpenStruct.new(
+      profile: OpenStruct.new(email_sent_at: Time.now)
+    )
+    representer = UserRepresenter.wrap(user)
+    profile = representer.profile
+    assert_instance_of(ProfileRepresenter, profile)
+  end
+
+  test "profile.email_sent_on is Date.today" do
+    user = OpenStruct.new(
+      profile: OpenStruct.new(email_sent_at: Time.now)
+    )
+    representer = UserRepresenter.wrap(user)
+    profile = representer.profile
+    assert_equal(profile.email_sent_on, Date.today)
+  end
+
+  test "representer class include profile in one_names array" do
+    one_names = UserRepresenter.one_names
+    assert_equal(one_names, [:profile])
+  end
+
+  test "base class doesn't include profile in one_names array" do
+    one_names = ActiveRepresenter::Base.one_names
+    assert_equal(one_names, [])
+  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.5
 platform: ruby
 authors:
 - Ryo Hashimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -33,7 +33,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +105,7 @@ files:
 - lib/activerepresenter.rb
 - test/attr_collection_test.rb
 - test/attr_field_test.rb
+- test/attr_one_test.rb
 - test/base_test.rb
 - test/inheritance_test.rb
 homepage: https://github.com/ryohashimoto/lightrails
@@ -126,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Active Representer provides model objects by decorating objects (part of
@@ -134,5 +135,6 @@ summary: Active Representer provides model objects by decorating objects (part o
 test_files:
 - test/attr_collection_test.rb
 - test/attr_field_test.rb
+- test/attr_one_test.rb
 - test/base_test.rb
 - test/inheritance_test.rb