pre_render 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7c3c0d589af98dc5618bdaef33b91078b21b705
-  data.tar.gz: 35f0eabc6e52dca5a2f3cfa988779829d17682aa
+  metadata.gz: c3476896a3dfcf2a171a65e3f6e52baf0457000e
+  data.tar.gz: 5ce05cbe2b9f9d80f6afb66be37bb4f76853a26f
 SHA512:
-  metadata.gz: 88dac5da89b583b991a0972b1aea05b451a804be03642b1b4bfc8774be3caa1201b49e61c34e7ec8d7e42bbeeb7b05df7a7eb96feb5d6e7546ce173db8525824
-  data.tar.gz: 5246c376ab7d7f92e9c32d804692495ff31e043cb1e52c4db20f91cb672f18970560d8e13bb41da0a575b0a1c4069a5345860d3d27b26509da48878fdbe572a5
+  metadata.gz: 295e79ae45cf471552f0016e96bba3a433da627da0cb4764aebce5c84b00ea85e50061ba3e4398bd144784b022e59cb1a22ac38e21b6b54ceb8261a8ba0ed26b
+  data.tar.gz: 2c56548248bca50c19494f19036a59318eff675154b383c9634382be81536d741c90c7b5448a40927e5fe3c7170670523aae81d114a47e0b84ff2ffce626621a

data/README.md

@@ -1,2 +1,74 @@
-# pre_render
-Adds support for a pre_render methods to Rails controllers.
+# The pre_render Gem
+
+Adds support for a ```pre_render()``` method to Rails controllers.
+
+## Installation
+
+Add the following line to your Rails application's Gemfile:
+
+```ruby
+gem "pre_render"
+```
+
+## Usage
+
+Let's say you have a ```Person``` model with the accompanying ```PeopleController```.  Then the controller might look something
+like this:
+
+```ruby
+class PeopleController < ApplicationController
+
+  before_action :set_person, only: [:show, :edit, :update, :destroy]
+
+  # GET /people
+  # GET /people.json
+  def index
+    @people = Person.all
+  end
+
+  # GET /people/1
+  # GET /people/1.json
+  def show
+  end
+
+  # ...
+
+  protected
+
+  def pre_render(view, *args)
+    logger.info "Preparing to render the \"#{view}\" view of #{self.class}"
+    case view
+    when :index
+      # ...
+    when :edit
+      # ...
+    # ...
+  end
+
+  private
+
+  # Use callbacks to share common setup or constraints between actions.
+  def set_person
+    @person = Person.find(params[:id])
+  end
+
+  # Never trust parameters from the scary internet, only allow the white list through.
+  def person_params
+    params.require(:person).permit(:first_name, :last_name, :age)
+  end
+
+end
+```
+
+The ```pre_render()``` method will be called right before Rails' ```render()``` method.  This will give your controller a last chance to
+fully initialize any instance variables a view might need to render itself.  If you are using any view model construct, this is a
+good place to initialize or finish initializing it.
+
+## Credits
+
+The idea for this gem came from my time spent working as a classic ASP.NET developer.  The classic ASP.NET page event model
+also supports the notion of a ```PreRender()``` method being called right before the ```Render()``` method to allow an application's
+code-behind class to finish initialization of its properties and fields.
+
+I found this to be useful then, as I do now in the Rails world.
+

data/lib/pre_render/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pre_render
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nathan Brazil
@@ -78,3 +78,4 @@ signing_key:
 specification_version: 4
 summary: Adds support for a pre_render() method to Rails controllers.
 test_files: []
+has_rdoc: