rom-sql 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c088db5ced8d4a5297ceb909e77dba86cd80ed37
-  data.tar.gz: 9d7f52c636a1418b966d7c609f57e766a1a4b224
+  metadata.gz: 2f9129b51494f9c6e4e78dd37a3700e103012ee7
+  data.tar.gz: 72e8eb116c43a411fb250ee866cdeeb9e5edb0a9
 SHA512:
-  metadata.gz: 2603a384db038ddf194df6827b4d29585f48b5db8cd4791117149e292c55d3c0e8ddcec364e516b046fab29a28c32af22e964f4788c4f44082b808239b1127b3
-  data.tar.gz: 67d0846c7bea76d5c9365d35874a9755aa1c0306cbf09de7ce51b4964c16784c740f2b8713bb632dca0d54ac3ba480fc931d3a477abd602791ed28be4ba81183
+  metadata.gz: 468a0785cb4d9d132bcdd344cf0bb72b12ece60b5e118d8ae7a5ac095d1be5adb7eca861ae0bf70167c79bf911c2fca30e4d814cb514c44cfc8e53b421266dcb
+  data.tar.gz: f081da3b8fe5f27c6b9c40f80f5b374a230ffd3e30d71b8ce70d82edeac09c176bce328bf8015d50e7f2dd51f88ea54aeb36d7661f90e5f1a6ff23807436b500

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v0.3.0 2014-12-19
+
+### Changed
+
+* `association_join` now uses Sequel's `graph` interface which qualifies columns automatically (solnic)
+* Delete command returns deleted tuples (solnic)
+
+[Compare v0.2.0...v0.3.0](https://github.com/rom-rb/rom-sql/compare/v0.2.0...v0.3.0)
+
 ## v0.2.0 2014-12-06
 
 ### Added

data/README.md

@@ -58,28 +58,14 @@ end
 
 ## Relations
 
-ROM doesn't have a relationship concept like in ActiveRecord or Sequel. Instead
-it provides a convenient interface for building joined relations that can be
-mapped to [aggregate objects](http://martinfowler.com/bliki/Aggregate.html).
-
-There's no lazy-loading, eager-loading or any other magic happening behind the
-scenes. You're in full control of how data are fetched from the database and it's
-an explicit operation.
-
 ``` ruby
 
 setup.relation(:tasks)
 
 setup.relation(:users) do
-  one_to_many :tasks, key: :user_id
-
   def by_name(name)
     where(name: name)
   end
-
-  def with_tasks
-    association_join(:tasks)
-  end
 end
 
 rom = setup.finalize
@@ -94,10 +80,19 @@ puts users.by_name("Piotr").with_tasks.to_a.inspect
 # => [{:id=>1, :name=>"Piotr", :user_id=>1, :title=>"Be happy"}]
 ```
 
-## Mapping
+## Mapping joins to aggregates
+
+ROM doesn't have a relationship concept like in ActiveRecord or Sequel. Instead
+it provides a convenient interface for building joined relations that can be
+mapped to [aggregate objects](http://martinfowler.com/bliki/Aggregate.html).
+
+There's no lazy-loading, eager-loading or any other magic happening behind the
+scenes. You're in full control of how data are fetched from the database and it's
+an explicit operation.
 
-Mapping joined relations can be simplified using `wrap` and `group` in-memory
-operations:
+Sequel's association DSL is available in relation definitions which enables
+`association_join` interface inside relations. To map joined results to
+aggregate objects `wrap` and `group` mapping transformation can be used
 
 ``` ruby
 setup.relation(:tasks)
@@ -110,7 +105,7 @@ setup.relation(:users) do
   end
 
   def with_tasks
-    in_memory { group(association_join(:tasks), tasks: [:title]) }
+    association_join(:tasks, select: [:title])
   end
 end
 

data/lib/rom/sql.rb

@@ -9,7 +9,6 @@ end
 
 require "rom/sql/version"
 require "rom/sql/header"
-require "rom/sql/relation_extension"
 require "rom/sql/relation_inclusion"
 require "rom/sql/adapter"
 

data/lib/rom/sql/adapter.rb

@@ -41,7 +41,9 @@ module ROM
       end
 
       def extend_relation_instance(relation)
-        relation.extend(RelationExtension)
+        model = relation.model
+        model.set_dataset(relation.dataset)
+        model.dataset.naked!
       end
 
       def command_namespace

data/lib/rom/sql/commands.rb

@@ -38,8 +38,9 @@ module ROM
       class Delete < ROM::Commands::Delete
 
         def execute
+          deleted = target.to_a
           target.delete
-          relation
+          deleted
         end
 
       end

data/lib/rom/sql/header.rb

@@ -25,6 +25,10 @@ module ROM
         }
       end
 
+      def names
+        map { |col| :"#{col.to_s.split('___').last}" }
+      end
+
       def project(*names)
         find_all { |col| names.include?(col) }
       end

data/lib/rom/sql/relation_inclusion.rb

@@ -9,6 +9,7 @@ module ROM
         klass.extend(AssociationDSL)
 
         klass.send(:undef_method, :select)
+        klass.send(:attr_reader, :model)
 
         klass.class_eval {
           class << self
@@ -42,8 +43,8 @@ module ROM
       #   end
       #
       # @api public
-      def association_join(*args)
-        send(:append_association, __method__, *args)
+      def association_join(name, options = {})
+        graph_join(name, :inner, options)
       end
 
       # Join configured association
@@ -63,36 +64,53 @@ module ROM
       #   end
       #
       # @api public
-      def association_left_join(*args)
-        send(:append_association, __method__, *args)
+      def association_left_join(name, options = {})
+        graph_join(name, :left_outer, options)
       end
 
-      private
-
       # @api private
-      def append_association(type, name, options = {})
-        self.class.new(
-          dataset.public_send(type, name).
-          select_append(*columns_for_association(name, options))
-        )
+      def primary_key
+        model.primary_key
       end
 
       # @api private
-      def columns_for_association(name, options)
-        col_names = options[:select]
-
-        return send(Inflecto.pluralize(name)).qualified_columns unless col_names
-
-        relations = col_names.is_a?(Hash) ? col_names.keys : [name]
-
-        columns = relations.each_with_object([]) do |rel_name, a|
-          relation = send(Inflecto.pluralize(rel_name))
-          names = col_names.is_a?(Hash) ? col_names[rel_name] : col_names
-
-          a.concat(relation.select(*names).prefix.qualified_columns)
+      def graph_join(name, join_type, options = {})
+        assoc = model.association_reflection(name)
+
+        key = assoc[:key]
+        type = assoc[:type]
+
+        if type == :many_to_many
+          select = options[:select] || {}
+
+          l_select, r_select =
+            if select.is_a?(Hash)
+              [select[assoc[:join_table]] || [], select[name]]
+            else
+              [[], select]
+            end
+
+          l_graph = graph(
+            assoc[:join_table],
+            { assoc[:left_key] => primary_key },
+            select: l_select, implicit_qualifier: self.name
+          )
+
+          l_graph.graph(name, { primary_key => assoc[:right_key] }, select: r_select)
+        else
+          join_keys =
+            if type == :many_to_one
+              { primary_key => key }
+            else
+              { key => primary_key }
+            end
+
+          graph(
+            name,
+            join_keys,
+            options.merge(join_type: join_type, implicit_qualifier: self.name)
+          )
         end
-
-        columns
       end
 
       module AssociationDSL

data/lib/rom/sql/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module SQL
-    VERSION = "0.2.0".freeze
+    VERSION = "0.3.0".freeze
   end
 end

data/spec/integration/commands/delete_spec.rb

@@ -8,7 +8,7 @@ describe 'Commands / Delete' do
   before do
     setup.relation(:users) do
       def by_name(name)
-        where(name: 'Piotr')
+        where(name: name)
       end
     end
 
@@ -22,12 +22,12 @@ describe 'Commands / Delete' do
   it 'deletes all tuples' do
     result = users.try { delete }
 
-    expect(result.value.to_a).to match_array([])
+    expect(result.value.to_a).to match_array([{ id: 1, name: 'Piotr' }, { id: 2, name: 'Jane' }])
   end
 
   it 'deletes all tuples in a restricted relation' do
     result = users.try { delete(:by_name, 'Jane').execute }
 
-    expect(result.value.to_a).to match_array([{ id: 2, name: 'Jane' }])
+    expect(result.value).to match_array([{ id: 2, name: 'Jane' }])
   end
 end

data/spec/unit/combined_associations_spec.rb

@@ -21,11 +21,11 @@ describe 'Defining multiple associations' do
         right_key: :tag_id
 
       def with_user_and_tags
-        all.with_tags.with_user
+        all.with_user.with_tags
       end
 
       def all
-        select(:id, :title).qualified
+        select(:id, :title)
       end
 
       def by_tag(name)
@@ -33,39 +33,41 @@ describe 'Defining multiple associations' do
       end
 
       def with_tags
-        association_left_join(:tags, select: :name)
+        association_left_join(:tags, select: [:name])
       end
 
       def with_user
-        association_join(:users, select: :name)
+        association_join(:users, select: [:name])
       end
 
-      def sorted_by_tag_name
-        order(Sequel.desc(:tasks__title))
+      def sorted_by_tags_name
+        order(Sequel.desc(:tags__name))
       end
 
     end
 
-    expect(rom.relations.tasks.with_user_and_tags.to_a).to eql([
-      { id: 1, title: 'Finish ROM', user_name: 'Piotr', tag_name: 'important' },
-      { id: 2, title: 'Go to sleep', user_name: 'Piotr',  tag_name: nil }
+    tasks = rom.relations.tasks
+
+    expect(tasks.with_user_and_tags.to_a).to eql([
+      { id: 1, title: 'Finish ROM', name: 'Piotr', tags_name: 'important' },
+      { id: 2, title: 'Go to sleep', name: 'Piotr',  tags_name: nil }
     ])
 
-    expect(rom.relations.tasks.with_user_and_tags.sorted_by_tag_name.to_a).to eql([
-      { id: 2, title: 'Go to sleep', user_name: 'Piotr',  tag_name: nil },
-      { id: 1, title: 'Finish ROM', user_name: 'Piotr', tag_name: 'important' }
+    expect(tasks.with_user_and_tags.sorted_by_tags_name.to_a).to eql([
+      { id: 2, title: 'Go to sleep', name: 'Piotr',  tags_name: nil },
+      { id: 1, title: 'Finish ROM', name: 'Piotr', tags_name: 'important' }
     ])
 
-    expect(rom.relations.tasks.with_user_and_tags.by_tag('important').to_a).to eql([
-      { id: 1, title: 'Finish ROM', user_name: 'Piotr', tag_name: 'important' }
+    expect(tasks.with_user_and_tags.by_tag('important').to_a).to eql([
+      { id: 1, title: 'Finish ROM', name: 'Piotr', tags_name: 'important' }
     ])
 
-    expect(rom.relations.tasks.all.with_user.to_a).to eql([
-      { id: 1, title: 'Finish ROM', user_name: 'Piotr' },
-      { id: 2, title: 'Go to sleep', user_name: 'Piotr'  }
+    expect(tasks.all.with_user.to_a).to eql([
+      { id: 1, title: 'Finish ROM', name: 'Piotr' },
+      { id: 2, title: 'Go to sleep', name: 'Piotr'  }
     ])
 
-    expect(rom.relations.tasks.where(title: 'Go to sleep').to_a).to eql(
+    expect(tasks.where(title: 'Go to sleep').to_a).to eql(
       [{ id: 2, user_id: 1, title: 'Go to sleep'}]
     )
   end

data/spec/unit/many_to_many_spec.rb

@@ -16,11 +16,21 @@ describe 'Defining many-to-one association' do
         right_key: :tag_id
 
       def with_tags
-        association_left_join(:tags).select(:tasks__id, :tasks__title, :tags__name)
+        association_left_join(:tags, select: [:name])
+      end
+
+      def with_tags_and_tag_id
+        association_left_join(:tags, select: {
+          tags: [:name], task_tags: [:tag_id]
+        })
       end
 
       def by_tag(name)
-        with_tags.where(tags__name: name)
+        with_tags.where(name: name)
+      end
+
+      def all
+        select(:id, :title)
       end
     end
 
@@ -28,12 +38,17 @@ describe 'Defining many-to-one association' do
 
     tasks = rom.relations.tasks
 
-    expect(tasks.with_tags.to_a).to eql([
+    expect(tasks.all.with_tags.to_a).to eql([
       { id: 1, title: 'Finish ROM', name: 'important' },
       { id: 2, title: 'Go to sleep', name: nil }
     ])
 
-    expect(tasks.by_tag("important").to_a).to eql([
+    expect(tasks.all.with_tags_and_tag_id.to_a).to eql([
+      { id: 1, title: 'Finish ROM', tag_id: 1, name: 'important' },
+      { id: 2, title: 'Go to sleep', tag_id: nil, name: nil }
+    ])
+
+    expect(tasks.all.by_tag("important").to_a).to eql([
       { id: 1, title: 'Finish ROM', name: 'important' }
     ])
 

data/spec/unit/many_to_one_spec.rb

@@ -8,7 +8,7 @@ describe 'Defining many-to-one association' do
       many_to_one :users, key: :user_id
 
       def all
-        select(:id, :title).rename(title: :task_title).qualified
+        select(:id, :title)
       end
 
       def with_user
@@ -16,12 +16,26 @@ describe 'Defining many-to-one association' do
       end
     end
 
+    setup.mappers do
+      define(:tasks)
+
+      define(:with_user, parent: :tasks) do
+        wrap :user do
+          attribute :name
+        end
+      end
+    end
+
     setup.relation(:users)
 
     tasks = rom.relations.tasks
 
     expect(tasks.all.with_user.to_a).to eql(
-      [{ id: 1, user_name: 'Piotr', task_title: 'Finish ROM' }]
+      [{ id: 1, name: 'Piotr', title: 'Finish ROM' }]
+    )
+
+    expect(rom.read(:tasks).all.with_user.to_a).to eql(
+      [{ id: 1, title: 'Finish ROM', user: { name: 'Piotr' } }]
     )
   end
 end

data/spec/unit/one_to_many_spec.rb

@@ -14,14 +14,30 @@ describe 'Defining one-to-many association' do
       end
 
       def with_tasks
-        association_join(:tasks)
+        association_left_join(:tasks, select: [:id, :title])
+      end
+
+      def all
+        select(:id, :name)
+      end
+    end
+
+    setup.mappers do
+      define(:users)
+
+      define(:with_tasks, parent: :users) do
+        group tasks: [:tasks_id, :title]
       end
     end
 
     users = rom.relations.users
 
     expect(users.with_tasks.by_name("Piotr").to_a).to eql(
-      [{ id: 1, user_id: 1, name: 'Piotr', title: 'Finish ROM' }]
+      [{ id: 1, name: 'Piotr', tasks_id: 1, title: 'Finish ROM' }]
+    )
+
+    expect(rom.read(:users).all.with_tasks.by_name("Piotr").to_a).to eql(
+      [{ id: 1, name: 'Piotr', tasks: [{ tasks_id: 1, title: 'Finish ROM' }] }]
     )
   end
 end

data/spec/unit/schema_spec.rb

@@ -26,7 +26,7 @@ describe 'Inferring schema from database' do
       rom = setup.finalize
       schema = rom.schema
 
-      expect(schema.postgres).to be(nil)
+      expect { schema.postgres }.to raise_error(NoMethodError)
     end
   end
 end

metadata

@@ -1,95 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: rom-sql
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-06 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.17'
 - !ruby/object:Gem::Dependency
   name: equalizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.0.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.0.9
 - !ruby/object:Gem::Dependency
   name: rom
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 description: RDBMS support for ROM
@@ -99,9 +99,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -112,7 +112,6 @@ files:
 - lib/rom/sql/adapter.rb
 - lib/rom/sql/commands.rb
 - lib/rom/sql/header.rb
-- lib/rom/sql/relation_extension.rb
 - lib/rom/sql/relation_inclusion.rb
 - lib/rom/sql/spec/support.rb
 - lib/rom/sql/support/active_support_notifications.rb
@@ -147,17 +146,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: RDBMS support for ROM

data/lib/rom/sql/relation_extension.rb

@@ -1,15 +0,0 @@
-module ROM
-  module SQL
-
-    module RelationExtension
-      attr_reader :model
-
-      def self.extended(relation)
-        relation.model.set_dataset(relation.dataset)
-        relation.model.dataset.naked!
-      end
-
-    end
-
-  end
-end