active_record_doctor 1.1.1 → 1.2.0

data/test/support/spy_printer.rb

@@ -1,9 +1,10 @@
 class SpyPrinter
-  attr_reader :unindexed_foreign_keys, :extraneous_indexes
+  attr_reader :unindexed_foreign_keys, :extraneous_indexes, :indexed_primary_key
 
   def initialize
     @unindexed_foreign_keys = nil
     @extraneous_indexes = nil
+    @indexed_primary_key = nil
   end
 
   def print_unindexed_foreign_keys(argument)
@@ -21,4 +22,12 @@ class SpyPrinter
       @extraneous_indexes = argument
     end
   end
+
+  def print_indexed_primary_keys(argument)
+    if @extraneous_indexes
+      fail("indexed_primary_key cannot be called twice")
+    else
+      @indexed_primary_key = argument
+    end
+  end
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: active_record_doctor
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Greg Navis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '11.1'
 description: 
@@ -73,70 +73,73 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/generators/active_record_doctor/add_indexes/add_indexes_generator.rb
-- lib/generators/active_record_doctor/add_indexes/USAGE
-- lib/active_record_doctor/railtie.rb
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_record_doctor.rb
 - lib/active_record_doctor/printers.rb
 - lib/active_record_doctor/printers/io_printer.rb
+- lib/active_record_doctor/railtie.rb
 - lib/active_record_doctor/tasks.rb
-- lib/active_record_doctor/version.rb
 - lib/active_record_doctor/tasks/extraneous_indexes.rb
 - lib/active_record_doctor/tasks/unindexed_foreign_keys.rb
-- lib/active_record_doctor.rb
+- lib/active_record_doctor/version.rb
+- lib/generators/active_record_doctor/add_indexes/USAGE
+- lib/generators/active_record_doctor/add_indexes/add_indexes_generator.rb
 - lib/tasks/active_record_doctor_tasks.rake
-- Rakefile
-- README.rdoc
-- test/test_helper.rb
 - test/active_record_doctor/printers/io_printer_test.rb
 - test/active_record_doctor/tasks/extraneous_indexes_test.rb
 - test/active_record_doctor/tasks/unindexed_foreign_keys_test.rb
 - test/dummy/README.rdoc
-- test/dummy/log/development.log
-- test/dummy/log/test.log
-- test/dummy/bin/rake
-- test/dummy/bin/rails
-- test/dummy/bin/setup
-- test/dummy/bin/bundle
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/models/profile.rb
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/models/comment.rb
 - test/dummy/app/models/employer.rb
+- test/dummy/app/models/profile.rb
 - test/dummy/app/models/user.rb
-- test/dummy/db/schema.rb
-- test/dummy/db/migrate/20160213102131_create_employers.rb
-- test/dummy/db/migrate/20160213101232_create_profiles.rb
-- test/dummy/db/migrate/20160213101213_create_users.rb
-- test/dummy/db/development.sqlite3
-- test/dummy/db/test.sqlite3
-- test/dummy/public/404.html
-- test/dummy/public/500.html
-- test/dummy/public/422.html
-- test/dummy/public/favicon.ico
-- test/dummy/config/secrets.yml
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/bin/setup
+- test/dummy/config.ru
 - test/dummy/config/application.rb
-- test/dummy/config/routes.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
 - test/dummy/config/environments/development.rb
-- test/dummy/config/environments/test.rb
 - test/dummy/config/environments/production.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/database.yml
-- test/dummy/config/locales/en.yml
-- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/assets.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/boot.rb
-- test/dummy/Rakefile
-- test/dummy/config.ru
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/config/secrets.yml
+- test/dummy/db/development.sqlite3
+- test/dummy/db/migrate/20160213101213_create_users.rb
+- test/dummy/db/migrate/20160213101232_create_profiles.rb
+- test/dummy/db/migrate/20160213102131_create_employers.rb
+- test/dummy/db/migrate/20160604081452_create_comments.rb
+- test/dummy/db/schema.rb
+- test/dummy/db/test.sqlite3
+- test/dummy/log/development.log
+- test/dummy/log/test.log
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
 - test/support/spy_printer.rb
-homepage: http://www.gregnavis.com/active-record-doctor/
+- test/test_helper.rb
+homepage: https://github.com/gregnavis/active_record_doctor
 licenses:
 - MIT
 metadata: {}
@@ -146,17 +149,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A cure for your Active Record ailments.
@@ -178,9 +181,11 @@ test_files:
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/models/profile.rb
+- test/dummy/app/models/comment.rb
 - test/dummy/app/models/employer.rb
 - test/dummy/app/models/user.rb
 - test/dummy/db/schema.rb
+- test/dummy/db/migrate/20160604081452_create_comments.rb
 - test/dummy/db/migrate/20160213102131_create_employers.rb
 - test/dummy/db/migrate/20160213101232_create_profiles.rb
 - test/dummy/db/migrate/20160213101213_create_users.rb

data/README.rdoc

@@ -1,84 +0,0 @@
-= Active Record Doctor
-
-Active Record Doctor helps to keep the database in a good shape. Currently, it
-can:
-
-* index unindexed foreign keys
-* detect extraneous indexes
-
-More features coming soon!
-
-Want to suggest a feature? Just shoot me {an email}[mailto:contact@gregnavis.com].
-
-{<img src="https://travis-ci.org/gregnavis/active_record_doctor.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/gregnavis/active_record_doctor]
-
-== Installation
-
-The preferred installation method is adding +active_record_doctor+ to your
-+Gemfile+:
-
-  gem 'active_record_doctor', group: :development
-
-Then run:
-
-  bundle install
-
-== Usage
-
-=== Indexing Unindexed Foreign Keys
-
-Foreign keys should be indexed unless it's proven ineffective. However, Rails
-makes it easy to create an unindexed foreign key. Active Record Doctor can
-automatically generate database migrations that add the missing indexes. It's a
-three-step process:
-
-1. Generate a list of unindexed foreign keys by running
-
-     rake active_record_doctor:unindexed_foreign_keys > unindexed_foreign_keys.txt
-
-2. Remove columns that should _not_ be indexed from +unindexed_foreign_keys.txt+
-   as a column can look like a foreign key (i.e. end with +_id+) without being
-   one.
-
-3. Generate the migrations
-
-     rails generate active_record_doctor:add_indexes unindexed_foreign_keys.txt
-
-4. Run the migrations
-
-     rake db:migrate
-
-=== Removing Extraneous Indexes
-
-Let me illustrate with an example. Consider a +users+ table with columns
-+first_name+ and +last_name+. If there are two indexes:
-
-* A two-column index on +last_name, first_name+.
-* A single-column index on +last_name+.
-
-Then the latter index can be dropped as the former can play its role. In
-general, a multi-column index on +column_1, column_2, ..., column_n+ can replace
-indexes on:
-
-* +column_1+
-* +column_1+, +column_2+
-* ...
-* +column_1+, +column_2+, ..., +column_(n - 1)+
-
-To discover such indexes automatically just follow these steps:
-
-1. List extraneous indexes by running:
-
-    rake active_record_doctor:extraneous_indexes
-
-2. Confirm that each of the indexes can be indeed dropped.
-
-3. Create a migration to drop the indexes.
-
-The indexes aren't dropped automatically because there's usually just a few of
-them and it's a good idea to double-check that you won't drop something
-necessary.
-
-== Author
-
-This gem is developed and maintained by {Greg Navis}[http://www.gregnavis.com].