rom-yesql 0.2.0 → 1.0.0

data/CHANGELOG.md

@@ -1,25 +1,69 @@
-## v0.2.0 2015-08-19
+## 1.0.0 2020-12-06
 
-Updated to work with ROM 0.9.0
+Updated to work with rom 6.0.0 (@mrship)
 
-[Compare v0.1.1...v0.2.0](https://github.com/rom-rb/rom-yaml/compare/v0.1.0...v0.2.0)
 
-## v0.1.1 2015-07-27
+[Compare v0.5.1...v1.0.0](https://github.com/rom-rb/rom-yesql/compare/v0.5.1...v1.0.0)
+
+## 0.5.1 2017-03-30
+
+Updated rom dependency (flash-gordon)
+
+
+[Compare v0.5.0...v0.5.1](https://github.com/rom-rb/rom-yesql/compare/v0.5.0...v0.5.1)
+
+## 0.5.0 2017-03-28
+
+Updated to work with rom 3.2.0 (flash-gordon)
+
+
+[Compare v0.4.0...v0.5.0](https://github.com/rom-rb/rom-yesql/compare/v0.4.0...v0.5.0)
+
+## 0.4.0 2017-02-10
+
+Updated to work with rom 3.0.0
+
+
+[Compare v0.3.0...v0.4.0](https://github.com/rom-rb/rom-yesql/compare/v0.3.0...v0.4.0)
+
+## 0.3.0 2016-07-31
+
+Updated to work with rom 2.0.0
+
+
+[Compare v0.2.0...v0.3.0](https://github.com/rom-rb/rom-yesql/compare/v0.2.0...v0.3.0)
+
+## 0.2.0 2015-08-19
+
+Updated to work with rom 0.9.0
+
+
+[Compare v0.1.1...v0.2.0](https://github.com/rom-rb/rom-yesql/compare/v0.1.1...v0.2.0)
+
+## 0.1.1 2015-07-27
+
+Updated to work with rom 0.8 (solnic)
 
 ### Changed
 
-* Updated to work with ROM 0.8 (solnic)
+- Updated to work with rom 0.8 (solnic)
+
+[Compare v0.1.0...v0.1.1](https://github.com/rom-rb/rom-yesql/compare/v0.1.0...v0.1.1)
+
+## 0.1.0 2015-03-22
+
+Bump rom dep to 0.6.0 final
+
 
-[Compare v0.1.0...v0.1.1](https://github.com/rom-rb/rom-yaml/compare/v0.1.0...v0.1.1)
+[Compare v0.0.2...v0.1.0](https://github.com/rom-rb/rom-yesql/compare/v0.0.2...v0.1.0)
 
-## v0.1.0 2015-03-22
+## 0.0.2 2015-03-21
 
-Bump ROM dep to 0.6.0 final
+Update to work with rom 0.6.0
 
-## v0.0.2 2015-03-21
 
-Update to work with ROM 0.6.0
+[Compare v0.0.1...v0.0.2](https://github.com/rom-rb/rom-yesql/compare/v0.0.1...v0.0.2)
 
-## v0.0.1 2015-03-01
+## 0.0.1 2015-03-01
 
 First public release \o/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.4.0, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct)

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discussing it first on [discourse.rom-rb.org](https://discourse.rom-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discourse.rom-rb.org](http://discourse.rom-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR which updates user documentation in the `docsite` directory
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.rom-rb.org](https://discourse.rom-rb.org) or join [our chat](https://rom-rb.zulipchat.com).

data/Gemfile

@@ -1,20 +1,19 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 gemspec
 
+eval_gemfile "Gemfile.devtools"
+
 group :test do
-  gem 'rom', github: 'rom-rb/rom', branch: 'master'
-  gem 'inflecto'
-  gem 'rspec', '~> 3.1'
-  gem 'codeclimate-test-reporter', require: false
-  gem 'sqlite3', platforms: [:mri, :rbx]
-  gem 'jdbc-sqlite3', platforms: :jruby
+  gem "codeclimate-test-reporter", require: false
+  gem "inflecto"
+  gem "jdbc-sqlite3", platforms: :jruby
+  gem "rspec", "~> 3.5"
+  gem "sqlite3", platforms: %i[mri rbx]
 end
 
 group :tools do
-  gem 'guard'
-  gem 'byebug', platforms: [:mri]
-  gem 'guard-rspec'
-  gem 'guard-rubocop'
-  gem 'rubocop', '~> 0.28'
+  gem "byebug", platforms: [:mri]
 end

data/Gemfile.devtools

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# this file is managed by rom-rb/devtools project
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+group :test do
+  gem "simplecov", require: false, platforms: :ruby
+  gem "simplecov-cobertura", require: false, platforms: :ruby
+
+  gem "warning" if RUBY_VERSION >= "2.4.0"
+end
+
+group :tools do
+  # this is the same version that we use on codacy
+  gem "rubocop", "0.82.0"
+end

data/Guardfile

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 group :red_green_refactor, halt_on_fail: true do
   guard :rspec, cmd: "rspec", all_on_start: true do
     # run all specs if Gemfile.lock is modified
-    watch('Gemfile.lock') { 'spec' }
+    watch("Gemfile.lock") { "spec" }
 
     # run all specs if any library code is modified
-    watch(%r{\Alib/.+\.rb\z}) { 'spec' }
+    watch(%r{\Alib/.+\.rb\z}) { "spec" }
 
     # run all specs if supporting files are modified
-    watch('spec/spec_helper.rb') { 'spec' }
-    watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
+    watch("spec/spec_helper.rb") { "spec" }
+    watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { "spec" }
 
     # run a spec if it is modified
     watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
 
-    notification :tmux, display_message: true if ENV.key?('TMUX')
+    notification :tmux, display_message: true if ENV.key?("TMUX")
   end
 
   guard :rubocop do

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2020 rom-rb team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,52 +1,28 @@
 [gem]: https://rubygems.org/gems/rom-yesql
-[travis]: https://travis-ci.org/rom-rb/rom-yesql
-[gemnasium]: https://gemnasium.com/rom-rb/rom-yesql
-[codeclimate]: https://codeclimate.com/github/rom-rb/rom-yesql
+[actions]: https://github.com/rom-rb/rom-yesql/actions
+[codacy]: https://www.codacy.com/gh/rom-rb/rom-yesql
+[chat]: https://rom-rb.zulipchat.com
 [inchpages]: http://inch-ci.org/github/rom-rb/rom-yesql
 
-# ROM::Yesql
+# rom-yesql [![Join the chat at https://rom-rb.zulipchat.com](https://img.shields.io/badge/rom--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/rom-yesql.svg)][gem]
-[![Build Status](https://travis-ci.org/rom-rb/rom-yesql.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/rom-rb/rom-yesql.png)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/rom-rb/rom-yesql/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/rom-rb/rom-yesql/badges/coverage.svg)][codeclimate]
+[![CI Status](https://github.com/rom-rb/rom-yesql/workflows/ci/badge.svg)][actions]
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/88fbb464691e4666b94e0455468b68bf)][codacy]
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/88fbb464691e4666b94e0455468b68bf)][codacy]
 [![Inline docs](http://inch-ci.org/github/rom-rb/rom-yesql.svg?branch=master)][inchpages]
 
+## Links
 
-[Yesql](https://github.com/krisajenkins/yesql)-like adapter for [Ruby Object Mapper](https://github.com/rom-rb/rom).
+* [User documentation](http://rom-rb.org/learn/yesql)
+* [API documentation](http://rubydoc.info/gems/rom-yesql)
 
-## Installation
+## Supported Ruby versions
 
-Add this line to your application's Gemfile:
+This library officially supports the following Ruby versions:
 
-```ruby
-gem 'rom-yesql'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rom-yesql
-
-## Synopsis
-
-``` ruby
-# given sql/my_queries/users.sql includes "SELECT * FROM users WHERE name = '%{name}'"
-
-ROM.setup(:yesql, ['sqlite://path/to/your/db', path: './sql'])
-
-class MyQueries < ROM::Relation[:yesql]
-end
-
-rom = ROM.finalize.env
-
-my_queries = rom.relations[:my_queries]
-my_queries.users(name: 'Jane').to_a # => gets the users
-```
+* MRI >= `2.4`
+* jruby >= `9.2`
 
 ## License
 

data/Rakefile

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)

data/changelog.yml

@@ -0,0 +1,33 @@
+---
+- version: 1.0.0
+  date: '2020-12-06'
+  summary: Updated to work with rom 6.0.0 (@mrship)
+- version: 0.5.1
+  date: '2017-03-30'
+  summary: Updated rom dependency (flash-gordon)
+- version: 0.5.0
+  date: '2017-03-28'
+  summary: Updated to work with rom 3.2.0 (flash-gordon)
+- version: 0.4.0
+  date: '2017-02-10'
+  summary: Updated to work with rom 3.0.0
+- version: 0.3.0
+  date: '2016-07-31'
+  summary: Updated to work with rom 2.0.0
+- version: 0.2.0
+  date: '2015-08-19'
+  summary: Updated to work with rom 0.9.0
+- version: 0.1.1
+  date: '2015-07-27'
+  changed:
+  - Updated to work with rom 0.8 (solnic)
+  summary: Updated to work with rom 0.8 (solnic)
+- version: 0.1.0
+  date: '2015-03-22'
+  summary: Bump rom dep to 0.6.0 final
+- version: 0.0.2
+  date: '2015-03-21'
+  summary: Update to work with rom 0.6.0
+- version: 0.0.1
+  date: '2015-03-01'
+  summary: First public release \o/

data/lib/rom-yesql.rb

@@ -1,3 +1,5 @@
-require 'rom' # FIXME: this should not be needed
+# frozen_string_literal: true
 
-require 'rom/yesql'
+require "rom" # FIXME: this should not be needed
+
+require "rom/yesql"

data/lib/rom/yesql.rb

@@ -1,2 +1,4 @@
-require 'rom/yesql/version'
-require 'rom/yesql/gateway'
+# frozen_string_literal: true
+
+require "rom/yesql/version"
+require "rom/yesql/gateway"

data/lib/rom/yesql/dataset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module Yesql
     # Yesql dataset simply uses a sequel connection to fetch results of a query

data/lib/rom/yesql/gateway.rb

@@ -1,95 +1,124 @@
-require 'sequel'
+# frozen_string_literal: true
 
-require 'rom/yesql/dataset'
-require 'rom/yesql/relation'
+require "sequel"
+
+require "rom/initializer"
+
+require "rom/yesql/dataset"
+require "rom/yesql/relation"
 
 module ROM
   module Yesql
     # Yesql gateway exposes access to configured SQL queries
     #
-    # @example
-    #   # Load all queries from a specific path
-    #   ROM::Yesql::Gateway.new(uri, path: '/path/to/my_queries')
-    #
-    #   # Provide queries explicitly using a hash
-    #   ROM::Yesql::Gateway.new(uri, queries: {
-    #     reports: {
-    #       all_users: 'SELECT * FROM users'
-    #     }
-    #   })
-    #
-    #   # Override default query proc handler
-    #   ROM::Yesql::Gateway.new(uri, query_proc: proc { |name, query, *args|
-    #     # do something to return an sql string
-    #   })
+    # Relations created with datasets provided by this gateway automatically
+    # expose access to gateway's queries.
     #
     # @api public
     class Gateway < ROM::Gateway
-      include Options
+      extend Initializer
+
+      adapter :yesql
+
+      # @!attribute [r] uri
+      #  @return [String] connection string
+      param :uri
 
-      option :path, reader: true
-      option :queries, type: Hash, default: EMPTY_HASH
-      option :query_proc, reader: true, default: proc { |gateway|
+      # @!attribute [r] path
+      #   @return [String] a path to files with SQL queries
+      option :path, reader: true, optional: true
+
+      # @!attribute [r] queries
+      #   @return [Hash] a hash with queries
+      option :queries, default: -> { EMPTY_HASH }
+
+      # @!attribute [r] query_proc
+      #   This defaults to simple interpolation of the query using option hash passed to a relation
+      #   @return [Proc] custom query proc for pre-processing a query string
+      option :query_proc, reader: true, default: proc { |_gateway|
         proc do |_name, query, opts|
           query % opts
         end
       }
 
-      # Return Sequel database connection
-      #
-      # @return [Sequel::Database]
-      #
-      # @api private
+      # @!attribute [r] connection
+      #   @return [Sequel::Database] Sequel database connection
       attr_reader :connection
 
-      # Hash with loaded queries indexed using dataset names
+      # Initializes a yesql gateway
       #
-      # @return [Hash]
+      # @example
+      #   # Load all queries from a specific path
+      #   ROM::Yesql::Gateway.new(uri, path: '/path/to/my_queries')
       #
-      # @api private
-      attr_reader :queries
-
-      # @api private
-      def initialize(uri, options = {})
+      #   # Provide queries explicitly using a hash
+      #   ROM::Yesql::Gateway.new(uri, queries: {
+      #     reports: {
+      #       all_users: 'SELECT * FROM users'
+      #     }
+      #   })
+      #
+      #   # Override default query proc handler
+      #   ROM::Yesql::Gateway.new(uri, query_proc: proc { |name, query, *args|
+      #     # do something to return an sql string
+      #   })
+      #
+      # @param uri [String]
+      #
+      # @param options [Hash]
+      #   @option :path [String]
+      #   @option :queries [Hash]
+      #   @option :query_proc [Proc]
+      #
+      # @api public
+      def initialize(*)
         super
         @connection = Sequel.connect(uri, options)
-        initialize_queries
-        queries.freeze
+        @queries = @queries.merge(load_queries(path)).freeze
         Relation.query_proc(query_proc)
         Relation.load_queries(queries)
       end
 
-      # Initialize a dataset
+      # Initializes a dataset
       #
       # Since all relations use the same dataset we simply create one instance
       #
+      # @return [Dataset]
+      #
       # @api private
       def dataset(_name)
         @dataset ||= Dataset.new(connection)
       end
 
+      # Returns if a dataset with the given name exists
+      #
+      # This always returns true because all relations use the same dataset
+      #
+      # @return [True]
+      #
       # @api private
       def dataset?(_name)
-        ! @dataset.nil?
+        !@dataset.nil?
       end
 
       private
 
-      # Load queries from filesystem if :path was provided
+      # Loads queries from filesystem if :path was provided
       #
       # @api private
-      def initialize_queries
-        @queries = options[:queries].dup
-
-        return unless path
-
-        Dir["#{path}/*"].each do |dir|
-          dataset = File.basename(dir).to_sym
-          @queries[dataset] = {}
-          Dir["#{dir}/**/*.sql"].each do |file|
-            name = File.basename(file, '.*').to_sym
-            sql = File.read(file)
-            @queries[dataset][name] = sql.strip
+      def load_queries(path)
+        if path.nil?
+          {}
+        else
+          Dir["#{path}/*"].each_with_object({}) do |dir, fs_queries|
+            dataset = File.basename(dir).to_sym
+
+            fs_queries[dataset] = Dir["#{dir}/**/*.sql"].each_with_object({}) do |file, ds_queries|
+              query_name = File.basename(file, ".*").to_sym
+              sql = File.read(file).strip
+
+              ds_queries[query_name] = sql
+            end
           end
         end
       end