redefined the "Out Of Range" concept as "Overflow" (#103):

- files: out_of_range* > overflow* - extra name: out_of_range > overflow - error class: OutOfRangeError > OverflowError - module: OutOfRange > Overflow - VARS: :out_of_range_mode > :overflow - instance variable: @out_of_range > @overflow - method: out_of_range? > overflow?
ddnexus · Nov 13, 2018 · 431e4db · 431e4db
1 parent a0b411a
commit 431e4db
Show file tree

Hide file tree

Showing 12 changed files with 149 additions and 149 deletions.
diff --git a/README.md b/README.md
@@ -58,7 +58,7 @@ Please check the [Benchmarks and Memory Profiles Source](http://github.com/ddnex
 - Pagy is very modular and does not load nor execute unnecessary code in your app _(see [why...](https://ddnexus.github.io/pagy/how-to#global-configuration))_
 - It works with collections/scopes that already used `limit` and `offset` _(see [how...](https://ddnexus.github.io/pagy/how-to#paginate-a-pre-offsetted-and-pre-limited-collection))_
 - It works with helpers or templates _(see [more...](https://ddnexus.github.io/pagy/how-to#using-templates))_
-- It raises real `Pagy::OutOfRangeError` exceptions that you can rescue from _(see [how...](https://ddnexus.github.io/pagy/how-to#handling-pagyoutofrangeerror-exception))_ or use the [out_of_range extra](http://ddnexus.github.io/pagy/extras/out_of_range) for a few ready to use common behaviors
+- It raises real `Pagy::OverflowError` exceptions that you can rescue from _(see [how...](https://ddnexus.github.io/pagy/how-to#handling-pagyoutofrangeerror-exception))_ or use the [overflow extra](http://ddnexus.github.io/pagy/extras/overflow) for a few ready to use common behaviors
 - It does not impose any difficult-to-override logic or output _(see [why...](https://ddnexus.github.io/pagy/index#really-easy-to-customize))_
 
 ### Easy to use
@@ -108,7 +108,7 @@ Use the official extras, or write your own in just a few lines. Extras add speci
 
 - [i18n](http://ddnexus.github.io/pagy/extras/i18n): Use the `I18n` gem instead of the pagy implementation
 - [items](http://ddnexus.github.io/pagy/extras/items): Allow the client to request a custom number of items per page with an optional selector UI
-- [out_of_range](http://ddnexus.github.io/pagy/extras/out_of_range): Allow for easy handling of out of range pages
+- [overflow](http://ddnexus.github.io/pagy/extras/overflow): Allow for easy handling of overflowing pages
 - [trim](http://ddnexus.github.io/pagy/extras/trim): Remove the `page=1` param from the first page link
 
 ### Alternative components

diff --git a/Rakefile b/Rakefile
@@ -10,7 +10,7 @@ require "rubocop/rake_task"
 Rake::TestTask.new(:test_common) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList.new.include("test/**/*_test.rb").exclude('test/**/i18n_test.rb', 'test/**/items_test.rb', 'test/**/out_of_range_test.rb', 'test/**/trim_test.rb')
+  t.test_files = FileList.new.include("test/**/*_test.rb").exclude('test/**/i18n_test.rb', 'test/**/items_test.rb', 'test/**/overflow_test.rb', 'test/**/trim_test.rb')
 end
 
 Rake::TestTask.new(:test_extra_i18n) do |t|
@@ -25,10 +25,10 @@ Rake::TestTask.new(:test_extra_items) do |t|
   t.test_files = FileList['test/**/items_test.rb']
 end
 
-Rake::TestTask.new(:test_extra_out_of_range) do |t|
+Rake::TestTask.new(:test_extra_overflow) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/out_of_range_test.rb']
+  t.test_files = FileList['test/**/overflow_test.rb']
 end
 
 Rake::TestTask.new(:test_extra_trim) do |t|
@@ -37,7 +37,7 @@ Rake::TestTask.new(:test_extra_trim) do |t|
   t.test_files = FileList['test/**/trim_test.rb']
 end
 
-task :test => [:test_common, :test_extra_items, :test_extra_i18n, :test_extra_out_of_range, :test_extra_trim ]
+task :test => [:test_common, :test_extra_items, :test_extra_i18n, :test_extra_overflow, :test_extra_trim ]
 
 RuboCop::RakeTask.new(:rubocop) do |t|
   t.options = `git ls-files -z`.split("\x0")     # limit rubocop to the files in the repo

diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -40,7 +40,7 @@ <h1 id="site-title">{{ site.title | default: site.github.repository_name }} <a c
       <a href="{{ site.baseurl }}/extras/foundation"><p class="indent1" {% if page.title == 'Foundation' %}id="active"{% endif %} >Foundation</p></a>
       <a href="{{ site.baseurl }}/extras/i18n"><p class="indent1" {% if page.title == 'I18n' %}id="active"{% endif %} >I18n</p></a>
       <a href="{{ site.baseurl }}/extras/items"><p class="indent1" {% if page.title == 'Items' %}id="active"{% endif %} >Items</p></a>
-      <a href="{{ site.baseurl }}/extras/out_of_range"><p class="indent1" {% if page.title == 'Out Of Range' %}id="active"{% endif %} >Out Of Range</p></a>
+      <a href="{{ site.baseurl }}/extras/overflow"><p class="indent1" {% if page.title == 'Overflow' %}id="active"{% endif %} >Overflow</p></a>
       <a href="{{ site.baseurl }}/extras/materialize"><p class="indent1" {% if page.title == 'Materialize' %}id="active"{% endif %} >Materialize</p></a>
       <a href="{{ site.baseurl }}/extras/navs"><p class="indent1" {% if page.title == 'Navs' %}id="active"{% endif %} >Navs</p></a>
       <a href="{{ site.baseurl }}/extras/searchkick"><p class="indent1" {% if page.title == 'Searchkick' %}id="active"{% endif %} >Searchkick</p></a>

diff --git a/docs/extras.md b/docs/extras.md
@@ -5,21 +5,21 @@ title: Extras
 
 Pagy comes with a few optional extensions/extras:
 
-| Extra                   | Description                                                                                                                                         | Links                                                                                                                                                              |
-| :---------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `array`                 | Paginate arrays efficiently avoiding expensive array-wrapping and without overriding                                                                | [array.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/array.rb), [documentation](extras/array.md)                                                 |
-| `bootstrap`             | Nav, responsive and compact helpers and templates for the Bootstrap [pagination component](https://getbootstrap.com/docs/4.1/components/pagination) | [bootstrap.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/bootstrap.rb), [documentation](extras/bootstrap.md)                                     |
-| `bulma`                 | Nav, responsive and compact helpers and templates for the Bulma [pagination component](https://bulma.io/documentation/components/pagination)        | [bulma.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/bulma.rb), [documentation](extras/bulma.md)                                                 |
-| `elasticsearch_rails`   | Paginate `elasticsearch_rails` gem results efficiently                                                                                              | [elasticsearch_rails.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/elasticsearch_rails.rb), [documentation](extras/elasticsearch_rails.md)       |
-| `foundation`            | Nav, responsive and compact helpers and templates for the Foundation [pagination component](https://foundation.zurb.com/sites/docs/pagination.html) | [foundation.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/foundation.rb), [documentation](extras/foundation.md)                                  |
-| `i18n`                  | Use the `I18n` gem instead of the pagy implementation                                                                                               | [i18n.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/i81n.rb), [documentation](extras/i18n.md)                                                    |
-| `items`                 | Allow the client to request a custom number of items per page with a ready to use selector UI                                                       | [items.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/items.rb), [documentation](extras/items.md)                                                 |
-| `materialize`           | Nav, responsive and compact helpers for the Materialize CSS [pagination component](https://materializecss.com/pagination.html)                      | [materialize.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/materialize.rb), [documentation](extras/materialize.md)                               |
-| `navs`                  | Add responsive and compact generic/unstyled nav helpers                                                                                             | [navs.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/navs.rb), [documentation](extras/navs.md)                                                    |
-| `out_of_range`          | Allow for easy handling of out of range pages                                                                                                       | [out_of_range.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/out_of_range.rb), [documentation](extras/out_of_range.md)                            |
-| `searchkick`            | Paginate arrays efficiently avoiding expensive array-wrapping and without overriding                                                                | [searchkick.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/searchkick.rb), [documentation](extras/searchkick.md)                                  |
-| `semantic`              | Nav helpers for the Semantic UI CSS [pagination component](https://semantic-ui.com/collections/menu.html)                                           | [semantic.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/semantic.rb), [documentation](extras/semantic.md)                                        |
-| `trim`                  | Remove the `page=1` param from links                                                                                                                | [trim.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/trim.rb), [documentation](extras/trim.md)                                                    |
+| Extra                 | Description                                                                                                                                            | Links                                                                                                                                                        |
+|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `array`               | Paginate arrays efficiently avoiding expensive array-wrapping and without overriding                                                                   | [array.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/array.rb), [documentation](extras/array.md)                                           |
+| `bootstrap`           | Nav, responsive and compact helpers and templates for the Bootstrap [pagination component](https://getbootstrap.com/docs/4.1/components/pagination)    | [bootstrap.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/bootstrap.rb), [documentation](extras/bootstrap.md)                               |
+| `bulma`               | Nav, responsive and compact helpers and templates for the Bulma [pagination component](https://bulma.io/documentation/components/pagination)           | [bulma.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/bulma.rb), [documentation](extras/bulma.md)                                           |
+| `elasticsearch_rails` | Paginate `elasticsearch_rails` gem results efficiently                                                                                                 | [elasticsearch_rails.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/elasticsearch_rails.rb), [documentation](extras/elasticsearch_rails.md) |
+| `foundation`          | Nav, responsive and compact helpers and templates for the Foundation [pagination component](https://foundation.zurb.com/sites/docs/pagination.html)    | [foundation.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/foundation.rb), [documentation](extras/foundation.md)                            |
+| `i18n`                | Use the `I18n` gem instead of the pagy implementation                                                                                                  | [i18n.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/i81n.rb), [documentation](extras/i18n.md)                                              |
+| `items`               | Allow the client to request a custom number of items per page with a ready to use selector UI                                                          | [items.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/items.rb), [documentation](extras/items.md)                                           |
+| `materialize`         | Nav, responsive and compact helpers for the Materialize CSS [pagination component](https://materializecss.com/pagination.html)                         | [materialize.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/materialize.rb), [documentation](extras/materialize.md)                         |
+| `navs`                | Add responsive and compact generic/unstyled nav helpers                                                                                                | [navs.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/navs.rb), [documentation](extras/navs.md)                                              |
+| `overflow`            | Allow for easy handling of overflowing pages                                                                                                           | [overflow.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/overflow.rb), [documentation](extras/overflow.md)                                  |
+| `searchkick`          | Paginate arrays efficiently avoiding expensive array-wrapping and without overriding                                                                   | [searchkick.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/searchkick.rb), [documentation](extras/searchkick.md)                            |
+| `semantic`            | Nav helpers for the Semantic UI CSS [pagination component](https://semantic-ui.com/collections/menu.html)                                              | [semantic.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/semantic.rb), [documentation](extras/semantic.md)                                  |
+| `trim`                | Remove the `page=1` param from links                                                                                                                   | [trim.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/trim.rb), [documentation](extras/trim.md)                                              |
 
 ## Synopsys
 

diff --git a/docs/extras/out_of_range.md b/docs/extras/out_of_range.md