presentability 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0b10ef3f8fba6959cfd51db2efee95b4df669863b1ef433656da03573d61f07
-  data.tar.gz: beefa821c8f69d2038a992d4064b08429202100a6a9b139bc4427247f31f47c1
+  metadata.gz: f5b0aae4df8ff0ef130bbcc9704f2f44a9b109dee48cc530db6abdfd0733cbd4
+  data.tar.gz: d149966c13d352f89c2f437c8ed251d63520ec33287c920e8ff7c1cd43eeb0e4
 SHA512:
-  metadata.gz: 5b2974973651bc54624dbca03bd89d841dd4aab00dcdc72f38ada1a40bb626b7096d78c2fd917b31c45af99d5771d0d935ce751da473ec8ef93e9dff2b01876d
-  data.tar.gz: 874444891db074bd26600f61bdacea937b75553616e541c6b50f0c69f0e888c2c5f437895da5d4bb5df5ca0dec849f73848f27230076e8883aec1ef30378393b
+  metadata.gz: 906172259081cb4c871975c6e8096bfcd7d8a2434903cc8bef9562b9b18c11af889ef1733372d46c94420008baf5821499d19e6708c75224abd962febabc0515
+  data.tar.gz: 5d2c5691ee59ba2526755a3a2eab49547d093fa1d2fbedad4163a78ea35b8acc4dc74d20f0e16a90d7b9af3cbedd9a043c68f3b402f8197ea40031984fc4773b

data/History.md

@@ -2,6 +2,13 @@
 
 ---
 
+## v0.2.0 [2022-12-06] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Add collection presentation.
+
+
 ## v0.1.0 [2022-08-11] Michael Granger <ged@faeriemud.org>
 
 Initial release.

data/lib/presentability.rb

@@ -54,6 +54,13 @@ require 'loggability'
 # (the "subject"), and then applying it:
 #
 # ```ruby
+# acme_widget = Acme::Widget.new(
+#   sku: "FF-2237H455",
+#   name: "Throbbing Frobnulator",
+#   unit_price: 299,
+#   inventory_count: 301,
+#   wholesale_cost: 39
+# )
 # presenter = Acme::Presenters.present( acme_widget )
 # presenter.apply
 # # => { :sku => "FF-2237H455", :name => "Throbbing Frobnulator", :unit_price => 299 }
@@ -65,7 +72,7 @@ module Presentability
 
 
 	# Package version
-	VERSION = '0.1.0'
+	VERSION = '0.2.0'
 
 
 	# Automatically load subordinate components
@@ -104,6 +111,13 @@ module Presentability
 	end
 
 
+	### Return an Array of all representations of the members of the
+	### +collection+ by applying a declared presentation.
+	def present_collection( collection, **options )
+		return collection.map {|object| self.present(object, **options) }
+	end
+
+
 	#########
 	protected
 	#########

data/spec/presentability_spec.rb

@@ -3,6 +3,7 @@
 
 require_relative 'spec_helper'
 
+require 'faker'
 require 'rspec'
 require 'presentability'
 
@@ -15,17 +16,35 @@ RSpec.describe Presentability do
 				return 'Acme::Entity'
 			end
 
-			def initialize
-				@foo = 1
-				@bar = 'two'
-				@baz = :three
+			def initialize( foo: 1, bar: 'two', baz: :three )
+				@foo = foo
+				@bar = bar
+				@baz = baz
 			end
 
 			attr_accessor :foo, :bar, :baz
 		end
 	end
 
+	let( :other_entity_class ) do
+		Class.new do
+			def self::name
+				return 'Acme::User'
+			end
+
+			def initialize( firstname, lastname, email, password )
+				@firstname = firstname
+				@lastname = lastname
+				@email = email
+				@password = password
+			end
+
+			attr_accessor :firstname, :lastname, :email, :password
+		end
+	end
+
 	let( :entity_instance ) { entity_class.new }
+	let( :other_entity_instance ) { entity_class.new }
 
 
 	describe "an extended module" do
@@ -103,6 +122,87 @@ RSpec.describe Presentability do
 			}.to raise_error( NoMethodError, /can't expose :id -- no such attribute exists/i )
 		end
 
+
+		describe "collection handling" do
+
+			it "can present a collection" do
+				extended_module.presenter_for( entity_class ) do
+					expose :foo
+					expose :bar
+				end
+				collection = 5.times.map do
+					entity_class.new( foo: rand(100) )
+				end
+
+				results = extended_module.present_collection( collection )
+
+				expect( results ).to have_attributes( length: 5 )
+				results.each do |representation|
+					expect( representation ).to include( :foo, :bar )
+					expect( representation ).to_not include( :baz )
+				end
+			end
+
+
+			it "can present a mixed collection" 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
+
+				collection = 5.times.flat_map do
+					[
+						entity_class.new( foo: rand(100) ),
+						other_entity_class.new(
+							Faker::Name.first_name,
+							Faker::Name.last_name,
+							Faker::Internet.email,
+							Faker::Internet.password
+						)
+					]
+				end
+
+				results = extended_module.present_collection( collection )
+
+				expect( results ).to have_attributes( length: 10 )
+				results.each do |representation|
+					expect( representation ).to include( :foo, :bar ).
+						or( include(:firstname, :lastname, :email) )
+					expect( representation ).to_not include( :baz )
+					expect( representation ).to_not include( :password )
+				end
+			end
+
+
+			it "passes options to the individual presenters" do
+				extended_module.presenter_for( entity_class ) do
+					expose :foo
+					expose :bar, if: :include_bar
+				end
+				collection = 5.times.map do
+					entity_class.new( foo: rand(100) )
+				end
+
+				results = extended_module.present_collection( collection )
+				results.each do |representation|
+					expect( representation ).to include( :foo )
+					expect( representation ).to_not include( :bar, :baz )
+				end
+
+				results = extended_module.present_collection( collection, include_bar: true )
+				results.each do |representation|
+					expect( representation ).to include( :foo, :bar )
+					expect( representation ).to_not include( :baz )
+				end
+			end
+
+		end
+
 	end
 
 end

data/spec/spec_helper.rb

@@ -4,6 +4,11 @@
 require 'simplecov' if ENV['COVERAGE']
 
 require 'rspec'
+require 'i18n'
+require 'faker'
+
+Faker::Config.locale = 'en'
+I18n.reload!
 
 require 'loggability/spechelpers'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: presentability
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Granger
@@ -33,7 +33,7 @@ cert_chain:
   P5YP5BAbNW+gvd3QHRiWTTuhgHrdDnGdXg93N2M5KHn1ug8BtPLQwlcFwEpKnlLn
   btEP+7EplFuoiMfd
   -----END CERTIFICATE-----
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -49,6 +49,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake-deveiate
   requirement: !ruby/object:Gem::Requirement