middleman-pagination 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe0923ecf34b591da48f68db56accf21a08c464c
-  data.tar.gz: 069471197145f7573a3b6f697caa7b04c420b0db
+  metadata.gz: 2ec4df12de80b850fef444d0be189c97c8fdd2d7
+  data.tar.gz: ebdf7415e47c6bc08cf8ac98279c9ffaceec21f6
 SHA512:
-  metadata.gz: 7ff7468e609f467d947bf3262edeaad95bff8a22ad167ad9ad193d74b4b18071f3c06b4bbf42be80eb12a74700a4e1fb0e1f401ee2c77acf02ace7a44c854bc7
-  data.tar.gz: 812a870bf801ba01fe2da1efbd2c99f236fa4a1c1abb113eb83593a117d16c7f7dbb73e5f32cb2436456a31df753e796438bcb1d1639202a77bedbe953c427e1
+  metadata.gz: f26c742c07023224891ca0c2ca321d3f30ec835a83fa7ecb5d384d4e70fb40d821a2b10eb1ed6aafbdb7aaad3e4358b7c9ce2f8ac176b9daad70fdf0247a79c3
+  data.tar.gz: 627b85c502bd9acf4c906b22ba2b3e26bac09a4c1bc2c27f2fc0cc71596b56a95e8a4bd5633458adbd7a8f9ab981d66cc519b8af8c6e5983a02346309dc519d7

data/README.md

@@ -4,13 +4,23 @@
 [![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)
 
-**Warning: this extension is brand-new, and the API liable to change until the prerelease identifier is dropped.**
-
 General-purpose pagination support for Middleman pages.
 
 ## Installation
 
-Coming soon.
+Add this line to your Middleman site's Gemfile:
+
+```ruby
+gem 'middleman-pagination'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install middleman-pagination
 
 ## Usage
 
@@ -23,7 +33,7 @@ Let's say you have a set of recipes that you want to create pagination for:
             bacon.html
             cake.html
 
-You can create named pageable resources based on a criteria. In this case, we're going to use any page that lives inside the `recipes` as the criteria for paging through recipes. Inside your `config.rb`:
+Inside your `config.rb`:
 
 ```ruby
 activate :pagination do
@@ -64,8 +74,7 @@ Showing <%= pagination.per_page %> per page
 
 **Note:** the `for` and `per_page` properties must be indented for the `pagination` frontmatter.
 
-
-You can define as many different types of pageable resources as you like:
+You can define as many different types of pageable resources as you like, with whatever criteria you like:
 
 ```ruby
 activate :pagination do
@@ -86,6 +95,7 @@ end
 * 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`)
 
 ## Contributing
 

data/lib/middleman/pagination/manipulated_resources.rb

@@ -44,8 +44,14 @@ module Middleman
 
       def build_new_index(first_index, pageable_context, page_num)
         sitemap = context.sitemap
-        pattern = %r{(^|/)#{Regexp.escape(context.index_file)}}
-        path = first_index.path.sub(pattern, "pages/#{page_num}.html")
+        pattern = %r{(^|/)#{Regexp.escape(context.index_file)}$}
+
+        path = if first_index.path.match(pattern)
+                 first_index.path.sub(pattern, "pages/#{page_num}.html")
+               else
+                 first_index.path.sub(%r{(^|/)([^/]*)\.([^/]*)$}, "\\1\\2/pages/#{page_num}.\\3")
+               end
+
         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.0"
+    VERSION = "1.0.1"
   end
 end

data/spec/features/pagination_feature_spec.rb

@@ -87,4 +87,26 @@ describe "Pagination with directory indexes", :feature do
     find_on_page 'Prev page: /pages/3/'
     find_on_page 'Next page: none'
   end
+end
+
+describe "Pagination with indexes not named index", :feature do
+  it "produces pages for a set of resources" do
+    run_site 'recipes' do
+      activate :pagination do
+        pageable :recipes do |resource|
+          resource.path.start_with?('recipes')
+        end
+      end
+    end
+
+    visit '/all-recipes.html'
+    find_on_page 'First page: /all-recipes.html'
+    find_on_page 'Prev page: none'
+    find_on_page 'Last page: /all-recipes/pages/2.html'
+    find_on_page 'Next page: /all-recipes/pages/2.html'
+
+    visit '/all-recipes/pages/2.html'
+    find_on_page 'Prev page: /all-recipes.html'
+    find_on_page 'Next page: none'
+  end
 end

data/spec/fixtures/recipes/source/all-recipes.html.erb

@@ -0,0 +1,21 @@
+---
+pagination:
+  for: recipes
+  per_page: 4
+---
+
+<% 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 %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-pagination
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Pete Nicholls
@@ -119,6 +119,7 @@ files:
 - lib/middleman_extension.rb
 - middleman-pagination.gemspec
 - spec/features/pagination_feature_spec.rb
+- spec/fixtures/recipes/source/all-recipes.html.erb
 - spec/fixtures/recipes/source/index.html.erb
 - spec/fixtures/recipes/source/layouts/layout.erb
 - spec/fixtures/recipes/source/recipes/bacon.html.erb
@@ -159,6 +160,7 @@ specification_version: 4
 summary: Pagination for Middleman pages.
 test_files:
 - spec/features/pagination_feature_spec.rb
+- spec/fixtures/recipes/source/all-recipes.html.erb
 - spec/fixtures/recipes/source/index.html.erb
 - spec/fixtures/recipes/source/layouts/layout.erb
 - spec/fixtures/recipes/source/recipes/bacon.html.erb