middleman-paginate 0.1.3 → 0.1.4.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a84f25e6ff6b38f219a0fd27053bd75aa094bca2
-  data.tar.gz: fe0775c19cbd7bae7df0f3ded11e0807d30c5544
+  metadata.gz: 82c55456c0157b6defcafd44b750cc242fa41ef8
+  data.tar.gz: 568e49311e123d877ba3af7ea0e58c1e456a05b0
 SHA512:
-  metadata.gz: f32d457d783865981779024eb32fbde0c46a36e47dfa1d72caef9baaa8f058c3a3f5bec469b6277e0080aba09b80dad837e1e570c4042035ec713a12057fbd15
-  data.tar.gz: a45eb9b23387c961c144c8a6fd97e55131f395045d5c4d5eaae112e6c2f995540e0985ea9c75314287082ab62c8c45241ceaead2cae4da624cc9170854171425
+  metadata.gz: daf5828b4d983dba7d7490652cae522798282e9ef4db231fbae6533d9c76d9046a243209735044235c3cb768c3833b9e49dc4c2b5d1ef9e0633bc70103d0d23d
+  data.tar.gz: 1874e243df4623f1e5395d442ccf12ed169192133fd39caddddd953cde652652ba5c73555535d96fb6da3460b1ea004eeb3c49016be9118b5a89877f35b7c079

data/README.md

@@ -22,7 +22,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Consider that middleman-paginate creates a page for each set of data sliced from your collection. This page is created by a template. In your config.rb
+
+```ruby
+paginate data.your_collection, "/episodes", "/templates/episodes.html"
+```
+
+in your pagination template you'll find a collection named `items` with the objects for the specific page:
+
+```ruby
+- items.each do |episode|
+  p= episode.title
+```
+
+You also have an object `pager` that offers some helpers to build the pagination links:
+
+```ruby
+- if pager.next_page
+  = link_to "Next page", pager.page_path(pager.next_page)
+- if pager.previous_page
+  = link_to "Previous page", pager.page_path(pager.previous_page)
+```
+
+The final URLs will be:
+
+```
+http://127.0.0.1:4567/episodes.html
+http://127.0.0.1:4567/episodes/page/2.html
+http://127.0.0.1:4567/episodes/page/3.html
+```
+
+and so on.
 
 ## Development
 

data/lib/middleman/paginate/extension.rb

@@ -3,9 +3,18 @@ require 'middleman_dato/middleman_extension'
 
 module Middleman
   module Paginate
-    class Extension < ::Middleman::Extension
+    class Extension < ::Middleman::ConfigExtension
+      self.resource_list_manipulator_priority = 0
       expose_to_config paginate: :paginate
 
+      CollectionProxyDescriptor = Struct.new(:descriptors) do
+        def execute_descriptor(app, resources)
+          descriptors.reduce(resources) do |resources, descriptor|
+            descriptor.execute_descriptor(app, resources)
+          end
+        end
+      end
+
       class Pager
         attr_reader :current_page, :total_pages, :per_page
 
@@ -31,24 +40,25 @@ module Middleman
       end
 
       def paginate(collection, base_path, template, per_page: 20, suffix: "/page/:num", locals: {}, data: {})
-        collection.tap do |collection|
-          pages = collection.each_slice(per_page).to_a
-
-          pages.each_with_index do |page_collection, i|
-            pager = Pager.new(base_path, suffix, i + 1, pages.size, per_page)
-
-            opts = {
-              locals: locals.merge(items: page_collection, pager: pager),
-              data: data
-            }
-
-            proxy(
-              Middleman::Util.normalize_path(pager.page_path),
-              Middleman::Util.normalize_path(template),
-              opts
-            )
-          end
+        pages = collection.each_slice(per_page).to_a
+        descriptors = []
+
+        pages.each_with_index do |page_collection, i|
+          pager = Pager.new(base_path, suffix, i + 1, pages.size, per_page)
+
+          opts = {
+            locals: locals.merge(items: page_collection, pager: pager),
+            data: data
+          }
+
+          descriptors << Middleman::Sitemap::Extensions::ProxyDescriptor.new(
+            Middleman::Util.normalize_path(pager.page_path),
+            Middleman::Util.normalize_path(template),
+            opts.dup
+          )
         end
+
+        CollectionProxyDescriptor.new(descriptors)
       end
     end
   end

data/lib/middleman/paginate/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Paginate
-    VERSION = "0.1.3"
+    VERSION = "0.1.4.pre"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-paginate
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4.pre
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,9 +103,9 @@ 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.5.1
@@ -113,3 +113,4 @@ signing_key:
 specification_version: 4
 summary: A simple helper to generate custom paginated content with Middleman
 test_files: []
+has_rdoc: