marilyne 1.0.0 → 1.0.1

data/README.md

@@ -1,47 +1,78 @@
-# Marilyn [![Build Status](https://secure.travis-ci.org/alaibe/marilyn.png)][travis] [![Dependency Status](https://gemnasium.com/alaibe/marilyn.png)][gemnasium] [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
+# Marilyne [![Build Status](https://secure.travis-ci.org/alaibe/marilyne.png)][travis] [![Dependency Status](https://gemnasium.com/alaibe/marilyne.png)][gemnasium] [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
 
-[travis]: http://travis-ci.org/alaibe/marilyn
-[gemnasium]: https://gemnasium.com/alaibe/marilyn
-[codeclimate]: https://codeclimate.com/github/alaibe/marilyn
+[travis]: http://travis-ci.org/alaibe/marilyne
+[gemnasium]: https://gemnasium.com/alaibe/marilyne
+[codeclimate]: https://codeclimate.com/github/alaibe/marilyne
 
-Marilyn is a Gem which allows you to use presenter patten easily into your rails project
+Marilyne is a Gem which allows you to use presenter patten easily into your rails project
 
 ## Resources
 Bugs
 
-* http://github.com/alaibe/marilyn/issues
+* http://github.com/alaibe/marilyne/issues
 
 Development
 
-* http://github.com/alaibe/marilyn
+* http://github.com/alaibe/marilyne
 
 Testing
 
-* http://travis-ci.org/alaibe/marilyn
+* http://travis-ci.org/alaibe/marilyne
 
 Source
 
-* git://github.com/alaibe/marilyn.git
+* git://github.com/alaibe/marilyne.git
 
 ## Install
 
 Add this to your Gemfile
 ``` ruby
-  gem 'marilyn'
+  gem 'marilyne'
 ```
 
 ## Usage
 
 You must generate your presenter
 ``` ruby
-  rails g marilyn:presenter my_presenter
+  rails g marilyne:presenter base # => app/presenters/base_presenter.rb
 ```
 
 And in your view you can call
 ``` ruby
-  <%= presenter_for('template', object: @object)
+  <%= presenter_for('template', object: @base) %>
+```
+
+## Exemple
+
+Basic usage:
+``` ruby
+  presenter_for('base')
+    # => render partial: 'base', object: BasePresenter.new(template, Base.new)
+```
+
+It's possible to specify the object you want present:
+``` ruby
+  presenter_for('base', object: @object)
+    # => render partial: 'base', object: BasePresenter.new(template, @object)
+```
+
+or multiple object
+``` ruby
+  presenter_for('base', objects: [@object, @other_object])
+    # => render partial: 'base', object: BasePresenter.new(template, @object, @other_object)
+```
+
+A block can also be passed and the the render will be call only if block is true
+``` ruby
+  presenter_for('base', object: @object) { |object| object.ok? }
+```
+
+Finally, it's also possible to pass a presenter in options
+``` ruby
+  presenter_for('base', presenter: 'MySpecificPresenter', object: @object)
+    # => render partial: 'base', object: MySpecificPresenter.new(template, @object)
 ```
 
 ## Contributors
 
-*Anthony Laibe
+*Anthony Laibe

data/Rakefile

@@ -14,7 +14,7 @@ end
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Marilyn'
+  rdoc.title    = 'Marilyne'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/lib/generators/templates/presenter.rb

@@ -1,2 +1,2 @@
-class <%= presenter_name.singularize.camelize %>Presenter < Marilyn::Presenter
+class <%= presenter_name.singularize.camelize %>Presenter < Marilyne::Presenter
 end

data/lib/marilyne/engine.rb

@@ -0,0 +1,9 @@
+module Marilyne
+  class Engine < ::Rails::Engine
+    initializer 'marilyne.initialize' do
+      ActiveSupport.on_load(:action_view) do
+        include Marilyne::Helper
+      end
+    end
+  end
+end

data/lib/{marilyn → marilyne}/helper.rb

@@ -1,4 +1,4 @@
-module Marilyn
+module Marilyne
   # = Presenter Helper
   module Helper
 
@@ -6,12 +6,12 @@ module Marilyn
     # ==== Examples
     #   presenter_for('base')
     #   # => render partial: 'base', object: BasePresenter.new(Base.new)
-    #   
+    #
     #   You can specify the object you want present:
     #
     #   presenter_for('base', object: @object)
     #   # => render partial: 'base', object: BasePresenter.new(@object)
-    #   
+    #
     #   or multiple object
     #
     #   presenter_for('base', objects: [@object, @other_object])
@@ -27,15 +27,15 @@ module Marilyn
     # * <tt>:presenter</tt> - Specifies the presenter you want use
     def presenter_for(template, options = {})
       presenter_string = options[:presenter] || "#{template.camelize}Presenter"
-      
-      object           = extract_objects template, options[:object], options[:objects] 
-      presenter        = presenter_string.constantize.new self, *object
-      
+
+      object           = extract_objects template, options[:object], options[:objects]
+      presenter        = presenter_string.to_s.constantize.new self, *object
+
       if block_given?
         return unless yield object
       end
 
-      render partial: template, object: presenter  
+      render partial: template, object: presenter
     end
 
     private
@@ -47,4 +47,4 @@ module Marilyn
       base_name.camelize.constantize.new
     end
   end
-end
+end

data/lib/{marilyn → marilyne}/presenter.rb

@@ -1,4 +1,4 @@
-module Marilyn
+module Marilyne
   # == Base presenter
   class Presenter
 
@@ -9,7 +9,7 @@ module Marilyn
     # * <tt>:objects</tt> - All presented objects
     def initialize(template, *objects)
       @template = template
-      objects.length == 1 ? @object = objects.first : @objects = objects 
+      objects.length == 1 ? @object = objects.first : @objects = objects
     end
   end
-end
+end

data/lib/marilyne/version.rb

@@ -0,0 +1,3 @@
+module Marilyne
+  VERSION = "1.0.1"
+end

data/lib/marilyne.rb

@@ -0,0 +1,5 @@
+require "marilyne/helper"
+require "marilyne/presenter"
+require "marilyne/engine"
+module Marilyne
+end

data/lib/tasks/{marilyn_tasks.rake → marilyne_tasks.rake}

@@ -1,4 +1,4 @@
 # desc "Explaining what the task does"
-# task :marilyn do
+# task :marilyne do
 #   # Task goes here
 # end

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

@@ -1,4 +1,4 @@
-class UserPresenter < Marilyn::Presenter
+class UserPresenter < Marilyne::Presenter
 
   def first_name
     @object.first_name

data/test/dummy/config/application.rb

@@ -3,7 +3,7 @@ require File.expand_path('../boot', __FILE__)
 require 'rails/all'
 
 Bundler.require
-require "marilyn"
+require "marilyne"
 
 module Dummy
   class Application < Rails::Application

data/test/dummy/db/schema.rb

@@ -1,23 +1,23 @@
-# encoding: UTF-8
-# This file is auto-generated from the current state of the database. Instead
-# of editing this file, please use the migrations feature of Active Record to
-# incrementally modify your database, and then regenerate this schema definition.
-#
-# Note that this schema.rb definition is the authoritative source for your
-# database schema. If you need to create the application database on another
-# system, you should be using db:schema:load, not running all the migrations
-# from scratch. The latter is a flawed and unsustainable approach (the more migrations
-# you'll amass, the slower it'll run and the greater likelihood for issues).
-#
-# It's strongly recommended to check this file into your version control system.
-
-ActiveRecord::Schema.define(:version => 20120818172022) do
-
-  create_table "users", :force => true do |t|
-    t.string   "first_name"
-    t.string   "last_name"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
-  end
-
-end
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20120818172022) do
+
+  create_table "users", :force => true do |t|
+    t.string   "first_name"
+    t.string   "last_name"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+end