dekorator 1.0.0.pre.1

data/gemfiles/rails_6.0.x.gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord"
+gem "activemodel"
+gem "activesupport"
+gem "actionview"
+gem "railties"
+gem "appraisal", require: false
+gem "rubocop", require: false
+gem "rails", "~> 6.0.0.beta1"
+
+group :test do
+  gem "simplecov", require: false
+  gem "coveralls", require: false
+end
+
+gemspec path: "../"

data/gemfiles/rails_6.0.x.gemfile.lock

@@ -0,0 +1,220 @@
+PATH
+  remote: ..
+  specs:
+    dekorator (1.0.0.pre.1)
+      actionview (>= 5.0, < 6.1)
+      activesupport (>= 5.0, < 6.1)
+      railties (>= 5.0, < 6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.0.beta1)
+      actionpack (= 6.0.0.beta1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.0.beta1)
+      actionpack (= 6.0.0.beta1)
+      activejob (= 6.0.0.beta1)
+      activerecord (= 6.0.0.beta1)
+      activestorage (= 6.0.0.beta1)
+      activesupport (= 6.0.0.beta1)
+      mail (>= 2.7.1)
+    actionmailer (6.0.0.beta1)
+      actionpack (= 6.0.0.beta1)
+      actionview (= 6.0.0.beta1)
+      activejob (= 6.0.0.beta1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.0.beta1)
+      actionview (= 6.0.0.beta1)
+      activesupport (= 6.0.0.beta1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actiontext (6.0.0.beta1)
+      actionpack (= 6.0.0.beta1)
+      activerecord (= 6.0.0.beta1)
+      activestorage (= 6.0.0.beta1)
+      activesupport (= 6.0.0.beta1)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.0.beta1)
+      activesupport (= 6.0.0.beta1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (6.0.0.beta1)
+      activesupport (= 6.0.0.beta1)
+      globalid (>= 0.3.6)
+    activemodel (6.0.0.beta1)
+      activesupport (= 6.0.0.beta1)
+    activerecord (6.0.0.beta1)
+      activemodel (= 6.0.0.beta1)
+      activesupport (= 6.0.0.beta1)
+    activestorage (6.0.0.beta1)
+      actionpack (= 6.0.0.beta1)
+      activerecord (= 6.0.0.beta1)
+      marcel (~> 0.3.1)
+    activesupport (6.0.0.beta1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.4)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    crass (1.0.4)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    netrc (0.11.0)
+    nio4r (2.3.1)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.0.beta1)
+      actioncable (= 6.0.0.beta1)
+      actionmailbox (= 6.0.0.beta1)
+      actionmailer (= 6.0.0.beta1)
+      actionpack (= 6.0.0.beta1)
+      actiontext (= 6.0.0.beta1)
+      actionview (= 6.0.0.beta1)
+      activejob (= 6.0.0.beta1)
+      activemodel (= 6.0.0.beta1)
+      activerecord (= 6.0.0.beta1)
+      activestorage (= 6.0.0.beta1)
+      activesupport (= 6.0.0.beta1)
+      bundler (>= 1.3.0)
+      railties (= 6.0.0.beta1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (6.0.0.beta1)
+      actionpack (= 6.0.0.beta1)
+      activesupport (= 6.0.0.beta1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.63.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tins (1.20.2)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.4.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionview
+  activemodel
+  activerecord
+  activesupport
+  appraisal
+  bundler (~> 2.0)
+  coveralls
+  dekorator!
+  rails (~> 6.0.0.beta1)
+  railties
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  simplecov
+
+BUNDLED WITH
+   2.0.1

data/lib/dekorator.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "dekorator/version"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/module/delegation"
+
+module Dekorator
+  class DecoratorNotFound < ArgumentError; end
+
+  # Base decorator.
+  class Base < SimpleDelegator
+    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.
+      #
+      # @return [Dekorator::Base, ActiveRecord::Relation, Enumerable] the obect or collection decorated.
+      #
+      # @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?
+
+        raise DecoratorNotFound, "Can't guess decorator for #{object_or_collection.class.name} object" if with.nil?
+
+        object_or_collection = _decorate(object_or_collection, with: with)
+
+        if block_given?
+          yield object_or_collection
+        else
+          object_or_collection
+        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.
+      #
+      # @example Define an association to decorate
+      #   class UserDecorator < ApplicationDecorator
+      #     decorates_association :posts
+      #   end
+      #
+      #   # A decorator could be precise
+      #   class UserDecorator < ApplicationDecorator
+      #     decorates_association :posts, PostDecorator
+      #   end
+      def decorates_association(relation_name, with: nil)
+        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)
+        end
+      end
+
+      def base_class
+        name.gsub("Decorator", "").safe_constantize
+      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
+          with.new(object_or_enumerable)
+        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?
+      end
+    end
+
+    delegate :decorate, to: :class
+
+    def initialize(object)
+      @decorated_associations = {}
+
+      super(object)
+    end
+
+    def object
+      __getobj__
+    end
+
+    if defined?(ActiveRecord::Relation)
+      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(collection, decorator_class)
+          super(collection)
+
+          @decorator_class = decorator_class
+        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
+      end
+    end
+  end
+end
+
+require "dekorator/railtie" if defined?(Rails)

data/lib/dekorator/decorators_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DecoratorsHelper
+  delegate :decorate, to: "Dekorator::Base"
+end

data/lib/dekorator/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "dekorator/decorators_helper"
+
+module Dekorator
+  class Railtie < Rails::Railtie
+    initializer "decorators.helper" do |_app|
+      ActionView::Base.send :include, DecoratorsHelper
+    end
+  end
+end

data/lib/dekorator/version.rb

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

data/lib/generators/decorator/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Generate a fresh new decorator
+
+Example:
+    `rails generate decorator User`
+
+    User decorator.
+        Decorator: app/decorators/user_decorator.rb
+        Test:      test/decorators/user_decorator_test.rb

data/lib/generators/decorator/decorator_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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

data/lib/generators/decorator/templates/decorator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= class_name %>Decorator < ApplicationDecorator
+  # include ActionView::Helpers::TextHelper
+  #
+  # decorates_association :posts
+  #
+  # def full_name
+  #   [first_name, last_name].join(" ")
+  # end
+  #
+  # def biography_summary
+  #   truncate(biography, length: 170)
+  # end
+end
+<% end -%>

data/lib/generators/decorator/templates/decorator_test.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/lib/generators/dekorator/install_generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Dekorator
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      def create_root_directory
+        return if File.directory?(dekorator_root_directory)
+
+        empty_directory(dekorator_root_directory)
+      end
+
+      def create_application_decorator
+        return if File.exist?(application_decorator_path)
+
+        create_file application_decorator_path, <<-RUBY
+# frozen_string_literal: true
+
+class ApplicationDecorator < Dekorator::Base
+end
+        RUBY
+      end
+
+      protected
+
+      def dekorator_root_directory
+        Rails.root.join("app", "decorators")
+      end
+
+      def application_decorator_path
+        dekorator_root_directory.join("application_decorator.rb")
+      end
+    end
+  end
+end