blacklight_range_limit 1.1.0 → 1.2.0

data/README.rdoc

@@ -11,8 +11,6 @@ Decimal numbers and Dates are NOT supported; they theoretically could be in the
 
 = Requirements
 
-A Rails app using the Blacklight plugin (post version 2.5. Either git checkout from master, or wait until whatever version comes after 2.5). If you've modified and over-ridden Blacklight a lot, things might get tricky. 
-
 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
@@ -31,27 +29,13 @@ Add
    gem "blacklight_range_limit"
 to your Gemfile. Run "bundle install". 
 
-Then run "rails generate blacklight_range_limit".  This will install some assets in your app's public/ folder. (This process likely to change in Rails 3.1). 
-
-== Blacklight 2.x/Rails 2.x
-
-Must be installed as a plugin, most easily using 'git', rather than as a gem. Version 0.9.6 is the last version that works with Blacklight 2.x. 
-
-   cd ./vendor/plugins/
-   git clone git://github.com/projectblacklight/blacklight_range_limit.git
-   cd blacklight_range_limit
-   git checkout v0.9.6
-
-
-If you don't have git installed, you can try downloading the 0.9.6 package from https://github.com/projectblacklight/blacklight_range_limit/archives/master , and installing in vendor/plugins. 
-
+Then run "rails generate blacklight_range_limit".  This will install some asset references in your application.js and application.css
 
 = 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 config/initializers/blacklight_config.rb, that field needs to be listed in config[:facet][:field_names], and you also need to create a config[:facet][:range]["your_field] => true key. 
+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[:facet][:field_names] << "my_field"
-  config[:facet][:range]["my_field"] = 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. 
 
@@ -66,7 +50,7 @@ You can also configure the look and feel of the Flot chart using the jQuery .dat
     grid: { color: '#aaaaaa', tickColor: '#aaaaaa', borderWidth: 0 }  
   });
 
-You can add this configuration in public/javascripts/application.js, or anywhere else loaded before the blacklight range limit javascript.
+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
 
@@ -85,7 +69,7 @@ Note that a drill-down will never require the second request, because boundaries
 
 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. 
 
-  config[:facet][:range]["my_field"] = { 
+config.add_facet_field 'pub_date', :label => 'Publication Year', :range => {
     :num_segments => 6,
     :assumed_boundaries => [1100, Time.now.year + 2],
     :slider_js => false,
@@ -119,19 +103,12 @@ to turn off all injection. The plugin will be completely non-functional if you d
 You can also turn off injection of individual components, which could be more useful:
    
   BlacklightRangeLimit.omit_inject = {
-    :css => false,
-    :js => false,
-    :flot => false,
+    :excanvas => false,
     :view_helpers => false,
     :controller_mixin => false
   }
-
-[:css]
-  set to false and the plugin will not insert it's own CSS. 
-[:js]
-  set to false and the plugin will not insert it's own JS, which means none of your range limits will get sliders or charts. Perhaps you don't like JS, or don't like ours. 
-[:flot]
-  Normally the plugin will insert <script> links to the Flot plugin, the Flot Selection plugin, and the IE canvas emulator Flot needs on IE.  Perhaps you are already including these files, or would like to include them yourself. Set to false. 
+[:excanvas]
+  Set to false to disable loading the IE 'excanvas' compatibility layer
 [: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]

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/app/assets/javascripts/blacklight_range_limit.js

@@ -0,0 +1,9 @@
+// Master manifest file for engine, so local app can require
+// this one file, but get all our files -- and local app
+// require does not need to change if we change file list.
+
+//= require 'jquery'
+//= require 'jquery-ui'
+//= require 'flot/jquery.flot.js'
+//= require 'flot/jquery.flot.selection.js'
+//= require_tree './blacklight_range_limit'

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

@@ -0,0 +1,6 @@
+/* Master manifest file for engine, so local app can require
+ * this one file, but get all our files -- and local app
+ * require does not need to change if we change file list. 
+ *
+ *= require_tree './blacklight_range_limit'
+ */

data/app/views/blacklight_range_limit/_range_limit_panel.html.erb

@@ -3,7 +3,6 @@
   field_config = range_config(solr_field)
 -%>
 
-<h3><%= facet_field_labels[solr_field] -%></h3>
 <div class="limit_content range_limit">  
   <% if  params["range"] &&
          params["range"][solr_field] &&

data/blacklight_range_limit.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |s|
 
 
   s.add_dependency "rails", "~> 3.0"
-  s.add_dependency "blacklight"
+  s.add_dependency "blacklight", "~> 3.2"
 end

data/lib/blacklight_range_limit.rb

@@ -52,8 +52,4 @@ module BlacklightRangeLimit
     array << element unless array.include?(element)
   end
   
-  def self.use_asset_pipeline?
-    (Rails::VERSION::MAJOR >= 3 and Rails::VERSION::MINOR >= 1) and Rails.application.config.assets.enabled
-  end
-  
 end

data/lib/blacklight_range_limit/controller_override.rb

@@ -19,26 +19,13 @@ module BlacklightRangeLimit
       end
   
       before_filter do |controller|
-        unless BlacklightRangeLimit.omit_inject[:css] || use_asset_pipeline?
-          controller.stylesheet_links << "blacklight_range_limit"
-        end
-  
-        unless BlacklightRangeLimit.omit_inject[:flot]
-          unless use_asset_pipeline?
-            controller.javascript_includes << "flot/jquery.flot.js"
-            controller.javascript_includes << "flot/jquery.flot.selection.js"
-          end
-          
+        unless BlacklightRangeLimit.omit_inject[:excanvas]
+               
           # canvas for IE. Need to inject it like this even with asset pipeline
           # cause it needs IE conditional include. view_context hacky way
           # to get asset url helpers. 
           controller.extra_head_content << ('<!--[if IE]>' + view_context.javascript_include_tag("flot/excanvas.min.js") + '<![endif]-->').html_safe
         end
-          
-        unless BlacklightRangeLimit.omit_inject[:js] || use_asset_pipeline?
-          controller.javascript_includes << "range_limit_slider"
-          controller.javascript_includes << "range_limit_distro_facets"
-        end
       end
     end
   
@@ -73,11 +60,7 @@ module BlacklightRangeLimit
     # Method added to solr_search_params_logic to fetch
     # proper things for date ranges. 
     def add_range_limit_params(solr_params, req_params)            
-      all_range_config.each_pair do |solr_field, config|
-        config = {} if config == true
-        # If we have any range facets configured, we want to ask for
-        # the stats component to get min/max.
-      
+      blacklight_config.facet_fields.select { |key, config| config.range }.each_pair do |solr_field, config|
         solr_params["stats"] = "true"
         solr_params["stats.field"] ||= []
         solr_params["stats.field"] << solr_field    
@@ -99,13 +82,13 @@ module BlacklightRangeLimit
           solr_params[:fq] ||= []
           solr_params[:fq] << "#{solr_field}: [#{start} TO #{finish}]"
           
-          if (config[:segments] != false && start != "*" && finish != "*")
+          if (config.segments != false && start != "*" && finish != "*")
             # Add in our calculated segments, can only do with both boundaries.
             add_range_segments_to_solr!(solr_params, solr_field, start.to_i, finish.to_i)
           end
           
-        elsif (config[:segments] != false &&
-               boundaries = config[:assumed_boundaries])
+        elsif (config.segments != false &&
+               boundaries = config.assumed_boundaries)
           # assumed_boundaries in config
           add_range_segments_to_solr!(solr_params, solr_field, boundaries[0], boundaries[1])
         end
@@ -118,23 +101,13 @@ module BlacklightRangeLimit
     # if not configured. Returns hash even if configured to 'true'
     # for consistency. 
     def range_config(solr_field)    
-      config = all_range_config[solr_field] || false
-      config = {} if config == true # normalize bool true to hash
-      return config
-    end
-    # returns a hash of solr_field => config for all configured range
-    # facets, or empty hash. 
-    # Uses Blacklight.config, needs to be modified when
-    # that changes to be controller-based. This is the only method
-    # in this plugin that accesses Blacklight.config, single point
-    # of contact. 
-    def all_range_config
-      Blacklight.config[:facet][:range] || {}
-    end
-    
-    private 
-    def use_asset_pipeline?
-      BlacklightRangeLimit.use_asset_pipeline?
+      field = blacklight_config.facet_fields[solr_field]
+      return false unless field.range
+
+      config = field.range
+      config = {} if config === true
+
+      config
     end
   end
 end

data/lib/blacklight_range_limit/view_helper_override.rb

@@ -5,14 +5,9 @@
 
 
     
-    def render_facet_limit(solr_field)
-      if ( range_config(solr_field) )
-        if (should_show_limit(solr_field))
-          render(:partial => "blacklight_range_limit/range_limit_panel", :locals=> {:solr_field => solr_field })
-        end
-      else
-        super(solr_field)
-      end
+    def facet_partial_name(display_facet)
+      return "blacklight_range_limit/range_limit_panel" if range_config(display_facet.name) and should_show_limit(display_facet.name)
+      super
     end
 
     def render_constraints_filters(my_params = params)

data/lib/generators/blacklight_range_limit/assets_generator.rb

@@ -16,32 +16,22 @@ module BlacklightRangeLimit
     source_root File.join(BlacklightRangeLimit::Engine.root, 'app', 'assets')
 
     def assets
-      if BlacklightRangeLimit.use_asset_pipeline?
-        insert_into_file "app/assets/stylesheets/application.css", :before => "*/" do
+      insert_into_file "app/assets/stylesheets/application.css", :before => "*/" do
 %q{
  *
  * Used by blacklight_range_limit
- *= require  'blacklight_range_limit/blacklight_range_limit'
+ *= require  'blacklight_range_limit'
  *         
 }
-        end
+      end
 
-        insert_into_file "app/assets/javascripts/application.js", :after => "//= require jquery" do
+      insert_into_file "app/assets/javascripts/application.js", :after => "//= require jquery$" do
 %q{
 
-// Used by blacklight_range_limit
-//= require 'flot/jquery.flot.js'
-//= require 'flot/jquery.flot.selection.js'
 // You can elmiminate one or both of these if you don't want their functionality
-//= require 'blacklight_range_limit/range_limit_slider'
-//= require 'blacklight_range_limit/range_limit_distro_facets'
+//= require 'blacklight_range_limit'
 
 }          
-        end
-      else
-        directory("stylesheets/blacklight_range_limit", "public/stylesheets")        
-        directory("javascripts/blacklight_range_limit", "public/javascripts")
-        directory("javascripts/flot", "public/javascripts/flot")
       end
     end
     

metadata

@@ -1,72 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: blacklight_range_limit
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  segments: 
-  - 1
-  - 1
-  - 0
-  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Jonathan Rochkind
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-20 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2169256060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: blacklight
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2169256060
+- !ruby/object:Gem::Dependency
+  name: blacklight
+  requirement: &2169255380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *2169255380
 description: 
-email: 
+email:
 - blacklight-development@googlegroups.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
+- app/assets/javascripts/blacklight_range_limit.js
 - app/assets/javascripts/blacklight_range_limit/range_limit_distro_facets.js
 - app/assets/javascripts/blacklight_range_limit/range_limit_slider.js
 - app/assets/javascripts/flot/excanvas.min.js
 - app/assets/javascripts/flot/jquery.flot.js
 - app/assets/javascripts/flot/jquery.flot.selection.js
+- app/assets/stylesheets/blacklight_range_limit.css.scss
 - app/assets/stylesheets/blacklight_range_limit/blacklight_range_limit.css
 - app/helpers/range_limit_helper.rb
 - app/views/blacklight_range_limit/_range_limit_panel.html.erb
@@ -83,39 +68,28 @@ files:
 - lib/blacklight_range_limit/view_helper_override.rb
 - lib/generators/blacklight_range_limit/assets_generator.rb
 - lib/generators/blacklight_range_limit/blacklight_range_limit_generator.rb
-has_rdoc: true
 homepage: http://projectblacklight.org/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: blacklight
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Blacklight Range Limit plugin
 test_files: []
-