neat-pages 0.1.7 → 1.0.0

data/lib/neat_pages/helpers/status.rb

@@ -1,4 +1,16 @@
+#*************************************************************************************
+# Status take care of generating the html code that show the results position and the
+# total results.
+#
+# Output Example
+#
+# 30 to 40 / 300
+#*************************************************************************************
 class NeatPages::Helpers::Status < NeatPages::Helpers::Builder
+  delegate :empty?,         to: :pagination
+  delegate :offset,         to: :pagination
+  delegate :out_of_bound?,  to: :pagination
+
   def generate
     return '' if empty? or out_of_bound?
 
@@ -7,6 +19,8 @@ class NeatPages::Helpers::Status < NeatPages::Helpers::Builder
     return build_status from, to
   end
 
+  private
+
   def build_status(from, to)
     reset_builder
 

data/lib/neat_pages/implants/action_controller_implant.rb

@@ -1,3 +1,6 @@
+#*************************************************************************************
+# Insert methods in the Action Controller of a Rails project.
+#*************************************************************************************
 module NeatPages::Implants::ActionControllerImplant
   extend ActiveSupport::Concern
 

data/lib/neat_pages/implants/mongoid_implant.rb

@@ -1,15 +1,17 @@
-module NeatPages::Implants
-  module MongoidCriteriaImplant
-    def paginate(current)
-      if current
-        current.set_total_items self.count
+#*************************************************************************************
+# Insert the method paginate in a Mongoid model. This method will be use the limit
+# the number of results returned by a query.
+#*************************************************************************************
+module NeatPages::Implants::MongoidCriteriaImplant
+  def paginate(current)
+    if current
+      current.set_total_items self.count
 
-        raise NeatPages::OutOfBound if current.out_of_bound?
+      raise NeatPages::OutOfBound if current.out_of_bound?
 
-        return self.offset(current.offset).limit(current.limit)
-      else
-        raise 'You need to initialize the pagination'
-      end
+      return self.offset(current.offset).limit(current.limit)
+    else
+      raise NeatPages::Uninitalized, 'You need to initialize the pagination'
     end
   end
 end

data/lib/neat_pages/{implants/railtie.rb → railtie.rb}

@@ -1,6 +1,4 @@
-require 'neat_pages/implants/action_controller_implant'
-
-module NeatPages::Implants
+module NeatPages
   class Railtie < Rails::Railtie
     initializer "neat-pages" do |app|
       ActiveSupport.on_load :action_controller do
@@ -14,9 +12,14 @@ module NeatPages::Implants
       Mime::Type.register "text/html", :neatpage if not Mime::Type.lookup_by_extension :neatpage
     end
   end
+
+  module Implants
+  end
 end
 
 dir = File.expand_path(File.dirname(__FILE__))
 
-I18n.load_path << File.join(dir, '../../../config/locales', 'fr.yml')
+I18n.load_path << File.join(dir, '../../config/locales', 'fr.yml')
 
+require 'neat_pages/implants/action_controller_implant'
+require 'neat_pages/implants/mongoid_implant'

data/neat-pages.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |gem|
+  gem.name        = "neat-pages"
+  gem.description = "A simple pagination API to paginate Mongoid Models."
+  gem.summary     = "A simple pagination API to paginate Mongoid Models."
+  gem.homepage    = "https://github.com/demarque/neat-pages"
+  gem.version     = "1.0.0"
+  gem.licenses    = ["MIT"]
+
+  gem.authors     = ["Sebastien Rosa"]
+  gem.email       = ["srosa@alchimik.com"]
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "rails", ['>= 4.0']
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "simplecov-rcov-text"
+  gem.add_development_dependency "coveralls"
+end

data/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe ApplicationController do
+  controller do
+    def index
+      paginate per_page: 20
+
+      set_pagination_header
+
+      raise NeatPages::OutOfBound
+    end
+  end
+
+  describe "#index" do
+    it 'is out of bound' do
+      get :index
+
+      expect(response.status).to eq(404)
+      expect(response.body).to eq "out_of_bound"
+      controller.pagination.per_page.should eql 20
+      response.headers["X-Per-Page"].should eql "20"
+    end
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/examples_controller.rb

@@ -0,0 +1,11 @@
+class ExamplesController < ApplicationController
+  protect_from_forgery
+
+  def index
+    render text: 'dummy'
+  end
+
+  def show
+    render text: 'dummy'
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+
+require "neat-pages"
+
+module Dummy
+  class Application < Rails::Application
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application.
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/standard_rails_initializers.rb

@@ -0,0 +1,9 @@
+Rails.application.config.filter_parameters += [:password]
+
+Dummy::Application.config.secret_key_base = 'ae3cad0b2a7fe9cf1620b58b362sdfsdf9d5236ba303b9821fb22ac023c9dc1b07ef16f27b74e96c4294f1e02c5bfc83f2dc89c02c9fc24d1b3974f6d7c14701'
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  neat_pages:
+    next_page: Next
+    previous_page: Previous
+    to: to

data/spec/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Dummy::Application.routes.draw do
+  resources :examples, only: [:index, :show]
+end

data/spec/neat_pages/base_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
 describe NeatPages::Base do
-  #*************************************************************************************
-  # PUBLIC INSTANCE METHODS
-  #*************************************************************************************
   describe "#empty?" do
     context "with a 20 items pagination" do
       specify { NeatPages::Base.new(0, total_items: 20).should_not be_empty }
@@ -14,6 +11,12 @@ describe NeatPages::Base do
     end
   end
 
+  describe "#limit" do
+    context "with a 100 items pagination starting at 0 and having 10 items per page" do
+      specify { NeatPages::Base.new(0, per_page: 10, total_items: 100).limit.should eql 10 }
+    end
+  end
+
   describe "#next_page" do
     context "with a 100 items pagination starting at 0 and having 10 items per page" do
       specify { NeatPages::Base.new(0, per_page: 10, total_items: 100).next_page.should eql 2 }
@@ -62,6 +65,16 @@ describe NeatPages::Base do
     end
   end
 
+  describe "#paginated?" do
+    context "with a 20 items pagination starting at page 1 and having 10 items per page" do
+      specify { NeatPages::Base.new(1, per_page: 10, total_items: 20).should be_paginated }
+    end
+
+    context "with a 5 items pagination starting at page 1 and having 10 items per page" do
+      specify { NeatPages::Base.new(1, per_page: 10, total_items: 5).should_not be_paginated }
+    end
+  end
+
   describe "#previous_page" do
     context "with a 100 items pagination starting at page 5 and having 10 items per page" do
       specify { NeatPages::Base.new(5, per_page: 10, total_items: 100).previous_page.should eql 4 }
@@ -95,7 +108,7 @@ describe NeatPages::Base do
       specify { NeatPages::Base.new(2, per_page: 10, total_items: 100).should be_previous }
     end
 
-    context "with a 5 items pagination starting at 0 and having 10 items per page" do
+    context "with a 5 items pagination starting at page 0 and having 10 items per page" do
       specify { NeatPages::Base.new(0, per_page: 10, total_items: 5).should_not be_previous }
     end
   end
@@ -107,11 +120,24 @@ describe NeatPages::Base do
       its(:length) { should eql 4 }
       its(['X-Total-Items']) { should eql '200' }
       its(['X-Total-Pages']) { should eql '20' }
-      its(['X-Per-Page']) { should eql '10' }#
+      its(['X-Per-Page']) { should eql '10' }
       its(['X-Current-Page']) { should eql '1' }
     end
   end
 
+  describe "#set_total_items" do
+    context "with a 100 items pagination starting at page 2 and having 10 items per page" do
+      let(:pagination) { NeatPages::Base.new(2, per_page: 10, total_items: 100) }
+
+      context "when changing the total items to 5" do
+        before { pagination.set_total_items 5 }
+
+        specify { pagination.should be_out_of_bound }
+        specify { pagination.total_items.should eql 5 }
+      end
+    end
+  end
+
   describe "#total_pages" do
     context "with a 100 items pagination and having 10 items per page" do
       specify { NeatPages::Base.new(0, per_page: 10, total_items: 100).total_pages.should eql 10 }