rom-sql 0.9.1 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7afadeffec4c6a560640ef08d8dbe333d067bf6c
-  data.tar.gz: 096577d996f4be2697da8ca271e57c60cdbdf18e
+  metadata.gz: 11ef8c53c46264b6203d44eaad523cda0815845e
+  data.tar.gz: c2514bbd7868d4591cd2a714e158bfafa2a36fbf
 SHA512:
-  metadata.gz: 65fc494f45e9e7a76ba43aeb541d5c38719b020ae7ef5092e3e1698f53e3ddf15c23baa4fe97c3a8bd0cb646b4ebec3c0efad77bf03aaeee9317cc9bf5aea2fb
-  data.tar.gz: 493b7c1cae2cb730c092e5b30df0e866797c2fdac2a5ce0c2264cbd2cf05a86ed66521c219b8d5c4c12687425bbf3ed82e193c6f5583969a49106264a17add47
+  metadata.gz: 1d21a1a74c17f0489431b31d648e58cb0fce934808811111f6e01fc11f4307096884fdc7c8246bc302ce41cd5ea992be9e12a48123841797d8dacab5bc2c88df
+  data.tar.gz: 5dc78196284dfeb55ac969afcb79510db21fa31bf5238f26209d8bdbe1ed919a929130313dd9600c07842b110facc88487a7c4e137642293f3f885075b210172

data/.travis.yml

@@ -13,9 +13,9 @@ after_success:
   - '[ "$TRAVIS_RUBY_VERSION" = "2.3.1" ] && [ "$TRAVIS_BRANCH" = "master" ] && bundle exec codeclimate-test-reporter'
 script: "bundle exec rake ci"
 rvm:
-  - 2.1.10
   - 2.2.5
   - 2.3.1
+  - 2.4.0
   - rbx-3
   - jruby
 env:

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+## v1.0.0 to-be-released
+
+This release is based on rom core 3.0.0 with its improved Schema API, which is extended with SQL-specific features.
+
+Please refer to [the upgrading guide](https://github.com/rom-rb/rom-sql/wiki/Upgrading-from-0.9.x-to-1.0.0) if you're moving from 0.9.x to 1.0.0.
+
+### Added
+
+* [BREAKING] All relations have schemas (inferred by default, but still possible to override and/or extend) (solnic)
+* [BREAKING] Schemas are used when defining relation views (solnic)
+* [BREAKING] Default dataset is set up based on schema (solnic)
+* Extended query API with support for schema attributes (solnic)
+* Schemas can project relations automatically (solnic)
+* New `Schema#qualified` (solnic)
+* 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)
+* Support for self-referencing associations (ie categories have_many child categories) (solnic)
+
+### Changed
+
+* [BREAKING] `Relation#header` has been removed in favor of schemas (solnic)
+* [BREAKING] `Relation#base` has been removed as now a vanilla relation *is a base relation view* (solnic)
+* [BREAKING] Deprecated `Commands::Update#change` has been removed (solnic)
+* [BREAKING] Deprecated `Commands.validator` has been removed (solnic)
+* [BREAKING] `assoc_macros` plugin has been removed, please use associations from now (solnic)
+* [internal] Associations use schemas for relation projections (solnic)
+* [internal] `select`, `select_append`, `project`, `inner_join` and `left_join` use schemas internally (solnic)
+* [internal] Deprecation and constants are now based on dry-core (flash-gordon)
+
+[Compare v0.9.1...v1.0.0](https://github.com/rom-rb/rom-sql/compare/v0.9.1...v1.0.0)
+
 ## v0.9.1 2016-12-23
 
 ### Added

data/Gemfile

@@ -2,10 +2,13 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'rom', git: 'https://github.com/rom-rb/rom.git', branch: 'master'
+gem 'rom-mapper', git: 'https://github.com/rom-rb/rom-mapper.git', branch: 'master'
+
 group :test do
   gem 'byebug', platforms: :mri
   gem 'dry-struct'
-  gem 'activesupport', '~> 4.2'
+  gem 'activesupport', '~> 5.0'
   gem 'rspec', '~> 3.1'
   gem 'codeclimate-test-reporter', require: false
   gem 'simplecov', require: false

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

@@ -31,9 +31,7 @@ module ROM
               other = __registry__[name]
               other_dataset = other.name.dataset
 
-              inner_join(other_dataset, keys)
-                .select(*qualified.header.columns)
-                .select_append(*other.prefix(other_dataset).qualified.header)
+              schema.merge(other.schema.wrap).qualified.(inner_join(other_dataset, keys))
             end
           end
         end

data/lib/rom/sql/association.rb

@@ -1,4 +1,8 @@
-require 'rom/support/constants'
+require 'dry/core/constants'
+require 'dry/core/class_attributes'
+
+require 'rom/types'
+require 'rom/initializer'
 require 'rom/sql/qualified_attribute'
 require 'rom/sql/association/name'
 
@@ -8,39 +12,50 @@ module ROM
     #
     # @api public
     class Association
+      include Dry::Core::Constants
       include Dry::Equalizer(:source, :target, :result)
-      include Options
-      extend ClassMacros
+      extend Initializer
+      extend Dry::Core::ClassAttributes
 
       defines :result
 
       # @!attribute [r] source
       #   @return [ROM::Relation::Name] the source relation name
-      attr_reader :source
+      param :source
 
       # @!attribute [r] target
       #   @return [ROM::Relation::Name] the target relation name
-      attr_reader :target
+      param :target
 
       # @!attribute [r] relation
       #   @return [Symbol] an optional relation identifier for the target
-      option :relation, accepts: [Symbol], reader: true
+      option :relation, Types::Strict::Symbol, reader: true, optional: true
 
       # @!attribute [r] result
       #   @return [Symbol] either :one or :many
-      option :result, accepts: [Symbol], reader: true, default: -> assoc { assoc.class.result }
+      option :result, Types::Strict::Symbol, reader: true, default: -> assoc { assoc.class.result }
 
       # @!attribute [r] as
       #   @return [Symbol] an optional association alias name
-      option :as, accepts: [Symbol], reader: true, default: -> assoc { assoc.target.to_sym }
+      option :as, Types::Strict::Symbol, reader: true, optional: true, default: -> assoc { assoc.target.to_sym }
+
+      # @!attribute [r] foreign_key
+      #   @return [Symbol] an optional association alias name
+      option :foreign_key, Types::Strict::Symbol, optional: true, reader: true, default: proc { nil }
+
+      # @!attribute [r] view
+      #   @return [Symbol] An optional view that should be used to extend assoc relation
+      option :view, reader: true, optional: true, default: proc { nil }
 
       alias_method :name, :as
 
-      # @api private
-      def initialize(source, target, options = EMPTY_HASH)
-        @source = Name[source]
-        @target = Name[options[:relation] || target, target, options[:as] || target]
-        super
+      # @api public
+      def self.new(source, target, options = EMPTY_HASH)
+        super(
+          Name[source],
+          Name[options[:relation] || target, target, options[:as] || target],
+          options
+        )
       end
 
       # Returns a qualified attribute name for a given dataset
@@ -55,7 +70,7 @@ module ROM
       #
       # @api public
       def qualify(name, attribute)
-        QualifiedAttribute[name.dataset, attribute]
+        QualifiedAttribute[name.to_sym, attribute]
       end
 
       protected
@@ -64,6 +79,10 @@ module ROM
       def join_key_map(relations)
         join_keys(relations).to_a.flatten.map(&:to_sym)
       end
+
+      def self_ref?
+        source.dataset == target.dataset
+      end
     end
   end
 end

data/lib/rom/sql/association/many_to_many.rb

@@ -1,12 +1,12 @@
+require 'rom/types'
+
 module ROM
   module SQL
     class Association
       class ManyToMany < Association
-        attr_reader :through
-
         result :many
 
-        option :through, default: nil, type: Symbol
+        option :through, type: Types::Strict::Symbol.optional
 
         # @api private
         def initialize(*)
@@ -24,17 +24,24 @@ module ROM
           left = assocs[target].call(relations)
           right = relations[target.relation]
 
-          left_fk = join_rel.foreign_key(source.relation)
+          left_fk = foreign_key || join_rel.foreign_key(source.relation)
 
-          columns = right.header.exclude(left_fk).qualified.to_a
-          columns << left_fk unless right.header.names.include?(left_fk)
+          schema =
+            if left.schema.key?(left_fk)
+              left.schema.project(*(right.schema.map(&:name) + [left_fk]))
+            else
+              right.schema.merge(join_rel.schema.project(left_fk))
+            end.qualified
 
           relation = left
             .inner_join(source, join_keys(relations))
-            .select(*columns)
-            .order(*right.header.project(*right.primary_key).qualified)
+            .order(*right.schema.project_pk.qualified)
 
-          relation.with(attributes: relation.header.names)
+          if view
+            schema.(relation.public_send(view))
+          else
+            schema.(relation)
+          end
         end
 
         # @api public
@@ -68,7 +75,7 @@ module ROM
         # @api private
         def with_keys(relations, &block)
           source_key = relations[source.relation].primary_key
-          target_key = relations[through.relation].foreign_key(source.relation)
+          target_key = foreign_key || relations[through.relation].foreign_key(source.relation)
           return [source_key, target_key] unless block
           yield(source_key, target_key)
         end

data/lib/rom/sql/association/many_to_one.rb

@@ -9,22 +9,28 @@ module ROM
           left = relations[target.relation]
           right = relations[source.relation]
 
-          right_pk = right.schema.primary_key.map { |a| a.meta[:name] }
-          right_fk = right.foreign_key(target.relation)
+          left_pk = left.primary_key
+          right_fk = left.foreign_key(source.relation)
 
-          pk_to_fk = Hash[right_pk.product(Array(left.foreign_key(source.relation)))]
+          left_schema = left.schema
+          right_schema = right.schema.project_pk
 
-          columns = left.header.qualified.to_a + right.header
-            .project(*right_pk)
-            .rename(pk_to_fk)
-            .qualified.to_a
+          schema =
+            if left.schema.key?(right_fk)
+              left_schema
+            else
+              left_schema.merge(right_schema.project_fk(left_pk => right_fk))
+            end.qualified
 
           relation = left
-            .inner_join(source, right_fk => left.primary_key)
-            .select(*columns)
-            .order(*right.header.project(*right.primary_key).qualified)
+            .inner_join(source_table, join_keys(relations))
+            .order(*right_schema.qualified)
 
-          relation.with(attributes: relation.header.names)
+          if view
+            schema.(relation.public_send(view))
+          else
+            schema.(relation)
+          end
         end
 
         # @api public
@@ -35,7 +41,7 @@ module ROM
         # @api public
         def join_keys(relations)
           with_keys(relations) { |source_key, target_key|
-            { qualify(source, source_key) => qualify(target, target_key) }
+            { qualify(source_alias, source_key) => qualify(target, target_key) }
           }
         end
 
@@ -47,9 +53,19 @@ module ROM
 
         protected
 
+        # @api private
+        def source_table
+          self_ref? ? :"#{source.dataset}___#{source_alias}" : source
+        end
+
+        # @api private
+        def source_alias
+          self_ref? ? :"#{source.dataset.to_s[0]}_0" : source
+        end
+
         # @api private
         def with_keys(relations, &block)
-          source_key = relations[source.relation].foreign_key(target.relation)
+          source_key = foreign_key || relations[source.relation].foreign_key(target.relation)
           target_key = relations[target.relation].primary_key
           return [source_key, target_key] unless block
           yield(source_key, target_key)

data/lib/rom/sql/association/name.rb

@@ -1,6 +1,6 @@
 require 'dry/equalizer'
 require 'rom/relation/name'
-require 'rom/support/cache'
+require 'dry/core/cache'
 
 module ROM
   module SQL
@@ -8,7 +8,7 @@ module ROM
       class Name
         include Dry::Equalizer.new(:relation_name, :key)
 
-        extend Cache
+        extend Dry::Core::Cache
 
         attr_reader :relation_name
 
@@ -61,8 +61,16 @@ module ROM
           relation_name.relation
         end
 
-        def sql_literal_append(ds, sql)
-          ds.literal_append(sql, dataset)
+        def as(aliaz)
+          Name[relation_name.relation, relation_name.dataset, aliaz]
+        end
+
+        def to_sym
+          dataset
+        end
+
+        def sql_literal(ds)
+          Sequel.expr(aliased? ? :"#{dataset}___#{key}" : dataset).sql_literal(ds)
         end
       end
     end

data/lib/rom/sql/association/one_to_many.rb

@@ -6,16 +6,17 @@ module ROM
 
         # @api public
         def call(relations)
-          with_keys(relations) do |left_pk, right_fk|
-            right = relations[target.relation]
-            columns = right.header.qualified.to_a
+          right = relations[target.relation]
+          schema = right.schema.qualified
 
-            relation = right
-              .inner_join(source, left_pk => right_fk)
-              .select(*columns)
-              .order(*right.header.project(*right.primary_key).qualified)
+          relation = right
+                       .inner_join(source_table, join_keys(relations))
+                       .order(*right.schema.project_pk.qualified)
 
-            relation.with(attributes: relation.header.names)
+          if view
+            schema.(relation.public_send(view))
+          else
+            schema.(relation)
           end
         end
 
@@ -27,7 +28,7 @@ module ROM
         # @api public
         def join_keys(relations)
           with_keys(relations) { |source_key, target_key|
-            { qualify(source, source_key) => qualify(target, target_key) }
+            { qualify(source_alias, source_key) => qualify(target, target_key) }
           }
         end
 
@@ -39,10 +40,20 @@ module ROM
 
         protected
 
+        # @api private
+        def source_table
+          self_ref? ? :"#{source.dataset}___#{source_alias}" : source
+        end
+
+        # @api private
+        def source_alias
+          self_ref? ? :"#{source.dataset.to_s[0]}_0" : source
+        end
+
         # @api private
         def with_keys(relations, &block)
           source_key = relations[source.relation].primary_key
-          target_key = relations[target.relation].foreign_key(source.relation)
+          target_key = foreign_key || relations[target.relation].foreign_key(source.relation)
           return [source_key, target_key] unless block
           yield(source_key, target_key)
         end

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

@@ -22,7 +22,6 @@ module ROM
         def execute(tuples)
           insert_tuples = with_input_tuples(tuples) do |tuple|
             attributes = input[tuple]
-            validator.call(attributes)
             attributes.to_h
           end
 

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

@@ -1,6 +1,3 @@
-require 'rom/support/deprecations'
-require 'rom/support/constants'
-
 require 'rom/sql/commands/error_wrapper'
 require 'rom/sql/commands/transaction'
 
@@ -13,52 +10,18 @@ module ROM
       class Update < ROM::Commands::Update
         adapter :sql
 
-        extend Deprecations
-
         include Transaction
         include ErrorWrapper
 
-        option :original, reader: true
-
         use :schema
 
-        deprecate :set, :call
-        deprecate :to, :call
-
         # Updates existing tuple in a relation
         #
         # @return [Array<Hash>, Hash]
         #
         # @api public
         def execute(tuple)
-          attributes = input[tuple]
-          validator.call(attributes)
-
-          changed = diff(attributes.to_h)
-
-          if changed.size > 0
-            update(changed)
-          else
-            EMPTY_ARRAY
-          end
-        end
-
-        # Update existing tuple only when it changed
-        #
-        # @example
-        #   user = rom.relation(:users).one
-        #   new_user = { name: 'Jane Doe' }
-        #
-        #   rom.command(:users).change(user).call(new_user)
-        #
-        # @param [#to_h, Hash] original The original tuple
-        #
-        # @return [Command::Update]
-        #
-        # @api public
-        def change(original)
-          Deprecations.warn("#{self.class}#change is deprecated. Use repositories with changesets instead")
-          self.class.build(relation, options.merge(original: original.to_h))
+          update(input[tuple].to_h)
         end
 
         private
@@ -77,17 +40,6 @@ module ROM
         def primary_key
           relation.primary_key
         end
-
-        # Check if input tuple is different from the original one
-        #
-        # @api private
-        def diff(tuple)
-          if original
-            Hash[tuple.to_a - (tuple.to_a & original.to_a)]
-          else
-            tuple
-          end
-        end
       end
     end
   end