page_wrapper 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in page_wrapper.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 mathieul
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Page Wrapper
+
+Pagination tools when using Ember, Ember Data and Rails / Rails-Api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'page_wrapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install page_wrapper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/erubis

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'erubis' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('erubis', 'erubis')

data/bin/rackup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rack', 'rackup')

data/bin/rails

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rails' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('railties', 'rails')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rake2thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake2thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'rake2thor')

data/bin/ri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rdoc', 'ri')

data/bin/thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'thor')

data/bin/tilt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tilt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tilt', 'tilt')

data/lib/generators/page_generator.rb

@@ -0,0 +1,36 @@
+module PageWrapper
+  class PageGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path("../../templates", __FILE__)
+
+    desc "Creates a new page to wrap a resource collection"
+
+    def create_page_files
+      model_path = File.join('app/models', class_path, "#{file_name}_page.rb")
+      template 'model_page.rb', model_path
+
+      serializer_path = File.join('app/serializers', class_path, "#{file_name}_page_serializer.rb")
+      template 'model_serializer.rb', serializer_path
+
+      controller_path = File.join('app/controllers', class_path, "#{file_name}_pages_controller.rb")
+      template 'model_controller.rb', controller_path
+
+      route "resources :#{class_name.underscore}_pages, only: [:index]"
+
+      controller_path = File.join('app/assets/javascripts/controllers', class_path, "#{file_name}_page_controller.js.coffee")
+      template 'page_controller.js.coffee', controller_path
+
+      model_path = File.join('app/assets/javascripts/models', class_path, "#{file_name}_page.js.coffee")
+      template 'page_model.js.coffee', model_path
+
+      template_path = File.join('app/assets/javascripts/templates', class_path, "#{file_name}_page.handlebars")
+      template 'page_template.handlebars', template_path
+
+      view_path = File.join('app/assets/javascripts/views', class_path, "#{file_name}_page.js.coffee")
+      template 'page_view.js.coffee', view_path
+    end
+
+    def show_readme
+      readme "README" if behavior == :invoke
+    end
+  end
+end

data/lib/page_wrapper.rb

@@ -0,0 +1,4 @@
+require 'page_wrapper/version'
+require 'page_wrapper/engine'
+require 'page_wrapper/railtie'
+require 'page_wrapper/model'

data/lib/page_wrapper/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module PageWrapper
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/page_wrapper/model.rb

@@ -0,0 +1,50 @@
+require 'active_model_serializers'
+
+module PageWrapper
+  class Model
+    include ActiveModel::AttributeMethods
+    include ActiveModel::SerializerSupport
+
+    attr_reader :attributes
+
+    def self.fields
+      [:id, :pages, :first, :last, :total, :per_page, :query, :sort, :dir]
+    end
+    define_attribute_methods fields.map(&:to_s)
+
+    fields.each do |name|
+      define_method(name) { attributes[name] }
+      define_method(:"#{name}=") { |value| attributes[name] = value }
+    end
+
+    def per_page_default
+      10
+    end
+
+    def per_page_max
+      100
+    end
+
+    def initialize(params)
+      page = params[:id].to_i
+      options = get_options_from(params)
+      records = fetch_records(page, options)
+      @attributes = options.merge(
+        id:    records.current_page,
+        pages: records.num_pages,
+        first: records.first_page?,
+        last:  records.last_page?,
+        total: records.total_count
+      )
+    end
+
+    def fetch_records(page, options)
+      raise "Overide me"
+    end
+
+    def get_options_from(params)
+      per_page = [params.fetch(:per_page, per_page_default).to_i, per_page_max].min
+      params.slice(:query, :sort, :dir).merge(per_page: per_page)
+    end
+  end
+end

data/lib/page_wrapper/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module PageWrapper
+  class Railtie < ::Rails::Railtie
+    generators do |app|
+      require "generators/page_generator"
+    end
+  end
+end

data/lib/page_wrapper/version.rb

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

data/lib/templates/README

@@ -0,0 +1,18 @@
+Thand you for using page_wrapper!
+
+Please note that you should update your Ember application router with
+something like below. This basic example uses "movie" as the paged
+model:
+
+# app/assets/javascripts/routes/app_router.js.coffee
+App.Router = Ember.Router.extend
+  location: Ember.Location.create(implementation: 'hash')
+
+  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)

data/lib/templates/model_controller.rb

@@ -0,0 +1,6 @@
+class <%= class_name.camelize %>PagesController < ApplicationController
+  def index
+    page = <%= class_name.camelize %>Page.new(params)
+    render json: [page]
+  end
+end

data/lib/templates/model_page.rb

@@ -0,0 +1,15 @@
+class <%= class_name.camelize %>Page < PageWrapper::Model
+  attr_reader :<%= class_name.underscore.pluralize %>
+
+  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)
+
+    result = <%= class_name.camelize %>.page(page)
+    result = result.per(options[:per_page]) if options[:per_page]
+    result
+  end
+end

data/lib/templates/model_serializer.rb

@@ -0,0 +1,7 @@
+class <%= class_name.camelize %>PageSerializer < ActiveModel::Serializer
+  embed :ids, include: true
+
+  attributes :id, :pages, :first, :last, :total, :per_page, :query, :sort, :dir
+
+  has_many :<%= class_name.underscore.pluralize %>
+end

data/lib/templates/page_controller.js.coffee

@@ -0,0 +1,15 @@
+App.<%= class_name.camelize %>PageController = Ember.ArrayController.extend PageWrapper.PaginatedControllerMixin,
+  model: App.<%= class_name.camelize %>Page
+
+  #
+  # Properties
+  #
+  # TODO: create properties for the field titles to use in the view template
+  #
+  # i.e.: if title is a sortable field
+  #
+  # titleLabel: (->
+  #   "Title #{@sortIndicator('title')}"
+  # ).property('content.isLoaded')
+  #
+  # => {{titleLable}} renders a link with sort direction in the view template

data/lib/templates/page_model.js.coffee

@@ -0,0 +1,3 @@
+App.<%= class_name.camelize %>Page = DS.Model.extend PageWrapper.PageModelMixin,
+  <%= class_name.underscore.pluralize %>: DS.hasMany('App.<%= class_name.camelize %>')
+  itemsName: '<%= class_name.underscore.pluralize %>'

data/lib/templates/page_template.handlebars

@@ -0,0 +1,28 @@
+<section>
+  <div class="page-header">
+    <h1><%= class_name.humanize.pluralize %></h1>
+  </div>
+
+  <div id="<%= class_name.underscore %>-list">
+    <table class="table table-bordered table-striped">
+      <thead>
+        <tr>
+          <th>Field1</th>
+          <th>Field2</th>
+        </tr>
+      </thead>
+
+      <tbody>
+        {{#if controller.content.isLoaded}}
+          {{#each controller.currentPage.<%= class_name.camelize.pluralize %>}}
+            <tr>
+              <td>{{field1}}</td>
+              <td>{{field2}}</td>
+            </tr>
+          {{/each}}
+        {{/if}}
+      </tbody>
+    </table>
+  </div>
+  {{view PageWrapper.PaginationView pageBinding="controller.currentPage"}}
+</section>

data/lib/templates/page_view.js.coffee

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

data/page_wrapper.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/page_wrapper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mathieu Lajugie"]
+  gem.email         = ["mathieul@gmail.com"]
+  gem.description   = %q{Pagination tools when using Ember, Ember Data and Rails / Rails-Api.}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/mathieul/page_wrapper"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "page_wrapper"
+  gem.require_paths = ["lib"]
+  gem.version       = PageWrapper::VERSION
+
+  gem.add_dependency "ember-rails", ["~> 0.6.0"]
+end

data/vendor/assets/javascripts/page-model-mixin.js.coffee

@@ -0,0 +1,73 @@
+window.PageWrapper ?= {}
+PageWrapper.PageModelMixin = Ember.Mixin.create
+  #
+  # Fields
+  #
+  pages:     DS.attr('number')
+  first:     DS.attr('boolean')
+  last:      DS.attr('boolean')
+  total:     DS.attr('number')
+  per_page:  DS.attr('number')
+  query:     DS.attr('string')
+  sort:      DS.attr('string')
+  dir:       DS.attr('string')
+
+  #
+  # Properties
+  #
+  paginated: (-> @get('pages') > 1).property('pages', 'isLoaded')
+
+  from: (->
+    1 + (@get('id') - 1) * @get('per_page')
+  ).property('id', 'per_page', 'isLoaded')
+
+  to: (->
+    if @get('last')
+      @get('total')
+    else
+      @get('from') + @get('per_page') - 1
+  ).property('last', 'total', 'from', 'per_page', 'isLoaded')
+
+  paginationItems: (->
+    [current, query] = [@get('id'), @get('query')]
+    items = @allItems(current, @get('pages'), query)
+    items.unshift @firstItem(current, query, @get('first'))
+    items.push @lastItem(current, query, @get('last'))
+    items
+  ).property('id', 'pages', 'total', 'query', 'isLoaded')
+
+  #
+  # Other methods
+  #
+  allItems: (current, pages, query) ->
+    items = if pages < 9
+      [1..pages]
+    else
+      switch current
+        when 1, 2, 3, 4, 5
+          [1, 2, 3, 4, 5, 6, '…', pages - 1, pages]
+        when pages - 4, pages - 3, pages - 2, pages - 1, pages
+          [1, 2, '…', pages - 5, pages - 4, pages - 3, pages - 2, pages - 1, pages]
+        else
+          [1, 2, '…', current - 1, current, current + 1, '…', pages - 1, pages]
+    for i in items
+      if i is '…'
+        value: '…'
+        disabled: true
+      else
+        page:    i
+        query:   query
+        value:   i
+        active:  i is current
+
+  firstItem: (current, query, first) ->
+    page:      if first then 'disabled' else current - 1
+    query:     query
+    value:     '«'
+    disabled:  first
+
+  lastItem: (current, query, last) ->
+    page:      if last then 'disabled' else current + 1
+    query:     query
+    value:     '»'
+    disabled:  last

data/vendor/assets/javascripts/page-wrapper.js

@@ -0,0 +1,3 @@
+//= require page-model-mixin
+//= require paginated-controller-mixin
+//= require pagination-view

data/vendor/assets/javascripts/paginated-controller-mixin.js.coffee

@@ -0,0 +1,55 @@
+window.PageWrapper ?= {}
+PageWrapper.PaginatedControllerMixin = Ember.Mixin.create
+  #
+  # Properties
+  #
+  currentPage: (->
+    array = @get('content')
+    array && array.objectAt(0)
+  ).property('content.isLoaded')
+
+  #
+  # Event handlers
+  #
+  changePage: (event) ->
+    event.preventDefault()
+    page = $(event.target).data('page')
+    @update(id: page) unless page is 'disabled'
+
+  filter: (event) ->
+    event.preventDefault()
+    query = $(event.target).prev().val()
+    query = $.trim(query)
+    id = 1
+    @update(id: id, query: query)
+
+  changeSort: (event) ->
+    event.preventDefault()
+    sortType = $(event.target).data('sort')
+    page = @get('content').objectAt(0)
+    [sort, dir] = if page.get('sort') is sortType
+      [sortType, if page.get('dir') is 'asc' then 'desc' else 'asc']
+    else
+      [sortType, 'asc']
+    @update(sort: sort, dir: dir)
+
+  #
+  # Other methods
+  #
+  firstPage: ->
+    @model.find(id: 1)
+
+  sortIndicator: (column) ->
+    page = @get('content').objectAt(0)
+    return '' unless page? and column is page.get('sort')
+    if page.get('dir') is 'asc' then '▼' else '▲'
+
+  update: (params = {}) ->
+    page = @get('content').objectAt(0)
+    params.id ?= page.get('id')
+    params.query ?= page.get('query')
+    params.sort ?= page.get('sort')
+    params.dir ?= page.get('dir')
+    for name, value of params
+      delete params[name] unless value?
+    @set('content', @get('model').find(params))

data/vendor/assets/javascripts/pagination-view.js.coffee

@@ -0,0 +1,27 @@
+window.PageWrapper ?= {}
+PageWrapper.PaginationView = Ember.View.extend
+  tagName:       'div'
+  classNames:    ['pagination pagination-right']
+  template: Ember.Handlebars.compile """
+    {{#if view.page.isLoaded}}
+      {{#with view.page}}
+        {{#if paginated}}
+          <ul>
+            {{#each paginationItems}}
+              <li {{bindAttr class="active disabled"}}>
+                {{#if disabled}}
+                  <a href="javascript:void(0)">{{value}}</a>
+                {{else}}
+                  <a href="#" {{bindAttr data-page="page"}}
+                     {{action changePage}}>{{value}}</a>
+                {{/if}}
+              </li>
+            {{/each}}
+          </ul>
+        {{/if}}
+        <div class="pagination-info">
+          Showing {{itemsName}} <code>{{from}} to {{to}}</code> out of <code>{{total}}</code>
+        </div>
+      {{/with}}
+    {{/if}}
+  """

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: page_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mathieu Lajugie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ember-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+description: Pagination tools when using Ember, Ember Data and Rails / Rails-Api.
+email:
+- mathieul@gmail.com
+executables:
+- erubis
+- rackup
+- rails
+- rake
+- rake2thor
+- ri
+- thor
+- tilt
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/erubis
+- bin/rackup
+- bin/rails
+- bin/rake
+- bin/rake2thor
+- bin/ri
+- bin/thor
+- bin/tilt
+- lib/generators/page_generator.rb
+- lib/page_wrapper.rb
+- lib/page_wrapper/engine.rb
+- lib/page_wrapper/model.rb
+- lib/page_wrapper/railtie.rb
+- lib/page_wrapper/version.rb
+- lib/templates/README
+- lib/templates/model_controller.rb
+- lib/templates/model_page.rb
+- lib/templates/model_serializer.rb
+- lib/templates/page_controller.js.coffee
+- lib/templates/page_model.js.coffee
+- lib/templates/page_template.handlebars
+- lib/templates/page_view.js.coffee
+- page_wrapper.gemspec
+- vendor/assets/javascripts/page-model-mixin.js.coffee
+- vendor/assets/javascripts/page-wrapper.js
+- vendor/assets/javascripts/paginated-controller-mixin.js.coffee
+- vendor/assets/javascripts/pagination-view.js.coffee
+homepage: https://github.com/mathieul/page_wrapper
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3175872921732100907
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3175872921732100907
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Pagination tools when using Ember, Ember Data and Rails / Rails-Api.
+test_files: []