dekorator 1.0.0.pre.1 → 1.2.1

data/lib/dekorator.rb

@@ -1,10 +1,14 @@
 # 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
+
+  # :nodoc:
   class DecoratorNotFound < ArgumentError; end
 
   # Base decorator.
@@ -12,110 +16,132 @@ module Dekorator
     class << self
       # Decorate an object with a decorator.
       #
-      # @param object_or_collection [Object, Enumerable] the object or collection to decorate.
-      # @option opts [Class] :with the decorator class to use. If empty a decorator will be guessed.
+      # @param object_or_enumerable [Object, Enumerable] the object or Enumerable to decorate.
+      # @param with [Class] the decorator class to use. If empty a decorator will be guessed.
       #
-      # @return [Dekorator::Base, ActiveRecord::Relation, Enumerable] the obect or collection decorated.
+      # @return [Dekorator::Base] if object given.
+      # @return [Enumerable] if Enumerable given.
       #
       # @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?
+      def decorate(object_or_enumerable, with: nil)
+        return object_or_enumerable unless decorable?(object_or_enumerable)
 
-        raise DecoratorNotFound, "Can't guess decorator for #{object_or_collection.class.name} object" if with.nil?
+        with ||= _decorator_class
 
-        object_or_collection = _decorate(object_or_collection, with: with)
+        object_or_enumerable = _decorate(object_or_enumerable, with: with)
 
         if block_given?
-          yield object_or_collection
+          yield object_or_enumerable
         else
-          object_or_collection
+          object_or_enumerable
         end
       end
 
       # Define that an association must be decorated.
       #
       # @param relation_name [String, Symbol] the association name to decorate.
-      # @option opts [Class] :with the decorator class to use. If empty a decorator will be guessed.
+      # @param with [Class] 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.sub("Decorator", ""))
       end
 
       private
 
+      # @api 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) }
+        with = _guess_decorator(object_or_enumerable) if with.nil? || with == :__guess__
+
+        if object_or_enumerable.is_a? Enumerable
+          object_or_enumerable.map { |object| _decorate(object, with: with) }
         else
           with.new(object_or_enumerable)
         end
       end
 
+      # @api private
       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} object")
       end
-    end
 
-    delegate :decorate, to: :class
+      # @api private
+      def decorable?(object_or_enumerable)
+        return false if defined?(ActiveRecord::Relation) \
+          && object_or_enumerable.is_a?(ActiveRecord::Relation) \
+          && object_or_enumerable.blank?
 
-    def initialize(object)
-      @decorated_associations = {}
+        return false if object_or_enumerable.respond_to?(:empty?) && object_or_enumerable.empty?
+        return false if !object_or_enumerable
+        return false if object_or_enumerable.is_a?(Dekorator::Base)
 
-      super(object)
-    end
+        true
+      end
 
-    def object
-      __getobj__
-    end
+      # @api private
+      def _safe_constantize(class_name)
+        Object.const_get(class_name)
+      rescue NameError => _
+        nil
+      end
 
-    if defined?(ActiveRecord::Relation)
-      class DecoratedEnumerableProxy < DelegateClass(ActiveRecord::Relation)
-        include Enumerable
+      # @api private
+      def _decorator_class
+        return nil if self == Dekorator::Base
 
-        delegate :as_json, :collect, :map, :each, :[], :all?, :include?,
-                 :first, :last, :shift, to: :decorated_collection
-        delegate :each, to: :to_ary
+        self
+      end
+    end
 
-        def initialize(collection, decorator_class)
-          super(collection)
+    # Decorate an object
+    #
+    # @param object [Object] object to decorate.
+    def initialize(object)
+      @_decorated_associations = {}
 
-          @decorator_class = decorator_class
-        end
+      super(object)
+    end
 
-        def wrapped_collection
-          __getobj__
-        end
+    # Decorate an object with a decorator.
+    #
+    # @param object_or_enumerable [Object, Enumerable] the object or Enumerable to decorate.
+    # @param with [Class] the decorator class to use. If empty a decorator will be guessed.
+    #
+    # @return [Dekorator::Base] if object given.
+    # @return [Enumerable] if Enumerable given.
+    #
+    # @raise [DecoratorNotFound] if decorator is not found.c
+    def decorate(object_or_enumerable, with: :__guess__)
+      self.class.decorate(object_or_enumerable, with: with)
+    end
 
-        def decorated_collection
-          @decorated_collection ||= wrapped_collection.collect { |member| @decorator_class.decorate(member) }
-        end
-        alias to_ary decorated_collection
-      end
+    # Returns the decorated object.
+    #
+    # @return [Object] the decorated object.
+    def object
+      __getobj__
     end
   end
 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.2.1
 platform: ruby
 authors:
-- Nicolas Brousse
+- Pantographe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-30 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -16,60 +16,80 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -88,16 +108,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,55 +135,43 @@ 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
+- ".codeclimate.yml"
+- ".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/rails/tasks/dekorator.rake
 - 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 +183,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.2.9
 signing_key: 
 specification_version: 4
 summary: An opinionated way of organizing model-view code in Ruby on Rails, based

data/.editorconfig

@@ -1,14 +0,0 @@
-; top-most EditorConfig file
-root = true
-
-; Unix-style newlines
-[*]
-end_of_line = LF
-indent_style = space
-indent_size = 2
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,114 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.2
-  DisabledByDefault: true
-  Exclude:
-    - lib/generators/**/templates/**/*
-
-Gemspec/OrderedDependencies:
-  Enabled: true
-
-Style/BlockDelimiters:
-  Enabled: true
-
-Style/BracesAroundHashParameters:
-  Enabled: true
-  EnforcedStyle: no_braces
-
-Style/Dir:
-  Enabled: true
-
-Style/Encoding:
-  Enabled: true
-
-Style/For:
-  Enabled: true
-  EnforcedStyle: each
-
-Style/MethodCallWithoutArgsParentheses:
-  Enabled: true
-
-Style/MethodDefParentheses:
-  Enabled: true
-
-Style/FrozenStringLiteralComment:
-  Enabled: true
-  EnforcedStyle: always
-
-Naming/ConstantName:
-  Enabled: true
-
-Naming/FileName:
-  Enabled: true
-
-Naming/MethodName:
-  Enabled: true
-
-Naming/PredicateName:
-  Enabled: true
-
-Naming/VariableName:
-  Enabled: true
-
-Lint/DeprecatedClassMethods:
-  Enabled: true
-
-Layout/AlignParameters:
-  Enabled: true
-
-Layout/BlockAlignment:
-  Enabled: true
-  EnforcedStyleAlignWith: start_of_block
-
-Layout/BlockEndNewline:
-  Enabled: true
-
-Layout/CaseIndentation:
-  Enabled: true
-
-Layout/ClosingParenthesisIndentation:
-  Enabled: true
-
-Layout/ConditionPosition:
-  Enabled: true
-
-Layout/DefEndAlignment:
-  Enabled: true
-
-Layout/DotPosition:
-  Enabled: true
-
-Layout/ElseAlignment:
-  Enabled: true
-
-Layout/EmptyLines:
-  Enabled: true
-
-Layout/EmptyLinesAroundAccessModifier:
-  Enabled: true
-
-Layout/SpaceAroundBlockParameters:
-  Enabled: true
-
-Layout/SpaceAroundEqualsInParameterDefault:
-  Enabled: true
-
-Layout/SpaceAroundOperators:
-  Enabled: true
-
-Layout/SpaceBeforeBlockBraces:
-  Enabled: true
-
-Layout/SpaceBeforeComma:
-  Enabled: true
-
-Layout/SpaceInsideArrayLiteralBrackets:
-  Enabled: true
-
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: true
-
-Layout/SpaceInsideParens:
-  Enabled: true
-
-Layout/TrailingWhitespace:
-  Enabled: true

data/.simplecov

@@ -1,5 +0,0 @@
-SimpleCov.minimum_coverage 70 # TODO: should be 90
-
-SimpleCov.start do
-  add_filter "/spec/"
-end