lol_dba 2.1.5 → 2.1.6

data/spec/associations_index_spec.rb

@@ -1,89 +1,76 @@
-require 'spec_helper'
+RSpec.describe 'Collect indexes based on associations:' do
+  let (:indexes) { LolDba::IndexFinder.check_for_indexes }
 
-RSpec.describe "Collect indexes based on associations:" do
+  it 'find relationship indexes' do
+    expect(indexes).not_to be_empty
 
-  before :all do
-    lol_dba = LolDba.check_for_indexes
-    @relationship_indexes = lol_dba[0]
-    @warning_messages = lol_dba[1]
+    expect(indexes).to have_key('companies')
+    expect(indexes).to have_key('companies_freelancers')
+    expect(indexes).to have_key('addresses')
+    expect(indexes).to have_key('purchases')
   end
 
-  it "find relationship indexes" do
-    expect(@relationship_indexes).not_to be_empty
-
-    expect(@relationship_indexes).to have_key("companies")
-    expect(@relationship_indexes).to have_key("companies_freelancers")
-    expect(@relationship_indexes).to have_key("addresses")
-    expect(@relationship_indexes).to have_key("purchases")
-  end
-
-  it "find indexes for belongs_to" do
-    expect(@relationship_indexes["addresses"]).to include("country_id")
-    expect(@relationship_indexes["favourites"]).to include("user_id")
+  it 'find indexes for belongs_to' do
+    expect(indexes['addresses']).to include('country_id')
+    expect(indexes['favourites']).to include('user_id')
   end
 
-  it "find indexes for polymorphic belongs_to" do
-    expect(@relationship_indexes["addresses"]).to include(["addressable_id", "addressable_type"])
+  it 'find indexes for polymorphic belongs_to' do
+    expect(indexes['addresses']).to include(%w[addressable_id addressable_type])
   end
 
-  it "find indexes for belongs_to with custom foreign key" do
-    expect(@relationship_indexes["companies"]).to include("owner_id")
+  it 'find indexes for belongs_to with custom foreign key' do
+    expect(indexes['companies']).to include('owner_id')
   end
 
-  it "find indexes for has_and_belongs_to_many" do
-    expect(@relationship_indexes["companies_freelancers"]).to include(["company_id", "freelancer_id"])
-    expect(@relationship_indexes["companies_freelancers"]).not_to include(["freelancer_id", "company_id"])
+  it 'find indexes for has_and_belongs_to_many' do
+    expect(indexes['companies_freelancers']).to include(%w[company_id freelancer_id])
+    expect(indexes['companies_freelancers']).not_to include(%w[freelancer_id company_id])
   end
 
-  it "find indexes for has_and_belongs_to_many with custom join_table, primary and foreign keys" do
-    expect(@relationship_indexes["purchases"]).to include(["buyer_id", "present_id"])
+  it 'find indexes for has_and_belongs_to_many with custom join_table, primary and foreign keys' do
+    expect(indexes['purchases']).to include(%w[buyer_id present_id])
   end
 
   it "find indexes for has_and_belongs_to_many but don't create the left_side index" do
-    expect(@relationship_indexes["purchases"]).not_to include("left_side_id")
-  end
-
-  it "do not add an already existing index" do
-    expect(@relationship_indexes["companies"]).not_to include("country_id")
+    expect(indexes['purchases']).not_to include('left_side_id')
   end
 
-  it "find indexes for has_many :through" do
-    expect(@relationship_indexes["billable_weeks"]).to include("remote_worker_id", "timesheet_id")
-    expect(@relationship_indexes["billable_weeks"]).not_to include(["billable_week_id", "remote_worker_id"])
+  it 'do not add an already existing index' do
+    expect(indexes['companies']).not_to include('country_id')
   end
 
-  it "find indexes for has_many :through with source and foreign key" do
-    expect(@relationship_indexes["complex_billable_week"]).to include(["freelancer_id", "id_complex_timesheet"])
+  it 'find indexes for has_many :through' do
+    expect(indexes['billable_weeks']).to include('remote_worker_id', 'timesheet_id')
+    expect(indexes['billable_weeks']).not_to include(%w[billable_week_id remote_worker_id])
   end
 
-  it "do not include wrong class" do
-    expect(@relationship_indexes["wrongs"]).to be_nil
-    expect(@relationship_indexes["addresses_wrongs"]).to be_nil
+  it 'find indexes for has_many :through with source and foreign key' do
+    expect(indexes['complex_billable_week']).to include(%w[freelancer_id id_complex_timesheet])
   end
 
-  it "have warnings(non-existent table) on test data" do
-    expect(@warning_messages).not_to be_empty
-    expect(@warning_messages).to match(/\'wrongs\'/)
-    expect(@warning_messages).to match(/\'addresses_wrongs\'/)
+  it 'do not include wrong class' do
+    expect(indexes['wrongs']).to be_nil
+    expect(indexes['addresses_wrongs']).to be_nil
   end
 
-  it "find indexes for STI" do
-    expect(@relationship_indexes["users"]).to include(["id", "type"])
+  it 'find indexes for STI' do
+    expect(indexes['users']).to include(%w[id type])
   end
 
-  it "find indexes for STI with custom inheritance column" do
-    expect(@relationship_indexes["freelancers"]).to include(["id", "worker_type"])
+  it 'find indexes for STI with custom inheritance column' do
+    expect(indexes['freelancers']).to include(%w[id worker_type])
   end
 
-  it "find indexes, than use custom class name option in association" do
-    expect(@relationship_indexes["employers_freelancers"]).to be_nil
-    expect(@relationship_indexes["companies_freelancers"]).to include(["company_id", "freelancer_id"])
-    expect(@relationship_indexes["companies_freelancers"]).not_to include(["freelancer_id", "company_id"])
+  it 'find indexes, than use custom class name option in association' do
+    expect(indexes['employers_freelancers']).to be_nil
+    expect(indexes['companies_freelancers']).to include(%w[company_id freelancer_id])
+    expect(indexes['companies_freelancers']).not_to include(%w[freelancer_id company_id])
   end
 
-  it "create index for HABTM with polymorphic relationship" do
-    expect(@relationship_indexes["favourites"]).to include(["favourable_id", "favourable_type"])
-    expect(@relationship_indexes["favourites"]).not_to include(["project_id", "user_id"])
-    expect(@relationship_indexes["favourites"]).not_to include(["project_id", "worker_user_id"])
+  it 'create index for HABTM with polymorphic relationship' do
+    expect(indexes['favourites']).to include(%w[favourable_id favourable_type])
+    expect(indexes['favourites']).not_to include(%w[project_id user_id])
+    expect(indexes['favourites']).not_to include(%w[project_id worker_user_id])
   end
 end

data/spec/fixtures/app/models/address.rb

@@ -1,5 +1,4 @@
 class Address < ActiveRecord::Base
-
   belongs_to :addressable, polymorphic: true
   belongs_to :country
 end

data/spec/fixtures/app/models/billable_week.rb

@@ -1,6 +1,4 @@
 class BillableWeek < ActiveRecord::Base
-
-  belongs_to :remote_worker, class_name: "Freelancer"
+  belongs_to :remote_worker, class_name: 'Freelancer'
   belongs_to :timesheet
-
 end

data/spec/fixtures/app/models/company.rb

@@ -1,5 +1,4 @@
 class Company < ActiveRecord::Base
-
   belongs_to :owner, foreign_key: :owner_id, class_name: 'User'
   belongs_to :country
 

data/spec/fixtures/app/models/complex_billable_week.rb

@@ -5,5 +5,4 @@ class ComplexBillableWeek < ActiveRecord::Base
 
   belongs_to :slave, class_name: 'Freelancer'
   belongs_to :complex_timesheet, foreign_key: :id_complex_timesheet
-
 end

data/spec/fixtures/app/models/complex_timesheet.rb

@@ -3,5 +3,4 @@ class ComplexTimesheet < ActiveRecord::Base
 
   has_many :complex_billable_weeks, foreign_key: :id_complex_timesheet
   has_many :workers, through: :complex_billable_weeks, source: :slave
-
 end

data/spec/fixtures/app/models/country.rb

@@ -1,4 +1,4 @@
 class Country < ActiveRecord::Base
   has_many :addresses
   has_many :companies
-end
+end

data/spec/fixtures/app/models/favourite.rb

@@ -1,6 +1,4 @@
 class Favourite < ActiveRecord::Base
-
   belongs_to :user
   belongs_to :favourable, polymorphic: true
-
 end

data/spec/fixtures/app/models/freelancer.rb

@@ -1,8 +1,7 @@
 class Freelancer < ActiveRecord::Base
-
   self.inheritance_column = 'worker_type'
   # use for testing custom class_name FK
-  has_and_belongs_to_many :employers, class_name: "Company"
+  has_and_belongs_to_many :employers, class_name: 'Company'
 
   has_many :billable_weeks, foreign_key: :remote_worker_id
   has_many :timesheets, through: :billable_weeks
@@ -10,5 +9,4 @@ class Freelancer < ActiveRecord::Base
   # Use for testing custom has_many :through
   has_many :complex_billable_weeks
   has_many :complex_timesheets, through: :complex_billable_weeks
-
 end

data/spec/fixtures/app/models/gift.rb

@@ -1,6 +1,4 @@
 class Gift < ActiveRecord::Base
-
   self.primary_key = :custom_primary_key
   has_and_belongs_to_many :users, join_table: :purchases, association_foreign_key: :buyer_id, foreign_key: :present_id
-
 end

data/spec/fixtures/app/models/god.rb

@@ -1,3 +1,3 @@
 class God < ActiveRecord::Base
   self.abstract_class = true
-end
+end

data/spec/fixtures/app/models/project.rb

@@ -1,6 +1,4 @@
 class Project < ActiveRecord::Base
-
   belongs_to :user
   has_many :favourites, as: :favourable
-
 end

data/spec/fixtures/app/models/timesheet.rb

@@ -1,6 +1,4 @@
 class Timesheet < ActiveRecord::Base
-
-  has_many :paiment_weeks, class_name: "BillableWeek"
+  has_many :paiment_weeks, class_name: 'BillableWeek'
   has_many :remote_workers, through: :paiment_weeks
-
 end

data/spec/fixtures/app/models/user.rb

@@ -1,5 +1,4 @@
 class User < ActiveRecord::Base
-
   has_one :company, foreign_key: :owner_id
   has_one :address, as: :addressable
 
@@ -10,5 +9,4 @@ class User < ActiveRecord::Base
   has_many :favourite_projects, through: :favourites, source: :favourable, source_type: 'Project'
 
   validates_uniqueness_of :name
-
 end

data/spec/fixtures/app/models/worker.rb

@@ -1,4 +1,3 @@
 # Check custom STI
 class Worker < Freelancer
-
 end

data/spec/fixtures/app/models/worker_user.rb

@@ -1,4 +1,3 @@
-#Test STI
+# Test STI
 class WorkerUser < User
-
-end
+end

data/spec/fixtures/schema.rb

@@ -1,91 +1,91 @@
 ActiveRecord::Schema.define do
-  create_table "users", :force => true do |t|
-    t.column "name",  :string
-    t.column "email", :string
-    t.column "type",  :string
+  create_table 'users', force: true do |t|
+    t.column 'name',  :string
+    t.column 'email', :string
+    t.column 'type',  :string
   end
 
-  create_table "companies", :force => true do |t|
-    t.column "name",  :text
-    t.column "owned_id", :integer
-    t.column "country_id", :integer
+  create_table 'companies', force: true do |t|
+    t.column 'name',  :text
+    t.column 'owned_id', :integer
+    t.column 'country_id', :integer
   end
 
   add_index :companies, :country_id
 
-  create_table "addresses", :force => true do |t|
-    t.column "addressable_type", :string
-    t.column "addressable_id", :integer
-    t.column "address", :text
-    t.column "country_id", :integer
+  create_table 'addresses', force: true do |t|
+    t.column 'addressable_type', :string
+    t.column 'addressable_id', :integer
+    t.column 'address', :text
+    t.column 'country_id', :integer
   end
 
-  create_table "freelancers", :force => true do |t|
-    t.column "name", :string
-    t.column "price_per_hour", :integer
+  create_table 'freelancers', force: true do |t|
+    t.column 'name', :string
+    t.column 'price_per_hour', :integer
     t.column 'worker_type', :string
   end
 
-  create_table "timesheets", :force => true do |t|
-    t.column "price_per_hour", :integer
-    t.column "hours", :integer
+  create_table 'timesheets', force: true do |t|
+    t.column 'price_per_hour', :integer
+    t.column 'hours', :integer
   end
 
-  create_table "complex_timesheets", :force => true do |t|
-    t.column "price_per_hour", :integer
-    t.column "hours", :integer
+  create_table 'complex_timesheets', force: true do |t|
+    t.column 'price_per_hour', :integer
+    t.column 'hours', :integer
   end
 
-  create_table "billable_weeks", :force => true do |t|
-    t.column "date", :date
-    t.column "timesheet_id", :integer
-    t.column "remote_worker_id", :integer
+  create_table 'billable_weeks', force: true do |t|
+    t.column 'date', :date
+    t.column 'timesheet_id', :integer
+    t.column 'remote_worker_id', :integer
   end
 
-  create_table "complex_billable_week", :force => true do |t|
-    t.column "date", :date
-    t.column "id_complex_timesheet", :integer
-    t.column "freelancer_id", :integer
+  create_table 'complex_billable_week', force: true do |t|
+    t.column 'date', :date
+    t.column 'id_complex_timesheet', :integer
+    t.column 'freelancer_id', :integer
   end
 
-  create_table "companies_freelancers", :id => false, :force => true do |t|
-    t.column "freelancer_id", :integer
-    t.column "company_id", :integer
+  create_table 'companies_freelancers', id: false, force: true do |t|
+    t.column 'freelancer_id', :integer
+    t.column 'company_id', :integer
   end
 
-  create_table "gifts", :primary_key => "custom_primary_key", :force => true do |t|
-    t.column "name", :string
-    t.column "price", :integer
+  create_table 'gifts', primary_key: 'custom_primary_key', force: true do |t|
+    t.column 'name', :string
+    t.column 'price', :integer
   end
 
-  create_table "purchases", :id => false, :force => true do |t|
-    t.column "present_id", :integer
-    t.column "buyer_id", :integer
+  create_table 'purchases', id: false, force: true do |t|
+    t.column 'present_id', :integer
+    t.column 'buyer_id', :integer
   end
 
-  create_table "countries", :force => true do |t|
-    t.column "name", :string
+  create_table 'countries', force: true do |t|
+    t.column 'name', :string
   end
 
-  create_table "components", force: :cascade do |t|
+  create_table 'components', force: :cascade do |t|
   end
 
-  create_table "group_components", force: :cascade do |t|
-    t.column "group_id",   :integer
-    t.column "component_id", :integer
+  create_table 'group_components', force: :cascade do |t|
+    t.column 'group_id', :integer
+    t.column 'component_id', :integer
   end
 
-  create_table "groups", force: :cascade do |t|
+  create_table 'groups', force: :cascade do |t|
   end
 
-  create_table "projects", :force => true do |t|
-    t.column "name", :string
-    t.column "user_id", :integer
+  create_table 'projects', force: true do |t|
+    t.column 'name', :string
+    t.column 'user_id', :integer
   end
 
-  create_table "favourites", :force => true do |t|
-    t.column "user_id", :integer
-    t.column "favourable_id", :integer
-    t.column "favourable_type", :string
+  create_table 'favourites', force: true do |t|
+    t.column 'user_id', :integer
+    t.column 'favourable_id', :integer
+    t.column 'favourable_type', :string
   end
 end

data/spec/migration_formatter_spec.rb

@@ -0,0 +1,66 @@
+RSpec.describe LolDba::MigrationFormatter do
+  describe '#migration_instructions' do
+    subject(:formatter) { LolDba::MigrationFormatter.new('') }
+    let(:index_to_add) { ['add_index :report, :_id_test_plan'] }
+
+    it 'print migration skeleton with set name' do
+      migration = formatter.migration_instructions(index_to_add)
+      expect(migration).to match(/class AddMissingIndexes/i)
+    end
+
+    it 'print migration with add_keys params' do
+      migration = formatter.migration_instructions(index_to_add)
+      expect(migration).to match(/add_index :report, :_id_test_plan/i)
+    end
+  end
+
+  describe '#format_for_migration' do
+    subject(:formatter) { LolDba::MigrationFormatter.new('') }
+
+    it 'return data for migrations for non-indexed single key in table' do
+      relationship_indexes = { users: [:user_id] }
+
+      add_indexes = formatter.format_for_migration(relationship_indexes)
+
+      expect(add_indexes.first).to eq('add_index :users, :user_id')
+    end
+
+    it 'return data for migrations for non-indexed composite key in table' do
+      relationship_indexes = { friends: [%i[user_id friend_id]] }
+
+      add_indexes = formatter.format_for_migration(relationship_indexes)
+
+      expect(add_indexes.first).to eq('add_index :friends, [:user_id, :friend_id]')
+    end
+
+    it 'ignore empty or nil keys for table' do
+      relationship_indexes = { table: [''], table2: [nil] }
+      add_indexes = formatter.format_for_migration(relationship_indexes)
+
+      expect(add_indexes).to be_empty
+    end
+  end
+
+  describe '#puts_migration_content' do
+    before do
+      @indexes = LolDba::IndexFinder.check_for_indexes
+    end
+
+    it 'print migration code' do
+      expect($stdout).to receive(:puts).with(/AddMissingIndexes/i)
+      LolDba::MigrationFormatter.new(@indexes).puts_migration_content
+    end
+
+    it 'print warning messages if they exist' do
+      warning = 'warning text here'
+      expect($stdout).to receive(:puts)
+
+      LolDba::MigrationFormatter.new({}).puts_migration_content
+    end
+
+    it 'print nothing if no indexes and warning messages exist' do
+      expect($stdout).to receive(:puts).with('Yey, no missing indexes found!')
+      LolDba::MigrationFormatter.new({}).puts_migration_content
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,16 +1,20 @@
+require 'bundler/setup'
 require 'rails/all'
 require 'lol_dba'
+require 'simplecov'
 
-ENV["RAILS_ENV"] ||= 'test'
+ENV['RAILS_ENV'] ||= 'test'
+
+SimpleCov.start
 
 ActiveRecord::Base.establish_connection(
-  :adapter  => "sqlite3",
-  :database => ":memory:"
+  adapter: 'sqlite3',
+  database: ':memory:'
 )
 
 module Rails
   def self.root
-    "spec/fixtures/"
+    'spec/fixtures/'
   end
 end
 Dir.glob("#{Rails.root}/app/models/*.rb").sort.each { |file| require_dependency file }
@@ -20,15 +24,19 @@ load 'fixtures/schema.rb'
 
 root_dir = File.dirname(__FILE__)
 
-#add current dir to the load path
-$:.unshift('.')
+# add current dir to the load path
+$LOAD_PATH.unshift('.')
+
 RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+    c.include_chain_clauses_in_custom_matcher_descriptions = true
   end
+
   config.mock_with :rspec do |mocks|
     mocks.allow_message_expectations_on_nil = true
     mocks.verify_partial_doubles = true
   end
-  config.disable_monkey_patching!
 end

data/spec/sql_generator_spec.rb

@@ -0,0 +1,9 @@
+RSpec.describe LolDba::SqlGenerator do
+  before do
+    FileUtils.mkdir_p(Pathname.new(Rails.root).join('db', 'migrate_sql'))
+  end
+
+  it 'generates migrations without error' do
+    expect { LolDba::SqlGenerator.new('all').run }.not_to raise_error
+  end
+end