inazuma 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTk3NjVjZDBhMmMzNWJkM2M3NDNkMjAwNmJjZDU5M2ZjZjYyMWJhNg==
+  data.tar.gz: !binary |-
+    NTRiZDQyOThhMzJjMDRhZmIyYTk3YjdiZTNmZGY2NzIxM2JhMWI4Mg==
+SHA512:
+  metadata.gz: !binary |-
+    ZmZhZmMxNzE1ODkzZjE0MjFhNWFiMDU3N2ZlODExNGYxYThlZWE1NmRlMThm
+    YzdjNDc0MWVkM2YyNDFhODFkNTcyYThjNzRkNDQ1MzYzYTZkY2YxMzcyYjZm
+    OTRmZDgwNTdhZDc1ZjVkZTE3NjRkNWVlYzVkMDRmMGU2ZDM2ZDg=
+  data.tar.gz: !binary |-
+    ZjkzODI3NDZjNjgxNWUyMjFjZmE3Yjg3YTAxMGEyN2YwYTQ5ZmE2MWNhMTdh
+    MDZmMzZhMTdiNWZhYmQxZDQ2MjIyNmRkZjM1NjFlNzAxNTZmZDIwNmZhMGM4
+    NDI0NTgzZDcyZTQwYWYzODgyOTUwZDEwMjc0MDJlM2RiMWE2MjE=

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 inazuma.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Zachary Friedman
+
+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 @@
+# Inazuma
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'inazuma'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inazuma
+
+## 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 @@
+require "bundler/gem_tasks"

data/inazuma.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inazuma/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "inazuma"
+  spec.version       = Inazuma::VERSION
+  spec.authors       = ["Zachary Friedman"]
+  spec.email         = ["zafriedman@gmail.com"]
+  spec.description   = %q{Lightweight, ORM and framework agnostic pagination library for Ruby}
+  spec.summary       = %q{A simple pagination library for Ruby}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 3.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/inazuma.rb

@@ -0,0 +1,9 @@
+require "inazuma/version"
+
+module Inazuma
+end
+
+require 'inazuma/config'
+require 'inazuma/configuration_methods'
+require 'inazuma/page_scope_methods'
+require 'inazuma/paginatable_array'

data/lib/inazuma/config.rb

@@ -0,0 +1,45 @@
+require 'active_support/configurable'
+
+module Inazuma
+  # Configures global settings for Inazuma
+  #   Inazuma.configure do |config|
+  #     config.default_per_page = 10
+  #   end
+  def self.configure(&block)
+    yield @config ||= Inazuma::Configuration.new
+  end
+
+  # Global settings for Inazuma
+  def self.config
+    @config
+  end
+
+  # need a Class for 3.0
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    config_accessor :default_per_page
+    config_accessor :max_per_page
+    config_accessor :page_method_name
+    config_accessor :max_pages
+    config_accessor :add_link_headers
+
+    def param_name
+      config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
+    end
+
+    # define param_name writer (copied from AS::Configurable)
+    writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
+    singleton_class.class_eval writer, __FILE__, line
+    class_eval writer, __FILE__, line
+  end
+
+  # this is ugly. why can't we pass the default value to config_accessor...?
+  configure do |config|
+    config.default_per_page = 25
+    config.max_per_page = nil
+    config.page_method_name = :page
+    config.param_name = :page
+    config.max_pages = nil
+    config.add_link_headers = false
+  end
+end

data/lib/inazuma/configuration_methods.rb

@@ -0,0 +1,52 @@
+module Inazuma
+  module ConfigurationMethods
+    extend ActiveSupport::Concern
+    module ClassMethods
+      # Overrides the default +per_page+ value per model
+      #   class Article < ActiveRecord::Base
+      #     paginates_per 10
+      #   end
+      def paginates_per(val)
+        @_default_per_page = val
+      end
+
+      # This model's default +per_page+ value
+      # returns +default_per_page+ value unless explicitly overridden via <tt>paginates_per</tt>
+      def default_per_page
+        (defined?(@_default_per_page) && @_default_per_page) || Inazuma.config.default_per_page
+      end
+
+      # Overrides the max +per_page+ value per model
+      #   class Article < ActiveRecord::Base
+      #     max_paginates_per 100
+      #   end
+      def max_paginates_per(val)
+        @_max_per_page = val
+      end
+
+      # This model's max +per_page+ value
+      # returns +max_per_page+ value unless explicitly overridden via <tt>max_paginates_per</tt>
+      def max_per_page
+        (defined?(@_max_per_page) && @_max_per_page) || Inazuma.config.max_per_page
+      end
+
+      # Overrides the max_pages value per model
+      #   class Article < ActiveRecord::Base
+      #     max_pages_per 100
+      #   end
+      def max_pages_per(val)
+        @_max_pages = val
+      end
+
+      # This model's max_pages value
+      # returns max_pages value unless explicitly overridden via <tt>max_pages_per</tt>
+      def max_pages
+        (defined?(@_max_pages) && @_max_pages) || Inazuma.config.max_pages
+      end
+
+      def add_link_headers?
+        Inazuma.config.add_link_headers
+      end
+    end
+  end
+end

data/lib/inazuma/page_scope_methods.rb

@@ -0,0 +1,70 @@
+module Inazuma
+  module PageScopeMethods
+    # Specify the <tt>per_page</tt> value for the preceding <tt>page</tt> scope
+    #   Model.page(3).per(10)
+    def per(num)
+      if (n = num.to_i) <= 0
+        self
+      elsif max_per_page && max_per_page < n
+        limit(max_per_page).offset(offset_value / limit_value * max_per_page)
+      else
+        limit(n).offset(offset_value / limit_value * n)
+      end
+    end
+
+    def padding(num)
+      @_padding = num
+      offset(offset_value + num.to_i)
+    end
+
+    # Total number of pages
+    def total_pages
+      count_without_padding = total_count
+      count_without_padding -= @_padding if defined?(@_padding) && @_padding
+      count_without_padding = 0 if count_without_padding < 0
+
+      total_pages_count = (count_without_padding.to_f / limit_value).ceil
+      if max_pages.present? && max_pages < total_pages_count
+        max_pages
+      else
+        total_pages_count
+      end
+    end
+    #FIXME for compatibility. remove num_pages at some time in the future
+    alias num_pages total_pages
+
+    # Current page number
+    def current_page
+      offset_without_padding = offset_value
+      offset_without_padding -= @_padding if defined?(@_padding) && @_padding
+      offset_without_padding = 0 if offset_without_padding < 0
+
+      (offset_without_padding / limit_value) + 1
+    end
+
+    # Next page number in the collection
+    def next_page
+      current_page + 1 unless last_page?
+    end
+
+    # Previous page number in the collection
+    def prev_page
+      current_page - 1 unless first_page?
+    end
+
+    # First page of the collection?
+    def first_page?
+      current_page == 1
+    end
+
+    # Last page of the collection?
+    def last_page?
+      current_page >= total_pages
+    end
+
+    # Out of range of the collection?
+    def out_of_range?
+      current_page > total_pages
+    end
+  end
+end

data/lib/inazuma/paginatable_array.rb

@@ -0,0 +1,58 @@
+require 'active_support/core_ext/module'
+module Inazuma
+  # Kind of Array that can paginate
+  class PaginatableArray < Array
+    include Inazuma::ConfigurationMethods::ClassMethods
+
+    attr_internal_accessor :limit_value, :offset_value
+
+    # ==== Options
+    # * <tt>:limit</tt> - limit
+    # * <tt>:offset</tt> - offset
+    # * <tt>:total_count</tt> - total_count
+    def initialize(original_array = [], options = {})
+      @_original_array, @_limit_value, @_offset_value, @_total_count, @_padding = original_array, (options[:limit] || default_per_page).to_i, options[:offset].to_i, options[:total_count], options[:padding].to_i
+
+      if options[:limit] && options[:offset]
+        extend Inazuma::PageScopeMethods
+      end
+
+      if options[:total_count]
+        super original_array
+      else
+        super(original_array[@_offset_value, @_limit_value] || [])
+      end
+    end
+
+    # items at the specified "page"
+    class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{Inazuma.config.page_method_name}(num = 1)
+        offset(limit_value * ([num.to_i, 1].max - 1))
+      end
+    RUBY
+
+    # returns another chunk of the original array
+    def limit(num)
+      self.class.new @_original_array, :limit => num, :offset => @_offset_value, :total_count => @_total_count, :padding => @_padding
+    end
+
+    # total item numbers of the original array
+    def total_count
+      @_total_count || @_original_array.count
+    end
+
+    # returns another chunk of the original array
+    def offset(num)
+      self.class.new @_original_array, :limit => @_limit_value, :offset => num, :total_count => @_total_count, :padding => @_padding
+    end
+  end
+
+  # Wrap an Array object to make it paginatable
+  # ==== Options
+  # * <tt>:limit</tt> - limit
+  # * <tt>:offset</tt> - offset
+  # * <tt>:total_count</tt> - total_count
+  def self.paginate_array(array, options = {})
+    PaginatableArray.new array, options
+  end
+end

data/lib/inazuma/version.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: inazuma
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zachary Friedman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lightweight, ORM and framework agnostic pagination library for Ruby
+email:
+- zafriedman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- inazuma.gemspec
+- lib/inazuma.rb
+- lib/inazuma/config.rb
+- lib/inazuma/configuration_methods.rb
+- lib/inazuma/page_scope_methods.rb
+- lib/inazuma/paginatable_array.rb
+- lib/inazuma/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: A simple pagination library for Ruby
+test_files: []