yesql 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39685fc3aed05a0bd16e721614bc55b31630fef3f8fdfb0c79e00662d0663da9
-  data.tar.gz: b4f2fc397dd96d2fed5ae8327b4757eb18ccfccd54e426f82833ffa9d1261e04
+  metadata.gz: 5c342b76a655011550ac627d5f117e183723309e22a5ab67dd896278f2e321c9
+  data.tar.gz: 7736ced5895925341a027f59d8814d792eebd7c1fa113bea165ad1dd9c4fa5d0
 SHA512:
-  metadata.gz: 4ddb51e8b4a1a07355b5b8c58b4245686e9bad9f20b5c2ae63a4310d4de70512ebd2946c965dfd798b4d7dbd51364fc3e1d310aa10b1d10ce20aacf4dd597dfe
-  data.tar.gz: 3c2db37304bd5894f740278c58fd79e20a93792d6405898c0f63257ee71216f43af9f4fdece369a4ebdc8aea1148e4a39bab78cacae0b429c78e8aa485e96f97
+  metadata.gz: 35190a0eaecbb93b945592e91279b0f932207b574d1341d9a1013f568d1854fd0f5e9962b21c27ecb11ded93437fb33724602ca73138f7ad46310be1aba9aa20
+  data.tar.gz: 96b1844015c909c4de69214c74a46a8870f675f61b3bb727ac73038cf98a4a37d6b489ea12bcaf8fd861369de20e2bae3b5a2e1d5075a3ba1d693371eecd2820

data/Gemfile

@@ -1,7 +1,9 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in yesql.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "minitest", "~> 5.0"
+group :docs do
+  gem 'yard'
+end

data/Gemfile.lock

@@ -0,0 +1,173 @@
+PATH
+  remote: .
+  specs:
+    yesql (0.1.0)
+      dry-configurable (~> 0.11.6)
+      rails (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      activestorage (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      actionview (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.3)
+      actionview (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      activestorage (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.3)
+      activesupport (= 6.0.3.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.3)
+      activesupport (= 6.0.3.3)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activerecord (6.0.3.3)
+      activemodel (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activestorage (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    dry-configurable (0.11.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.7.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    nio4r (2.5.3)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    pg (1.2.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.3)
+      actioncable (= 6.0.3.3)
+      actionmailbox (= 6.0.3.3)
+      actionmailer (= 6.0.3.3)
+      actionpack (= 6.0.3.3)
+      actiontext (= 6.0.3.3)
+      actionview (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      activemodel (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      activestorage (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    yard (0.9.25)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pg (>= 0.18)
+  pry (~> 0.13.1)
+  rspec (~> 3.9.0)
+  yard
+  yesql!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,8 +1,10 @@
 # Yesql
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yesql`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ruby library for using SQL in Ruby on Rails projects.
 
-TODO: Delete this and the text above, and describe your gem
+YeSQL is a Ruby wrapper built on top of ActiveRecord to allow applications to execute "raw" SQL files from any directory within the application.
+
+Heavily inspired by [krisajenkins/yesql](https://github.com/krisajenkins/yesql) Clojure library. You can see the [rationale](https://github.com/krisajenkins/yesql#rationale) of the library, which is the same for this one.
 
 ## Installation
 
@@ -22,17 +24,155 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Write a SQL query in a file under the `app/yesql` directory named `users.sql`:
 
-## Development
+```sql
+-- app/yesql/users.sql
+SELECT *
+FROM users;
+```
+
+Now open the Rails console, include the module and execute your query using `YeSQL`:
+
+```ruby
+include YeSQL
+
+YeSQL('users')
+# users (0.9ms)  SELECT * FROM users;
+# => [[1, nil, nil, 2020-09-27 21:27:02.997839 UTC, 2020-09-27 21:27:02.997839 UTC]
+```
+
+By default the output is an array of arrays, containing the value for every row.
+
+
+## Options
+
+
+#### `bindings`
+
+
+If your query has bindings, you can pass them as the second argument when calling `YeSQL`.
+
+```sql
+-- app/yesql/top_10_users_in_x_country.sql
+SELECT
+  :country AS country,
+  users.*
+FROM users
+WHERE country_id = :country_id
+LIMIT :limit;
+```
+
+When calling `YeSQL`:
+
+```ruby
+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.
+
+
+#### `output`
+
+
+If you need an output other than an array of arrays, you can use the `output` options. It accepts three values:
+
+  - `:columns` (or `'columns'`): returns an array containing the name of the columns returned from the query in the format `['column_a', 'column_b', ...]`.
+  - `:hash` (or `'hash'`): returns an array of hashes in the format `[{ column: value }, ...]`.
+  - `:rows` (or `'rows'`) DEFAULT: returns an array of arrays containing the result values from the query in the format `[[value1, value2, ...], ...]`.
+
+Example:
+
+```ruby
+YeSQL('users', output: :columns)
+# => ['id', 'name', 'admin', 'created_at', 'updated_at']
+
+YeSQL('users', output: :hash)
+# => [{:id=>1, :name=>nil, :admin=>nil, :created_at=>2020-09-27 21:27:02.997839 UTC, :updated_at=>2020-09-27 21:27:02.997839 UTC}]
+
+YeSQL('users', output: :rows)
+# => [[1, nil, nil, 2020-09-27 21:27:02.997839 UTC, 2020-09-27 21:27:02.997839 UTC]]
+
+YeSQL('users') # same as in `YeSQL('users', output: :rows)`
+# => [[1, nil, nil, 2020-09-27 21:27:02.997839 UTC, 2020-09-27 21:27:02.997839 UTC]]
+```
+
+- If an unsupported `output` value is provided it raises a `NotImplementedError` exception.
+- If no `output` value is provided, the default is `rows`.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+#### `prepare`
+
+Using `prepare: true` it creates a prepared statement with the content of the SQL file:
+
+```ruby
+ActiveRecord::Base.connection.execute('SELECT * FROM pg_prepared_statements').to_a
+(0.Xms)  SELECT * FROM pg_prepared_statements
+# => []
+
+YeSQL('top_10_users_in_x_country', prepare: true)
+# ...
+
+ActiveRecord::Base.connection.execute('SELECT * FROM pg_prepared_statements').to_a
+(0.Xms)  SELECT * FROM pg_prepared_statements
+# => [{"name"=>"a1", "statement"=>"SELECT   $1 AS country,   users.* FROM users WHERE country_id = $2 LIMIT $3;", "prepare_time"=>2020-10-09 20:52:01.664121 +0000, "parameter_types"=>"{text,integer,bigint}", "from_sql"=>false}]
+```
+
+
+#### `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:
+
+```ruby
+YeSQL.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:
+
+```ruby
+YeSQL.config
+# <Dry::Configurable::Config values={:path=>"path"}>
+Yesql.config.path
+# "path"
+```
+
+
+## Development
+
+- Clone the repository.
+- Install the gem dependencies.
+- Make sure to create the database used in the dummy Rails application in the spec/ folder.
+- Run the tests.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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/[USERNAME]/yesql/blob/master/CODE_OF_CONDUCT.md).
+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).
 
 
 ## License
@@ -41,4 +181,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Yesql project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/yesql/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Yesql project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sebastian-palma/yesql/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,10 +1 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task :default => :test
+# frozen_string_literal: true

data/lib/yesql.rb

@@ -1,6 +1,54 @@
-require "yesql/version"
+# frozen_string_literal: true
 
-module Yesql
-  class Error < StandardError; end
-  # Your code goes here...
+require 'dry-configurable'
+require 'pry'
+require 'yesql/version'
+require 'yesql/query/performer'
+require 'yesql/errors/cache_expiration_error'
+require 'yesql/errors/file_path_does_not_exist_error'
+require 'yesql/errors/no_bindings_provided_error'
+require 'yesql/errors/output_argument_error'
+require 'yesql/bindings/binder'
+
+module YeSQL
+  extend ::Dry::Configurable
+
+  include ::YeSQL::Errors::CacheExpirationError
+  include ::YeSQL::Errors::FilePathDoesNotExistError
+  include ::YeSQL::Errors::NoBindingsProvidedError
+  include ::YeSQL::Errors::OutputArgumentError
+
+  setting :path, 'app/yesql'
+
+  BIND_REGEX = /(?<!:):(\w+)(?=\b)/.freeze
+
+  # rubocop:disable Naming/MethodName
+  def YeSQL(file_path, bindings = {}, options = {})
+    output = options[:output] || :rows
+    cache = options[:cache] || {}
+
+    validate(bindings, cache, file_path, output)
+    execute(bindings, cache, file_path, output, options)
+  end
+  # rubocop:enable Naming/MethodName
+
+  private
+
+  def validate(bindings, cache, file_path, output)
+    validate_file_path_existence(file_path)
+    validate_statement_bindings(bindings, file_path)
+    validate_output_options(output)
+    validate_cache_expiration(cache[:expires_in]) unless cache.empty?
+  end
+
+  def execute(bindings, cache, file_path, output, options)
+    ::YeSQL::Query::Performer.new(
+      bindings: bindings,
+      bind_statement: ::YeSQL::Bindings::Binder.bind_statement(file_path, bindings),
+      cache: cache,
+      file_path: file_path,
+      output: output,
+      prepare: options[:prepare]
+    ).call
+  end
 end

data/lib/yesql/bindings/binder.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'yesql/utils/read'
+require 'yesql/bindings/extractor'
+
+module YeSQL
+  module Bindings
+    class Binder
+      def self.bind_statement(file_path, bindings)
+        ::YeSQL::Bindings::Extractor.new(bindings: bindings).call.tap do |extractor|
+          break ::YeSQL::Utils::Read.statement(file_path, readable: true)
+                                    .gsub(::YeSQL::BIND_REGEX) do |match|
+                                      extractor[match[/(\w+)/].to_sym][:bind][:vars]
+                                    end
+        end
+      end
+    end
+  end
+end

data/lib/yesql/bindings/extract.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'yesql'
+
+module YeSQL
+  module Bindings
+    class Extract
+      def initialize(indexed_bindings, hash, index, value)
+        @indexed_bindings = indexed_bindings
+        @hash = hash
+        @index = index
+        @value = value
+      end
+
+      def bind_vals
+        return [nil, value] unless array?
+
+        value.map { |bind| [nil, bind] }
+      end
+
+      def bind_vars
+        return "$#{last_val}" unless array?
+
+        value.map.with_index(bind_index) { |_, i| "$#{i}" }.join(', ')
+      end
+
+      def last_val
+        prev_last_val + current_val_size
+      end
+
+      def prev
+        return if first?
+
+        indexed_bindings[index - 2].first
+      end
+
+      private
+
+      attr_reader :hash, :index, :indexed_bindings, :value
+
+      def current_val_size
+        return value.size if array?
+
+        1
+      end
+
+      def prev_last_val
+        return 0 if first?
+
+        hash[prev][:last_val]
+      end
+
+      def first?
+        index == 1
+      end
+
+      def array?
+        value.is_a?(Array)
+      end
+
+      def bind_index
+        return 1 if first?
+
+        prev_last_val + 1
+      end
+    end
+  end
+end

data/lib/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
+
+      # rubocop:disable Metrics/MethodLength
+      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
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      private
+
+      attr_reader :bindings, :indexed_bindings
+    end
+  end
+end

data/lib/yesql/bindings/utils.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module YeSQL
+  module Bindings
+    module Utils
+      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
+      end
+    end
+  end
+end

data/lib/yesql/errors/cache_expiration_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module YeSQL
+  module Errors
+    module CacheExpirationError
+      def validate_cache_expiration(expires_in)
+        raise ArgumentError, MESSAGE unless expires_in.is_a?(ActiveSupport::Duration)
+      end
+
+      MESSAGE = <<~MSG
+        Missing mandatory `expires_in` option for `cache`.
+
+        Can not cache the result of the query without an expiration date.
+      MSG
+      private_constant :MESSAGE
+    end
+  end
+end

data/lib/yesql/errors/file_path_does_not_exist_error.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module YeSQL
+  module Errors
+    module FilePathDoesNotExistError
+      def validate_file_path_existence(file_path)
+        return if file_exists?(file_path)
+
+        raise NotImplementedError, format(MESSAGE, available_files: available_files,
+                                                   file_path: file_path, path: ::YeSQL.config.path)
+      end
+
+      private
+
+      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?(file_path)
+        path_files.any? { |filename| filename.include?("#{file_path}.sql") }
+      end
+
+      def available_files
+        path_files.map { |file| "- #{file}\n" }.join
+      end
+
+      def path_files
+        @path_files ||= Dir["#{::YeSQL.config.path}/**/*.sql"]
+      end
+    end
+  end
+end

data/lib/yesql/errors/no_bindings_provided_error.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module YeSQL
+  module Errors
+    module NoBindingsProvidedError
+      def validate_statement_bindings(binds, file_path)
+        return unless statement_binds(file_path).size.positive?
+
+        format(MESSAGE, renderable_statement_binds(file_path)).tap do |message|
+          raise ArgumentError, message unless binds.is_a?(Hash) && !binds.empty?
+        end
+      end
+
+      private
+
+      MESSAGE = <<~MSG
+
+        YeSQL invoked without bindings.
+
+        Expected bindings are:
+
+        %s
+      MSG
+      private_constant :MESSAGE
+
+      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?
+
+          break scanned_binds.sort
+        end
+      end
+
+      def renderable_statement_binds(file_path)
+        statement_binds(file_path).flatten.map { |bind| "- `#{bind}`\n" }.join
+      end
+    end
+  end
+end

data/lib/yesql/errors/output_argument_error.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module YeSQL
+  module Errors
+    module OutputArgumentError
+      def validate_output_options(output)
+        return if output.nil?
+
+        raise ArgumentError, format(MESSAGE, output) unless OPTIONS.include?(output.to_sym)
+      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
+      OPTIONS = %i[columns hash rows].freeze
+      private_constant :MESSAGE, :OPTIONS
+    end
+  end
+end

data/lib/yesql/query/performer.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'yesql'
+require 'forwardable'
+require 'yesql/bindings/utils'
+
+module YeSQL
+  module Query
+    class Performer
+      extend Forwardable
+
+      include ::YeSQL::Bindings::Utils
+
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(bind_statement:,
+                     bindings: {},
+                     cache: {},
+                     file_path:,
+                     output: :rows,
+                     prepare: false)
+        @bind_statement = bind_statement
+        @cache = cache
+        @cache_key = cache[:key] || file_path
+        @connection = ActiveRecord::Base.connection
+        @expires_in = cache[:expires_in]
+        @file_path = file_path
+        @named_bindings = bindings.transform_keys(&:to_sym)
+        @output = output
+        @prepare = prepare
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def call
+        return modified_output if cache.empty?
+
+        Rails.cache.fetch(cache_key, expires_in: expires_in) { modified_output }
+      end
+
+      private
+
+      attr_reader :bind_statement,
+                  :cache,
+                  :cache_key,
+                  :connection,
+                  :expires_in,
+                  :file_path,
+                  :named_bindings,
+                  :output,
+                  :prepare,
+                  :rows
+
+      def_delegator(:query_result, :columns)
+      private :columns
+      def_delegator(:query_result, :rows)
+      private :rows
+
+      def modified_output
+        @modified_output ||=
+          begin
+            return query_result.public_send(output) if %w[columns rows].include?(output.to_s)
+
+            columns.map(&:to_sym).tap { |cols| break rows.map { |row| cols.zip(row).to_h } }
+          end
+      end
+
+      def query_result
+        @query_result ||= connection.exec_query(bind_statement, file_path, binds, prepare: prepare)
+      end
+
+      def binds
+        ::YeSQL::Bindings::Extractor.new(bindings: named_bindings).call.tap do |extractor|
+          break statement_binds(extractor).sort_by(&:last)
+                                          .map(&:first)
+                                          .flatten
+                                          .each_slice(2)
+                                          .to_a
+        end
+      end
+    end
+  end
+end

data/lib/yesql/utils/read.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+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
+
+          break File.read(sql_file_path)
+        end
+      end
+    end
+  end
+end

data/lib/yesql/version.rb

@@ -1,3 +1,5 @@
-module Yesql
-  VERSION = "0.1.0"
+# frozen_string_literal: true
+
+module YeSQL
+  VERSION = '0.1.1'
 end

data/yesql.gemspec

@@ -1,27 +1,28 @@
+# frozen_string_literal: true
+
 require_relative 'lib/yesql/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "yesql"
-  spec.version       = Yesql::VERSION
-  spec.authors       = ["Sebastián Palma"]
-  spec.email         = ["vnhnhm.github@gmail.com"]
-
-  spec.summary       = "krisajenkins/yesql like Ruby gem"
-  spec.description   = "SQL 'raw' for Rails projects"
-  spec.homepage      = "https://github.com/sebastian-palma/yesql"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/sebastian-palma/yesql"
-  spec.metadata["changelog_uri"] = "https://github.com/sebastian-palma/yesql"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.name = 'yesql'
+  spec.version = YeSQL::VERSION
+  spec.authors = ['Sebastián Palma']
+  spec.email = ['vnhnhm.github@gmail.com']
+  spec.summary = 'Ruby library to use SQL'
+  spec.description = 'SQL "raw" for Rails projects'
+  spec.homepage = 'https://github.com/sebastian-palma/yesql'
+  spec.license = 'MIT'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/sebastian-palma/yesql'
+  spec.metadata['changelog_uri'] = 'https://github.com/sebastian-palma/yesql'
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_dependency 'dry-configurable', '~> 0.11.6'
+  spec.add_dependency 'rails', '>= 5.0'
+  spec.add_development_dependency 'pg', '>= 0.18'
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
 end

metadata

@@ -1,31 +1,110 @@
 --- !ruby/object:Gem::Specification
 name: yesql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sebastián Palma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
-dependencies: []
-description: SQL 'raw' for Rails projects
+date: 2020-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+description: SQL "raw" for Rails projects
 email:
 - vnhnhm.github@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/yesql.rb
+- lib/yesql/bindings/binder.rb
+- lib/yesql/bindings/extract.rb
+- lib/yesql/bindings/extractor.rb
+- lib/yesql/bindings/utils.rb
+- lib/yesql/errors/cache_expiration_error.rb
+- lib/yesql/errors/file_path_does_not_exist_error.rb
+- lib/yesql/errors/no_bindings_provided_error.rb
+- lib/yesql/errors/output_argument_error.rb
+- lib/yesql/query/performer.rb
+- lib/yesql/utils/read.rb
 - lib/yesql/version.rb
 - yesql.gemspec
 homepage: https://github.com/sebastian-palma/yesql
@@ -43,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -53,5 +132,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: krisajenkins/yesql like Ruby gem
+summary: Ruby library to use SQL
 test_files: []

data/.gitignore

@@ -1 +0,0 @@
-*.gem

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at vnhnhm@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/