qa 0.10.1 → 0.10.2

data/lib/qa/authorities/local/file_based_authority.rb

@@ -8,13 +8,13 @@ module Qa::Authorities
     def search(q)
       r = q.blank? ? [] : terms.select { |term| /\b#{q.downcase}/.match(term[:term].downcase) }
       r.map do |res|
-        { :id => res[:id], :label => res[:term] }.with_indifferent_access
+        { id: res[:id], label: res[:term] }.with_indifferent_access
       end
     end
 
     def all
       terms.map do |res|
-        { :id => res[:id], :label => res[:term] }.with_indifferent_access
+        { id: res[:id], label: res[:term] }.with_indifferent_access
       end
     end
 
@@ -24,26 +24,25 @@ module Qa::Authorities
 
     private
 
-    def terms
-      subauthority_hash = YAML.load(File.read(subauthority_filename))
-      terms = subauthority_hash.with_indifferent_access.fetch(:terms, [])
-      normalize_terms(terms)
-    end
+      def terms
+        subauthority_hash = YAML.load(File.read(subauthority_filename))
+        terms = subauthority_hash.with_indifferent_access.fetch(:terms, [])
+        normalize_terms(terms)
+      end
 
-    def subauthority_filename
-      File.join(Local.subauthorities_path, "#{subauthority}.yml")
-    end
+      def subauthority_filename
+        File.join(Local.subauthorities_path, "#{subauthority}.yml")
+      end
 
-    def normalize_terms(terms)
-      terms.map do |term|
-        if term.is_a? String
-          { :id => term, :term => term }.with_indifferent_access
-        else
-          term[:id] ||= term[:term]
-          term
+      def normalize_terms(terms)
+        terms.map do |term|
+          if term.is_a? String
+            { id: term, term: term }.with_indifferent_access
+          else
+            term[:id] ||= term[:term]
+            term
+          end
         end
       end
-    end
-
   end
 end

data/lib/qa/authorities/local/mysql_table_based_authority.rb

@@ -1,15 +1,17 @@
 module Qa
   module Authorities
     module Local
-      #
       class MysqlTableBasedAuthority < Local::TableBasedAuthority
+        self.table_index = "index_qa_local_authority_entries_on_lower_label_and_authority"
+
         def self.check_for_index
           conn = ActiveRecord::Base.connection
-          if table_or_view_exists? && conn.index_name_exists?(:qa_local_authority_entries, 'index_qa_local_authority_entries_on_lower_label_and_authority', :default).blank?
-            Rails.logger.error "You've installed mysql local authority tables, but you haven't indexed the lower label.  Rails doesn't support functional indexes in migrations, so we tried to execute it for you but something went wrong...\n" \
-              'Make sure your table has a lower_label column which is virtuall created and that column is indexed' \
-              ' ALTER TABLE qa_local_authority_entries ADD lower_label VARCHAR(256) GENERATED ALWAYS AS (lower(label)) VIRTUAL' \
-              ' CREATE INDEX index_qa_local_authority_entries_on_lower_label_and_authority ON qa_local_authority_entries (local_authority_id, lower_label)'
+          if table_or_view_exists? && conn.index_name_exists?(table_name.to_sym, table_index, :default).blank?
+            Rails.logger.error "You've installed mysql local authority tables, but you haven't indexed the lower label. "
+            "Rails doesn't support functional indexes in migrations, so we tried to execute it for you but something went wrong...\n" \
+            "Make sure your table has a lower_label column, which is virtually created, and that the column is indexed." \
+            " ALTER TABLE #{table_name} ADD lower_label VARCHAR(256) GENERATED ALWAYS AS (lower(label)) VIRTUAL" \
+            " CREATE INDEX #{table_index} ON #{table_name} (local_authority_id, lower_label)"
           end
         end
 

data/lib/qa/authorities/local/registry.rb

@@ -20,12 +20,12 @@ module Qa::Authorities
 
       def self.logger
         @logger ||= begin
-          ::Rails.logger if defined? Rails and Rails.respond_to? :logger
+          ::Rails.logger if defined? Rails && Rails.respond_to?(:logger)
         end
       end
 
-      def self.logger= logger
-        @logger = logger
+      class << self
+        attr_writer :logger
       end
 
       def add(subauthority, class_name)
@@ -33,10 +33,10 @@ module Qa::Authorities
         @hash[subauthority] = RegistryEntry.new(subauthority, class_name)
       end
 
-
       class RegistryEntry
         def initialize(subauthority, class_name)
-          @subauthority, @class_name = subauthority, class_name
+          @subauthority = subauthority
+          @class_name = class_name
         end
 
         def klass

data/lib/qa/authorities/local/table_based_authority.rb

@@ -1,16 +1,33 @@
 module Qa::Authorities
   class Local::TableBasedAuthority < Base
-    def self.check_for_index
-      @checked_for_index ||= begin
-        conn = ActiveRecord::Base.connection
-        if table_or_view_exists? && !conn.indexes('local_authority_entries').find { |i| i.name == 'index_local_authority_entries_on_lower_label' }
-          Rails.logger.error "You've installed local authority tables, but you haven't indexed the label.  Rails doesn't support functional indexes in migrations, so you'll have to add this manually:\n" \
-            "CREATE INDEX \"index_qa_local_authority_entries_on_lower_label\" ON \"qa_local_authority_entries\" (local_authority_id, lower(label))\n" \
-            "   OR on Sqlite: \n" \
-            "CREATE INDEX \"index_qa_local_authority_entries_on_lower_label\" ON \"qa_local_authority_entries\" (local_authority_id, label collate nocase)\n" \
-            "   OR for MySQL use the MSQLTableBasedAuthority instead, since mysql does not support functional indexes."
+    class_attribute :table_name, :table_index
+    self.table_name = "qa_local_authority_entries"
+    self.table_index = "index_qa_local_authority_entries_on_lower_label"
+
+    class << self
+      def check_for_index
+        @checked_for_index ||= begin
+          conn = ActiveRecord::Base.connection
+          if table_or_view_exists? && !conn.indexes(table_name).find { |i| i.name == table_index }
+            Rails.logger.error "You've installed local authority tables, but you haven't indexed the label.  Rails doesn't support functional indexes in migrations, so you'll have to add this manually:\n" \
+              "CREATE INDEX \"#{table_index}\" ON \"#{table_name}\" (local_authority_id, lower(label))\n" \
+              "   OR on Sqlite: \n" \
+              "CREATE INDEX \"#{table_index}\" ON \"#{table_name}\" (local_authority_id, label collate nocase)\n" \
+              "   OR for MySQL use the MSQLTableBasedAuthority instead, since mysql does not support functional indexes."
+          end
         end
       end
+
+      private
+
+        def table_or_view_exists?
+          conn = ActiveRecord::Base.connection
+          if conn.respond_to?(:data_source_exists?)
+            conn.data_source_exists?(table_name)
+          else
+            conn.table_exists?(table_name)
+          end
+        end
     end
 
     attr_reader :subauthority
@@ -37,15 +54,6 @@ module Qa::Authorities
 
     private
 
-      def self.table_or_view_exists?
-        conn = ActiveRecord::Base.connection
-        if conn.respond_to?(:data_source_exists?)
-          conn.data_source_exists?('qa_local_authority_entries')
-        else
-          conn.table_exists?('qa_local_authority_entries')
-        end
-      end
-
       def base_relation
         Qa::LocalAuthorityEntry.where(local_authority: local_authority)
       end
@@ -61,6 +69,5 @@ module Qa::Authorities
       def local_authority
         Qa::LocalAuthority.find_by_name(subauthority)
       end
-
   end
 end

data/lib/qa/authorities/mesh.rb

@@ -1,26 +1,18 @@
 module Qa::Authorities
   class Mesh < Base
-
-    def search q
-      begin
-        r = Qa::SubjectMeshTerm.where('term_lower LIKE ?', "#{q}%").limit(10)
-        r.map { |t| {id: t.term_id, label: t.term} }
-      end
+    def search(q)
+      r = Qa::SubjectMeshTerm.where('term_lower LIKE ?', "#{q}%").limit(10)
+      r.map { |t| { id: t.term_id, label: t.term } }
     end
 
-    def find id
-      begin
-        r = Qa::SubjectMeshTerm.where(term_id: id).limit(1).first
-        r.nil? ? nil : {id: r.term_id, label: r.term, synonyms: r.synonyms}
-      end
+    def find(id)
+      r = Qa::SubjectMeshTerm.where(term_id: id).limit(1).first
+      r.nil? ? nil : { id: r.term_id, label: r.term, synonyms: r.synonyms }
     end
 
     def all
-      begin
-        r = Qa::SubjectMeshTerm.all
-        r.map { |t| {id: t.term_id, label: t.term} }
-      end
+      r = Qa::SubjectMeshTerm.all
+      r.map { |t| { id: t.term_id, label: t.term } }
     end
-    
   end
 end

data/lib/qa/authorities/mesh_tools.rb

@@ -1,6 +1,6 @@
-  module Qa::Authorities::MeshTools
-    extend ActiveSupport::Autoload
+module Qa::Authorities::MeshTools
+  extend ActiveSupport::Autoload
 
-    autoload :MeshDataParser
-    autoload :MeshImporter
-  end
+  autoload :MeshDataParser
+  autoload :MeshImporter
+end

data/lib/qa/authorities/mesh_tools/mesh_data_parser.rb

@@ -1,17 +1,16 @@
 module Qa::Authorities
   module MeshTools
     class MeshDataParser
-
       attr_accessor :file
 
       def initialize(file)
         @file = file
       end
 
-      def each_mesh_record(&block)
+      def each_mesh_record
         current_data = {}
         in_record = false
-        self.file.each_line do |line|
+        file.each_line do |line|
           case line
           when /\A\*NEWRECORD/
             yield(current_data) if in_record
@@ -31,10 +30,9 @@ module Qa::Authorities
 
       def all_records
         result = []
-        self.each_mesh_record {|rec| result << rec }
-        return result
+        each_mesh_record { |rec| result << rec }
+        result
       end
-
     end
   end
 end

data/lib/qa/authorities/mesh_tools/mesh_importer.rb

@@ -12,11 +12,10 @@ module Qa::Authorities
           entry << record['MH'].first.downcase
           entry << get_synonyms(record).join('|')
           entries << entry
-          unless record['MN'].nil?
-            trees += record['MN'].map do |tree_number|
-              [record['UI'].first,
-               tree_number]
-            end
+          next if record['MN'].nil?
+          trees += record['MN'].map do |tree_number|
+            [record['UI'].first,
+             tree_number]
           end
         end
         Qa::SubjectMeshTerm.import([:term_id, :term, :term_lower, :synonyms], entries)
@@ -25,15 +24,14 @@ module Qa::Authorities
 
       private
 
-      def get_synonyms(record)
-        first_terms(record, 'PRINT ENTRY') + first_terms(record, 'ENTRY')
-      end
-
-      def first_terms(record, field)
-        return [] if record[field].nil?
-        record[field].map { |s| s.split('|').first }
-      end
+        def get_synonyms(record)
+          first_terms(record, 'PRINT ENTRY') + first_terms(record, 'ENTRY')
+        end
 
+        def first_terms(record, field)
+          return [] if record[field].nil?
+          record[field].map { |s| s.split('|').first }
+        end
     end
   end
 end

data/lib/qa/authorities/oclcts.rb

@@ -20,6 +20,5 @@ module Qa::Authorities
     def self.url_pattern(query_type)
       SRU_SERVER_CONFIG["url-pattern"][query_type]
     end
-
   end
 end

data/lib/qa/authorities/oclcts/generic_oclc_authority.rb

@@ -7,36 +7,36 @@ module Qa::Authorities
     end
     include WebServiceBase
 
-    def search q
+    def search(q)
       get_raw_response("prefix-query", q)
-      r = Array.new
+      r = []
       raw_response.xpath('sru:searchRetrieveResponse/sru:records/sru:record/sru:recordData', 'sru' => 'http://www.loc.gov/zing/srw/').each do |record|
-        r.append({"id" => record.xpath('Zthes/term/termId').first.content, "label" => record.xpath('Zthes/term/termName').first.content})
+        r.append("id" => record.xpath('Zthes/term/termId').first.content, "label" => record.xpath('Zthes/term/termName').first.content)
       end
       r
     end
 
-    def find id
+    def find(id)
       get_raw_response("id-lookup", id)
       parse_full_record(id)
     end
 
     private
 
-    def parse_full_record id
-      a = {}
-      zthes_record = raw_response.xpath("sru:searchRetrieveResponse/sru:records/sru:record/sru:recordData/Zthes/term[termId='#{id}']", 'sru' => 'http://www.loc.gov/zing/srw/')
-      zthes_record.children.each do |child|
-        if (child.is_a? Nokogiri::XML::Element) && (!child.children.nil?) && (child.children.size == 1) && (child.children.first.is_a? Nokogiri::XML::Text)
-          a[child.name] = child.children.first.to_s
+      def parse_full_record(id)
+        a = {}
+        zthes_record = raw_response.xpath("sru:searchRetrieveResponse/sru:records/sru:record/sru:recordData/Zthes/term[termId='#{id}']", 'sru' => 'http://www.loc.gov/zing/srw/')
+        zthes_record.children.each do |child|
+          if (child.is_a? Nokogiri::XML::Element) && !child.children.nil? && (child.children.size == 1) && (child.children.first.is_a? Nokogiri::XML::Text)
+            a[child.name] = child.children.first.to_s
+          end
         end
+        a
       end
-      a
-    end
 
-    def get_raw_response query_type, id
-      query_url = Oclcts.url_pattern(query_type).gsub("{query}", id).gsub("{id}", id).gsub("{authority-id}", subauthority)
-      @raw_response = Nokogiri::XML(open(query_url))
-    end
+      def get_raw_response(query_type, id)
+        query_url = Oclcts.url_pattern(query_type).gsub("{query}", id).gsub("{id}", id).gsub("{authority-id}", subauthority)
+        @raw_response = Nokogiri::XML(open(query_url))
+      end
   end
 end

data/lib/qa/authorities/tgnlang.rb

@@ -2,17 +2,14 @@ require 'nokogiri'
 
 module Qa::Authorities
   class Tgnlang < Base
-
     def search(q)
-      getTgnLang(q)
+      get_tgnlang(q)
     end
 
-    def getTgnLang(q)
-      obj = Array.new
+    def get_tgnlang(q)
+      obj = []
       Tgnlang.languages.each do |h|
-        if h["label"].downcase.start_with?(q.downcase)
-          obj.push(h)
-        end
+        obj.push(h) if h["label"].downcase.start_with?(q.downcase)
       end
       obj
     end
@@ -27,7 +24,7 @@ module Qa::Authorities
             lang_array = doc.css("Language").map do |lang|
               id = lang.css("Language_Code").first.text
               label = lang.css("Language_Name").first.text
-              {"id" => id, "label" => label}
+              { "id" => id, "label" => label }
             end
           end
           lang_array
@@ -37,11 +34,9 @@ module Qa::Authorities
     def find(id)
       id = id.downcase
       Tgnlang.languages.each do |h|
-        if h["label"].downcase == id
-          return h
-        end
+        return h if h["label"].downcase == id
       end
-      return {}
+      {}
     end
   end
 end

data/lib/qa/version.rb

@@ -1,3 +1,3 @@
 module Qa
-  VERSION = "0.10.1"
+  VERSION = "0.10.2".freeze
 end

data/spec/controllers/terms_controller_spec.rb

@@ -1,143 +1,133 @@
 require 'spec_helper'
 
-describe Qa::TermsController, :type => :controller do
-
+describe Qa::TermsController, type: :controller do
   before do
     @routes = Qa::Engine.routes
   end
 
   describe "#check_vocab_param" do
-    it "should return 404 if the vocabulary is missing" do
-      get :search, { :q => "a query", :vocab => "" }
+    it "returns 404 if the vocabulary is missing" do
+      get :search, q: "a query", vocab: ""
       expect(response.code).to eq("404")
     end
   end
 
   describe "#check_query_param" do
-    it "should return 404 if the query is missing" do
-      get :search, { :q => "", :vocab => "tgnlang" }
+    it "returns 404 if the query is missing" do
+      get :search, q: "", vocab: "tgnlang"
       expect(response.code).to eq("404")
     end
   end
 
   describe "#init_authority" do
     context "when the authority does not exist" do
-      it "should return 404" do
+      it "returns 404" do
         expect(Rails.logger).to receive(:warn).with("Unable to initialize authority Qa::Authorities::Non-existent-authority")
-        get :search, { :q => "a query", :vocab => "non-existent-authority" }
+        get :search, q: "a query", vocab: "non-existent-authority"
         expect(response.code).to eq("404")
       end
     end
     context "when a sub-authority does not exist" do
-      it "should return 404 if a sub-authority does not exist" do
+      it "returns 404 if a sub-authority does not exist" do
         expect(Rails.logger).to receive(:warn).with("Unable to initialize sub-authority non-existent-subauthority for Qa::Authorities::Loc. Valid sub-authorities are [\"subjects\", \"names\", \"classification\", \"childrensSubjects\", \"genreForms\", \"performanceMediums\", \"graphicMaterials\", \"organizations\", \"relators\", \"countries\", \"ethnographicTerms\", \"geographicAreas\", \"languages\", \"iso639-1\", \"iso639-2\", \"iso639-5\", \"preservation\", \"actionsGranted\", \"agentType\", \"edtf\", \"contentLocationType\", \"copyrightStatus\", \"cryptographicHashFunctions\", \"environmentCharacteristic\", \"environmentPurpose\", \"eventRelatedAgentRole\", \"eventRelatedObjectRole\", \"eventType\", \"formatRegistryRole\", \"hardwareType\", \"inhibitorTarget\", \"inhibitorType\", \"objectCategory\", \"preservationLevelRole\", \"relationshipSubType\", \"relationshipType\", \"rightsBasis\", \"rightsRelatedAgentRole\", \"signatureEncoding\", \"signatureMethod\", \"softwareType\", \"storageMedium\"]")
-        get :search, { :q => "a query", :vocab => "loc", :subauthority => "non-existent-subauthority" }
+        get :search, q: "a query", vocab: "loc", subauthority: "non-existent-subauthority"
         expect(response.code).to eq("404")
       end
     end
     context "when a sub-authority is absent" do
-      it "should return 404 for LOC" do
-        get :search, { :q => "a query", :vocab => "loc" }
+      it "returns 404 for LOC" do
+        get :search, q: "a query", vocab: "loc"
         expect(response.code).to eq("404")
       end
-      it "should return 404 for oclcts" do
-        get :search, { :q => "a query", :vocab => "oclcts" }
+      it "returns 404 for oclcts" do
+        get :search, q: "a query", vocab: "oclcts"
         expect(response.code).to eq("404")
       end
     end
   end
 
   describe "#search" do
-
     context "loc" do
-      before :each do
-        stub_request(:get, "http://id.loc.gov/search/?format=json&q=Berry&q=cs:http://id.loc.gov/authorities/names").
-          with(:headers => {'Accept'=>'application/json'}).
-          to_return(:body => webmock_fixture("loc-names-response.txt"), :status => 200)
+      before do
+        stub_request(:get, "http://id.loc.gov/search/?format=json&q=Berry&q=cs:http://id.loc.gov/authorities/names")
+          .with(headers: { 'Accept' => 'application/json' })
+          .to_return(body: webmock_fixture("loc-names-response.txt"), status: 200)
       end
 
-      it "should return a set of terms for a tgnlang query" do
-        get :search, {:q => "Tibetan", :vocab => "tgnlang" }
+      it "returns a set of terms for a tgnlang query" do
+        get :search, q: "Tibetan", vocab: "tgnlang"
         expect(response).to be_success
       end
 
-      it "should not return 404 if subauthority is valid" do
-        get :search, { :q => "Berry", :vocab => "loc", :subauthority => "names" }
+      it "does not return 404 if subauthority is valid" do
+        get :search, q: "Berry", vocab: "loc", subauthority: "names"
         expect(response).to be_success
       end
     end
 
     context "assign_fast" do
       before do
-        stub_request(:get, "http://fast.oclc.org/searchfast/fastsuggest?query=word&queryIndex=suggest50&queryReturn=suggest50,idroot,auth,type&rows=20&suggest=autoSubject").
-          with(:headers => {'Accept'=>'application/json'}).
-          to_return(:body => webmock_fixture("assign-fast-topical-result.json"), :status => 200, :headers => {})
+        stub_request(:get, "http://fast.oclc.org/searchfast/fastsuggest?query=word&queryIndex=suggest50&queryReturn=suggest50,idroot,auth,type&rows=20&suggest=autoSubject")
+          .with(headers: { 'Accept' => 'application/json' })
+          .to_return(body: webmock_fixture("assign-fast-topical-result.json"), status: 200, headers: {})
       end
       it "succeeds if authority class is camelcase" do
-        get :search, { :q => "word", :vocab => "assign_fast", :subauthority => "topical" }
+        get :search, q: "word", vocab: "assign_fast", subauthority: "topical"
         expect(response).to be_success
       end
     end
-
   end
 
   describe "#index" do
-
     context "with supported authorities" do
-      it "should return all local authority state terms" do
-        get :index, { :vocab => "local", :subauthority => "states" }
+      it "returns all local authority state terms" do
+        get :index, vocab: "local", subauthority: "states"
         expect(response).to be_success
       end
-      it "should return all MeSH terms" do
-        get :index, { :vocab => "mesh" }
+      it "returns all MeSH terms" do
+        get :index, vocab: "mesh"
         expect(response).to be_success
       end
     end
 
     context "when the authority does not support #all" do
-      it "should return null for tgnlang" do
-        get :index, { :vocab => "tgnlang" }
+      it "returns null for tgnlang" do
+        get :index, vocab: "tgnlang"
         expect(response.body).to eq("null")
       end
-      it "should return null for oclcts" do
-        get :index, { :vocab => "oclcts", :subauthority => "mesh" }
+      it "returns null for oclcts" do
+        get :index, vocab: "oclcts", subauthority: "mesh"
         expect(response.body).to eq("null")
       end
-      it "should return null for LOC authorities" do
-        get :index, { :vocab => "loc", :subauthority => "relators" }
+      it "returns null for LOC authorities" do
+        get :index, vocab: "loc", subauthority: "relators"
         expect(response.body).to eq("null")
       end
     end
-
   end
 
   describe "#show" do
-
     context "with supported authorities" do
-
       before do
-        stub_request(:get, "http://id.loc.gov/authorities/subjects/sh85077565.json").
-          with(:headers => {'Accept'=>'application/json'}).
-          to_return(:status => 200, :body => webmock_fixture("loc-names-response.txt"), :headers => {})
+        stub_request(:get, "http://id.loc.gov/authorities/subjects/sh85077565.json")
+          .with(headers: { 'Accept' => 'application/json' })
+          .to_return(status: 200, body: webmock_fixture("loc-names-response.txt"), headers: {})
       end
 
-      it "should return an individual state term" do
-        get :show, { :vocab => "local", :subauthority => "states", id: "OH" }
+      it "returns an individual state term" do
+        get :show, vocab: "local", subauthority: "states", id: "OH"
         expect(response).to be_success
       end
 
-      it "should return an individual MeSH term" do
-        get :show, { vocab: "mesh", id: "D000001" }
+      it "returns an individual MeSH term" do
+        get :show, vocab: "mesh", id: "D000001"
         expect(response).to be_success
       end
 
-      it "should return an individual subject term" do
-        get :show, { vocab: "loc", subauthority: "subjects", id: "sh85077565" }
+      it "returns an individual subject term" do
+        get :show, vocab: "loc", subauthority: "subjects", id: "sh85077565"
         expect(response).to be_success
       end
-
     end
-
   end
-
 end