rom-sql 1.0.0.beta3 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c94e3593d4f6fbe8a49111c097a6721ae9d5dfc
-  data.tar.gz: 0b12c00984a1b6943465d608fe97e66c78beda47
+  metadata.gz: 7a382cb7f94949a99c91fd0a25edec94612b15da
+  data.tar.gz: b87bb54a9ae16bbcd2ac87bf416a80582a4df16e
 SHA512:
-  metadata.gz: 3fc3303b1f6c7b5415d44186bc857b7f8a5add043b1b9f990f2b003003bfa8fddd87fc6feb30532759b4548919dbfbffeea2c560a42faff3225b0894933ee2c8
-  data.tar.gz: 449816a9fe18c46ba4b65a64e0397121d57c9593a3fffd1ffdab7da04e29eb33a2a40a49cdf8c1859b3e974c68e71a6971eae3afc47a8316715c9c1d8746958d
+  metadata.gz: 45f97617413eac1f6c5bb3cf88cd313b74769b9c3e01f5a43939f90e0b48a2f72925b7043b74deeb7c83c9b5cdcf546aa3e347c81b970e521564c13f64c4067b
+  data.tar.gz: bfeab37bc67d5ed98e3bb75340ab8df8711653146d9f641d1092aef4c42433c974b32aa7af9bc8198a2df16b034523e6e50ac360df7d2890ecf7a15dbee3acd4

data/.travis.yml

@@ -10,21 +10,21 @@ before_script:
   - psql -c 'create database rom_sql;' -U postgres
   - mysql -u root -e 'create database rom_sql;'
 after_success:
-  - '[ "$TRAVIS_RUBY_VERSION" = "2.3.1" ] && [ "$TRAVIS_BRANCH" = "master" ] && bundle exec codeclimate-test-reporter'
+  - '[ "${TRAVIS_JOB_NUMBER#*.}" = "1" ] && [ "$TRAVIS_BRANCH" = "master" ] && bundle exec codeclimate-test-reporter'
 script: "bundle exec rake ci"
 rvm:
-  - 2.2.5
-  - 2.3.3
   - 2.4.0
+  - 2.3
+  - 2.2
   - rbx-3
-  - jruby
+  - jruby-9.1.6.0
 env:
   global:
     - CODECLIMATE_REPO_TOKEN=03d7f66589572702b12426d2bc71c4de6281a96139e33b335b894264b1f8f0b0
     - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
-    - rvm: rbx
+    - rvm: jruby-9.1.6.0
 notifications:
   webhooks:
     urls:

data/.yardopts

@@ -0,0 +1,2 @@
+--query '@api.text != "private"'
+--embed-mixins

data/CHANGELOG.md

@@ -16,10 +16,13 @@ Please refer to [the upgrading guide](https://github.com/rom-rb/rom-sql/wiki/Upg
 * Schema attribute types are now SQL-specific and compatible with query DSL (ie you can pass relation attributes to `select` and they will be automatically converted to valid SQL expressions) (solnic)
 * Associations support setting custom `view` that will be used to extend association relation (solnic)
 * Associations support setting custom `foreign_key` names (solnic)
+* Update commands has `:associates` plugin enabled (solnic)
 * Support for self-referencing associations (ie categories have_many child categories) (solnic)
 * Inferrers for mysql and sqlite were added (flash-gordon)
-* PG's auto-inferrer can handle `inet`/`cidr` data types in a two-way manner, i.e. converting them back and forth on reading and writing. Same for `point` datatype (flash-gordon)
+* PG's auto-inferrer can handle `inet`/`cidr`/`point` data types in a two-way manner, i.e. converting them back and forth on reading and writing (flash-gordon)
+* Support for inferring more PG types: `macaddr`, `xml` (flash-gordon)
 * `ROM::SQL::Relation::SequelAPI` extension for backward-compatible query API (this will be deprecated in 1.1.0 and removed in 2.0.0) (solnic)
+* Added `Object` type for `SQLite` which is used by the inferrer for columns without a type affinity (flash-gordon)
 
 ### Changed
 

data/lib/rom/plugins/relation/sql/auto_combine.rb

@@ -2,6 +2,7 @@ module ROM
   module Plugins
     module Relation
       module SQL
+        # @api private
         module AutoCombine
           # @api private
           def self.included(klass)
@@ -12,7 +13,9 @@ module ROM
             end
           end
 
+          # @api private
           module ClassInterface
+            # @api private
             def inherited(klass)
               super
               klass.auto_curry :for_combine
@@ -20,6 +23,7 @@ module ROM
             end
           end
 
+          # @api private
           module InstanceInterface
             # Default methods for fetching combined relation
             #

data/lib/rom/plugins/relation/sql/auto_wrap.rb

@@ -2,6 +2,7 @@ module ROM
   module Plugins
     module Relation
       module SQL
+        # @api private
         module AutoWrap
           # @api private
           def self.included(klass)
@@ -12,13 +13,16 @@ module ROM
             end
           end
 
+          # @api private
           module ClassInterface
+            # @api private
             def inherited(klass)
               super
               klass.auto_curry :for_wrap
             end
           end
 
+          # @api private
           module InstanceInterface
             # Default methods for fetching wrapped relation
             #

data/lib/rom/sql/{type.rb → attribute.rb}

@@ -1,13 +1,16 @@
-require 'rom/schema/type'
+require 'rom/schema/attribute'
 
 module ROM
   module SQL
-    class Type < ROM::Schema::Type
+    # Extended schema attributes tailored for SQL databases
+    #
+    # @api public
+    class Attribute < ROM::Schema::Attribute
       QualifyError = Class.new(StandardError)
 
       # Return a new type marked as a FK
       #
-      # @return [SQL::Type]
+      # @return [SQL::Attribute]
       #
       # @api public
       def foreign_key
@@ -22,7 +25,7 @@ module ROM
 
       # Return a new type marked as qualified
       #
-      # @return [SQL::Type]
+      # @return [SQL::Attribute]
       #
       # @api public
       def qualified
@@ -39,7 +42,7 @@ module ROM
 
       # Return a new type marked as joined
       #
-      # @return [SQL::Type]
+      # @return [SQL::Attribute]
       #
       # @api public
       def joined

data/lib/rom/sql/commands/update.rb

@@ -14,6 +14,7 @@ module ROM
         include ErrorWrapper
 
         use :schema
+        use :associates
 
         after :finalize
 
@@ -47,6 +48,15 @@ module ROM
         def primary_key
           relation.primary_key
         end
+
+        # Yields tuples for insertion or return an enumerator
+        #
+        # @api private
+        def with_input_tuples(tuples)
+          input_tuples = Array([tuples]).flatten(1).map
+          return input_tuples unless block_given?
+          input_tuples.each { |tuple| yield(tuple) }
+        end
       end
     end
   end

data/lib/rom/sql/dsl.rb

@@ -1,5 +1,6 @@
 module ROM
   module SQL
+    # @api private
     class DSL < BasicObject
       # @api private
       attr_reader :schema

data/lib/rom/sql/extensions/postgres/inferrer.rb

@@ -23,7 +23,8 @@ module ROM
           'inet' => Types::PG::IPAddress,
           'cidr' => Types::PG::IPAddress,
           'macaddr' => Types::String,
-          'point' => Types::PG::PointT
+          'point' => Types::PG::PointT,
+          'xml' => Types::String
         ).freeze
 
         db_array_type_matcher Sequel::Postgres::PGArray::EMPTY_BRACKET

data/lib/rom/sql/extensions/sqlite.rb

@@ -1 +1,2 @@
+require 'rom/sql/extensions/sqlite/types'
 require 'rom/sql/extensions/sqlite/inferrer'

data/lib/rom/sql/extensions/sqlite/inferrer.rb

@@ -4,6 +4,15 @@ module ROM
   module SQL
     class Schema
       class SqliteInferrer < Inferrer[:sqlite]
+        NO_TYPE = EMPTY_STRING
+
+        def map_type(_, db_type, **_kw)
+          if db_type.eql?(NO_TYPE)
+            ROM::SQL::Types::SQLite::Object
+          else
+            super
+          end
+        end
       end
     end
   end

data/lib/rom/sql/extensions/sqlite/types.rb

@@ -0,0 +1,11 @@
+require 'dry-types'
+
+module ROM
+  module SQL
+    module Types
+      module SQLite
+        Object = ::ROM::SQL::Types::Object
+      end
+    end
+  end
+end

data/lib/rom/sql/function.rb

@@ -1,6 +1,9 @@
+require 'rom/schema/attribute'
+
 module ROM
   module SQL
-    class Function < ROM::Schema::Type
+    # @api private
+    class Function < ROM::Schema::Attribute
       def sql_literal(ds)
         if name
           func.as(name).sql_literal(ds)

data/lib/rom/sql/gateway.rb

@@ -12,18 +12,14 @@ module ROM
   module SQL
     # SQL gateway
     #
-    # @example
-    #   db = Sequel.connect(:sqlite)
-    #   gateway = ROM::SQL::Gateway.new(db)
-    #
-    #   users = gateway.dataset(:users)
-    #
     # @api public
     class Gateway < ROM::Gateway
       include Dry::Core::Constants
       include Migration
 
       class << self
+        # FIXME: get rid of this and figure out a nicer way of handling migration DSL
+        # we want to have global access ONLY when running migration tasks
         attr_accessor :instance
       end
 
@@ -31,35 +27,64 @@ module ROM
         postgres: %i(pg_array pg_json pg_enum)
       }.freeze
 
-      # Return optionally configured logger
-      #
-      # @return [Object] logger
-      #
-      # @api public
+      # @!attribute [r] logger
+      #   @return [Object] configured gateway logger
       attr_reader :logger
 
-      # @api private
+      # @!attribute [r] options
+      #   @return [Hash] Options used for connection
       attr_reader :options
 
-      # SQL gateway interface
+      # Initialize an SQL gateway
+      #
+      # Gateways are typically initialized via ROM::Configuration object, gateway constructor
+      # arguments such as URI and options are passed directly to this constructor
+      #
+      # @overload initialize(uri)
+      #   Connects to a database via URI
+      #
+      #   @example
+      #     ROM.container(:sql, 'postgres://localhost/db_name')
+      #
+      #   @param [Sequel::Database] connection a connection instance
+      #
+      # @overload initialize(uri, options)
+      #   Connects to a database via URI and options
       #
-      # @overload connect(uri, options)
-      #   Connects to database via uri passing options
+      #   @example
+      #     ROM.container(:sql, 'postgres://localhost/db_name', extensions: %w[pg_enum])
       #
       #   @param [String,Symbol] uri connection URI
+      #
       #   @param [Hash] options connection options
       #
-      # @overload connect(connection)
-      #   Re-uses connection instance
+      #   @option options [Array<Symbol>] :inferrable_relations
+      #     A list of dataset names that should be inferred. If
+      #     this is set explicitly to an empty array relations
+      #     won't be inferred at all
+      #
+      #   @option options [Array<Symbol>] :not_inferrable_relations
+      #     A list of dataset names that should NOT be inferred
+      #
+      #   @option options [Array<Symbol>] :extensions
+      #     A list of connection extensions supported by Sequel
+      #
+      #   @option options [String] :user Database username
+      #
+      #   @option options [String] :password Database password
+      #
+      # @overload initialize(connection)
+      #   Creates a gateway from an existing database connection. This
+      #   works with Sequel connections exclusively.
+      #
+      #   @example
+      #     ROM.container(:sql, Sequel.connect(:sqlite))
       #
       #   @param [Sequel::Database] connection a connection instance
       #
-      # @example
-      #   gateway = ROM::SQL::Gateway.new('postgres://localhost/rom')
+      # @return [SQL::Gateway]
       #
-      #   # or reuse connection
-      #   DB = Sequel.connect('postgres://localhost/rom')
-      #   gateway = ROM::SQL::Gateway.new(DB)
+      # @see https://github.com/jeremyevans/sequel/blob/master/doc/opening_databases.rdoc Sequel connection docs
       #
       # @api public
       def initialize(uri, options = EMPTY_HASH)
@@ -73,7 +98,7 @@ module ROM
         self.class.instance = self
       end
 
-      # Disconnect from database
+      # Disconnect from the gateway's database
       #
       # @api public
       def disconnect
@@ -82,7 +107,9 @@ module ROM
 
       # Return dataset with the given name
       #
-      # @param [String] name dataset name
+      # Thsi returns a raw Sequel database
+      #
+      # @param [String, Symbol] name The dataset name
       #
       # @return [Dataset]
       #
@@ -93,6 +120,15 @@ module ROM
 
       # Setup a logger
       #
+      # @example set a logger during configuration process
+      #   rom = ROM.container(:sql, 'sqlite::memory') do |config|
+      #     config.gateways[:default].use_logger(Logger.new($stdout))
+      #   end
+      #
+      # @example set logger after gateway has been established
+      #   rom = ROM.container(:sql, 'sqlite::memory')
+      #   rom.gateways[:default].use_logger(Logger.new($stdout))
+      #
       # @param [Object] logger
       #
       # @see Sequel::Database#loggers
@@ -114,7 +150,7 @@ module ROM
         connection[name]
       end
 
-      # Check if dataset exists
+      # Check if a dataset exists
       #
       # @param [String] name dataset name
       #
@@ -123,10 +159,10 @@ module ROM
         schema.include?(name)
       end
 
-      # Extend database-specific behavior
+      # Extend the command class with database-specific behavior
       #
-      # @param [Class] klass command class
-      # @param [Object] dataset a dataset that will be used
+      # @param [Class] klass Command class
+      # @param [Sequel::Dataset] dataset A dataset that will be used
       #
       # Note: Currently, only postgres is supported.
       #

data/lib/rom/sql/migration.rb

@@ -6,13 +6,12 @@ module ROM
     # on a specific gateway, use ROM::SQL::Gateway#migration
     #
     # @example
-    #   ROM.setup(
+    #   rom = ROM.container(
     #     default: [:sql, 'sqlite::memory'],
     #     other: [:sql, 'postgres://localhost/test']
     #   )
     #
-    #   ROM.finalize
-    #
+    #   # default gateway migrations
     #   ROM::SQL.migration do
     #     change do
     #       create_table(:users) do
@@ -22,6 +21,16 @@ module ROM
     #     end
     #   end
     #
+    #   # other gateway migrations
+    #   rom.gateways[:other].migration do
+    #     change do
+    #       create_table(:users) do
+    #         primary_key :id
+    #         String :name
+    #       end
+    #     end
+    #   end
+    #
     # @api public
     def self.migration(&block)
       ROM::SQL::Gateway.instance.migration(&block)
@@ -30,7 +39,8 @@ module ROM
     module Migration
       Sequel.extension :migration
 
-      # @api public
+      # @!attribute [r] migrator
+      #   @return [Migrator] Migrator instance
       attr_reader :migrator
 
       # @api private
@@ -38,6 +48,8 @@ module ROM
         @migrator = options.fetch(:migrator) { Migrator.new(connection) }
       end
 
+      # Check if there are any pending migrations
+      #
       # @see ROM::SQL::Migration.pending?
       #
       # @api public
@@ -45,6 +57,8 @@ module ROM
         migrator.pending?
       end
 
+      # Migration DSL
+      #
       # @see ROM::SQL.migration
       #
       # @api public
@@ -52,13 +66,11 @@ module ROM
         migrator.migration(&block)
       end
 
-      # Run migrations for a given gateway
+      # Run migrations
       #
       # @example
-      #   ROM.setup(:sql, ['sqlite::memory'])
-      #   ROM.finalize
-      #   ROM.env.gateways[:default].run_migrations
-      #
+      #   rom = ROM.container(:sql, ['sqlite::memory'])
+      #   rom.gateways[:default].run_migrations
       #
       # @param [Hash] options The options used by Sequel migrator
       #
@@ -66,26 +78,6 @@ module ROM
       def run_migrations(options = {})
         migrator.run(options)
       end
-
-      # TODO: this should be removed in favor of migration API in Gateway
-      class << self
-        attr_writer :path
-        attr_accessor :connection
-
-        def path
-          @path || Migrator::DEFAULT_PATH
-        end
-
-        def run(options = {})
-          warn "ROM::SQL::Migration.run is deprecated please ROM::SQL::Gateway#run_migrations (#{caller[0]})"
-          ::Sequel::Migrator.run(connection, path, options)
-        end
-
-        def create(&block)
-          warn "ROM::SQL::Migration.create is deprecated please use ROM::SQL.migration (#{caller[0]})"
-          ::Sequel.migration(&block)
-        end
-      end
     end
   end
 end