github-ds 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7df77cb6809937119fa2de6b8c56fc949df2562
-  data.tar.gz: 315a6384a50871cc13fc1b3b275eac7e243d3786
+  metadata.gz: e72707c0bbfc8fcf2e846d4e16e6735b8b457728
+  data.tar.gz: 11e5d2059aafe9dc81e7cd343c0a1b7218ca23e6
 SHA512:
-  metadata.gz: 6505957502604a32bc5c37e9d45b6002ba824c2085f1d26b85937b4e32f15d9a90464763ab88c64fc96b5c7b54f54578d60c8f16b9b7428af005936872fa5493
-  data.tar.gz: 68168285e35c21a1fb101ca89c4ca9cd00d3bb2e2bef4fc3c62b9ccc260282ff370e2be1ba918059830a921dca2fe554cee9c197ebd4835cf2470a069b7c5a08
+  metadata.gz: a9f34c95c26ee3edd98d27acefa2d1ea8ca6c1197c36f1616c0dbc387e2f76c4a16c497024565a85de00138031ec8955ab40bd61c6545e3a6ef0e28f4ef1bfbe
+  data.tar.gz: 38586c9b89eaefa299d45e94ed9beb03cbc21b230c301aada2db21aeab27ff8a851cce41ddfc7f7cec0cfd56193e66a1ff62588f57d930ef3089cecbf3c2634f

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.2.8
+
+Fixes
+
+* GitHub::SQL.transaction now takes options and passes them to ActiveRecord::Base.transaction.
+* Moved default time zone enforcement to sanitize from add. Makes it possible to use interpolate or sanitize and have correct time zone enforcement.
+
+Additions
+
+* Added GitHub::SQL#transaction instance method to match the class level one.
+
 ## 0.2.7
 
 Fixes

data/lib/github/ds/version.rb

@@ -1,5 +1,5 @@
 module GitHub
   module DS
-    VERSION = "0.2.7"
+    VERSION = "0.2.8"
   end
 end

data/lib/github/sql.rb

@@ -31,47 +31,12 @@ module GitHub
   #   GitHub::SQL::ROWS(array_of_arrays).
   #
   class SQL
-
-    # Internal: a SQL literal value.
-    class Literal
-      # Public: the string value of this literal
-      attr_reader :value
-
-      def initialize(value)
-        @value = value.to_s.dup.freeze
-      end
-
-      def inspect
-        "<#{self.class.name} #{value}>"
-      end
-
-      def bytesize
-        value.bytesize
-      end
-    end
-
-    # Internal: a list of arrays of values for insertion into SQL.
-    class Rows
-      # Public: the Array of row values
-      attr_reader :values
-
-      def initialize(values)
-        unless values.all? { |v| v.is_a? Array }
-          raise ArgumentError, "cannot instantiate SQL rows with anything but arrays"
-        end
-        @values = values.dup.freeze
-      end
-
-      def inspect
-        "<#{self.class.name} #{values.inspect}>"
-      end
-    end
-
-    # Public: Run inside a transaction
-    def self.transaction
-      ActiveRecord::Base.connection.transaction do
-        yield
-      end
+    # Public: Run inside a transaction. Class version of this method only works
+    # if only one connection is in use. If passing connections to
+    # GitHub::SQL#initialize or overriding connection then you'll need to use
+    # the instance version.
+    def self.transaction(options = {}, &block)
+      ActiveRecord::Base.connection.transaction(options, &block)
     end
 
     # Public: Instantiate a literal SQL value.
@@ -103,27 +68,55 @@ module GitHub
       Rows.new(rows)
     end
 
-    # Public: prepackaged literal values.
-    NULL = Literal.new "NULL"
-    NOW  = Literal.new "NOW()"
+    # Public: Create and execute a new SQL query, ignoring results.
+    #
+    # sql      - A SQL string. See GitHub::SQL#add for details.
+    # bindings - Optional bind values. See GitHub::SQL#add for details.
+    #
+    # Returns self.
+    def self.run(sql, bindings = {})
+      new(sql, bindings).run
+    end
 
-    # Public: A superclass for errors.
-    class Error < RuntimeError
+    # Public: Create and execute a new SQL query, returning its hash_result rows.
+    #
+    # sql      - A SQL string. See GitHub::SQL#add for details.
+    # bindings - Optional bind values. See GitHub::SQL#add for details.
+    #
+    # Returns an Array of result hashes.
+    def self.hash_results(sql, bindings = {})
+      new(sql, bindings).hash_results
     end
 
-    # Public: Raised when a bound ":keyword" value isn't available.
-    class BadBind < Error
-      def initialize(keyword)
-        super "There's no bind value for #{keyword.inspect}"
-      end
+    # Public: Create and execute a new SQL query, returning its result rows.
+    #
+    # sql      - A SQL string. See GitHub::SQL#add for details.
+    # bindings - Optional bind values. See GitHub::SQL#add for details.
+    #
+    # Returns an Array of result arrays.
+    def self.results(sql, bindings = {})
+      new(sql, bindings).results
     end
 
-    # Public: Raised when a bound value can't be sanitized.
-    class BadValue < Error
-      def initialize(value, description = nil)
-        description ||= "a #{value.class.name}"
-        super "Can't sanitize #{description}: #{value.inspect}"
-      end
+    # Public: Create and execute a new SQL query, returning the value of the
+    # first column of the first result row.
+    #
+    # sql      - A SQL string. See GitHub::SQL#add for details.
+    # bindings - Optional bind values. See GitHub::SQL#add for details.
+    #
+    # Returns a value or nil.
+    def self.value(sql, bindings = {})
+      new(sql, bindings).value
+    end
+
+    # Public: Create and execute a new SQL query, returning its values.
+    #
+    # sql      - A SQL string. See GitHub::SQL#add for details.
+    # bindings - Optional bind values. See GitHub::SQL#add for details.
+    #
+    # Returns an Array of values.
+    def self.values(sql, bindings = {})
+      new(sql, bindings).values
     end
 
     # Internal: A Symbol-Keyed Hash of bind values.
@@ -151,10 +144,10 @@ module GitHub
 
       @last_insert_id = nil
       @affected_rows  = nil
-      @binds      = binds ? binds.dup : {}
-      @query      = ""
-      @connection = @binds.delete :connection
-      @force_tz   = @binds.delete :force_timezone
+      @binds          = binds ? binds.dup : {}
+      @query          = ""
+      @connection     = @binds.delete :connection
+      @force_timezone = @binds.delete :force_timezone
 
       add query
     end
@@ -173,19 +166,9 @@ module GitHub
       return self if sql.nil? || sql.empty?
 
       query << " " unless query.empty?
+      query << interpolate(sql.strip, extras)
 
-      begin
-        if @force_tz
-          zone = ActiveRecord::Base.default_timezone
-          ActiveRecord::Base.default_timezone = @force_tz
-        end
-
-        query << interpolate(sql.strip, extras)
-
-        self
-      ensure
-        ActiveRecord::Base.default_timezone = zone if @force_tz
-      end
+      self
     end
 
     # Public: Add a chunk of SQL to the query, unless query generated so far is empty.
@@ -204,11 +187,6 @@ module GitHub
       add sql, extras
     end
 
-    # Public: The number of affected rows for this connection.
-    def affected_rows
-      @affected_rows || connection.raw_connection.affected_rows
-    end
-
     # Public: Add additional bind values to be interpolated each time SQL
     # is added to the query.
     #
@@ -220,44 +198,6 @@ module GitHub
       self
     end
 
-    # Internal: The object we use to execute SQL and retrieve results. Defaults
-    # to AR::B.connection, but can be overridden with a ":connection" key when
-    # initializing a new instance.
-    def connection
-      @connection || ActiveRecord::Base.connection
-    end
-
-    # Public: the number of rows found by the query.
-    #
-    # Returns FOUND_ROWS() if a SELECT query included SQL_CALC_FOUND_ROWS.
-    # Raises if SQL_CALC_FOUND_ROWS was not present in the query.
-    def found_rows
-      raise "no SQL_CALC_FOUND_ROWS clause present" unless defined? @found_rows
-      @found_rows
-    end
-
-    # Internal: Replace ":keywords" with sanitized values from binds or extras.
-    def interpolate(sql, extras = nil)
-      sql.gsub(/:[a-z][a-z0-9_]*/) do |raw|
-        sym = raw[1..-1].intern # O.o gensym
-
-        if extras && extras.include?(sym)
-          val = extras[sym]
-        elsif binds.include?(sym)
-          val = binds[sym]
-        end
-
-        raise BadBind.new raw if val.nil?
-
-        sanitize val
-      end
-    end
-
-    # Public: The last inserted ID for this connection.
-    def last_insert_id
-      @last_insert_id || connection.raw_connection.last_insert_id
-    end
-
     # Public: Map each row to an instance of an ActiveRecord::Base subclass.
     def models(klass)
       return @models if defined? @models
@@ -279,12 +219,7 @@ module GitHub
       return @results if defined? @results
       return [] if frozen?
 
-      begin
-        if @force_tz
-          zone = ActiveRecord::Base.default_timezone
-          ActiveRecord::Base.default_timezone = @force_tz
-        end
-
+      enforce_timezone do
         case query
         when /\ADELETE/i
           @affected_rows = connection.delete(query, "#{self.class.name} Delete")
@@ -310,11 +245,23 @@ module GitHub
         freeze
 
         @results
-      ensure
-        ActiveRecord::Base.default_timezone = zone if @force_tz
       end
     end
 
+    # Public: Execute, ignoring results. This is useful when the results of a
+    # query aren't important, often INSERTs, UPDATEs, or DELETEs.
+    #
+    # sql    - An optional SQL string. See GitHub::SQL#add for details.
+    # extras - Optional bind values. See GitHub::SQL#add for details.
+    #
+    # Returns self.
+    def run(sql = nil, extras = nil)
+      add sql, extras if !sql.nil?
+      results
+
+      self
+    end
+
     # Public: If the query is a SELECT, return an array of hashes instead of an array of arrays.
     def hash_results
       results
@@ -326,18 +273,47 @@ module GitHub
       results.first
     end
 
-    # Public: Execute, ignoring results. This is useful when the results of a
-    # query aren't important, often INSERTs, UPDATEs, or DELETEs.
-    #
-    # sql    - An optional SQL string. See GitHub::SQL#add for details.
-    # extras - Optional bind values. See GitHub::SQL#add for details.
+    # Public: Get the first column of the first row of results.
+    def value
+      row && row.first
+    end
+
+    # Public: Is there a value?
+    def value?
+      !value.nil?
+    end
+
+    # Public: Get first column of every row of results.
     #
-    # Returns self.
-    def run(sql = nil, extras = nil)
-      add sql, extras if !sql.nil?
-      results
+    # Returns an Array or nil.
+    def values
+      results.map(&:first)
+    end
 
-      self
+    # Public: Run inside a transaction for the connection.
+    def transaction(options = {}, &block)
+      connection.transaction(options, &block)
+    end
+
+    # Internal: The object we use to execute SQL and retrieve results. Defaults
+    # to AR::B.connection, but can be overridden with a ":connection" key when
+    # initializing a new instance.
+    def connection
+      @connection || ActiveRecord::Base.connection
+    end
+
+    # Public: The number of affected rows for this connection.
+    def affected_rows
+      @affected_rows || connection.raw_connection.affected_rows
+    end
+
+    # Public: the number of rows found by the query.
+    #
+    # Returns FOUND_ROWS() if a SELECT query included SQL_CALC_FOUND_ROWS.
+    # Raises if SQL_CALC_FOUND_ROWS was not present in the query.
+    def found_rows
+      raise "no SQL_CALC_FOUND_ROWS clause present" unless defined? @found_rows
+      @found_rows
     end
 
     # Internal: when a SQL_CALC_FOUND_ROWS clause is present in a SELECT query,
@@ -349,55 +325,26 @@ module GitHub
       end
     end
 
-    # Public: Create and execute a new SQL query, ignoring results.
-    #
-    # sql      - A SQL string. See GitHub::SQL#add for details.
-    # bindings - Optional bind values. See GitHub::SQL#add for details.
-    #
-    # Returns self.
-    def self.run(sql, bindings = {})
-      new(sql, bindings).run
+    # Public: The last inserted ID for this connection.
+    def last_insert_id
+      @last_insert_id || connection.raw_connection.last_insert_id
     end
 
-    # Public: Create and execute a new SQL query, returning its hash_result rows.
-    #
-    # sql      - A SQL string. See GitHub::SQL#add for details.
-    # bindings - Optional bind values. See GitHub::SQL#add for details.
-    #
-    # Returns an Array of result hashes.
-    def self.hash_results(sql, bindings = {})
-      new(sql, bindings).hash_results
-    end
+    # Internal: Replace ":keywords" with sanitized values from binds or extras.
+    def interpolate(sql, extras = nil)
+      sql.gsub(/:[a-z][a-z0-9_]*/) do |raw|
+        sym = raw[1..-1].intern # O.o gensym
 
-    # Public: Create and execute a new SQL query, returning its result rows.
-    #
-    # sql      - A SQL string. See GitHub::SQL#add for details.
-    # bindings - Optional bind values. See GitHub::SQL#add for details.
-    #
-    # Returns an Array of result arrays.
-    def self.results(sql, bindings = {})
-      new(sql, bindings).results
-    end
+        if extras && extras.include?(sym)
+          val = extras[sym]
+        elsif binds.include?(sym)
+          val = binds[sym]
+        end
 
-    # Public: Create and execute a new SQL query, returning the value of the
-    # first column of the first result row.
-    #
-    # sql      - A SQL string. See GitHub::SQL#add for details.
-    # bindings - Optional bind values. See GitHub::SQL#add for details.
-    #
-    # Returns a value or nil.
-    def self.value(sql, bindings = {})
-      new(sql, bindings).value
-    end
+        raise BadBind.new raw if val.nil?
 
-    # Public: Create and execute a new SQL query, returning its values.
-    #
-    # sql      - A SQL string. See GitHub::SQL#add for details.
-    # bindings - Optional bind values. See GitHub::SQL#add for details.
-    #
-    # Returns an Array of values.
-    def self.values(sql, bindings = {})
-      new(sql, bindings).values
+        sanitize val
+      end
     end
 
     # Internal: Make `value` database-safe. Ish.
@@ -426,7 +373,9 @@ module GitHub
         connection.quote value.name
 
       when DateTime, Time, Date
-        connection.quote value.to_s(:db)
+        enforce_timezone do
+          connection.quote value.to_s(:db)
+        end
 
       when true
         connection.quoted_true
@@ -442,21 +391,24 @@ module GitHub
       end
     end
 
-    # Public: Get the first column of the first row of results.
-    def value
-      row && row.first
-    end
+    private
 
-    # Public: Is there a value?
-    def value?
-      !value.nil?
-    end
+    # Private: Forces ActiveRecord's default timezone for duration of block.
+    def enforce_timezone(&block)
+      begin
+        if @force_timezone
+          zone = ActiveRecord::Base.default_timezone
+          ActiveRecord::Base.default_timezone = @force_timezone
+        end
 
-    # Public: Get first column of every row of results.
-    #
-    # Returns an Array or nil.
-    def values
-      results.map(&:first)
+        yield if block_given?
+      ensure
+        ActiveRecord::Base.default_timezone = zone if @force_timezone
+      end
     end
   end
 end
+
+require "github/sql/literal"
+require "github/sql/rows"
+require "github/sql/errors"

data/lib/github/sql/errors.rb

@@ -0,0 +1,22 @@
+module GitHub
+  class SQL
+    # Public: A superclass for errors.
+    class Error < RuntimeError
+    end
+
+    # Public: Raised when a bound ":keyword" value isn't available.
+    class BadBind < Error
+      def initialize(keyword)
+        super "There's no bind value for #{keyword.inspect}"
+      end
+    end
+
+    # Public: Raised when a bound value can't be sanitized.
+    class BadValue < Error
+      def initialize(value, description = nil)
+        description ||= "a #{value.class.name}"
+        super "Can't sanitize #{description}: #{value.inspect}"
+      end
+    end
+  end
+end

data/lib/github/sql/literal.rb

@@ -0,0 +1,25 @@
+module GitHub
+  class SQL
+    # Internal: a SQL literal value.
+    class Literal
+      # Public: the string value of this literal
+      attr_reader :value
+
+      def initialize(value)
+        @value = value.to_s.dup.freeze
+      end
+
+      def inspect
+        "<#{self.class.name} #{value}>"
+      end
+
+      def bytesize
+        value.bytesize
+      end
+    end
+
+    # Public: prepackaged literal values.
+    NULL = Literal.new "NULL"
+    NOW  = Literal.new "NOW()"
+  end
+end

data/lib/github/sql/rows.rb

@@ -0,0 +1,20 @@
+module GitHub
+  class SQL
+    # Internal: a list of arrays of values for insertion into SQL.
+    class Rows
+      # Public: the Array of row values
+      attr_reader :values
+
+      def initialize(values)
+        unless values.all? { |v| v.is_a? Array }
+          raise ArgumentError, "cannot instantiate SQL rows with anything but arrays"
+        end
+        @values = values.dup.freeze
+      end
+
+      def inspect
+        "<#{self.class.name} #{values.inspect}>"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-ds
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - GitHub Open Source
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-28 00:00:00.000000000 Z
+date: 2017-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -162,6 +162,9 @@ files:
 - lib/github/kv.rb
 - lib/github/result.rb
 - lib/github/sql.rb
+- lib/github/sql/errors.rb
+- lib/github/sql/literal.rb
+- lib/github/sql/rows.rb
 - script/bootstrap
 - script/console
 - script/install