dbla 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed3c90144eabe9791538f773b22ba691467248be
-  data.tar.gz: 7cab3b50332d69e51d978538022ff2034b88265f
+  metadata.gz: b511243621c7428086b96e4b807c3900dddd1264
+  data.tar.gz: c46a5e41a85489dd58e189adc67859699bd7adb8
 SHA512:
-  metadata.gz: 276e2e397be231484d882ce6c8111f7905a79e1dbe428be6dff04944c02efa4598f47106c01e454c8f23012714159f52f8c90b4078136114813c237edfea6c68
-  data.tar.gz: 19da1e0593e6f066ac31505d6d9df0a0120685186966fd112ed4481c04ec6e0e7a7e7284df49466f0b1ff91a1fc914b1b40e7d1c7c441b2901934dd8f514858d
+  metadata.gz: 54793d19643fd0c7854c1ef8f1e98720ea0c4b46ad1493265ae6bef4527369ff060e7a6d0914c2ea4fcc526ec21337fe21a60e5af72c736fda9edbbfd4f0fcec
+  data.tar.gz: 54a4c98894f0e24f4b1fbeb868b10b1941402bb2b9d1174bf82567a4af5c093672b6dfbe5795b9057119a8ff67c879cbad2893f3193a0b8db08f99a71263f836

data/lib/dbla/abstract_response.rb

@@ -31,6 +31,10 @@ module Dbla
       {}
     end
     # secret api
+    def export_formats
+      {}
+    end
+
     def grouped?
       false
     end

data/lib/dbla/document_presenter.rb

@@ -67,7 +67,7 @@ module Dbla
     #   @param [Hash] opts
     #   @options opts [String] :value
     def render_index_field_value field, options = {}
-
+        field.to_s.split('.').inject(@document) {|m,v| m[v]}
     end
     ##
     # Render the show field value for a document
@@ -78,6 +78,7 @@ module Dbla
     #   @param [Hash] options
     #   @options opts [String] :value
     def render_document_show_field_value field, options={}
+        field.to_s.split('.').inject(@document) {|m,v| m[v]}
     end
 
     ##

data/lib/dbla/repository.rb

@@ -12,7 +12,16 @@ module Dbla
       data = nil
       #TODO Move this into a SearchBuilder, add a generator
       if params['q']
-        q = "?api_key=#{api_key}&q=#{params['q']}&facets=sourceResource.format"
+        q = "?api_key=#{api_key}&q=#{params['q']}"
+        fq = []
+        blacklight_config.facet_fields.each do |f|
+          # [fiendName, facetConfig]
+          next unless f[0] =~ /^(sourceResource|provider|object|intermediateProvider|dataProvider)/
+          fqv = f[0]
+          fqv = fqv + ':' + f[1].pin if f[1].pin
+          fq << fqv
+        end
+        q << "&facets=#{fq.join(',')}" unless fq.empty?
         if params.page
           q << "&page=#{params.page}"
         end

data/lib/dbla/response.rb

@@ -9,10 +9,10 @@ module Dbla
       self.document_model = options[:solr_document_model] || options[:document_model] || Item
       self.blacklight_config = options[:blacklight_config]
       if data
-        @total = data['count']
+        @total = data.fetch('count',0)
         @documents = (data['docs'] || []).map {|d| document_model.new(d,self)}
-        @start = data['start']
-        @limit = data['limit']
+        @start = data.fetch('start',0)
+        @limit = data.fetch('limit',10)
         @aggregations = (data['facets'] || {})
       else
         @aggregations = {}
@@ -25,10 +25,14 @@ module Dbla
     def aggregations
       # "facets":{"sourceResource.format":{"_type":"terms","missing":77,"total":250,"other":16,"terms":[{"term":"Photographs","count":44},
       Hash[@aggregations.map do |k,v|
+        next unless v['terms']
         items = v['terms'].map {|term| Facets::FacetItem.new(value: term['term'], hits: term['count'])}
         [k, Facets::FacetField.new(k,items)]
       end]
     end
+    def facet_by_field_name(facet_field)
+      aggregations[facet_field.to_s]
+    end
     def spelling
       Words.new([])
     end

data/lib/dbla/response/facets.rb

@@ -22,7 +22,7 @@ module Dbla::Response::Facets
 
     private
     def default_limit
-      100
+      Dbla.config.fetch(:facet_field_default_limit, 100)
     end
 
     def default_sort

data/lib/dbla/version.rb

@@ -1,3 +1,3 @@
 module Dbla
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/generators/dbla/catalog_generator.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+module Dbla
+  class CatalogGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def assets
+      copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb"
+    end
+  end
+end

data/lib/generators/dbla/templates/catalog_controller.rb

@@ -0,0 +1,156 @@
+# -*- encoding : utf-8 -*-
+class CatalogController < ApplicationController  
+  include Blacklight::Marc::Catalog
+
+  include Blacklight::Catalog
+
+  configure_blacklight do |config|
+    ## Default parameters to send to solr for all search-like requests. See also SearchBuilder#processed_parameters
+    config.default_solr_params = { 
+      :qt => 'search',
+      :rows => 10 
+    }
+    
+    # solr path which will be added to solr base url before the other solr params.
+    #config.solr_path = 'select' 
+    
+    # items to show per page, each number in the array represent another option to choose from.
+    #config.per_page = [10,20,50,100]
+
+    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SearchHelper#solr_doc_params) or
+    ## parameters included in the Blacklight-jetty document requestHandler.
+    #
+    #config.default_document_solr_params = {
+    #  :qt => 'document',
+    #  ## These are hard-coded in the blacklight 'document' requestHandler
+    #  # :fl => '*',
+    #  # :rows => 1
+    #  # :q => '{!raw f=id v=$id}' 
+    #}
+
+    config.repository_class = Dbla::Repository
+    config.document_model = Item
+    config.response_model = Dbla::Response
+    config.document_presenter_class = Dbla::DocumentPresenter
+    config.search_builder_class = SearchBuilder
+    # solr field configuration for search results/index views
+    config.index.title_field = 'sourceResource.title'
+    config.index.thumbnail_field = 'object'
+    config.index.display_type_field = 'format'
+
+    # solr field configuration for document/show views
+    #config.show.title_field = 'title_display'
+    #config.show.display_type_field = 'format'
+
+    # solr fields that will be treated as facets by the blacklight application
+    #   The ordering of the field names is the order of the display
+    #
+    # Setting a limit will trigger Blacklight's 'more' facet values link.
+    # * If left unset, then all facet values returned by solr will be displayed.
+    # * If set to an integer, then "f.somefield.facet.limit" will be added to
+    # solr request, with actual solr request being +1 your configured limit --
+    # you configure the number of items you actually want _displayed_ in a page.    
+    # * If set to 'true', then no additional parameters will be sent to solr,
+    # but any 'sniffed' request limit parameters will be used for paging, with
+    # paging at requested limit -1. Can sniff from facet.limit or 
+    # f.specific_field.facet.limit solr request params. This 'true' config
+    # can be used if you set limits in :default_solr_params, or as defaults
+    # on the solr side in the request handler itself. Request handler defaults
+    # sniffing requires solr requests to be made with "echoParams=all", for
+    # app code to actually have it echo'd back to see it.  
+    #
+    # :show may be set to false if you don't want the facet to be drawn in the 
+    # facet bar
+    config.add_facet_field 'sourceResource.format', label: 'By Format'
+    config.add_facet_field 'dataProvider', label: 'Contributing Institution'
+    config.add_facet_field 'provider.name', label: 'Partner'
+    config.add_facet_field 'sourceResource.language.name', label: 'By Language'
+    config.add_facet_field 'sourceResource.subject.name', label: 'By Subject'
+
+    # Have BL send all facet field names to Solr, which has been the default
+    # previously. Simply remove these lines if you'd rather use Solr request
+    # handler defaults, or have no facets.
+    config.add_facet_fields_to_solr_request!
+
+    # solr fields to be displayed in the index (search results) view
+    #   The ordering of the field names is the order of the display 
+    config.add_index_field 'sourceResource.format', :label => 'Format'
+    config.add_index_field 'sourceResource.creator', :label => 'Creator'
+
+    # solr fields to be displayed in the show (single result) view
+    #   The ordering of the field names is the order of the display 
+
+    # "fielded" search configuration. Used by pulldown among other places.
+    # For supported keys in hash, see rdoc for Blacklight::SearchFields
+    #
+    # Search fields will inherit the :qt solr request handler from
+    # config[:default_solr_parameters], OR can specify a different one
+    # with a :qt key/value. Below examples inherit, except for subject
+    # that specifies the same :qt as default for our own internal
+    # testing purposes.
+    #
+    # The :key is what will be used to identify this BL search field internally,
+    # as well as in URLs -- so changing it after deployment may break bookmarked
+    # urls.  A display label will be automatically calculated from the :key,
+    # or can be specified manually to be different. 
+
+    # This one uses all the defaults set by the solr request handler. Which
+    # solr request handler? The one set in config[:default_solr_parameters][:qt],
+    # since we aren't specifying it otherwise. 
+    
+    config.add_search_field 'all_fields', :label => 'All Fields'
+    
+
+    # Now we see how to over-ride Solr request handler defaults, in this
+    # case for a BL "search field", which is really a dismax aggregate
+    # of Solr search fields. 
+    
+    config.add_search_field('title') do |field|
+      # solr_parameters hash are sent to Solr as ordinary url query params. 
+      field.solr_parameters = { :'spellcheck.dictionary' => 'title' }
+
+      # :solr_local_parameters will be sent using Solr LocalParams
+      # syntax, as eg {! qf=$title_qf }. This is neccesary to use
+      # Solr parameter de-referencing like $title_qf.
+      # See: http://wiki.apache.org/solr/LocalParams
+      field.solr_local_parameters = { 
+        :qf => '$title_qf',
+        :pf => '$title_pf'
+      }
+    end
+    
+    config.add_search_field('author') do |field|
+      field.solr_parameters = { :'spellcheck.dictionary' => 'author' }
+      field.solr_local_parameters = { 
+        :qf => '$author_qf',
+        :pf => '$author_pf'
+      }
+    end
+    
+    # Specifying a :qt only to show it's possible, and so our internal automated
+    # tests can test it. In this case it's the same as 
+    # config[:default_solr_parameters][:qt], so isn't actually neccesary. 
+    config.add_search_field('subject') do |field|
+      field.solr_parameters = { :'spellcheck.dictionary' => 'subject' }
+      field.qt = 'search'
+      field.solr_local_parameters = { 
+        :qf => '$subject_qf',
+        :pf => '$subject_pf'
+      }
+    end
+
+    # "sort results by" select (pulldown)
+    # label in pulldown is followed by the name of the SOLR field to sort by and
+    # whether the sort is ascending or descending (it must be asc or desc
+    # except in the relevancy case).
+    config.add_sort_field 'score desc, pub_date_sort desc, title_sort asc', :label => 'relevance'
+    config.add_sort_field 'pub_date_sort desc, title_sort asc', :label => 'year'
+    config.add_sort_field 'author_sort asc, title_sort asc', :label => 'author'
+    config.add_sort_field 'title_sort asc, pub_date_sort desc', :label => 'title'
+
+    # If there are more than this many search results, no spelling ("did you 
+    # mean") suggestion is offered.
+    config.spell_max = 5
+  end
+
+end 

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: dbla
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Audrey Altman
 - Ben Armintor
+- Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -17,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.10
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.10
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +100,7 @@ description: Rails engine to put BL on DPLA -> DBLA
 email:
 - audrey@dp.la
 - armintor@gmail.com
+- jeremy.n.friesen@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -123,10 +125,12 @@ files:
 - lib/dbla/search_builder_behavior.rb
 - lib/dbla/version.rb
 - lib/generators/dbla/assets_generator.rb
+- lib/generators/dbla/catalog_generator.rb
 - lib/generators/dbla/install_generator.rb
 - lib/generators/dbla/models_generator.rb
 - lib/generators/dbla/routes_generator.rb
 - lib/generators/dbla/search_builder_generator.rb
+- lib/generators/dbla/templates/catalog_controller.rb
 - lib/generators/dbla/templates/collection.rb
 - lib/generators/dbla/templates/dbla.css.scss
 - lib/generators/dbla/templates/item.rb