rom-yesql 0.2.0 → 1.0.0

data/lib/rom/yesql/relation.rb

@@ -1,5 +1,9 @@
-require 'rom/relation'
-require 'rom/yesql/relation/class_interface'
+# frozen_string_literal: true
+
+require "dry/core/class_attributes"
+
+require "rom/relation"
+require "rom/yesql/relation/class_interface"
 
 module ROM
   module Yesql
@@ -11,7 +15,9 @@ module ROM
     # It also supports overriding query_proc
     #
     # @example
-    #   ROM.setup(:yesql, [uri, path: '/my/sql/queries/are/here'])
+    #   conf = ROM::Configuration.new(
+    #     :yesql, ['sqlite::memory', path: '/my/sql/queries/are/here']
+    #   )
     #
     #   class Reports < ROM::Relation[:yesql]
     #     query_proc(proc { |name, query, *args|
@@ -19,15 +25,17 @@ module ROM
     #     })
     #   end
     #
-    #   rom = ROM.finalize.env
+    #   conf.register_relation(Reports)
     #
-    #   rom.relation(:reports) # use like a normal rom relation
+    #   rom = ROM.container(conf)
+    #
+    #   rom.relations[:reports] # use like a normal rom relation
     #
     # @api public
     class Relation < ROM::Relation
       adapter :yesql
 
-      extend ClassMacros
+      extend Dry::Core::ClassAttributes
 
       defines :query_proc
 
@@ -43,10 +51,9 @@ module ROM
       def self.inherited(klass)
         super
         klass.extend(ClassInterface)
-        define_query_methods(klass, queries[klass.dataset] || {})
       end
 
-      # Extend provided klass with query methods
+      # Extends provided klass with query methods
       #
       # @param [Class] klass A relation class
       # @param [Hash] queries A hash with name, query pairs for the relation
@@ -66,7 +73,7 @@ module ROM
       #
       # @return [Hash]
       #
-      # @api privatek
+      # @api private
       def self.queries
         @queries || {}
       end
@@ -86,7 +93,7 @@ module ROM
         @queries
       end
 
-      # Return query proc set on a relation class
+      # Returns query proc set on a relation class
       #
       # By default this returns whatever was set in the gateway or the default
       # one which simply uses hash % query to evaluate a query string

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

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 module ROM
   module Yesql
     class Relation < ROM::Relation
       module ClassInterface
-        # Set dataset name for the relation class
+        # Sets dataset name for the relation class
         #
         # The class will be extended with queries registered under that name.
         # By default dataset name is derived from the class name, which doesn't
-        # have to match they key under which its queries were registered
+        # have to match the key under which its queries were registered
+        #
+        # @param name [String]
         #
         # @return [Symbol]
         #
         # @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/version.rb

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

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,10 @@ 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
 end

data/rom-yesql.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rom/yesql/version'
@@ -18,8 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'rom', '~> 0.9', '>= 0.9.0'
-  spec.add_runtime_dependency 'sequel', '~> 4.19.0'
+  spec.add_runtime_dependency "rom", "~>5"
+  spec.add_runtime_dependency "dry-core", "~>0.4"
+  spec.add_runtime_dependency "sequel", "~>5"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
 end

data/spec/integration/adapter_spec.rb

@@ -1,59 +1,61 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'ROM / Yesql' do
-  include_context 'users and tasks'
+require "spec_helper"
 
-  let(:rom) { setup.finalize }
+RSpec.describe "ROM / Yesql" do
+  include_context "users and tasks"
 
-  let!(:setup) do
-    ROM.setup(:yesql, [uri, path: path, queries: { reports: report_queries }])
+  let(:container) { ROM.container(configuration) }
+
+  let!(:configuration) do
+    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) { rom.relation(:users) }
-  let(:tasks) { rom.relation(:tasks) }
-  let(:reports) { rom.relation(:reports) }
+  let(:users) { container.relations[:users] }
+  let(:tasks) { container.relations[:tasks] }
+  let(:reports) { container.relations[:reports] }
 
   before do
-    class Users < ROM::Relation[:yesql]
-    end
-
-    class Tasks < ROM::Relation[:yesql]
-      query_proc(proc { |_name, query, opts| query.gsub(':id:', opts[:id].to_s) })
+    configuration.relation(:users)
+    configuration.relation(:tasks) do
+      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 @@
-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 @@
-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 @@
-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,39 +1,39 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'bundler'
+require "bundler"
 Bundler.setup
 
-if RUBY_ENGINE == 'rbx'
-  require "codeclimate-test-reporter"
-  CodeClimate::TestReporter.start
-end
+require_relative "support/coverage" if ENV["COVERAGE"] == "true"
+
+require_relative "support/warnings"
+
+Warning.process { |w| raise w } if ENV["FAIL_ON_WARNINGS"].eql?("true")
 
-require 'rom-yesql'
-# FIXME: why do we need to require it manually??
-require 'sequel/adapters/sqlite' unless RUBY_ENGINE == 'jruby'
-require 'inflecto'
-require 'logger'
+require "rom-yesql"
+require "inflecto"
+require "logger"
 
 begin
-  require 'byebug'
+  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
 
-Dir[root.join('shared/*.rb').to_s].each { |f| require f }
-
 RSpec.configure do |config|
   config.before do
-    @constants = Object.constants
+    module Test
+    end
   end
 
   config.after do
-    added_constants = Object.constants - @constants
-    added_constants.each { |name| Object.send(:remove_const, name) }
+    Object.send(:remove_const, :Test)
   end
+
+  config.disable_monkey_patching!
+  config.warnings = true
 end
 
-ROM.use :auto_registration
+Dir[root.join("shared/*.rb").to_s].sort.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/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
 
-describe ROM::Yesql::Gateway do
-  include_context 'gateway setup'
+require "spec_helper"
 
-  it 'loads queries from file system when :path is provided' do
+RSpec.describe ROM::Yesql::Gateway do
+  include_context "gateway setup"
+
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-yesql
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Piotr Solnica
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2020-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rom
@@ -16,34 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: dry-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.19.0
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.19.0
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -79,17 +87,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devtools/templates/changelog.erb"
+- ".github/ISSUE_TEMPLATE/----please-don-t-ask-for-support-via-issues.md"
+- ".github/ISSUE_TEMPLATE/---bug-report.md"
+- ".github/ISSUE_TEMPLATE/---feature-request.md"
+- ".github/workflows/ci.yml"
+- ".github/workflows/docsite.yml"
+- ".github/workflows/sync_configs.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
+- Gemfile.devtools
 - Guardfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
+- changelog.yml
 - db/.gitkeep
 - lib/rom-yesql.rb
 - lib/rom/yesql.rb
@@ -99,6 +116,7 @@ files:
 - lib/rom/yesql/relation/class_interface.rb
 - lib/rom/yesql/version.rb
 - log/.gitkeep
+- project.yml
 - rakelib/rubocop.rake
 - rom-yesql.gemspec
 - spec/fixtures/tasks/by_id.sql
@@ -108,12 +126,14 @@ files:
 - spec/shared/repository_setup.rb
 - spec/shared/users_and_tasks.rb
 - spec/spec_helper.rb
+- spec/support/coverage.rb
+- spec/support/warnings.rb
 - spec/unit/rom/yesql/repository_spec.rb
 homepage: http://rom-rb.org
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,9 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Yesql adapter for ROM
 test_files:
@@ -141,4 +160,6 @@ test_files:
 - spec/shared/repository_setup.rb
 - spec/shared/users_and_tasks.rb
 - spec/spec_helper.rb
+- spec/support/coverage.rb
+- spec/support/warnings.rb
 - spec/unit/rom/yesql/repository_spec.rb