rom 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85a6e3c77b6e9a8d724fdd73056c4bdde3730beb
-  data.tar.gz: 6f964fb1181920ab5222f66d3482cf9ebcddf810
+  metadata.gz: 39759c82e1343f0fbffc57f13776e3c6c32a8cc9
+  data.tar.gz: 28daebfe7db350be6ac1b591d369274a6d64dea2
 SHA512:
-  metadata.gz: 31e1ff16669d9481ba1d516f27d9016054ef35c1ac2daa3dad5de8792ef9bd30813b7de01f48132726574f52edb7a1b2a374245602932683b02a473e1c577e93
-  data.tar.gz: 62698c8268af71829168e3c8b27edac7553cc7e03b7c6362b485585e9404e10bd9bb1438f68cf3be9f8122c7d8670ac280e4867345f9f5a1d8aa6759e5e2d265
+  metadata.gz: 27528eadcc25bd65907de664a36a88a3abd9478873d9f213111c8aa33b32dccb95e22596202459bf43c9e7c093688807f8d218351b17d16defd40af683085720
+  data.tar.gz: 22d152bd43402e7d04d6ac53e80ea8744fb683742fe92710f796e8853e505823d0c3070923137b2e8da75c3271ecbe6c404e90206841dbfac4e3fa675c8ee115

data/.rubocop.yml

@@ -0,0 +1,81 @@
+# FIXME: Lower by refactoring biggest offenders
+Metrics/AbcSize:
+  Max: 27
+
+# FIXME: Lower by refactoring biggest offenders
+Metrics/MethodLength:
+  Max: 29
+
+# FIXME: Lower by refactoring biggest offenders
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# It’s quite readable when we know what we are doing
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Exclude:
+    - Rakefile
+
+Metrics/ClassLength:
+  Max: 120
+
+# gemspec is a special snowflake
+Metrics/LineLength:
+  Max: 84
+  Exclude:
+    - 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
+
+# Early returns have their vices
+Style/GuardClause:
+  Enabled: false
+
+# 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

data/.travis.yml

@@ -1,11 +1,12 @@
 language: ruby
 env:
   - CODECLIMATE_REPO_TOKEN=f7c652b65a700fcf1032174afc5ea243b991e48bf73077cc34c148e1c800a2f7
-bundler_args: --without sql benchmarks console
+bundler_args: --without sql benchmarks console tools
 script: "bundle exec rake spec"
 rvm:
   - 2.0
   - 2.1
+  - 2.2
   - rbx-2
   - jruby
   - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+## v0.5.0 2014-12-31
+
+### Added
+
+* Mapper DSL supports `embedded` interface for nested tuples (solnic)
+* Support for nested `group` mapping (solnic)
+* Support for nested `wrap` mapping (solnic)
+* Support for primitive type coercions (:to_string, :to_integer etc.) (solnic)
+* Support for top-level `:prefix` option in mapping DSL (solnic)
+* Support for top-level `:symbolize_keys` option in mapping DSL (solnic)
+* Support for `:prefix` option in wrap/group mapping DSL (solnic)
+* Interface for registering data mapping processors (solnic)
+* Remaining relations are automatically setup from the schema (solnic)
+* Each relation has now access to other relations (previously they only had
+  access to raw datasets) (solnic)
+* `ROM.setup` supports passing in *just an uri* which will setup a default repository (solnic)
+* `ROM.setup` supports passing in conventional database connection hash (solnic)
+* Adapters support extra options in addition to the base connection URI (solnic)
+
+### Changed
+
+* Mapping backend replaced by integration with transproc (solnic)
+* Readers no longer expose adapter query DSL (solnic)
+* Registry objects raise `ROM::Registry::ElementNotFoundError` when missing
+  element is referenced (rather than raw KeyError) (solnic)
+* Performance improvements in Reader (solnic)
+* `ROM::RA` was merged into in-memory adapter as this fits there perfectly (solnic)
+* It is no longer needed to explicitly execute a delete command in try block (solnic)
+
+### Fixed
+
+* Wrap/group skips empty tuples now (solnic)
+* Readers raise a meaningful error when relation is missing (solnic)
+
+## Internal
+
+* Massive code clean-up and rubocop integration (chastell)
+* Refactored `Reader` and mapper-specific logic into `MapperRegistry` (solnic)
+
+[Compare v0.4.2...v0.5.0](https://github.com/rom-rb/rom/compare/v0.4.2...v0.5.0)
+
 ## v0.4.2 2014-12-19
 
 ### Added

data/Gemfile

@@ -9,18 +9,11 @@ end
 
 group :test do
   gem 'virtus'
-  gem 'guard'
-  gem 'guard-rspec'
 
   platforms :rbx do
     gem 'rubysl-bigdecimal', platforms: :rbx
     gem 'codeclimate-test-reporter', require: false
   end
-
-  platforms :mri do
-    gem 'mutant'
-    gem 'mutant-rspec'
-  end
 end
 
 group :sql do
@@ -31,6 +24,17 @@ group :sql do
 end
 
 group :benchmarks do
-  gem 'activerecord', '4.2.0.rc3'
+  gem 'activerecord', '4.2.0'
   gem 'benchmark-ips'
 end
+
+group :tools do
+  gem 'rubocop'
+
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+
+  gem 'mutant'
+  gem 'mutant-rspec'
+end

data/Guardfile

@@ -1,16 +1,22 @@
-guard :rspec, cmd: "rspec" do
-  #run all specs if configuration is modified
-  watch('Guardfile')           { 'spec' }
-  watch('Gemfile.lock')        { 'spec' }
-  watch('spec/spec_helper.rb') { 'spec' }
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "rspec" do
+    # run all specs if configuration is modified
+    watch('Guardfile')           { 'spec' }
+    watch('Gemfile.lock')        { 'spec' }
+    watch('spec/spec_helper.rb') { 'spec' }
 
-  # run all specs if supporting files files are modified
-  watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
+    # run all specs if supporting files files are modified
+    watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
 
-  watch(%r{\Alib/(.+)\.rb\z}) { |m| 'spec' }
+    watch(%r{\Alib/(.+)\.rb\z}) { |_m| 'spec' }
 
-  # run a spec if it is modified
-  watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
+    # run a spec if it is modified
+    watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
 
-  notification :tmux, :display_message => true
+    notification :tmux, display_message: true
+  end
+
+  guard :rubocop do
+    watch(%r{\Alib/(.+)\.rb\z})
+  end
 end

data/README.md

@@ -1,10 +1,3 @@
-[![Gem Version](https://badge.fury.io/rb/rom.svg)][gem]
-[![Build Status](https://travis-ci.org/rom-rb/rom.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/rom-rb/rom.png)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/rom-rb/rom/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/rom-rb/rom/badges/coverage.svg)][codeclimate]
-[![Inline docs](http://inch-ci.org/github/rom-rb/rom.svg?branch=master)][inchpages]
-
 [gem]: https://rubygems.org/gems/rom
 [travis]: https://travis-ci.org/rom-rb/rom
 [gemnasium]: https://gemnasium.com/rom-rb/rom
@@ -14,6 +7,13 @@
 
 # Ruby Object Mapper
 
+[![Gem Version](https://badge.fury.io/rb/rom.svg)][gem]
+[![Build Status](https://travis-ci.org/rom-rb/rom.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/rom-rb/rom/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/rom-rb/rom/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/rom-rb/rom.svg?branch=master)][inchpages]
+
 ROM is an experimental Ruby ORM that aims to bring powerful object mapping
 capabilities and give you back the full power of your database. It is based on
 a couple of core concepts which makes it different from a typical ORM:

data/Rakefile

@@ -1,3 +1,32 @@
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+task default: [:spec]
+
+begin
+  require "rubocop/rake_task"
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << "--display-cop-names"
+  end
+rescue LoadError
+end
+
+desc "Run mutant against a specific subject"
+task :mutant do
+  subject = ARGV.last
+  if subject == 'mutant'
+    abort "usage: rake mutant SUBJECT\nexample: rake mutant ROM::Header"
+  else
+    opts = {
+      'include' => 'lib',
+      'require' => 'rom',
+      'use' => 'rspec',
+      'ignore-subject' => "#{subject}#respond_to_missing?"
+    }.to_a.map { |k, v| "--#{k} #{v}" }.join(' ')
+
+    exec("bundle exec mutant #{opts} #{subject}")
+  end
+end

data/lib/rom.rb

@@ -7,24 +7,27 @@ require 'rom/support/registry'
 
 require 'rom/header'
 require 'rom/relation'
-require 'rom/transformer'
 require 'rom/mapper'
 require 'rom/reader'
 
+require 'rom/processor/transproc'
+
 require 'rom/commands'
 
 require 'rom/adapter'
 require 'rom/repository'
-require 'rom/env'
 
-require 'rom/ra'
+require 'rom/config'
+require 'rom/env'
 
-require 'rom/boot'
+require 'rom/global'
+require 'rom/setup'
 
 module ROM
   EnvAlreadyFinalizedError = Class.new(StandardError)
   CommandError = Class.new(StandardError)
   TupleCountMismatchError = Class.new(CommandError)
+  NoRelationError = Class.new(StandardError)
 
   InvalidOptionError = Class.new(StandardError) do
     def initialize(option, valid_values)
@@ -36,67 +39,7 @@ module ROM
   RelationRegistry = Class.new(Registry)
   ReaderRegistry = Class.new(Registry)
 
-  # Starts the setup process for schema, relations and mappers
-  #
-  # @param [Hash] options repository URIs
-  #
-  # @return [Boot] boot object
-  #
-  # @api public
-  def self.setup(options, &block)
-    adapters = options.each_with_object({}) do |(name, uri), hash|
-      hash[name] = Adapter.setup(uri)
-    end
-
-    repositories = adapters.each_with_object({}) do |(name, adapter), hash|
-      hash[name] = Repository.new(adapter)
-    end
-
-    boot = Boot.new(repositories)
-
-    if block
-      boot.instance_exec(&block)
-      boot.finalize
-    else
-      @boot = boot
-    end
-  end
-
-  # @api public
-  def self.schema(&block)
-    boot.schema(&block)
-  end
-
-  # @api public
-  def self.relation(*args, &block)
-    boot.relation(*args, &block)
-  end
-
-  # @api public
-  def self.commands(*args, &block)
-    boot.commands(*args, &block)
-  end
-
-  # @api public
-  def self.mappers(*args, &block)
-    boot.mappers(*args, &block)
-  end
-
-  # @api public
-  def self.env
-    @env
-  end
-
-  # @api public
-  def self.finalize
-    @env = boot.finalize
-    @boot = nil
-    self
-  end
-
-  # @api private
-  def self.boot
-    @boot
-  end
+  EMPTY_HASH = {}.freeze
 
+  extend Global
 end

data/lib/rom/adapter.rb

@@ -1,15 +1,12 @@
 require 'addressable/uri'
 
 module ROM
-
   # Abstract adapter class
   #
   # @api public
   class Adapter
     include Equalizer.new(:connection)
 
-    @adapters = []
-
     # Return connection URI associated with the adapter
     #
     # @return [String]
@@ -24,6 +21,23 @@ module ROM
     # @api public
     attr_reader :connection
 
+    # Additional options hash
+    #
+    # @return [Hash]
+    #
+    # @api public
+    attr_reader :options
+
+    # @api private
+    def self.inherited(adapter)
+      Adapter.adapters.unshift(adapter)
+    end
+
+    # @api private
+    def self.adapters
+      @_adapters ||= []
+    end
+
     # Setup an adapter instance with the given connection URI
     #
     # @example
@@ -41,14 +55,15 @@ module ROM
     # @return [Adapter]
     #
     # @api public
-    def self.setup(uri_string)
+    def self.setup(uri_string, options = {})
       uri = Addressable::URI.parse(uri_string)
+      adapter = self[uri.scheme]
 
-      unless adapter = self[uri.scheme]
+      unless adapter
         raise ArgumentError, "#{uri_string.inspect} uri is not supported"
       end
 
-      adapter.new(uri)
+      adapter.new(uri, options)
     end
 
     # Register adapter class
@@ -67,8 +82,8 @@ module ROM
     # @return [Array] registered adapters
     #
     # @api public
-    def self.register(adapter)
-      @adapters.unshift adapter
+    def self.register(_adapter)
+      warn "Adapter.register is no longer needed [#{caller[0]}"
     end
 
     # Return adapter class for the given scheme
@@ -79,12 +94,25 @@ module ROM
     #
     # @api public
     def self.[](scheme)
-      @adapters.detect { |adapter| adapter.schemes.include?(scheme.to_sym) }
+      adapters.detect { |adapter| adapter.schemes.include?(scheme.to_sym) }
     end
 
+    # Hook for adapters to normalize scheme name
+    #
     # @api private
-    def initialize(uri)
+    def self.normalize_scheme(scheme)
+      scheme
+    end
+
+    # @api private
+    def self.database_file?(_scheme)
+      false
+    end
+
+    # @api private
+    def initialize(uri, options = {})
       @uri = uri
+      @options = options
     end
 
     # Extension hook for adding adapter-specific behavior to a relation class
@@ -144,6 +172,13 @@ module ROM
       []
     end
 
+    # Disconnect is optional and it's a no-op by default
+    #
+    # @api public
+    def disconnect
+      # noop
+    end
+
     # Return namespace with adapter-specific command classes
     #
     # @return [Module]
@@ -152,7 +187,5 @@ module ROM
     def command_namespace
       self.class.const_get(:Commands)
     end
-
   end
-
 end