RubyGems - arch_presenter - Versions diffs - 0.1.5 → 0.1.6 - Mend

arch_presenter 0.1.5 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

checksums.yaml +4 -4
data/README.md +158 -10
data/lib/arch_presenter/base.rb +0 -13
data/lib/arch_presenter/presenter.rb +1 -0
data/lib/arch_presenter/version.rb +1 -1
metadata +2 -2

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9a1c985b8e80a569e42dda4e1fae1c43267d7a6
-  data.tar.gz: 7060f5d72bc975bcd3737c78ca63df4a1c4bc42e
+  metadata.gz: 3a0abcad3a6fa30f12186903c14b06d2331eeb5e
+  data.tar.gz: 78a348ee01770be2cca8976c253ce58d31af7148
 SHA512:
-  metadata.gz: 6980a7a33817e83a711fa0cda57e00211057ccab26e359641e571eb08f5967a2a2b265f787519366f035e6a1aac0526183aeec682f98caa9557b4deb9f99bc65
-  data.tar.gz: 49361a5a0839b46ce0a644b66197de32713bbefef324df211a89eefece86596b497562acb452f08327479178a0c468340c735f120eafdc77a36b534db278e1b2
+  metadata.gz: 61703e68f2a16c178f9b9c13bac89efee8b938be218aa2c7bb1c7b5b48b9742988fa881da39dbf22c388b836fe116686aab61edf330d121133fc94dd2577fae9
+  data.tar.gz: f0fb0b3ef289c878910616cec1986c5dabf6b72cd5533a41f3d26dcec8919824b7342f0309f9e0e2b1eaa144f37603580d255bb1973a4d160de24b610387f0ed

data/README.md CHANGED

@@ -1,8 +1,8 @@
 # ArchPresenter
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/arch_presenter`. To experiment with that code, run `bin/console` for an interactive prompt.
+ArchPresenter is a simple, lightweight gem that implements the Presenter pattern.
-TODO: Delete this and the text above, and describe your gem
+It allows you to slim down your models and controllers by extracting the logic related to class presentation. You can learn more about this pattern [on the Jay Fields' blog](http://blog.jayfields.com/2007/03/rails-presenter-pattern.html).
 ## Installation
@@ -12,23 +12,171 @@ Add this line to your application's Gemfile:
 gem 'arch_presenter'
 ```
-And then execute:
+And then run:
     $ bundle
-Or install it yourself as:
-    $ gem install arch_presenter
 ## Usage
-TODO: Write usage instructions here
+### Super-quick example
+Simple, skinny model:
+```ruby
+# app/models/user.rb
+class User
+  def first_name
+    'John'
+  end
+  def last_name
+    'Smith'
+  end
+  def title
+    'Mr.'
+  end
+  def name_visible?
+    true
+  end
+end
+```
+Presentation logic moved to the presenter:
+```ruby
+# app/presenters/user_presenter.rb
+class UserPresenter < ArchPresenter::Base
+  def display_name
+    if name_visible?
+      [title, first_name, last_name].join(' ')
+    else
+      '(Name hidden)'
+    end
+  end
+end
+```
+Presenting the object in the controller:
+``` ruby
+# app/controllers/users_cotroller.rb
+class UsersController < ApplicationController
+  def show
+    @user = User.find(params[:id])
+    @user = present(@user)
+  end
+end
+```
+Using the `display_name` function:
+```ruby
+# app/views/users/show.html.erb
+<h1><%=@user.display_name %> - User profile</h1>
+```
+### Creating presenter classes
+First you will need to create a class that will be used to decorate your object.
+Presenter class files should be placed in `app/presenters/` and should inherit from `ArchPresenter::Base`.
+### Autoloading
+You might wish to add `app/presenters/` to your autoload path. This will allow rails to automatically detect changes made to the presenter files without the need to restart the server.
+In `config/application.rb` add:
+```ruby
+config.autoload_paths << Rails.root.join('app', 'presenters')
+```
+### Decorating
-## Development
+ArchPresenter gem provides a `#present` function that can be invoked in your controller (or in your view if you preffer decorating your classes there).
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+To decorate your class use the `#present` function.
+In the controller:
+```ruby
+user = User.find(1)
+@user = present(user)
+```
+or in the view:
+```ruby
+<body>
+<% @user = present(@user) %>
+Hello <%= @user.full_name %>!
+</body>
+```
+### Mini-tutorial
+We have a user model that looks like this:
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  def first_name
+    'John'
+  end
+  def last_name
+    'Smith'
+  end
+  def title
+    'Mr.'
+  end
+  def name_visible?
+    true
+  end
+  def display_name
+    if name_visible?
+      [title, first_name, last_name].join(' ')
+    else
+      '(Name hidden)'
+    end
+  end
+end
+```
+where `first_name`, `last_name` and `title` are user table cloumns and `display_name` is only used to show the name while displaying information about the user. `display_name` doesn't really belong to the model and we want to move it to a separate class - the presenter.
+We create a new file in `app/presenters` and move the `display_name` there:
+```ruby
+class UserPresenter < ActiveRecord::Base
+  def display_name
+    if name_visible?
+      [title, first_name, last_name].join(' ')
+    else
+      '(Name hidden)'
+    end
+  end
+end
+```
+Now in our controller we can use the `present` method:
+``` ruby
+# app/controllers/users_cotroller.rb
+class UsersController < ApplicationController
+  def show
+    @user = User.find(params[:id])
+    @user = present(@user)
+  end
+end
+```
+This will add the `display_name` method to our `@user`. We can now use it in the view:
+```ruby
+# app/views/users/show.html.erb
+<h1><%=@user.display_name %> - User profile</h1>
+```
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 ## Contributing

data/lib/arch_presenter/base.rb CHANGED

@@ -1,17 +1,4 @@
 module ArchPresenter
   class Base < ::SimpleDelegator
-    def self.human_attribute_name(*args)
-      original_class.human_attribute_name(*args)
-    end
-    def original_class
-      presenter_class_name.chomp('Presenter').constantize
-    end
-    private
-    def presenter_class_name
-      self.class.to_s
-    end
   end
 end

data/lib/arch_presenter/presenter.rb CHANGED

@@ -4,6 +4,7 @@ module ArchPresenter
       presenter_class_name = "#{target_object.class}Presenter"
       class_constant = presenter_class_name.constantize
       class_constant.new(target_object)
+    # If the presenter class doen't exist resturn the original object
     rescue NameError
       target_object
     end

data/lib/arch_presenter/version.rb CHANGED

@@ -1,3 +1,3 @@
 module ArchPresenter
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arch_presenter
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Przemyslaw Krowinski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2015-05-16 00:00:00.000000000 Z
+date: 2015-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler