Code re-organization

Signed-off-by: David Celis <[email protected]>

Author: davidcelis

lib/api-pagination.rb

@@ -1,39 +1,4 @@
+require 'api-pagination/hooks'
 require 'api-pagination/version'
 
-module ApiPagination
-  protected
-    def paginate(scope)
-      links = (headers['Link'] || "").split(',').map(&:strip)
-
-      scope = instance_variable_get(:"@#{scope}")
-      url   = request.original_url.sub(/\?.*$/, '')
-      pages = {}
-
-      unless scope.first_page?
-        pages[:first] = 1
-        pages[:prev]  = scope.current_page - 1
-      end
-
-      unless scope.last_page?
-        pages[:last] = scope.total_pages
-        pages[:next] = scope.current_page + 1
-      end
-
-      pages.each do |k, v|
-        new_params = request.query_parameters.merge(:page => v)
-        links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
-      end
-
-      headers['Link'] = links.join(', ') unless links.empty?
-    end
-end
-
-ActionController::Base.send(:include, ApiPagination) if defined?(ActionController::Base)
-ActionController::API.send(:include, ApiPagination)  if defined?(ActionController::API)
-
-if defined?(WillPaginate::CollectionMethods)
-  WillPaginate::CollectionMethods.module_eval do
-    def first_page?() !previous_page end
-    def last_page?() !next_page end
-  end
-end
+ApiPagination::Hooks.init

lib/api-pagination/hooks.rb

@@ -0,0 +1,36 @@
+module ApiPagination
+  class Hooks
+    def self.init
+      begin; require 'rails'; rescue LoadError; end
+      if defined?(ActionController::Base)
+        require 'rails/pagination'
+        ActionController::Base.send(:include, Rails::Pagination)
+      end
+
+      begin; require 'rails-api'; rescue LoadError; end
+      if defined?(ActionController::API)
+        require 'rails/pagination'
+        ActionController::API.send(:include, Rails::Pagination)
+      end
+
+      begin; require 'will_paginate'; rescue LoadError; end
+      if defined?(WillPaginate::CollectionMethod)
+        WillPaginate::CollectionMethods.module_eval do
+          def first_page?() !previous_page end
+          def last_page?() !next_page end
+        end
+      end
+
+      begin; require 'kaminari'; rescue LoadError; end
+
+      STDERR.puts <<-EOC unless defined?(Kaminari) || defined?(WillPaginate)
+Warning: api-pagination relies on either Kaminari or WillPaginate. Please
+install either dependency by adding one of the following to your Gemfile:
+
+gem 'kaminari'
+gem 'will_paginate'
+
+EOC
+    end
+  end
+end

lib/rails/pagination.rb

@@ -0,0 +1,32 @@
+module Rails
+  module Pagination
+    protected
+
+      def paginate(scope)
+        links = (headers['Link'] || "").split(',').map(&:strip)
+
+        scope = instance_variable_get(:"@#{scope}")
+        url   = request.original_url.sub(/\?.*$/, '')
+        pages = {}
+
+        unless scope.first_page?
+          pages[:first] = 1
+          pages[:prev]  = scope.current_page - 1
+        end
+
+        unless scope.last_page?
+          pages[:last] = scope.total_pages
+          pages[:next] = scope.current_page + 1
+        end
+
+        pages.each do |k, v|
+          new_params = request.query_parameters.merge(:page => v)
+          links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
+        end
+
+        headers['Link'] = links.join(', ') unless links.empty?
+
+        return scope
+      end
+  end
+end

spec/controllers/numbers_controller_spec.rb renamed to spec/rails_spec.rb

@@ -1,40 +1,4 @@
-require 'spec_helper'
-
-Rails.application.routes.draw do
-  resources :numbers, only: [:index]
-end
-
-# quacks like Kaminari
-PaginatedSet = Struct.new(:current_page, :total_count) do
-  def limit_value() 25 end
-
-  def total_pages
-    total_count.zero? ? 1 : (total_count.to_f / limit_value).ceil
-  end
-
-  def first_page?() current_page == 1 end
-  def last_page?() current_page == total_pages end
-end
-
-class NumbersController < ActionController::Base
-  include Rails.application.routes.url_helpers
-
-  after_filter only: [:index] { paginate(:numbers) }
-
-  def index
-    page = params.fetch(:page, 1).to_i
-    total = params.fetch(:count).to_i
-
-    if params[:with_headers]
-      query = request.query_parameters
-      query.delete(:with_headers)
-      headers['Link'] = %(<#{numbers_url}?#{query.to_param}>; rel="without") if params[:with_headers]
-    end
-
-    @numbers = PaginatedSet.new(page, total)
-    render json: @numbers
-  end
-end
+require 'rails_spec_helper'
 
 describe NumbersController, :type => :controller do
   describe 'GET #index' do

spec/rails_spec_helper.rb

@@ -0,0 +1,67 @@
+require 'action_controller'
+require 'spec_helper'
+
+module Rails
+  def self.application
+    @application ||= begin
+      routes = ActionDispatch::Routing::RouteSet.new
+      OpenStruct.new(routes: routes, env_config: {})
+    end
+  end
+end
+
+module ControllerExampleGroup
+  def self.included(base)
+    base.extend ClassMethods
+    base.send(:include, ActionController::TestCase::Behavior)
+
+    base.prepend_before do
+      @routes = Rails.application.routes
+      @controller = described_class.new
+    end
+  end
+
+  module ClassMethods
+    def setup(*methods)
+      methods.each do |method|
+        if method.to_s =~ /^setup_(fixtures|controller_request_and_response)$/
+          prepend_before { send method }
+        else
+          before         { send method }
+        end
+      end
+    end
+
+    def teardown(*methods)
+      methods.each { |method| after { send method } }
+    end
+  end
+end
+
+Rails.application.routes.draw do
+  resources :numbers, only: [:index]
+end
+
+class NumbersController < ActionController::Base
+  include Rails.application.routes.url_helpers
+
+  after_filter only: [:index] { paginate(:numbers) }
+
+  def index
+    page = params.fetch(:page, 1).to_i
+    total = params.fetch(:count).to_i
+
+    if params[:with_headers]
+      query = request.query_parameters
+      query.delete(:with_headers)
+      headers['Link'] = %(<#{numbers_url}?#{query.to_param}>; rel="without") if params[:with_headers]
+    end
+
+    @numbers = PaginatedSet.new(page, total)
+    render json: @numbers
+  end
+end
+
+RSpec.configure do |config|
+  config.include ControllerExampleGroup, :type => :controller
+end

spec/spec_helper.rb

@@ -1,55 +1,23 @@
-require 'action_controller'
 require 'api-pagination'
 require 'rspec/autorun'
 require 'ostruct'
 
-module Rails
-  def self.application
-    @application ||= begin
-      routes = ActionDispatch::Routing::RouteSet.new
-      OpenStruct.new(routes: routes, env_config: {})
-    end
-  end
-end
+# Quacks like Kaminari
+PaginatedSet = Struct.new(:current_page, :total_count) do
+  def limit_value() 25 end
 
-module ControllerExampleGroup
-  def self.included(base)
-    base.extend ClassMethods
-    base.send(:include, ActionController::TestCase::Behavior)
-
-    base.prepend_before do
-      @routes = Rails.application.routes
-      @controller = described_class.new
-    end
+  def total_pages
+    total_count.zero? ? 1 : (total_count.to_f / limit_value).ceil
   end
 
-  module ClassMethods
-    def setup(*methods)
-      methods.each do |method|
-        if method.to_s =~ /^setup_(fixtures|controller_request_and_response)$/
-          prepend_before { send method }
-        else
-          before         { send method }
-        end
-      end
-    end
-
-    def teardown(*methods)
-      methods.each { |method| after { send method } }
-    end
-  end
+  def first_page?() current_page == 1 end
+  def last_page?() current_page == total_pages end
 end
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
-
-  config.include ControllerExampleGroup, :type => :controller
 end