mysql_framework 1.1.2 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dea6c1520ad570dfaf0070efd3df024dbd8d8ba9bc745970ebc59a82ad38418
-  data.tar.gz: 7f2e6a694727e104584c5304673841cf06231b3efc538fb1a0bce23f69772293
+  metadata.gz: 79a94352053f85513e65fe768c6a2dbe420c14dd84e483e6f5ee276029b3c494
+  data.tar.gz: 794c2b7cafbdfa11d9be23e924a71cec74140003396266c2cc2dec023f2c7c26
 SHA512:
-  metadata.gz: 6adf70afb9966e920ef972c187679847ea08d1638b3be8b5473bb031d5be41bc607a9143d313aafd106ff748f295b7679437f597f28a88b4e68afa6e1bcb9068
-  data.tar.gz: '0057569f653959047e9c12feac892e9e0fc51f3fa99085bcd153f26374b4057e7dbdf45f6515d5254798064992065056e7d981369c7700986073390fc88a94e3'
+  metadata.gz: affb71d82cf2c8446d72b2a898abbade1d62a04dbebc97502ccef5a92c6c1e0377a9acc9dccf2a08ce6d7d9da03b64eb0b1d1a861715ca15977c2b53f6aa8c89
+  data.tar.gz: 8f48457c4dbc815b62406ab8c64fa14a4cc572d0f30c683d66a22a0e9cc7f68112d364edc0bf24d6569fabfaef5869e0606282a9a998910cf1c78bf2f785f264

data/lib/mysql_framework/in_condition.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module MysqlFramework
+# This class is used to represent a Sql IN Condition for a column.
+  class InCondition < SqlCondition
+    # This method is called to get the condition as a string for a sql prepared statement
+    def to_s
+      params = value.map { |_| '?' }
+      "#{@column} #{@comparison} (#{params.join(', ')})"
+    end
+  end
+end

data/lib/mysql_framework/sql_column.rb

@@ -46,6 +46,10 @@ module MysqlFramework
       SqlCondition.new(column: to_s, comparison: '<=', value: value)
     end
 
+    def in(*values)
+      InCondition.new(column: to_s, comparison: 'IN', value: values)
+    end
+
     # This method is called to generate an alias statement for this column.
     def as(name)
       "#{self} as `#{name}`"

data/lib/mysql_framework/sql_query.rb

@@ -9,11 +9,12 @@ module MysqlFramework
     def initialize
       @sql = ''
       @params = []
+      @lock = nil
     end
 
     # This method is called to access the sql string for this query.
     def sql
-      @sql.strip
+      (@sql + @lock.to_s + @dup_query.to_s).strip
     end
 
     # This method is called to start a select query
@@ -76,19 +77,6 @@ module MysqlFramework
       self
     end
 
-    # This method is called to specify the columns to bulk upsert.
-    def bulk_upsert(columns)
-      @sql += 'ON DUPLICATE KEY UPDATE '
-
-      columns.each do |column|
-        @sql += "#{column} = VALUES(#{column}), "
-      end
-
-      @sql = @sql.chomp(', ')
-
-      self
-    end
-
     # This method is called to specify the columns to update.
     def set(values)
       @sql += ' SET '
@@ -136,7 +124,13 @@ module MysqlFramework
       @sql += ' WHERE' unless @sql.include?('WHERE')
       @sql += " (#{conditions.join(' AND ')}) "
 
-      conditions.each { |condition| @params << condition.value }
+      conditions.each do |condition|
+        if condition.value.is_a?(Enumerable)
+          @params.concat(condition.value)
+        else
+          @params << condition.value
+        end
+      end
 
       self
     end
@@ -218,5 +212,53 @@ module MysqlFramework
 
       self
     end
+
+    # This method allows you to add a pessimistic lock to the record.
+    # The default lock is `FOR UPDATE`
+    # If you require any custom lock, e.g. FOR SHARE, just pass that in as the condition
+    # query.lock('FOR SHARE')
+    def lock(condition = nil)
+      raise 'This must be a SELECT query' unless @sql.start_with?('SELECT')
+
+      @lock = ' ' + (condition || 'FOR UPDATE')
+      self
+    end
+
+    # For insert queries if you need to handle that a primary key already exists and automatically do an update instead.
+    # If you do not pass in a hash specifying a column name and custom value for it.
+    # @param update_values [Hash] key is a column name.  A nil value will make the query update
+    # the column with the value specified in the insert.  Otherwise any value will be interpreted
+    # literally via mysql.
+    # @return SqlQuery
+    # e.g.
+    # query.insert('users')
+    # .into('id', first_name', 'login_count')
+    # .values(1, 'Bob', 1)
+    # .duplicate_update(
+    #   {
+    #     first_name: nil,
+    #     login_count: 'login_count + 5'
+    #   }
+    # )
+    # This would first create a record like => `1, 'Bob', 1`.
+    # The second time it would update it with => `'Bob', 6`  (Note the 1 is not used in the update)
+    def on_duplicate(update_values = {})
+      raise 'This must be an INSERT query' unless @sql.start_with?('INSERT')
+
+      duplicates = []
+      update_values.each do |column, col_value|
+        if col_value.nil?
+          # value comes from what the INSERT intended
+          updated_value = "#{column} = VALUES (#{column})"
+        else
+          # custom value specified by col_value
+          updated_value = "#{column} = #{col_value}"
+        end
+        duplicates << updated_value
+      end
+      @dup_query = " ON DUPLICATE KEY UPDATE #{duplicates.join(', ')}"
+
+      self
+    end
   end
 end

data/lib/mysql_framework/sql_table.rb

@@ -5,11 +5,13 @@ module MysqlFramework
   class SqlTable
     def initialize(name)
       @name = name
+      @column_objects = {}
     end
 
     # This method is called to get a sql column for this table
     def [](column)
-      SqlColumn.new(table: @name, column: column)
+      return @column_objects[column.to_sym] if @column_objects[column.to_sym]
+      @column_objects[column.to_sym] = SqlColumn.new(table: @name, column: column)
     end
 
     def to_s

data/lib/mysql_framework/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MysqlFramework
-  VERSION = '1.1.2'
+  VERSION = '2.0.0.rc1'
 end

data/lib/mysql_framework.rb

@@ -7,6 +7,7 @@ require_relative 'mysql_framework/logger'
 require_relative 'mysql_framework/scripts'
 require_relative 'mysql_framework/sql_column'
 require_relative 'mysql_framework/sql_condition'
+require_relative 'mysql_framework/in_condition'
 require_relative 'mysql_framework/sql_query'
 require_relative 'mysql_framework/sql_table'
 require_relative 'mysql_framework/version'

data/spec/lib/mysql_framework/sql_column_spec.rb

@@ -63,6 +63,14 @@ describe MysqlFramework::SqlColumn do
     end
   end
 
+  describe '#in' do
+    it 'returns a SqlCondition for the comparison' do
+      condition = subject.in('a', 'b', 'c')
+      expect(condition).to be_a(MysqlFramework::InCondition)
+      expect(condition.to_s).to eq('`gems`.`version` IN (?, ?, ?)')
+    end
+  end
+
   describe '#as' do
     it 'returns the column specified as another name' do
       expect(subject.as('v')).to eq('`gems`.`version` as `v`')

data/spec/lib/mysql_framework/sql_query_spec.rb

@@ -139,16 +139,6 @@ describe MysqlFramework::SqlQuery do
     end
   end
 
-  describe '#bulk_upsert' do
-    it 'sets the sql for the upsert statement' do
-      columns = %w(column_1 column_2)
-
-      subject.bulk_upsert(columns)
-
-      expect(subject.sql).to eq('ON DUPLICATE KEY UPDATE column_1 = VALUES(column_1), column_2 = VALUES(column_2)')
-    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')
@@ -330,4 +320,69 @@ describe MysqlFramework::SqlQuery do
       end
     end
   end
+
+  describe '#lock' do
+    it 'appends `FOR_UPDATE` to the query' do
+      subject.select('*').from(gems).lock
+      expect(subject.sql).to end_with('FOR UPDATE')
+    end
+  end
+
+  describe '#on_duplicate' do
+    let(:query) do
+      subject.insert(gems)
+        .into(
+          gems[:id],
+          gems[:name],
+          gems[:author]
+        )
+        .values(
+          1,
+          'mysql_framework',
+          'Bob Hope'
+        )
+    end
+
+    context 'when no custom values are specified' do
+      it 'updates with the value from the INSERT clause' do
+        query.on_duplicate(
+          {
+            gems[:name] => nil,
+            gems[:author] => nil
+          }
+        )
+
+        expect(query.sql)
+          .to end_with 'ON DUPLICATE KEY UPDATE `gems`.`name` = VALUES (`gems`.`name`), `gems`.`author` = VALUES (`gems`.`author`)'
+      end
+    end
+
+    context 'when a custom value is specified' do
+      it 'updates the value based on the custom value' do
+        query.on_duplicate(
+          {
+            gems[:name] => '"mysql_alternative"',
+            gems[:author] => '"Michael Caine"'
+          }
+        )
+
+        expect(query.sql)
+          .to end_with 'ON DUPLICATE KEY UPDATE `gems`.`name` = "mysql_alternative", `gems`.`author` = "Michael Caine"'
+      end
+    end
+
+    context 'when column names are specified instead of SqlColumn objects' do
+      it 'updates the value based on the custom column key names' do
+        query.on_duplicate(
+          {
+            name: '"mysql_alternative"',
+            author: '"Michael Caine"'
+          }
+        )
+
+        expect(query.sql)
+          .to end_with 'ON DUPLICATE KEY UPDATE name = "mysql_alternative", author = "Michael Caine"'
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysql_framework
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0.rc1
 platform: ruby
 authors:
 - Sage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2019-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - lib/mysql_framework.rb
 - lib/mysql_framework/connector.rb
+- lib/mysql_framework/in_condition.rb
 - lib/mysql_framework/logger.rb
 - lib/mysql_framework/scripts.rb
 - lib/mysql_framework/scripts/base.rb
@@ -132,9 +133,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.7