rom-sql 0.3.2 → 0.4.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e002fcfac65061b46118390214d8731033307b4
-  data.tar.gz: a13fd979244aee8b7a2c46ef4b522333534ecbd9
+  metadata.gz: 43358c16de1cbf1030d10052160c9a5a7e922216
+  data.tar.gz: 0c9950d51f83c690436f1ba9504435c2bad53d2c
 SHA512:
-  metadata.gz: 27e70cf80b500a17af3d29ec60d10c9066caed57256a39f9f7acdc6955999b68d38b18e0356d2ac0518340280651ef5d08d15fd973753050cd66086e0bed2726
-  data.tar.gz: 8b37d7213ff4a0330a3331969886d670a8a09d46dd0cea8145bd45a1959259d44b3fe4dfac5544df6cda76eb0718d6b3406b67d0b7953c90c04c1346ee80bd88
+  metadata.gz: 916eb01f87b7825519ec9d917ee1904e04fa75537e5e2e35ba470cdc6239f4a0f2037393b64cec97e77fd9f1ea322939cf919e00618a6fff628297bfd1d9ab34
+  data.tar.gz: d2a3fe1e9077a547b44938c3600d5586548a7a283fa4d46de8c2d73d8b51394f56e8691b88d6197a38de9662c2c3ec697d24ed5415ee48df522010877da70728

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+log/*.log

data/.rubocop.yml

@@ -1,41 +1,78 @@
-# FIXME: Lower by refactoring biggest offenders
-Metrics/AbcSize:
-  Max: 27
+# Generated by `rubocop --auto-gen-config`
+inherit_from: .rubocop_todo.yml
 
-# FIXME: Lower by refactoring biggest offenders
-Metrics/MethodLength:
-  Max: 32
+# Exclude temporary files
+AllCops:
+  Exclude:
+    - tmp/**/*
+
+# It’s quite readable when we know what we are doing
+Lint/AssignmentInCondition:
+  Enabled: false
 
-# FIXME: Lower by refactoring biggest offenders
-Metrics/PerceivedComplexity:
-  Max: 9
+# No need to handle LoadError in Rakefile
+Lint/HandleExceptions:
+  Exclude:
+    - Rakefile
 
-# This file is not worth fixing
+# gemspec is a special snowflake
 Metrics/LineLength:
   Exclude:
-    - spec/support/active_support_notifications_spec.rb
+    - rom.gemspec
 
 # The enforced style doesn’t match Vim’s defaults
 Style/AlignParameters:
   Enabled: false
 
+# UTF-8 is perfectly fine in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Allow using braces for value-returning blocks
+Style/Blocks:
+  Enabled: false
+
 # Documentation checked by Inch CI
 Style/Documentation:
   Enabled: false
 
-# This is a shim file for those who require 'rom-mongo'
-Style/FileName:
-  Exclude:
-    - lib/rom-sql.rb
+# Early returns have their vices
+Style/GuardClause:
+  Enabled: false
 
-# The default style doesn’t match Vim’s defaults
-Style/IndentHash:
-  EnforcedStyle: consistent
+# Need to be skipped for >-> usage
+Style/Lambda:
+  Enabled: false
+
+# Multiline block chains are ok
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Result::Success and Result::Failure use > for callbacks
+Style/OpMethod:
+  Exclude:
+    - lib/rom/command_registry.rb
 
 # Even a single escaped slash can be confusing
 Style/RegexpLiteral:
   MaxSlashes: 0
 
+# Don’t introduce semantic fail/raise distinction
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Need to be skipped for >-> usage
+Style/SpaceAroundOperators:
+  Enabled: false
+
 # Accept both single and double quotes
 Style/StringLiterals:
   Enabled: false
+
+# Allow def self.foo; @foo; end
+Style/TrivialAccessors:
+  Enabled: false
+
+# Allow rom-sql
+Style/FileName:
+    Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,15 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-25 22:37:25 +0100 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 20
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14

data/.travis.yml

@@ -1,21 +1,26 @@
 language: ruby
-bundler_args: --without yard guard benchmarks
-env:
-  - CODECLIMATE_REPO_TOKEN=03d7f66589572702b12426d2bc71c4de6281a96139e33b335b894264b1f8f0b0
+sudo: false
+cache: bundler
+bundler_args: --without yard guard benchmarks tools
 before_script:
   - psql -c 'create database rom;' -U postgres
-script: "bundle exec rake spec"
+script: "bundle exec rake ci"
 rvm:
   - 2.0
   - 2.1
   - 2.2
   - rbx-2
   - jruby
+  - jruby-head
   - ruby-head
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=03d7f66589572702b12426d2bc71c4de6281a96139e33b335b894264b1f8f0b0
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby
+    - rvm: jruby-head
 notifications:
   webhooks:
     urls:

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## v0.4.0 to-be-released
+
+### Added
+
+* `ROM::SQL::Relation` which explictly defines an interface on top of Sequel (solnic + mcls)
+* Experimental migration API using sequel/migrations (gotar)
+* Pagination plugin (solnic)
+
+### Changed
+
+* Use ROM's own inflector which uses either ActiveSupport or Inflecto backends (mjtko)
+
+### Fixed
+
+* Indentation in Rails logger (morgoth)
+
+[Compare v0.3.2...master](https://github.com/rom-rb/rom-sql/compare/v0.3.2...master)
+
 ## v0.3.2 2015-01-01
 
 ### Fixed

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rom', '~> 0.5.0', github: 'rom-rb/rom', branch: 'master'
+  gem 'rom', '~> 0.6.0', github: 'rom-rb/rom', branch: 'master'
   gem 'virtus'
   gem 'activesupport'
   gem 'rspec', '~> 3.1'
@@ -11,3 +11,10 @@ group :test do
   gem 'pg', platforms: [:mri, :rbx]
   gem 'pg_jruby', platforms: :jruby
 end
+
+group :tools do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'rubocop', '~> 0.28'
+end

data/Guardfile

@@ -0,0 +1,24 @@
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "rspec", all_on_start: true do
+    # run all specs if Gemfile.lock is modified
+    watch('Gemfile.lock') { 'spec' }
+
+    # run all specs if any library code is modified
+    watch(%r{\Alib/.+\.rb\z}) { 'spec' }
+
+    # run all specs if supporting files are modified
+    watch('spec/spec_helper.rb') { 'spec' }
+    watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
+
+    # run a spec if it is modified
+    watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
+
+    notification :tmux, display_message: true if ENV.key?('TMUX')
+  end
+
+  guard :rubocop do
+    # run rubocop on modified file
+    watch(%r{\Alib/.+\.rb\z})
+    watch(%r{\Aspec/.+\.rb\z})
+  end
+end

data/README.md

@@ -41,15 +41,15 @@ in relation objects. For schema migrations you can use its
 which is available via repositories.
 
 ``` ruby
-setup = ROM.setup(sqlite: "sqlite::memory")
+setup = ROM.setup(:sql, "sqlite::memory")
 
-setup.sqlite.connection.create_table(:users) do
+setup.default.connection.create_table(:users) do
   primary_key :id
   String :name
   Boolean :admin
 end
 
-setup.sqlite.connection.create_table(:tasks) do
+setup.default.connection.create_table(:tasks) do
   primary_key :id
   Integer :user_id
   String :title
@@ -60,15 +60,15 @@ end
 
 ``` ruby
 
-setup.relation(:tasks)
+class Users < ROM::Relation[:sql]
+  base_name :users
 
-setup.relation(:users) do
   def by_name(name)
     where(name: name)
   end
 end
 
-rom = setup.finalize
+rom = ROM.finalize.env
 
 users = rom.relations.users
 tasks = rom.relations.tasks
@@ -95,9 +95,9 @@ Sequel's association DSL is available in relation definitions which enables
 aggregate objects `wrap` and `group` mapping transformation can be used
 
 ``` ruby
-setup.relation(:tasks)
+ROM.setup(:sql, "sqlite::memory")
 
-setup.relation(:users) do
+class Users < ROM::Relation[:sql]
   one_to_many :tasks, key: :user_id
 
   def by_name(name)
@@ -109,15 +109,15 @@ setup.relation(:users) do
   end
 end
 
-setup.mappers do
-  define(:users) do
-    model name: 'User'
+class UserMapper < ROM::Mapper
+  relation :users
 
-    group tasks: [:title]
-  end
+  model name: 'User'
+
+  group tasks: [:title]
 end
 
-rom = setup.finalize
+rom = ROM.finalize.env
 
 users = rom.relations.users
 tasks = rom.relations.tasks
@@ -131,14 +131,6 @@ rom.read(:users).with_tasks.by_name("Piotr").to_a
 
 ## ROADMAP
 
-On a very high level:
-
-* Make it dead simple to join relations and support all types of joins
-* Make it dead simple to select and alias column names
-* Discover conventions for typical query scenarios and make common things trivial,
-  less common things simple and super rare cases possible
-* Make mapper interface smart enough to figure out when columns are aliased
-
 For details please refer to [issues](https://github.com/rom-rb/rom-sql/issues).
 
 ## License

data/Rakefile

@@ -1,10 +1,18 @@
 require "rspec/core/rake_task"
-require "rubocop/rake_task"
-
-task default: [:spec, :rubocop]
 
 RSpec::Core::RakeTask.new(:spec)
+task default: [:ci]
+
+desc "Run CI tasks"
+task ci: [:spec]
+
+begin
+  require "rubocop/rake_task"
+
+  Rake::Task[:default].enhance [:rubocop]
 
-RuboCop::RakeTask.new do |task|
-  task.options << "--display-cop-names"
+  RuboCop::RakeTask.new do |task|
+    task.options << "--display-cop-names"
+  end
+rescue LoadError
 end

data/lib/rom/sql.rb

@@ -8,13 +8,13 @@ module ROM
 end
 
 require "rom/sql/version"
-require "rom/sql/header"
-require "rom/sql/relation_inclusion"
-require "rom/sql/adapter"
-
-require "rom/sql/support/sequel_dataset_ext"
+require "rom/sql/relation"
+require "rom/sql/repository"
+require "rom/sql/migration"
 
 if defined?(Rails)
   require "rom/sql/support/active_support_notifications"
   require 'rom/sql/support/rails_log_subscriber'
 end
+
+ROM.register_adapter(:sql, ROM::SQL)

data/lib/rom/sql/commands.rb

@@ -1,3 +1,5 @@
+require 'rom/commands'
+
 module ROM
   module SQL
     module Commands
@@ -5,55 +7,11 @@ module ROM
         Sequel::UniqueConstraintViolation,
         Sequel::NotNullConstraintViolation
       ].freeze
-
-      module TupleCount
-        # TODO: we need an interface for "target_count" here
-        def assert_tuple_count
-          if result == :one && target.count > 1
-            raise TupleCountMismatchError, "#{inspect} expects one tuple"
-          end
-        end
-      end
-
-      class Create < ROM::Commands::Create
-        include TupleCount
-
-        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
-        include TupleCount
-
-        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
-        include TupleCount
-
-        def execute
-          deleted = target.to_a
-          target.delete
-          deleted
-        end
-      end
     end
   end
 end
+
+require 'rom/sql/commands/create'
+require 'rom/sql/commands/update'
+require 'rom/sql/commands/delete'
+require 'rom/sql/commands_ext/postgres'

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

@@ -0,0 +1,29 @@
+require 'rom/sql/commands'
+require 'rom/sql/commands/transaction'
+
+module ROM
+  module SQL
+    module Commands
+      class Create < ROM::Commands::Create
+        include Transaction
+
+        def execute(tuples)
+          insert_tuples = Array([tuples]).flatten.map do |tuple|
+            attributes = input[tuple]
+            validator.call(attributes)
+            attributes.to_h
+          end
+
+          insert(insert_tuples)
+        rescue *ERRORS => e
+          raise ConstraintError, e.message
+        end
+
+        def insert(tuples)
+          pks = tuples.map { |tuple| relation.insert(tuple) }
+          relation.where(relation.primary_key => pks)
+        end
+      end
+    end
+  end
+end