dekorator 1.0.0.pre.1 → 1.0.0

data/dekorator.gemspec

@@ -1,23 +1,36 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "dekorator/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "dekorator"
-  spec.version       = Dekorator::VERSION
-  spec.authors       = ["Nicolas Brousse"]
-  spec.email         = ["nicolas@pantographe.studio"]
-
-  spec.summary       = "An opinionated way of organizing model-view code in Ruby on Rails, based on decorators"
-  spec.description   = "An opinionated way of organizing model-view code in Ruby on Rails, based on decorators"
-  spec.license       = "MIT"
+  spec.name        = "dekorator"
+  spec.version     = Dekorator::VERSION
+  spec.authors     = ["Pantographe"]
+  spec.email       = ["oss@pantographe.studio"]
+
+  spec.summary     = "An opinionated way of organizing model-view code in Ruby on Rails, based on decorators"
+  spec.description = "An opinionated way of organizing model-view code in Ruby on Rails, based on decorators"
+  spec.homepage    = "http://komponent.io"
+  spec.license     = "MIT"
+
+  spec.metadata    = {
+    "homepage_uri"    => "https://github.com/komposable/dekorator",
+    "changelog_uri"   => "https://github.com/komposable/dekorator/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/komposable/dekorator",
+    "bug_tracker_uri" => "https://github.com/komposable/dekorator/issues",
+}
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files       = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0")
+      .reject do |f|
+        f.match(%r{^(test|spec|features|gemfiles|bin)/}) \
+        || %w[.editorconfig .gitignore .inch.yml .rspec .rubocop.yml .simplecov .travis.yml
+          .yardots Appraisals Gemfile Gemfile.lock].include?(f)
+      end
   end
 
   spec.require_paths = ["lib"]

data/lib/dekorator.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 require "dekorator/version"
-require "active_support/core_ext/object/blank"
-require "active_support/core_ext/module/delegation"
+require "delegate"
 
+# :nodoc
 module Dekorator
+  # @api private
+  module Generators; end
+
   class DecoratorNotFound < ArgumentError; end
 
   # Base decorator.
@@ -19,11 +22,10 @@ module Dekorator
       #
       # @raise [DecoratorNotFound] if decorator is not found.
       def decorate(object_or_collection, with: nil)
-        return object_or_collection if object_or_collection.blank?
-
-        with = _guess_decorator(object_or_collection) if with.nil? && object_or_collection.present?
+        return object_or_collection if decorable_object?(object_or_collection)
 
-        raise DecoratorNotFound, "Can't guess decorator for #{object_or_collection.class.name} object" if with.nil?
+        with ||= self if with != :__guess__ && self != Dekorator::Base
+        with = _guess_decorator(object_or_collection) if with.nil? || with == :__guess__
 
         object_or_collection = _decorate(object_or_collection, with: with)
 
@@ -40,82 +42,108 @@ module Dekorator
       # @option opts [Class] :with the decorator class to use. If empty a decorator will be guessed.
       #
       # @example Define an association to decorate
-      #   class UserDecorator < ApplicationDecorator
+      #   class UserDecorator < Dekorator::Base
       #     decorates_association :posts
       #   end
       #
       #   # A decorator could be precise
-      #   class UserDecorator < ApplicationDecorator
+      #   class UserDecorator < Dekorator::Base
       #     decorates_association :posts, PostDecorator
       #   end
-      def decorates_association(relation_name, with: nil)
+      def decorates_association(relation_name, with: :__guess__)
         relation_name = relation_name.to_sym
 
         define_method(relation_name) do
-          association = __getobj__.public_send(relation_name)
-
-          @decorated_associations[relation_name] ||= decorate(association, with: with)
+          @decorated_associations[relation_name] ||= decorate(__getobj__.public_send(relation_name), with: with)
         end
       end
 
+      # Guess and returns the decorated object class.
+      #
+      # @return [Class] the decorated object class.
       def base_class
-        name.gsub("Decorator", "").safe_constantize
+        _safe_constantize(name.gsub("Decorator", ""))
       end
 
       private
 
-      def _decorate(object_or_enumerable, with: nil)
-        if defined?(ActiveRecord::Relation) && object_or_enumerable.is_a?(ActiveRecord::Relation)
-          DecoratedEnumerableProxy.new(object_or_enumerable, with)
-        elsif object_or_enumerable.is_a? Enumerable
-          object_or_enumerable.map { |object| with.new(object) }
-        else
+      def _decorate(object_or_enumerable, with:)
+        if !object_or_enumerable.is_a? Enumerable
           with.new(object_or_enumerable)
+        else
+          if defined?(ActiveRecord::Relation) && object_or_enumerable.is_a?(ActiveRecord::Relation)
+            Dekorator::DecoratedEnumerableProxy.new(with, object_or_enumerable)
+          else object_or_enumerable.is_a? Enumerable
+            object_or_enumerable.map { |object| _decorate(object, with: with) }
+          end
         end
       end
 
       def _guess_decorator(object_or_enumerable)
         object_or_enumerable = object_or_enumerable.first if object_or_enumerable.is_a? Enumerable
 
-        "#{object_or_enumerable.class}Decorator".safe_constantize if object_or_enumerable.present?
+        _safe_constantize("#{object_or_enumerable.class}Decorator") \
+          || raise(DecoratorNotFound, "Can't guess decorator for #{object_or_enumerable.class.name} object")
       end
-    end
 
-    delegate :decorate, to: :class
+      def decorable_object?(object_or_collection)
+        (object_or_collection.respond_to?(:empty?) && object_or_collection.empty?) \
+          || !object_or_collection \
+          || object_or_collection.is_a?(Dekorator::Base) \
+          || (defined?(ActiveRecord::Relation) && object_or_collection.is_a?(Dekorator::DecoratedEnumerableProxy))
+      end
 
+      def _safe_constantize(class_name)
+        Object.const_get(class_name)
+      rescue NameError => _e
+        nil
+      end
+    end
+
+    # :nodoc
     def initialize(object)
       @decorated_associations = {}
 
       super(object)
     end
 
+    # :nodoc
+    def decorate(object_or_collection, with: :__guess__)
+      self.class.decorate(object_or_collection, with: with)
+    end
+
+    # Returns the decorated object.
+    #
+    # @return [Object] the decorated object.
     def object
       __getobj__
     end
+  end
 
-    if defined?(ActiveRecord::Relation)
-      class DecoratedEnumerableProxy < DelegateClass(ActiveRecord::Relation)
-        include Enumerable
+  if defined?(ActiveRecord::Relation)
+    # DecoratedEnumerableProxy is strongly inspired from
+    # https://github.com/kiote/activeadmin-poro-decorator/blob/master/lib/activeadmin-poro-decorator.rb#L65
+    class DecoratedEnumerableProxy < DelegateClass(ActiveRecord::Relation)
+      include Enumerable
 
-        delegate :as_json, :collect, :map, :each, :[], :all?, :include?,
-                 :first, :last, :shift, to: :decorated_collection
-        delegate :each, to: :to_ary
+      delegate :as_json, :collect, :map, :each, :[], :all?, :include?,
+               :first, :last, :shift, to: :decorated_collection
+      delegate :each, to: :to_ary
 
-        def initialize(collection, decorator_class)
-          super(collection)
+      def initialize(decorator_class, collection)
+        super(collection)
 
-          @decorator_class = decorator_class
-        end
+        @decorator_class = decorator_class
+      end
 
-        def wrapped_collection
-          __getobj__
-        end
+      def wrapped_collection
+        __getobj__
+      end
 
-        def decorated_collection
-          @decorated_collection ||= wrapped_collection.collect { |member| @decorator_class.decorate(member) }
-        end
-        alias to_ary decorated_collection
+      def decorated_collection
+        @decorated_collection ||= wrapped_collection.collect { |member| @decorator_class.new(member) }
       end
+      alias to_ary decorated_collection
     end
   end
 end

data/lib/dekorator/rails/controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Dekorator
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :decorate
+    end
+
+    def decorate(object_or_collection, with: nil)
+      Dekorator::Base.decorate(object_or_collection, with: with)
+    end
+  end
+end

data/lib/dekorator/railtie.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
-require "dekorator/decorators_helper"
-
 module Dekorator
-  class Railtie < Rails::Railtie
-    initializer "decorators.helper" do |_app|
-      ActionView::Base.send :include, DecoratorsHelper
+  require "dekorator/rails/controller"
+
+  class Railtie < ::Rails::Railtie
+    config.to_prepare do |_app|
+      ActionController::Base.include Dekorator::Controller
+    end
+
+    config.after_initialize do |app|
+      app.config.paths.add "app/decorators", eager_load: true
     end
   end
 end

data/lib/dekorator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dekorator
-  VERSION = "1.0.0.pre.1".freeze
+  VERSION = "1.0.0".freeze
 end

data/lib/generators/decorator_generator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+class DecoratorGenerator < ::Rails::Generators::NamedBase
+  invoke "dekorator:decorator"
+end

data/lib/generators/{decorator → dekorator/decorator}/USAGE

@@ -2,7 +2,7 @@ Description:
   Generate a fresh new decorator
 
 Example:
-    `rails generate decorator User`
+    `rails generate dekorator:decorator User`
 
     User decorator.
         Decorator: app/decorators/user_decorator.rb

data/lib/generators/dekorator/decorator/decorator_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Dekorator
+  module Generators
+    class DecoratorGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_decorator
+        template "decorator.rb", File.join("app/decorators", class_path, "#{file_name}_decorator.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/generators/dekorator/{install_generator.rb → install/install_generator.rb}

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
+require "rails/generators"
+
 module Dekorator
   module Generators
-    class InstallGenerator < Rails::Generators::Base
+    class InstallGenerator < ::Rails::Generators::Base
 
       def create_root_directory
-        return if File.directory?(dekorator_root_directory)
-
         empty_directory(dekorator_root_directory)
+
+        concerns_directory = dekorator_root_directory.join("concerns")
+        empty_directory(concerns_directory)
+        create_file("#{concerns_directory}/.keep")
       end
 
       def create_application_decorator
-        return if File.exist?(application_decorator_path)
-
         create_file application_decorator_path, <<-RUBY
 # frozen_string_literal: true
 
@@ -24,7 +26,7 @@ end
       protected
 
       def dekorator_root_directory
-        Rails.root.join("app", "decorators")
+        Rails.root.join("app/decorators")
       end
 
       def application_decorator_path

data/lib/generators/rspec/decorator_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rails/generators"
+
 module Rspec
   module Generators
     class DecoratorGenerator < ::Rails::Generators::NamedBase

data/lib/generators/test_unit/decorator_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rails/generators"
+
 module TestUnit
   module Generators
     class DecoratorGenerator < ::Rails::Generators::NamedBase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dekorator
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Nicolas Brousse
+- Pantographe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-30 00:00:00.000000000 Z
+date: 2019-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -115,55 +115,41 @@ dependencies:
 description: An opinionated way of organizing model-view code in Ruby on Rails, based
   on decorators
 email:
-- nicolas@pantographe.studio
+- oss@pantographe.studio
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".simplecov"
-- ".travis.yml"
-- Appraisals
+- ".github/workflows/test.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- benchmarks/README.md
+- benchmarks/benchmark.rb
 - dekorator.gemspec
-- gemfiles/.bundle/config
-- gemfiles/rails_5.0.x.gemfile
-- gemfiles/rails_5.0.x.gemfile.lock
-- gemfiles/rails_5.1.x.gemfile
-- gemfiles/rails_5.1.x.gemfile.lock
-- gemfiles/rails_5.2.x.gemfile
-- gemfiles/rails_5.2.x.gemfile.lock
-- gemfiles/rails_6.0.x.gemfile
-- gemfiles/rails_6.0.x.gemfile.lock
 - lib/dekorator.rb
-- lib/dekorator/decorators_helper.rb
+- lib/dekorator/rails/controller.rb
 - lib/dekorator/railtie.rb
-- lib/dekorator/rspec.rb
 - lib/dekorator/version.rb
-- lib/generators/decorator/USAGE
-- lib/generators/decorator/decorator_generator.rb
-- lib/generators/decorator/templates/decorator.rb
-- lib/generators/decorator/templates/decorator_test.rb
-- lib/generators/dekorator/install_generator.rb
+- lib/generators/decorator_generator.rb
+- lib/generators/dekorator/decorator/USAGE
+- lib/generators/dekorator/decorator/decorator_generator.rb
+- lib/generators/dekorator/decorator/templates/decorator.rb
+- lib/generators/dekorator/install/install_generator.rb
 - lib/generators/rspec/decorator_generator.rb
 - lib/generators/rspec/templates/decorator_spec.rb
 - lib/generators/test_unit/decorator_generator.rb
 - lib/generators/test_unit/templates/decorator_test.rb
-homepage: 
+homepage: http://komponent.io
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/komposable/dekorator
+  changelog_uri: https://github.com/komposable/dekorator/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/komposable/dekorator
+  bug_tracker_uri: https://github.com/komposable/dekorator/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -175,11 +161,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: An opinionated way of organizing model-view code in Ruby on Rails, based