page_wrapper 0.0.1 → 0.0.2

data/README.md

@@ -1,24 +1,81 @@
-# Page Wrapper
+## Page Wrapper ##
 
-Pagination tools when using Ember, Ember Data and Rails / Rails-Api.
+Page Wrapper helps you add pagination to a list of resources fetched
+from a Rails server and rendered using Ember and Ember Data.
 
-## Installation
+It contains:
+
+* a page model class intended to be extended to wrap a list of resources
+  into a page
+* a set of Ember classes to help fetching, browsing, sorting and
+  filtering the list of resources within an Ember application
+* a generator for all the Ruby and CoffeeScript files you need to paginate
+  those resources
+
+It requires a 3.1+ rails or rails-api application and a model to
+paginate. There are no constraint on which ORM or plain old Ruby object
+to use, or which tool to paginate or filter on the Ruby side. It is up
+to you to code or integrate that part (i.e.: Active Record + Kaminari,
+Mongoid + Kaminari, Remotely + Kaminari, etc...).
+
+Finaly it is delegating most of the work to a set of great Ruby gems and
+JavaScript libraries:
+
+* [Rails API](https://github.com/spastorino/rails-api) or [Rails](http://rubyonrails.org/) for the web server
+* [Active Model Serializers](https://github.com/josevalim/active_model_serializers/) to serialize the page instance and its collection
+* [Ember Rails](https://github.com/emberjs/ember-rails) that comes with
+  [Ember](http://emberjs.com/) and [Ember Data](https://github.com/emberjs/data) for fetching the data from the browser and rendering the collections and browse it page by page
+
+## Getting Started ##
+
+Page Wrapper works with Rails 3.1 onwards and Ember Rails 0.6.0+.
 
 Add this line to your application's Gemfile:
 
-    gem 'page_wrapper'
+```ruby
+gem 'page_wrapper'
+```
 
 And then execute:
 
-    $ bundle
+```console
+$ bundle
+```
+
+After you install Page Wrapper and add it to your Gemfile, you need to
+run the generator. Assuming you want to paginate *Movie* resources:
+
+```console
+rails generate page_wrapper:page movie
+```
+
+This command will generate the Ruby and Ember classes required to
+paginate a **Movie** model and add a route to the index action of the
+new server movie page controller.
 
-Or install it yourself as:
+At that point you just need to update your Ember application routing
+manager to route to the new front-end movie page controller. Here is an
+example of a single page with an outlet setup to contain the list of
+movies:
 
-    $ gem install page_wrapper
+```coffeescript
+# app/assets/javascripts/routes/app_router.js.coffee
 
-## Usage
+App.Router = Ember.Router.extend
+  location: 'hash'
 
-TODO: Write usage instructions here
+  root: Ember.State.extend
+    index: Ember.State.extend
+      route: '/'
+      connectOutlets: (router) ->
+        controller = router.get('applicationController')
+        controller.connectOutlet(App.MoviePageView, App.MoviePageController::firstPage())
+        moviePageController = router.get('moviePageController')
+        moviePageController.set('target', moviePageController)
+```
+After reloading your application you should now look at the first page
+and be able to interact with the pagination control to navigate
+the collection page by page.
 
 ## Contributing
 

data/lib/page_wrapper/version.rb

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

data/lib/templates/model_page.rb

@@ -1,15 +1,16 @@
+<%- names = class_name.underscore.pluralize -%>
 class <%= class_name.camelize %>Page < PageWrapper::Model
-  attr_reader :<%= class_name.underscore.pluralize %>
+  attr_reader :<%= names %>
 
   def fetch_records(page, options)
     # TODO: customize the logic below and consider moving it into
     #       a class method <%= class_name.camelize %>.paginated_query
     #       and simplify this method to a one-liner:
     #
-    # @<%= class_name.underscore.pluralize %> = <%= class_name.camelize %>.paginated_query(page, options)
+    # @<%= names %> = <%= class_name.camelize %>.paginated_query(page, options)
 
-    result = <%= class_name.camelize %>.page(page)
-    result = result.per(options[:per_page]) if options[:per_page]
-    result
+    @<%= names %> = <%= class_name.camelize %>.page(page)
+    @<%= names %> = @<%= names %>.per(options[:per_page]) if options[:per_page]
+    @<%= names %>
   end
 end

data/lib/templates/page_template.handlebars

@@ -7,17 +7,19 @@
     <table class="table table-bordered table-striped">
       <thead>
         <tr>
-          <th>Field1</th>
-          <th>Field2</th>
+          <th>Id</th>
+          <th>Title</th>
+          <th>Year</th>
         </tr>
       </thead>
 
       <tbody>
         {{#if controller.content.isLoaded}}
-          {{#each controller.currentPage.<%= class_name.camelize.pluralize %>}}
+          {{#each controller.currentPage.<%= class_name.underscore.pluralize %>}}
             <tr>
-              <td>{{field1}}</td>
-              <td>{{field2}}</td>
+              <td>{{id}}</td>
+              <td>{{title}}</td>
+              <td>{{year}}</td>
             </tr>
           {{/each}}
         {{/if}}

data/lib/templates/page_view.js.coffee

@@ -1,2 +1,2 @@
 App.<%= class_name.camelize %>PageView = Ember.View.extend
-  templateName: '<%= class_name.underscore %>'
+  templateName: '<%= class_name.underscore %>_page'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: page_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -88,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3175872921732100907
+      hash: 1937236751138719714
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3175872921732100907
+      hash: 1937236751138719714
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23