qa 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87d95a0b1bdcbe0f16ac1ab1a5df3c0f3f5c84d7
-  data.tar.gz: d05ff39f1e7cf5f3803d79c8633cae5269a8746f
+  metadata.gz: e2bdd4569dfb4ab638c33d27795cfbb461f2559d
+  data.tar.gz: 1ac7796c5f9a0dd23e5721a9c3c5f65e579674d2
 SHA512:
-  metadata.gz: 0786240f76d29bb086fdd5b196f39761986f89aaa03a3f61116ac55e59ae8206607c8fc5c5cc2ad30b89d15fc39606f52af301ca50f670307404c257f9f2bcfd
-  data.tar.gz: 92f2bb8cfe4d4c6fd16e01a66d8fdd9c27d488786844ff96b409b37507291ff4f349c2e151d98e0e81eaf12ccc652c7f3569fffcbbd4d452f82ac83fe2f3f204
+  metadata.gz: f0e9691da5a0d9d980ed2cc7192ad705601c646820a4042366440db60061cdaa953a9cd627c74378442dc06816149f2e38a810c2719c1bbbbe8735ced44fa81a
+  data.tar.gz: d8d96b05bc5e2d3b6ddd808e432df99b0c264a941b4dce2c617e2b854e4fc723e0282464084163af4fd612807262531c4fea13fcae3d5432bd62333e248d2b86

data/Rakefile

@@ -2,12 +2,22 @@
 require 'bundler/gem_tasks'
 require 'engine_cart/rake_task'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.requires << 'rubocop-rspec'
+  task.fail_on_error = true
+end
+
 desc "Run continuous integration build"
-task :ci => ['engine_cart:generate'] do
+task ci: ['engine_cart:generate'] do
   Rake::Task['spec'].invoke
 end
 
-task :default => :ci
+desc 'Run continuous integration build'
+task ci: ['rubocop', 'spec']
+
+task default: :ci

data/app/controllers/qa/terms_controller.rb

@@ -4,7 +4,6 @@
 # same methods.
 
 class Qa::TermsController < ApplicationController
-
   before_action :check_vocab_param, :init_authority
   before_action :check_query_param, only: :search
 
@@ -32,18 +31,18 @@ class Qa::TermsController < ApplicationController
   def init_authority
     begin
       mod = authority_class.camelize.constantize
-    rescue NameError => e
+    rescue NameError
       logger.warn "Unable to initialize authority #{authority_class}"
       head :not_found
       return
     end
     begin
-      @authority = if mod.kind_of? Class
-        mod.new
-      else
-        raise Qa::MissingSubAuthority, "No sub-authority provided" if params[:subauthority].blank?
-        mod.subauthority_for(params[:subauthority])
-      end
+      @authority = if mod.is_a? Class
+                     mod.new
+                   else
+                     raise Qa::MissingSubAuthority, "No sub-authority provided" if params[:subauthority].blank?
+                     mod.subauthority_for(params[:subauthority])
+                   end
     rescue Qa::InvalidSubAuthority, Qa::MissingSubAuthority => e
       logger.warn e.message
       head :not_found
@@ -56,13 +55,12 @@ class Qa::TermsController < ApplicationController
 
   private
 
-  def authority_class
-    "Qa::Authorities::"+params[:vocab].capitalize
-  end
-
-  # converts wildcards into URL-encoded characters
-  def url_search
-    params[:q].gsub("*", "%2A")
-  end
+    def authority_class
+      "Qa::Authorities::" + params[:vocab].capitalize
+    end
 
+    # converts wildcards into URL-encoded characters
+    def url_search
+      params[:q].gsub("*", "%2A")
+    end
 end

data/app/models/qa/mesh_tree.rb

@@ -1,10 +1,8 @@
 class Qa::MeshTree < ActiveRecord::Base
-  belongs_to :subject_mesh_term , :foreign_key => "term_id"
+  belongs_to :subject_mesh_term, foreign_key: "term_id"
 
   def self.classify_all_trees
-    MeshTreeStructure.find_each do |mts|
-      mts.classify_tree!
-    end
+    MeshTreeStructure.find_each(&:classify_tree!)
   end
 
   def eval_tree_path
@@ -18,7 +16,7 @@ class Qa::MeshTree < ActiveRecord::Base
 
   def classify_tree
     tree_levels = initial_segements_of(tree_structure)
-    tree_levels.map &method(:lookup_tree_term)
+    tree_levels.map(&:lookup_tree_term)
   end
 
   def classify_tree!

data/app/models/qa/subject_mesh_term.rb

@@ -1,12 +1,12 @@
 class Qa::SubjectMeshTerm < ActiveRecord::Base
-  has_many :mesh_trees, :foreign_key => "term_id"
+  has_many :mesh_trees, foreign_key: "term_id"
 
   def self.from_tree_number(tree_id)
     Qa::SubjectMeshTerm.joins('INNER JOIN qa_mesh_trees ON qa_subject_mesh_terms.term_id = qa_mesh_trees.term_id').where('qa_mesh_trees.tree_number = ?', tree_id)
   end
 
   def trees
-    Qa::MeshTree.where(term_id: self.term_id).map { |t| t.tree_number }
+    Qa::MeshTree.where(term_id: term_id).map(&:tree_number)
   end
 
   def synonyms
@@ -24,22 +24,22 @@ class Qa::SubjectMeshTerm < ActiveRecord::Base
   end
 
   def parents
-    t = self.trees
+    t = trees
     t.map { |tn| initial_segements_of(tn) }.flatten.uniq.map { |tn| Qa::SubjectMeshTerm.from_tree_number(tn) }
   end
 
   private
-  # Return all of the intial segements of our tree number,
-  # from most general to most specific
-  # e.g. 'D03.456.23.789' returns ['D03', 'D03.456', 'D03.456.23', 'D03.456.23.789']
-  def initial_segements_of(s)
-    result = []
-    loop do
-      result << s
-      s = s.rpartition('.').first
-      break if s.empty?
-    end
-    result.reverse
-  end
 
+    # Return all of the intial segements of our tree number,
+    # from most general to most specific
+    # e.g. 'D03.456.23.789' returns ['D03', 'D03.456', 'D03.456.23', 'D03.456.23.789']
+    def initial_segements_of(s)
+      result = []
+      loop do
+        result << s
+        s = s.rpartition('.').first
+        break if s.empty?
+      end
+      result.reverse
+    end
 end

data/config/routes.rb

@@ -1,6 +1,6 @@
 Qa::Engine.routes.draw do
   get "/terms/:vocab(/:subauthority)",  controller: :terms, action: :index
   get "/search/:vocab(/:subauthority)", controller: :terms, action: :search
-  get "/show/:vocab/:id",                controller: :terms, action: :show
+  get "/show/:vocab/:id", controller: :terms, action: :show
   get "/show/:vocab/:subauthority/:id", controller: :terms, action: :show
 end

data/lib/generators/qa/install/install_generator.rb

@@ -2,13 +2,12 @@ class Qa::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 
   def inject_routes
-    insert_into_file "config/routes.rb", :after => ".draw do" do
-      %{\n  mount Qa::Engine => '/qa'\n}
+    insert_into_file "config/routes.rb", after: ".draw do" do
+      %(\n  mount Qa::Engine => '/qa'\n)
     end
   end
 
   def copy_oclcts_configs
     copy_file "config/oclcts-authorities.yml", "config/oclcts-authorities.yml"
   end
-
 end

data/lib/generators/qa/local/tables/mysql/mysql_generator.rb

@@ -6,7 +6,6 @@ module Qa::Local
       include ActiveRecord::Generators::Migration
 
       def migrations
-
         unless defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter) && ActiveRecord::Base.connection.instance_of?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
           message = "Use the table based generator if you are not using mysql 'rails generate qa:local:tables'"
           say_status("error", message, :red)
@@ -15,9 +14,9 @@ module Qa::Local
 
         generate "model qa/local_authority name:string:uniq"
         generate "model qa/local_authority_entry local_authority:references label:string uri:string:uniq lower_label:string"
-        migration_file = Dir.entries(File.join(destination_root,'db/migrate/'))
-                             .reject{|name| !name.include?('create_qa_local_authority_entries')}.first
-        migration_file = File.join('db/migrate',migration_file)
+        migration_file = Dir.entries(File.join(destination_root, 'db/migrate/'))
+                            .reject { |name| !name.include?('create_qa_local_authority_entries') }.first
+        migration_file = File.join('db/migrate', migration_file)
         gsub_file migration_file,
                   't.references :local_authority, index: true, foreign_key: true',
                   't.integer :local_authority_id, index: true'
@@ -40,4 +39,3 @@ module Qa::Local
     end
   end
 end
-

data/lib/generators/qa/local/tables/tables_generator.rb

@@ -5,16 +5,16 @@ module Qa::Local
     include ActiveRecord::Generators::Migration
 
     def migrations
-      if defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter) &&  ActiveRecord::Base.connection.instance_of?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
+      if defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter) && ActiveRecord::Base.connection.instance_of?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
         message = "Use the mysql table based generator if you are using mysql 'rails generate qa:local:tables:mysql'"
         say_status("error", message, :red)
         return 0
       end
       generate "model qa/local_authority name:string:uniq"
       generate "model qa/local_authority_entry local_authority:references label:string uri:string:uniq"
-      migration_file = Dir.entries(File.join(destination_root,'db/migrate/'))
-                           .reject{|name| !name.include?('create_qa_local_authority_entries')}.first
-      migration_file = File.join('db/migrate',migration_file)
+      migration_file = Dir.entries(File.join(destination_root, 'db/migrate/'))
+                          .reject { |name| !name.include?('create_qa_local_authority_entries') }.first
+      migration_file = File.join('db/migrate', migration_file)
       gsub_file migration_file,
                 't.references :local_authority, index: true, foreign_key: true',
                 't.references :local_authority, foreign_key: { to_table: :qa_local_authorities }, index: true'
@@ -25,7 +25,5 @@ module Qa::Local
     "CREATE INDEX \"index_qa_local_authority_entries_on_lower_label\" ON \"qa_local_authority_entries\" (local_authority_id, label collate nocase)\n"
       say_status("info", message, :yellow)
     end
-
   end
 end
-

data/lib/qa/authorities/assign_fast/generic_authority.rb

@@ -14,11 +14,11 @@ module Qa::Authorities
     #
     # @param [String] the query
     # @return json results
-    def search q
+    def search(q)
       url = build_query_url q
       begin
         raw_response = get_json(url)
-      rescue JSON::ParserError => error
+      rescue JSON::ParserError
         Rails.logger.info "Could not parse response as JSON. Request url: #{url}"
         return []
       end
@@ -29,33 +29,30 @@ module Qa::Authorities
     #
     # @param [String] the query
     # @return [String] the url
-    def build_query_url q
+    def build_query_url(q)
       escaped_query = clean_query_string q
       index = AssignFast.index_for_authority(subauthority)
       return_data = "#{index}%2Cidroot%2Cauth%2Ctype"
       num_rows = 20 # max allowed by the API
-      url = "http://fast.oclc.org/searchfast/fastsuggest?&query=#{escaped_query}&queryIndex=#{index}&queryReturn=#{return_data}&suggest=autoSubject&rows=#{num_rows}"
+      "http://fast.oclc.org/searchfast/fastsuggest?&query=#{escaped_query}&queryIndex=#{index}&queryReturn=#{return_data}&suggest=autoSubject&rows=#{num_rows}"
     end
 
     private
 
-    # Removes characters from the query string that are not tolerated by the API
-    #   See oclc sample code at
-    #   http://experimental.worldcat.org/fast/assignfast/js/assignFASTComplete.js
-    def clean_query_string q
-      URI.escape(q.gsub(/-|\(|\)|:/, ""))
-    end
+      # Removes characters from the query string that are not tolerated by the API
+      #   See oclc sample code at
+      #   http://experimental.worldcat.org/fast/assignfast/js/assignFASTComplete.js
+      def clean_query_string(q)
+        URI.escape(q.gsub(/-|\(|\)|:/, ""))
+      end
 
-    def parse_authority_response(raw_response)
-      results = raw_response['response']['docs'].map do |doc|
-        index = AssignFast.index_for_authority(subauthority)
-        term = doc[index].first
-        if doc['type'] == 'alt'
-          term += ' USE ' + doc['auth']
+      def parse_authority_response(raw_response)
+        raw_response['response']['docs'].map do |doc|
+          index = AssignFast.index_for_authority(subauthority)
+          term = doc[index].first
+          term += ' USE ' + doc['auth'] if doc['type'] == 'alt'
+          { id: doc['idroot'], label: term, value: doc['auth'] }
         end
-        { id: doc['idroot'], label: term, value: doc['auth'] }
       end
-    end
-
   end
 end

data/lib/qa/authorities/assign_fast_subauthority.rb

@@ -1,6 +1,5 @@
 # Encapsulate information about assignFAST subauthorities
 module Qa::Authorities::AssignFastSubauthority
-
   # Hash of subauthority names used in qa routes => 'index' used by API
   Subauthorities = {
     'all'        => 'suggestall',
@@ -10,8 +9,8 @@ module Qa::Authorities::AssignFastSubauthority
     'uniform'    => 'suggest30',
     'topical'    => 'suggest50',
     'geographic' => 'suggest51',
-    'form_genre' => 'suggest55',
-  }
+    'form_genre' => 'suggest55'
+  }.freeze
 
   # Get a list of subauthorities by name
   #
@@ -24,8 +23,7 @@ module Qa::Authorities::AssignFastSubauthority
   #
   # @param [String] English name
   # @return [String] index name
-  def index_for_authority authority
+  def index_for_authority(authority)
     Subauthorities[authority]
   end
-
 end

data/lib/qa/authorities/authority_with_sub_authority.rb

@@ -1,7 +1,6 @@
 module Qa::Authorities
   module AuthorityWithSubAuthority
-
-    def new(subauthority=nil)
+    def new(subauthority = nil)
       raise "Initializing with as sub authority is removed. use #{self.class}.subauthority_for(#{subauthority.inspect}) instead"
     end
 

data/lib/qa/authorities/base.rb

@@ -15,13 +15,12 @@ module Qa::Authorities
     # If the subclassed authority does have this feature
     # then you will overide the #find method in the subclassed authority.
     # TODO: need to set some kind of error here
-    def find id
+    def find(id)
     end
 
-    def full_record id, subauthority=nil
+    def full_record(id, _subauthority = nil)
       Deprecation.warn(".full_record is deprecated. Use .find instead")
       find(id)
     end
-
   end
 end

data/lib/qa/authorities/geonames.rb

@@ -4,11 +4,11 @@ module Qa::Authorities
 
     class_attribute :username, :label
 
-    self.label = -> (item) do
+    self.label = lambda do |item|
       [item['name'], item['adminName1'], item['countryName']].compact.join(', ')
     end
 
-    def search q
+    def search(q)
       unless username
         Rails.logger.error "Questioning Authority tried to call geonames, but no username was set"
         return []
@@ -21,7 +21,7 @@ module Qa::Authorities
       get_json(*args)
     end
 
-    def build_query_url q
+    def build_query_url(q)
       query = URI.escape(untaint(q))
       "http://api.geonames.org/searchJSON?q=#{query}&username=#{username}&maxRows=10"
     end
@@ -30,23 +30,22 @@ module Qa::Authorities
       q.gsub(/[^\w\s-]/, '')
     end
 
-    def find id
+    def find(id)
       json(find_url(id))
     end
 
-    def find_url id
+    def find_url(id)
       "http://www.geonames.org/getJSON?geonameId=#{id}&username=#{username}"
     end
 
     private
 
-    # Reformats the data received from the service
-    def parse_authority_response(response)
-      response['geonames'].map do |result|
-        { 'id' => "http://sws.geonames.org/#{result['geonameId']}",
-          'label' => label.call(result) }
+      # Reformats the data received from the service
+      def parse_authority_response(response)
+        response['geonames'].map do |result|
+          { 'id' => "http://sws.geonames.org/#{result['geonameId']}",
+            'label' => label.call(result) }
+        end
       end
-    end
-
   end
 end

data/lib/qa/authorities/getty.rb

@@ -8,19 +8,18 @@ module Qa::Authorities
     extend AuthorityWithSubAuthority
 
     def self.subauthorities
-      [ "aat" , "tgn", "ulan" ]
+      ["aat", "tgn", "ulan"]
     end
 
     def self.subauthority_class(subauthority)
       case subauthority
-        when 'aat'
-          AAT
-        when 'tgn'
-          TGN
-        when 'ulan'
-          Ulan
+      when 'aat'
+        AAT
+      when 'tgn'
+        TGN
+      when 'ulan'
+        Ulan
       end
     end
   end
 end
-