yesql 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e080f284342f3ef4585f3763e069a7d716deb8c5ffbb0b3e3e06a15d2dcdafa3
-  data.tar.gz: a39131cd73c4df0e109071de38a87a284e688978ab8f8078611958677ccb7412
+  metadata.gz: a975eb880308df8b6528635fef23c0765a4a55575b3fd701889c35d3b31df597
+  data.tar.gz: e20a7b8f884fcb1ac6f122d2b260681128bcb811e4f4013e96c6095cbe430ca8
 SHA512:
-  metadata.gz: 2d4800c0d99e16ca0302deff9a9ace0b453d1503b9ae9a9937936da56cc4084c3ce4194e98974384d53f9cac3f3866b41324661db49edd6ed777fc3f379bc1a5
-  data.tar.gz: 3c5cc66fb4fcbb8ab188f1c7057a2243e3df7d8ac84359327af44ae9d0ef812ab4c7a52b8c70f791a05bffe90efb7ebe5caaa8bae68cb038bd4b9bf1f7576044
+  metadata.gz: 0b06e530938239c35dbd9d73c1b185bdfab8055aef33fe6949ed4cd2ae87b631be7be66c48a78df207e9306f0c76abfa095a92afc3adba3228c82972c0600f8a
+  data.tar.gz: 79b81dde78f7d749257f9eafe0e5afb7575b38ed89e4aa017996d03b2d2d9fc2003eeff6124456623025e0f5c17b2c59e89f8ca4652808db2bbb2e365cec00f8

data/README.md

@@ -70,7 +70,6 @@ YeSQL('top_10_users_in_x_country', { country: 'Cuba', country_id: 1, limit: 6 })
 ```
 
 - If the query doesn't have bindings, but they're provided they're just omitted.
-TODO: update this with link to the error.
 - If the query has bindings, but nothing is provided, it raises a `NotImplementedError` exception.
 
 
@@ -121,45 +120,23 @@ ActiveRecord::Base.connection.execute('SELECT * FROM pg_prepared_statements').to
 ```
 
 
-#### `cache`
-
-If you need to cache your query, you can use the `cache` option. `cache` must be a Hash containing __at least__ the `expires_in` key with an `ActiveSupport::Duration` object, e.g:
-
-```ruby
-YeSQL('users', cache: { key: 'users', expires_in: 1.hour })
-```
-
-That's enough to cache the result of the query for 1 hour with the cache key "users".
-
-If no `key` key/value is used, then the cache key is the name of the file containing the SQL code, and
-
-```ruby
-YeSQL('users', cache: { key: 'users', expires_in: 1.hour })
-```
-
-is the same as
-
-```ruby
-YeSQL('users', cache: { expires_in: 1.hour })
-```
-
 ## Configuration
 
-For default `YeSQL` looks for the _.sql_ files defined under the `app/yesql/` folder but you can update it to use any folder you need. For that you can create a Ruby file under the `config/initializers/` folder as:
+For default `YeSQL` looks for the _.sql_ files defined under the `app/yesql/` folder but you can update it to use any folder you need. For that you can create a Ruby file under the `config/initializers/` with the following content:
 
 ```ruby
-YeSQL.config.path = 'path'
+::YeSQL.configure { |config| config.path = 'path' }
 ```
 
 After saving the file and restarting the server the files are going to be read from the given folder.
 
-You can check at anytime what's the configuration path by inspecting the YeSQL `config` object:
+You can check at anytime what's the configuration path by inspecting the ::YeSQL `config` object:
 
 ```ruby
-YeSQL.config
-# <Dry::Configurable::Config values={:path=>"path"}>
-Yesql.config.path
-# "path"
+::YeSQL.config
+# => #<YeSQL::Config::Configuration:0x00007feea1aa2ef8 @path="app/yesql">
+::YeSQL.config.path
+# => "app/yesql"
 ```
 
 
@@ -167,13 +144,19 @@ Yesql.config.path
 
 - Clone the repository.
 - Install the gem dependencies.
-- Make sure to create the database used in the dummy Rails application in the spec/ folder.
+- Make sure to create both databases used in the dummy Rails applications (mysql, pg) in the spec/ folder.
 - Run the tests.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/sebastian-palma/yesql. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sebastian-palma/yesql/blob/master/CODE_OF_CONDUCT.md).
 
+## TODO
+
+- [ ] Allow comments in .sql files.
+- [ ] Improve errors.
+- [ ] Auto convert `x IN (xs)` queries to `(x = x' OR x = x'')`.
+
 
 ## License
 

data/lib/.rbnext/2.3/yesql/errors/file_path_does_not_exist_error.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ::YeSQL
+  module Errors
+    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
+          )
+        )
+      end
+
+      private
+
+      attr_reader :file_path
+
+      MESSAGE = <<-MSG
+       SQL file "%<file_path>s" does not exist in %<path>s.
+       Available SQL files are:
+       %<available_files>s
+      MSG
+      private_constant :MESSAGE
+
+      def file_exists? ;  path_files.any? { |_1| _1.include?("#{file_path}.sql") }; end
+      def path_files ;  @path_files ||= Dir["#{::YeSQL.config.path}/**/*.sql"]; end
+      def available_files ;  path_files.map { |_1| "- #{_1}\n" }.join; end
+    end
+  end
+end

data/lib/.rbnext/2.3/yesql/errors/no_bindings_provided_error.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "yesql/utils/read"
+
+module ::YeSQL
+  module Errors
+    class NoBindingsProvidedError
+      include ::YeSQL::Utils::Read
+
+      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, format(MESSAGE, renderable_statement_binds)
+      end
+
+      private
+
+      attr_reader :binds, :file_path
+
+      MESSAGE = <<-MSG
+       YeSQL invoked without bindings.
+       Expected bindings are:
+       %s
+      MSG
+      private_constant :MESSAGE
+
+      def statement_binds ;  statement.scan(::YeSQL::BIND_REGEX).tap { |_1| break (_1 || []).sort }; end
+      def renderable_statement_binds ;  statement_binds.flatten.map { |_1| "- `#{_1}`\n" }.join; end
+      def expected_binds? ;  binds.is_a?(::Hash) && !binds.empty?; end
+    end
+  end
+end

data/lib/.rbnext/2.3/yesql/errors/output_argument_error.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ::YeSQL
+  module Errors
+    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)
+      end
+
+      private
+
+      attr_reader :output
+
+      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
+      OPTIONS = %i[columns hash rows].freeze
+      private_constant :MESSAGE, :OPTIONS
+    end
+  end
+end

data/lib/.rbnext/2.3/yesql/query/transform_result.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "yesql"
+require "yesql/common/adapter"
+require "forwardable"
+
+module ::YeSQL
+  module Query
+    class TransformResult
+      extend ::Forwardable
+
+      include ::YeSQL::Common::Adapter
+
+      def initialize(output:, result:)
+        @output = output
+        @result = result
+      end
+
+      def call
+        if rails_5? && mysql?
+          return columns if columns?
+          return rows_values if rows?
+          return array_of_symbol_hashes if hash?
+        end
+
+        return result.public_send(output.to_sym) if columns? || rows?
+
+        to_a.map(&:symbolize_keys)
+      end
+
+      private
+
+      attr_reader :output, :result
+
+      def_delegators(:result, :fields, :rows, :to_a)
+      def_delegators(:output, :columns?, :hash?, :rows?)
+
+      def array_of_symbol_hashes
+        to_a.tap { break hashed_rows(_1) if rails_5? }.map { |_1| ((((__safe_lvar__ = _1) || true) && (!__safe_lvar__.nil? || nil)) && __safe_lvar__.symbolize_keys) || _1 }
+      end
+
+      def columns ;  fields || result.columns; end
+      def rows_values ;  to_a.map { |_1| _1.respond_to?(:values) ? _1.values : _1 }; end
+      def hashed_rows(rows) ;  rows.map { |_1| columns.zip(_1).to_h }; end
+      def rails_5? ;  ::ActiveRecord::VERSION::MAJOR == 5; end
+    end
+  end
+end

data/lib/.rbnext/2.7/yesql/bindings/extract.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "yesql"
+require "yesql/common/adapter"
+
+module ::YeSQL
+  module Bindings
+    class Extract
+      include ::YeSQL::Common::Adapter
+
+      def initialize(hash, indexed_bindings, index, value)
+        @hash = hash
+        @index = index
+        @indexed_bindings = indexed_bindings
+        @value = value
+      end
+
+      def bind_vals
+        return [nil, value] unless array?
+
+        value.map { |_1| [nil, _1] }
+      end
+
+      def bind_vars
+        if mysql?
+          return "?" unless array?
+
+          Array.new(size, "?").join(", ")
+        elsif pg?
+          return "$#{last_val}" unless array?
+
+          value.map.with_index(bind_index) { |_1, _2| "$#{_2}" }.join(", ")
+        end
+      end
+
+      def prev
+        return if first?
+
+        indexed_bindings[index - 2].first
+      end
+
+      def last_val ;  prev_last_val + current_val_size; end
+
+      private
+
+      attr_reader :hash, :index, :indexed_bindings, :value
+
+      def current_val_size
+        return size if array?
+
+        1
+      end
+
+      def prev_last_val
+        return 0 if first?
+
+        hash[prev][:last_val]
+      end
+
+      def bind_index
+        return 1 if first?
+
+        prev_last_val + 1
+      end
+
+      def size ;  value.size; end
+      def first? ;  index == 1; end
+      def array? ;  value.is_a?(Array); end
+    end
+  end
+end

data/lib/.rbnext/2.7/yesql/bindings/extractor.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "yesql/bindings/extract"
+
+module ::YeSQL
+  module Bindings
+    class Extractor
+      def initialize(bindings: {})
+        @bindings = bindings
+        @indexed_bindings = bindings.to_a
+      end
+
+      def call
+        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 |_1|
+          break {
+            bind: { vals: _1.bind_vals, vars: _1.bind_vars },
+            last_val: _1.last_val,
+            match: key,
+            prev: _1.prev,
+            value: value
+          }
+        end
+      end
+    end
+  end
+end

data/lib/.rbnext/2.7/yesql/bindings/transformed.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "yesql"
+require "yesql/common/adapter"
+
+module ::YeSQL
+  module Bindings
+    class Transformed
+      include ::YeSQL::Common::Adapter
+
+      def initialize(statement_binds:)
+        @statement_binds = statement_binds
+      end
+
+      def call
+        return mysql_rails5_binds if rails5? && mysql?
+        return mysql_binds if !rails5? && mysql?
+
+        pg_binds
+      end
+
+      private
+
+      attr_reader :statement_binds
+
+      def rails5? ;  ::ActiveRecord::VERSION::MAJOR == 5; end
+
+      def mysql_rails5_binds
+        statement_binds
+          .flat_map(&:first)
+          .each_slice(2)
+          .flat_map do |_1, _2|
+            next [_1, _2].compact.map(&:last) if _1.is_a?(Array)
+
+            _2
+          end
+      end
+
+      def mysql_binds
+        statement_binds
+          .map(&:first)
+          .flatten
+          .each_slice(2)
+          .to_a
+      end
+
+      def pg_binds
+        statement_binds
+          .sort_by { |_1, _2| _2.to_s.tr("$", "").to_i }
+          .uniq
+          .map(&:first)
+          .flatten
+          .each_slice(2)
+          .to_a
+      end
+    end
+  end
+end

data/lib/.rbnext/2.7/yesql/bindings/utils.rb

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