middleman-pagination 1.0.8.beta1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b831157223541650867242a75896caca0f81903d
-  data.tar.gz: 0564a1276c93a5df3c9d0184ebc66f6fc7985f99
+  metadata.gz: 4a2f30b43ccef991c6a62a958834e01be01e087c
+  data.tar.gz: 0885570cd76963b8332b4c86d420931dda5670c3
 SHA512:
-  metadata.gz: d0983b61e7e671b5d684552c863bdca87826848dc52885ee0e5366163dbbb52ff0f40b28008400b0ecbdb03f1a4e09f64636835b2faf0fc0e82724d5abd85be1
-  data.tar.gz: 2ba41a1bea041d3affb87ffdd518d3838468b00209b3be23d2560610b42fad075af7db610b2bffad1a182d6deca8d089b5afe416c246c740fee986cf97476dc1
+  metadata.gz: f4c4dceda27114398941c2d49a6de4f1c5ae47a210aca794cb2caceebdb2782349fc081e5fff9ddc381a48172609850011a044b2da64d50d0135c3e13638462d
+  data.tar.gz: 55f9fc280beee965abd73c181d08ae1cbbf4333d0dde4a12159a9adc458b00f97128c467ccba7828daa413381cc3f03abb4ba22454647e61bf22b295e39d3654

data/README.md

@@ -39,7 +39,7 @@ Inside your `config.rb`:
 
 ```ruby
 activate :pagination do
-  pageable :recipes do |page|
+  pageable_resource :recipes do |page|
     # Match any page that lives in the "recipes" directory
     page.path.start_with?('recipes/')
   end
@@ -80,12 +80,12 @@ You can define as many different types of pageable resources as you like, with w
 
 ```ruby
 activate :pagination do
-  pageable :staff do |page|
+  pageable_resource :staff do |page|
     # Match any page whose URL includes "/staff/"
     page.url.include?('/staff/')
   end
 
-  pageable :news do |page|
+  pageable_resource :news do |page|
     # Match any page that has a "news" property in its frontmatter
     page.data.news.present?
   end
@@ -108,11 +108,55 @@ pagination:
 
 Your pages would be created at `all-recipes/p/1.html`, `all-recipes/p/2.html`, etc.
 
-## Paginate anything
+## Paginate data
+
+You aren't limited to just pages. You can paginate over [Middleman Local Data](http://middlemanapp.com/advanced/local-data/), too.
+
+Let's say you had a file called `roman_gods.yml` in your `data` directory:
+
+```
+- name: Jupiter
+  title: King of the Gods
+- name: Juno
+  title: Queen of the Gods
+- name: Neptune
+  title: God of the Sea
+- name: Pluto
+  title: God of Death
+
+...snip...
+```
 
-*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 produce pagination by using `pageable_set`:
 
-You can paginate any collection of objects that responds to `each`, by using `pageable_set`:
+
+```ruby
+activate :pagination do
+  pageable_set :gods do
+    data.roman_gods
+  end
+end
+```
+
+In your template:
+
+```erb
+---
+pagination:
+  for: gods
+  per_page: 10
+---
+
+<% pagination.each do |god| %>
+  - <%= god.name %> (<%= god.title %>)
+<% end %>
+
+<%= link_to "Next page", pagination.next_page.url if pagination.next_page %>
+```
+
+## Paginate anything
+
+In fact, you can paginate any collection of objects that responds to `each`, by using `pageable_set`:
 
 ```ruby
 activate :pagination do
@@ -124,7 +168,7 @@ end
 
 The set can be used in exactly the same way:
 
-```
+```erb
 ---
 pagination:
   for: planets
@@ -137,7 +181,7 @@ Planets (showing <%= pagination.per_page %> per page):
   - <%= planet %>
 <% end %>
 
-Next page: <%= pagination.next_page.url %>
+<%= link_to "Next page", pagination.next_page.url if pagination.next_page %>
 ```
 
 ## Getting help
@@ -146,13 +190,11 @@ Bug? Feature request? You can [open an issue](https://github.com/Aupajo/middlema
 
 ## 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)
 * Pagination link generator (e.g. `Pages: 1 2 [3] ... 7 8 9`)
-* Adopt Middleman's Queryable interface
+* Adopt Middleman's Queryable interface (potentially requires changes to Middleman first)
 
 ## Contributing
 

data/lib/middleman/pagination/configuration.rb

@@ -8,11 +8,21 @@ module Middleman
       end
 
       def pageable(name, &block)
-        @pageable[name] = Pageable.new(name, resource_filter: block)
+        warn "`pageable` is deprecated, use `pageable_resource` instead"
+        pageable_resource(name, &block)
+      end
+
+      def pageable_resource(name, &block)
+        @pageable[name] = Pageable.new(name) do
+          resources.select do |resource|
+            next if resource.ignored?
+            block.call(resource)
+          end.sort_by(&:path)
+        end
       end
 
       def pageable_set(name, &block)
-        @pageable[name] = Pageable.new(name, set: block)
+        @pageable[name] = Pageable.new(name, &block)
       end
 
       def each(&block)
@@ -20,6 +30,7 @@ module Middleman
           yield pageable_obj
         end
       end
+
     end
   end
 end

data/lib/middleman/pagination/extension_context.rb

@@ -3,7 +3,7 @@ module Middleman
     class ExtensionContext
       extend Forwardable
       
-      def_delegators :app, :sitemap, :index_file
+      def_delegators :app, :sitemap, :index_file, :data
 
       def initialize(extension)
         @extension = extension

data/lib/middleman/pagination/index_page.rb

@@ -2,10 +2,10 @@ module Middleman
   module Pagination
     class IndexPage
 
-      attr_reader :context, :first_index, :pageable_context, :page_num, :symbolic_replacement_path
+      attr_reader :extension_context, :first_index, :pageable_context, :page_num, :symbolic_replacement_path
 
-      def initialize(context, first_index, pageable_context, page_num, symbolic_replacement_path)
-        @context = context
+      def initialize(extension_context, first_index, pageable_context, page_num, symbolic_replacement_path)
+        @extension_context = extension_context
         @first_index = first_index
         @pageable_context = pageable_context
         @page_num = page_num
@@ -25,11 +25,11 @@ module Middleman
       end
 
       def sitemap
-        context.sitemap
+        extension_context.sitemap
       end
 
       def path
-        IndexPath.new(context, first_index.path, page_num, symbolic_replacement_path).to_s
+        IndexPath.new(extension_context, first_index.path, page_num, symbolic_replacement_path).to_s
       end
 
       def metadata

data/lib/middleman/pagination/index_path.rb

@@ -1,10 +1,10 @@
 module Middleman
   module Pagination
     class IndexPath
-      attr_accessor :context, :original_path, :page_num, :symbolic_path_replacement
+      attr_accessor :extension_context, :original_path, :page_num, :symbolic_path_replacement
 
-      def initialize(context, original_path, page_num, symbolic_path_replacement = nil)
-        @context = context
+      def initialize(extension_context, original_path, page_num, symbolic_path_replacement = nil)
+        @extension_context = extension_context
         @original_path = original_path
         @symbolic_path_replacement = symbolic_path_replacement || 'pages/:num'
 
@@ -38,8 +38,8 @@ module Middleman
       end
 
       def index_file_pattern
-        index_file_ext = File.extname(context.index_file)
-        index_file_path = context.index_file.delete(index_file_ext)
+        index_file_ext = File.extname(extension_context.index_file)
+        index_file_path = extension_context.index_file.delete(index_file_ext)
 
         %r{
           (/)?                                # An optional slash

data/lib/middleman/pagination/pageable.rb

@@ -2,28 +2,23 @@ module Middleman
   module Pagination
     class Pageable
 
-      attr_reader :name, :resource_filter
+      attr_reader :name
 
-      def initialize(name, options = {})
+      def initialize(name, &block)
         @name = name
-        @resource_filter = options[:resource_filter]
-        @set = options[:set]
+        @set = block
       end
 
-      def new_resources(context, resources)
+      def new_resources(extension_context, resources)
         pagination_indexes(resources).map do |resource|
-          new_pages_for_index(context, resource, resources)
+          new_pages_for_index(extension_context, resource, resources)
         end.compact
       end
 
       private
 
-      def set(resources)
-        if @set
-          @set.call
-        else
-          set_from_resource_filter(resources)
-        end
+      def set(extension_context, resources)
+        OpenStruct.new(resources: resources, data: extension_context.data).instance_eval(&@set)
       end
 
       def pagination_indexes(resources)
@@ -36,19 +31,19 @@ module Middleman
         end
       end
 
-      def new_pages_for_index(context, index, resources)
+      def new_pages_for_index(extension_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),
+          set: set(extension_context, 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,
+          new_index = IndexPage.new(extension_context,
                                     index,
                                     pageable_context,
                                     page_num,
@@ -73,13 +68,6 @@ module Middleman
         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/version.rb

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

data/spec/features/custom_path_feature_spec.rb

@@ -4,7 +4,7 @@ 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|
+        pageable_resource :recipes do |resource|
           resource.path.start_with?('recipes')
         end
       end

data/spec/features/paginate_any_data_feature_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-describe "Pagination with data", :feature do
-  it "produces pages for a set of resources with a custom path" do
+describe "Pagination with a set", :feature do
+  it "produces pages for an array" do
     run_site 'pantheon' do
       activate :pagination do
         pageable_set :gods do
@@ -28,4 +28,24 @@ describe "Pagination with data", :feature do
     find_on_page 'Poseidon'
     find_on_page 'Hermes'
   end
+end
+
+describe "Pagination with Middleman data", :feature do
+  it "produces pages from given data" do
+    run_site 'pantheon' do
+      activate :pagination do
+        pageable_set :gods do
+          data.roman_gods
+        end
+      end
+    end
+
+    visit '/'
+    find_on_page 'Jupiter'
+    find_on_page 'King of the Gods'
+
+    visit '/pages/6.html'
+    find_on_page 'Plutus'
+    find_on_page 'God of Wealth'
+  end
 end

data/spec/features/pagination_feature_spec.rb

@@ -10,7 +10,7 @@ describe "Simple pagination", :feature do
   it "produces pages for a set of resources" do
     run_site 'recipes' do
       activate :pagination do
-        pageable :recipes do |resource|
+        pageable_resource :recipes do |resource|
           resource.path.start_with?('recipes')
         end
       end
@@ -53,7 +53,7 @@ describe "Pagination with directory indexes", :feature do
   it "produces pages for a set of resources" do
     run_site 'recipes' do
       activate :pagination do
-        pageable :recipes do |resource|
+        pageable_resource :recipes do |resource|
           resource.path.start_with?('recipes')
         end
       end
@@ -85,7 +85,7 @@ 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|
+        pageable_resource :recipes do |resource|
           resource.path.start_with?('recipes')
         end
       end
@@ -111,7 +111,7 @@ describe "Pagination with proxied resources and ignored proxy resource template"
       end
 
       activate :pagination do
-        pageable :minerals do |resource|
+        pageable_resource :minerals do |resource|
           resource.path.start_with?('mineral')
         end
       end
@@ -143,7 +143,7 @@ describe "Pagination with proxied resources and ignored proxy index", :feature d
       proxy '/alternative/index.html', '/index.html', ignore: true
 
       activate :pagination do
-        pageable :minerals do |resource|
+        pageable_resource :minerals do |resource|
           resource.path.start_with?('mineral')
         end
       end
@@ -180,7 +180,7 @@ describe "Pagination with proxied resources and two indexes (one proxied)", :fea
       proxy '/alternative/index.html', '/index.html'
 
       activate :pagination do
-        pageable :minerals do |resource|
+        pageable_resource :minerals do |resource|
           resource.path.start_with?('mineral')
         end
       end

data/spec/fixtures/pantheon/data/roman_gods.yml

@@ -0,0 +1,44 @@
+- name: Jupiter
+  title: King of the Gods
+- name: Juno
+  title: Queen of the Gods
+- name: Neptune
+  title: God of the Sea
+- name: Pluto
+  title: God of Death
+- name: Apollo
+  title: God of the Sun
+- name: Diana
+  title: Goddess of the Moon
+- name: Mars
+  title: God of War
+- name: Venus
+  title: Goddess of Love
+- name: Cupid
+  title: God of Love
+- name: Mercury
+  title: Messenger of the Gods
+- name: Minerva
+  title: Goddess of Wisdom
+- name: Ceres
+  title: The Earth Goddess
+- name: Proserpine
+  title: Goddess of the Underworld
+- name: Vulcan
+  title: The Smith God
+- name: Bacchus
+  title: God of Wine
+- name: Saturn
+  title: God of Time
+- name: Vesta
+  title: Goddess of the Home
+- name: Janus
+  title: God of Doors
+- name: Uranus and Gaia
+  title: Parents of Saturn
+- name: Maia
+  title: Goddess of Growth
+- name: Flora
+  title: Goddess of Flowers
+- name: Plutus
+  title: God of Wealth

data/spec/middleman/pagination/configuration_spec.rb

@@ -5,7 +5,7 @@ describe Middleman::Pagination::Configuration do
     it "accepts a name and a block" do
       config = described_class.new
       expect {
-        config.pageable(:key) { }
+        config.pageable_resource(:key) { }
       }.not_to raise_error
     end
   end
@@ -14,33 +14,15 @@ describe Middleman::Pagination::Configuration do
     it "yields each pageable object" do
       config = described_class.new
       block = lambda {}
-      config.pageable(:recipes, &block)
+      config.pageable_resource(:recipes)
 
       collected = []
       
       config.each do |pageable|
-        collected << [pageable.name, pageable.resource_filter]
+        collected << pageable.name
       end
 
-      expect(collected).to eql([[:recipes, block]])
-    end
-  end
-
-  context "with instance_eval" do
-    it "acts appropriately" do
-      config = described_class.new
-
-      config.instance_eval do
-        pageable(:recipes) { :ok }
-      end
-
-      result = nil
-      
-      config.each do |pageable|
-        result = pageable.resource_filter.call
-      end
-
-      expect(result).to be(:ok)
+      expect(collected).to eql([:recipes])
     end
   end
 end

data/spec/middleman/pagination/extension_context_spec.rb

@@ -35,6 +35,11 @@ describe Middleman::Pagination::ExtensionContext do
     it_should_behave_like "a method delegated to the app"
   end
 
+  describe "#sitemap" do
+    let(:method_name) { :data }
+    it_should_behave_like "a method delegated to the app"
+  end
+
   describe "#index_file" do
     let(:method_name) { :index_file }
     it_should_behave_like "a method delegated to the app"

data/spec/middleman/pagination/manipulated_resources_spec.rb

@@ -23,7 +23,7 @@ module Middleman::Pagination
       context "with a pageable configuration and an pagination index" do
         let(:configuration) {
           config = Configuration.new
-          config.pageable(:recipes, &:is_recipe?)
+          config.pageable_resource(:recipes, &:is_recipe?)
           config
         }
 

data/spec/support/middleman_server_helpers.rb

@@ -9,7 +9,9 @@ module MiddlemanServerHelpers
   end
 
   def visit(path)
-    expect(get(path).status).to eql(200)
+    get(path)
+    expect(last_response.status).to eql(200),
+      "Expected 200 response, got #{last_response.status}: #{last_response.body}"
   end
 
   def find_on_page(string)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-pagination
 version: !ruby/object:Gem::Version
-  version: 1.0.8.beta1
+  version: 1.1.0
 platform: ruby
 authors:
 - Pete Nicholls
@@ -126,6 +126,7 @@ files:
 - spec/features/pagination_feature_spec.rb
 - spec/fixtures/mine/source/index.html.erb
 - spec/fixtures/mine/source/minerals/template.html.erb
+- spec/fixtures/pantheon/data/roman_gods.yml
 - spec/fixtures/pantheon/source/index.html.erb
 - spec/fixtures/pantheon/source/layouts/layout.erb
 - spec/fixtures/recipes/source/all-recipes.html.erb
@@ -160,9 +161,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3
@@ -175,6 +176,7 @@ 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/pantheon/data/roman_gods.yml
 - spec/fixtures/pantheon/source/index.html.erb
 - spec/fixtures/pantheon/source/layouts/layout.erb
 - spec/fixtures/recipes/source/all-recipes.html.erb