presentability 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67ea66c2c975ecb5064c9ddb9c0be1a203b0e9e9944dfc3f3821f07e360fc726
-  data.tar.gz: c13fdaccf960dc87d3feaed73e2a22a96ad805aed83cadbadeeee9cc60e80e49
+  metadata.gz: c1802a45773fa3f0e4662926ae1067ae729e81b88201437f7e4bf9705ceac5ec
+  data.tar.gz: c0dedfb32ced019e2105b4434816610598f5f7b560ffab7353144955b9f4a9f3
 SHA512:
-  metadata.gz: 550a710c7ae589dfc6ebb1ed801508c8e2d347dbd37e1cdd19e3f3699b5b203ad38b7f2dc6a917e71d3e3dd3711e4eefe8c01594a1f4d92f10b120c4fe1e0a82
-  data.tar.gz: 07d9674d3ad188b6b19923153accddf6175bf61d238d79867b7237a34a10595e066e10f4d37cc702bbcca8b7dcf65fd7df75ad0eb2fa0c4557716be3a370090b
+  metadata.gz: c3c3eb84c0c800517b515defb1b8717f1f940d4c582cb63baf5f7689df9aeb47d63a956f997ba64238301f1db88447cffff972a23faa3fad0026b37b3a0b872b
+  data.tar.gz: 9305b383f0f617186e27411fd153a0aa65b430ae96264c70bc3cc6b9ba99e4d9da77a4e817a9cb2e0870be2c057ed17249a6fad5c1fdd4985edb94b3b4232d3e

data/History.md

@@ -1,6 +1,14 @@
 # Release History for presentability
 
 ---
+## v0.5.0 [2023-11-06] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Add recursive presentation
+- Allow presenters to be defined for objects with no instance variables
+
+
 ## v0.4.0 [2023-02-02] Michael Granger <ged@faeriemud.org>
 
 Improvements:

data/lib/presentability/presenter.rb

@@ -57,6 +57,14 @@ class Presentability::Presenter
 	end
 
 
+	### Set up an exposure of a collection with the given +name+. This means it will
+	### have the :in_collection option set by default.
+	def self::expose_collection( name, **options, &block )
+		options = options.merge( unless: :in_collection )
+		self.expose( name, **options, &block )
+	end
+
+
 	### Generate the body an exposure method that delegates to a method with the
 	### same +name+ on its subject.
 	def self::generate_expose_method( name, **options )
@@ -107,12 +115,14 @@ class Presentability::Presenter
 
 
 	### Apply the exposures to the subject and return the result.
-	def apply
+	def apply( presenters )
 		result = self.empty_representation
 
 		self.class.exposures.each do |name, exposure_options|
 			next if self.skip_exposure?( name )
 			value = self.method( name ).call
+			value = presenters.present( value, **exposure_options ) unless
+				value.is_a?( result.class )
 			key = exposure_options.key?( :as ) ? exposure_options[:as] : name
 			result[ key.to_sym ] = value
 		end

data/lib/presentability.rb

@@ -9,7 +9,7 @@ module Presentability
 
 
 	# Package version
-	VERSION = '0.4.0'
+	VERSION = '0.5.0'
 
 
 	# Automatically load subordinate components
@@ -41,8 +41,15 @@ module Presentability
 	### Return a representation of the +object+ by applying a declared presentation.
 	def present( object, **options )
 		representation = self.present_by_class( object, **options ) ||
-			self.present_by_classname( object, **options ) or
-			raise NoMethodError, "no presenter found for %p" % [ object ]
+			self.present_by_classname( object, **options )
+
+		unless representation
+			if object.instance_variables.empty?
+				return object
+			else
+				raise NoMethodError, "no presenter found for %p" % [ object ]
+			end
+		end
 
 		return representation
 	end
@@ -66,7 +73,7 @@ module Presentability
 		presenter_class = self.presenters[ object.class ] or return nil
 		presenter = presenter_class.new( object, **presentation_options )
 
-		return presenter.apply
+		return presenter.apply( self )
 	end
 
 
@@ -77,7 +84,7 @@ module Presentability
 		presenter_class = self.presenters[ classname ] or return nil
 		presenter = presenter_class.new( object, **presentation_options )
 
-		return presenter.apply
+		return presenter.apply( self )
 	end
 
 end # module Presentability

data/spec/presentability/presenter_spec.rb

@@ -9,7 +9,18 @@ require 'presentability/presenter'
 RSpec.describe( Presentability::Presenter ) do
 
 	let( :presenter_subject ) do
-		OpenStruct.new( country: 'Philippines', export: 'Copper', flower: 'Sampaguita' )
+		OpenStruct.new(
+			country: 'Philippines',
+			export: 'Copper',
+			flower: 'Sampaguita',
+			cities: ['Quezon City', 'Cagayan de Oro', 'Roxas']
+		)
+	end
+
+	let( :presenters ) do
+		mod = Module.new
+		mod.extend( Presentability )
+		return mod
 	end
 
 
@@ -27,7 +38,7 @@ RSpec.describe( Presentability::Presenter ) do
 
 		it "can be created with just a subject" do
 			presenter = subclass.new( presenter_subject )
-			expect( presenter.apply ).to eq( {} )
+			expect( presenter.apply(presenters) ).to eq( {} )
 		end
 
 
@@ -35,7 +46,7 @@ RSpec.describe( Presentability::Presenter ) do
 			subclass.expose( :country )
 			presenter = subclass.new( presenter_subject )
 
-			expect( presenter.apply ).to eq({ country: 'Philippines' })
+			expect( presenter.apply(presenters) ).to eq({ country: 'Philippines' })
 		end
 
 
@@ -47,9 +58,9 @@ RSpec.describe( Presentability::Presenter ) do
 			financial_presenter = subclass.new( presenter_subject, financial: true )
 			cultural_presenter = subclass.new( presenter_subject, financial: false )
 
-			expect( financial_presenter.apply ).
+			expect( financial_presenter.apply(presenters) ).
 				to eq({ country: 'Philippines', export: 'Copper' })
-			expect( cultural_presenter.apply ).
+			expect( cultural_presenter.apply(presenters) ).
 				to eq({ country: 'Philippines', flower: 'Sampaguita' })
 		end
 
@@ -86,6 +97,14 @@ RSpec.describe( Presentability::Presenter ) do
 		end
 
 
+		it "can expose an attribute as a collection" do
+			subclass.expose( :country )
+			subclass.expose_collection( :cities )
+
+			expect( subclass.exposures[:cities] ).to include( unless: :in_collection )
+		end
+
+
 		it "has useful #inspect output" do
 			presenter = subclass.new( presenter_subject )
 			expect( presenter.inspect ).to match( /Presentability::Presenter\S+ for /i )

data/spec/presentability_spec.rb

@@ -43,6 +43,23 @@ RSpec.describe Presentability do
 		end
 	end
 
+	let( :complex_entity_class ) do
+		Class.new do
+			def self::name
+				return 'Acme::Pair'
+			end
+
+			def initialize( user:, entity:, overridden: false, locked: true )
+				@user = user
+				@entity = entity
+				@overridden = overridden
+				@locked = locked
+			end
+
+			attr_accessor :user, :entity, :overridden, :locked
+		end
+	end
+
 	let( :entity_instance ) { entity_class.new }
 	let( :other_entity_instance ) do
 		other_entity_class.new(
@@ -52,6 +69,9 @@ RSpec.describe Presentability do
 			Faker::Internet.password
 		)
 	end
+	let( :complex_entity_instance ) do
+		complex_entity_class.new( user: other_entity_instance, entity: entity_instance )
+	end
 
 
 	describe "when used to extend a module" do
@@ -162,6 +182,42 @@ RSpec.describe Presentability do
 		end
 
 
+		it "doesn't try to present objects with no instance variables by default" do
+			object = 'a string'
+			expect( extended_module.present(object) ).to be( object )
+
+			object = 8
+			expect( extended_module.present(object) ).to be( object )
+
+			object = :a_symbol
+			expect( extended_module.present(object) ).to be( object )
+
+			object = Time.now
+			expect( extended_module.present(object) ).to be( object )
+
+			object = %[an array of strings]
+			expect( extended_module.present(object) ).to be( object )
+
+			object = Object.new
+			expect( extended_module.present(object) ).to be( object )
+		end
+
+
+		it "allows presenters to be defined for objects with no instance variables" do
+			extended_module.presenter_for( Time ) do
+				expose :sec
+				expose :usec
+			end
+
+			object = Time.at( 1699287281.336554 )
+
+			expect( extended_module.present(object) ).to eq({
+				sec: object.sec,
+				usec: object.usec
+			})
+		end
+
+
 		it "errors usefully if asked to present an object it knows nothing about" do
 			expect {
 				extended_module.present( entity_instance )
@@ -230,7 +286,7 @@ RSpec.describe Presentability do
 			end
 
 
-			it "handles a hetergeneous collection" do
+			it "handles a heterogeneous collection" do
 				extended_module.presenter_for( entity_class ) do
 					expose :foo
 					expose :bar
@@ -307,6 +363,43 @@ RSpec.describe Presentability do
 
 		end
 
+
+		describe "and used to present a complex object" do
+
+			it "uses registered presenters for sub-objects" do
+				extended_module.presenter_for( entity_class ) do
+					expose :foo
+					expose :bar
+				end
+				extended_module.presenter_for( other_entity_class ) do
+					expose :firstname
+					expose :lastname
+					expose :email
+				end
+				extended_module.presenter_for( complex_entity_class ) do
+					expose :user
+					expose :entity
+					expose :locked
+				end
+
+				result = extended_module.present( complex_entity_instance )
+
+				expect( result ).to eq({
+					user: {
+						firstname: other_entity_instance.firstname,
+						lastname: other_entity_instance.lastname,
+						email: other_entity_instance.email,
+					},
+					entity: {
+						foo: entity_instance.foo,
+						bar: entity_instance.bar
+					},
+					locked: complex_entity_instance.locked,
+				})
+			end
+
+		end
+
 	end
 
 end

data.tar.gz.sig

@@ -1,3 +1 @@
-"�Y�i��$ua_ZV�������j�KoVp
-j{�����:g�#�O��f��?�;:TK��dF�J�ՂaS�]	��_;����[�Ս��Z�-B����
-շ�`���%`�_�Ԃ8lqM�|Y� ����3��b? 3���Dixŗ����B�{�n��+��9��vas��	:�0��1�O�sM7�9�*+N��A�����!�T�#C�џ5nd�a�g�]:����j��QV��*�_�#Q�d��}o5���a;iIO���!�j�8�
+�B6s��m�{����Μ��'�*'7�tD�!�&CI&��57|�Me�aU®��|!��@~9�"z-��Xz�4[(�M������^Z��������s&�ˀ��|�]��C��fʰ�%_�ߦ�"rz4ER��l�݃G�T�<"��E���滌6ڠ��#J]';kh�9e���V�R=.�`:�d�T��>z�k5m�/�h��ak�FV3�!ʢ�`�w�rued-���~��ן�
�(=��H*���8j�AU��_���Tw�i�v���G�.��dDW����˵����E���L-�7���_�Ӷ���-��𹐪�}���_�}�Hb"��4d%WR�.,д����S��vt�������J���KR�r��

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: presentability
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Michael Granger
@@ -33,7 +33,7 @@ cert_chain:
   WmEdESlpWhzFECctefIF2lsN9vaOuof57RM77t2otrtcscDtNarIqjZsIyqtDvtL
   DttITiit0Vwz7bY0
   -----END CERTIFICATE-----
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Facade-based presenters with minimal assumptions.