rom-yesql 0.5.1 → 1.1.0

data/lib/rom/yesql/gateway.rb

@@ -1,9 +1,11 @@
-require 'sequel'
+# frozen_string_literal: true
 
-require 'rom/initializer'
+require "sequel"
 
-require 'rom/yesql/dataset'
-require 'rom/yesql/relation'
+require "rom/initializer"
+
+require "rom/yesql/dataset"
+require "rom/yesql/relation"
 
 module ROM
   module Yesql
@@ -13,7 +15,7 @@ module ROM
     # expose access to gateway's queries.
     #
     # @api public
-    class Gateway < ROM::Gateway
+    class Gateway < ::ROM::Gateway
       extend Initializer
 
       adapter :yesql
@@ -69,9 +71,9 @@ module ROM
       #   @option :query_proc [Proc]
       #
       # @api public
-      def initialize(*)
+      def initialize(*, **)
         super
-        @connection = Sequel.connect(uri, options)
+        @connection = ::Sequel.connect(uri, options)
         @queries = @queries.merge(load_queries(path)).freeze
         Relation.query_proc(query_proc)
         Relation.load_queries(queries)
@@ -96,7 +98,7 @@ module ROM
       #
       # @api private
       def dataset?(_name)
-        ! @dataset.nil?
+        !@dataset.nil?
       end
 
       private
@@ -108,20 +110,21 @@ module ROM
         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
+          ::Dir["#{path}/*"].to_h do |dir|
+            [
+              ::File.basename(dir).to_sym,
+              ::Dir["#{dir}/**/*.sql"].to_h do |file|
+                query_name = ::File.basename(file, ".*").to_sym
+                sql = ::File.read(file).strip
+
+                [query_name, sql]
+              end
+            ]
           end
         end
       end
     end
   end
 
-  register_adapter(:yesql, ROM::Yesql)
+  register_adapter(:yesql, Yesql)
 end

data/lib/rom/yesql/relation/class_interface.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ROM
   module Yesql
-    class Relation < ROM::Relation
+    class Relation < ::ROM::Relation
       module ClassInterface
         # Sets dataset name for the relation class
         #
@@ -14,10 +16,9 @@ module ROM
         #
         # @api public
         def dataset(name = Undefined)
-          return @dataset if name == Undefined
-          @dataset = name
+          name = relation_name.to_sym if name == Undefined
           define_query_methods(self, Relation.queries[name] || {})
-          @dataset
+          ->(*) { self }
         end
       end
     end

data/lib/rom/yesql/relation.rb

@@ -1,7 +1,9 @@
-require 'dry/core/class_attributes'
+# frozen_string_literal: true
 
-require 'rom/relation'
-require 'rom/yesql/relation/class_interface'
+require "dry/core/class_attributes"
+
+require "rom/relation"
+require "rom/yesql/relation/class_interface"
 
 module ROM
   module Yesql
@@ -30,14 +32,14 @@ module ROM
     #   rom.relations[:reports] # use like a normal rom relation
     #
     # @api public
-    class Relation < ROM::Relation
+    class Relation < ::ROM::Relation
       adapter :yesql
 
-      extend Dry::Core::ClassAttributes
+      extend ::Dry::Core::ClassAttributes
 
       defines :query_proc
 
-      Materialized = Class.new(ROM::Relation)
+      Materialized = ::Class.new(::ROM::Relation)
 
       # Extends a relation with query methods
       #
@@ -49,7 +51,6 @@ module ROM
       def self.inherited(klass)
         super
         klass.extend(ClassInterface)
-        define_query_methods(klass, queries[klass.dataset] || {})
       end
 
       # Extends provided klass with query methods
@@ -83,13 +84,9 @@ module ROM
       #
       # @api private
       def self.load_queries(queries)
-        @queries = {}
-        queries.each do |ds, ds_queries|
-          @queries[ds] = ds_queries.each_with_object({}) do |(name, query), h|
-            h[name] = query
-          end
+        @queries = queries.to_h do |ds, ds_queries|
+          [ds, ds_queries.to_h { |name, query| [name, query] }]
         end
-        @queries
       end
 
       # Returns query proc set on a relation class

data/lib/rom/yesql/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ROM
   module Yesql
-    VERSION = '0.5.1'.freeze
+    VERSION = "1.1.0"
   end
 end

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.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/project.yml

@@ -0,0 +1,2 @@
+name: rom-yesql
+codacy_id: 88fbb464691e4666b94e0455468b68bf

data/rakelib/rubocop.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require "rubocop/rake_task"
 
@@ -8,11 +10,11 @@ begin
   end
 
   namespace :rubocop do
-    desc 'Generate a configuration file acting as a TODO list.'
+    desc "Generate a configuration file acting as a TODO list."
     task :auto_gen_config do
       exec "bundle exec rubocop --auto-gen-config"
     end
   end
-
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError
+  # rubocop is not available
 end

data/rom-yesql.gemspec

@@ -1,13 +1,15 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rom/yesql/version'
+require "rom/yesql/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "rom-yesql"
   spec.version       = ROM::Yesql::VERSION.dup
   spec.authors       = ["Piotr Solnica"]
   spec.email         = ["piotr.solnica@gmail.com"]
-  spec.summary       = 'Yesql adapter for ROM'
+  spec.summary       = "Yesql adapter for ROM"
   spec.description   = spec.summary
   spec.homepage      = "http://rom-rb.org"
   spec.license       = "MIT"
@@ -16,10 +18,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 3.1.0"
 
-  spec.add_runtime_dependency "rom", "~> 3.2"
-  spec.add_runtime_dependency "dry-core", "~> 0.2", ">= 0.2.4"
-  spec.add_runtime_dependency "sequel", "~> 4.27"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "dry-core", "~>1.1"
+  spec.add_runtime_dependency "rom", "~> 5.4"
+  spec.add_runtime_dependency "sequel", "~> 5"
 end

data/spec/integration/adapter_spec.rb

@@ -1,59 +1,61 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-RSpec.describe 'ROM / Yesql' do
-  include_context 'users and tasks'
+require "spec_helper"
+
+RSpec.describe "ROM / Yesql" do
+  include_context "users and tasks"
 
   let(:container) { ROM.container(configuration) }
 
   let!(:configuration) do
-    ROM::Configuration.new(:yesql, [uri, path: path, queries: { reports: report_queries }])
+    ROM::Configuration.new(:yesql, uri, path: path, queries: {reports: report_queries})
   end
 
-  let(:report_queries) { { all_users: 'SELECT * FROM users ORDER BY %{order}' } }
+  let(:report_queries) { {all_users: "SELECT * FROM users ORDER BY %{order}"} }
 
-  let(:users) { container.relation(:users) }
-  let(:tasks) { container.relation(:tasks) }
-  let(:reports) { container.relation(:reports) }
+  let(:users) { container.relations[:users] }
+  let(:tasks) { container.relations[:tasks] }
+  let(:reports) { container.relations[:reports] }
 
   before do
     configuration.relation(:users)
     configuration.relation(:tasks) do
-      query_proc(proc { |_name, query, opts| query.gsub(':id:', opts[:id].to_s) })
+      query_proc(proc { |_name, query, opts| query.gsub(":id:", opts[:id].to_s) })
     end
 
     module Test
       class Reports < ROM::Relation[:yesql]
-        dataset :reports
+        schema :reports, infer: true
       end
     end
 
     configuration.register_relation(Test::Reports)
   end
 
-  describe 'query method' do
-    it 'uses hash-based interpolation by default' do
-      expect(users.by_name(name: 'Jane')).to match_array([
-        { id: 1, name: 'Jane' }
+  describe "query method" do
+    it "uses hash-based interpolation by default" do
+      expect(users.by_name(name: "Jane")).to match_array([
+        {id: 1, name: "Jane"}
       ])
     end
 
-    it 'uses provided proc to preprocess a query' do
+    it "uses provided proc to preprocess a query" do
       expect(tasks.by_id(id: 1)).to match_array([
-        { id: 1, title: 'Task One' }
+        {id: 1, title: "Task One"}
       ])
     end
 
-    it 'uses queries provided explicitly during setup' do
-      expect(reports.all_users(order: 'name').to_a).to eql([
-        { id: 3, name: 'Jade' },
-        { id: 1, name: 'Jane' },
-        { id: 2, name: 'Joe' }
+    it "uses queries provided explicitly during setup" do
+      expect(reports.all_users(order: "name").to_a).to eql([
+        {id: 3, name: "Jade"},
+        {id: 1, name: "Jane"},
+        {id: 2, name: "Joe"}
       ])
     end
 
-    it 'returns rom relation' do
-      relation = users.by_name(name: 'Jane') >> proc { |r| r.map { |t| t[:name] } }
-      expect(relation).to match_array(['Jane'])
+    it "returns rom relation" do
+      relation = users.by_name(name: "Jane") >> proc { |r| r.map { |t| t[:name] } }
+      expect(relation).to match_array(["Jane"])
     end
   end
 end

data/spec/shared/database_setup.rb

@@ -1,10 +1,12 @@
-RSpec.shared_context 'database setup' do
-  include_context 'gateway setup'
+# frozen_string_literal: true
+
+RSpec.shared_context "database setup" do
+  include_context "gateway setup"
 
   let!(:conn) { Sequel.connect(uri) }
 
   def drop_tables
-    [:users, :tasks].each { |name| conn.drop_table?(name) }
+    %i[users tasks].each { |name| conn.drop_table?(name) }
   end
 
   before do

data/spec/shared/repository_setup.rb

@@ -1,10 +1,12 @@
-RSpec.shared_context 'gateway setup' do
-  let(:root) { Pathname(__FILE__).dirname.join('../..') }
-  let(:path) { root.join('spec/fixtures') }
+# frozen_string_literal: true
 
-  if RUBY_ENGINE == 'jruby'
-    let(:uri) { "jdbc:sqlite://#{root.join('db/test.sqlite')}" }
+RSpec.shared_context "gateway setup" do
+  let(:root) { Pathname(__FILE__).dirname.join("../..") }
+  let(:path) { root.join("spec/fixtures") }
+
+  if RUBY_ENGINE == "jruby"
+    let(:uri) { "jdbc:sqlite://#{root.join("db/test.sqlite")}" }
   else
-    let(:uri) { "sqlite://#{root.join('db/test.sqlite')}" }
+    let(:uri) { "sqlite://#{root.join("db/test.sqlite")}" }
   end
 end

data/spec/shared/users_and_tasks.rb

@@ -1,12 +1,14 @@
-RSpec.shared_context 'users and tasks' do
-  include_context 'database setup'
+# frozen_string_literal: true
+
+RSpec.shared_context "users and tasks" do
+  include_context "database setup"
 
   before do
-    conn[:users].insert id: 1, name: 'Jane'
-    conn[:users].insert id: 2, name: 'Joe'
-    conn[:users].insert id: 3, name: 'Jade'
+    conn[:users].insert id: 1, name: "Jane"
+    conn[:users].insert id: 2, name: "Joe"
+    conn[:users].insert id: 3, name: "Jade"
 
-    conn[:tasks].insert id: 1, title: 'Task One'
-    conn[:tasks].insert id: 2, title: 'Task Two'
+    conn[:tasks].insert id: 1, title: "Task One"
+    conn[:tasks].insert id: 2, title: "Task Two"
   end
 end

data/spec/spec_helper.rb

@@ -1,29 +1,23 @@
-require 'bundler'
+# frozen_string_literal: true
+
+require "bundler"
 Bundler.setup
 
-if RUBY_ENGINE == 'ruby' && ENV['COVERAGE'] == 'true'
-  require 'yaml'
-  rubies = YAML.load(File.read(File.join(__dir__, '..', '.travis.yml')))['rvm']
-  latest_mri = rubies.select { |v| v =~ /\A\d+\.\d+.\d+\z/ }.max
+require_relative "support/coverage" if ENV["COVERAGE"] == "true"
 
-  if RUBY_VERSION == latest_mri
-    require 'simplecov'
-    SimpleCov.start do
-      add_filter '/spec/'
-    end
-  end
-end
+require_relative "support/warnings"
+
+Warning.process { |w| raise w } if ENV["FAIL_ON_WARNINGS"].eql?("true")
 
-require 'rom-yesql'
-require 'inflecto'
-require 'logger'
+require "rom-yesql"
+require "logger"
 
 begin
-  require 'byebug'
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+  require "byebug"
+rescue LoadError
 end
 
-LOGGER = Logger.new(File.open('./log/test.log', 'a'))
+LOGGER = Logger.new(File.open("./log/test.log", "a"))
 
 root = Pathname(__FILE__).dirname
 
@@ -41,4 +35,4 @@ RSpec.configure do |config|
   config.warnings = true
 end
 
-Dir[root.join('shared/*.rb').to_s].each { |f| require f }
+Dir[root.join("shared/*.rb").to_s].each { |f| require f }

data/spec/support/coverage.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# this file is managed by rom-rb/devtools
+
+if ENV["COVERAGE"] == "true"
+  require "simplecov"
+  require "simplecov-cobertura"
+
+  SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+
+  SimpleCov.start do
+    add_filter "/spec/"
+    enable_coverage :branch
+  end
+end

data/spec/support/rspec_options.rb

@@ -0,0 +1,16 @@
+RSpec.configure do |config|
+  # When no filter given, search and run focused tests
+  config.filter_run_when_matching :focus
+
+  # Disables rspec monkey patches (no reason for their existence tbh)
+  config.disable_monkey_patching!
+
+  # Run ruby in verbose mode
+  config.warnings = true
+
+  # Collect all failing expectations automatically,
+  # without calling aggregate_failures everywhere
+  config.define_derived_metadata do |meta|
+    meta[:aggregate_failures] = true
+  end
+end

data/spec/support/warnings.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# this file is managed by rom-rb/devtools project
+
+require "warning"
+
+Warning.ignore(%r{rspec/core})
+Warning.ignore(%r{rspec/mocks})
+Warning.ignore(/codacy/)
+Warning[:experimental] = false if Warning.respond_to?(:[])

data/spec/unit/rom/yesql/repository_spec.rb

@@ -1,36 +1,38 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 RSpec.describe ROM::Yesql::Gateway do
-  include_context 'gateway setup'
+  include_context "gateway setup"
 
-  it 'loads queries from file system when :path is provided' do
+  it "loads queries from file system when :path is provided" do
     gateway = ROM::Yesql::Gateway.new(uri, path: path)
 
     expect(gateway.queries.keys).to match_array([:users, :tasks])
   end
 
-  it 'combines queries from :queries option and loaded from provided :path' do
-    queries = { reports: { true: 'SELECT 1' } }
+  it "combines queries from :queries option and loaded from provided :path" do
+    queries = {reports: {true: "SELECT 1"}}
     gateway = ROM::Yesql::Gateway.new(uri, path: path, queries: queries)
 
     expect(gateway.queries.keys).to match_array([:users, :tasks, :reports])
   end
 
-  it 'loads queries from :queries option' do
-    queries = { reports: { true: 'SELECT 1' } }
+  it "loads queries from :queries option" do
+    queries = {reports: {true: "SELECT 1"}}
     gateway = ROM::Yesql::Gateway.new(uri, queries: queries)
 
     expect(gateway.queries).to eql(queries)
   end
 
-  it 'loads empty queries hash when no options were provided' do
+  it "loads empty queries hash when no options were provided" do
     gateway = ROM::Yesql::Gateway.new(uri)
 
     expect(gateway.queries).to eql({})
   end
 
-  it 'freezes queries' do
-    queries = { reports: { true: 'SELECT 1' } }
+  it "freezes queries" do
+    queries = {reports: {true: "SELECT 1"}}
     gateway = ROM::Yesql::Gateway.new(uri, queries: queries)
 
     expect(gateway.queries).to be_frozen