middleman-paginator 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 519980611123aa1088aa0fe2e937cc28ebfc3fa3
+  data.tar.gz: 240ee374dc4fc0d09c79b39ff016a62a84bf464d
+SHA512:
+  metadata.gz: 2707fdb78fd6a427906155118b2c42a7adca261a08da896c62cd5d447c748f9729d4cbb7e21840bbfe592a9fb72a0d48263885906a3f532e76a3615824590616
+  data.tar.gz: 67264f0e7f2c6607043ff7f7691ec1f3ada314102ca5d8481ef63aad854427ae473a591b6a893c0ce9c35741780b22164bbfc5d11b7b13d34fbedb5c758c4c47

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,61 @@
+# Middleman Paginator
+A simple plugin that allows paginating any collection of objects
+
+## Instalation
+
+Add this to your Gemfile
+
+```
+gem 'middleman-paginator'
+```
+
+## Use
+
+### Activate gem in `config.rb`
+
+```ruby
+  activate :paginator do |e|
+    e.per_page = 25 # Default 20
+  end
+```
+
+### Paginate
+
+`destination` - Path to put pages in. Expects `/` in the end.
+Produced pages will have following path `#{destination}pages/index.html`, `#{destination}pages/2.html`
+
+`template` - Path to the template.
+If you don't want to render template by itself pass `ignore: true` to extra arguments.
+
+`objects` - Objects to paginate. You will have access to them inside the template as `objects`.
+
+`locals` -  If you have need any other variables inside the template, pass them allong as you normally would.
+
+`ignore` - See `template` option description.
+
+```ruby
+paginate(
+  destination: '/',
+  template: 'template.html',
+  objects: objects,
+  locals: { },
+  ignore: true
+)
+```
+
+### Access from template
+
+Inside `template`, iterate over `per_page` number of `objects`
+
+```haml
+  - objects.each do |object|
+    // render object 
+
+  = previous_page_link
+  = next_page_link
+
+```
+
+### Helpers
+
+Paginator provides to helper methods: `previous_page_link`, `next_page_link`. They supposed to just work.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-paginator)

data/lib/middleman-paginator.rb

@@ -0,0 +1,7 @@
+require "middleman-core"
+
+Middleman::Extensions.register :paginator do
+  require "middleman/paginator"
+
+  Paginator
+end

data/lib/middleman/paginator.rb

@@ -0,0 +1,65 @@
+require 'middleman-core'
+
+class Paginator < ::Middleman::ConfigExtension
+   self.resource_list_manipulator_priority = 0
+
+  expose_to_config :paginate
+
+  option :per_page, 20, 'Controls pagination'
+
+  CollectionProxyDescriptor = Struct.new(:descriptors) do
+    def execute_descriptor(app, resources)
+      descriptors.reduce(resources) do |resources, descriptor|
+        if descriptor.metadata[:ignore]
+          d = ::Middleman::Sitemap::Extensions::Ignores::StringIgnoreDescriptor.new(descriptor.target)
+          d.execute_descriptor(app, resources)
+        end
+
+        descriptor.execute_descriptor(app, resources)
+      end
+    end
+  end
+
+  def paginate(destination:, objects:, template:, **page_options)
+    descriptors = []
+
+    objects.each_slice(options.per_page).with_index(1).reverse_each do |o, i|
+      paginate_options = { locals: { objects: o, page: i, destination: destination } }
+      path = i == 1 ? 'index.html' : "pages/#{i}.html"
+
+      descriptor = Middleman::Sitemap::Extensions::ProxyDescriptor.new(
+        ::Middleman::Util.normalize_path("#{destination}#{path}"),
+        ::Middleman::Util.normalize_path(template),
+        page_options.merge(paginate_options) { |key, v1, v2| v1.merge v2 }
+      )
+
+      descriptors << descriptor
+    end
+
+    CollectionProxyDescriptor.new(descriptors)
+  end
+
+  helpers do
+    def previous_page_link
+      page = @locs[:page]
+      return if page == 1
+
+      path = if page == 2
+        "#{@locs[:destination]}index.html"
+      else
+        "#{@locs[:destination]}pages/#{page - 1}.html"
+      end
+
+      link_to 'Previous', path, class: 'page-link'
+    end
+
+    def next_page_link
+      page = @locs[:page]
+      path = "#{@locs[:destination]}pages/#{page + 1}.html"
+      return unless sitemap.find_resource_by_path(path)
+
+      link_to 'Next', path, class: 'page-link'
+    end
+  end
+end
+

data/middleman-paginate_collection.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-paginator"
+  s.version     = "0.0.3"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["TheSmartnik"]
+  s.email       = ["misharinn@gmail.com"]
+  s.homepage    = "https://github.com/TheSmartnik/middleman-paginator"
+  s.summary     = %q{A simple plugin to allow pagination in middleman}
+  s.description = %q{A simple way to paginate any collection in middleman }
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency("middleman-core", [">= 4.2.1"])
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: middleman-paginator
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- TheSmartnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+description: 'A simple way to paginate any collection in middleman '
+email:
+- misharinn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-paginator.rb
+- lib/middleman/paginator.rb
+- middleman-paginate_collection.gemspec
+homepage: https://github.com/TheSmartnik/middleman-paginator
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A simple plugin to allow pagination in middleman
+test_files:
+- features/support/env.rb