tiny_decorator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 556129b98566d8008a5debe82b1b482fdca17b671a7f5216efe52b6cb3c133a9
-  data.tar.gz: bbe8d99109236b1af9f6b0627e7efb5de0bb609a02a3113fbb940812da8e71eb
+  metadata.gz: 364b7fcece5d8c7d52133df5b8acf3ccb5b79ea275e47ed9f5955d297b25f163
+  data.tar.gz: bec109f60ccecf10b5cb18182188f2e4a435bf00af57327226155129654fdcb0
 SHA512:
-  metadata.gz: a7c87eab3b528b9cbbdc1cb63550a2d64bcfff06bfe15bc5af5db13a3abdce1153ec09615c96bbeb56cb06c2cc4c73c8e0a52f7841134d9c231585e5ee97b8aa
-  data.tar.gz: 8decc6dd24638f49b3c71a4165a9d92353689943b4ee48accf6514188256d35ed7d9195f445da1c219b66f277dd2d24f1652dd2b651770d1e9d4ef9d8054ffc4
+  metadata.gz: 316ed45920375aba4766fbd74454b857e17d1425c60c12f559b5d0978cf26d64561ce5d4fbc6f8bbdb77f4452a7cc574a5c12f3e881c598377389beb1dfa51b5
+  data.tar.gz: 9944fb695a7e58467e522bcc9bccff267ccda41cfe0167504eb8e4952df0f55ec26f867ba2ec5a6630ef3fa51a9bdd49948efec4138694b5ced25aa97c73c6cb

data/Gemfile

@@ -4,3 +4,8 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in tiny_decorator.gemspec
 gemspec
+
+gem 'pry-byebug'
+gem 'benchmark-ips'
+gem 'draper'
+gem 'ruby-prof'

data/Gemfile.lock

@@ -1,13 +1,77 @@
 PATH
   remote: .
   specs:
-    tiny_decorator (0.1.0)
+    tiny_decorator (0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (6.0.2.1)
+      actionview (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activemodel-serializers-xml (1.0.2)
+      activemodel (> 5.x)
+      activesupport (> 5.x)
+      builder (~> 3.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    benchmark-ips (2.7.2)
+    builder (3.2.4)
+    byebug (11.1.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
     diff-lcs (1.3)
-    rake (10.5.0)
+    draper (4.0.0)
+      actionpack (>= 5.0)
+      activemodel (>= 5.0)
+      activemodel-serializers-xml (>= 1.0)
+      activesupport (>= 5.0)
+      request_store (>= 1.0)
+    erubi (1.9.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    rake (13.0.1)
+    request_store (1.5.0)
+      rack (>= 1.4)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -21,15 +85,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    ruby-prof (1.3.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  benchmark-ips
   bundler (~> 1.16)
-  rake (~> 10.0)
+  draper
+  pry-byebug
+  rake (>= 12.3.3)
   rspec (~> 3.0)
+  ruby-prof
   tiny_decorator!
 
 BUNDLED WITH
-   1.17.1
+   1.17.3

data/README.md

@@ -63,6 +63,21 @@ NewDecorator.decorate_collection(models, context)
 
 ```
 
+### Preload
+
+In case rails' eager loading doesn't fit, or we don't use. `preload` could be used to avoid N+1.
+
+```ruby
+  preload :count_all, ->(all_records, context, preloaded) { Group(all_records).count }
+  #   all_records - all the records to decorate
+  #   context     - The context passed to collection decorating,
+  #     because preload run once before all decratings, this is the only cotext we have at this time
+  #   preloaded   - all preloaded before. For perfomrance, it's mutable, please handle with care
+```
+
+Then each single decorator could access through `preload[:count_all]`.
+Note: `preload` will be run once before decorating all records, compare to context will be ran for each record.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/tiny_decorator/composite_decorator.rb

@@ -1,6 +1,7 @@
 module TinyDecorator
   #
   # Passing only decorator name, object will be decorated
+  # 
   # ```
   #   extend TinyDecorator::CompositeDecorator
   #   decorated_by :default, 'DefaultDecorator'
@@ -33,18 +34,37 @@ module TinyDecorator
   # The decorator is a sub class of TinyDecorator::BaseDelegator (or draper decorator, but not recommend)
   # TinyDecorator::BaseDelegator will answer the question which attributes are decorated.
   #
+  # In case we don't have eager loading or rails' eager loading doesn't match,
+  #   preload block could be used to manually load data to avoid N+1.
+  #   Then access through 3rd param of decorator
+  #
+  # ```ruby
+  #   preload :count_all, ->(all_records, context, preloaded) { Group(all_records).count }
+  # ```
+  #   all_records - all the records to decorate
+  #   context     - The context passed to collection decorating,
+  #     because preload run once before all decratings, this is the only cotext we have at this time
+  #   preloaded   - all preloaded before. For perfomrance, it's mutable, please handle with care
+  #
   module CompositeDecorator
     # Decorate collection of objects, each object is decorate by `#decorate`
-    # TODO: [AV] It's greate if with activerecord relationshop, we defer decorate until data retrieved.
+    # TODO: [AV] It's greate if with activerecord relationship, we defer decorate until data retrieved.
     #       Using `map` will make data retrieval executes immediately
     def decorate_collection(records, context = {})
+      if instance_variable_get(:@_preloaders)
+        preloaded = {}
+        instance_variable_get(:@_preloaders).each do |preloader, execute_block|
+          preloaded[preloader] = execute_block.call(records, context, preloaded)
+        end
+      end
+
       Array(records).map do |record|
-        decorate(record, context)
+        decorate(record, context, preloaded)
       end
     end
 
     # Decorate an object by defined `#decorated_by`
-    def decorate(record, context = {})
+    def decorate(record, context = {}, preloaded = {})
       if instance_variable_get(:@_contexts)
         context = context.merge(instance_variable_get(:@_contexts).inject({}) do |carry, (context_name, context_block)|
           context[context_name] = context_block.call(record, context)
@@ -53,14 +73,14 @@ module TinyDecorator
         end)
       end
 
-      instance_variable_get(:@decorators).inject(record) do |carry, (name, value)|
+      instance_variable_get(:@_decorators).inject(record) do |carry, (name, value)|
         decorator = decorator_resolver(name, value, record, context)
         if decorator
           carry = begin
             const_get(decorator, false)
           rescue NameError
             Object.const_get(decorator, false)
-          end.decorate(carry, context)
+          end.decorate(carry, context, preloaded)
         end
 
         carry
@@ -69,18 +89,31 @@ module TinyDecorator
 
     private
 
+    # decorated_by
     def decorated_by(decorate_name, class_name, condition_block = nil)
-      decorators = instance_variable_get(:@decorators) || {}
+      decorators = instance_variable_get(:@_decorators) || {}
       decorators[decorate_name] = [class_name, condition_block]
-      instance_variable_set(:@decorators, decorators)
+      instance_variable_set(:@_decorators, decorators)
     end
 
+    # set_context
     def set_context(context_name, context_block)
       _contexts = instance_variable_get(:@_contexts) || {}
       _contexts[context_name] = context_block
       instance_variable_set(:@_contexts, _contexts)
     end
 
+    # preload
+    # Similar to context. but run once on whole collection
+    # preload preload_name, ->(records, preloaded) do
+    #   Relation.where(id: records.map(&:relation_id).compact.uniq)
+    # end
+    def preload(preloader, preloader_block)
+      _preloaders = instance_variable_get(:@_preloaders) || {}
+      _preloaders[preloader] = preloader_block
+      instance_variable_set(:@_preloaders, _preloaders)
+    end
+
     # Resolve decorator class from #decorated_by definition
     # if 1st param is a block, evaluate it as decorator name
     # if 1st param isn't a block

data/lib/tiny_decorator/delegatable.rb

@@ -0,0 +1,79 @@
+module TinyDecorator
+  module Delegatable
+    RUBY_RESERVED_KEYWORDS = %w(alias and BEGIN begin break case class def defined? do
+                             else elsif END end ensure false for if in module next nil not or redo rescue retry
+                             return self super then true undef unless until when while yield)
+    DELEGATION_RESERVED_KEYWORDS = %w(_ arg args block)
+    DELEGATION_RESERVED_METHOD_NAMES = Set.new(RUBY_RESERVED_KEYWORDS + DELEGATION_RESERVED_KEYWORDS).freeze
+
+    unless defined?(delegate)
+      # =========================================================
+      # File activesupport/lib/active_support/core_ext/module/delegation.rb, line 154
+      # In case we don't use rails, include their well known `delegate`
+      # I have no idea of how to write it better
+      # =========================================================
+      def delegate(*methods, to: nil, prefix: nil, allow_nil: nil)
+        unless to
+          raise ArgumentError, "Delegation needs a target. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, to: :greeter)."
+        end
+
+        if prefix == true && /^[^a-z_]/.match?(to)
+          raise ArgumentError, "Can only automatically set the delegation prefix when delegating to a method."
+        end
+
+        method_prefix = if prefix
+            "#{prefix == true ? to : prefix}_"
+          else
+            ""
+          end
+
+        location = caller_locations(1, 1).first
+        file, line = location.path, location.lineno
+
+        to = to.to_s
+        to = "self.#{to}" if TinyDecorator::Delegatable::DELEGATION_RESERVED_METHOD_NAMES.include?(to)
+
+        methods.map do |method|
+          # Attribute writer methods only accept one argument. Makes sure []=
+          # methods still accept two arguments.
+          definition = /[^\]]=$/.match?(method) ? "arg" : "*args, &block"
+
+          # The following generated method calls the target exactly once, storing
+          # the returned value in a dummy variable.
+          #
+          # Reason is twofold: On one hand doing less calls is in general better.
+          # On the other hand it could be that the target has side-effects,
+          # whereas conceptually, from the user point of view, the delegator should
+          # be doing one call.
+          if allow_nil
+            method_def = [
+              "def #{method_prefix}#{method}(#{definition})",
+              "_ = #{to}",
+              "if !_.nil? || nil.respond_to?(:#{method})",
+              "  _.#{method}(#{definition})",
+              "end",
+            "end"
+            ].join ";"
+          else
+            exception = %(raise DelegationError, "#{self}##{method_prefix}#{method} delegated to #{to}.#{method}, but #{to} is nil: \#{self.inspect}")
+
+            method_def = [
+              "def #{method_prefix}#{method}(#{definition})",
+              " _ = #{to}",
+              "  _.#{method}(#{definition})",
+              "rescue NoMethodError => e",
+              "  if _.nil? && e.name == :#{method}",
+              "    #{exception}",
+              "  else",
+              "    raise",
+              "  end",
+              "end"
+            ].join ";"
+          end
+
+          module_eval(method_def, file, line)
+        end
+      end
+    end
+  end
+end

data/lib/tiny_decorator/single_decorator.rb

@@ -1,3 +1,5 @@
+require 'tiny_decorator/delegatable'
+
 module TinyDecorator
   # Single decorator. Inherite, then define methods to use.
   # This base decorator delegates all. To limit delegation to source object.
@@ -19,11 +21,12 @@ module TinyDecorator
     # Initialize, use `.decorate` or `.new` are the same
     # @param delegatee [Object] source object to decorate
     # @param context [Hash] context as hash, could read within decorator scope by `context[]`
-    def initialize(delegatee, context = {})
+    def initialize(delegatee, context = {}, preloaded = {})
       @context = context
+      @preloaded = preloaded
       __setobj__(delegatee)
     end
-    attr_reader :context
+    attr_reader :context, :preloaded
 
     class << self
       # Decorate a collection, collection must extend Enum behavior
@@ -36,6 +39,8 @@ module TinyDecorator
       end
 
       alias decorate new
+
+      include TinyDecorator::Delegatable
     end
   end
 end

data/lib/tiny_decorator/version.rb

@@ -1,3 +1,3 @@
 module TinyDecorator
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/tiny_decorator.gemspec

@@ -34,6 +34,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_decorator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - An Vo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-01 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,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
@@ -75,6 +75,7 @@ files:
 - bin/setup
 - lib/tiny_decorator.rb
 - lib/tiny_decorator/composite_decorator.rb
+- lib/tiny_decorator/delegatable.rb
 - lib/tiny_decorator/single_decorator.rb
 - lib/tiny_decorator/version.rb
 - tiny_decorator.gemspec
@@ -98,7 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A simple decorator untility module