yesql 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4cad8cd91b4afba6c7a8722f9f0dfd6092552d2f4ce735c6880425241122b43
-  data.tar.gz: b8be652b46ee03e081ec2d8bc3bcc2321e26e2b7fcd55dcbf2a2bb288ddac139
+  metadata.gz: f38a878a124272c8ed8f51d723cba49704d2e7b60b28920c562fdbc8e1d68836
+  data.tar.gz: dbfa7776c1eb0eeae767023504cb741dd05052fd992b3b01a218f849917d7696
 SHA512:
-  metadata.gz: 4dc794c44484b4fcc8815fa866023c6cf5d2f4b82d4f2c45c6de7e86082eaa3ba838c55e750e3f2fd53b0312b4be699c7ddc900400c8445c377fd7c6d1139190
-  data.tar.gz: 88b860a5ce91655366f9d73336b522678a8f709938881e1ff150a13565b57cd12b65c753531ecfb886528d162405c36ca9036c1c3cba52a62aa2e3e3993e76fb
+  metadata.gz: b781599e0e8d5f6a84bec509737595269f28e6347284046f2a7d767ff14256b79a8658643b0e077a453ce08bf4d23766e2eebbd1bcc19b952b43f3eeda94b87b
+  data.tar.gz: 6ac1827d64222972e9fd70bbdb216576581c86dd54a93824d20236e451720ae035ee54ad47912270faa823d8ff30d471353e9a69d123fa1d2544315067683481

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yesql (0.2.2)
+    yesql (0.1.8)
       activerecord (>= 4.0.0.beta1)
 
 GEM

data/lib/yesql.rb

@@ -8,36 +8,33 @@ require "yesql/errors/file_path_does_not_exist_error"
 require "yesql/errors/no_bindings_provided_error"
 require "yesql/errors/output_argument_error"
 
-module YeSQL
+module ::YeSQL
   include ::YeSQL::Config
-  include ::YeSQL::Errors::FilePathDoesNotExistError
-  include ::YeSQL::Errors::NoBindingsProvidedError
-  include ::YeSQL::Errors::OutputArgumentError
 
   BIND_REGEX = /(?<!:):(\w+)(?=\b)/
 
-  def YeSQL(file_path, bindings = {}, options = {})
+  def YeSQL(file_path, binds = {}, options = {})
     output = options[:output] || :rows
 
-    validate(bindings, file_path, output)
-    execute(bindings, file_path, output, options)
+    validate(binds, file_path, output)
+    execute(binds, file_path, output, options[:prepare])
   end
 
   private
 
-  def validate(bindings, file_path, output)
-    validate_file_path_existence(file_path)
-    validate_statement_bindings(bindings, file_path)
-    validate_output_options(output)
+  def validate(binds, file_path, output)
+    ::YeSQL::Errors::FilePathDoesNotExistError.new(file_path).validate_file_path_existence
+    ::YeSQL::Errors::NoBindingsProvidedError.new(binds, file_path).validate_statement_bindings
+    ::YeSQL::Errors::OutputArgumentError.new(output).validate_output_options
   end
 
-  def execute(bindings, file_path, output, options)
+  def execute(binds, file_path, output, prepare)
     ::YeSQL::Query::Performer.new(
-      bindings: bindings,
-      bind_statement: ::YeSQL::Statement.new(bindings, file_path),
+      bindings: binds,
+      bind_statement: ::YeSQL::Statement.new(binds, file_path),
       file_path: file_path,
       output: output,
-      prepare: options[:prepare]
+      prepare: prepare
     ).call
   end
 end

data/lib/yesql/bindings/extract.rb

@@ -8,7 +8,7 @@ module ::YeSQL
     class Extract
       include ::YeSQL::Common::Adapter
 
-      def initialize(indexed_bindings, hash, index, value)
+      def initialize(hash, indexed_bindings, index, value)
         @hash = hash
         @index = index
         @indexed_bindings = indexed_bindings
@@ -25,7 +25,7 @@ module ::YeSQL
         if mysql?
           return "?" unless array?
 
-          Array.new(value.size, "?").join(", ")
+          Array.new(size, "?").join(", ")
         elsif pg?
           return "$#{last_val}" unless array?
 
@@ -48,7 +48,7 @@ module ::YeSQL
       attr_reader :hash, :index, :indexed_bindings, :value
 
       def current_val_size
-        return value.size if array?
+        return size if array?
 
         1
       end
@@ -72,6 +72,10 @@ module ::YeSQL
 
         prev_last_val + 1
       end
+
+      def size
+        value.size
+      end
     end
   end
 end

data/lib/yesql/bindings/extractor.rb

@@ -2,35 +2,40 @@
 
 require "yesql/bindings/extract"
 
-module YeSQL
+module ::YeSQL
   module Bindings
     class Extractor
-      def initialize(bindings:)
+      def initialize(bindings: {})
         @bindings = bindings
-        @indexed_bindings = (bindings || {}).to_a
+        @indexed_bindings = bindings.to_a
       end
 
       def call
-        bindings.each_with_object({}).with_index(1) do |((key, value), hash), index|
-          hash[key] =
-            ::YeSQL::Bindings::Extract.new(indexed_bindings, hash, index, value).tap do |extract|
-              break {
-                bind: {
-                  vals: extract.bind_vals,
-                  vars: extract.bind_vars
-                },
-                last_val: extract.last_val,
-                match: key,
-                prev: extract.prev,
-                value: value
-              }
-            end
-        end
+        bindings
+          .each_with_object({})
+          .with_index(1) do |((key, value), hash), index|
+            hash[key] = binding_extracts(hash, indexed_bindings, index, key, value)
+          end
       end
 
       private
 
       attr_reader :bindings, :indexed_bindings
+
+      def binding_extracts(hash, indexed_bindings, index, key, value)
+        ::YeSQL::Bindings::Extract.new(hash, indexed_bindings, index, value).tap do |extract|
+          break {
+            bind: {
+              vals: extract.bind_vals,
+              vars: extract.bind_vars
+            },
+            last_val: extract.last_val,
+            match: key,
+            prev: extract.prev,
+            value: value
+          }
+        end
+      end
     end
   end
 end

data/lib/yesql/bindings/utils.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-module YeSQL
+module ::YeSQL
   module Bindings
     module Utils
+      include ::YeSQL::Utils::Read
+
       def statement_binds(extractor)
-        ::YeSQL::Utils::Read
-          .statement(file_path, readable: true)
-          .scan(::YeSQL::BIND_REGEX).map do |(bind)|
-            extractor[bind.to_sym][:bind].values_at(:vals, :vars)
-          end
+        statement(readable: true)
+          .scan(::YeSQL::BIND_REGEX)
+          .map(&:first)
+          .map { extractor[_1.to_sym][:bind].values_at(:vals, :vars) }
       end
     end
   end

data/lib/yesql/errors/file_path_does_not_exist_error.rb

@@ -1,28 +1,31 @@
 # frozen_string_literal: true
 
-module YeSQL
+module ::YeSQL
   module Errors
-    module FilePathDoesNotExistError
-      def validate_file_path_existence(file_path)
-        return if file_exists?(file_path)
+    class FilePathDoesNotExistError
+      def initialize(file_path)
+        @file_path = file_path
+      end
+
+      def validate_file_path_existence
+        return if file_exists?
 
-        raise NotImplementedError, format(MESSAGE, available_files: available_files,
-                                                   file_path: file_path, path: ::YeSQL.config.path)
+        raise ::NotImplementedError, message
       end
 
       private
 
-      MESSAGE = <<~MSG
+      attr_reader :file_path
 
-        SQL file "%<file_path>s" does not exist in %<path>s.
+      def message
+"\nSQL file \"#{file_path}\" does not exist in #{::YeSQL.config.path}.
 
-        Available SQL files are:
+Available SQL files are:
 
-        %<available_files>s
-      MSG
-      private_constant :MESSAGE
+#{available_files}\n"
+      end
 
-      def file_exists?(file_path)
+      def file_exists?
         path_files.any? { |filename| filename.include?("#{file_path}.sql") }
       end
 

data/lib/yesql/errors/no_bindings_provided_error.rb

@@ -4,38 +4,45 @@ require "yesql/utils/read"
 
 module ::YeSQL
   module Errors
-    module NoBindingsProvidedError
-      def validate_statement_bindings(binds, file_path)
-        return unless statement_binds(file_path).size.positive?
+    class NoBindingsProvidedError
+      include ::YeSQL::Utils::Read
 
-        format(MESSAGE, renderable_statement_binds(file_path)).tap do |message|
-          raise ::ArgumentError, message unless binds.is_a?(::Hash) && !binds.empty?
-        end
+      def initialize(binds, file_path)
+        @binds = binds
+        @file_path = file_path
+      end
+
+      def validate_statement_bindings
+        return unless statement_binds.size.positive?
+        return if expected_binds?
+
+        raise ::ArgumentError, message
       end
 
       private
 
-      MESSAGE = <<~MSG
+      attr_reader :binds, :file_path
 
-        YeSQL invoked without bindings.
+      def message
+"\nYeSQL invoked without bindings.
 
-        Expected bindings are:
+Expected bindings are:
 
-        %s
-      MSG
-      private_constant :MESSAGE
+#{renderable_statement_binds}\n"
+      end
 
-      def statement_binds(file_path)
-        ::YeSQL::Utils::Read.statement(file_path)
-          .scan(::YeSQL::BIND_REGEX).tap do |scanned_binds|
-          break [] if scanned_binds.size.zero?
+      def statement_binds
+        statement
+          .scan(::YeSQL::BIND_REGEX)
+          .tap { |scanned_binds| break (scanned_binds || []).sort }
+      end
 
-          break scanned_binds.sort
-        end
+      def renderable_statement_binds
+        statement_binds.flatten.map { |bind| "- `#{bind}`\n" }.join
       end
 
-      def renderable_statement_binds(file_path)
-        statement_binds(file_path).flatten.map { |bind| "- `#{bind}`\n" }.join
+      def expected_binds?
+        binds.is_a?(::Hash) && !binds.empty?
       end
     end
   end

data/lib/yesql/errors/output_argument_error.rb

@@ -1,22 +1,32 @@
 # frozen_string_literal: true
 
-module YeSQL
+module ::YeSQL
   module Errors
-    module OutputArgumentError
-      def validate_output_options(output)
+    class OutputArgumentError
+      def initialize(output)
+        @output = output
+      end
+
+      def validate_output_options
         return if output.nil?
+        return if OPTIONS.include?(output.to_sym)
 
-        raise ArgumentError, format(MESSAGE, output) unless OPTIONS.include?(output.to_sym)
+        raise ArgumentError, message
       end
 
-      MESSAGE = <<~MSG
-        Unsupported `output` option given `%s`. Possible values are:
-          - `columns`: returns an array with the columns from the result.
-          - `hash`: returns an array of hashes combining both, the columns and rows from the statement result.
-          - `rows`: returns an array of arrays for each row from the given SQL statement.
-      MSG
+      private
+
+      attr_reader :output
+
       OPTIONS = %i[columns hash rows].freeze
-      private_constant :MESSAGE, :OPTIONS
+      private_constant :OPTIONS
+
+      def message
+"Unsupported `output` option given `#{output}`. Possible values are:
+  - `columns`: returns an array with the columns from the result.
+  - `hash`: returns an array of hashes combining both, the columns and rows from the statement result.
+  - `rows`: returns an array of arrays for each row from the given SQL statement.\n"
+      end
     end
   end
 end

data/lib/yesql/params/output.rb

@@ -6,7 +6,7 @@ require "forwardable"
 module ::YeSQL
   module Params
     class Output
-      extend Forwardable
+      extend ::Forwardable
 
       def initialize(output)
         @output = output.to_s

data/lib/yesql/query/performer.rb

@@ -8,7 +8,7 @@ require "yesql/query/result"
 require "yesql/query/transform_result"
 require "yesql/params/output"
 
-module YeSQL
+module ::YeSQL
   module Query
     class Performer
       include ::YeSQL::Bindings::Utils
@@ -27,7 +27,7 @@ module YeSQL
 
       private
 
-      attr_reader :bind_statement, :file_path, :named_bindings, :output, :prepare, :rows
+      attr_reader :bind_statement, :file_path, :named_bindings, :output, :prepare
 
       def query_result
         @query_result ||= ::YeSQL::Query::Result.new(binds: binds,

data/lib/yesql/query/result.rb

@@ -7,14 +7,13 @@ require "yesql/common/adapter"
 module ::YeSQL
   module Query
     class Result
-      extend Forwardable
+      extend ::Forwardable
 
       include ::YeSQL::Common::Adapter
 
       def initialize(bind_statement:, file_path:, prepare:, binds: [])
         @binds = binds
         @bind_statement = bind_statement
-        @connection = ActiveRecord::Base.connection
         @file_path = file_path
         @prepare_option = prepare
       end
@@ -28,7 +27,7 @@ module ::YeSQL
 
       private
 
-      attr_reader :binds, :bind_statement, :connection, :file_path, :prepare_option
+      attr_reader :binds, :bind_statement, :file_path, :prepare_option
 
       def_delegators(:bind_statement, :bound, :to_s, :view?)
       def_delegators(:connection, :exec_query, :raw_connection)
@@ -38,10 +37,13 @@ module ::YeSQL
         exec_query(bound)
       end
 
-      # TODO: recheck this case
       def rails5_result
         prepare(bound).execute(*binds)
       end
+
+      def connection
+        @connection ||= ActiveRecord::Base.connection
+      end
     end
   end
 end

data/lib/yesql/query/transform_result.rb

@@ -7,7 +7,7 @@ require "forwardable"
 module ::YeSQL
   module Query
     class TransformResult
-      extend Forwardable
+      extend ::Forwardable
 
       include ::YeSQL::Common::Adapter
 
@@ -17,7 +17,7 @@ module ::YeSQL
       end
 
       def call
-        if ::ActiveRecord::VERSION::MAJOR == 5 && mysql?
+        if rails_5? && mysql?
           return columns if columns?
           return rows_values if rows?
           return array_of_symbol_hashes if hash?
@@ -32,7 +32,7 @@ module ::YeSQL
 
       attr_reader :output, :result
 
-      def_delegators(:result, :rows, :to_a)
+      def_delegators(:result, :fields, :rows, :to_a)
       def_delegators(:output, :columns?, :hash?, :rows?)
 
       def rows_values
@@ -50,9 +50,11 @@ module ::YeSQL
       end
 
       def columns
-        return result.fields if result.respond_to?(:fields)
+        fields || result.columns
+      end
 
-        result.columns
+      def rails_5?
+        ::ActiveRecord::VERSION::MAJOR == 5
       end
     end
   end

data/lib/yesql/statement.rb

@@ -13,6 +13,7 @@ module ::YeSQL
     extend ::Forwardable
 
     include ::YeSQL::Common::Adapter
+    include ::YeSQL::Utils::Read
     # Give access to the quote method.
     include ::ActiveRecord::ConnectionAdapters::Quoting
 
@@ -23,16 +24,12 @@ module ::YeSQL
 
     def bound
       to_s.gsub(::YeSQL::BIND_REGEX) do |match|
-        extractor[match[/(\w+)/].to_sym].tap do |extract|
-          break quote(extract[:value]) if view?
-
-          break extract[:bind][:vars]
-        end
+        extract_bind_values(extractor[match[/(\w+)/].to_sym])
       end
     end
 
     def to_s
-      @to_s ||= ::YeSQL::Utils::Read.statement(file_path, readable: true)
+      @to_s ||= statement(readable: true)
     end
 
     def view?
@@ -43,6 +40,12 @@ module ::YeSQL
 
     attr_reader :bindings, :file_path
 
+    def extract_bind_values(match)
+      return quote(match[:value]) if view?
+
+      match[:bind][:vars]
+    end
+
     def extractor
       ::YeSQL::Bindings::Extractor.new(bindings: bindings).call
     end

data/lib/yesql/utils/read.rb

@@ -1,16 +1,26 @@
 # frozen_string_literal: true
 
-module YeSQL
+module ::YeSQL
   module Utils
     module Read
-      def self.statement(file_path, readable: false)
-        Dir["./#{::YeSQL.config.path}/**/*.sql"]
-          .find { |dir_file_path| dir_file_path.include?("#{file_path}.sql") }
-          .tap do |sql_file_path|
-          break File.readlines(sql_file_path, chomp: true).join(" ") if readable == true
+      def statement(readable: false)
+        read_file(found_file, readable)
+      end
+
+      private
 
-          break File.read(sql_file_path)
-        end
+      def read_file(file, readable)
+        return File.readlines(file, chomp: true).join(" ") if readable == true
+
+        File.read(file)
+      end
+
+      def found_file
+        dir_sql_files.find { |dir_file_path| dir_file_path.include?("#{file_path}.sql") }
+      end
+
+      def dir_sql_files
+        Dir["./#{::YeSQL.config.path}/**/*.sql"]
       end
     end
   end

data/lib/yesql/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module YeSQL
-  VERSION = "0.2.2"
+module ::YeSQL
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yesql
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Sebastián Palma