rom-sql 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65667c45aace8c6a4ca6998f10bc23cca6acb6e0
-  data.tar.gz: c63cf22daea5c103abca9c75b46df203228a5f2e
+  metadata.gz: fae231a134bab168af4e2cc51bc9f525839165aa
+  data.tar.gz: dcaa467ae85f00b2298d7a11ba24612bd1db17b6
 SHA512:
-  metadata.gz: eeb635de13c7519b535a73fccfbd0213af82ed8381a3709b082e1b50f976215b20588611899916feea315053f3b60bae7b51300dc99b2fcc2c3fe3bf602785f3
-  data.tar.gz: 6ffb7da871553147a54a7976e008d70ee927189cd06b0f5f0f3130dec0ae3fcb6c2e8011893792fb60adaa48c41019c2fe8e82c6d832b8b2ecabf8a83e4f2c9e
+  metadata.gz: 4279201898c5ff53884bd2dd1d8743baea691965bd2e26c573a9453001deff5fe1f6e17b37ec05b1bf6c67907ea7f2e40ecc75301746921c310a72c6a29b4a9d
+  data.tar.gz: 15878ffaebb4557cb9bd1b95fa3c1326d21a91017175f532cad871bb3cddeae039bf80f72e4139735ad932af589b3d6a05cf97c0269c2600c165e3d3c79f9914

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+## v0.4.3 2015-05-17
+
+### Fixed
+
+* `transaction` doesn't swallow errors now other than CommandError (solnic)
+
+[Compare v0.4.2...v0.4.3](https://github.com/rom-rb/rom-sql/compare/v0.4.2...v0.4.3)
+
+## v0.4.2 2015-05-17
+
+### Added
+
+* Support for setting custom association name (solnic)
+* Support for `:conditions` option in association definition (solnic)
+* Better error message when accessing undefined associations (pdswan)
+
+### Fixed
+
+* Correct `ROM::SQL::Plugin::Pagination::Pager#total_pages` when total is not
+  evenly divisible by page size (larribas)
+* `association_join` behaves correctly when dataset is different than register_as (nepalez)
+
+### Changed
+
+* `transaction` returns command failure objects when there was a rollback (solnic)
+
+[Compare v0.4.1...v0.4.2](https://github.com/rom-rb/rom-sql/compare/v0.4.1...v0.4.2)
+
 ## v0.4.1 2015-04-04
 
 ### Added

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 group :test do
   gem 'byebug', platforms: :mri
-  gem 'rom', '~> 0.6.0.beta', github: 'rom-rb/rom', branch: 'master'
+  gem 'rom', github: 'rom-rb/rom', branch: 'master'
   gem 'virtus'
   gem 'activesupport'
   gem 'rspec', '~> 3.1'

data/README.md

@@ -13,7 +13,7 @@
 [![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).
+RDBMS support for [Ruby Object Mapper](https://github.com/rom-rb/rom).
 
 ## Issues
 
@@ -44,6 +44,9 @@ in relation objects. For schema migrations you can use its
 which is available via repositories.
 
 ``` ruby
+require "rom-sql"
+require "sqlite3"
+
 setup = ROM.setup(:sql, "sqlite::memory")
 
 setup.default.connection.create_table(:users) do
@@ -69,6 +72,9 @@ class Users < ROM::Relation[:sql]
   end
 end
 
+class Tasks < ROM::Relation[:sql]
+end
+
 rom = ROM.finalize.env
 
 users = rom.relations.users
@@ -77,8 +83,8 @@ tasks = rom.relations.tasks
 users.insert(id: 1, name: "Piotr")
 tasks.insert(user_id: 1, title: "Be happy")
 
-puts rom.relation(:users).by_name("Piotr").with_tasks.to_a.inspect
-# => [{:id=>1, :name=>"Piotr", :user_id=>1, :title=>"Be happy"}]
+puts rom.relation(:users).by_name("Piotr").to_a.inspect
+# => [{:id=>1, :name=>"Piotr", :user_id=>1}]
 ```
 
 ## Mapping joins to aggregates
@@ -127,6 +133,9 @@ tasks = rom.relations.tasks
 users.insert(id: 1, name: "Piotr")
 tasks.insert(user_id: 1, title: "Be happy")
 
+rom.relation(:users).with_tasks.by_name("Piotr").to_a
+# => [{:id=>1, :name=>"Piotr", :admin=>nil, :title=>"Be happy"}]
+
 rom.relation(:users).as(:model).with_tasks.by_name("Piotr").to_a
 # => [#<User:0x007fb31542a098 @id=1, @name="Piotr", @tasks=[{:title=>"Be happy"}]>]
 ```

data/lib/rom/sql.rb

@@ -3,6 +3,7 @@ require "rom"
 
 module ROM
   module SQL
+    NoAssociationError = Class.new(StandardError)
     ConstraintError = Class.new(ROM::CommandError)
 
     class DatabaseError < ROM::CommandError
@@ -27,3 +28,7 @@ if defined?(Rails)
 end
 
 ROM.register_adapter(:sql, ROM::SQL)
+
+ROM.plugins do
+  register :pagination, ROM::SQL::Plugin::Pagination, type: :relation
+end

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

@@ -3,13 +3,29 @@ require 'rom/commands/result'
 module ROM
   module SQL
     module Commands
+      # Adds transaction interface to commands
+      #
+      # @api private
       module Transaction
         ROM::SQL::Rollback = Class.new(Sequel::Rollback)
 
+        # Start a transaction
+        #
+        # @param [Hash] options The options hash supported by Sequel
+        #
+        # @return [ROM::Commands::Result::Success,ROM::Commands::Result::Failure]
+        #
+        # @api public
         def transaction(options = {}, &block)
-          ROM::Commands::Result::Success.new(
-            relation.dataset.db.transaction(options, &block)
-          )
+          result = relation.dataset.db.transaction(options, &block)
+
+          if result
+            ROM::Commands::Result::Success.new(result)
+          else
+            ROM::Commands::Result::Failure.new(result)
+          end
+        rescue ROM::CommandError => e
+          ROM::Commands::Result::Failure.new(e)
         end
       end
     end

data/lib/rom/sql/plugin/pagination.rb

@@ -31,7 +31,7 @@ module ROM
           end
 
           def total_pages
-            (total / per_page) + 1
+            (total / per_page.to_f).ceil
           end
 
           def at(dataset, current_page, per_page = self.per_page)

data/lib/rom/sql/relation.rb

@@ -4,6 +4,8 @@ require 'rom/sql/relation/class_methods'
 require 'rom/sql/relation/inspection'
 require 'rom/sql/relation/associations'
 
+require 'rom/sql/plugin/pagination'
+
 module ROM
   module SQL
     # Sequel-specific relation extensions

data/lib/rom/sql/relation/associations.rb

@@ -45,18 +45,30 @@ module ROM
         end
 
         # @api private
-        def graph_join(name, join_type, options = {})
-          assoc = model.association_reflection(name)
+        def graph_join(assoc_name, join_type, options = {})
+          assoc = model.association_reflection(assoc_name)
+
+          if assoc.nil?
+            raise NoAssociationError,
+              "Association #{assoc_name.inspect} has not been " \
+              "defined for relation #{name.inspect}"
+          end
 
           key = assoc[:key]
           type = assoc[:type]
+          table_name = assoc[:class].table_name
 
-          if type == :many_to_many
-            select = options[:select] || {}
-            graph_join_many_to_many(name, assoc, select)
-          else
-            graph_join_other(name, key, type, join_type, options)
-          end
+          graph_rel =
+            if type == :many_to_many
+              select = options[:select] || {}
+              graph_join_many_to_many(table_name, assoc, select)
+            else
+              graph_join_other(table_name, key, type, join_type, options)
+            end
+
+          graph_rel = graph_rel.where(assoc[:conditions]) if assoc[:conditions]
+
+          graph_rel
         end
 
         # @api private

data/lib/rom/sql/relation/class_methods.rb

@@ -14,11 +14,11 @@ module ROM
         end
 
         def one_to_many(name, options)
-          associations << [__method__, name, options.merge(relation: name)]
+          associations << [__method__, name, { relation: name }.merge(options)]
         end
 
         def many_to_many(name, options = {})
-          associations << [__method__, name, options.merge(relation: name)]
+          associations << [__method__, name, { relation: name }.merge(options)]
         end
 
         def many_to_one(name, options = {})
@@ -31,10 +31,9 @@ module ROM
           model.set_dataset(relation.dataset)
           model.dataset.naked!
 
-          associations.each do |*args, options|
-            model = relation.model
-            other = relations[options.fetch(:relation)].model
-
+          associations.each do |*args, assoc_opts|
+            options = Hash[assoc_opts]
+            other = relations[options.delete(:relation) || args[1]].model
             model.public_send(*args, options.merge(class: other))
           end
 

data/lib/rom/sql/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module SQL
-    VERSION = '0.4.1'.freeze
+    VERSION = '0.4.3'.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"
+  spec.add_runtime_dependency "rom", "~> 0.7", ">= 0.7.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"

data/spec/integration/combine_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'Eager loading' do
+  include_context 'users and tasks'
+
+  before do
+    setup.relation(:users) do
+      def by_name(name)
+        where(name: name)
+      end
+    end
+
+    setup.relation(:tasks) do
+      def for_users(users)
+        where(user_id: users.map { |tuple| tuple[:id] })
+      end
+    end
+
+    setup.relation(:tags) do
+      def for_tasks(tasks)
+        inner_join(:task_tags, task_id: :id)
+          .where(task_id: tasks.map { |tuple| tuple[:id] })
+      end
+    end
+  end
+
+  it 'issues 3 queries for 3 combined relations' do
+    users = rom.relation(:users).by_name('Piotr')
+    tasks = rom.relation(:tasks)
+    tags = rom.relation(:tags)
+
+    relation = users.combine(tasks.for_users.combine(tags.for_tasks))
+
+    # TODO: figure out a way to assert correct number of issued queries
+    expect(relation.call).to be_instance_of(ROM::Relation::Loaded)
+  end
+end

data/spec/integration/commands/create_spec.rb

@@ -20,6 +20,11 @@ describe 'Commands / Create' do
     setup.commands(:users) do
       define(:create) do
         input Params
+
+        validator -> tuple {
+          raise ROM::CommandError.new('name cannot be empty') if tuple[:name] == ''
+        }
+
         result :one
       end
 
@@ -32,7 +37,7 @@ describe 'Commands / Create' do
   end
 
   context '#transaction' do
-    it 'create record if nothing was raised' do
+    it 'creates record if nothing was raised' do
       result = users.create.transaction {
         users.create.call(name: 'Jane')
       }
@@ -50,15 +55,59 @@ describe 'Commands / Create' do
       expect(result.value).to eq(id: 1, name: 'Jane')
     end
 
-    it 'create nothing if anything was raised' do
-      result = users.create.transaction(rollback: :always) {
-        users.create.call(name: 'Jane')
-      }
+    it 'creates nothing if command error was raised' do
+      expect {
+        passed = false
+
+        result = users.create.transaction {
+          users.create.call(name: 'Jane')
+          users.create.call(name: '')
+        } >-> value {
+          passed = true
+        }
+
+        expect(result.value).to be(nil)
+        expect(result.error.message).to eql('name cannot be empty')
+        expect(passed).to be(false)
+      }.to_not change { rom.relations.users.count }
+    end
+
+    it 'creates nothing if rollback was raised' do
+      expect {
+        passed = false
 
-      expect(result.value).to be_nil
+        result = users.create.transaction {
+          users.create.call(name: 'Jane')
+          users.create.call(name: 'John')
+          raise ROM::SQL::Rollback
+        } >-> value {
+          passed = true
+        }
+
+        expect(result.value).to be(nil)
+        expect(result.error).to be(nil)
+        expect(passed).to be(false)
+      }.to_not change { rom.relations.users.count }
+    end
+
+    it 'creates nothing if constraint error was raised' do
+      expect {
+        passed = false
+
+        result = users.create.transaction {
+          users.create.call(name: 'Jane')
+          users.create.call(name: 'Jane')
+        } >-> value {
+          passed = true
+        }
+
+        expect(result.value).to be(nil)
+        expect(result.error).to_not be(nil)
+        expect(passed).to be(false)
+      }.to_not change { rom.relations.users.count }
     end
 
-    it 'create nothing if anything was raised in any nested transaction' do
+    it 'creates nothing if anything was raised in any nested transaction' do
       expect {
         expect {
           users.create.transaction {

data/spec/integration/read_spec.rb

@@ -5,7 +5,7 @@ describe 'Reading relations' do
   include_context 'users and tasks'
 
   before :each do
-    class Task
+    class Goal
       include Virtus.value_object(coerce: true)
 
       values do
@@ -20,31 +20,34 @@ describe 'Reading relations' do
       values do
         attribute :id, Integer
         attribute :name, String
-        attribute :tasks, Array[Task]
+        attribute :goals, Array[Goal]
       end
     end
 
-    class UserTaskCount
+    class UserGoalCount
       include Virtus.value_object(coerce: true)
 
       values do
         attribute :id, Integer
         attribute :name, String
-        attribute :task_count, Integer
+        attribute :goal_count, Integer
       end
     end
 
-    setup.relation(:tasks)
+    setup.relation(:goals) do
+      register_as :goals
+      dataset :tasks
+    end
 
     setup.relation(:users) do
-      one_to_many :tasks, key: :user_id
+      one_to_many :goals, key: :user_id
 
       def by_name(name)
         where(name: name)
       end
 
-      def with_tasks
-        association_left_join(:tasks, select: [:id, :title])
+      def with_goals
+        association_left_join(:goals, select: [:id, :title])
       end
 
       def all
@@ -52,19 +55,19 @@ describe 'Reading relations' do
       end
     end
 
-    setup.relation(:user_task_counts) do
+    setup.relation(:user_goal_counts) do
       dataset :users
-      register_as :user_task_counts
-      one_to_many :tasks, key: :user_id
+      register_as :user_goal_counts
+      one_to_many :goals, key: :user_id
 
       def all
-        with_tasks.select_group(:users__id, :users__name).select_append {
-          count(:tasks).as(:task_count)
+        with_goals.select_group(:users__id, :users__name).select_append {
+          count(:tasks).as(:goal_count)
         }
       end
 
-      def with_tasks
-        association_left_join(:tasks, select: [:id, :title])
+      def with_goals
+        association_left_join(:goals, select: [:id, :title])
       end
     end
 
@@ -72,36 +75,36 @@ describe 'Reading relations' do
       define(:users) do
         model User
 
-        group :tasks do
-          model Task
+        group :goals do
+          model Goal
 
           attribute :id, from: :tasks_id
           attribute :title
         end
       end
 
-      define(:user_task_counts) do
-        model UserTaskCount
+      define(:user_goal_counts) do
+        model UserGoalCount
       end
     end
   end
 
   it 'loads domain objects' do
-    user = rom.relation(:users).as(:users).with_tasks.by_name('Piotr').to_a.first
+    user = rom.relation(:users).as(:users).with_goals.by_name('Piotr').to_a.first
 
     expect(user).to eql(
       User.new(
-        id: 1, name: 'Piotr', tasks: [Task.new(id: 1, title: 'Finish ROM')]
+        id: 1, name: 'Piotr', goals: [Goal.new(id: 1, title: 'Finish ROM')]
       ))
   end
 
   it 'works with grouping and aggregates' do
-    rom.relations[:tasks].insert(id: 2, user_id: 1, title: 'Get Milk')
+    rom.relations[:goals].insert(id: 2, user_id: 1, title: 'Get Milk')
 
-    users_with_task_count = rom.relation(:user_task_counts).as(:user_task_counts).all
+    users_with_goal_count = rom.relation(:user_goal_counts).as(:user_goal_counts).all
 
-    expect(users_with_task_count.to_a).to eq([
-      UserTaskCount.new(id: 1, name: "Piotr", task_count: 2)
+    expect(users_with_goal_count.to_a).to eq([
+      UserGoalCount.new(id: 1, name: "Piotr", goal_count: 2)
     ])
   end
 end

data/spec/shared/database_setup.rb

@@ -3,6 +3,7 @@ shared_context 'database setup' do
 
   let(:uri) { DB_URI }
   let(:conn) { Sequel.connect(uri) }
+
   let(:setup) { ROM.setup(:sql, conn) }
 
   def drop_tables

data/spec/spec_helper.rb

@@ -10,8 +10,11 @@ end
 
 require 'rom-sql'
 require 'rom/sql/rake_task'
+
 # FIXME: why do we need to require it manually??
 require 'sequel/adapters/postgres'
+require 'active_support/inflector'
+
 require 'logger'
 begin
   require 'byebug'

data/spec/unit/association_errors_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'Association errors' do
+  include_context 'users and tasks'
+
+  describe 'accessing an undefined association' do
+    specify do
+      setup.relation(:users) do
+        def with_undefined
+          association_join(:undefined)
+        end
+      end
+
+      expect {
+        rom.relations.users.with_undefined
+      }.to raise_error ROM::SQL::NoAssociationError, 'Association :undefined has not been defined for relation :users'
+    end
+  end
+end
+

data/spec/unit/one_to_many_spec.rb

@@ -3,6 +3,16 @@ require 'spec_helper'
 describe 'Defining one-to-many association' do
   include_context 'users and tasks'
 
+  before do
+    setup.mappers do
+      define(:users)
+
+      define(:with_tasks, parent: :users) do
+        group tasks: [:tasks_id, :title]
+      end
+    end
+  end
+
   it 'extends relation with association methods' do
     setup.relation(:users) do
       one_to_many :tasks, key: :user_id
@@ -20,22 +30,42 @@ describe 'Defining one-to-many association' do
       end
     end
 
-    setup.mappers do
-      define(:users)
+    users = rom.relations.users
 
-      define(:with_tasks, parent: :users) do
-        group tasks: [:tasks_id, :title]
+    expect(users.with_tasks.by_name("Piotr").to_a).to eql(
+      [{ id: 1, name: 'Piotr', tasks_id: 1, title: 'Finish ROM' }]
+    )
+
+    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
+
+  it 'allows setting :conditions' do
+    setup.relation(:users) do
+      one_to_many :piotrs_tasks, relation: :tasks, key: :user_id,
+        conditions: { name: 'Piotr' }
+
+      def with_piotrs_tasks
+        association_left_join(:piotrs_tasks, select: [:id, :title])
+      end
+
+      def all
+        select(:id, :name)
       end
     end
 
     users = rom.relations.users
 
-    expect(users.with_tasks.by_name("Piotr").to_a).to eql(
+    expect(users.with_piotrs_tasks.to_a).to eql(
       [{ id: 1, name: 'Piotr', tasks_id: 1, title: 'Finish ROM' }]
     )
 
     result = rom.relation(:users).map_with(:with_tasks)
-      .all.with_tasks.by_name("Piotr").to_a
+      .all.with_piotrs_tasks.to_a
 
     expect(result).to eql(
       [{ id: 1, name: 'Piotr', tasks: [{ tasks_id: 1, title: 'Finish ROM' }] }]

data/spec/unit/plugin/pagination_spec.rb

@@ -9,7 +9,7 @@ describe 'Plugin / Pagination' do
     9.times { |i| conn[:users].insert(name: "User #{i}") }
 
     setup.relation(:users) do
-      include ROM::SQL::Plugin::Pagination # meh such constants not wow
+      use :pagination
 
       per_page 4
     end
@@ -53,6 +53,18 @@ describe 'Plugin / Pagination' do
     end
   end
 
+  describe '#total_pages' do
+    it 'returns a single page when elements are a perfect fit' do
+      users = rom.relation(:users).page(1).per_page(3)
+      expect(users.pager.total_pages).to eql(3)
+    end
+
+    it 'returns the exact number of pages to accommodate all elements' do
+      users = rom.relation(:users).per_page(9)
+      expect(users.pager.total_pages).to eql(1)
+    end
+  end
+
   describe '#pager' do
     it 'returns a pager with pagination meta-info' do
       users = rom.relation(:users).page(1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-sql
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-04 00:00:00.000000000 Z
+date: 2015-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -50,14 +50,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +138,7 @@ files:
 - log/.gitkeep
 - rom-sql.gemspec
 - spec/fixtures/migrations/20150403090603_create_carrots.rb
+- spec/integration/combine_spec.rb
 - spec/integration/commands/create_spec.rb
 - spec/integration/commands/delete_spec.rb
 - spec/integration/commands/update_spec.rb
@@ -142,6 +149,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/active_support_notifications_spec.rb
 - spec/support/rails_log_subscriber_spec.rb
+- spec/unit/association_errors_spec.rb
 - spec/unit/combined_associations_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/many_to_many_spec.rb
@@ -179,6 +187,7 @@ specification_version: 4
 summary: SQL databases support for ROM
 test_files:
 - spec/fixtures/migrations/20150403090603_create_carrots.rb
+- spec/integration/combine_spec.rb
 - spec/integration/commands/create_spec.rb
 - spec/integration/commands/delete_spec.rb
 - spec/integration/commands/update_spec.rb
@@ -189,6 +198,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/active_support_notifications_spec.rb
 - spec/support/rails_log_subscriber_spec.rb
+- spec/unit/association_errors_spec.rb
 - spec/unit/combined_associations_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/many_to_many_spec.rb
@@ -200,4 +210,3 @@ test_files:
 - spec/unit/relation_spec.rb
 - spec/unit/repository_spec.rb
 - spec/unit/schema_spec.rb
-has_rdoc: