auto_presenter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3d56d88e59a4a4a44668eea58dc7cb5261cc47e
+  data.tar.gz: 3f9cb8fb4ba274780263cc39808f6f691b5d9f28
+SHA512:
+  metadata.gz: d9d39a5e2c79ef1af3f448f843b0446d289f22e4668986c1d6047341e7f3b464ebca8d578749c8162490ff9d39a3855d1226a609808941943673628432b419b8
+  data.tar.gz: e4724857836cc87dc0668d3fdb2b38619fa077974c93836513f8f9724f4a419529a2509c514326ae27123c2d5a37efb0ef086fd00b30a482ab2a0f3b7656b7ec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# AutoPresenter
+
+[![Build Status](https://secure.travis-ci.org/afcapel/auto_presenter.png)](http://travis-ci.org/afcapel/auto_presenter)
+[![Code Climate](https://codeclimate.com/github/afcapel/auto_presenter.png)](https://codeclimate.com/github/afcapel/auto_presenter)
+
+AutoPresenter uses convention over configuration to remove the bolierplate code to use presenters in your rails app. That allows you to cleanly remove the presentation logic from your controllers.
+
+## Usage
+
+Let's say you have a controller:
+
+```ruby
+class ProjectsController < ApplicationController
+
+  def show
+    @project = Project.find(params[:id])
+
+    @completed_tasks   = @project.tasks.completed
+    @uncompleted_tasks = @project.tasks.uncompleted
+  end
+end
+```
+
+To decorate `@completed_tasks` just create a presenter in `app/presenters/projects/completed_tasks_presenter.rb`. If you want to decorate any `Task` instance variable in your views just create a `TaskPresenter` in `app/presenters/task_presenter.rb`. There is no need to change your controller code.
+
+
+### Presenters
+
+Autopresenter doesn't ship with any base presenter class you can inherit from. A presenter can be any object that accepts the decorated object in the initializer and adds presentation methods to it. The ruby standard library is `SimpleDelegator` usually a good and simple option to implement your delegators. Drapper decorators work well too.
+
+```ruby
+class TaskPresenter < SimpleDelegator
+
+  # This method will be added to Task objects in the views.
+  def status
+    completed_at.present? ? 'Completed' : 'Uncompleted'
+  end
+end
+```
+
+## Installation
+
+Add AutoPresenter to your Gemfile
+
+```ruby
+  gem 'auto_presenter'
+```
+
+## License
+
+Autopresenter is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AutoPresenter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/auto_presenter.rb

@@ -0,0 +1,49 @@
+require_relative 'auto_presenter/relation_presenter'
+
+module AutoPresenter
+  extend ActiveSupport::Concern
+
+  included do
+    define_callbacks :render
+    set_callback :render, :before, :auto_present_instance_vars
+  end
+
+  private
+
+  def render(*args, &block)
+    run_callbacks(:render) { super }
+  end
+
+  def auto_present_instance_vars
+    vars_to_present = instance_variables.collect(&:to_s).reject do |var_name|
+      var_name.starts_with?('@_')
+    end
+
+    vars_to_present.each { |instance_var_name| auto_present(instance_var_name) }
+  end
+
+  def auto_present(instance_var_name)
+    var = instance_variable_get(instance_var_name)
+    var_name = instance_var_name[1..-1] # without the @
+
+    presenter = auto_presenter_for(var_name, var)
+
+    if presenter
+      presented_object = presenter.new(var)
+      instance_variable_set(instance_var_name, presented_object)
+    end
+  end
+
+  def auto_presenter_for(var_name, var)
+    controller_presenter = "#{params[:controller]}/#{var_name}_presenter".camelize.safe_constantize
+
+    return controller_presenter if controller_presenter
+
+    if var.is_a?(ActiveRecord::Relation)
+      RelationPresenter
+    else
+      class_name = var.class.name
+      "#{class_name}Presenter".safe_constantize
+    end
+  end
+end

data/lib/auto_presenter/relation_presenter.rb

@@ -0,0 +1,31 @@
+require "delegate"
+
+module AutoPresenter
+  class RelationPresenter < SimpleDelegator
+
+    delegate :to_xml, :to_yaml, :length, :collect, :map, :each, :all?, :include?, :to_ary, to: :to_a
+
+    def initialize(object)
+      __setobj__(object)
+
+      name = object.klass.name
+      @_presenter = "#{name}Presenter".safe_constantize
+
+      present_records if loaded?
+    end
+
+    def to_a
+      if @_presented || !@_presenter
+        __getobj__.to_a
+      else
+        present_records
+      end
+    end
+
+    def present_records
+       records = __getobj__.to_a.collect! { |record| @_presenter.new(record) }
+       @_presented = true
+       records
+    end
+  end
+end

data/lib/auto_presenter/version.rb

@@ -0,0 +1,3 @@
+module AutoPresenter
+  VERSION = "0.0.1"
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

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

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

@@ -0,0 +1,64 @@
+class ProjectsController < ApplicationController
+  before_filter :set_project, only: [:show, :edit, :update, :destroy]
+
+  # GET /projects
+  def index
+    @projects = Project.all
+  end
+
+  # GET /projects/1
+  def show
+    @tasks = @project.tasks
+
+    @new_task = @project.tasks.build
+
+    @completed_tasks   = @project.tasks.completed
+    @uncompleted_tasks = @project.tasks.uncompleted
+  end
+
+  # GET /projects/new
+  def new
+    @project = Project.new
+  end
+
+  # GET /projects/1/edit
+  def edit
+  end
+
+  # POST /projects
+  def create
+    @project = Project.new(project_params)
+
+    if @project.save
+      redirect_to @project, notice: 'Project was successfully created.'
+    else
+      render :new
+    end
+  end
+
+  # PATCH/PUT /projects/1
+  def update
+    if @project.update(project_params)
+      redirect_to @project, notice: 'Project was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  # DELETE /projects/1
+  def destroy
+    @project.destroy
+    redirect_to projects_url, notice: 'Project was successfully destroyed.'
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_project
+      @project = Project.find(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def project_params
+      params.require(:project).permit(:name)
+    end
+end

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

@@ -0,0 +1,43 @@
+class TasksController < ApplicationController
+  before_filter :set_project
+  before_filter :set_task, only: [:show, :edit, :update, :destroy]
+
+  # POST /tasks
+  def create
+    @task =  @project.tasks.new(task_params)
+
+    if @task.save
+      redirect_to @project, notice: 'Task was successfully created.'
+    else
+      render :new
+    end
+  end
+
+  def update
+    if @task.update(task_params)
+      redirect_to @project, notice: 'Task was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  # DELETE /tasks/1
+  def destroy
+    @task.destroy
+    redirect_to tasks_url, notice: 'Task was successfully destroyed.'
+  end
+
+  private
+
+  def set_project
+    @project = Project.find(params[:project_id])
+  end
+
+  def set_task
+    @task = @project.tasks.find(params[:id])
+  end
+
+  def task_params
+    params.require(:task).permit(:name, :completed_at)
+  end
+end

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

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/projects_helper.rb

@@ -0,0 +1,2 @@
+module ProjectsHelper
+end

data/test/dummy/app/helpers/tasks_helper.rb

@@ -0,0 +1,2 @@
+module TasksHelper
+end

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

@@ -0,0 +1,3 @@
+class Project < ActiveRecord::Base
+  has_many :tasks
+end

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

@@ -0,0 +1,10 @@
+class Task < ActiveRecord::Base
+  belongs_to :project
+
+  scope :completed,   -> { where('`tasks`.`completed_at` IS NOT NULL') }
+  scope :uncompleted, -> { where('`tasks`.`completed_at` IS NULL') }
+
+  def status
+    completed_at.present? ? 'Completed' : 'Uncompleted'
+  end
+end

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

@@ -0,0 +1,2 @@
+class ProjectPresenter < SimpleDelegator
+end

data/test/dummy/app/presenters/projects/completed_tasks_presenter.rb

@@ -0,0 +1,2 @@
+class Projects::CompletedTasksPresenter < SimpleDelegator
+end

data/test/dummy/app/presenters/projects/projects_presenter.rb

@@ -0,0 +1,2 @@
+class Projects::ProjectsPresenter < SimpleDelegator
+end

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

@@ -0,0 +1,6 @@
+class TaskPresenter < DelegateClass(Task)
+
+  def status
+    completed_at.present? ? 'Completed' : 'Uncompleted'
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>