rom-sql 0.4.0.beta2 → 0.4.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c31ac7fa972f7d1fbc7c713386d27022cc23f40d
-  data.tar.gz: 01c29d65d87c5938bd54348c012cd081bf4931b2
+  metadata.gz: 57a2bfb4e1713bec72222dc1c886372999102814
+  data.tar.gz: 302233e252f9cf434f73bc8493d726fe849d5a28
 SHA512:
-  metadata.gz: b80a36a94602f5b5aa5c1ca11ac1b17d7d22d1cb342a682afa6487210ea8d39124062254c7867115bf9d25ccd31c29a795e71b6689529e0a37b404b14a71fc6e
-  data.tar.gz: bc46004965aa3c9c8a36d60cd56b23c86c8635efef47e7236905d00ada4647982a90de9693a6c8ca954f1c4de781730efaa9e0829d3ab0605e9ba57cf1681e34
+  metadata.gz: 9b0520c09a6e9db3c2ea2571df0b9c5f4815283f75b876c71bd6a5598d80f55208b5d7cc8468abbaa9f729d2ab9c9943603480da3f12483acbab5017c8deb0c0
+  data.tar.gz: d862d6d1892af178796824e0c1f09a5d393dab89c23966524ed24d67f4f706367d502bdf34339866e678c4550619829afe59875b4b86cfbd022dd3cf70b95902

data/CHANGELOG.md

@@ -7,6 +7,7 @@
 * `Update#change` interface for skipping execution when there's no diff (solnic)
 * Experimental migration API using sequel/migrations (gotar)
 * Pagination plugin (solnic)
+* Allow reuse of established Sequel connections (splattael)
 
 ### Changed
 

data/README.md

@@ -13,9 +13,12 @@
 [![Test Coverage](https://codeclimate.com/github/rom-rb/rom-sql/badges/coverage.svg)][codeclimate]
 [![Inline docs](http://inch-ci.org/github/rom-rb/rom-sql.svg?branch=master)][inchpages]
 
-
 RDBMS suport for [Ruby Object Mapper](https://github.com/rom-rb/rom).
 
+## Issues
+
+Please report any issues in the main [rom-rb/rom](https://github.com/rom-rb/rom/issues) issue tracker.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/rom/sql/repository.rb

@@ -6,38 +6,111 @@ require 'rom/sql/commands'
 module ROM
   module SQL
     class Repository < ROM::Repository
-      attr_reader :logger, :schema
+      # Return optionally configured logger
+      #
+      # @return [Object] logger
+      #
+      # @api public
+      attr_reader :logger
 
+      # Returns a list of datasets inferred from table names
+      #
+      # @return [Array] array with table names
+      #
+      # @api public
+      attr_reader :schema
+
+      # @param [String,Symbol] scheme
+      #
+      # @api public
       def self.database_file?(scheme)
         scheme.to_s.include?('sqlite')
       end
 
+      # SQL repository interface
+      #
+      # @overload connect(uri, options)
+      #   Connects to database via uri passing options
+      #
+      #   @param [String,Symbol] uri connection URI
+      #   @param [Hash] options connection options
+      #
+      # @overload connect(connection)
+      #   Re-uses connection instance
+      #
+      #   @param [Sequel::Database] connection a connection instance
+      #
+      # @example
+      #   repository = ROM::SQL::Repository.new('postgres://localhost/rom')
+      #
+      #   # or reuse connection
+      #   DB = Sequel.connect('postgres://localhost/rom')
+      #   repository = ROM::SQL::Repository.new(DB)
+      #
+      # @api public
       def initialize(uri, options = {})
-        @connection = ::Sequel.connect(uri.to_s, options)
+        @connection = connect(uri, options)
         @schema = connection.tables
       end
 
+      # Disconnect from database
+      #
+      # @api public
       def disconnect
         connection.disconnect
       end
 
+      # Return dataset with the given name
+      #
+      # @param [String] name dataset name
+      #
+      # @return [Dataset]
+      #
+      # @api public
       def [](name)
         connection[name]
       end
 
+      # Setup a logger
+      #
+      # @param [Object] logger
+      #
+      # @see Sequel::Database#loggers
+      #
+      # @api public
       def use_logger(logger)
         @logger = logger
         connection.loggers << logger
       end
 
-      def dataset(table)
-        connection[table]
+      # Return dataset with the given name
+      #
+      # @param [String] name a dataset name
+      #
+      # @return [Dataset]
+      #
+      # @api public
+      def dataset(name)
+        connection[name]
       end
 
+      # Check if dataset exists
+      #
+      # @param [String] name dataset name
+      #
+      # @api public
       def dataset?(name)
         schema.include?(name)
       end
 
+      # Extend database-specific behavior
+      #
+      # @param [Class] klass command class
+      # @param [Object] dataset a dataset that will be used
+      #
+      # Note: Currently, only postgres is supported.
+      #
+      # @api public
       def extend_command_class(klass, dataset)
         type = dataset.db.database_type
 
@@ -54,6 +127,22 @@ module ROM
 
         klass
       end
+
+      private
+
+      # Connect to database or reuse established connection instance
+      #
+      # @return [Database::Sequel] a connection instance
+      #
+      # @api private
+      def connect(uri, *args)
+        case uri
+        when ::Sequel::Database
+          uri
+        else
+          ::Sequel.connect(uri.to_s, *args)
+        end
+      end
     end
   end
 end

data/lib/rom/sql/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module SQL
-    VERSION = "0.4.0.beta2".freeze
+    VERSION = "0.4.0.rc1".freeze
   end
 end

data/rom-sql.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "sequel", "~> 4.18"
   spec.add_runtime_dependency "equalizer", "~> 0.0", ">= 0.0.9"
-  spec.add_runtime_dependency "rom", "~> 0.6.0.beta3"
+  spec.add_runtime_dependency "rom", "~> 0.6.0.rc1"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"

data/spec/integration/read_spec.rb

@@ -87,7 +87,7 @@ describe 'Reading relations' do
   end
 
   it 'loads domain objects' do
-    user = rom.read(:users).with_tasks.by_name('Piotr').to_a.first
+    user = rom.relation(:users).as(:users).with_tasks.by_name('Piotr').to_a.first
 
     expect(user).to eql(
       User.new(
@@ -98,7 +98,8 @@ describe 'Reading relations' do
   it 'works with grouping and aggregates' do
     rom.relations[:tasks].insert(id: 2, user_id: 1, title: 'Get Milk')
 
-    users_with_task_count = rom.read(:user_task_counts).all
+    users_with_task_count = rom.relation(:user_task_counts).as(:user_task_counts).all
+
     expect(users_with_task_count.to_a).to eq([
       UserTaskCount.new(id: 1, name: "Piotr", task_count: 2)
     ])

data/spec/shared/database_setup.rb

@@ -3,7 +3,7 @@ shared_context 'database setup' do
 
   let(:uri) { 'postgres://localhost/rom' }
   let(:conn) { Sequel.connect(uri) }
-  let(:setup) { ROM.setup(:sql, uri) }
+  let(:setup) { ROM.setup(:sql, conn) }
 
   def drop_tables
     [:users, :tasks, :tags, :task_tags].each { |name| conn.drop_table?(name) }
@@ -39,7 +39,6 @@ shared_context 'database setup' do
   end
 
   after do
-    rom.repositories[:default].disconnect
     conn.disconnect
   end
 end

data/spec/unit/many_to_one_spec.rb

@@ -34,7 +34,7 @@ describe 'Defining many-to-one association' do
       [{ id: 1, name: 'Piotr', title: 'Finish ROM' }]
     )
 
-    expect(rom.read(:tasks).all.with_user.to_a).to eql(
+    expect(rom.relation(:tasks).map_with(:with_user).all.with_user.to_a).to eql(
       [{ id: 1, title: 'Finish ROM', user: { name: 'Piotr' } }]
     )
   end

data/spec/unit/one_to_many_spec.rb

@@ -34,7 +34,10 @@ describe 'Defining one-to-many association' do
       [{ id: 1, name: 'Piotr', tasks_id: 1, title: 'Finish ROM' }]
     )
 
-    expect(rom.read(:users).all.with_tasks.by_name("Piotr").to_a).to eql(
+    result = rom.relation(:users).map_with(:with_tasks)
+      .all.with_tasks.by_name("Piotr").to_a
+
+    expect(result).to eql(
       [{ id: 1, name: 'Piotr', tasks: [{ tasks_id: 1, title: 'Finish ROM' }] }]
     )
   end

data/spec/unit/repository_spec.rb

@@ -28,6 +28,7 @@ describe ROM::SQL::Repository do
 
     it 'disconnects via sequel connection' do
       # FIXME: no idea how to test it in a different way
+      # FIXME: we are leaking connection here
       expect(repository.connection).to receive(:disconnect)
       repository.disconnect
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-sql
 version: !ruby/object:Gem::Version
-  version: 0.4.0.beta2
+  version: 0.4.0.rc1
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0.beta3
+        version: 0.6.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0.beta3
+        version: 0.6.0.rc1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: SQL databases support for ROM
@@ -193,4 +193,3 @@ test_files:
 - spec/unit/relation_spec.rb
 - spec/unit/repository_spec.rb
 - spec/unit/schema_spec.rb
-has_rdoc: