mysql_framework 0.0.1

data/spec/lib/mysql_framework/scripts/manager_spec.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe MysqlFramework::Scripts::Manager do
+  let(:connector) { MysqlFramework::Connector.new }
+
+  before :each do
+    subject.instance_variable_set(:@mysql_connector, connector)
+  end
+
+  describe '#execute' do
+    before :each do
+      subject.initialize_script_history
+    end
+
+    it 'executes all pending scripts' do
+      expect(subject.table_exists?('demo')).to eq(false)
+      expect(subject.table_exists?('test')).to eq(false)
+
+      subject.execute
+
+      expect(subject.table_exists?('demo')).to eq(true)
+      expect(subject.table_exists?('test')).to eq(true)
+    end
+
+    after :each do
+      subject.drop_all_tables
+    end
+  end
+
+  describe '#apply_by_tag' do
+    before :each do
+      subject.initialize_script_history
+    end
+
+    it 'executes all pending scripts that match the tag' do
+      expect(subject.table_exists?('demo')).to eq(false)
+      expect(subject.table_exists?('test')).to eq(false)
+
+      subject.apply_by_tag([MysqlFramework::Support::Tables::TestTable::NAME])
+
+      expect(subject.table_exists?('demo')).to eq(false)
+      expect(subject.table_exists?('test')).to eq(true)
+    end
+
+    after :each do
+      subject.drop_all_tables
+    end
+  end
+
+  describe '#drop_all_tables' do
+    it 'drops the script history table and any registered tables' do
+      expect(subject).to receive(:drop_script_history)
+      expect(subject).to receive(:drop_table).with('test')
+      expect(subject).to receive(:drop_table).with('demo')
+
+      subject.drop_all_tables
+    end
+  end
+
+  describe '#retrieve_last_executed_script' do
+    before :each do
+      subject.initialize_script_history
+    end
+
+    context 'when no scripts have been executed' do
+      it 'returns 0' do
+        expect(subject.retrieve_last_executed_script).to eq(0)
+      end
+    end
+
+    context 'when scripts have been executed previously' do
+      before :each do
+        subject.apply_by_tag([MysqlFramework::Support::Tables::TestTable::NAME])
+      end
+
+      it 'returns the last executed script' do
+        expect(subject.retrieve_last_executed_script).to eq(201807031200)
+      end
+    end
+
+    after :each do
+      subject.drop_script_history
+    end
+  end
+
+  describe '#initialize_script_history' do
+    it 'creates a migration history table' do
+      expect(subject.table_exists?('migration_script_history')).to eq(false)
+      subject.initialize_script_history
+      expect(subject.table_exists?('migration_script_history')).to eq(true)
+    end
+  end
+
+  describe '#calculate_pending_scripts' do
+    it 'returns any scripts that are newer than the given date in ascending order' do
+      timestamp = 201701010000 # 00:00 01/01/2017
+      results = subject.calculate_pending_scripts(timestamp)
+
+      expect(results.length).to eq(3)
+      expect(results[0]).to be_a(MysqlFramework::Support::Scripts::CreateTestTable)
+      expect(results[1]).to be_a(MysqlFramework::Support::Scripts::CreateDemoTable)
+    end
+
+    context 'when there are scripts older than the given date' do
+      it 'returns only scripts that are newer than the given date in ascending order' do
+        timestamp = 201802021010 # 10:10 02/02/2018
+        results = subject.calculate_pending_scripts(timestamp)
+
+        expect(results.length).to eq(2)
+        expect(results[0]).to be_a(MysqlFramework::Support::Scripts::CreateDemoTable)
+      end
+    end
+  end
+
+  describe '#table_exists?' do
+    context 'when the table exists' do
+      it 'returns true' do
+        expect(subject.table_exists?('gems')).to eq(true)
+      end
+    end
+
+    context 'when the table does not exist' do
+      it 'returns false' do
+        expect(subject.table_exists?('foo')).to eq(false)
+      end
+    end
+  end
+
+  describe '#drop_script_history' do
+    it 'drops the migration script history table' do
+      query = <<~SQL
+        DROP TABLE IF EXISTS `#{ENV.fetch('MYSQL_DATABASE')}`.`migration_script_history`
+      SQL
+      expect(connector).to receive(:query).with(query)
+      subject.drop_script_history
+    end
+  end
+
+  describe '#drop_table' do
+    it 'drops the given table' do
+      expect(connector).to receive(:query).with(<<~SQL)
+        DROP TABLE IF EXISTS `some_database`.`some_table`
+      SQL
+      subject.drop_table('`some_database`.`some_table`')
+    end
+  end
+
+  describe '#all_tables' do
+    it 'returns all registered tables' do
+      expect(subject.all_tables).to eq(['test', 'demo'])
+    end
+  end
+
+  describe '.all_tables' do
+    it 'stores a class level array of tables' do
+      expect(described_class.all_tables).to eq(['test', 'demo'])
+    end
+  end
+end

data/spec/lib/mysql_framework/sql_column_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe MysqlFramework::SqlColumn do
+  subject { described_class.new(table: 'gems', column: 'version') }
+
+  describe '#to_s' do
+    it 'returns the prepared sql name with backticks' do
+      expect(subject.to_s).to eq('`gems`.`version`')
+    end
+  end
+
+  describe '#to_sym' do
+    it 'returns the column name as a symbol' do
+      expect(subject.to_sym).to eq(:version)
+    end
+  end
+
+  describe '#eq' do
+    it 'returns a SqlCondition for the comparison' do
+      condition = subject.eq('2.0.0')
+      expect(condition).to be_a(MysqlFramework::SqlCondition)
+      expect(condition.to_s).to eq('`gems`.`version` = ?')
+    end
+  end
+
+  describe '#not_eq' do
+    it 'returns a SqlCondition for the comparison' do
+      condition = subject.not_eq('2.0.0')
+      expect(condition).to be_a(MysqlFramework::SqlCondition)
+      expect(condition.to_s).to eq('`gems`.`version` <> ?')
+    end
+  end
+
+  describe '#gt' do
+    it 'returns a SqlCondition for the comparison' do
+      condition = subject.gt('2.0.0')
+      expect(condition).to be_a(MysqlFramework::SqlCondition)
+      expect(condition.to_s).to eq('`gems`.`version` > ?')
+    end
+  end
+
+  describe '#gte' do
+    it 'returns a SqlCondition for the comparison' do
+      condition = subject.gte('2.0.0')
+      expect(condition).to be_a(MysqlFramework::SqlCondition)
+      expect(condition.to_s).to eq('`gems`.`version` >= ?')
+    end
+  end
+
+  describe '#lt' do
+    it 'returns a SqlCondition for the comparison' do
+      condition = subject.lt('2.0.0')
+      expect(condition).to be_a(MysqlFramework::SqlCondition)
+      expect(condition.to_s).to eq('`gems`.`version` < ?')
+    end
+  end
+
+  describe '#lte' do
+    it 'returns a SqlCondition for the comparison' do
+      condition = subject.lte('2.0.0')
+      expect(condition).to be_a(MysqlFramework::SqlCondition)
+      expect(condition.to_s).to eq('`gems`.`version` <= ?')
+    end
+  end
+
+  describe '#as' do
+    it 'returns the column specified as another name' do
+      expect(subject.as('v')).to eq('`gems`.`version` as `v`')
+    end
+  end
+end

data/spec/lib/mysql_framework/sql_condition_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe MysqlFramework::SqlCondition do
+  subject { described_class.new(column: 'version', comparison: '=', value: '1.0.0') }
+
+  describe '#to_s' do
+    it 'returns the condition as a string for a prepared statement' do
+      expect(subject.to_s).to eq('version = ?')
+    end
+  end
+end

data/spec/lib/mysql_framework/sql_query_spec.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe MysqlFramework::SqlQuery do
+  let(:gems) { MysqlFramework::SqlTable.new('gems') }
+  let(:versions) { MysqlFramework::SqlTable.new('versions') }
+
+  describe 'building a query' do
+    it 'builds the insert query as expected' do
+      subject.insert(gems, 15)
+        .into(
+          gems[:name],
+          gems[:author],
+          gems[:created_at],
+          gems[:updated_at]
+        )
+        .values(
+          'mysql_framework',
+          'sage',
+          '2018-06-28 10:00:00',
+          '2018-06-28 10:00:00'
+        )
+
+      expect(subject.sql).to eq('insert into `gems` partition(p15) (`gems`.`name`,`gems`.`author`,`gems`.`created_at`,`gems`.`updated_at`) values (?,?,?,?)')
+      expect(subject.params).to eq(['mysql_framework', 'sage', '2018-06-28 10:00:00', '2018-06-28 10:00:00'])
+    end
+
+    it 'builds the update query as expected' do
+      subject.update(gems, 20)
+        .set(
+          name: 'mysql_framework',
+          updated_at: '2018-06-28 13:00:00'
+        )
+        .where(
+          gems[:id].eq('12345')
+        )
+
+      expect(subject.sql).to eq('update `gems` partition(p20) set `name` = ?, `updated_at` = ? where (`gems`.`id` = ?)')
+      expect(subject.params).to eq(['mysql_framework', '2018-06-28 13:00:00', '12345'])
+    end
+
+    it 'builds the delete query as expected' do
+      subject.delete.from(gems, 30)
+        .where(
+          gems[:id].eq('45678')
+        )
+
+      expect(subject.sql).to eq('delete from `gems` partition(p30) where (`gems`.`id` = ?)')
+      expect(subject.params).to eq(['45678'])
+    end
+
+    it 'builds a basic select query as expected' do
+      subject.select('*')
+        .from(gems, 40)
+        .where(
+          gems[:id].eq('9876')
+        )
+
+      expect(subject.sql).to eq('select * from `gems` partition(p40) where (`gems`.`id` = ?)')
+      expect(subject.params).to eq(['9876'])
+    end
+
+    it 'builds a joined select query as expected' do
+      subject.select('*')
+        .from(gems, 40)
+        .join(versions).on(versions[:gem_id], gems[:id])
+        .where(
+          gems[:id].eq('9876')
+        )
+
+      expect(subject.sql).to eq('select * from `gems` partition(p40) join `versions` on `versions`.`gem_id` = `gems`.`id` where (`gems`.`id` = ?)')
+      expect(subject.params).to eq(['9876'])
+    end
+  end
+
+  describe '#select' do
+    it 'sets the sql for a select statement' do
+      subject.select(gems[:id], gems[:name])
+      expect(subject.sql).to eq('select `gems`.`id`,`gems`.`name`')
+    end
+  end
+
+  describe '#delete' do
+    it 'sets the sql for a delete statement' do
+      subject.delete
+      expect(subject.sql).to eq('delete')
+    end
+  end
+
+  describe '#update' do
+    it 'sets the sql for an update statement' do
+      subject.update(gems)
+      expect(subject.sql).to eq('update `gems`')
+    end
+
+    context 'when a partition is specified' do
+      it 'sets the sql for an update statement' do
+        subject.update(gems, 25)
+        expect(subject.sql).to eq('update `gems` partition(p25)')
+      end
+    end
+  end
+
+  describe '#insert' do
+    it 'sets the sql for an insert statement' do
+      subject.insert(gems)
+      expect(subject.sql).to eq('insert into `gems`')
+    end
+
+    context 'when a partition is specified' do
+      it 'sets the sql for an insert statement' do
+        subject.insert(gems, 35)
+        expect(subject.sql).to eq('insert into `gems` partition(p35)')
+      end
+    end
+  end
+
+  describe '#into' do
+    it 'sets the sql for an into statement' do
+      subject.into(gems[:name], gems[:author], gems[:created_at])
+      expect(subject.sql).to eq('(`gems`.`name`,`gems`.`author`,`gems`.`created_at`)')
+    end
+  end
+
+  describe '#values' do
+    it 'sets the sql for the values statement' do
+      subject.values('mysql_framework', 'sage', '2016-06-28 10:00:00')
+      expect(subject.sql).to eq('values (?,?,?)')
+    end
+  end
+
+  describe '#set' do
+    it 'sets the sql for the set statement' do
+      subject.set(name: 'mysql_framework', author: 'sage', created_at: '2016-06-28 10:00:00')
+      expect(subject.sql).to eq('set `name` = ?, `author` = ?, `created_at` = ?')
+    end
+  end
+
+  describe '#from' do
+    it 'sets the sql for a from statement' do
+      subject.from(gems)
+      expect(subject.sql).to eq('from `gems`')
+    end
+
+    context 'when a partition is specified' do
+      it 'sets the sql for a from statement' do
+        subject.from(gems, 45)
+        expect(subject.sql).to eq('from `gems` partition(p45)')
+      end
+    end
+  end
+
+  describe '#where' do
+    before :each do
+      subject.where(gems['author'].eq('sage'), gems['created_at'].gt('2018-01-01 00:00:00'))
+    end
+
+    it 'appends where to the sql' do
+      expect(subject.sql).to include('where')
+    end
+
+    it 'sets the sql for the where statement' do
+      expect(subject.sql).to eq('where (`gems`.`author` = ? and `gems`.`created_at` > ?)')
+    end
+
+    context 'when the sql already contains a where' do
+      it 'does not append an extra where' do
+        subject.and.where(gems['name'].eq('mysql_framework'))
+        expect(subject.sql).to eq('where (`gems`.`author` = ? and `gems`.`created_at` > ?) and (`gems`.`name` = ?)')
+      end
+    end
+  end
+
+  describe '#and' do
+    it 'appends the sql for an and statement' do
+      subject.and
+      expect(subject.sql).to eq('and')
+    end
+  end
+
+  describe '#or' do
+    it 'appends the sql for an or statement' do
+      subject.or
+      expect(subject.sql).to eq('or')
+    end
+  end
+
+  describe '#order' do
+    it 'appends the sql for an order statement' do
+      subject.order(gems[:created_at], gems[:updated_at])
+      expect(subject.sql).to eq('order by `gems`.`created_at`,`gems`.`updated_at`')
+    end
+  end
+
+  describe '#order_desc' do
+    it 'appends the sql for an order descending statement' do
+      subject.order_desc(gems[:created_at], gems[:updated_at])
+      expect(subject.sql).to eq('order by `gems`.`created_at`,`gems`.`updated_at` desc')
+    end
+  end
+
+  describe '#limit' do
+    it 'appends the sql for a limit statement' do
+      subject.limit(10)
+      expect(subject.sql).to eq('limit 10')
+    end
+  end
+
+  describe '#join' do
+    it 'appends the sql for a join statement' do
+      subject.join(versions)
+      expect(subject.sql).to eq('join `versions`')
+    end
+  end
+
+  describe '#on' do
+    it 'appends the sql for the on statement' do
+      subject.on(gems[:id], versions[:gem_id])
+      expect(subject.sql).to eq('on `gems`.`id` = `versions`.`gem_id`')
+    end
+  end
+end