detaso-oprah 0.3.0

data/lib/oprah/presenter.rb

@@ -0,0 +1,149 @@
+module Oprah
+  class Presenter < SimpleDelegator
+    # @return [ActionView::Base] The view context
+    attr_reader :view_context
+
+    alias :h :view_context
+
+    # @!visibility private
+    @@cache = ActiveSupport::Cache::MemoryStore.new
+
+    class << self
+      # Returns the shared presenter cache object.
+      #
+      # @return [ActiveSupport::Cache::MemoryStore]
+      def cache
+        @@cache
+      end
+
+      # Presents the given `object` with all it's matching presenters,
+      # following it's ancestors in reverse.
+      #
+      # @param object [Object] The object to present
+      # @param view_context [ActionView::Context] View context to assign
+      # @param only [Class] Class or Array of presenters to use
+      # @return [Presenter] Presented object
+      def present(object, view_context: default_view_context, only: nil)
+        presenters = presenter_classes_for(object)
+        presenters &= Array(only) if only
+
+        presenters.inject(object) do |memo, presenter|
+          presenter.new(memo, view_context: view_context)
+        end
+      end
+
+      # Presents the given `objects` with all their matching presenters.
+      # The behaviour and parameters are identical to `.present`'s.
+      #
+      # @param objects [Enumerable] The objects to present
+      # @see .present
+      def present_many(objects, **kwargs)
+        objects.map { |object| present(object, **kwargs) }
+      end
+
+      # Automatically wrap the objects returned by the given one-to-one
+      # `association` method in presenters.
+      #
+      # Presenters will re-use the parent's assigned view context.
+      #
+      # @param association [Symbol] Name of the association
+      # @return [Symbol] Name of the association
+      def presents_one(association)
+        define_method association do
+          present(__getobj__.__send__(association))
+        end
+
+        association
+      end
+
+      # Automatically wrap the objects returned by the given one-to-many
+      # or many-to-many `association` method in presenters.
+      #
+      # Presenters will re-use the parent's assigned view context.
+      #
+      # @param association [Symbol] Name of the association
+      # @return [Symbol] Name of the association
+      def presents_many(association)
+        define_method association do
+          present_many(__getobj__.__send__(association))
+        end
+
+        association
+      end
+
+      # Returns the default view context to use if no view context is explicitly
+      # passed to the presenter.
+      #
+      # @return [ActionView::Context]
+      def default_view_context
+        ActionController::Base.new.view_context
+      end
+
+      private
+
+      # @since 0.2.0
+      def presenter_classes_for(object)
+        klass = object.class
+
+        @@cache.fetch klass.name do
+          klass.ancestors.map do |ancestor|
+            (ancestor.name + "Presenter").safe_constantize if ancestor.name
+          end.compact.reverse
+        end
+      end
+    end
+
+    # Initializes a new Presenter.
+    #
+    # @param object [Object] The object to present
+    # @param view_context [ActionView::Context] View context to assign
+    def initialize(object, view_context: self.class.default_view_context)
+      __setobj__(object)
+      @view_context = view_context
+    end
+
+    # Presents a single object.
+    #
+    # Will re-use the presenter's assigned view context if no `view_context`:
+    # parameter is given.
+    #
+    # @see .present
+    def present(*args, **kwargs, &block)
+      kwargs = { view_context: view_context }.merge(kwargs)
+      self.class.present(*args, **kwargs, &block)
+    end
+
+    # Presents a collection of objects.
+    #
+    # Will re-use the presenter's assigned view context if no `view_context`:
+    # parameter is given.
+    #
+    # @see .present_many
+    def present_many(*args, **kwargs, &block)
+      kwargs = { view_context: view_context }.merge(kwargs)
+      self.class.present_many(*args, **kwargs, &block)
+    end
+
+    # Returns true if `klass` is the class of the presented object or the
+    # presenter, or if `#class` is one of the superclasses of the presented
+    # object, the presenter or modules included in the presented object or the
+    # presenter.
+    #
+    # @param other [Module]
+    # @return [Boolean] result
+    def kind_of?(other)
+      super || __getobj__.kind_of?(other)
+    end
+
+    alias :is_a? :kind_of?
+
+    # Returns `true` if the presented object or the presenter is an instance
+    # of the given `class`.
+    #
+    # @param klass [Class]
+    # @return [Boolean] result
+    def instance_of?(klass)
+      super || __getobj__.instance_of?(klass)
+    end
+  end
+end

data/lib/oprah/railtie.rb

@@ -0,0 +1,27 @@
+require 'rails/railtie'
+
+module Oprah
+  class Railtie < Rails::Railtie
+    initializer "oprah.configure_cache_clear_on_code_reload" do
+      ActiveSupport::Reloader.to_run do
+        Oprah::Presenter.cache.clear
+
+        if Oprah.debug?
+          Rails.logger.debug "Oprah cache cleared"
+        end
+      end
+    end
+
+    initializer "oprah.configure_action_controller_helpers" do
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.include(Oprah::ControllerHelpers)
+      end
+    end
+
+    initializer "oprah.configure_action_mailer_helpers" do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.include(Oprah::ControllerHelpers)
+      end
+    end
+  end
+end

data/lib/oprah/test_helpers.rb

@@ -0,0 +1,47 @@
+module Oprah
+  # Test helpers that can be included into `Minitest::Test` or
+  # `ActiveSupport::TestCase`.
+  #
+  # @since 0.1.2
+  module TestHelpers
+    # Presents a collection of objects.
+    #
+    # @see Presenter.present_many
+    def present_many(*args, **kwargs, &block)
+      Presenter.present_many(*args, **kwargs, &block)
+    end
+
+    # Presents a single object.
+    #
+    # @see Presenter.present
+    def present(*args, **kwargs, &block)
+      Presenter.present(*args, **kwargs, &block)
+    end
+
+    # Fails unless `object` is a presenter.
+    #
+    # @since 0.1.3
+    # @param [Object] object The object to be tested
+    # @return [Boolean]
+    def assert_presented(object)
+      msg = message(msg) do
+        "Expected #{mu_pp(object)} to be an Oprah::Presenter"
+      end
+
+      assert object.kind_of?(Oprah::Presenter), msg
+    end
+
+    # Fails if `object` is a presenter.
+    #
+    # @since 0.1.3
+    # @param [Object] object The object to be tested
+    # @return [Boolean]
+    def refute_presented(object)
+      msg = message(msg) do
+        "Expected #{mu_pp(object)} to not be an Oprah::Presenter"
+      end
+
+      refute object.kind_of?(Oprah::Presenter), msg
+    end
+  end
+end

data/lib/oprah/version.rb

@@ -0,0 +1,4 @@
+module Oprah
+  # @return [String] The Oprah library version.
+  VERSION = "0.3.0"
+end

data/lib/oprah.rb

@@ -0,0 +1,43 @@
+# stdlib
+require 'delegate'
+
+# gems
+require 'active_support/cache'
+require 'active_support/concern'
+require 'active_support/inflector'
+require 'active_support/proxy_object'
+require 'action_controller'
+
+# internal
+require 'oprah/controller_helpers'
+require 'oprah/presenter'
+require 'oprah/version'
+
+require 'oprah/railtie' if defined?(Rails)
+
+# The Oprah namespace.
+#
+# @since 0.0.1
+module Oprah
+  # @!visibility private
+  def debug?
+    !!ENV["OPRAH_DEBUG"]
+  end
+
+  # Presents a single object.
+  #
+  # @see Presenter.present
+  def present(*args, **kwargs, &block)
+    Presenter.present(*args, **kwargs, &block)
+  end
+
+  # Presents a collection of objects.
+  #
+  # @see Presenter.present_many
+  def present_many(*args, **kwargs, &block)
+    Presenter.present_many(*args, **kwargs, &block)
+  end
+
+  extend self
+end
+

data/oprah.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oprah/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "detaso-oprah"
+  gem.version       = Oprah::VERSION
+  gem.authors       = ["Tobias Svensson"]
+  gem.email         = ["tob@tobiassvensson.co.uk"]
+  gem.summary       = "Opinionated presenters for Rails 5 - without the cruft"
+  gem.description   = gem.summary
+  gem.homepage      = "https://github.com/detaso/oprah"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activesupport", ">= 5.0.0"
+  gem.add_dependency "actionpack", ">= 5.0.0"
+
+  gem.add_development_dependency "bundler", "~> 2"
+  gem.add_development_dependency "minitest", "~> 5.9.0"
+  gem.add_development_dependency "rails", ">= 5.0.0"
+  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "redcarpet", "~> 3.3.4"
+  gem.add_development_dependency "yard", "~> 0.9.5"
+  gem.add_development_dependency "sqlite3", "~> 1.3.11"
+end

data/tasks/bundler.rb

@@ -0,0 +1,5 @@
+require 'bundler/gem_helper'
+
+namespace :gem do
+  Bundler::GemHelper.install_tasks name: 'oprah'
+end

data/tasks/console.rb

@@ -0,0 +1,35 @@
+class RakeConsole
+  GEM = Dir["*.gemspec"].first.sub('.gemspec', '')
+  REQUIRE_PATH = File.join(Dir.pwd, 'lib', GEM)
+
+  module Helpers
+    def reload!
+      puts "Reloading..."
+      $LOADED_FEATURES.select do |feat|
+        feat =~ /\/#{GEM}\//
+      end.each { |file| load file }
+      true
+    end
+  end
+
+  def start
+    require REQUIRE_PATH
+    ARGV.clear
+    Object.include(Helpers)
+
+    begin
+      require 'pry'
+      TOPLEVEL_BINDING.pry
+    rescue LoadError
+      require 'irb'
+      require 'irb/completion'
+      IRB.start
+    end
+  end
+end
+
+desc "Start development console"
+task :console do
+  RakeConsole.new.start
+end
+

data/tasks/minitest.rb

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = false
+end
+

data/tasks/yard.rb

@@ -0,0 +1,16 @@
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = %w{
+    --verbose
+    --markup markdown
+    --readme README.md
+    --tag comment
+    --hide-tag comment
+    --hide-void-return
+    -M
+    redcarpet
+  }
+end

data/test/controllers/posts_controller_test.rb

@@ -0,0 +1,10 @@
+require 'helper'
+
+class PostsControllerTest < ActionController::TestCase
+  def test_show
+    get :show, params: { id: 1 }
+
+    expected = "<p>\n  Hello!\n</p>"
+    assert_equal expected, response.body
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  include Oprah::ControllerHelpers
+end

data/test/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,5 @@
+class PostsController < ApplicationController
+  def show
+    @post = present Post.new
+  end
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,2 @@
+class ApplicationMailer < ActionMailer::Base
+end

data/test/dummy/app/mailers/post_mailer.rb

@@ -0,0 +1,8 @@
+class PostMailer < ApplicationMailer
+  default from: 'bar@baz', to: 'foo@bar'
+
+  def notification(post)
+    @post = present(post)
+    mail(subject: 'Foobar')
+  end
+end

data/test/dummy/app/models/post.rb

@@ -0,0 +1,2 @@
+class Post
+end

data/test/dummy/app/presenters/post_presenter.rb

@@ -0,0 +1,5 @@
+class PostPresenter < Oprah::Presenter
+  def paragraph(&block)
+    h.content_tag(:p, &block)
+  end
+end

data/test/dummy/app/views/post_mailer/notification.html.erb

@@ -0,0 +1,3 @@
+<%= @post.paragraph do %>
+  Hello!
+<% end %>

data/test/dummy/app/views/posts/show.html.erb

@@ -0,0 +1,3 @@
+<%= @post.paragraph do %>
+  Hello!
+<% end %>

data/test/dummy/config/database.yml

@@ -0,0 +1,6 @@
+
+test:
+  adapter: sqlite3
+  database: ':memory:'
+  pool: 5
+  timeout: 5000

data/test/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Dummy::Application.routes.draw do
+  resources :posts, only: [:show]
+end

data/test/dummy/init.rb

@@ -0,0 +1,29 @@
+ENV['RAILS_ENV'] ||= 'test'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __FILE__)
+require 'bundler/setup'
+require 'rails/all'
+Bundler.require(:default, Rails.env)
+
+module Dummy
+  class Application < ::Rails::Application
+    config.root = File.join __FILE__, '..'
+    config.cache_store = :memory_store
+    config.assets.enabled = false
+    config.active_support.test_order = :random
+    config.consider_all_requests_local = true
+    config.action_controller.perform_caching = false
+    config.action_dispatch.show_exceptions = false
+    config.action_controller.allow_forgery_protection = false
+    config.action_mailer.delivery_method = :test
+    config.active_support.deprecation = :stderr
+    config.allow_concurrency = true
+    config.cache_classes = true
+    config.dependency_loading = true
+    config.preload_frameworks = true
+    config.eager_load = true
+    config.secret_key_base = '012345678901234567890123456789'
+  end
+end
+
+Dummy::Application.initialize!
+require 'rails/test_help'

data/test/helper.rb

@@ -0,0 +1,84 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'oprah'
+require 'oprah/railtie'
+require 'oprah/test_helpers'
+require 'dummy/init'
+
+class Minitest::Test
+  include Oprah::TestHelpers
+
+  def setup
+    super
+    Oprah::Presenter.cache.clear
+  end
+end
+
+module Fixtures
+  module Entity
+  end
+
+  class EntityPresenter < Oprah::Presenter
+    def foo
+      "foo"
+    end
+  end
+
+  class User
+    include Entity
+
+    def first_name
+      "Foo"
+    end
+
+    def last_name
+      "Bar"
+    end
+
+    private
+
+    def password
+      "baz"
+    end
+  end
+
+  class UserPresenter < Oprah::Presenter
+    def name
+      [first_name, last_name].join(' ')
+    end
+
+    def foo
+      super + "bar"
+    end
+  end
+
+  class Comment
+  end
+
+  class CommentPresenter < Oprah::Presenter
+  end
+
+  class Project
+    def comments
+      Array.new(3) { Comment.new }
+    end
+
+    def owner
+      User.new
+    end
+  end
+
+  class ProjectPresenter < Oprah::Presenter
+    presents_many :comments
+    presents_one :owner
+  end
+
+  # EigenUser contains eigen class in ancestors list.
+  #
+  # > EigenUser.ancestors
+  # => [Fixtures::EigenUser, #<Module:0x007faa79b128f0>, Object, ... , Kernel, BasicObject]
+  #
+  class EigenUser
+    include Module.new
+  end
+end

data/test/mailers/post_mailer_test.rb

@@ -0,0 +1,13 @@
+class PostMailerTest < ActionMailer::TestCase
+  def test_invite
+    post = Post.new
+    email = PostMailer.notification(Post.new)
+
+    assert_emails 1 do
+      email.deliver_now
+    end
+
+    expected = "<p>\n  Hello!\n</p>"
+    assert_equal expected, email.body.to_s
+  end
+end

data/test/oprah/controller_helpers_test.rb

@@ -0,0 +1,65 @@
+require 'helper'
+
+module Oprah
+  class ControllerHelpersTest < Minitest::Test
+    class Controller
+      @@helper_methods = []
+
+      class << self
+        def helper_methods
+          @@helper_methods
+        end
+
+        def helper_method(method)
+          @@helper_methods << method
+        end
+      end
+
+      def view_context
+        :ok
+      end
+
+      include Oprah::ControllerHelpers
+    end
+
+    include Fixtures
+
+    def setup
+      super
+      @controller = Controller.new
+    end
+
+    def test_present
+      presenter = @controller.present(User.new)
+
+      assert_kind_of UserPresenter, presenter
+      assert_kind_of EntityPresenter, presenter
+
+      assert_equal "ok", presenter.view_context.to_s
+    end
+
+    def test_present_custom_view_context
+      presenter = @controller.present(User.new, view_context: :foobar)
+      assert_equal :foobar, presenter.view_context
+    end
+
+    def test_present_many
+      presenters = @controller.present_many([User.new, User.new])
+
+      assert_equal 2, presenters.length
+
+      presenters.each do |presenter|
+        assert_equal "Foo Bar", presenter.name
+        assert_equal "ok", presenter.view_context.to_s
+      end
+    end
+
+    def test_helper_method
+      assert_equal [:present, :present_many], Controller.helper_methods
+    end
+
+    def test_oprah_view_context
+      assert_equal @controller.oprah_view_context, @controller.view_context
+    end
+  end
+end

data/test/oprah/oprah_test.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+module Oprah
+  class Test < Minitest::Test
+    def test_debug
+      old = ENV["OPRAH_DEBUG"]
+
+      ENV["OPRAH_DEBUG"] = nil
+      refute Oprah.debug?
+
+      ENV["OPRAH_DEBUG"] = "1"
+      assert Oprah.debug?
+
+      ENV["OPRAH_DEBUG"] = old
+    end
+  end
+end