rom-yesql 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d2f166f3d42301d471b4979669d1da6895a2cff
-  data.tar.gz: 3aeb1b4e7a6aa628b37a67fb6c82c1b56b76281e
+  metadata.gz: 2aedcc9a8aee73d1d75cf44cf9ffcea7c2750e64
+  data.tar.gz: fb51885ac908e9131e4ceca401549ad214097391
 SHA512:
-  metadata.gz: d94b71f2804916243042a0b34236303deba1fdc6b8ff8a850572927b7953b2a84743a5d90342ced89c5a82d1731130dc5117faa797c1862ff550c9319798ffd7
-  data.tar.gz: f9f3336ac5eda3bd80a21125c1e3a332016e8230158effdc3b3473d26eba79b2fad70d4590919d9297f8bcfd185a07e629ef1df6beacf8868d4e29ad6afe8fb2
+  metadata.gz: ae27fce18a060dcb5f88b6c0bb8eab3acbf5dd37e8996dd3b38a8012d4a84f4bd1c4d5285076272f9ccb6c1cae187e4fa3351d0ad1594fe5849cf622aaba2343
+  data.tar.gz: bec60620f2ae3ae65e806b00ff320c04fb291a8895691ee170fcce48ea65602618bb4c40290d649fedd7e714cac626c91ad4c6e20e6877cfe7f2ec077194c7e5

data/.rubocop.yml

@@ -29,7 +29,7 @@ Style/AsciiComments:
   Enabled: false
 
 # Allow using braces for value-returning blocks
-Style/Blocks:
+Style/BlockDelimiters:
   Enabled: false
 
 # Documentation checked by Inch CI
@@ -53,10 +53,6 @@ Style/OpMethod:
   Exclude:
     - lib/rom/command_registry.rb
 
-# Even a single escaped slash can be confusing
-Style/RegexpLiteral:
-  MaxSlashes: 0
-
 # Don’t introduce semantic fail/raise distinction
 Style/SignalException:
   EnforcedStyle: only_raise

data/.rubocop_todo.yml

@@ -1,15 +1,21 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-03-01 15:08:21 +0100 using RuboCop version 0.29.1.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-09-26 18:14:52 +0200 using RuboCop version 0.34.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-Lint/HandleExceptions:
-  Enabled: false
+Metrics/AbcSize:
+  Max: 19
 
-# Offense count: 1
+# Offense count: 4
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
-  Max: 81
+  Max: 83
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 11

data/.travis.yml

@@ -4,11 +4,11 @@ cache: bundler
 bundler_args: --without tools
 script: "bundle exec rake ci"
 rvm:
-  - 2.0
   - 2.1
   - 2.2
+  - 2.3.1
   - rbx-2
-  - jruby
+  - jruby-9.0.5.0
   - jruby-head
   - ruby-head
 env:

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+## v0.3.0 2016-07-31
+
+Updated to work with rom 2.0.0
+
 ## v0.2.0 2015-08-19
 
-Updated to work with ROM 0.9.0
+Updated to work with rom 0.9.0
 
 [Compare v0.1.1...v0.2.0](https://github.com/rom-rb/rom-yaml/compare/v0.1.0...v0.2.0)
 
@@ -8,17 +12,17 @@ Updated to work with ROM 0.9.0
 
 ### 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-yaml/compare/v0.1.0...v0.1.1)
 
 ## v0.1.0 2015-03-22
 
-Bump ROM dep to 0.6.0 final
+Bump rom dep to 0.6.0 final
 
 ## v0.0.2 2015-03-21
 
-Update to work with ROM 0.6.0
+Update to work with rom 0.6.0
 
 ## v0.0.1 2015-03-01
 

data/Gemfile

@@ -3,18 +3,13 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rom', github: 'rom-rb/rom', branch: 'master'
   gem 'inflecto'
-  gem 'rspec', '~> 3.1'
+  gem 'rspec', '~> 3.5'
   gem 'codeclimate-test-reporter', require: false
   gem 'sqlite3', platforms: [:mri, :rbx]
   gem 'jdbc-sqlite3', platforms: :jruby
 end
 
 group :tools do
-  gem 'guard'
   gem 'byebug', platforms: [:mri]
-  gem 'guard-rspec'
-  gem 'guard-rubocop'
-  gem 'rubocop', '~> 0.28'
 end

data/README.md

@@ -4,11 +4,11 @@
 [codeclimate]: https://codeclimate.com/github/rom-rb/rom-yesql
 [inchpages]: http://inch-ci.org/github/rom-rb/rom-yesql
 
-# ROM::Yesql
+# rom-yesql
 
 [![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]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom-yesql.svg)][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]
 [![Inline docs](http://inch-ci.org/github/rom-rb/rom-yesql.svg?branch=master)][inchpages]
@@ -16,6 +16,9 @@
 
 [Yesql](https://github.com/krisajenkins/yesql)-like adapter for [Ruby Object Mapper](https://github.com/rom-rb/rom).
 
+* [API docs](http://rubydoc.info/gems/rom-yesql)
+* [ROM user docs](http://rom-rb.org/learn)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,22 +35,6 @@ 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
-```
-
 ## License
 
 See `LICENSE` file.

data/lib/rom/yesql/gateway.rb

@@ -1,5 +1,7 @@
 require 'sequel'
 
+require 'rom/support/options'
+
 require 'rom/yesql/dataset'
 require 'rom/yesql/relation'
 
@@ -7,49 +9,60 @@ 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
 
+      # @!attribute [r] path
+      #   @return [String] a path to files with SQL queries
       option :path, reader: true
-      option :queries, type: Hash, default: EMPTY_HASH
-      option :query_proc, reader: true, default: proc { |gateway|
+
+      # @!attribute [r] queries
+      #   @return [Hash] a hash with queries
+      option :queries, type: Hash, default: EMPTY_HASH, reader: true
+
+      # @!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
+      #   # 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(uri, options = {})
         super
         @connection = Sequel.connect(uri, options)
@@ -59,15 +72,23 @@ module ROM
         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?
@@ -75,7 +96,7 @@ module ROM
 
       private
 
-      # Load queries from filesystem if :path was provided
+      # Loads queries from filesystem if :path was provided
       #
       # @api private
       def initialize_queries

data/lib/rom/yesql/relation.rb

@@ -11,7 +11,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,9 +21,11 @@ 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
@@ -46,7 +50,7 @@ module ROM
         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 +70,7 @@ module ROM
       #
       # @return [Hash]
       #
-      # @api privatek
+      # @api private
       def self.queries
         @queries || {}
       end
@@ -86,7 +90,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

@@ -2,11 +2,13 @@ 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]
         #

data/lib/rom/yesql/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Yesql
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/rakelib/rubocop.rake

@@ -14,5 +14,5 @@ begin
     end
   end
 
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/HandleExceptions
 end

data/rom-yesql.gemspec

@@ -18,8 +18,8 @@ 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", "~> 2.0"
+  spec.add_runtime_dependency 'sequel', '~> 4.27'
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
 end

data/spec/integration/adapter_spec.rb

@@ -3,23 +3,21 @@ require 'spec_helper'
 describe 'ROM / Yesql' do
   include_context 'users and tasks'
 
-  let(:rom) { setup.finalize }
+  let(:container) { ROM.container(configuration) }
 
-  let!(:setup) do
-    ROM.setup(:yesql, [uri, path: path, queries: { reports: report_queries }])
+  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(:users) { rom.relation(:users) }
-  let(:tasks) { rom.relation(:tasks) }
-  let(:reports) { rom.relation(:reports) }
+  let(:users) { container.relation(:users) }
+  let(:tasks) { container.relation(:tasks) }
+  let(:reports) { container.relation(:reports) }
 
   before do
-    class Users < ROM::Relation[:yesql]
-    end
-
-    class Tasks < ROM::Relation[:yesql]
+    configuration.relation(:users)
+    configuration.relation(:tasks) do
       query_proc(proc { |_name, query, opts| query.gsub(':id:', opts[:id].to_s) })
     end
 
@@ -28,6 +26,8 @@ describe 'ROM / Yesql' do
         dataset :reports
       end
     end
+
+    configuration.register_relation(Test::Reports)
   end
 
   describe 'query method' do

data/spec/spec_helper.rb

@@ -16,7 +16,7 @@ require 'logger'
 
 begin
   require 'byebug'
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/HandleExceptions
 end
 
 LOGGER = Logger.new(File.open('./log/test.log', 'a'))
@@ -35,5 +35,3 @@ RSpec.configure do |config|
     added_constants.each { |name| Object.send(:remove_const, name) }
   end
 end
-
-ROM.use :auto_registration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-yesql
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2016-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rom
@@ -16,34 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.19.0
+        version: '4.27'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.19.0
+        version: '4.27'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Yesql adapter for ROM