dekorator 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e632f3f499971f15713b16354a960d3c0c2e42436694a040d5a77c8627baec7a
-  data.tar.gz: 1318630635b3406f2336d0d144d1651c0b66bb013e4f5e342c726314ba145b30
+  metadata.gz: b54b4599f372c2cf35b0ac966ef4491374af34cb11a02081ed94c1e98b54d5ba
+  data.tar.gz: 816309b5406ab7f95b2468e9a3c1b16fcdc1f6e7e09994cef4f055d252eafa76
 SHA512:
-  metadata.gz: c51f4aa3459a64007d77e6f33361e2fdacceb56893f05cfef773c2bd0401ea92cb021bd6fc8153ff8b679fcff52de642fe7338d8cefe448b59595edc36e1ed19
-  data.tar.gz: 453e6c9a109f4b0c791a211365284adac236496dd7e7f7280103066f074e867c103f9d1c298b5096f3228e9bc4627f73713da659c38e62e5e20af5b0eaa74909
+  metadata.gz: 0fc9fed3fab894d17a0f1436c169b36cdfddab34d32e73e749458092731b921c295ed1d9d48963117df81518f88fde9f716fe81017eccbe6890e47d99b33f355
+  data.tar.gz: 299d6600c2320b28543c64c8252d2b6fa6b8714087dcbd2f59d3e79da8441b05786d17b36a441e9079dc6845a9c89c485c6a5deda4022943036b54738429656c

data/.codeclimate.yml

@@ -0,0 +1,4 @@
+exclude_patterns:
+- "benchmarks/**/*"
+- "lib/generators/**/*"
+- "spec/**/*"

data/.github/workflows/test.yml

@@ -9,17 +9,17 @@ jobs:
     strategy:
       matrix:
         versions:
-          - { ruby: "2.4.x", rails: "5.0.x" }
-          - { ruby: "2.5.x", rails: "5.0.x" }
-          - { ruby: "2.6.x", rails: "5.0.x" }
-          - { ruby: "2.4.x", rails: "5.1.x" }
-          - { ruby: "2.5.x", rails: "5.1.x" }
-          - { ruby: "2.6.x", rails: "5.1.x" }
-          - { ruby: "2.4.x", rails: "5.2.x" }
-          - { ruby: "2.5.x", rails: "5.2.x" }
-          - { ruby: "2.6.x", rails: "5.2.x" }
-          - { ruby: "2.5.x", rails: "6.0.x" }
-          - { ruby: "2.6.x", rails: "6.0.x" }
+          - { ruby: "2.5", rails: "5.2.x" }
+          - { ruby: "2.6", rails: "5.2.x" }
+          - { ruby: "2.7", rails: "5.2.x" }
+          - { ruby: "2.5", rails: "6.0.x" }
+          - { ruby: "2.6", rails: "6.0.x" }
+          - { ruby: "2.7", rails: "6.0.x" }
+          - { ruby: "3.0", rails: "6.0.x" }
+          - { ruby: "2.5", rails: "6.1.x" }
+          - { ruby: "2.6", rails: "6.1.x" }
+          - { ruby: "2.7", rails: "6.1.x" }
+          - { ruby: "3.0", rails: "6.1.x" }
 
     steps:
     - uses: actions/checkout@v1
@@ -31,9 +31,10 @@ jobs:
         key: ruby-${{ matrix.versions.ruby }}-rails-${{ matrix.versions.rails }}
 
     - name: Set up Ruby
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.versions.ruby }}
+        bundler-cache: true
 
     - name: Set up bundler
       run: |

data/CHANGELOG.md

@@ -8,6 +8,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 Nothing yet
 
+## [1.1.0] - 2020-12-23
+### Added
+- Ruby 2.7 support ([#37](https://github.com/komposable/dekorator/pull/37))
+- List decorators in Rails stats task ([#38](https://github.com/komposable/dekorator/pull/38))
+- Add Rails 6.1 support and drop Rails 5.0 and 5.1 support ([#41](https://github.com/komposable/dekorator/pull/41))
+### Changed
+- Refactorisation ([#39](https://github.com/komposable/dekorator/pull/39))
+### Removed
+- Remove `DecoratedEnumerableProxy` ([#36](https://github.com/komposable/dekorator/pull/36))
+- Drop Ruby 2.4 support ([#37](https://github.com/komposable/dekorator/pull/37))
+- Drop Rails 5.0 and 5.1 support ([#41](https://github.com/komposable/dekorator/pull/41))
+
 ## [1.0.0] - 2019-12-02
 ### Added
 - Avoid deep decoration ([#25](https://github.com/komposable/dekorator/pull/25))
@@ -28,5 +40,6 @@ Nothing yet
 - Create `dekorator:install` generator ([a2a36d66](https://github.com/komposable/dekorator/commit/a2a36d66c6de6cb0a00f783794cd29f899bc04b6))
 - Create `decorator` generator ([a2a36d66](https://github.com/komposable/dekorator/commit/a2a36d66c6de6cb0a00f783794cd29f899bc04b6))
 
-[Unreleased]: https://github.com/komposable/dekorator/compare/v1.0.0...master
-[1.0.0]: https://github.com/komposable/dekorator/compare/v1.0.0...1.0.0.pre.1
+[Unreleased]: https://github.com/komposable/dekorator/compare/v1.1.0...master
+[1.1.0]: https://github.com/komposable/dekorator/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/komposable/dekorator/compare/v1.0.0.pre.1...v1.0.0

data/README.md

@@ -13,8 +13,8 @@ This gem has been inspired by our Rails development practices at [Pantographe](h
 
 ## Compatibility
 
-* Ruby 2.4+
-* Rails 5.0+
+* Ruby 2.5+
+* Rails 5.2+
 
 ## Installation
 
@@ -156,7 +156,8 @@ decorated_user.posts.first # => ArticleDecorator
 
 ### ActiveAdmin
 
-This gem is compatible with [`activeadmin`][activeadmin].
+This gem is compatible with [`activeadmin`][activeadmin] ([2.8+](https://github.com/activeadmin/activeadmin/pull/6249)).  
+For `activeadmin` before `2.8`, use `dekorator` `1.0.*`.
 
 Simply use `#decorate_with`
 

data/benchmarks/benchmark.rb

@@ -96,8 +96,8 @@ end
 
 # Benchmark
 SCENARIOS = {
-  "#summary"        => :summary,
-  "#comments"       => :comments,
+  "#summary"  => :summary,
+  "#comments" => :comments,
 }
 
 SCENARIOS.each_pair do |name, method|

data/dekorator.gemspec

@@ -37,11 +37,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3"
 
-  spec.add_runtime_dependency "actionview", ">= 5.0", "< 6.1"
-  spec.add_runtime_dependency "activesupport", ">= 5.0", "< 6.1"
-  spec.add_runtime_dependency "railties", ">= 5.0", "< 6.1"
+  spec.add_runtime_dependency "actionview", ">= 5.2", "< 6.2"
+  spec.add_runtime_dependency "activesupport", ">= 5.2", "< 6.2"
+  spec.add_runtime_dependency "railties", ">= 5.2", "< 6.2"
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/dekorator.rb

@@ -8,6 +8,7 @@ module Dekorator
   # @api private
   module Generators; end
 
+  # :nodoc:
   class DecoratorNotFound < ArgumentError; end
 
   # Base decorator.
@@ -15,31 +16,31 @@ 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 decorable_object?(object_or_collection)
+      def decorate(object_or_enumerable, with: nil)
+        return object_or_enumerable unless decorable?(object_or_enumerable)
 
-        with ||= self if with != :__guess__ && self != Dekorator::Base
-        with = _guess_decorator(object_or_collection) if with.nil? || with == :__guess__
+        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 < Dekorator::Base
@@ -54,7 +55,7 @@ module Dekorator
         relation_name = relation_name.to_sym
 
         define_method(relation_name) do
-          @decorated_associations[relation_name] ||= decorate(__getobj__.public_send(relation_name), with: with)
+          @_decorated_associations[relation_name] ||= decorate(__getobj__.public_send(relation_name), with: with)
         end
       end
 
@@ -62,54 +63,74 @@ module Dekorator
       #
       # @return [Class] the decorated object class.
       def base_class
-        _safe_constantize(name.gsub("Decorator", ""))
+        _safe_constantize(name.sub("Decorator", ""))
       end
 
       private
 
-      def _decorate(object_or_enumerable, with:)
-        if !object_or_enumerable.is_a? Enumerable
-          with.new(object_or_enumerable)
+      # @api private
+      def _decorate(object_or_enumerable, with: nil)
+        with = _guess_decorator(object_or_enumerable) if with.nil? || with == :__guess__
+
+        if object_or_enumerable.is_a? Enumerable
+          object_or_enumerable.lazy.map { |object| _decorate(object, with: with) }
         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
+          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
 
         _safe_constantize("#{object_or_enumerable.class}Decorator") \
-          || raise(DecoratorNotFound, "Can't guess decorator for #{object_or_enumerable.class.name} object")
+          || raise(DecoratorNotFound, "Can't guess decorator for #{object_or_enumerable.class} object")
       end
 
-      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))
+      # @api private
+      def decorable?(object_or_enumerable)
+        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)
+
+        true
       end
 
+      # @api private
       def _safe_constantize(class_name)
         Object.const_get(class_name)
-      rescue NameError => _e
+      rescue NameError => _
         nil
       end
+
+      # @api private
+      def _decorator_class
+        return nil if self == Dekorator::Base
+
+        self
+      end
     end
 
-    # :nodoc
+    # Decorate an object
+    #
+    # @param object [Object] object to decorate.
     def initialize(object)
-      @decorated_associations = {}
+      @_decorated_associations = {}
 
       super(object)
     end
 
-    # :nodoc
-    def decorate(object_or_collection, with: :__guess__)
-      self.class.decorate(object_or_collection, with: with)
+    # 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
 
     # Returns the decorated object.
@@ -119,33 +140,6 @@ module Dekorator
       __getobj__
     end
   end
-
-  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
-
-      def initialize(decorator_class, collection)
-        super(collection)
-
-        @decorator_class = decorator_class
-      end
-
-      def wrapped_collection
-        __getobj__
-      end
-
-      def decorated_collection
-        @decorated_collection ||= wrapped_collection.collect { |member| @decorator_class.new(member) }
-      end
-      alias to_ary decorated_collection
-    end
-  end
 end
 
 require "dekorator/railtie" if defined?(Rails)

data/lib/dekorator/rails/controller.rb

@@ -10,8 +10,8 @@ module Dekorator
       helper_method :decorate
     end
 
-    def decorate(object_or_collection, with: nil)
-      Dekorator::Base.decorate(object_or_collection, with: with)
+    def decorate(object_or_enumerable, with: nil)
+      Dekorator::Base.decorate(object_or_enumerable, with: with)
     end
   end
 end

data/lib/dekorator/rails/tasks/dekorator.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+task stats: "dekorator:statsetup"
+
+namespace :dekorator do
+  task statsetup: :environment do
+    require "rails/code_statistics"
+
+    ::STATS_DIRECTORIES << ["Decorators", "app/decorators"]
+  end
+end

data/lib/dekorator/railtie.rb

@@ -4,12 +4,12 @@ module Dekorator
   require "dekorator/rails/controller"
 
   class Railtie < ::Rails::Railtie
-    config.to_prepare do |_app|
-      ActionController::Base.include Dekorator::Controller
+    rake_tasks do
+      load "dekorator/rails/tasks/dekorator.rake"
     end
 
-    config.after_initialize do |app|
-      app.config.paths.add "app/decorators", eager_load: true
+    config.to_prepare do |_app|
+      ActionController::Base.include Dekorator::Controller
     end
   end
 end

data/lib/dekorator/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dekorator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Pantographe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -16,60 +16,60 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   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: '6.2'
 - !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: '6.2'
   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: '6.2'
 - !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: '6.2'
   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: '6.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -88,16 +88,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
@@ -120,6 +120,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".github/workflows/test.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -131,6 +132,7 @@ files:
 - dekorator.gemspec
 - lib/dekorator.rb
 - lib/dekorator/rails/controller.rb
+- lib/dekorator/rails/tasks/dekorator.rake
 - lib/dekorator/railtie.rb
 - lib/dekorator/version.rb
 - lib/generators/decorator_generator.rb
@@ -165,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.2
 signing_key: 
 specification_version: 4
 summary: An opinionated way of organizing model-view code in Ruby on Rails, based