blacklight 6.12.0 → 6.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02341df004a989772bead1f95c9d0cb9bbe2efb4
-  data.tar.gz: bfa578b3cbd743828afdbc9e261f0aaff917373e
+  metadata.gz: 3f8e150bbc29ab7fea77523b447dddfc11c32c7d
+  data.tar.gz: 5e9a545db8bf223f3ebf452464055408739d2620
 SHA512:
-  metadata.gz: 33942d3280a5ce4ab36703a0d81975ecc8e93a92ec44b3c824166ae0a738522bdd7a17f54fd77371449a3c386b4793d0e5dcfbdbd0542d0d25a283e9fe0a72b1
-  data.tar.gz: 24b2a2e23c5ec9e38c710ad3764a2e47a3a9ededd1d327842a47c0d1eb52777c92576e39b16d634ca08f74c471d01427460cb532784c92fc576d45f1f03614a5
+  metadata.gz: a412554969d9774294084579801d8b35804d741952a8795fd45cd0d8c810c66c3a63e96c8611ef9663ecf1574e0ff0e2dc05dda706b2ed778ec0afec332babd8
+  data.tar.gz: 2ab4d5eaf1663d0557f4d196f475f4819d816211b1006cbbc9caa406075c0d7f5c1a9a744de458e5a667ca5f7ecc6f9de6d0a159b57ce062d82c8265b1974695

data/VERSION

@@ -1 +1 @@
-6.12.0
+6.13.0

data/app/controllers/concerns/blacklight/search_fields.rb

@@ -26,6 +26,9 @@
 #
 ##
 module Blacklight::SearchFields
+  extend Deprecation
+  self.deprecation_horizon = 'blacklight 7.x'
+
   # Looks up search field config list from blacklight_config[:search_fields], and
   # 'normalizes' all field config hashes using normalize_config method. 
   def search_field_list
@@ -37,22 +40,11 @@ module Blacklight::SearchFields
   def search_field_def_for_key(key)
     blacklight_config.search_fields[key]
   end
+  deprecation_deprecate search_field_def_for_key: "Use blacklight_config.search_fields[key]"
 
   # Returns default search field, used for simpler display in history, etc.
   # if not set in blacklight_config, defaults to first field listed in #search_field_list
   def default_search_field
     blacklight_config.default_search_field || search_field_list.first
   end
-
-  # Shortcut for commonly needed operation, look up display
-  # label for the key specified. Returns "Keyword" if a label
-  # can't be found. 
-  def label_for_search_field(key)
-    field_def = search_field_def_for_key(key)
-    if field_def && field_def.label
-       field_def.label
-    else
-       I18n.t('blacklight.search.fields.default')
-    end            
-  end
 end

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -14,7 +14,7 @@ module Blacklight::ConfigurationHelperBehavior
 
   # Used in the document_list partial (search view) for building a select element
   def sort_fields
-    active_sort_fields.map { |key, x| [x.label, x.key] }
+    active_sort_fields.map { |_sort_key, field_config| [sort_field_label(field_config.key), field_config.key] }
   end
   deprecation_deprecate :sort_fields
   
@@ -31,8 +31,8 @@ module Blacklight::ConfigurationHelperBehavior
   # an html select based on #search_field_list. Skips search_fields
   # marked :include_in_simple_select => false
   def search_field_options_for_select
-    blacklight_config.search_fields.collect do |key, field_def|
-      [field_def.label,  field_def.key] if should_render_field?(field_def)
+    blacklight_config.search_fields.collect do |_key, field_def|
+      [label_for_search_field(field_def.key), field_def.key] if should_render_field?(field_def)
     end.compact
   end
 
@@ -107,6 +107,32 @@ module Blacklight::ConfigurationHelperBehavior
     )
   end
 
+  # Shortcut for commonly needed operation, look up display
+  # label for the key specified. Returns "Keyword" if a label
+  # can't be found.
+  def label_for_search_field(key)
+    field_config = blacklight_config.search_fields[key]
+    field_config ||= Blacklight::Configuration::NullField.new(key: key)
+
+    field_label(
+      :"blacklight.search.fields.search.#{field_config.key}",
+      :"blacklight.search.fields.#{field_config.key}",
+      (field_config.label if field_config),
+      key.to_s.humanize
+    )
+  end
+
+  def sort_field_label(key)
+    field_config = blacklight_config.sort_fields[key]
+    field_config ||= Blacklight::Configuration::NullField.new(key: key)
+
+    field_label(
+      :"blacklight.search.fields.sort.#{key}",
+      (field_config.label if field_config),
+      key.to_s.humanize
+    )
+  end
+
   ##
   # Look up the label for a solr field.
   #

data/app/views/catalog/_sort_widget.html.erb

@@ -1,12 +1,12 @@
 <% if show_sort_and_per_page? and active_sort_fields.many? %>
 <div id="sort-dropdown" class="btn-group">
   <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
-      <%= t('blacklight.search.sort.label', :field =>current_sort_field.label) %> <span class="caret"></span>
+      <%= t('blacklight.search.sort.label', :field =>sort_field_label(current_sort_field.key)) %> <span class="caret"></span>
   </button>
 
   <ul class="dropdown-menu" role="menu">
       <%- active_sort_fields.each do |sort_key, field_config| %>
-        <li><%= link_to(field_config.label, url_for(search_state.params_for_search(sort: sort_key))) %></li>
+        <li><%= link_to(sort_field_label(sort_key), url_for(search_state.params_for_search(sort: sort_key))) %></li>
       <%- end -%>
   </ul>
 </div>

data/lib/generators/blacklight/install_generator.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 module Blacklight
   class Install < Rails::Generators::Base
-    
     source_root File.expand_path('../templates', __FILE__)
-    
+
     argument     :model_name  , type: :string , default: "user"
     argument     :controller_name, type: :string , default: "catalog"
     argument     :document_name, type: :string , default: "solr_document"
@@ -14,11 +13,12 @@ module Blacklight
     class_option :jettywrapper, type: :boolean, default: false, desc: "Use jettywrapper to download and control Jetty"
     class_option :marc        , type: :boolean, default: false, aliases: "-m", desc: "Generate MARC-based demo ."
     class_option :'skip-assets', type: :boolean, default: false, desc: "Skip generating javascript and css assets into the application"
+    class_option :'skip-solr', type: :boolean, default: false, desc: "Skip generating solr configurations."
 
     desc <<-EOS
       This generator makes the following changes to your application:
        1. Generates blacklight:models
-       2. Generates utilities for working with solr 
+       2. Generates utilities for working with solr
        3. Creates a number of public assets, including images, stylesheets, and javascript
        4. Injects behavior into your user application_controller.rb
        5. Adds example configurations for dealing with MARC-like data
@@ -28,6 +28,7 @@ module Blacklight
     EOS
 
     def add_solr_wrapper
+      return if options[:'skip-solr']
       generator_options = '--jettywrapper' if options[:jettywrapper]
       solr_generator = if options[:jettywrapper]
                          'blacklight:solr4'
@@ -47,11 +48,11 @@ module Blacklight
 
     # Copy all files in templates/public/ directory to public/
     # Call external generator in AssetsGenerator, so we can
-    # leave that callable seperately too. 
-    def copy_public_assets 
+    # leave that callable seperately too.
+    def copy_public_assets
       generate "blacklight:assets" unless options[:'skip-assets']
     end
-    
+
     def generate_blacklight_document
       generate 'blacklight:document', document_name
     end
@@ -63,20 +64,20 @@ module Blacklight
     def generate_blacklight_models
       generate 'blacklight:models'
     end
-    
+
     def generate_blacklight_user
       generator_args = [model_name]
       if options[:devise]
         generator_args << "--devise #{options[:devise]}"
       end
-      
+
       generate 'blacklight:user', generator_args.join(" ")
     end
 
     def generate_controller
       generate 'blacklight:controller', controller_name
     end
-    
+
     def add_default_catalog_route
       route("root to: \"#{controller_name}#index\"")
     end

data/spec/controllers/blacklight/search_fields_spec.rb

@@ -29,20 +29,16 @@ describe Blacklight::SearchFields do
      end
   end
 
-  it "fills in default qt where needed" do
-    expect(@search_field_obj.search_field_def_for_key("all_fields").qt).to eq @config.default_solr_params[:qt]
-  end
-
-  it "lookups field definitions by key" do
-    expect(@search_field_obj.search_field_def_for_key("title").key).to eq "title"
-  end
-
-  it "finds label by key" do
-    expect(@search_field_obj.label_for_search_field("title")).to eq "Title"
-  end
+  describe "#search_field_def_for_key" do
+    it "fills in default qt where needed" do
+      expect(Deprecation).to receive(:warn).at_least(:once)
+      expect(@search_field_obj.search_field_def_for_key("all_fields").qt).to eq @config.default_solr_params[:qt]
+    end
 
-  it "supplies default label for key not found" do
-    expect(@search_field_obj.label_for_search_field("non_existent_key")).to eq "Keyword"
+    it "lookups field definitions by key" do
+      expect(Deprecation).to receive(:warn).at_least(:once)
+      expect(@search_field_obj.search_field_def_for_key("title").key).to eq "title"
+    end
   end
 
   describe "for unspecified :key" do

data/spec/helpers/configuration_helper_spec.rb

@@ -270,4 +270,18 @@ describe BlacklightConfigurationHelper do
       expect(select_arguments).not_to include(["No Display", "no_display"])
     end
   end
+
+  describe "#label_for_search_field" do
+    before do
+      blacklight_config.add_search_field 'title', :qt => 'title_search'
+    end
+
+    it "finds label by key" do
+      expect(helper.label_for_search_field("title")).to eq "Title"
+    end
+
+    it "supplies default label for key not found" do
+      expect(helper.label_for_search_field("non_existent_key")).to eq "Non existent key"
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 6.12.0
+  version: 6.13.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2017-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails