will_paginate_semantic_ui 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0490b858bd58ac6cd222124bcce8af03985b216f
+  data.tar.gz: 1cb249aaccb321b430404854b5fa1c36bd5a9cc7
+SHA512:
+  metadata.gz: c7d3b67fb236fc7e616e3965e355a71d825bd6fddfce511399fec97c2c719244616768e7ffacf77d2c5507f44c65bfea34a5cce75a278bbde9c72622bc919d33
+  data.tar.gz: 35d24caa054d9c792cb7f0d9aa0fe8b9abfeca3f2edcf9ae474cd6ea96e5504b3daf2396625168f8d73b35b3521c52fd6529f2d46f29991efb15f1805bd4337e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.coveralls.yml
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+will_paginate_semantic_ui

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+  - Release first version with Rails support.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    will_paginate_semantic_ui (1.0.0)
+      will_paginate (> 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.0.5)
+    coveralls (0.8.14)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (2.0.1)
+    mini_portile2 (2.1.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    pkg-config (1.1.7)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.1)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.6.0)
+    will_paginate (3.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  byebug
+  coveralls
+  nokogiri
+  rake
+  rspec
+  will_paginate_semantic_ui!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Rafael Biriba
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Will Paginate for Semantic UI
+
+[![Gem Version](https://badge.fury.io/rb/will_paginate_semantic_ui.svg)](http://badge.fury.io/rb/will_paginate_semantic_ui) [![Travis](https://api.travis-ci.org/rafaelbiriba/will_paginate_semantic_ui.svg?branch=master)](https://travis-ci.org/rafaelbiriba/will_paginate_semantic_ui) [![Coverage Status](https://coveralls.io/repos/rafaelbiriba/will_paginate_semantic_ui/badge.svg?branch=master)](https://coveralls.io/r/rafaelbiriba/will_paginate_semantic_ui?branch=master)
+
+#### If you are using [Will Paginate gem](https://github.com/mislav/will_paginate) and [Semantic UI framework](http://semantic-ui.com/), this gem is WHAT YOU NEED!
+
+The html snippet for pagination that `will_paginate` creates is incompatible with the semantic ui.
+
+This gem solves this problem with a custom render that creates the correct pagination html for the component.
+
+![Example](https://raw.githubusercontent.com/rafaelbiriba/will_paginate_semantic_ui/master/docs/example1.png)
+![Example](https://raw.githubusercontent.com/rafaelbiriba/will_paginate_semantic_ui/master/docs/example2.png)
+
+## Requirements
+
+Semantic UI `> 2.0` and will_paginate `> 3.0`
+
+## Installation
+
+As easy as `gem install will_paginate_semantic_ui` or add `gem "will_paginate_semantic_ui"` to your Gemfile
+
+## How to use
+
+### Rails
+
+You need to use another render in the will paginate command:
+
+`<%= will_paginate @collection, renderer: WillPaginateSemanticUi::Renderer %>`
+
+## Tuning
+
+You can also use some will_pagination options to customize your component:
+
+`<%= will_paginate @collection, renderer: WillPaginateSemanticUi::Renderer, class: "right floated", inner_window: 3 %>
+`
+
+The command above create this
+
+![Example](https://raw.githubusercontent.com/rafaelbiriba/will_paginate_semantic_ui/master/docs/example1.png)
+
+`inner_window: 3` as you see above, 3 pages to the left and to the right from the selected page. (This creates a component with 700px max width in the worst case)
+
+![Example](https://raw.githubusercontent.com/rafaelbiriba/will_paginate_semantic_ui/master/docs/example3.png)
+
+`class: "right floated"` useful if you are using inside a table. Floats the pagination to the right.

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+namespace :spec do
+  desc "Run Rspec test pushing Coverage results"
+  task :coveralls do
+    system "coveralls push"
+  end
+end
+
+task :default => :spec
+task :test => :spec

data/lib/will_paginate_semantic_ui.rb

@@ -0,0 +1,6 @@
+require "will_paginate_semantic_ui/version"
+require "will_paginate"
+
+if defined?(ActionView)
+  require "will_paginate_semantic_ui/rails"
+end

data/lib/will_paginate_semantic_ui/generic_renderer.rb

@@ -0,0 +1,45 @@
+module WillPaginateSemanticUi
+  module GenericRenderer
+    GAP = "…"
+
+    def to_html
+      list_items = pagination.map do |item|
+        item.class == Fixnum ? page_number(item) : send(item)
+      end.join(@options[:link_separator])
+
+      tag("div", list_items, class: ul_class)
+    end
+
+    protected
+
+    def page_number(page)
+      classLink = "item"
+      classLink += " active" if page == current_page
+      link(page, page, {class: classLink})
+    end
+
+    def previous_or_next_page(page, classname)
+      classLink = "icon item"
+      classLink += " disabled" if !page
+      link(tag("i", "", class: "#{classname} chevron icon"), page, {class: classLink})
+    end
+
+    def gap
+      tag("div", GAP, class: "disabled item")
+    end
+
+    def previous_page
+      num = @collection.current_page > 1 && @collection.current_page - 1
+      previous_or_next_page(num, "left")
+    end
+
+    def next_page
+      num = @collection.current_page < @collection.total_pages && @collection.current_page + 1
+      previous_or_next_page(num, "right")
+    end
+
+    def ul_class
+      ["pagination ui menu", @options[:class]].compact.join(" ")
+    end
+  end
+end

data/lib/will_paginate_semantic_ui/rails.rb

@@ -0,0 +1,8 @@
+require "will_paginate/view_helpers/action_view"
+require "will_paginate_semantic_ui/generic_renderer"
+
+module WillPaginateSemanticUi
+  class Renderer < WillPaginate::ActionView::LinkRenderer
+    include WillPaginateSemanticUi::GenericRenderer
+  end
+end

data/lib/will_paginate_semantic_ui/version.rb

@@ -0,0 +1,3 @@
+module WillPaginateSemanticUi
+  VERSION = "1.0.0"
+end

data/spec/lib/will_paginate_semantic_ui/generic_renderer_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+require 'nokogiri'
+require 'will_paginate/array'
+
+include WillPaginate::ViewHelpers
+
+describe WillPaginateSemanticUi::GenericRenderer do
+  let(:collection_size) { 15 }
+  let(:page) { (collection_size / 2.0).to_i }
+  let(:collection) { 1.upto(collection_size).to_a }
+  let(:class_opt) { nil }
+  let(:output) do
+    will_paginate(collection.paginate(:page => page, :per_page => 1), renderer: FakeRenderer, class: class_opt)
+  end
+
+  let(:html) { Nokogiri::HTML.fragment(output) }
+
+  it "returns a string" do
+    expect(output).to be_kind_of String
+  end
+
+  it "returns a string containing HTML" do
+    expect(html).to be_kind_of Nokogiri::HTML::DocumentFragment
+  end
+
+  it "has an active list item" do
+    expect(html.at_css('div a.active.item')).not_to be_nil
+  end
+
+  it "has a gap item with class disabled" do
+    expect(html.at_css('div.disabled.item')).not_to be_nil
+  end
+
+  it "has one item with rel start value" do
+    expect(html.css('[rel~=start]').size).to eql 1
+  end
+
+  it "has two items with rel prev value" do
+    expect(html.css('[rel~=prev]').size).to eql 2
+  end
+
+  it "has two items with rel next value" do
+    expect(html.css('[rel~=next]').size).to eql 2
+  end
+
+  it "has an anchor within each non-active/non-disabled list item" do
+    html.css('div a:not(.active):not(.disabled)').each { |a| expect(a).not_to be_nil }
+  end
+
+  it 'has a ellipsis in the gap' do
+    ellipsis = FakeRenderer::GAP
+    expect(html.at_css('div.disabled', text: ellipsis)).not_to be_nil
+  end
+
+  describe 'when on the first page' do
+    let(:page) { 1 }
+
+    it 'uses a i element for the (disabled) previous button' do
+      expect(html.at_css('a.disabled i.left')).not_to be_nil
+    end
+  end
+
+  describe 'when on the last page' do
+    let(:page) { collection_size }
+
+    it 'uses a i element for the (disabled) next button' do
+      expect(html.at_css('a.disabled i.right')).not_to be_nil
+    end
+  end
+
+  it "has a div with pagination class" do
+    expect(html.at_css('div.pagination.ui.menu')).not_to be_nil
+  end
+
+  describe "when specifying a custom class" do
+    let(:class_opt) { "pagination-lg" }
+
+    it "applies the class to the ul" do
+      expect(html.at_css("div.pagination.ui.menu.pagination-lg")).not_to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+require "rake"
+require "byebug"
+require "will_paginate_semantic_ui"
+require 'coveralls'
+Coveralls.wear!
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+
+Dir["./spec/support/**/*.rb"].each { |f| require f }

data/spec/support/fake_renderer.rb

@@ -0,0 +1,10 @@
+require 'will_paginate/view_helpers/link_renderer'
+require 'will_paginate_semantic_ui/generic_renderer'
+
+class FakeRenderer < WillPaginate::ViewHelpers::LinkRenderer
+  include WillPaginateSemanticUi::GenericRenderer
+
+  def url(args)
+    ""
+  end
+end

data/will_paginate_semantic_ui.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'will_paginate_semantic_ui/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "will_paginate_semantic_ui"
+  spec.version       = WillPaginateSemanticUi::VERSION
+  spec.authors       = ["Rafael Biriba"]
+  spec.email         = ["biribarj@gmail.com"]
+  spec.description   = "Integrates the Semantic UI pagination component with will_paginate"
+  spec.summary       = "Integrates the Semantic UI pagination component with will_paginate"
+  spec.homepage      = "https://github.com/rafaelbiriba/will_paginate_semantic_ui"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/).reject{ |f| f =~ /docs/  }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "will_paginate", "> 3.0.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "coveralls"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: will_paginate_semantic_ui
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rafael Biriba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Integrates the Semantic UI pagination component with will_paginate
+email:
+- biribarj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/will_paginate_semantic_ui.rb
+- lib/will_paginate_semantic_ui/generic_renderer.rb
+- lib/will_paginate_semantic_ui/rails.rb
+- lib/will_paginate_semantic_ui/version.rb
+- spec/lib/will_paginate_semantic_ui/generic_renderer_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_renderer.rb
+- will_paginate_semantic_ui.gemspec
+homepage: https://github.com/rafaelbiriba/will_paginate_semantic_ui
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Integrates the Semantic UI pagination component with will_paginate
+test_files:
+- spec/lib/will_paginate_semantic_ui/generic_renderer_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_renderer.rb