exposant 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a32157d1c5d5bc482d278ea27afc87bea199f1a70459f5158e17a4cb27a35c2b
-  data.tar.gz: 4a31ae775b219ded8bce8961ee321ab57334af8603412997b6622a5e9e918868
+  metadata.gz: e71f97dbf32080d25a520091a6e33d480ad18e6a3fff6bcd6e450b80c0cd5414
+  data.tar.gz: 499db0ccd9fd33e879dcc035f4decf21ea7c8874042ddc113bc4862b3bf726e6
 SHA512:
-  metadata.gz: b30952a3a17b5f5bd718d2a1e54f7fb7e186a60cd2a2a0cf667e8f9716eb42fc70d0b80cf1303544c96ee2a39893336bfe4d3ce29e21f70c73f390781a983524
-  data.tar.gz: e0ae7a0c8501b34037038621b79ab9bb78b596c6c3216974bf74970b3f3f8ee0bf328b18e703926bf451dd5dd87797ee3099178ace2d29d2cfb0033560f793b6
+  metadata.gz: d446462784d85f9b13426e79fb69a484a827c8bb347d117c286fa3da0a841aace9c51ea265a5d23256a53da36112c6b3b6c28be0a6502a28cb1c7414bd80a2e7
+  data.tar.gz: 4f0642a4b7001c14b149deaf738738ae13e8541cb54c3987405e383ef5656c1ade8fe84c1b8c31756659c7816869c10b0a83023f18500ac73c81d2560d733ed6

data/Gemfile.lock

@@ -1,22 +1,22 @@
 PATH
   remote: .
   specs:
-    exposant (0.1.0)
+    exposant (0.1.2)
       activemodel (~> 7.0)
       activesupport (~> 7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4)
-      activesupport (= 7.0.4)
-    activesupport (7.0.4)
+    activemodel (7.0.4.2)
+      activesupport (= 7.0.4.2)
+    activesupport (7.0.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.1)
@@ -41,7 +41,7 @@ GEM
     rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
 

data/README.md

@@ -1,8 +1,10 @@
 # Exposant
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/exposant`. To experiment with that code, run `bin/console` for an interactive prompt.
+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).
 
-TODO: Delete this and the text above, and describe your gem
+This gem provide an easy way to create Ruby exhibitors or decorators.
 
 ## Installation
 
@@ -22,7 +24,55 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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.
+
+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:
+
+Consider having a User model with `first_name` and `last_name`
+
+```ruby
+# app/models/application_record.rb
+class ApplicationRecord < ActiveRecord::Base
+  include Exposant::Exposable
+end
+
+# app/exhibitors/user_exhibitor.rb
+class UserExhibitor < Exposant::ModelExhibitor
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+end
+
+# app/exhibitors/users_exhibitor.rb
+class UsersExhibitor < Exposant::CollectionExhibitor
+  # You can add methods for collections too if necessary
+end
+```
+
+Then you may want to use your brand new exhibitor in your controller
+```ruby
+# app/controllers/users_controller.rb
+class UsersController < DefaultController
+  def index
+    @users = User.exhibitor(User.all)
+  end
+
+  def show
+    @user = User.find(...).exhibitor
+  end
+end
+```
 
 ## Development
 

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
-  t.test_files = FileList['test/**/test_*.rb']
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 require 'rubocop/rake_task'

data/lib/exposant/collection_exhibitor.rb

@@ -11,7 +11,12 @@ module Exposant
     def each
       return enum_for(:each) unless block_given?
 
-      __getobj__.each { |o| yield o.exhibitor(self.class.exhibitor_variant) }
+      __getobj__.each do |o|
+        exh = o&.exhibitor(self.class.exhibitor_variant)
+        exh.contextualize(context) if exh.present? && contextualized?
+
+        yield exh
+      end
     end
 
     def to_model

data/lib/exposant/concerns/exhibitor.rb

@@ -1,5 +1,6 @@
 module Exhibitor
   extend ActiveSupport::Concern
+  attr_accessor :context
 
   def obj
     __getobj__
@@ -9,7 +10,16 @@ module Exhibitor
     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

data/lib/exposant/concerns/{presentable.rb → exposable.rb}

@@ -1,5 +1,5 @@
 module Exposant
-  module Presentable
+  module Exposable
     module Model
       extend ActiveSupport::Concern
 
@@ -9,7 +9,7 @@ module Exposant
 
       module ClassMethods
         def exhibitor(obj, variant = nil)
-          obj.extend(Presentable::Collection)
+          obj.extend(Exposable::Collection)
           obj.model_klass = self
 
           obj.exhibitor(variant)

data/lib/exposant/version.rb

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

data/lib/exposant.rb

@@ -4,8 +4,8 @@ require 'delegate'
 require 'active_support'
 require 'active_model'
 
-require_relative 'exposant/concerns/presentable'
 require_relative 'exposant/concerns/exhibitor'
+require_relative 'exposant/concerns/exposable'
 require_relative 'exposant/collection_exhibitor'
 require_relative 'exposant/model_exhibitor'
 require_relative 'exposant/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exposant
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Thomas Kienlen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -56,7 +56,7 @@ files:
 - lib/exposant.rb
 - lib/exposant/collection_exhibitor.rb
 - lib/exposant/concerns/exhibitor.rb
-- lib/exposant/concerns/presentable.rb
+- lib/exposant/concerns/exposable.rb
 - lib/exposant/model_exhibitor.rb
 - lib/exposant/version.rb
 homepage: http://127.0.0.1:3000