magic-presenter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04a88e0f222913a774946299ef036231cb1628baaa980111b5bb058cb77f69a4
-  data.tar.gz: 9a5d28343913ebae389a941153d49d6c3d04acb2e6e61891ada49404a2e1d49f
+  metadata.gz: 17e4d44c0c2d9a9e09e7e099a4067b9e6aafe27e1b389cf01808ed0a77d0b9ae
+  data.tar.gz: 7d492486c2f4edb2407af461794e1f0c7e53c7f6b93e65595a618369fb845250
 SHA512:
-  metadata.gz: 0a572d9c94e5b75cb65c23e029d524f19d48457d1ea57bf6185d4ed463757296c2917d77e7210ab67021347b111136e34c1cbcdb15ae47c6d67445623ff13508
-  data.tar.gz: 41c4b6afee8ffb1b89aedbba4f619d94ddc04d3c4201afa6ae7c34fec7d1fe52a746eb3fc29463d316fc446c4e1a7b9458395c473c18af02b388caae0f2dabaa
+  metadata.gz: fb2609c3dbba1cec025bca22aaa196c718b32084b2954b8184f9b5ce896e7a9289c0b7eb0660469edaf3571d27d99026f6e588f58004e395cee07a75820e38d7
+  data.tar.gz: 1a87908713cb7dbcb029687dd1d4b9006432e8ba9703ef1dbe813088060c471ada70f8d7d1f5de4cdc9210ba602bd0457b1bf061f6fd3d9a25c5a420003198e0

data/README.md

@@ -103,6 +103,12 @@ When in doubt, one can use `Magic::Presenter.name_for`:
 Magic::Presenter.name_for Person # => "PersonPresenter"
 ```
 
+### In views
+
+> [!IMPORTANT]
+> Every object passed to views is decorated automagically.
+> This involves both implicit instance variables and `locals` passed explicitly.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/{lib → app/models/concerns}/magic/presentable.rb

@@ -7,6 +7,14 @@ module Magic
 	module Presentable
 		include Decoratable
 
+		class << self
+			def classes
+				Magic.eager_load :models
+
+				super
+			end
+		end
+
 		private
 
 		def decorator_base = Presenter

data/config/initializers/action_view.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+ActiveSupport.on_load :action_view do
+	concerning :DecoratedAssignments, prepend: true do
+		def assign(assignments, ...)
+			assignments
+					.transform_values! &:decorated
+
+			super
+		end
+
+		def _run(method, template, locals, ...)
+			locals
+					.transform_values! &:decorated
+
+			super
+		end
+	end
+end

data/lib/magic/presenter/base.rb

@@ -17,6 +17,8 @@ module Magic
 		# If not found, it looks for presenters of its ancestor classes,
 		# up to `ObjectPresenter`.
 		class Base < Decorator::Base
+			include GlobalID if defined? ::GlobalID
+
 			class << self
 				def name_for object_class
 					object_class
@@ -25,6 +27,23 @@ module Magic
 							.delete_suffix('Record')
 							.then { "#{_1}Presenter" }
 				end
+
+				def model_class
+					Presentable.classes
+							.select { Presenter.for(_1) == self }
+							.sole
+				rescue Enumerable::SoleItemExpectedError => error
+					raise Lookup::Error, "#{error.message
+							.sub('items', 'model classes')
+							.sub('item',  'model class')
+					} for #{self}"
+				end
+
+				def descendants
+					Magic.eager_load :presenters
+
+					super
+				end
 			end
 		end
 	end

data/lib/magic/presenter/global_id.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Magic
+	module Presenter
+		# = Active Job integration
+		#
+		# Active Job [accepts Active Record objects](
+		# 	http://edgeguides.rubyonrails.org/active_job_basics.html#globalid
+		# ).
+		# An object passed to a background job must implement [Global ID](
+		# 	https://github.com/rails/globalid
+		# ).
+		#
+		# This module implements Global ID for decorated models by defining
+		# `.find` method that uses the one from a model class and decorates
+		# the result.
+		# This means one can pass decorated objects to background jobs and
+		# get them decorated when deserialized.
+		module GlobalID
+			extend ActiveSupport::Concern
+
+			included do
+				include ::GlobalID::Identification
+			end
+
+			class_methods do
+				def find(...)
+					model_class
+							.find(...)
+							.decorated
+				end
+			end
+		end
+	end
+end

data/lib/magic/presenter/version.rb

@@ -2,6 +2,6 @@
 
 module Magic
 	module Presenter
-		VERSION = '0.2.0'
+		VERSION = '0.3.0'
 	end
 end

data/lib/magic/presenter.rb

@@ -6,11 +6,10 @@ require_relative 'presenter/version'
 require_relative 'presenter/engine'
 
 module Magic # :nodoc:
-	autoload :Presentable, 'magic/presentable'
-
 	# Presentation layer for Rails models
 	module Presenter
 		autoload :Base,      'magic/presenter/base'
+		autoload :GlobalID,  'magic/presenter/global_id'
 		autoload :Generator, 'generators/magic/presenter/generator'
 
 		module_function
@@ -18,4 +17,17 @@ module Magic # :nodoc:
 		def for(...)      = Base.for(...)
 		def name_for(...) = Base.name_for(...)
 	end
+
+	module_function
+
+	def eager_load *scopes
+		return if Rails.application.config.eager_load
+
+		scopes
+				.map(&:to_s)
+				.map(&:pluralize)
+				.map { Rails.root / 'app' / _1 }
+				.select(&:exist?)
+				.each { Rails.autoloaders.main.eager_load_dir _1 }
+	end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: magic-presenter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexander Senko
 bindir: bin
 cert_chain: []
-date: 2024-10-26 00:00:00.000000000 Z
+date: 2024-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -33,16 +33,16 @@ dependencies:
   name: magic-decorator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0.alpha
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0.alpha
+        version: '0.3'
 description: Based on Magic Decorator, it’s meant to replace Draper.
 email:
 - Alexander.Senko@gmail.com
@@ -53,7 +53,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- config/initializers/loading.rb
+- app/models/concerns/magic/presentable.rb
+- config/initializers/action_view.rb
 - config/initializers/presentable.rb
 - config/initializers/rspec.rb
 - lib/generators/magic/presenter/generator.rb
@@ -67,11 +68,11 @@ files:
 - lib/generators/rspec/presenter/templates/presenter_spec.rb.tt
 - lib/generators/test_unit/presenter/presenter_generator.rb
 - lib/generators/test_unit/presenter/templates/presenter_test.rb.tt
-- lib/magic/presentable.rb
 - lib/magic/presenter.rb
 - lib/magic/presenter/authors.rb
 - lib/magic/presenter/base.rb
 - lib/magic/presenter/engine.rb
+- lib/magic/presenter/global_id.rb
 - lib/magic/presenter/version.rb
 - lib/tasks/magic/presenter_tasks.rake
 homepage: https://github.com/Alexander-Senko/magic-presenter
@@ -80,7 +81,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Alexander-Senko/magic-presenter
   source_code_uri: https://github.com/Alexander-Senko/magic-presenter
-  changelog_uri: https://github.com/Alexander-Senko/magic-presenter/blob/v0.2.0/CHANGELOG.md
+  changelog_uri: https://github.com/Alexander-Senko/magic-presenter/blob/v0.3.0/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib

data/config/initializers/loading.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-Rails.application.config.to_prepare do
-	[ Rails.root / 'app/presenters' ]
-			.select(&:exist?)
-			.each { Rails.autoloaders.main.eager_load_dir _1 }
-end unless Rails.application.config.eager_load