faceted 1.4.0 → 1.5.0

data/README.md

@@ -71,6 +71,42 @@ You can also explicitly declare the class of the association:
 
   field :genre_id, :class_name => 'MusicalGenre'
 
+Presenters from Existing Models
+----
+In your controllers, you will typically be using one of three methods to instantiate a presenter: `new`, `materialize`, or `from`.
+
+### new
+
+This method is used to retrieve and instantiate a persisted model based on an `id`:
+
+	m = Musician.create(:name => 'Bauhaus', :genre => 'Goth')	m.id
+    => 213
+
+    presenter = MyApi::Musician.new(:id => 213)
+    presenter.name
+    => "Bauhaus"
+
+### materialize
+
+Have an array of objects that you need translated into presenters? No problem. Use the `materialize` class method on the presenter class:
+
+		musicians = [
+			::Musician.new(:name => 'Love and Rockets'),
+			::Musician.new(:name => 'The Pixies')
+		]
+		presenters = MyApi::Musician.materialize(musicians)
+		presenters.first.name
+		=> 'Love and Rockets'
+
+### from
+
+If you have an single instance of a persisted model already loaded, or if you're presenting a class that does not get read from a database (e.g. an object from an API response), you can use the `from` class method to materialize a single presenter object:
+
+		musician_from_json_response = ::Musician.new(:name => 'Dust and a Shadow')
+		presenter = MyApi::Musician.from(musician_from_json_response)
+		presenter.name
+		=> 'Dust and a Shadow'
+
 Collectors
 ----------
 Collectors are simply models that collect multiple instances of another model. An example:

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.5.0

data/faceted.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "faceted"
-  s.version = "1.4.0"
+  s.version = "1.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Corey Ehmke", "Max Thom Stahl"]
-  s.date = "2013-09-13"
+  s.date = "2013-09-16"
   s.description = "Faceted provides set of tools, patterns, and modules for use in API implementations."
   s.email = "corey@trunkclub.com"
   s.extra_rdoc_files = [

data/lib/faceted/model.rb

@@ -44,7 +44,11 @@ module Faceted
         @fields ||= [:id, :excludes]
       end
 
-      def materialize(objects=[], args={})
+      def from(object, args={})
+        materialize([object], args).first
+      end
+
+     def materialize(objects=[], args={})
         objects.compact.inject([]) do |a, object|
           interface = self.new(args)
           interface.send(:object=, object)

data/spec/presenter_spec.rb

@@ -70,6 +70,20 @@ module MyApi
 
     end
 
+    describe 'initialized with an instantiated object' do
+
+      let(:musician_presenter) { MyApi::Musician.from(@ar_musician) }
+
+      it 'accepts an object' do
+        musician_presenter.send(:object).should == @ar_musician
+      end
+
+      it 'initializes with the attributes of the object' do
+        musician_presenter.name.should == 'Johnny Cash'
+      end
+
+    end
+
     describe 'initialized with a presented object' do
 
       describe 'inherits values from its AR counterpart' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faceted
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-13 00:00:00.000000000 Z
+date: 2013-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -214,7 +214,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4498478211701341188
+      hash: -1783250443854962767
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: