prospecto 0.2.0 → 0.2.1

data/lib/prospecto/presenter_view.rb

@@ -1,7 +1,12 @@
 require "set"
 
 module Prospecto
+  # Optional base class for convenience when working with rails presenters.
   class PresenterView
+    # Initialize a new PresenterView instance accepting the provided arguments.
+    #
+    # @param [Hash] args key value pairs for what ever properties you declared
+    #                    on the class.
     def initialize(args={})
       args.each do |name, value|
         if respond_to? name
@@ -15,6 +20,7 @@ module Prospecto
       end
     end
 
+    # @private
     def method_missing(name, *args, &block)
       if property_name = self.class.__properties.find{|m| name.to_s.start_with? "#{m}_"}
         field_name = name.to_s.sub("#{property_name}_", "")
@@ -26,25 +32,23 @@ module Prospecto
       end
     end
 
+    # @private
     def __delegates
       @__delegates ||= Set.new
     end
 
     class << self
-      # "Presents" means a member will be reflected out to the view. Use of presents should be
-      # limited to very special cases.
-      alias :presents :attr_reader
-
-      def __properties
-        @__properties ||= Set.new
-      end
-
-      def __delegates
-        @__delegates ||= Set.new
+      # Instructs the class to create a publicly visible version of the value.
+      #
+      # @param [Symbols*] args name of the properties to accept.  This will be used in the constructor.
+      def presents(*args)
+        attr_reader(*args)
       end
 
-      # Accepts means the view uses the member internally, but it is not available
-      # outside the class.
+      # Instructs the class to *accept* the value internally but not
+      # publish it.
+      #
+      # @param [Symbols*] args name of the properties to accept.  This will be used in the constructor.
       def accepts(*args)
         args.each do |name|
           define_method name do
@@ -54,8 +58,10 @@ module Prospecto
         end
       end
 
-      # Proxies means that the properties of the object can be accessed directly from this object
-      # when prefixed with the object name. (ie: @view.user_full_name)
+      # Instructs the class that the properties of the object can be accessed directly from this object
+      # when prefixed with the object name. (ie: `@view.user_full_name`)
+      #
+      # @param [Symbols*] args name of the properties to accept.  This will be used in the constructor.
       def proxies(*args)
         args.each do |name|
           __properties << name
@@ -63,12 +69,25 @@ module Prospecto
         accepts(*args)
       end
 
-      # Decorates means that properties of the object will be available directly on the presenter.
+      # Instructs the class to proxy directly for this object like a true decorator. This is very similar
+      # to how something like [draper](https://github.com/jcasimir/draper) works.
+      #
+      # @param [Symbols*] args name of the properties to accept.  This will be used in the constructor.
       def decorates(*args)
         args.each do |name|
           __delegates << name
         end
       end
+
+      # @private
+      def __properties
+        @__properties ||= Set.new
+      end
+
+      # @private
+      def __delegates
+        @__delegates ||= Set.new
+      end
     end
   end
 end

data/lib/prospecto/railtie.rb

@@ -1,6 +1,7 @@
 require 'rails/railtie'
 
 module Prospecto
+  # @private
   class Railtie < Rails::Railtie
     initializer "prospecto.initialize" do |app|
       # Import the url helpers to allow resolving of URLs easily

data/lib/prospecto/version.rb

@@ -1,3 +1,5 @@
+# Main Prospecto namespace.
 module Prospecto
-  VERSION = "0.2.0"
+  # The current Prospecto version.
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prospecto
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70296683085180 !ruby/object:Gem::Requirement
+  requirement: &70113014264460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70296683085180
+  version_requirements: *70113014264460
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70296683083860 !ruby/object:Gem::Requirement
+  requirement: &70113014263760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70296683083860
+  version_requirements: *70113014263760
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70296683082860 !ruby/object:Gem::Requirement
+  requirement: &70113014262840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70296683082860
+  version_requirements: *70113014262840
 description: ''
 email:
 - bigjasonwebb@gmail.com
@@ -81,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -977387351276312960
+      hash: -2544824161487180405
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -977387351276312960
+      hash: -2544824161487180405
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10