middleman-pagination 1.0.7 → 1.0.8.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6585d00919a91cfbdddc63b60109f4472f7eb005
-  data.tar.gz: 616eda1fe14317f7cbaf8b4f26304c5be10aab78
+  metadata.gz: b831157223541650867242a75896caca0f81903d
+  data.tar.gz: 0564a1276c93a5df3c9d0184ebc66f6fc7985f99
 SHA512:
-  metadata.gz: 2700db7a4c0f1d3b264dbdd0ba59f5444962dfbb2fa363ec7e562576113231ad17e9fa261a8e506d4030e4fab59413a22c95f517f1a46330f5b1c8d5caf5a4e0
-  data.tar.gz: 79ac07a2e77556d20586a315e9b36fc8af03fd7f4a65c3c188c254a80550ccc173370448f95e464fa2a7b6e2d0d92797c99e4f1ffc38e9b05e35349a765e6a5b
+  metadata.gz: d0983b61e7e671b5d684552c863bdca87826848dc52885ee0e5366163dbbb52ff0f40b28008400b0ecbdb03f1a4e09f64636835b2faf0fc0e82724d5abd85be1
+  data.tar.gz: 2ba41a1bea041d3affb87ffdd518d3838468b00209b3be23d2560610b42fad075af7db610b2bffad1a182d6deca8d089b5afe416c246c740fee986cf97476dc1

data/README.md

@@ -4,8 +4,10 @@
 [![Code Climate](https://codeclimate.com/github/Aupajo/middleman-pagination.png)](https://codeclimate.com/github/Aupajo/middleman-pagination)
 [![Dependency Status](https://gemnasium.com/Aupajo/middleman-pagination.png)](https://gemnasium.com/Aupajo/middleman-pagination)
 
-General-purpose pagination support for Middleman pages. Proxy pages for both pageable resources and pagination indexes are supported.
- 
+General-purpose pagination support for Middleman.
+
+Middleman resources, proxy pages, and any arbitrary collection of objects can be paginated.
+
 ## Installation
 
 Add this line to your Middleman site's Gemfile:
@@ -106,12 +108,46 @@ pagination:
 
 Your pages would be created at `all-recipes/p/1.html`, `all-recipes/p/2.html`, etc.
 
+## Paginate anything
+
+*This is an experimental feature available in `1.0.8.beta1`. Change your Gemfile to `gem 'middleman-pagination', '~> 1.0.8.beta1` to try it out.*
+
+You can paginate any collection of objects that responds to `each`, by using `pageable_set`:
+
+```ruby
+activate :pagination do
+  pageable_set :planets do
+    ['Mercury', 'Venus', 'Earth', 'Mars', 'Jupiter', 'Saturn', 'Uranus', 'Neptune']
+  end
+end
+```
+
+The set can be used in exactly the same way:
+
+```
+---
+pagination:
+  for: planets
+  per_page: 4
+---
+
+Planets (showing <%= pagination.per_page %> per page):
+
+<% pagination.each do |planet| %>
+  - <%= planet %>
+<% end %>
+
+Next page: <%= pagination.next_page.url %>
+```
+
 ## Getting help
 
 Bug? Feature request? You can [open an issue](https://github.com/Aupajo/middleman-pagination/issues), [contact me on Twitter](http://twitter.com/aupajo), or [start a new topic on the Middleman forums](http://forum.middlemanapp.com). All feedback and suggestions welcome.
 
 ## TODO
 
+* Support for paginating Middleman data
+* Support for Middleman's Queryable interface
 * Custom sorting (e.g. by date)
 * Add tests for metadata support
 * Convenience helper methods (e.g. make `pagination.` optional)

data/lib/middleman/pagination.rb

@@ -4,7 +4,9 @@ require "middleman/pagination/version"
 require "middleman/pagination/configuration"
 require "middleman/pagination/extension_context"
 require "middleman/pagination/manipulated_resources"
+require "middleman/pagination/pageable"
 require "middleman/pagination/pageable_context"
+require "middleman/pagination/index_page"
 require "middleman/pagination/index_path"
 require "middleman/pagination/in_page_context"
 require "middleman/pagination/extension"

data/lib/middleman/pagination/configuration.rb

@@ -8,11 +8,17 @@ module Middleman
       end
 
       def pageable(name, &block)
-        @pageable[name] = block
+        @pageable[name] = Pageable.new(name, resource_filter: block)
+      end
+
+      def pageable_set(name, &block)
+        @pageable[name] = Pageable.new(name, set: block)
       end
 
       def each(&block)
-        @pageable.each(&block)
+        @pageable.each do |name, pageable_obj|
+          yield pageable_obj
+        end
       end
     end
   end

data/lib/middleman/pagination/in_page_context.rb

@@ -4,7 +4,7 @@ module Middleman
       extend Forwardable
       include Enumerable
 
-      def_delegators :pageable_context, :resources,
+      def_delegators :pageable_context, :set,
                                         :index_resources,
                                         :total_page_num,
                                         :per_page,
@@ -19,13 +19,13 @@ module Middleman
         index_resources[page_num - 2] if page_num > 1
       end
 
-      def current_resources
+      def subset
         num_previous = per_page * (page_num - 1)
-        resources.drop(num_previous).take(per_page)
+        set.drop(num_previous).take(per_page)
       end
 
       def each(&block)
-        current_resources.each(&block)
+        subset.each(&block)
       end
     end
   end

data/lib/middleman/pagination/index_page.rb

@@ -0,0 +1,49 @@
+module Middleman
+  module Pagination
+    class IndexPage
+
+      attr_reader :context, :first_index, :pageable_context, :page_num, :symbolic_replacement_path
+
+      def initialize(context, first_index, pageable_context, page_num, symbolic_replacement_path)
+        @context = context
+        @first_index = first_index
+        @pageable_context = pageable_context
+        @page_num = page_num
+        @symbolic_replacement_path = symbolic_replacement_path
+      end
+
+      def resource
+        res = ::Middleman::Sitemap::Resource.new(sitemap, path, source_file)
+        res.add_metadata(metadata)
+        res
+      end
+
+      private
+
+      def source_file
+        first_index.source_file
+      end
+
+      def sitemap
+        context.sitemap
+      end
+
+      def path
+        IndexPath.new(context, first_index.path, page_num, symbolic_replacement_path).to_s
+      end
+
+      def metadata
+        { locals: locals }
+      end
+
+      def locals
+        { pagination: in_page_context }
+      end
+
+      def in_page_context
+        InPageContext.new(pageable_context: pageable_context, page_num: page_num)
+      end
+
+    end
+  end
+end

data/lib/middleman/pagination/manipulated_resources.rb

@@ -14,62 +14,11 @@ module Middleman
 
       private
 
-      def pagination_data(resource, key)
-        keys = [:pagination, key]
-
-        [resource.data, resource.metadata[:options]].inject(nil) do |result, data_source|
-          result or keys.inject(data_source) { |source, key| source.try(:[], key) }
-        end
-      end
-
       def new_resources
-        context.configuration.map do |name, filter|
-          new_resources_for_pageable(name, filter)
+        context.configuration.map do |pageable|
+          pageable.new_resources(context, original_resources)
         end.flatten
       end
-
-      def new_resources_for_pageable(name, filter)
-        original_resources.map do |resource|
-          if !resource.ignored? && pagination_data(resource, :for) == name.to_s
-            new_resources_for_index(resource, filter)
-          end
-        end.compact
-      end
-
-      def new_resources_for_index(first_index, filter)
-        symbolic_replacement_path = pagination_data(first_index, :path)
-
-        pageable_context = PageableContext.new(
-          per_page: pagination_data(first_index, :per_page) || 20,
-          # OPTIMIZE
-          resources: original_resources.reject(&:ignored?).select(&filter).sort_by(&:path),
-          index_resources: [first_index]
-        )
-
-        add_pagination_to(first_index, pageable_context: pageable_context, page_num: 1)
-
-        (2..pageable_context.total_page_num).map do |n|
-          build_new_index(first_index, pageable_context, n, symbolic_replacement_path)
-        end
-      end
-
-      def build_new_index(first_index, pageable_context, page_num, symbolic_replacement_path)
-        sitemap = context.sitemap
-        path = IndexPath.new(context, first_index.path, page_num, symbolic_replacement_path).to_s
-        source_file = first_index.source_file
-
-        new_index = ::Middleman::Sitemap::Resource.new(sitemap, path, source_file)
-        add_pagination_to(new_index, pageable_context: pageable_context, page_num: page_num)
-        
-        pageable_context.index_resources << new_index
-
-        new_index
-      end
-
-      def add_pagination_to(resource, attributes = {})
-        in_page_context = InPageContext.new(attributes)
-        resource.add_metadata(locals: { 'pagination' => in_page_context })
-      end
     end
   end
 end

data/lib/middleman/pagination/pageable.rb

@@ -0,0 +1,85 @@
+module Middleman
+  module Pagination
+    class Pageable
+
+      attr_reader :name, :resource_filter
+
+      def initialize(name, options = {})
+        @name = name
+        @resource_filter = options[:resource_filter]
+        @set = options[:set]
+      end
+
+      def new_resources(context, resources)
+        pagination_indexes(resources).map do |resource|
+          new_pages_for_index(context, resource, resources)
+        end.compact
+      end
+
+      private
+
+      def set(resources)
+        if @set
+          @set.call
+        else
+          set_from_resource_filter(resources)
+        end
+      end
+
+      def pagination_indexes(resources)
+        Enumerator.new do |enum| 
+          resources.each do |resource|
+            if !resource.ignored? && pagination_data(resource, :for) == name.to_s
+              enum.yield resource
+            end
+          end
+        end
+      end
+
+      def new_pages_for_index(context, index, resources)
+        symbolic_replacement_path = pagination_data(index, :path)
+
+        pageable_context = PageableContext.new(
+          per_page: pagination_data(index, :per_page) || 20,
+          set: set(resources),
+          index_resources: [index]
+        )
+
+        add_pagination_to(index, pageable_context: pageable_context, page_num: 1)
+
+        (2..pageable_context.total_page_num).map do |page_num|
+          new_index = IndexPage.new(context,
+                                    index,
+                                    pageable_context,
+                                    page_num,
+                                    symbolic_replacement_path).resource
+
+          pageable_context.index_resources << new_index
+
+          new_index
+        end
+      end
+
+      def add_pagination_to(resource, attributes = {})
+        in_page_context = InPageContext.new(attributes)
+        resource.add_metadata(locals: { 'pagination' => in_page_context })
+      end
+      
+      def pagination_data(resource, key)
+        keys = [:pagination, key]
+
+        [resource.data, resource.metadata[:options]].inject(nil) do |result, data_source|
+          result or keys.inject(data_source) { |source, key| source.try(:[], key) }
+        end
+      end
+
+      def set_from_resource_filter(resources)
+        resources.select do |resource|
+          next if resource.ignored?
+          resource_filter.call(resource)
+        end.sort_by(&:path)
+      end
+
+    end
+  end
+end

data/lib/middleman/pagination/pageable_context.rb

@@ -2,7 +2,7 @@ module Middleman
   module Pagination
     class PageableContext < OpenStruct
       def total_page_num
-        (resources.length.to_f / per_page).ceil
+        (set.length.to_f / per_page).ceil
       end
 
       def first_page

data/lib/middleman/pagination/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Pagination
-    VERSION = "1.0.7"
+    VERSION = "1.0.8.beta1"
   end
 end

data/spec/features/paginate_any_data_feature_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe "Pagination with data", :feature do
+  it "produces pages for a set of resources with a custom path" do
+    run_site 'pantheon' do
+      activate :pagination do
+        pageable_set :gods do
+          %w{ Ares Aphrodite Apollo Artemis Athena Demeter Hephaestus Hestia Zeus Hera Poseidon Hermes }
+        end
+      end
+    end
+
+    visit '/'
+    find_on_page 'Ares'
+    find_on_page 'Aphrodite'
+    find_on_page 'Apollo'
+    find_on_page 'Artemis'
+
+    visit '/pages/2.html'
+    find_on_page 'Athena'
+    find_on_page 'Demeter'
+    find_on_page 'Hephaestus'
+    find_on_page 'Hestia'
+
+    visit '/pages/3.html'
+    find_on_page 'Zeus'
+    find_on_page 'Hera'
+    find_on_page 'Poseidon'
+    find_on_page 'Hermes'
+  end
+end

data/spec/fixtures/pantheon/source/index.html.erb

@@ -0,0 +1,21 @@
+---
+pagination:
+  for: gods
+  per_page: 4
+---
+
+<% pagination.each do |god| %>
+- <%= god %>
+<% end %>
+
+Page <%= pagination.page_num %> of <%= pagination.total_page_num %>
+
+Showing <%= pagination.per_page %> per page
+
+First page: <%= pagination.first_page.url %>
+
+Next page: <%= pagination.next_page.try(:url) || 'none' %>
+
+Prev page: <%= pagination.prev_page.try(:url) || 'none' %>
+
+Last page: <%= pagination.last_page.url %>

data/spec/fixtures/pantheon/source/layouts/layout.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/middleman/pagination/configuration_spec.rb

@@ -11,15 +11,15 @@ describe Middleman::Pagination::Configuration do
   end
 
   describe "#each" do
-    it "yields the name and the block" do
+    it "yields each pageable object" do
       config = described_class.new
       block = lambda {}
       config.pageable(:recipes, &block)
 
       collected = []
       
-      config.each do |name, block|
-        collected << [name, block]
+      config.each do |pageable|
+        collected << [pageable.name, pageable.resource_filter]
       end
 
       expect(collected).to eql([[:recipes, block]])
@@ -35,7 +35,11 @@ describe Middleman::Pagination::Configuration do
       end
 
       result = nil
-      config.each { |name, block| result = block.call }
+      
+      config.each do |pageable|
+        result = pageable.resource_filter.call
+      end
+
       expect(result).to be(:ok)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-pagination
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8.beta1
 platform: ruby
 authors:
 - Pete Nicholls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2013-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -113,16 +113,21 @@ files:
 - lib/middleman/pagination/extension.rb
 - lib/middleman/pagination/extension_context.rb
 - lib/middleman/pagination/in_page_context.rb
+- lib/middleman/pagination/index_page.rb
 - lib/middleman/pagination/index_path.rb
 - lib/middleman/pagination/manipulated_resources.rb
+- lib/middleman/pagination/pageable.rb
 - lib/middleman/pagination/pageable_context.rb
 - lib/middleman/pagination/version.rb
 - lib/middleman_extension.rb
 - middleman-pagination.gemspec
 - spec/features/custom_path_feature_spec.rb
+- spec/features/paginate_any_data_feature_spec.rb
 - spec/features/pagination_feature_spec.rb
 - spec/fixtures/mine/source/index.html.erb
 - spec/fixtures/mine/source/minerals/template.html.erb
+- spec/fixtures/pantheon/source/index.html.erb
+- spec/fixtures/pantheon/source/layouts/layout.erb
 - spec/fixtures/recipes/source/all-recipes.html.erb
 - spec/fixtures/recipes/source/custom.html.erb
 - spec/fixtures/recipes/source/index.html.erb
@@ -155,20 +160,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Pagination for Middleman pages.
 test_files:
 - spec/features/custom_path_feature_spec.rb
+- spec/features/paginate_any_data_feature_spec.rb
 - spec/features/pagination_feature_spec.rb
 - spec/fixtures/mine/source/index.html.erb
 - spec/fixtures/mine/source/minerals/template.html.erb
+- spec/fixtures/pantheon/source/index.html.erb
+- spec/fixtures/pantheon/source/layouts/layout.erb
 - spec/fixtures/recipes/source/all-recipes.html.erb
 - spec/fixtures/recipes/source/custom.html.erb
 - spec/fixtures/recipes/source/index.html.erb