exposant 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1e1e4a2106643469e0007c4d6655fb2fa80aaa8373a97a71a09f8c473effc9c
-  data.tar.gz: e37e005611d1f6c055f1d99101aa70aa5d8237d7d02f9783eaa1f4f3c48c3028
+  metadata.gz: 3b348ab3f3c0d4c3d274469598cd72c5d234d9a832348ec4824fbfc8936a5957
+  data.tar.gz: 94ee91f4ae16555a4161e22f4075d2f83293f72af04f5f0c834e9a351634c072
 SHA512:
-  metadata.gz: cf007a8c253a74c14b7d41abdcede220a9e131288ffd10831f298c8ec293b14d9f5a9e393c594d5c735cdd4872b9eb15357e49e470dbfa7b5f6bdca74acd729f
-  data.tar.gz: 48e9792620ea3226bc2409f02fd655e71c866ce6359706ed5e053b4991394e74dfa0bd85027126b2f62d4d4168106ddc1fff965111e59f37984cdcac155feda7
+  metadata.gz: b51a4907d36637a6d86d209b9577539a2e21ae8cc7c0bdd72c17395927acfe26981e19e7503d04de0677f7036609fadecada2c6ded173cb9d85492144748c842
+  data.tar.gz: 467b366ac5b9c5ea8f6a60f4bf3e55a32d5049c3b89c1be222836df651a6b7e12194fe5c5160df38c1855507473d9f8328fae896e3eb0685f82b5db5ec1fa3cb

data/.rubocop.yml

@@ -19,7 +19,7 @@ Lint/EmptyClass:
   Enabled: false
 
 Metrics/AbcSize:
-  Max: 50
+  Max: 55
 
 Metrics/CyclomaticComplexity:
   Max: 15

data/Gemfile

@@ -10,3 +10,5 @@ gem 'rake', '~> 13.0'
 gem 'minitest', '~> 5.0'
 
 gem 'rubocop', '~> 1.21'
+
+gem 'pry'

data/Gemfile.lock

@@ -1,29 +1,45 @@
 PATH
   remote: .
   specs:
-    exposant (0.1.1)
-      activemodel (~> 7.0)
-      activesupport (~> 7.0)
+    exposant (0.2.0)
+      activemodel (> 5.0)
+      activesupport (> 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4)
-      activesupport (= 7.0.4)
-    activesupport (7.0.4)
+    activemodel (7.1.1)
+      activesupport (= 7.1.1)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
-    i18n (1.12.0)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    drb (2.1.1)
+      ruby2_keywords
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.1)
+    method_source (1.0.0)
     minitest (5.16.3)
+    mutex_m (0.1.2)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
@@ -41,7 +57,8 @@ GEM
     rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    tzinfo (2.0.5)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
 
@@ -51,6 +68,7 @@ PLATFORMS
 DEPENDENCIES
   exposant!
   minitest (~> 5.0)
+  pry
   rake (~> 13.0)
   rubocop (~> 1.21)
 

data/README.md

@@ -2,9 +2,14 @@
 
 In a Rails application, it is often required to fill a gap between Models and
 Views. There are of course, many differents ways to fill this gap, one of these
-is exhibitors (or improved decorators).
+is decorators and its variants exhibits or presenters.
 
-This gem provide an easy way to create Ruby exhibitors or decorators.
+The main difference between decorators, exhibits and presenters are their
+proximity with the rendering layer. Typically a decorator is not meant to be
+contextualized, whereas an exhibit is intended to have access to rendering
+context.
+
+This gem provide an easy way to create theese concepts in Ruby.
 
 ## Installation
 
@@ -16,74 +21,90 @@ gem 'exposant'
 
 And then execute:
 
-    $ bundle install
+```ruby
+$ bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install exposant
+```
+$ gem install exposant
+```
 
 ## Usage
 
-There are two kinds of exhibitors refering to model or collection.
-
-A collection exhibitor is meant to encapsulate an enumerable object (like
-ActiveRecord Relation or just Array). It overrides `each` method to ensure
-encapsulation of resulting objects.
+Exposant objects are intended to overload class (scopes) and instance methods
+of any other object. The default type is exposant, choosing between decorator,
+exhibit or any other type name is up to you. There is no magic involved for the
+context, you just have to call contextualize and provide the required context.
 
-A model exhibitor improve it's associated object, like adding non-database
-related methods to an ActiveRecord object for example.
-
-To use this gem in a Rails application, create a folder `app/exhibitors`.
-Create pluralized exhibitors for collections and singularized exhibitors for
-models.
-
-### Example:
+### Basic example
 
 Consider having a User model with `first_name` and `last_name`
 
 ```ruby
-# app/models/application_record.rb
-class ApplicationRecord < ActiveRecord::Base
-  include Exposant::Exposable
+# app/models/user.rb
+class User < ActiveRecord::Base
+  include Exposant::Model
+  has_exposant type: :decorator
 end
 
-# app/exhibitors/user_exhibitor.rb
-class UserExhibitor < Exposant::ModelExhibitor
+# app/decorators/user_decorator.rb
+class UserDecorator < Exposant::Base
+  exposant_type :decorator
+
   def full_name
     "#{first_name} #{last_name}"
   end
 end
+```
+
+Then you may want to use your brand new decorator in your controller
 
-# app/exhibitors/users_exhibitor.rb
-class UsersExhibitor < Exposant::CollectionExhibitor
-  # You can add methods for collections too if necessary
+```ruby
+# app/controllers/users_controller.rb
+class UsersController < DefaultController
+  def index
+    @users = User.decorator(User.all)
+  end
+
+  def show
+    @user = User.find(...).decorator
+  end
 end
 ```
 
-Then you may want to use your brand new exhibitor in your controller
+### Contextualization example
+
+If you want to contextualize a presenter, for example in a Rails application.
+
 ```ruby
 # app/controllers/users_controller.rb
 class UsersController < DefaultController
   def index
-    @users = User.exhibitor(User.all)
+    @users = User.presenter(User.all)
+    @users.contextualize(self)
   end
 
   def show
-    @user = User.find(...).exhibitor
+    @user = User.find(...).presenter
+    @user.contextualize(self)
   end
 end
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies. You can
+also run `bin/console` for an interactive prompt that will allow you to
+experiment.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kmmndr/exposant.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/kmmndr/exposant.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/exposant.gemspec

@@ -30,9 +30,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency 'activemodel', '~> 7.0'
-  spec.add_dependency 'activesupport', '~> 7.0'
+  spec.add_dependency 'activemodel', '> 5.0'
+  spec.add_dependency 'activesupport', '> 5.0'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/exposant/base.rb

@@ -0,0 +1,92 @@
+module Exposant
+  class Base < SimpleDelegator
+    include Exposant::Contextualizable
+    extend ActiveModel::Naming
+
+    def initialize(*)
+      super
+
+      extend(Exposant::Collection) if __getobj__.is_a?(Enumerable)
+    end
+
+    def to_model
+      __getobj__
+    end
+
+    def self.respond_to_missing?(name, *)
+      klass.respond_to?(name) || super
+    end
+
+    def self.method_missing(name, *args, &block)
+      klass.send(name, *args, &block)
+    end
+
+    def self.human_attribute_name(*args)
+      exposed_class.human_attribute_name(*args)
+    end
+
+    def self.klass
+      @klass ||= exposed_class
+    end
+
+    def self.belongs_to_model(name)
+      exposed_class(name)
+    end
+
+    def self.exposed_class(value = nil)
+      @exposed_class = value.constantize if value.present?
+      return @exposed_class if @exposed_class.present?
+
+      return ancestors[1].exposed_class unless ancestors[1] == Exposant::Base || ancestors[1].exposant_base?
+
+      klass_name = name.gsub(/#{type_name}$/, '')
+
+      klass_name.constantize
+    end
+
+    def self.exposant_type(value = nil)
+      @exposant_type = value if value.present?
+      return @exposant_type if @exposant_type.present?
+
+      return ancestors[1].exposant_type unless ancestors[1] == Exposant::Base
+
+      :exposant
+    end
+
+    def self.type_name
+      exposant_type.to_s.camelcase
+    end
+
+    def self.custom_type?
+      exposant_type != :exposant
+    end
+
+    def self.exposant_base?
+      !!@exposant_base
+    end
+
+    def self.exposant_base
+      @exposant_base = true
+    end
+
+    def self.exposant_variant
+      exposed_name = exposed_class.name.demodulize
+
+      variant = name
+                .split('::')
+                .tap { |arr| arr.last.gsub!(/#{exposed_name}#{type_name}$/, '') }
+                .last
+                .downcase
+
+      return nil if variant.blank?
+
+      variant.to_sym
+    end
+
+    def self.parent_exposant
+      return ancestors[1].parent_exposant unless ancestors[1] == Exposant::Base
+
+      name.constantize
+    end
+  end
+end

data/lib/exposant/concerns/collection.rb

@@ -0,0 +1,16 @@
+module Exposant
+  module Collection
+    include Enumerable
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      super do |obj|
+        exposant = obj.exposant(self.class.exposant_variant, self.class.exposant_type)
+        exposant.contextualize(context) if contextualized?
+
+        yield exposant
+      end
+    end
+  end
+end

data/lib/exposant/concerns/contextualizable.rb

@@ -0,0 +1,13 @@
+module Exposant
+  module Contextualizable
+    attr_accessor :context
+
+    def contextualize(context)
+      self.context = context
+    end
+
+    def contextualized?
+      context.present?
+    end
+  end
+end

data/lib/exposant/model.rb

@@ -0,0 +1,82 @@
+require 'pry'
+module Exposant
+  module Model
+    extend ActiveSupport::Concern
+
+    def exposant(variant = nil, type = nil)
+      self.class.exposant_class(variant, type).new(self)
+    end
+
+    module ClassMethods
+      def has_exposant(name: nil, type: nil)
+        @exposant_class = name
+        @exposant_type = type
+
+        if type.present? && type != :exposant
+          raise 'Type must be a symbol' unless type.is_a?(Symbol)
+
+          define_method type do |variant = nil|
+            exposant(variant, type)
+          end
+
+          define_singleton_method type do |obj, variant = nil|
+            exposant(obj, variant, type)
+          end
+        end
+
+        self
+      end
+
+      def exposant_type
+        @exposant_type || :exposant
+      end
+
+      def exposant(obj, variant = nil, type = nil)
+        obj.extend(ExposantMethods)
+        obj.model_klass = self
+
+        if type.present? && type != :exposant
+          raise 'Type must be a symbol' unless type.is_a?(Symbol)
+
+          obj.singleton_class.class_eval do
+            define_method type do |var = nil|
+              exposant(var, type)
+            end
+          end
+        end
+
+        obj.exposant(variant, type)
+      end
+
+      def exposant_class(variant = nil, type = nil)
+        type_name = (type || exposant_type).to_s.camelcase
+        klass = if @exposant_class.present?
+                  @exposant_class
+                else
+                  name.dup.concat(type_name)
+                end
+
+        klass = klass
+                .split('::')
+                .tap { |arr| arr.last.prepend(variant&.to_s&.downcase&.capitalize || '') }
+                .join('::')
+
+        raise "Missing exposant #{klass}" unless const_defined?(klass)
+
+        klass.constantize
+      end
+    end
+  end
+
+  module ExposantMethods
+    attr_accessor :model_klass
+
+    def exposant(variant = nil, type = nil)
+      exposant_class(variant, type).new(self)
+    end
+
+    def exposant_class(variant = nil, type = nil)
+      model_klass.exposant_class(variant, type)
+    end
+  end
+end

data/lib/exposant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Exposant
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/exposant.rb

@@ -4,13 +4,12 @@ require 'delegate'
 require 'active_support'
 require 'active_model'
 
-require_relative 'exposant/concerns/exhibitor'
-require_relative 'exposant/concerns/exposable'
-require_relative 'exposant/collection_exhibitor'
-require_relative 'exposant/model_exhibitor'
+require_relative 'exposant/concerns/contextualizable'
+require_relative 'exposant/concerns/collection'
+require_relative 'exposant/model'
+require_relative 'exposant/base'
 require_relative 'exposant/version'
 
 module Exposant
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: exposant
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Thomas Kienlen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-08 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '5.0'
 description:
 email:
 - kommander@laposte.net
@@ -54,10 +54,10 @@ files:
 - Rakefile
 - exposant.gemspec
 - lib/exposant.rb
-- lib/exposant/collection_exhibitor.rb
-- lib/exposant/concerns/exhibitor.rb
-- lib/exposant/concerns/exposable.rb
-- lib/exposant/model_exhibitor.rb
+- lib/exposant/base.rb
+- lib/exposant/concerns/collection.rb
+- lib/exposant/concerns/contextualizable.rb
+- lib/exposant/model.rb
 - lib/exposant/version.rb
 homepage: http://127.0.0.1:3000
 licenses:
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Simple way to create decorators and presenters

data/lib/exposant/collection_exhibitor.rb

@@ -1,25 +0,0 @@
-module Exposant
-  class CollectionExhibitor < SimpleDelegator
-    include Exhibitor
-    extend ActiveModel::Naming
-    include Enumerable
-
-    def self.exhibitor_variant
-      self::MODEL_PRESENTER_VARIANT if const_defined?('MODEL_PRESENTER_VARIANT')
-    end
-
-    def each
-      return enum_for(:each) unless block_given?
-
-      __getobj__.each do |o|
-        exh = o.exhibitor(self.class.exhibitor_variant)
-        exh.contextualize(context) if contextualized?
-        yield exh
-      end
-    end
-
-    def to_model
-      self
-    end
-  end
-end

data/lib/exposant/concerns/exhibitor.rb

@@ -1,34 +0,0 @@
-module Exhibitor
-  extend ActiveSupport::Concern
-  attr_accessor :context
-
-  def obj
-    __getobj__
-  end
-
-  def exhibitor_for(obj)
-    self.class.exhibitor_for(obj)
-  end
-
-  def contextualize(context)
-    self.context = context
-  end
-
-  def contextualized?
-    context.present?
-  end
-
-  module ClassMethods
-
-    def exhibitor_for_super(method, klass = nil)
-      define_method(method) do |*args|
-        klass ||= self.class
-        klass.new(super(*args))
-      end
-    end
-
-    def exhibitor_for(obj)
-      new(obj)
-    end
-  end
-end

data/lib/exposant/concerns/exposable.rb

@@ -1,56 +0,0 @@
-module Exposant
-  module Exposable
-    module Model
-      extend ActiveSupport::Concern
-
-      def exhibitor(variant = nil)
-        self.class.exhibitor_class(variant).new(self)
-      end
-
-      module ClassMethods
-        def exhibitor(obj, variant = nil)
-          obj.extend(Exposable::Collection)
-          obj.model_klass = self
-
-          obj.exhibitor(variant)
-        end
-
-        def exhibitor_class(variant = nil)
-          klass = [
-            name,
-            variant&.downcase&.capitalize,
-            'Exhibitor'
-          ].join
-
-          raise "Missing exhibitor #{klass}" unless const_defined?(klass)
-
-          klass.constantize
-        end
-      end
-    end
-
-    module Collection
-      attr_accessor :model_klass
-
-      def exhibitor(variant = nil)
-        exhibitor_class(variant).new(self)
-      end
-
-      def exhibitor_class(variant = nil)
-        klass_name = model_klass.name
-
-        klass = [
-          klass_name.pluralize,
-          variant&.downcase&.capitalize,
-          'Exhibitor'
-        ].join
-
-        begin
-          klass.constantize
-        rescue NameError
-          raise "Missing exhibitor #{klass}"
-        end
-      end
-    end
-  end
-end

data/lib/exposant/model_exhibitor.rb

@@ -1,34 +0,0 @@
-module Exposant
-  class ModelExhibitor < SimpleDelegator
-    include Exhibitor
-    extend ActiveModel::Naming
-
-    def to_model
-      obj
-    end
-
-    def self.human_attribute_name(*args)
-      exhibited_class.human_attribute_name(*args)
-    end
-
-    def self.exhibited_class
-      return ancestors[1].exhibited_class unless ancestors[1] == ModelExhibitor
-
-      name.gsub(/Exhibitor$/, '').constantize
-    end
-
-    def self.exhibitor_variant
-      variant = name[parent_exhibitor.exhibited_class.name.length..].gsub(/Exhibitor$/, '').downcase
-
-      return nil if variant.blank?
-
-      variant.to_sym
-    end
-
-    def self.parent_exhibitor
-      return ancestors[1].parent_exhibitor unless ancestors[1] == ModelExhibitor
-
-      name.constantize
-    end
-  end
-end