Merge branch 'develop' into added_gems

Author: ctran

.travis.yml

@@ -16,4 +16,4 @@ matrix:
 before_install:
   - rvm @global do gem install bundler
 script:
-  - bundle exec rspec
+  - bundle exec rubocop && bundle exec rspec

Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rake', '>= 10.4.2', require: false
+gem 'rake', require: false
 gem 'activerecord', '>= 4.2.5', require: false
 gem 'ruby_dep', '1.3.1'
 
@@ -21,6 +21,7 @@ group :development, :test do
   gem 'rubocop', '~> 0.46.0', require: false unless RUBY_VERSION =~ /^1.8/
   gem 'coveralls'
   gem 'codeclimate-test-reporter'
+  gem 'ruby_dep', '1.3.1'
 
   platforms :mri, :mingw do
     gem 'pry', require: false

annotate.gemspec

@@ -26,10 +26,10 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rake>, [">= 10.4", "< 12.0"])
+      s.add_runtime_dependency(%q<rake>, [">= 10.4", "< 12.1"])
       s.add_runtime_dependency(%q<activerecord>, [">= 3.2", "< 6.0"])
     else
-      s.add_dependency(%q<rake>, [">= 10.4", "< 12.0"])
+      s.add_dependency(%q<rake>, [">= 10.4", "< 12.1"])
       s.add_dependency(%q<activerecord>, [">= 3.2", "< 6.0"])
     end
   else

lib/annotate/annotate_models.rb

@@ -181,6 +181,18 @@ def schema_default(klass, column)
       quote(klass.column_defaults[column.name])
     end
 
+    def retrieve_indexes_from_table(klass)
+      table_name = klass.table_name
+      return [] unless table_name
+
+      indexes = klass.connection.indexes(table_name)
+      return indexes if indexes.any? || !klass.table_name_prefix
+
+      # Try to search the table without prefix
+      table_name.to_s.slice!(klass.table_name_prefix)
+      klass.connection.indexes(table_name)
+    end
+
     # Use the column information in an ActiveRecord class
     # to create a comment block containing a line for
     # each column. The line contains the column name,
@@ -244,7 +256,7 @@ def get_schema_info(klass, header, options = {})
         # Check if the column has indices and print "indexed" if true
         # If the index includes another column, print it too.
         if options[:simple_indexes] && klass.table_exists?# Check out if this column is indexed
-          indices = klass.connection.indexes(klass.table_name)
+          indices = retrieve_indexes_from_table(klass)
           if indices = indices.select { |ind| ind.columns.include? col.name }
             indices.sort_by(&:name).each do |ind|
               ind = ind.columns.reject! { |i| i == col.name }
@@ -305,7 +317,7 @@ def get_index_info(klass, options={})
         index_info = "#\n# Indexes\n#\n"
       end
 
-      indexes = klass.connection.indexes(klass.table_name)
+      indexes = retrieve_indexes_from_table(klass)
       return '' if indexes.empty?
 
       max_size = indexes.collect{|index| index.name.size}.max + 1

spec/annotate/annotate_models_spec.rb

@@ -5,6 +5,14 @@
 require 'active_support/core_ext/string'
 
 describe AnnotateModels do
+  def mock_index(name, columns = [], unique = false)
+    double("IndexKeyDefinition",
+           :name          => name,
+           :columns       => columns,
+           :unique        => unique
+    )
+  end
+
   def mock_foreign_key(name, from_column, to_table, to_column = 'id', constraints = {})
     double("ForeignKeyDefinition",
            :name         => name,
@@ -20,21 +28,22 @@ def mock_connection(indexes = [], foreign_keys = [])
     double("Conn",
            :indexes      => indexes,
            :foreign_keys => foreign_keys,
-           :supports_foreign_keys? => true,
+           :supports_foreign_keys? => true
     )
   end
 
-  def mock_class(table_name, primary_key, columns, foreign_keys = [])
+  def mock_class(table_name, primary_key, columns, indexes = [], foreign_keys = [])
     options = {
-      :connection       => mock_connection([], foreign_keys),
+      :connection       => mock_connection(indexes, foreign_keys),
       :table_exists?    => true,
       :table_name       => table_name,
       :primary_key      => primary_key,
       :column_names     => columns.map { |col| col.name.to_s },
       :columns          => columns,
       :column_defaults  => Hash[columns.map { |col|
         [col.name, col.default]
-      }]
+      }],
+      :table_name_prefix => '',
     }
 
     double("An ActiveRecord class", options)
@@ -181,7 +190,7 @@ def mock_column(name, type, options={})
            klass = mock_class(:users, :id, [
               mock_column(:id, :integer),
               mock_column(:foreign_thing_id, :integer),
-            ],
+            ], [],
                               [
                                 mock_foreign_key(
                                   'fk_rails_cf2568e89e',
@@ -220,7 +229,7 @@ def mock_column(name, type, options={})
     klass = mock_class(:users, :id, [
        mock_column(:id, :integer),
        mock_column(:foreign_thing_id, :integer),
-     ],
+     ], [],
                        [
                          mock_foreign_key(
                            'fk_rails_02e851e3b7',
@@ -246,6 +255,44 @@ def mock_column(name, type, options={})
 EOS
   end
 
+  it "should get indexes keys" do
+    klass = mock_class(:users, :id, [
+       mock_column(:id, :integer),
+       mock_column(:foreign_thing_id, :integer),
+     ], [mock_index('index_rails_02e851e3b7', ['id']),
+         mock_index('index_rails_02e851e3b8', ['foreign_thing_id'])])
+    expect(AnnotateModels.get_schema_info(klass, "Schema Info", :show_indexes => true)).to eql(<<-EOS)
+# Schema Info
+#
+# Table name: users
+#
+#  id               :integer          not null, primary key
+#  foreign_thing_id :integer          not null
+#
+# Indexes
+#
+#  index_rails_02e851e3b7  (id)
+#  index_rails_02e851e3b8  (foreign_thing_id)
+#
+EOS
+  end
+
+  it "should not crash getting indexes keys" do
+    klass = mock_class(:users, :id, [
+       mock_column(:id, :integer),
+       mock_column(:foreign_thing_id, :integer),
+     ], [])
+    expect(AnnotateModels.get_schema_info(klass, "Schema Info", :show_indexes => true)).to eql(<<-EOS)
+# Schema Info
+#
+# Table name: users
+#
+#  id               :integer          not null, primary key
+#  foreign_thing_id :integer          not null
+#
+EOS
+  end
+
   it "should get schema info as RDoc" do
     klass = mock_class(:users, :id, [
                                      mock_column(:id, :integer),

spec/spec_helper.rb

@@ -29,8 +29,6 @@
 
 require 'byebug'
 require 'rubocop/rake_task'
-RuboCop::RakeTask.new
-Rake::Task['rubocop'].invoke
 
 module Annotate
   module Integration