strong_presenter 0.0.1 → 0.1.0

data/lib/strong_presenter/view_context.rb

@@ -0,0 +1,84 @@
+require 'strong_presenter/view_context/build_strategy'
+require 'request_store'
+
+module StrongPresenter
+
+  # Copied from Draper::ViewContext
+  module ViewContext
+    # Hooks into a controller or mailer to save the view context in {current}.
+    def view_context
+      super.tap do |context|
+        StrongPresenter::ViewContext.current = context
+      end
+    end
+
+    # Returns the current controller.
+    def self.controller
+      RequestStore.store[:current_controller]
+    end
+
+    # Sets the current controller.
+    def self.controller=(controller)
+      RequestStore.store[:current_controller] = controller
+    end
+
+    # Returns the current view context, or builds one if none is saved.
+    #
+    # @return [HelperProxy]
+    def self.current
+      RequestStore.store.fetch(:current_view_context) { build! }
+    end
+
+    # Sets the current view context.
+    def self.current=(view_context)
+      RequestStore.store[:current_view_context] = StrongPresenter::HelperProxy.new(view_context)
+    end
+
+    # Clears the saved controller and view context.
+    def self.clear!
+      RequestStore.store.delete :current_controller
+      RequestStore.store.delete :current_view_context
+    end
+
+    # Builds a new view context for usage in tests. See {test_strategy} for
+    # details of how the view context is built.
+    def self.build
+      build_strategy.call
+    end
+
+    # Builds a new view context and sets it as the current view context.
+    #
+    # @return [HelperProxy]
+    def self.build!
+      # send because we want to return the HelperProxy returned from #current=
+      send :current=, build
+    end
+
+    # Configures the strategy used to build view contexts in tests, which
+    # defaults to `:full` if `test_strategy` has not been called. Evaluates
+    # the block, if given, in the context of the view context's class.
+    #
+    # @example Pass a block to add helper methods to the view context:
+    #   StrongPresenter::ViewContext.test_strategy :fast do
+    #     include ApplicationHelper
+    #   end
+    #
+    # @param [:full, :fast] name
+    #   the strategy to use:
+    #
+    #   `:full` - build a fully-working view context. Your Rails environment
+    #   must be loaded, including your `ApplicationController`.
+    #
+    #   `:fast` - build a minimal view context in tests, with no dependencies
+    #   on other components of your application.
+    def self.test_strategy(name, &block)
+      @build_strategy = StrongPresenter::ViewContext::BuildStrategy.new(name, &block)
+    end
+
+    # @private
+    def self.build_strategy
+      @build_strategy ||= StrongPresenter::ViewContext::BuildStrategy.new(:full)
+    end
+
+  end
+end

data/lib/strong_presenter/view_helpers.rb

@@ -0,0 +1,39 @@
+module StrongPresenter
+  # Provides the {#helpers} method used in {Presenter} and {CollectionPresenter}
+  # to call the Rails helpers.
+
+  # Copy of Draper::ViewHelpers
+  module ViewHelpers
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      # Access the helpers proxy to call built-in and user-defined
+      # Rails helpers from a class context.
+      #
+      # @return [HelperProxy] the helpers proxy
+      def helpers
+        StrongPresenter::ViewContext.current
+      end
+      alias_method :h, :helpers
+
+    end
+
+    # Access the helpers proxy to call built-in and user-defined
+    # Rails helpers. Aliased to `h` for convenience.
+    #
+    # @return [HelperProxy] the helpers proxy
+    def helpers
+      StrongPresenter::ViewContext.current
+    end
+    alias_method :h, :helpers
+
+    # Alias for `helpers.localize`, since localize is something that's used
+    # quite often. Further aliased to `l` for convenience.
+    def localize(*args)
+      helpers.localize(*args)
+    end
+    alias_method :l, :localize
+
+  end
+end

data/lib/strong_presenter.rb

@@ -1,7 +1,69 @@
+require 'action_view'
+require 'active_model/naming'
+require 'active_model/serialization'
+require 'active_model/serializers/json'
+require 'active_model/serializers/xml'
+require 'active_support/concern'
+require 'active_support/inflector'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/hash/reverse_merge'
+require 'active_support/core_ext/name_error'
+
 require "strong_presenter/version"
-require "strong_presenter/base"
+require "strong_presenter/view_helpers"
+require "strong_presenter/helper_proxy"
+require "strong_presenter/view_context"
+require "strong_presenter/delegation"
+require "strong_presenter/permissions"
+require "strong_presenter/permissible"
+require "strong_presenter/associable"
+require "strong_presenter/inferrer"
+require "strong_presenter/presenter"
+require "strong_presenter/collection_presenter"
+require "strong_presenter/factory"
+require "strong_presenter/presenter_association"
+require "strong_presenter/presenter_helper_constructor"
+require "strong_presenter/controller_additions"
 require "strong_presenter/railtie" if defined? Rails
 
 module StrongPresenter
-  # Your code goes here...
+  def self.setup_action_controller(base)
+    base.class_eval do
+      include StrongPresenter::ViewContext
+      include StrongPresenter::ControllerAdditions
+
+      before_filter do |controller|
+        StrongPresenter::ViewContext.clear!
+        StrongPresenter::ViewContext.controller = controller
+      end
+    end
+  end
+
+  def self.setup_action_mailer(base)
+    base.class_eval do
+      include StrongPresenter::ViewContext
+    end
+  end
+
+  def self.setup_active_model_serializers(base)
+    StrongPresenter::CollectionPresenter.class_eval do
+      include ActiveModel::ArraySerializerSupport
+    end
+  end
+
+  # Note: we do not want to patch ActiveRecord
+
+  class UninferrablePresenterError < NameError
+    def initialize(klass)
+      super("Could not infer a presenter for #{klass}.")
+    end
+  end
+
+  class UninferrableSourceError < NameError
+    def initialize(klass)
+      super("Could not infer a source for #{klass}.")
+    end
+  end
 end

data/spec/dummy/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,4 @@
+class ApplicationController < ActionController::Base
+  include LocalizedUrls
+  protect_from_forgery
+end

data/spec/dummy/app/controllers/localized_urls.rb

@@ -0,0 +1,5 @@
+module LocalizedUrls
+  def default_url_options(options = {})
+    {locale: I18n.locale, host: "www.example.com", port: 12345}
+  end
+end

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

@@ -0,0 +1,25 @@
+class PostsController < ApplicationController
+  presents :post, :with => StrongPresenter::Presenter, :only => :show
+  presents :post, :with => PostPresenter, :only => :show do |presenter|
+    presenter.permit(:permit_to_present, :peek_a_boo)
+  end
+  presents :post, :with => StrongPresenter::Presenter, :only => [:index]
+  presents :post, :with => StrongPresenter::Presenter, :except => [:show, :new]
+
+  def show
+    @post = Post.find(params[:id])
+  end
+
+  def mail
+    post = Post.find(params[:id])
+    email = PostMailer.presented_email(post).deliver
+    render text: email.body
+  end
+
+  private
+
+  def goodnight_moon
+    "Goodnight, moon!"
+  end
+  helper_method :goodnight_moon
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,5 @@
+module ApplicationHelper
+  def hello_world
+    "Hello, world!"
+  end
+end

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

@@ -0,0 +1,3 @@
+class ApplicationMailer < ActionMailer::Base
+  include LocalizedUrls
+end

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

@@ -0,0 +1,19 @@
+class PostMailer < ApplicationMailer
+  default from: "from@example.com"
+  layout "application"
+
+  # Mailers don't import app/helpers automatically
+  helper :application
+
+  def presented_email(post)
+    @post = PostPresenter.new(post).permit!
+    mail to: "to@example.com", subject: "A presented post"
+  end
+
+  private
+
+  def goodnight_moon
+    "Goodnight, moon!"
+  end
+  helper_method :goodnight_moon
+end

data/spec/dummy/app/models/admin.rb

@@ -0,0 +1,5 @@
+if defined?(Devise)
+  class Admin
+    extend Devise::Models
+  end
+end

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

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  # attr_accessible :title, :body
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,5 @@
+if defined?(Devise)
+  class User
+    extend Devise::Models
+  end
+end

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

@@ -0,0 +1,69 @@
+class PostPresenter < StrongPresenter::Presenter
+  # don't delegate_all here because it helps to identify things we
+  # have to delegate for ActiveModel compatibility
+
+  # need to delegate attribute methods for AM::Serialization
+  # need to delegate id and new_record? for AR::Base#== (Rails 3.0 only)
+  delegate :id, :created_at, :new_record?
+
+  def posted_date
+    if created_at.to_date == DateTime.now.utc.to_date
+      "Today"
+    else
+      "Not Today"
+    end
+  end
+
+  def path_with_model
+    h.post_path(object)
+  end
+
+  def path_with_id
+    h.post_path(id: id)
+  end
+
+  def url_with_model
+    h.post_url(object)
+  end
+
+  def url_with_id
+    h.post_url(id: id)
+  end
+
+  def link
+    h.link_to id.to_s, self
+  end
+
+  def truncated
+    h.truncate("Once upon a time in a world far far away", length: 17, separator: ' ')
+  end
+
+  def html_escaped
+    h.html_escape("<script>danger</script>")
+  end
+
+  def hello_world
+    h.hello_world
+  end
+
+  def goodnight_moon
+    h.goodnight_moon
+  end
+
+  def updated_at
+    :overridden
+  end
+
+  def permit_to_present
+    "I am permitted"
+  end
+
+  def peek_a_boo
+    "BOO!"
+  end
+
+  def unpermitted
+    "Top Secret"
+  end
+
+end

data/spec/dummy/app/presenters/special_post_presenter.rb

@@ -0,0 +1,5 @@
+class SpecialPostPresenter < StrongPresenter::Presenter
+  presents :post
+
+  delegate :id, :title
+end

data/spec/dummy/app/presenters/special_posts_presenter.rb

@@ -0,0 +1,5 @@
+class SpecialPostsPresenter < StrongPresenter::CollectionPresenter
+  def collection_special?
+    true
+  end
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/post_mailer/presented_email.html.erb

@@ -0,0 +1 @@
+<%= render @post %>

data/spec/dummy/app/views/posts/_post.html.erb

@@ -0,0 +1,50 @@
+<dl>
+  <dt>Environment:</dt>
+  <dd id="environment"><%= Rails.env %></dd>
+
+  <dt>StrongPresenter view context controller:</dt>
+  <dd id="controller"><%= StrongPresenter::ViewContext.current.controller.class %></dd>
+
+  <dt>Posted:</dt>
+  <dd id="posted_date"><%= post.posted_date %></dd>
+
+  <dt>Built-in helpers:</dt>
+  <dd id="truncated"><%= post.truncated %></dd>
+
+  <dt>Built-in private helpers:</dt>
+  <dd id="html_escaped"><%= post.html_escaped %></dd>
+
+  <dt>Helpers from app/helpers:</dt>
+  <dd id="hello_world"><%= post.hello_world %></dd>
+
+  <dt>Helpers from the controller:</dt>
+  <dd id="goodnight_moon"><%= post.goodnight_moon %></dd>
+
+  <dt>Path with presenter:</dt>
+  <dd id="path_with_presenter"><%= post_path(post) %></dd>
+
+  <dt>Path with model:</dt>
+  <dd id="path_with_model"><%= post.path_with_model %></dd>
+
+  <dt>Path with id:</dt>
+  <dd id="path_with_id"><%= post.path_with_id %></dd>
+
+  <dt>URL with presenter:</dt>
+  <dd id="url_with_presenter"><%= post_url(post) %></dd>
+
+  <dt>URL with model:</dt>
+  <dd id="url_with_model"><%= post.url_with_model %></dd>
+
+  <dt>URL with id:</dt>
+  <dd id="url_with_id"><%= post.url_with_id %></dd>
+
+  <% post.presents :permit_to_present, :unpermitted do |key, value| %>
+    <dt><%= key.to_s.humanize %>:</dt>
+    <dd id="<%= key.to_s %>"><%= value %></dd>
+  <% end %>
+
+  <% post.present :peek_a_boo do |value| %>
+    <dt>Peek A Boo:</dt>
+    <dd id="peekaboo"><%= value %></dd>
+  <% end %>
+</dl>

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

@@ -0,0 +1 @@
+<%= render post %>

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/config/application.rb

@@ -0,0 +1,70 @@
+require File.expand_path('../boot', __FILE__)
+
+def attempt_require(file)
+  require file
+rescue LoadError
+end
+
+require 'rails/all'
+require 'strong_presenter'
+attempt_require 'devise'
+require 'active_model_serializers'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    # config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    # config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    # config.assets.version = '1.0'
+
+    # Tell Action Mailer not to deliver emails to the real world.
+    # The :test delivery method accumulates sent emails in the
+    # ActionMailer::Base.deliveries array.
+    config.action_mailer.delivery_method = :test
+  end
+end
+
+ActiveRecord::Migration.verbose = false

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,33 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  config.eager_load = false
+
+  # Raise exception on mass assignment protection for Active Record models
+  # config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  # config.assets.compress = false
+
+  # Expands the lines which load the assets
+  # config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,57 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  config.eager_load = true
+
+  # Defaults to nil and saved in location specified by config.assets.prefix
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Prepend all log lines with the following tags
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+end