rom-sql 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b418fd66438b79201905f6028726de01065b463f
-  data.tar.gz: 07b4d5462ea91aea73913c11794d7946569c3d34
+  metadata.gz: c088db5ced8d4a5297ceb909e77dba86cd80ed37
+  data.tar.gz: 9d7f52c636a1418b966d7c609f57e766a1a4b224
 SHA512:
-  metadata.gz: 8525d555c7682a1122613f1b4de21205029f6a6c1d4f1046cdff8c875468cacca3846826f2007fa73fc98074733f3bcfe4027049c2cfb24aed585a6049ae20b0
-  data.tar.gz: 4efbe175a8462af7c47751ca171085e112f5d82da75f3dbc3d20d81e4eac568e558a93490af860dd800900f449d59d61ca12e7e1dd2da0560b3fbe94dac95f33
+  metadata.gz: 2603a384db038ddf194df6827b4d29585f48b5db8cd4791117149e292c55d3c0e8ddcec364e516b046fab29a28c32af22e964f4788c4f44082b808239b1127b3
+  data.tar.gz: 67d0846c7bea76d5c9365d35874a9755aa1c0306cbf09de7ce51b4964c16784c740f2b8713bb632dca0d54ac3ba480fc931d3a477abd602791ed28be4ba81183

data/CHANGELOG.md

@@ -1,8 +1,25 @@
-# v0.1.1 2014-11-24
+## v0.2.0 2014-12-06
 
-* [fixed] fix equalizer in header (solnic)
-* [internal] minor refactor in adapter (solnic)
+### Added
 
-# v0.1.0 2014-11-24
+* Command API (solnic)
+* Support for ActiveSupport::Notifications with a log subscriber (solnic)
+* New `ROM::SQL::Adapter#dataset?(name)` checking if a given table exists (solnic)
+
+[Compare v0.1.1...v0.2.0](https://github.com/rom-rb/rom-sql/compare/v0.1.1...v0.2.0)
+
+## v0.1.1 2014-11-24
+
+### Fixed
+
+* Equalizer in header (solnic)
+
+### Changed
+
+* minor refactor in adapter (solnic)
+
+[Compare v0.1.0...v0.1.1](https://github.com/rom-rb/rom-sql/compare/v0.1.0...v0.1.1)
+
+## v0.1.0 2014-11-24
 
 First release powered by Sequel

data/Gemfile

@@ -4,6 +4,7 @@ gemspec
 
 group :test do
   gem 'rom', git: 'https://github.com/rom-rb/rom.git', branch: 'master'
+  gem 'activesupport'
   gem 'rspec', '~> 3.1'
   gem 'codeclimate-test-reporter', require: false
   gem 'pg', platforms: [:mri, :rbx]

data/README.md

@@ -41,7 +41,7 @@ in relation objects. For schema migrations you can use its
 which is available via repositories.
 
 ``` ruby
-setup = ROM.setup(sqlite: "memory::sqlite")
+setup = ROM.setup(sqlite: "sqlite::memory")
 
 setup.sqlite.connection.create_table(:users) do
   primary_key :id
@@ -87,8 +87,8 @@ rom = setup.finalize
 users = rom.relations.users
 tasks = rom.relations.tasks
 
-users.insert(name: "Piotr")
-tasks.insert(title: "Be happy")
+users.insert(id: 1, name: "Piotr")
+tasks.insert(user_id: 1, title: "Be happy")
 
 puts users.by_name("Piotr").with_tasks.to_a.inspect
 # => [{:id=>1, :name=>"Piotr", :user_id=>1, :title=>"Be happy"}]
@@ -118,9 +118,7 @@ setup.mappers do
   define(:users) do
     model name: 'User'
 
-    group :tasks do
-      attribute :title
-    end
+    group tasks: [:title]
   end
 end
 
@@ -129,8 +127,8 @@ rom = setup.finalize
 users = rom.relations.users
 tasks = rom.relations.tasks
 
-users.insert(name: "Piotr")
-tasks.insert(title: "Be happy")
+users.insert(id: 1, name: "Piotr")
+tasks.insert(user_id: 1, title: "Be happy")
 
 rom.read(:users).with_tasks.by_name("Piotr").to_a
 # => [#<User:0x007fb31542a098 @id=1, @name="Piotr", @tasks=[{:title=>"Be happy"}]>]

data/lib/rom/sql.rb

@@ -1,6 +1,12 @@
 require "sequel"
-
 require "rom"
+
+module ROM
+  module SQL
+    ConstraintError = Class.new(ROM::CommandError)
+  end
+end
+
 require "rom/sql/version"
 require "rom/sql/header"
 require "rom/sql/relation_extension"
@@ -8,3 +14,8 @@ require "rom/sql/relation_inclusion"
 require "rom/sql/adapter"
 
 require "rom/sql/support/sequel_dataset_ext"
+
+if defined?(Rails)
+  require "rom/sql/support/active_support_notifications"
+  require 'rom/sql/support/rails_log_subscriber'
+end

data/lib/rom/sql/adapter.rb

@@ -1,8 +1,12 @@
+require 'logger'
+
+require 'rom/sql/commands'
+
 module ROM
   module SQL
 
     class Adapter < ROM::Adapter
-      attr_reader :connection
+      attr_reader :logger
 
       def self.schemes
         [:ado, :amalgalite, :cubrid, :db2, :dbi, :do, :fdbsql, :firebird, :ibmdb,
@@ -19,10 +23,19 @@ module ROM
         connection[name]
       end
 
+      def logger=(logger)
+        @logger = logger
+        connection.loggers << logger
+      end
+
       def schema
         tables.map { |table| [table, dataset(table), columns(table)] }
       end
 
+      def dataset?(name)
+        tables.include?(name)
+      end
+
       def extend_relation_class(klass)
         klass.send(:include, RelationInclusion)
       end
@@ -31,6 +44,10 @@ module ROM
         relation.extend(RelationExtension)
       end
 
+      def command_namespace
+        SQL::Commands
+      end
+
       private
 
       def tables

data/lib/rom/sql/commands.rb

@@ -0,0 +1,49 @@
+module ROM
+  module SQL
+    module Commands
+      ERRORS = [
+        Sequel::UniqueConstraintViolation,
+        Sequel::NotNullConstraintViolation
+      ].freeze
+
+      class Create < ROM::Commands::Create
+
+        def execute(tuples)
+          pks = Array([tuples]).flatten.map do |tuple|
+            attributes = input[tuple]
+            validator.call(attributes)
+            relation.insert(attributes.to_h)
+          end
+
+          relation.where(relation.model.primary_key => pks)
+        rescue *ERRORS => e
+          raise ConstraintError, e.message
+        end
+      end
+
+      class Update < ROM::Commands::Update
+
+        def execute(tuple)
+          attributes = input[tuple]
+          validator.call(attributes)
+
+          pks = relation.map { |t| t[relation.model.primary_key] }
+
+          relation.update(attributes.to_h)
+          relation.unfiltered.where(relation.model.primary_key => pks)
+        end
+
+      end
+
+      class Delete < ROM::Commands::Delete
+
+        def execute
+          target.delete
+          relation
+        end
+
+      end
+
+    end
+  end
+end

data/lib/rom/sql/support/active_support_notifications.rb

@@ -0,0 +1,29 @@
+require 'sequel/database/logging'
+require 'active_support/notifications'
+
+module Sequel
+
+  class Database
+
+    def log_yield_with_instrumentation(sql, args = nil, &block)
+      ActiveSupport::Notifications.instrument(
+        'sql.rom',
+        :sql => sql,
+        :name => instrumentation_name,
+        :binds => args
+      ) do
+        log_yield_without_instrumentation(sql, args, &block)
+      end
+    end
+
+    alias_method :log_yield_without_instrumentation, :log_yield
+    alias_method :log_yield, :log_yield_with_instrumentation
+
+    private
+
+    def instrumentation_name
+      "ROM[#{database_type}]"
+    end
+
+  end
+end

data/lib/rom/sql/support/rails_log_subscriber.rb

@@ -0,0 +1,36 @@
+require 'active_support/log_subscriber'
+
+module ROM
+  module SQL
+
+    class RailsLogSubscriber < ActiveSupport::LogSubscriber
+
+      def sql(event)
+        return unless logger.debug?
+
+        payload = event.payload
+
+        name = format('%s (%.1fms)', payload[:name], event.duration)
+        sql  = payload[:sql].squeeze(' ')
+        binds = payload[:binds].to_a.inspect if payload[:binds]
+
+        if odd?
+          name = color(name, :cyan, true)
+          sql  = color(sql, nil, true)
+        else
+          name = color(name, :magenta, true)
+        end
+
+        debug "   #{name}  #{sql}  #{binds}"
+      end
+
+      def odd?
+        @odd_or_even = !@odd_or_even
+      end
+
+    end
+
+  end
+end
+
+ROM::SQL::RailsLogSubscriber.attach_to(:rom)

data/lib/rom/sql/version.rb

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

data/rom-sql.gemspec

@@ -5,7 +5,7 @@ require 'rom/sql/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "rom-sql"
-  spec.version       = ROM::SQL::VERSION
+  spec.version       = ROM::SQL::VERSION.dup
   spec.authors       = ["Piotr Solnica"]
   spec.email         = ["piotr.solnica@gmail.com"]
   spec.summary       = %q{RDBMS support for ROM}
@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "sequel", "~> 4.16"
+  spec.add_runtime_dependency "sequel", "~> 4.17"
   spec.add_runtime_dependency "equalizer", "~> 0.0", ">= 0.0.9"
-  spec.add_runtime_dependency "rom", "~> 0.3", "~> 0.3.0"
+  spec.add_runtime_dependency "rom", "~> 0.4", ">= 0.4.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"

data/spec/integration/commands/create_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe 'Commands / Create' do
+  include_context 'users and tasks'
+
+  subject(:users) { rom.commands.users }
+
+  before do
+    setup.relation(:users)
+
+    setup.commands(:users) do
+      define(:create) do
+        result :one
+      end
+
+      define(:create_many, type: :create) do
+        result :many
+      end
+    end
+  end
+
+  it 'returns a single tuple when result is set to :one' do
+    result = users.try { create(id: 2, name: 'Jane') }
+
+    expect(result.value).to eql(id: 2, name: 'Jane')
+  end
+
+  it 'returns tuples when result is set to :many' do
+    result = users.try {
+      create_many([{ id: 2, name: 'Jane' }, { id: 3, name: 'Jack' }])
+    }
+
+    expect(result.value.to_a).to match_array([
+      { id: 2, name: 'Jane' }, { id: 3, name: 'Jack' }
+    ])
+  end
+
+  it 'handles not-null constraint violation error' do
+    result = users.try { create(id: nil, name: 'Jane') }
+
+    expect(result.error).to be_instance_of(ROM::SQL::ConstraintError)
+    expect(result.error.message).to match(/not-null/)
+  end
+
+  it 'handles uniqueness constraint violation error' do
+    result = users.try { create(id: 3, name: 'Piotr') }
+
+    expect(result.error).to be_instance_of(ROM::SQL::ConstraintError)
+    expect(result.error.message).to match(/unique/)
+  end
+end

data/spec/integration/commands/delete_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'Commands / Delete' do
+  include_context 'users and tasks'
+
+  subject(:users) { rom.commands.users }
+
+  before do
+    setup.relation(:users) do
+      def by_name(name)
+        where(name: 'Piotr')
+      end
+    end
+
+    setup.commands(:users) do
+      define(:delete)
+    end
+
+    rom.relations.users.insert(id: 2, name: 'Jane')
+  end
+
+  it 'deletes all tuples' do
+    result = users.try { delete }
+
+    expect(result.value.to_a).to match_array([])
+  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' }])
+  end
+end

data/spec/integration/commands/update_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'Commands / Update' do
+  include_context 'users and tasks'
+
+  subject(:users) { rom.commands.users }
+
+  it 'works' do
+    setup.relation(:users) do
+      def by_name(name)
+        where(name: name)
+      end
+    end
+
+    setup.commands(:users) do
+      define(:update) do
+        input Hash
+        validator Proc.new {}
+      end
+    end
+
+    result = users.try { update(:by_name, 'Piotr').set(name: 'Peter') }
+
+    expect(result.value.to_a).to match_array([{ id: 1, name: 'Peter' }])
+  end
+end

data/spec/shared/database_setup.rb

@@ -0,0 +1,36 @@
+shared_context 'database setup' do
+  subject(:rom) { setup.finalize }
+
+  let(:setup) { ROM.setup(postgres: 'postgres://localhost/rom') }
+  let(:conn) { setup.postgres.connection }
+
+  before do
+    setup.postgres.use_logger(LOGGER)
+
+    [:users, :tasks, :tags, :task_tags].each { |name| conn.drop_table?(name) }
+
+    conn.create_table :users do
+      primary_key :id
+      String :name
+      index :name, unique: true
+    end
+
+    conn.create_table :tasks do
+      primary_key :id
+      Integer :user_id
+      String :title
+    end
+
+    conn.create_table :tags do
+      primary_key :id
+      String :name
+    end
+
+    conn.create_table :task_tags do
+      primary_key :tag_id, :task_id
+      Integer :tag_id
+      Integer :task_id
+    end
+
+  end
+end

data/spec/shared/users_and_tasks.rb

@@ -1,34 +1,7 @@
 shared_context 'users and tasks' do
-  subject(:rom) { setup.finalize }
-
-  let(:setup) { ROM.setup(postgres: 'postgres://localhost/rom') }
-  let(:conn) { setup.postgres.connection }
+  include_context 'database setup'
 
   before do
-    [:users, :tasks, :tags, :task_tags].each { |name| conn.drop_table?(name) }
-
-    conn.create_table :users do
-      primary_key :id
-      String :name
-    end
-
-    conn.create_table :tasks do
-      primary_key :id
-      Integer :user_id
-      String :title
-    end
-
-    conn.create_table :tags do
-      primary_key :id
-      String :name
-    end
-
-    conn.create_table :task_tags do
-      primary_key :tag_id, :task_id
-      Integer :tag_id
-      Integer :task_id
-    end
-
     conn[:users].insert id: 1, name: 'Piotr'
     conn[:tasks].insert id: 1, user_id: 1, title: 'Finish ROM'
     conn[:tags].insert id: 1, name: 'important'

data/spec/spec_helper.rb

@@ -6,6 +6,9 @@ if RUBY_ENGINE == 'rbx'
 end
 
 require 'rom-sql'
+require 'logger'
+
+LOGGER = Logger.new(File.open('./log/test.log', 'a'))
 
 root = Pathname(__FILE__).dirname
 

data/spec/support/active_support_notifications_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+require 'rom/sql/support/active_support_notifications'
+require 'active_support/log_subscriber'
+
+describe 'ActiveSupport::Notifications support' do
+  include_context 'database setup'
+
+  it 'works' do
+    rom.postgres.use_logger(LOGGER)
+
+    sql = nil
+
+    ActiveSupport::Notifications.subscribe('sql.rom') do |name, start, finish, id, payload|
+      sql = payload[:sql]
+    end
+
+    rom.postgres.connection.run(%(SELECT * FROM "users" WHERE name = 'notification test'))
+
+    expect(sql).to eql(%(SELECT * FROM "users" WHERE name = 'notification test'))
+  end
+end

data/spec/support/rails_log_subscriber_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+require 'rom/sql/support/active_support_notifications'
+require 'rom/sql/support/rails_log_subscriber'
+
+require 'active_support/log_subscriber/test_helper'
+
+describe 'Rails log subscriber' do
+  include ActiveSupport::LogSubscriber::TestHelper
+
+  include_context 'database setup'
+
+  let(:test_query) do
+    %(SELECT * FROM "users" WHERE name = 'notification test')
+  end
+
+  let(:logger) { ActiveSupport::LogSubscriber::TestHelper::MockLogger.new }
+
+  before do
+    set_logger(logger)
+    rom.postgres.use_logger(logger)
+  end
+
+  it 'works' do
+    rom.postgres.connection.run(test_query)
+
+    expect(logger.logged(:debug).last).to include(test_query)
+  end
+end

data/spec/unit/adapter_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe ROM::Adapter do
+  subject(:adapter) { rom.postgres.adapter }
+
+  let(:setup) { ROM.setup(postgres: "postgres://localhost/rom") }
+  let(:rom) { setup.finalize }
+
+  describe '#dataset?' do
+    it 'returns true if a table exists' do
+      expect(adapter.dataset?(:users)).to be(true)
+    end
+
+    it 'returns false if a table does not exist' do
+      expect(adapter.dataset?(:not_here)).to be(false)
+    end
+  end
+end

data/spec/unit/logger_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'Logger' do
+  include_context 'users and tasks'
+
+  it 'sets up a logger for sequel' do
+    repository = rom.postgres
+
+    expect(repository.logger).to be(LOGGER)
+    expect(repository.connection.loggers).to include(LOGGER)
+  end
+end

metadata

@@ -1,95 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: rom-sql
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2014-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.16'
+        version: '4.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.16'
+        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.3'
-    - - ~>
+        version: '0.4'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ~>
+        version: '0.4'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        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
@@ -110,16 +110,28 @@ files:
 - lib/rom-sql.rb
 - lib/rom/sql.rb
 - 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
+- lib/rom/sql/support/rails_log_subscriber.rb
 - lib/rom/sql/support/sequel_dataset_ext.rb
 - lib/rom/sql/version.rb
+- log/.gitkeep
 - rom-sql.gemspec
+- spec/integration/commands/create_spec.rb
+- spec/integration/commands/delete_spec.rb
+- spec/integration/commands/update_spec.rb
+- spec/shared/database_setup.rb
 - spec/shared/users_and_tasks.rb
 - spec/spec_helper.rb
+- spec/support/active_support_notifications_spec.rb
+- spec/support/rails_log_subscriber_spec.rb
+- spec/unit/adapter_spec.rb
 - spec/unit/combined_associations_spec.rb
+- spec/unit/logger_spec.rb
 - spec/unit/many_to_many_spec.rb
 - spec/unit/many_to_one_spec.rb
 - spec/unit/one_to_many_spec.rb
@@ -135,26 +147,35 @@ 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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: RDBMS support for ROM
 test_files:
+- spec/integration/commands/create_spec.rb
+- spec/integration/commands/delete_spec.rb
+- spec/integration/commands/update_spec.rb
+- spec/shared/database_setup.rb
 - spec/shared/users_and_tasks.rb
 - spec/spec_helper.rb
+- spec/support/active_support_notifications_spec.rb
+- spec/support/rails_log_subscriber_spec.rb
+- spec/unit/adapter_spec.rb
 - spec/unit/combined_associations_spec.rb
+- spec/unit/logger_spec.rb
 - spec/unit/many_to_many_spec.rb
 - spec/unit/many_to_one_spec.rb
 - spec/unit/one_to_many_spec.rb
 - spec/unit/relation_spec.rb
 - spec/unit/schema_spec.rb
+has_rdoc: