magic-presenter 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04a88e0f222913a774946299ef036231cb1628baaa980111b5bb058cb77f69a4
-  data.tar.gz: 9a5d28343913ebae389a941153d49d6c3d04acb2e6e61891ada49404a2e1d49f
+  metadata.gz: 8ca84b456b21332f6eeba63a5667ed1c8cf7ac97d59141192f138d1698c504bf
+  data.tar.gz: c380ea14f2ddd44150ae71095063e895486d33077521fe1067fca81d4c4b36b0
 SHA512:
-  metadata.gz: 0a572d9c94e5b75cb65c23e029d524f19d48457d1ea57bf6185d4ed463757296c2917d77e7210ab67021347b111136e34c1cbcdb15ae47c6d67445623ff13508
-  data.tar.gz: 41c4b6afee8ffb1b89aedbba4f619d94ddc04d3c4201afa6ae7c34fec7d1fe52a746eb3fc29463d316fc446c4e1a7b9458395c473c18af02b388caae0f2dabaa
+  metadata.gz: 728dbf1b11115069bb58bfb47c81258f358d22c3570c35dc4a5e7e4d9429a2fa5a6dc3237d0ef0e6a0442d88ca7e9b405e481bd5ea2da90c618800593c8f5155
+  data.tar.gz: f014751ea9cf0470fd1387f25f63b56291a63a434abd177ca0e1aaab27ba1d9a4da4e590354b729fcd12a40fa19f125866daedfba4bd904f37e8d48b3c281ea6

data/README.md

@@ -68,6 +68,35 @@ See the help for more info:
 
 	$ bin/rails generate presenter --help
 
+### View helpers
+
+A presenter can use any helpers via `#helpers` (aliased as `#h`) both in class and instance methods:
+
+```ruby
+class PersonPresenter < Magic::Presenter::Base
+  def self.links
+    [ h.link_to('All', model_class) ]
+  end
+  
+  def link(...) 
+    helpers.link_to(name, self, ...)
+  end
+end
+```
+
+A view context must be set to enable helpers.
+It’s done automagically [wherever possible](#helpers).
+However, one can set it explicitly anywhere:
+
+```ruby
+Magic::Presenter.with view_context: ApplicationController.new.view_context do
+  # put the code that uses helpers within presenters here
+end
+```
+
+> [!NOTE]
+> A valid `request` may be needed for URL helpers to get host info.
+
 ## 🧙 Magic
 
 It’s based on [Magic Decorator](
@@ -103,6 +132,19 @@ 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.
+
+### Helpers
+
+View context is set automagically to enable helpers:
+- in views,
+- in controller actions,
+- in mailer actions.
+
 ## 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_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+presenter_context = proc do
+	around_action :set_presenter_context
+
+	private
+
+	def set_presenter_context(&)
+		Magic::Presenter.with view_context:, &
+	end
+end
+
+ActiveSupport.on_load :action_controller, &presenter_context
+ActiveSupport.on_load :action_mailer,     &presenter_context

data/config/initializers/action_view.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+ActiveSupport.on_load :action_view do # rubocop:disable Metrics/BlockLength
+	concerning :DecoratedAssignments, prepend: true do
+		def assign(assignments, ...)
+			decorate assignments
+
+			super
+		end
+
+		def _run(method, template, locals, ...)
+			decorate locals
+
+			super
+		end
+
+		private
+
+		def decorate objects
+			objects
+					.transform_values!(&:decorated)
+		end
+	end
+
+	concerning :PresenterContext, prepend: true do
+		def in_rendering_context(...)
+			Magic::Presenter::Base.with view_context: self do
+				super
+			end
+		end
+
+		private
+
+		def decorate(...)
+			super
+					.each_value
+					.grep(Magic::Presenter::Base)
+					.each { _1.view_context = self }
+		end
+	end
+end

data/lib/magic/presenter/base.rb

@@ -17,6 +17,9 @@ 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
+			prepend Helpers  if defined? ::ActionView
+
 			class << self
 				def name_for object_class
 					object_class
@@ -25,6 +28,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/helpers.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Magic
+	module Presenter
+		module Helpers # :nodoc:
+			extend ActiveSupport::Concern
+
+			# The Magic::Presenter::Helpers::MissingContext exception is
+			# raised when no view context to run helpers in has been set.
+			class MissingContext < RuntimeError
+				def message
+					<<~TEXT
+						missing view context
+						You should set Magic::Presenter.view_context first
+					TEXT
+				end
+			end
+
+			prepended do
+				class_attribute :view_context
+			end
+
+			class_methods do
+				include Helpers
+
+				alias __raise__ raise
+			end
+
+			private
+
+			def helpers
+				view_context or
+						__raise__ MissingContext
+			end
+
+			alias_method :h, :helpers
+
+			def method_missing(method, ...)
+				super
+			rescue NoMethodError
+				__raise__ unless view_context
+				__raise__ unless helpers.respond_to? method
+
+				helpers.send(method, ...)
+			end
+
+			def respond_to_missing?(method, ...)
+				super or
+						(helpers if view_context).respond_to?(method, ...)
+			end
+		end
+	end
+end

data/lib/magic/presenter/version.rb

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

data/lib/magic/presenter.rb

@@ -6,16 +6,29 @@ 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 :Helpers,   'magic/presenter/helpers'
+		autoload :GlobalID,  'magic/presenter/global_id'
 		autoload :Generator, 'generators/magic/presenter/generator'
 
-		module_function
+		singleton_class.delegate *%i[
+				for name_for
+				view_context view_context=
+		], to: Base
+	end
+
+	module_function
+
+	def eager_load *scopes
+		return if Rails.application.config.eager_load
 
-		def for(...)      = Base.for(...)
-		def name_for(...) = Base.name_for(...)
+		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.4.0
 platform: ruby
 authors:
 - Alexander Senko
 bindir: bin
 cert_chain: []
-date: 2024-10-26 00:00:00.000000000 Z
+date: 2024-10-29 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,9 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- config/initializers/loading.rb
+- app/models/concerns/magic/presentable.rb
+- config/initializers/action_controller.rb
+- config/initializers/action_view.rb
 - config/initializers/presentable.rb
 - config/initializers/rspec.rb
 - lib/generators/magic/presenter/generator.rb
@@ -67,11 +69,12 @@ 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/helpers.rb
 - lib/magic/presenter/version.rb
 - lib/tasks/magic/presenter_tasks.rake
 homepage: https://github.com/Alexander-Senko/magic-presenter
@@ -80,7 +83,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.4.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