qa 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04f7b6155dd96973d581100cf2a1dd4a3d354a9e
-  data.tar.gz: fb7def7c149256be271a7b95de1d784f089218f7
+  metadata.gz: debb1457464aa8c952a8bc130618d1edcf86e7df
+  data.tar.gz: 93d2a32f54288ce095f2efd3ea322fe190c9f453
 SHA512:
-  metadata.gz: 0a19a175ac1cb3b84fd9af171a426229bf0b757c3daf5a1f76dd95fc6074ed8950f233d97aaaeba0d127f0e0eb7e7fedbeb304f530abf82036a1947d0a46b71a
-  data.tar.gz: 52cea5dc60f4758990f9bc8c73652c1f7396abd9d3b894d0357ae912e794f9e526a8ef2cfa35ead7aca8129a1c16611541fc0fdb1029e1c02cb30754b7b04bc1
+  metadata.gz: 3f0664726f8224d72fa6b75f53d410c3f760dda40983fb7743c8dcd2e750fba8791042adbd883978b9b90ce12a9b8fafd4e2138f64efafc4632b672b02c93dfa
+  data.tar.gz: f00430c377ba7ad6e886ae5a6a4960d6f306ebb6c6222427350f7899ef3ad702bb1b2a9dcdd88022e1dc857930946afe502eb8b342d3411f692b1b09b8edc783

data/README.md

@@ -154,7 +154,7 @@ Make sure you register an account and enable it to see search results.
 Ensure you can run a query like this:
 
 ```
-http://api.geonames.org/searchJSON?q=port&&maxRows=10username=MY_ACCOUNT_NAME
+http://api.geonames.org/searchJSON?q=port&&maxRows=10&username=MY_ACCOUNT_NAME
 ```
 
 Then you can set your username like this:
@@ -238,6 +238,12 @@ Run the generator to install configuration files and an example authority.
     rails generate qa:local:tables
     rake db:migrate
 
+
+  **Note: If you are using MYSQL as your database use the MSQL database generator instead**  
+
+    rails generate qa:local:tables:mysql
+    rake db:migrate
+
 This will create two tables/models Qa::LocalAuthority and Qa::LocalAuthorityEntry. You can then add terms to each:
 
     language_auth = Qa::LocalAuthority.find_or_create_by(name: 'language')
@@ -253,10 +259,14 @@ Unfortunately, Rails doesn't have a mechnism for adding functional indexes to ta
     CREATE INDEX "index_qa_local_authority_entries_on_lower_label" ON 
       "qa_local_authority_entries" (local_authority_id, lower(label))
 
+  **Note: If you are using MYSQL as your database and used the MSQL database gerator we tried to execute the correct SQL to create the virtual fields and indexes for you**  
+
 Finall you want register your authority in an initializer:
 
     Qa::Authorities::Local.register_subauthority('languages', 'Qa::Authorities::Local::TableBasedAuthority')
 
+  **Note: If you are using MYSQL as your database and used the MSQL database gerator register the MysqlTableBasedAuthority instead of the TableBasedAuthority**  
+
 Then you can search for 
 
     /qa/search/local/languages?q=Fre
@@ -269,7 +279,6 @@ The entire list (up to the first 1000 terms) can also be returned using:
 
     /qa/terms/local/languages/
 
-
 ### Medical Subject Headings (MeSH)
 
 Provides autocompletion of [MeSH terms](http://www.nlm.nih.gov/mesh/introduction.html). This

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

@@ -0,0 +1,43 @@
+require 'rails/generators/active_record/migration'
+module Qa::Local
+  module Tables
+    class MysqlGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      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)
+          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 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)
+        gsub_file migration_file,
+                  't.references :local_authority, index: true, foreign_key: true',
+                  't.integer :local_authority_id, index: true'
+        insert_into_file migration_file, after: "add_index :qa_local_authority_entries, :uri, unique: true" do
+          "\n    add_foreign_key :qa_local_authority_entries, :qa_local_authorities, column: :local_authority_id\n" \
+          "    if ActiveRecord::Base.connection.instance_of? ActiveRecord::ConnectionAdapters::Mysql2Adapter\n"  \
+          "       remove_column :qa_local_authority_entries, :lower_label, :string\n" \
+          "       execute(\"alter table qa_local_authority_entries add lower_label varchar(256) GENERATED ALWAYS AS (lower(label)) VIRTUAL\")\n" \
+          "    end\n" \
+          "    add_index :qa_local_authority_entries, [:lower_label, :local_authority_id], name: 'index_qa_local_authority_entries_on_lower_label_and_authority'"
+        end
+
+        message = "Rails doesn't support functional indexes in migrations, so we inserted an exec into the migration since you are specifying you are running with mysql.\n" \
+                  "The excute will not be run for another database.  The commands being run are: "\
+                  " 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)"
+
+        say_status("info", message, :yellow)
+      end
+    end
+  end
+end
+

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

@@ -5,8 +5,20 @@ module Qa::Local
     include ActiveRecord::Generators::Migration
 
     def migrations
+      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)
+      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'
+
       message = "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" \

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

@@ -0,0 +1,23 @@
+module Qa
+  module Authorities
+    module Local
+      #
+      class MysqlTableBasedAuthority < Local::TableBasedAuthority
+        def self.check_for_index
+          conn = ActiveRecord::Base.connection
+          if conn.table_exists?('qa_local_authority_entries') && 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)'
+          end
+        end
+
+        def search(q)
+          return [] if q.blank?
+          output_set(base_relation.where('lower_label like ?', "#{q.downcase}%").limit(25))
+        end
+      end
+    end
+  end
+end

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

@@ -7,6 +7,7 @@ module Qa::Authorities
           "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."
       end
     end
 

data/lib/qa/authorities/local.rb

@@ -5,6 +5,7 @@ module Qa::Authorities
     autoload :FileBasedAuthority
     autoload :Registry
     autoload :TableBasedAuthority
+    autoload :MysqlTableBasedAuthority
 
     def self.config
       @config

data/lib/qa/version.rb

@@ -1,3 +1,3 @@
 module Qa
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/spec/lib/authorities/mysql_table_based_authority_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Qa::Authorities::Local::MysqlTableBasedAuthority do
+  let(:language) { Qa::Authorities::Local.subauthority_for("language") }
+  let(:language_auth) { Qa::LocalAuthority.find_by(name: 'language') }
+  let(:base_relation) { Qa::LocalAuthorityEntry.where(name: 'language') }
+  before do
+    Qa::Authorities::Local.register_subauthority('language', described_class.to_s)
+  end
+
+  describe "#check_for_index" do
+    let(:connection) { ActiveRecord::Base.connection }
+    before do
+      allow(ActiveRecord::Base).to receive(:connection).and_return(connection)
+    end
+    context "with no index" do
+      before do
+        #allow(connection).to receive(:index_name_exists?).and_return(nil)
+      end
+      it "outputs an error message" do
+        expect(Rails.logger).to receive(:error)
+        described_class.check_for_index
+      end
+    end
+    context "with index" do
+      before do
+        allow(connection).to receive(:index_name_exists?).and_return(true)
+      end
+      it "outputs an error message" do
+        expect(Rails.logger).not_to receive(:error)
+        described_class.check_for_index
+      end
+    end
+  end
+
+  describe "#search" do
+    context "with an empty query string" do
+      let(:expected) { [] }
+      it "should return no results" do
+        expect(Qa::LocalAuthorityEntry).not_to receive(:where)
+        expect(language.search("")).to eq(expected)
+      end
+    end
+    context "with at least one matching entry" do
+      it "is case insensitive by using lower_lable column" do
+        expect(Qa::LocalAuthorityEntry).to receive(:where).with(local_authority: language_auth).and_return(base_relation)
+        expect(base_relation).to receive(:where).with("lower_label like ?","fre%").and_return(base_relation)
+        expect(base_relation).to receive(:limit).and_return([])
+        language.search("fRe")
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qa
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Stephen Anderson
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -23,20 +23,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -209,6 +209,7 @@ files:
 - lib/generators/qa/install/templates/config/oclcts-authorities.yml
 - lib/generators/qa/local/USAGE
 - lib/generators/qa/local/files/files_generator.rb
+- lib/generators/qa/local/tables/mysql/mysql_generator.rb
 - lib/generators/qa/local/tables/tables_generator.rb
 - lib/generators/qa/local/tables/templates/add_index_to_local_authorities.rb
 - lib/generators/qa/local/templates/config/authorities.yml
@@ -230,6 +231,7 @@ files:
 - lib/qa/authorities/loc_subauthority.rb
 - lib/qa/authorities/local.rb
 - lib/qa/authorities/local/file_based_authority.rb
+- lib/qa/authorities/local/mysql_table_based_authority.rb
 - lib/qa/authorities/local/registry.rb
 - lib/qa/authorities/local/table_based_authority.rb
 - lib/qa/authorities/mesh.rb
@@ -280,6 +282,7 @@ files:
 - spec/lib/authorities/loc_spec.rb
 - spec/lib/authorities/local_spec.rb
 - spec/lib/authorities/mesh_spec.rb
+- spec/lib/authorities/mysql_table_based_authority_spec.rb
 - spec/lib/authorities/oclcts_spec.rb
 - spec/lib/authorities/table_based_authority_spec.rb
 - spec/lib/authorities/tgnlang_spec.rb
@@ -350,6 +353,7 @@ test_files:
 - spec/lib/authorities/loc_spec.rb
 - spec/lib/authorities/local_spec.rb
 - spec/lib/authorities/mesh_spec.rb
+- spec/lib/authorities/mysql_table_based_authority_spec.rb
 - spec/lib/authorities/oclcts_spec.rb
 - spec/lib/authorities/table_based_authority_spec.rb
 - spec/lib/authorities/tgnlang_spec.rb
@@ -360,4 +364,3 @@ test_files:
 - spec/routing/route_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/lib/generators/test_app_generator.rb
-has_rdoc: