middleman-pagination 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a5de30344c93337f35a33f43bb16272af19d0d9
-  data.tar.gz: 47e3482871978d4dd24219b4648f5091e801e976
+  metadata.gz: a29ba1726972cb939f315b1f5ac1ded71d23cc1f
+  data.tar.gz: 3660c0071d5073fc8df417b639a5a43c844041b3
 SHA512:
-  metadata.gz: adfb6c1815df41983f8e08242ff26469046554f2136a7dac6c87b563803216d50c27b9fecc56e456d46d7524cc33bcf74e5177755866e9cfab9ded25ba810eba
-  data.tar.gz: 715d36ca42f3f1a11520db51520e1d808af8aedcf476bb821810faeb920a7801a1971c3baf15e31d9652d328baf4003b672c67da7e898aaeae26378f54978c71
+  metadata.gz: a9e6048da2b6ae427d11fa33b968216ffefab71aef562cdc0f8b22694410332c3eddacc4c0ca1974c4c5a2f57fd168f8dbc8ea88e7cc69e5b599f63dcf1a42c4
+  data.tar.gz: 3f1fd46306b3476eb8d6e43e2436f68fc451d6a6133d79b4666645d3008090a37f8d7e45ca793a36c2133bb0396e7252a0f9ee78ba18eaf364e31d51e395c870

data/README.md

@@ -72,7 +72,7 @@ Showing <%= pagination.per_page %> per page
 <%= link_to "Last page", pagination.first_page.url %>
 ```
 
-**Note:** the `for` and `per_page` properties must be indented for the `pagination` frontmatter.
+**Note:** the `for` and `per_page` properties must be indented for the `pagination` frontmatter (`per_page` is optional).
 
 You can define as many different types of pageable resources as you like, with whatever criteria you like:
 
@@ -90,13 +90,28 @@ activate :pagination do
 end
 ```
 
+### Custom path
+
+If your pagination index is called `all-recipes.html`, the subsequent pages will ba named `all-recipes/pages/2.html`, `all-recipes/pages/3.html`, and so on.
+
+You can customise the path with the `path` pagination frontmatter. For example, in `all-recipes.html`:
+
+```
+---
+pagination:
+  for: recipes
+  path: p/:num
+---
+```
+
+Your pages would be created at `all-recipes/p/1.html`, `all-recipes/p/2.html`, etc.
+
 ## 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
 
-* Customisable path
 * Custom sorting (e.g. by date)
 * Convenience helper methods (e.g. make `pagination.` optional)
 * Pagination link generator (e.g. `Pages: 1 2 [3] ... 7 8 9`)

data/lib/middleman/pagination/index_path.rb

@@ -3,10 +3,10 @@ module Middleman
     class IndexPath
       attr_accessor :context, :original_path, :page_num, :symbolic_path_replacement
 
-      def initialize(context, original_path, page_num, symbolic_path_replacement = 'pages/:num')
+      def initialize(context, original_path, page_num, symbolic_path_replacement = nil)
         @context = context
         @original_path = original_path
-        @symbolic_path_replacement = symbolic_path_replacement
+        @symbolic_path_replacement = symbolic_path_replacement || 'pages/:num'
 
         if page_num < 1
           raise "Expected page_num greater than 0 (page numbers are not zero-indexed"

data/lib/middleman/pagination/manipulated_resources.rb

@@ -29,6 +29,8 @@ module Middleman
       end
       
       def new_resources_for_index(first_index, filter)
+        symbolic_replacement_path = first_index.data.pagination.try(:path)
+
         pageable_context = PageableContext.new(
           per_page: first_index.data.pagination.per_page || 20,
           # OPTIMIZE
@@ -39,13 +41,13 @@ module Middleman
         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)
+          build_new_index(first_index, pageable_context, n, symbolic_replacement_path)
         end
       end
 
-      def build_new_index(first_index, pageable_context, page_num)
+      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).to_s
+        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)

data/lib/middleman/pagination/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Pagination
-    VERSION = "1.0.4"
+    VERSION = "1.0.5"
   end
 end

data/spec/features/custom_path_feature_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe "Pagination with custom path", :feature do
+  it "produces pages for a set of resources with a custom path" do
+    run_site 'recipes' do
+      activate :pagination do
+        pageable :recipes do |resource|
+          resource.path.start_with?('recipes')
+        end
+      end
+    end
+
+    visit '/custom.html'
+    find_on_page 'First page: /custom.html'
+    find_on_page 'Prev page: none'
+    find_on_page 'Last page: /custom/p/2.html'
+    find_on_page 'Next page: /custom/p/2.html'
+
+    visit '/custom/p/2.html'
+    find_on_page 'Prev page: /custom.html'
+    find_on_page 'Next page: none'
+  end
+end

data/spec/fixtures/recipes/source/custom.html.erb

@@ -0,0 +1,22 @@
+---
+pagination:
+  for: recipes
+  per_page: 4
+  path: p/:num
+---
+
+<% pagination.each do |recipe| %>
+- <%= recipe.data.title %>
+<% 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/middleman/pagination/manipulated_resources_spec.rb

@@ -28,7 +28,7 @@ module Middleman::Pagination
         }
 
         let(:pagination_index) {
-          pagination_data = double(for: 'recipes', per_page: 2)
+          pagination_data = double(for: 'recipes', per_page: 2, path: nil)
           resource = double(:resource, path: 'index.html', is_recipe?: false, ignored?: false).as_null_object
           resource.stub_chain(:data, pagination: pagination_data)
           resource

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-pagination
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Pete Nicholls
@@ -119,10 +119,12 @@ files:
 - lib/middleman/pagination/version.rb
 - lib/middleman_extension.rb
 - middleman-pagination.gemspec
+- spec/features/custom_path_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/recipes/source/all-recipes.html.erb
+- spec/fixtures/recipes/source/custom.html.erb
 - spec/fixtures/recipes/source/index.html.erb
 - spec/fixtures/recipes/source/layouts/layout.erb
 - spec/fixtures/recipes/source/recipes/bacon.html.erb
@@ -163,10 +165,12 @@ signing_key:
 specification_version: 4
 summary: Pagination for Middleman pages.
 test_files:
+- spec/features/custom_path_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/recipes/source/all-recipes.html.erb
+- spec/fixtures/recipes/source/custom.html.erb
 - spec/fixtures/recipes/source/index.html.erb
 - spec/fixtures/recipes/source/layouts/layout.erb
 - spec/fixtures/recipes/source/recipes/bacon.html.erb