middleman-pagination 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ec4df12de80b850fef444d0be189c97c8fdd2d7
-  data.tar.gz: ebdf7415e47c6bc08cf8ac98279c9ffaceec21f6
+  metadata.gz: 102b81437ae7290ba740170291acecfba9734692
+  data.tar.gz: 626ed8051a0aedc31ceb84321ef811916b1efc81
 SHA512:
-  metadata.gz: f26c742c07023224891ca0c2ca321d3f30ec835a83fa7ecb5d384d4e70fb40d821a2b10eb1ed6aafbdb7aaad3e4358b7c9ce2f8ac176b9daad70fdf0247a79c3
-  data.tar.gz: 627b85c502bd9acf4c906b22ba2b3e26bac09a4c1bc2c27f2fc0cc71596b56a95e8a4bd5633458adbd7a8f9ab981d66cc519b8af8c6e5983a02346309dc519d7
+  metadata.gz: 5db875234970ea265ed0a35a3d1211b6baa3139ddf595a44d814f74ec8eaf8ada18e4d8ad095eb2f71c564d57a5be6263d294fced1d445e2754be989f0b9843d
+  data.tar.gz: 9b9f8734c8d42819a3ff595585bd0c73f22754d110af05438d705008ff7c54c5c8cfe836b5af1df1f620601c4dc3c28239cf04873e26fc356f2dfd1400df130a

data/README.md

@@ -4,8 +4,8 @@
 [![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.
-
+General-purpose pagination support for Middleman pages. Proxy pages for both pageable resources and pagination indexes are supported.
+ 
 ## Installation
 
 Add this line to your Middleman site's Gemfile:
@@ -84,7 +84,7 @@ activate :pagination do
   end
 
   pageable :news do |page|
-    # Match any page that has "news" in its frontmatter
+    # Match any page that has a "news" property in its frontmatter
     page.data.news.present?
   end
 end

data/lib/middleman/pagination/manipulated_resources.rb

@@ -22,16 +22,18 @@ module Middleman
 
       def new_resources_for_pageable(name, filter)
         original_resources.map do |resource|
-          if resource.data.pagination.try(:for) == name.to_s
+          if !resource.ignored? && resource.data.pagination.try(:for) == name.to_s
             new_resources_for_index(resource, filter)
           end
         end.compact
       end
       
       def new_resources_for_index(first_index, filter)
+        puts "Creating new resources for index: #{first_index.path}"
         pageable_context = PageableContext.new(
           per_page: first_index.data.pagination.per_page || 20,
-          resources: original_resources.select(&filter).sort_by(&:path),
+          # OPTIMIZE
+          resources: original_resources.reject(&:ignored?).select(&filter).sort_by(&:path),
           index_resources: [first_index]
         )
 
@@ -44,14 +46,7 @@ module Middleman
 
       def build_new_index(first_index, pageable_context, page_num)
         sitemap = context.sitemap
-        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
-
+        path = secondary_index_path(first_index.path, page_num)
         source_file = first_index.source_file
 
         new_index = ::Middleman::Sitemap::Resource.new(sitemap, path, source_file)
@@ -62,6 +57,18 @@ module Middleman
         new_index
       end
 
+      def secondary_index_path(original_path, page_num)
+        symbolic_path_replacement = "pages/:num"
+        pattern = %r{^?(/)?#{Regexp.escape(context.index_file)}$}
+        replacement = symbolic_path_replacement.sub(':num', page_num.to_s)
+
+        if original_path.match(pattern)
+          original_path.sub(pattern, "\\1#{replacement}.html")
+        else
+          original_path.sub(%r{(^|/)([^/]*)\.([^/]*)$}, "\\1\\2/#{replacement}.\\3")
+        end
+      end
+
       def add_pagination_to(resource, attributes = {})
         in_page_context = InPageContext.new(attributes)
         resource.add_metadata(:locals => { 'pagination' => in_page_context })

data/lib/middleman/pagination/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Pagination
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

data/spec/features/pagination_feature_spec.rb

@@ -109,4 +109,115 @@ describe "Pagination with indexes not named index", :feature do
     find_on_page 'Prev page: /all-recipes.html'
     find_on_page 'Next page: none'
   end
+end
+
+describe "Pagination with proxied resources and ignored proxy resource template", :feature do
+  it "produces pages for a set of resources" do
+    run_site 'mine' do
+      %w{ Feldspar Olivine Quartz }.each do |mineral|
+        proxy "/minerals/#{mineral.downcase}.html", '/minerals/template.html', locals: { mineral: mineral }, ignore: true
+      end
+
+      activate :pagination do
+        pageable :minerals do |resource|
+          resource.path.start_with?('mineral')
+        end
+      end
+    end
+
+    visit '/'
+    find_on_page 'Feldspar'
+    find_on_page 'Olivine'
+    find_on_page 'First page: /'
+    find_on_page 'Prev page: none'
+    find_on_page 'Last page: /pages/2.html'
+    find_on_page 'Next page: /pages/2.html'
+
+    visit '/pages/2.html'
+    find_on_page 'Quartz'
+    find_on_page 'Prev page: /'
+    find_on_page 'Next page: none'
+    expect(last_response.body).not_to include('minerals/template')
+  end
+end
+
+describe "Pagination with proxied resources and ignored proxy index", :feature do
+  it "produces pages for a set of resources" do
+    run_site 'mine' do
+      %w{ Feldspar Olivine Quartz }.each do |mineral|
+        proxy "/minerals/#{mineral.downcase}.html", '/minerals/template.html', locals: { mineral: mineral }, ignore: true
+      end
+
+      proxy '/alternative/index.html', '/index.html', ignore: true
+
+      activate :pagination do
+        pageable :minerals do |resource|
+          resource.path.start_with?('mineral')
+        end
+      end
+    end
+
+    get '/'
+    expect(last_response.status).to eql(404)
+
+    get '/pages/2.html'
+    expect(last_response.status).to eql(404)
+
+    visit '/alternative/'
+    find_on_page 'Feldspar'
+    find_on_page 'Olivine'
+    find_on_page 'First page: /alternative/'
+    find_on_page 'Prev page: none'
+    find_on_page 'Last page: /alternative/pages/2.html'
+    find_on_page 'Next page: /alternative/pages/2.html'
+
+    visit '/alternative/pages/2.html'
+    find_on_page 'Quartz'
+    find_on_page 'Prev page: /alternative/'
+    find_on_page 'Next page: none'
+  end
+end
+
+describe "Pagination with proxied resources and two indexes (one proxied)", :feature do
+  it "produces pages for a set of resources" do
+    run_site 'mine' do
+      %w{ Feldspar Olivine Quartz }.each do |mineral|
+        proxy "/minerals/#{mineral.downcase}.html", '/minerals/template.html', locals: { mineral: mineral }, ignore: true
+      end
+
+      proxy '/alternative/index.html', '/index.html'
+
+      activate :pagination do
+        pageable :minerals do |resource|
+          resource.path.start_with?('mineral')
+        end
+      end
+    end
+
+    visit '/'
+    find_on_page 'Feldspar'
+    find_on_page 'Olivine'
+    find_on_page 'First page: /'
+    find_on_page 'Prev page: none'
+    find_on_page 'Last page: /pages/2.html'
+    find_on_page 'Next page: /pages/2.html'
+
+    visit '/pages/2.html'
+    find_on_page 'Quartz'
+    find_on_page 'Prev page: /'
+    find_on_page 'Next page: none'
+
+    visit '/alternative/'
+    find_on_page 'Feldspar'
+    find_on_page 'Olivine'
+    find_on_page 'First page: /alternative/'
+    find_on_page 'Prev page: none'
+    find_on_page 'Last page: /alternative/pages/2.html'
+    find_on_page 'Next page: /alternative/pages/2.html'
+
+    visit '/alternative/pages/2.html'
+    find_on_page 'Quartz'
+    find_on_page 'Prev page: /alternative/'
+    find_on_page 'Next page: none'
+  end
 end

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

@@ -0,0 +1,21 @@
+---
+pagination:
+  for: minerals
+  per_page: 2
+---
+
+<% pagination.each do |page| %>
+- <%= page.metadata[:locals][:mineral] %> (<%= page.url %>)
+<% 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/mine/source/minerals/template.html.erb

@@ -0,0 +1 @@
+Mineral: <%= mineral %>

data/spec/middleman/pagination/manipulated_resources_spec.rb

@@ -29,7 +29,7 @@ module Middleman::Pagination
 
         let(:pagination_index) {
           pagination_data = double(for: 'recipes', per_page: 2)
-          resource = double(:resource, path: 'index.html', is_recipe?: false).as_null_object
+          resource = double(:resource, path: 'index.html', is_recipe?: false, ignored?: false).as_null_object
           resource.stub_chain(:data, pagination: pagination_data)
           resource
         }
@@ -37,7 +37,7 @@ module Middleman::Pagination
         let(:resource_list) {
           [pagination_index] +
           7.times.map do |n|
-            double(:resource, path: "recipe-#{n}.html", is_recipe?: true).as_null_object
+            double(:resource, path: "recipe-#{n}.html", is_recipe?: true, ignored?: false).as_null_object
           end
         }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-pagination
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Pete Nicholls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-28 00:00:00.000000000 Z
+date: 2013-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -119,6 +119,8 @@ files:
 - lib/middleman_extension.rb
 - middleman-pagination.gemspec
 - 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/index.html.erb
 - spec/fixtures/recipes/source/layouts/layout.erb
@@ -160,6 +162,8 @@ specification_version: 4
 summary: Pagination for Middleman pages.
 test_files:
 - 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/index.html.erb
 - spec/fixtures/recipes/source/layouts/layout.erb