mobile_pagination 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Luke Fender
+
+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,107 @@
+# MobilePagination
+
+## Description
+Rack gem for producing minimal pagination links.
+
+![<Display Name>](http://i.imgur.com/qZcqfx8.png)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mobile_pagination'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mobile_pagination
+
+## Usage
+Initializes with 4 options: `current_page, total_pages, query, path`
+
+```ruby
+require 'mobile_pagination'
+
+# http://local.m.newhomeguide.com/New-Homes/Georgia/Atlanta/?page=2
+
+def opts
+  {
+    :current_page => params[:page],         # => 2
+    :total_pages  => total_pages,           # => Int for total pages
+    :query        => request.query_string,  # => 'page=2'
+    :path         => request.path           # => '/New-Homes/Georgia/Atlanta/'
+  }
+end
+
+def pagination
+  MobilePagination::Paginate.new(opts).html
+end
+
+# in your view, you may have something like this:
+ol
+  = pagination
+```
+
+### Configuration
+Configuration is optional. Say for example you were paginating slides on a slideshow - instead of using page, you could configure the gem to use a different key.
+
+```ruby
+MobilePagination.configure do |config|
+  config.page_key = 'slide'
+end
+```
+
+Configuration must run prior to initialization. The resulting pagination links will now contain `/?slide=2, /?slide=3` to suit your custom url structure. The default page_key is `page`.
+
+### Overrides
+
+If you don't like list items, you will need to override `MobilePagination::Templates`
+
+Just add this to the bottom of one of your view helpers:
+
+```ruby
+module MobilePagination
+  module Templates
+
+    def first_page_html
+      "<p'>
+        <a title='First Page' href='#{first_page_link}'>Luke's Page</a> |
+      <p>"
+    end
+
+    def previous_page_html
+      "<h1>
+        <a title='Previous Page' href='#{previous_page_link}'>Previous Page</a> |
+      </h1>"
+    end
+
+    def next_page_html
+      "<span>
+        <a title='Next Page' href='#{next_page_link}'>Next Page</a> |
+      </span>"
+    end
+
+    def last_page_html
+      "<h3>
+        <a title='Last Page' href='#{last_page_link}'>Last Page</a>
+      </h3>"
+    end
+
+  end
+end
+```
+
+Please note, any methods ending in `_link` will need to remain, as these methods are responsible for generating the paginated urls.
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/mobile_pagination.rb

@@ -0,0 +1,15 @@
+require_relative 'mobile_pagination/initialize'
+
+module MobilePagination
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    @configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+end
+
+MobilePagination.configure unless block_given?

data/lib/mobile_pagination/configuration.rb

@@ -0,0 +1,11 @@
+module MobilePagination
+  class Configuration
+
+    attr_accessor :page_key
+
+    def initialize(data={})
+      @page_key = data[:page_key] || 'page'
+    end
+
+  end
+end

data/lib/mobile_pagination/initialize.rb

@@ -0,0 +1,5 @@
+require 'uri'
+require_relative 'configuration'
+require_relative 'utils/initialize'
+require_relative 'templates'
+require_relative 'paginate'

data/lib/mobile_pagination/paginate.rb

@@ -0,0 +1,78 @@
+module MobilePagination
+  class Paginate
+
+    include Utils
+    include Templates
+
+    attr_reader :total_pages, :current_page, :query_params, :path
+
+    def initialize(opts)
+      @total_pages  = opts[:total_pages].to_i || 0
+      @current_page = current(opts[:current_page])
+      @query_params = query_to_hash(opts[:query])
+      @path         = opts[:path] || '/'
+    end
+
+    def first_page_link
+      "#{page_url}"
+    end
+
+    def previous_page_link
+      previous == 1 ? "#{first_page_link}" : "#{page_url(previous)}"
+    end
+
+    def next_page_link
+      "#{page_url(@current_page + 1)}" if @current_page < @total_pages
+    end
+
+    def last_page_link
+      "#{page_url(@total_pages)}"
+    end
+
+    private
+
+      def should_paginate?
+        @total_pages > 1
+      end
+
+      def previous_page?
+        @current_page > 1
+      end
+
+      def next_page?
+        not next_page_link.nil?
+      end
+
+      def current(page)
+        page = page.nil? ? 1 : page.to_i
+        page > @total_pages ? @total_pages : page
+      end
+
+      def previous
+        @current_page - 1
+      end
+
+      def page_url(page=nil)
+        page.nil? ? "#{@path}#{qs_without_key}" : "#{@path}#{qs_with_key(page)}"
+      end
+
+
+      def qs_with_key(page)
+        "?#{hash_to_query(opts_with_key(page))}"
+      end
+
+      def qs_without_key
+        "?#{hash_to_query(opts_without_key)}"
+      end
+
+      def opts_with_key(page)
+        @query_params.merge({ MobilePagination.configuration.page_key => page })
+      end
+
+      def opts_without_key
+        @query_params.delete(MobilePagination.configuration.page_key)
+        @query_params
+      end
+
+  end
+end

data/lib/mobile_pagination/templates.rb

@@ -0,0 +1,39 @@
+module MobilePagination
+  module Templates
+
+    def first_page_html
+      "<li>
+        <a title='First Page' href='#{first_page_link}'>First Page</a> |
+      </li>"
+    end
+
+    def previous_page_html
+      "<li>
+        <a title='Previous Page' href='#{previous_page_link}'>Previous Page</a> |
+      </li>"
+    end
+
+    def next_page_html
+      "<li>
+        <a title='Next Page' href='#{next_page_link}'>Next Page</a> |
+      </li>"
+    end
+
+    def last_page_html
+      "<li>
+        <a title='Last Page' href='#{last_page_link}'>Last Page</a>
+      </li>"
+    end
+
+    def html
+      return '' unless should_paginate?
+      ''.tap do |markup|
+        markup << first_page_html    if previous_page?
+        markup << previous_page_html if previous_page?
+        markup << next_page_html     if next_page?
+        markup << last_page_html     if next_page?
+      end
+    end
+
+  end
+end

data/lib/mobile_pagination/utils/initialize.rb

@@ -0,0 +1,2 @@
+require_relative 'version'
+require_relative 'utils'

data/lib/mobile_pagination/utils/utils.rb

@@ -0,0 +1,13 @@
+module MobilePagination
+  module Utils
+
+    def query_to_hash(qs)
+      Rack::Utils.parse_nested_query(qs) || {}
+    end
+
+    def hash_to_query(hash)
+      URI.encode(hash.map{|k,v| "#{k}=#{v}"}.join("&"))
+    end
+
+  end
+end

data/lib/mobile_pagination/utils/version.rb

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

data/mobile_pagination.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+require 'date'
+require './lib/mobile_pagination/utils/version'
+
+Gem::Specification.new do |gem|
+ gem.name          = "mobile_pagination"
+ gem.authors       = ["Luke Fender"]
+ gem.email         = ["lfender6445@gmail.com"]
+ gem.description   = %q{Creates a series of pagination elements relative to current page.}
+ gem.summary       = %q{Minimal and configurable pagination templating, best suited for smaller screenspace. Provides buttons for first, previous, next, and last page.}
+ gem.homepage      = 'http://github.com/lfender6445/mobile_pagination'
+ gem.license       = "MIT"
+
+ gem.add_development_dependency "rake"
+ gem.add_development_dependency 'simplecov'
+ gem.add_development_dependency 'guard-rspec'
+ gem.add_development_dependency 'rack-test'
+ gem.add_development_dependency 'rspec'
+
+ gem.required_ruby_version = '>= 1.9.3'
+ gem.platform      = Gem::Platform::RUBY
+ gem.date          = Date.today.to_s
+ gem.files         = `git ls-files`.split("\n")
+ gem.require_paths = ["lib"]
+ gem.version       = MobilePagination::VERSION
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'simplecov'
+require 'bundler/setup'
+require 'rack/utils'
+
+SimpleCov.start { add_filter '/spec/' }
+
+require 'mobile_pagination'
+
+spec_dir = File.dirname __FILE__

data/spec/unit/mobile_pagination_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe MobilePagination do
+
+  describe 'Configuration' do
+
+    it 'page_key config defaults to page' do
+      config = described_class.configuration
+      expect(config.page_key).to eq('page')
+    end
+
+
+    it 'sets configuration options' do
+      MobilePagination.configure { |config| config.page_key = 'slide' }
+      expect(described_class.configuration.page_key).to eq('slide')
+    end
+
+  end
+
+end

data/spec/unit/paginate_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+module MobilePagination
+  describe Paginate do
+
+    describe 'attributes' do
+       before do
+        @klass = described_class.new({})
+      end
+
+      it 'should set defaults' do
+        expect(@klass.total_pages).to eq 0
+        expect(@klass.current_page).to eq 0
+        expect(@klass.query_params).to eq({})
+        expect(@klass.path).to eq "/"
+      end
+    end
+
+    describe 'readers' do
+      before do
+        opts = {
+          :total_pages  => 2,
+          :current_page => 2,
+          :query_params => 'a=1&b=2',
+          :path         => '/abc/'
+        }
+        @klass = described_class.new(opts)
+      end
+
+      it 'should assign properties' do
+        expect(@klass.total_pages).to eq 2
+        expect(@klass.current_page).to eq 2
+        expect(@klass.query_params).to eq({})
+        expect(@klass.path).to eq "/abc/"
+      end
+    end
+
+    describe 'class methods' do
+      before do
+        MobilePagination.configure { |c| c.page_key = 'slide' }
+        opts = {
+          :total_pages  => 10,
+          :current_page => 5,
+          :query        => 'slide=5&community=Providence',
+          :path         => '/Listings/Georgia/Atlanta/'
+        }
+        @klass = described_class.new(opts)
+      end
+
+      describe '#first_page_link' do
+        it 'should generate url for first page' do
+          expect(@klass.first_page_link).to eq('/Listings/Georgia/Atlanta/?community=Providence')
+        end
+      end
+
+      describe '#previous_page_link' do
+        it 'should generate url for previous page' do
+          expect(@klass.previous_page_link).to eq('/Listings/Georgia/Atlanta/?slide=4&community=Providence')
+
+        end
+      end
+
+      describe '#next_page_link' do
+        it 'should generate url for next page' do
+          expect(@klass.next_page_link).to eq('/Listings/Georgia/Atlanta/?slide=6&community=Providence')
+        end
+      end
+
+      describe '#last_page_link' do
+        it 'should generate url for last page' do
+          expect(@klass.last_page_link).to eq('/Listings/Georgia/Atlanta/?slide=10&community=Providence')
+        end
+      end
+
+      describe 'Templates' do
+        it '#first_page_html should return string' do
+          @klass.first_page_html.should be_a_kind_of(String)
+        end
+        it '#previous_page_html should return string' do
+          @klass.previous_page_html.should be_kind_of(String)
+        end
+        it '#next_page_html should return string' do
+          @klass.next_page_html.should be_kind_of(String)
+        end
+        it '#last_page_html should return string' do
+          @klass.last_page_html.should be_kind_of(String)
+        end
+        it '#html return blank string unless total_pages' do
+          @klass.html.should be_kind_of(String)
+        end
+      end
+    end
+
+  end
+end

data/spec/unit/templates_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+module MobilePagination
+
+end

data/spec/unit/utils_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module MobilePagination
+  describe 'Utils' do
+    include Utils
+
+    it '#query_to_hash should covert query to hash' do
+      expectation = query_to_hash('a=1&b=2')
+      expect(expectation).to eq({'a' => '1', 'b' => '2'})
+    end
+
+    it '#hash_to_query should covert hash to query' do
+      expectation = hash_to_query({ :a => 1, :b => 2})
+      expect(expectation).to eq('a=1&b=2')
+    end
+
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: mobile_pagination
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Luke Fender
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Creates a series of pagination elements relative to current page.
+email:
+- lfender6445@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mobile_pagination.rb
+- lib/mobile_pagination/configuration.rb
+- lib/mobile_pagination/initialize.rb
+- lib/mobile_pagination/paginate.rb
+- lib/mobile_pagination/templates.rb
+- lib/mobile_pagination/utils/initialize.rb
+- lib/mobile_pagination/utils/utils.rb
+- lib/mobile_pagination/utils/version.rb
+- mobile_pagination.gemspec
+- spec/spec_helper.rb
+- spec/unit/mobile_pagination_spec.rb
+- spec/unit/paginate_spec.rb
+- spec/unit/templates_spec.rb
+- spec/unit/utils_spec.rb
+homepage: http://github.com/lfender6445/mobile_pagination
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Minimal and configurable pagination templating, best suited for smaller screenspace.
+  Provides buttons for first, previous, next, and last page.
+test_files: []
+has_rdoc: