magic-presenter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c2d9f852b05ac3df9f02d0a6f43256155d36f0aa54c9b94887017c6695040000
+  data.tar.gz: 07f21527902b18f58d4ffc88655b3e37317a331fa8db2f37addaa421478a523b
+SHA512:
+  metadata.gz: 3d230e25c5b5a5bfaef1e941df5388cdcc71315287fbf71177fa7ebe1ca13ff4fa16a2e6a07e358bbed35213053262e6900b390cdc9572f5e33ea5ae59161626
+  data.tar.gz: 36e3545b509b62c1c68f22d156adec1ef46ddf34ff0efeb9875aedf13bac1856a6387006211ad9c93a9dc118aa55f98a6a0db09133172d8b6453ed6f81e968e1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Alexander Senko
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# 🧙 Magic Presenter
+
+![Code Climate maintainability](
+	https://img.shields.io/codeclimate/maintainability-percentage/Alexander-Senko/magic-presenter
+)
+![Code Climate coverage](
+	https://img.shields.io/codeclimate/coverage/Alexander-Senko/magic-presenter
+)
+
+A bit of history: this gem was inspired by digging deeper into [Draper](https://github.com/drapergem/draper) with an eye on a refactoring.
+
+Based on [Magic Decorator](https://github.com/Alexander-Senko/magic-decorator), it implements a presenter logic.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add magic-presenter
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install magic-presenter
+
+## Usage
+
+`Magic::Presenter::Base` is a basic presenter class to be inherited by any other presenter.
+It further inherits from [`SimpleDelegator`](
+	https://docs.ruby-lang.org/en/master/SimpleDelegator.html
+).
+
+```ruby
+class PersonPresenter < Magic::Presenter::Base
+  def name = "#{first_name} #{last_name}"
+end
+
+class Person
+  include ActiveModel::Model
+  attr_accessor :first_name, :last_name
+end
+
+person = Person.new(first_name: 'John', last_name: 'Smith').decorate
+person.name # => "John Smith"
+```
+
+### `Magic::Presentable`
+
+This module includes `Magic::Decoratable` and allows a descendant to be decorated by presenters only.
+Presenter class is being inferred automatically.
+When no presenter is found,
+- `#decorate`  returns `nil`,
+- `#decorate!` raises `Magic::Lookup::Error`,
+- `#decorated` returns the original object.
+
+## Magic
+
+It’s based on [Magic Decorator](
+	https://github.com/Alexander-Senko/magic-decorator#magic
+), so get familiar with that one as well.
+
+### Presentable scope
+
+`Magic::Presentable` is mixed into `ActiveModel::Model` by default.
+It means that any model, be it `ActiveRecord::Base`, `Mongoid::Document` or whatever else, is _magically presentable_.
+
+### Presenter class inference
+
+Presenters provide automatic class inference for any model based on its class name powered by [Magic Lookup](
+	https://github.com/Alexander-Senko/magic-lookup
+).
+
+For example, `MyNamespace::MyModel.new.decorate` looks for `MyNamespace::MyModelPresenter` first.
+When missing, it further looks for decorators for its ancestor classes, up to `ObjectPresenter`.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Alexander-Senko/magic-presenter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Alexander-Senko/magic-presenter/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Magic Presenter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Alexander-Senko/magic-presenter/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path 'spec/internal/Rakefile', __dir__
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/config/initializers/presentable.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+ActiveSupport.on_load :active_model do
+	include Magic::Presentable
+end

data/lib/magic/presentable.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Magic
+	# This module includes `Magic::Decoratable` and allows a descendant
+	# to be decorated by presenters only. Presenter class is being
+	# inferred automatically.
+	module Presentable
+		include Decoratable
+
+		private
+
+		def decorator = Presenter.for self.class
+	end
+end

data/lib/magic/presenter/authors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Gem::Author ||= Struct.new(
+		:name,
+		:email,
+		:github,
+) do
+	def github_url = github && "https://github.com/#{github}"
+end
+
+module Magic
+	module Presenter # :nodoc:
+		AUTHORS = [ # rubocop:disable Style/MutableConstant
+				Gem::Author.new(
+						name:   'Alexander Senko',
+						email:  'Alexander.Senko@gmail.com',
+						github: 'Alexander-Senko',
+				),
+		]
+
+		class << AUTHORS
+			def names      = filter_map &:name
+			def emails     = filter_map &:email
+			def github_url = filter_map(&:github_url).first
+		end
+	end
+end

data/lib/magic/presenter/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'delegate'
+
+module Magic
+	module Presenter
+		# = Magic Presenter
+		#
+		# Any presenter should inherit `Magic::Presenter::Base`.
+		# It further inherits from `SimpleDelegator` and behaves like that.
+		#
+		# == Presenter class inference
+		#
+		# Presenters provide automatic class inference for any model based
+		# on its class name powered by Magic Lookup.
+		# For example, `MyModel.new` looks for `MyModelPresenter` first.
+		# If not found, it looks for presenters of its ancestor classes,
+		# up to `ObjectPresenter`.
+		class Base < Decorator::Base
+			class << self
+				def name_for(object_class) = "#{object_class}Presenter"
+			end
+		end
+	end
+end

data/lib/magic/presenter/engine.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Magic
+	module Presenter
+		class Engine < ::Rails::Engine # :nodoc:
+			isolate_namespace Magic::Presenter
+		end
+	end
+end

data/lib/magic/presenter/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Magic
+	module Presenter
+		VERSION = '0.1.0'
+	end
+end

data/lib/magic/presenter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'magic/decorator'
+
+require_relative 'presenter/version'
+require_relative 'presenter/engine'
+
+module Magic
+	autoload :Presentable, 'magic/presentable'
+
+	# Presentation layer for Rails models
+	module Presenter
+		autoload :Base, 'magic/presenter/base'
+
+		module_function
+
+		def for(...)      = Base.for(...)
+		def name_for(...) = Base.name_for(...)
+	end
+end

data/lib/tasks/magic/presenter_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :magic_presenter do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: magic-presenter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Senko
+bindir: bin
+cert_chain: []
+date: 2024-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: magic-decorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Based on Magic Decorator, it’s meant to replace Draper.
+email:
+- Alexander.Senko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/initializers/presentable.rb
+- 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/version.rb
+- lib/tasks/magic/presenter_tasks.rake
+homepage: https://github.com/Alexander-Senko/magic-presenter
+licenses:
+- MIT
+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.1.0/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+specification_version: 4
+summary: Presentation layer for Rails models
+test_files: []