liaison 0.0.1 → 0.0.2

data/ChangeLog

@@ -0,0 +1,9 @@
+2011-09-20   Mike Burns   <mburns@thoughtbot.com>
+
+	* presenter.rb, presenter_spec.rb:
+	Include the Enumerable module to the Presenter class, with a test.
+
+	* NEWS, ChangeLog:
+	Add an overview NEWS file and a more detailed ChangeLog file.
+
+	* version.rb: Bump version to 0.0.2.

data/NEWS

@@ -0,0 +1,4 @@
+New in 0.0.2:
+
+* The Presenter class now includes the Enumerable class. This means you can
+  use #map, #reject, #sort, and so on, on the Presenter data object.

data/README.md

@@ -3,6 +3,28 @@ Liaison
 
 A Rails presenter class.
 
+How to Use Liaison
+------------------
+
+Add this to your `Gemfile`:
+
+    gem 'liaison'
+
+Then run the bundler installer:
+
+    bundle
+
+You instantiate `Presenter` classes in your controllers, setting them as instance variables so they can be passed to the views. The `Presenter` class takes the model name as a string (`sign_up`, for example) then a hash of options. Currently supported options are `:fields`, a list of attributes on the presenter (`[:email, :password]`); and `:validator`, a class that knows how to validate the data (`SignUpValidator`).
+
+An instance of the `Presenter` object is Hash-like: it implements the `Enumerable` module, which means it has an `#each` method among many others; it also has a `#[]` method, which you can use to access values just like with the CGI `params` hash.
+
+The business logic classes (`SignUp` in the below example) live under `app/models` and are tested as normal, except instead of requiring `spec_helper` they can likely require just `rspec`.
+
+Validator classes (`SignUpValidator` in the below example) live under `lib` and must either descend from `ActiveModel::Validator` or implement the same interface (`.kind`, `#kind`, `#validate` that takes a record, and a constructor that takes a hash of options). They are also unit tested like normal and can likely get away with just requiring `rspec` instead of `spec_helper`. Sadly, in order to hook into the `ActiveModel::Validations` framework, you must pass the validator class itself instead of an object (`SignUpValidator` vs `SignUpValidator.new`).
+
+Turorial and Thought Process
+----------------------------
+
 A major idea of [the presenter pattern](http://blog.jayfields.com/2007/03/rails-presenter-pattern.html) is to break off the business logic from the view object, letting the view logic be a dumb instance that knows how to get, set, and validate values. The business logic can then query the presenter object for the values as needed.
 
 Look, here's an example business object:
@@ -76,11 +98,6 @@ The `presenter` method in the above example produces a new `Presenter` instance.
 
 You, the author of the business logic class, are in charge of checking in on these validations and errors. For example, before saving any objects you should check `Presenter#valid?`. And after you've saved something to the database you should add any errors onto the presenter using `Presenter#add_errors`.
 
-Getting Data
-----------
-
-An instance of the `Presenter` object is Hash-like: it implements the `Enumerable` module, which means it has an `#each` method among many others; it also has a `#[]` method, which you can use to access values just like with the CGI `params` hash.
-
 Testing
 -------
 

data/lib/liaison/presenter.rb

@@ -4,6 +4,7 @@ class Presenter
   extend ActiveModel::Naming
   include ActiveModel::Conversion
   include ActiveModel::Validations
+  include Enumerable
 
   validate :instance_validations
 
@@ -24,25 +25,22 @@ class Presenter
     self.class.send(:attr_accessor,*@fields) unless @fields.nil? || @fields.empty?
   end
 
-  def instance_validations
-    validates_with(@validator, :attributes => @fields) if @validator
-  end
-
+  # This only exists for ActiveModel::Naming
   def self.model_name # :nodoc:
-    ActiveModel::Name.new(Class.new do
-      attr_reader :name
-      def initialize(n)
-        @name = n
-      end
-    end.new(@@model_name))
+    model_namer = Struct.new("ModelNamer", :name).new(@@model_name)
+    ActiveModel::Name.new(model_namer)
   end
 
+  # This only exists for ActiveModel::Constructs
   def persisted? # :nodoc:
     false
   end
 
   # Set the params from the form using this.
   #
+  # For example, if you have a presenter in the @sign_up_presenter variable,
+  # you can update the values in it using this method:
+  #
   #   @sign_up_presenter.with_params(params[:sign_up])
   def with_params(params = {})
     params.each {|k,v| self.send("#{k}=", v)}
@@ -76,8 +74,8 @@ class Presenter
     to_hash[key]
   end
 
-  # This is an instance of Enumerable, which means you can iterate over the
-  # keys and values as set by the form.
+  # Presenter objects are instances of Enumerable, which means you can iterate
+  # over the keys and values as set by the form.
   #
   #   @sign_up_presenter.each {|k,v| puts "the form set #{k} to #{v}" }
   def each(&block)
@@ -92,4 +90,8 @@ class Presenter
       acc
     end
   end
+
+  def instance_validations
+    validates_with(@validator, :attributes => @fields) if @validator
+  end
 end

data/lib/liaison/version.rb

@@ -1,3 +1,3 @@
 module Liaison
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/presenter_spec.rb

@@ -96,4 +96,8 @@ describe Presenter, "enumerations" do
     subject[:a].should == 'hello'
     subject[:b].should == 'goodbye'
   end
+
+  it "has at least #reject" do
+    subject.reject {|k,v| k == :a}.should == [[:b, 'goodbye']]
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: liaison
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Mike Burns
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-10 00:00:00 Z
+date: 2011-09-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activemodel
@@ -70,8 +70,10 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- ChangeLog
 - Gemfile
 - LICENSE
+- NEWS
 - README.md
 - Rakefile
 - liaison.gemspec