presentability 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5b0aae4df8ff0ef130bbcc9704f2f44a9b109dee48cc530db6abdfd0733cbd4
-  data.tar.gz: d149966c13d352f89c2f437c8ed251d63520ec33287c920e8ff7c1cd43eeb0e4
+  metadata.gz: ff4d9944824eaaa9ef6bc0d5e2b02879e83c481f2db9a39fe6c6ebc6f947dd7f
+  data.tar.gz: 4ccd0e65bdaae2504bf6edad1df4aab25698d5290b740028c5f5dc7c78732302
 SHA512:
-  metadata.gz: 906172259081cb4c871975c6e8096bfcd7d8a2434903cc8bef9562b9b18c11af889ef1733372d46c94420008baf5821499d19e6708c75224abd962febabc0515
-  data.tar.gz: 5d2c5691ee59ba2526755a3a2eab49547d093fa1d2fbedad4163a78ea35b8acc4dc74d20f0e16a90d7b9af3cbedd9a043c68f3b402f8197ea40031984fc4773b
+  metadata.gz: cae40ce72cd721000c47cff537ba2a2ac6635fc27205f79d81548471efda66b499c9aadd8eab97049a457dbd1c784e20ec5cd01805a57c511e1da808517c5ab8
+  data.tar.gz: 73ccbe66aeeed78447ae7cb91a0bb9cdbe95325d834e6fcfc6baaa4c96103cfb03efa4ef55f3718098ad021f211c17d5365f2e528b0dc5e846570ff6bec3407d

data/History.md

@@ -1,6 +1,14 @@
 # Release History for presentability
 
 ---
+## v0.3.0 [2022-12-16] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Rework to use a more flexible exposure mechanism
+  - Allows `nil` and `false` as exposed values
+  - Allows declaring an exposure with a block
+
 
 ## v0.2.0 [2022-12-06] Michael Granger <ged@faeriemud.org>
 

data/lib/presentability/presenter.rb

@@ -69,14 +69,50 @@ class Presentability::Presenter
 
 	### Set up an exposure that will delegate to the attribute of the subject with
 	### the given +name+.
-	def self::expose( name, **options )
+	def self::expose( name, **options, &block )
+		name = name.to_sym
 		options = DEFAULT_EXPOSURE_OPTIONS.merge( options )
 
-		self.log.debug "Setting up exposure %p %p" % [ name, options ]
+		self.define_method( name, &block ) if block
+
+		unless self.instance_methods( true ).include?( name )
+			method_body = self.generate_expose_method( name, **options )
+			define_method( name, &method_body )
+		end
+
+		self.log.debug "Setting up exposure %p, options = %p" % [ name, options ]
 		self.exposures[ name ] = options
 	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 )
+		self.log.debug "Generating a default delegation exposure method for %p" % [ name ]
+		return lambda do
+			return self.subject.send( __method__ )
+		end
+	end
+
+
+	### Method definition hook -- hook up new methods with the same name as an exposure
+	### to its :call option.
+	def self::method_added( method_name )
+		super
+
+		return unless self.exposures
+
+		if self.exposures.key?( method_name )
+			self.log.debug "Exposing %p via a new presenter method." % [ method_name ]
+			self.exposures[ method_name ][ :call ] = self.instance_method( method_name )
+		end
+	end
+
+
+	#
+	# Instance methods
+	#
+
 	### Create a new Presenter for the given +subject+.
 	def initialize( subject, options={} )
 		@subject = subject
@@ -104,11 +140,7 @@ class Presentability::Presenter
 
 		self.class.exposures.each do |name, exposure_options|
 			next if self.skip_exposure?( name )
-
-			value = self.expose_via_delegation( name, exposure_options ) ||
-				self.expose_via_presenter_method( name, exposure_options ) or
-				raise NoMethodError, "can't expose %p -- no such attribute exists" % [name]
-
+			value = self.method( name ).call
 			result[ name.to_sym ] = value
 		end
 
@@ -143,27 +175,5 @@ class Presentability::Presenter
 	end
 
 
-	### Attempt to expose the attribute with the given +name+ via delegation to the
-	### subject's method of the same name. Returns +nil+ if no such method exists.
-	def expose_via_delegation( name, options={} )
-		self.log.debug "Trying to expose %p via delegation to %p" % [ name, self.subject ]
-
-		return nil unless self.subject.respond_to?( name )
-
-		return self.subject.send( name )
-	end
-
-
-	### Attempt to expose the attribute with the given +name+ via a method on the presenter
-	### of the same name. Returns +nil+ if no such method exists.
-	def expose_via_presenter_method( name, options={} )
-		self.log.debug "Trying to expose %p via presenter method" % [ name ]
-
-		return nil unless self.respond_to?( name )
-
-		meth = self.method( name )
-		return meth.call
-	end
-
 end # class Presentability::Presenter
 

data/lib/presentability.rb

@@ -72,7 +72,7 @@ module Presentability
 
 
 	# Package version
-	VERSION = '0.2.0'
+	VERSION = '0.3.0'
 
 
 	# Automatically load subordinate components

data/spec/presentability_spec.rb

@@ -37,14 +37,22 @@ RSpec.describe Presentability do
 				@lastname = lastname
 				@email = email
 				@password = password
+				@is_admin = false
 			end
 
-			attr_accessor :firstname, :lastname, :email, :password
+			attr_accessor :firstname, :lastname, :email, :password, :is_admin
 		end
 	end
 
 	let( :entity_instance ) { entity_class.new }
-	let( :other_entity_instance ) { entity_class.new }
+	let( :other_entity_instance ) do
+		other_entity_class.new(
+			Faker::Name.first_name,
+			Faker::Name.last_name,
+			Faker::Internet.email,
+			Faker::Internet.password
+		)
+	end
 
 
 	describe "an extended module" do
@@ -75,7 +83,7 @@ RSpec.describe Presentability do
 		end
 
 
-		it "can effect more complex exposures be declaring presenter methods" do
+		it "can define more complex exposures by declaring presenter methods" do
 			extended_module.presenter_for( entity_class ) do
 				expose :foo
 				expose :bar
@@ -91,6 +99,56 @@ RSpec.describe Presentability do
 		end
 
 
+		it "calls an exposure's block if it has one" do
+			extended_module.presenter_for( entity_class ) do
+				expose :foo
+				expose :bar
+				expose :id do
+					self.subject.object_id
+				end
+			end
+
+			expect( extended_module.present(entity_instance) ).
+				to eq({ foo: 1, bar: 'two', id: entity_instance.object_id })
+		end
+
+
+		it "exposes `false' values correctly" do
+			extended_module.presenter_for( other_entity_class ) do
+				expose :firstname
+				expose :lastname
+				expose :email
+				expose :is_admin
+			end
+
+			other_entity_instance.is_admin = false
+
+			expect( extended_module.present(other_entity_instance) ).to eq({
+				firstname: other_entity_instance.firstname,
+				lastname: other_entity_instance.lastname,
+				email: other_entity_instance.email,
+				is_admin: false
+			})
+		end
+
+
+		it "exposes `nil' values correctly" do
+			extended_module.presenter_for( other_entity_class ) do
+				expose :firstname
+				expose :lastname
+				expose :email
+			end
+
+			other_entity_instance.email = nil
+
+			expect( extended_module.present(other_entity_instance) ).to eq({
+				firstname: other_entity_instance.firstname,
+				lastname: other_entity_instance.lastname,
+				email: nil
+			})
+		end
+
+
 		it "can be made conditional on an option being set" do
 			extended_module.presenter_for( entity_class ) do
 				expose :foo
@@ -119,10 +177,11 @@ RSpec.describe Presentability do
 
 			expect {
 				extended_module.present( entity_instance )
-			}.to raise_error( NoMethodError, /can't expose :id -- no such attribute exists/i )
+			}.to raise_error( NoMethodError, /undefined method `id'/i )
 		end
 
 
+
 		describe "collection handling" do
 
 			it "can present a collection" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: presentability
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Granger
@@ -33,7 +33,7 @@ cert_chain:
   P5YP5BAbNW+gvd3QHRiWTTuhgHrdDnGdXg93N2M5KHn1ug8BtPLQwlcFwEpKnlLn
   btEP+7EplFuoiMfd
   -----END CERTIFICATE-----
-date: 2022-12-06 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -69,28 +69,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
-  name: rdoc-generator-fivefish
+  name: rdoc-generator-sixfish
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.2'
 description: Facade-based presenters with minimal assumptions. This library contains
   utilities for setting up presenters for data classes for things like web services,
   logging output, etc.