blacklight_range_limit 5.0.0 → 5.0.1

data/{README.rdoc → README.md}

@@ -1,8 +1,10 @@
 BlacklightRangeLimit:  integer range limiting and profiling for Blacklight applications
 
-{<img src="https://travis-ci.org/projectblacklight/blacklight_range_limit.png?branch=master" alt="Build Status" />}[https://travis-ci.org/projectblacklight/blacklight_range_limit] {<img src="https://badge.fury.io/rb/blacklight_range_limit.png" alt="Gem Version" />}[http://badge.fury.io/rb/blacklight_range_limit]
+[![Build Status](https://travis-ci.org/projectblacklight/blacklight_range_limit.png?branch=v5.0.0)](https://travis-ci.org/projectblacklight/blacklight_range_limit) [![Gem Version](https://badge.fury.io/rb/blacklight_range_limit.png)](http://badge.fury.io/rb/blacklight_range_limit)
 
-= Description
+![Screen shot](doc/example-screenshot.png)
+
+# Description
 
 The BlacklightRangeLimit plugin provides a 'facet' or limit for integer fields, that lets the user enter range limits with a text box or a slider, and also provides area charts giving a sense of the distribution of values (with drill down). 
 
@@ -11,11 +13,11 @@ The primary use case of this plugin is for 'year' data, but it should work for a
 Decimal numbers and Dates are NOT supported; they theoretically could be in the future, although it gets tricky. 
 
 
-= Requirements
+# Requirements
 
 A Solr integer field. Depending on your data, it may or may not be advantageous to use a tint (trie with non-zero precision) type field. 
 
-==Note on solr field types
+## Note on solr field types
 
 If all your integers are the same number of digits, you can use just about any solr type, including string/type, and all will be well. But if your integers vary in digits, strings won't sort correctly, making your numbers behave oddly in partitions and limits. This is also true if you use a pre-1.4 "integer"/pint/solr.IntField  field -- these are not "sortable". 
 
@@ -23,13 +25,13 @@ You need to use a "sortable" numeric-type field. In Solr 1.4, the standard "int"
 
 The pre Solr 1.4 now deprecated sint or slong types should work fine too. 
 
-= Installation
+# Installation
 
 Current 5.x version of `blacklight_range_limit` work with `blacklight` 5.x -- we now synchronize the _major version number_ between `blacklight` and `blacklight_range_limit`.  `blacklight_range_limit` 2.1 is the last version believed to work with blacklight 4.x or possibly blacklight 3.x.
 
 Add
 
-   gem "blacklight_range_limit"
+    gem "blacklight_range_limit"
 
 to your Gemfile. Run "bundle install". 
 
@@ -39,28 +41,27 @@ Then run
 
 This will install some asset references in your application.js and application.css.
 
-= Configuration
+# Configuration
 
 You have at least one solr field you want to display as a range limit, that's why you've installed this plugin. In your CatalogController, the facet configuration should look like:
 
-  config.add_facet_field 'pub_date', :label => 'Publication Year', :range => true 
+    config.add_facet_field 'pub_date', :label => 'Publication Year', :range => true 
   
 You should now get range limit display. More complicated configuration is available if desired, see Range Facet Configuration below. 
 
 
 You can also configure the look and feel of the Flot chart using the jQuery .data() method. On the `.facet_limit` container you want to configure, add a Flot options associative array (documented at http://people.iola.dk/olau/flot/API.txt) as the `plot-config` key. The `plot-config` key to set the `plot-config` key on the appropriate `.facet_limit` container. In order to customize the plot colors, for example, you could use this code:
 
-  $('.blacklight-year_i').data('plot-config', { 
-    selection: { color: '#C0FF83' }, 
-    colors: ['#ffffff'], 
-    series: { lines: { fillColor: 'rgba(255,255,255, 0.5)' }}, 
-    grid: { color: '#aaaaaa', tickColor: '#aaaaaa', borderWidth: 0 }  
-  });
+    $('.blacklight-year_i').data('plot-config', { 
+      selection: { color: '#C0FF83' }, 
+      colors: ['#ffffff'], 
+      series: { lines: { fillColor: 'rgba(255,255,255, 0.5)' }}, 
+      grid: { color: '#aaaaaa', tickColor: '#aaaaaa', borderWidth: 0 }  
+    });
 
 You can add this configuration in app/assets/javascript/application.js, or anywhere else loaded before the blacklight range limit javascript.
 
-
-== A note on AJAX use
+## A note on AJAX use
 
 In order to calculate distribution segment ranges, we need to first know the min and max boundaries. But we don't really know that until we've fetched the result set (we use the Solr Stats component to get min and max with a result set). 
 
@@ -73,7 +74,7 @@ If you'd like to avoid this, you can turn off segment display altogether with th
 Note that a drill-down will never require the second request, because boundaries on a drill-down are always taken from the specified limits.
 
  
-== Range Facet Configuration
+## Range Facet Configuration
 
 Instead of simply passing "true", you can pass a hash with additional configuration. Here's an example with all the available keys, you don't need to use them all, just the ones you want to set to non-default values. 
 
@@ -83,16 +84,16 @@ Instead of simply passing "true", you can pass a hash with additional configurat
       :segments => false    
     }
   
-[num_segments]
-   Default 10. Approximately how many segments to divide the range into for segment facets, which become segments on the chart. Actual segments are calculated to be 'nice' values, so may not exactly match your setting.  
-[assumed_boundaries]
-   Default null. For a result set that has not yet been limited, instead of taking boundaries from results and making a second AJAX request to fetch segments, just assume these given boundaries. If you'd like to avoid this second AJAX Solr call, you can set :assumed_boundaries to a two-element array of integers instead, and the assumed boundaries will always be used. Note this is live ruby code, you can put calculations in there like Time.now.year + 2. 
-[:segments]
-   Default true. If set to false, then distribution segment facets will not be loaded at all.  
+* **:num_segments** :
+  * Default 10. Approximately how many segments to divide the range into for segment facets, which become segments on the chart. Actual segments are calculated to be 'nice' values, so may not exactly match your setting.  
+* **:assumed_boundaries** :
+  * Default null. For a result set that has not yet been limited, instead of taking boundaries from results and making a second AJAX request to fetch segments, just assume these given boundaries. If you'd like to avoid this second AJAX Solr call, you can set :assumed_boundaries to a two-element array of integers instead, and the assumed boundaries will always be used. Note this is live ruby code, you can put calculations in there like Time.now.year + 2. 
+* **:segments** :
+  * Default true. If set to false, then distribution segment facets will not be loaded at all.  
    
-== Javascript dependencies
+## Javascript dependencies
 
-The selectable histograms/barcharts are done with Javascript, using Flot[http://code.google.com/p/flot/]. Flot requires JQuery, as well as support for the HTML5 canvas element. In IE previous to IE9, canvas element support can be added with excanvas[http://excanvas.sourceforge.net/]. For the slider, [bootstrap-slider](http://www.eyecon.ro/bootstrap-slider/) is used (bootstrap-slider is actually third party, not officially bootstrap). Flot and bootstrap-slider are both directly included in blacklight_range_limit in vendor. 
+The selectable histograms/barcharts are done with Javascript, using [Flot](http://code.google.com/p/flot/). Flot requires JQuery, as well as support for the HTML5 canvas element. In IE previous to IE9, canvas element support can be added with [excanvas](http://excanvas.sourceforge.net/). For the slider, [bootstrap-slider](http://www.eyecon.ro/bootstrap-slider/) is used (bootstrap-slider is actually third party, not officially bootstrap). Flot and bootstrap-slider are both directly included in blacklight_range_limit in vendor. 
 
 A `require 'blacklight_range_limit'` in a Rails asset pipeline manifest file will automatically include all of these things. The blacklight_range_limit adds just this line to your `app/assets/application.js`. 
 
@@ -102,20 +103,20 @@ Note this means a copy of jquery, from the jquery-rails gem, will be included in
 
 If you don't want any of this gem's JS, you can simply remove the `require 'blacklight_range_limit'` line from your application.js, and hack something else together yourself. 
 
-== IE8, excanvas
+## IE8, excanvas
 
 IE8 and below do not support the 'canvas' element, needed for flot to render the chart. 
 Without canvas, view will cleanly degrade to an ordinary textual listing of range segments
 as facets. 
 
-Or, you can use excanvas.js to add canvas support to IE.  blacklight_range_limit includes
-the excanvas.js file, but you'll have to manually add a reference to it to your Rails layout
+Or, you can use excanvas.js to add canvas support to IE.  `blacklight_range_limit` includes
+the `excanvas.js` file, but you'll have to manually add a reference to it to your Rails layout
 template -- if you were previously using the stock Blacklight layout, you'll have to add a
-local custom layout instead. Then add this to the html <head> section:
+local custom layout instead. Then add this to the html `<head>` section:
 
     <!--[if lte IE 8]><%= javascript_include_tag 'flot/excanvas.min' %><![endif]-->
 
-== Touch?
+## Touch?
 
 For touch screens, one wants the UI to work well. The slider used is
 [bootstrap_slider](http://www.eyecon.ro/bootstrap-slider/), which says if you add
@@ -126,7 +127,7 @@ Also not sure how well the flot select UI works on a touch screen. The slider
 is probably the best touch UI anyway, if it can be made to work well. 
 
 
-== Injection
+## Injection
 
 The plugin assumes it is in a Blacklight Rails app, and uses Blacklight methods, Rails methods, and standard ruby module includes to inject it's behaviors into the app.  
 
@@ -134,35 +135,36 @@ You can turn off this injection if you like, although it will make the plugin le
 
 In any initializer, you can set:
 
-  BlacklightRangeLimit.omit_inject = true
+    BlacklightRangeLimit.omit_inject = true
   
 to turn off all injection. The plugin will be completely non-functional if you do this, of course. But perhaps you could try to re-use some of it's classes in a non-Blacklight, highly hacked Blacklight, or even non-Rails application this way. 
 
 You can also turn off injection of individual components, which could be more useful:
    
-  BlacklightRangeLimit.omit_inject = {
-    :view_helpers => false,
-    :controller_mixin => false,
-    :routes => false
-  }
-[:view_helpers]
-  Set to false and the plugin will not insert it's own rails view helpers into the app. It will raise lots of errors if you do this, you probably don't want to. 
-[:controller_mixin]
-  The plugin mixes some methods into CatalogController, both over-riding Blacklight methods, and providing a new action of it's own. Set to false, and the plugin won't. You've basically disabled the plugin if you do this.  
-[:routes]
-  Disable automatic routes loading
+    BlacklightRangeLimit.omit_inject = {
+      :view_helpers => false,
+      :controller_mixin => false,
+      :routes => false
+    }
+
+* **:view_helpers** :
+  * Set to false and the plugin will not insert it's own rails view helpers into the app. It will raise lots of errors if you do this, you probably don't want to. 
+* **:controller_mixin** :
+  * The plugin mixes some methods into CatalogController, both over-riding Blacklight methods, and providing a new action of it's own. Set to false, and the plugin won't. You've basically disabled the plugin if you do this.  
+* **:routes** :
+  * Disable automatic routes loading
   
 See Javascript Dependencies above for disabling injection of gem's js.   
   
-= Tests
+# Tests
 
-Start the Blacklight demo jetty server (on port 8983)
+Test coverage is not great, but there are some tests, using rspec.  Run `rake ci` or just `rake` to seed and
+start a demo jetty server, build a clean test app, and run tests. 
 
-Run the rspec tests by running:
+Just `rake spec` to just run tests against an existing test app and jetty server. 
 
-  rspec
+# Possible future To Do
 
-= Possible future To Do
 * StatsComponent replacement. We use StatsComponent to get min/max of result set, as well as missing count. StatsComponent is included on every non-drilldown request, so ranges and slider can be displayed. However, StatsComponent really can slow down the solr response with a large result set. So replace StatsComponent with other strategies. No ideal ones, we can use facet.missing to get missing count instead, but RSolr makes it harder than it should be to grab this info. We can use seperate solr queries to get min/max (sort on our field, asc and desc), but this is more complicated, more solr queries, and possibly requires redesign of AJAXy stuff, so even a lone slider can have min/max. 
 * tests
 * In cases where an AJAX request is needed to fetch more results, don't trigger the AJAX until the range facet has actually been opened/shown. Currently it's done on page load. 

data/Rakefile

@@ -23,7 +23,7 @@ RSpec::Core::RakeTask.new do |t|
 
 end
 
-task :ci => ['jetty:clean', 'engine_cart:generate'] do
+task :ci => ['jetty:clean', 'engine_cart:clean', 'engine_cart:generate'] do
   jetty_params = Jettywrapper.load_config('test')
   jetty_params[:startup_wait]= 60
   error = Jettywrapper.wrap(jetty_params) do
@@ -43,4 +43,4 @@ namespace :test do
     end
   end
 
-end
+end

data/VERSION

@@ -1 +1 @@
-5.0.0
+5.0.1

data/app/assets/stylesheets/blacklight_range_limit/blacklight_range_limit.css

@@ -3,7 +3,7 @@ form.range_limit {
   line-height: 3;
 }
 
-form.range_limit input.range_begin, form.range_limit input.range_end {
+.range_limit input.range_begin, .range_limit input.range_end {
   display: inline-block;
   width: 4.5em;
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-11 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -185,7 +185,7 @@ files:
 - .travis.yml
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - app/assets/javascripts/blacklight_range_limit.js
@@ -201,6 +201,7 @@ files:
 - config/jetty.yml
 - config/routes.rb
 - config/solr.yml
+- doc/example-screenshot.png
 - lib/blacklight_range_limit.rb
 - lib/blacklight_range_limit/controller_override.rb
 - lib/blacklight_range_limit/engine.rb