rom 0.5.0 → 0.6.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39759c82e1343f0fbffc57f13776e3c6c32a8cc9
-  data.tar.gz: 28daebfe7db350be6ac1b591d369274a6d64dea2
+  metadata.gz: 814ed4ee8e88aefe0b86817fb61169b1e35f94ba
+  data.tar.gz: 999033f0c7c9afb931cf8cb18a333026e8b3efae
 SHA512:
-  metadata.gz: 27528eadcc25bd65907de664a36a88a3abd9478873d9f213111c8aa33b32dccb95e22596202459bf43c9e7c093688807f8d218351b17d16defd40af683085720
-  data.tar.gz: 22d152bd43402e7d04d6ac53e80ea8744fb683742fe92710f796e8853e505823d0c3070923137b2e8da75c3271ecbe6c404e90206841dbfac4e3fa675c8ee115
+  metadata.gz: fac52ead0bcbbe6c2404b59b8520facb25374050e8dbf6d98964aab073896fe8dca05f589d91ad34769f169ca284006f14685d2b4808e18571794bf0a8fd635c
+  data.tar.gz: 866166744b5e93f3fca5c623414579814efd7d6765d2cc695af3437e3b233f720e52f403f7f98b9cb288bc548e45e015f6ab3035692a4a05f57e6bdcbc893d69

data/.rubocop.yml

@@ -1,29 +1,24 @@
-# 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: 29
-
-# FIXME: Lower by refactoring biggest offenders
-Metrics/PerceivedComplexity:
-  Max: 8
+# Exclude temporary files
+AllCops:
+  Exclude:
+    - tmp/**/*
 
 # It’s quite readable when we know what we are doing
 Lint/AssignmentInCondition:
   Enabled: false
 
+# No need to handle LoadError in Rakefile
 Lint/HandleExceptions:
   Exclude:
-    - Rakefile
-
-Metrics/ClassLength:
-  Max: 120
+    - rakelib/*.rake
+    - spec/spec_helper.rb
+    - benchmarks/setup.rb
 
 # gemspec is a special snowflake
 Metrics/LineLength:
-  Max: 84
   Exclude:
     - rom.gemspec
 
@@ -79,3 +74,12 @@ Style/StringLiterals:
 # Allow def self.foo; @foo; end
 Style/TrivialAccessors:
   Enabled: false
+
+# Allow compact style for specs
+Style/ClassAndModuleChildren:
+  Exclude:
+    - spec/**/*_spec.rb
+
+# Allow logical `or`/`and` in conditionals
+Style/AndOr:
+  EnforcedStyle: conditionals

data/.rubocop_todo.yml

@@ -0,0 +1,28 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-02-26 16:54:42 +0100 using RuboCop version 0.29.1.
+# 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: 4
+Metrics/AbcSize:
+  Max: 22
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 40
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 88
+
+# Offense count: 15
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 21
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 10

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
+sudo: false
+cache: bundler
 env:
   - CODECLIMATE_REPO_TOKEN=f7c652b65a700fcf1032174afc5ea243b991e48bf73077cc34c148e1c800a2f7
 bundler_args: --without sql benchmarks console tools
-script: "bundle exec rake spec"
+script: "bundle exec rake ci"
 rvm:
   - 2.0
   - 2.1
@@ -10,9 +12,14 @@ rvm:
   - rbx-2
   - jruby
   - ruby-head
+  - jruby-head
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
     - rvm: ruby-head
+    - rvm: jruby-head
 notifications:
   webhooks:
     urls:

data/CHANGELOG.md

@@ -1,3 +1,43 @@
+## v0.6.0 to-be-released
+
+### Added
+
+* It is now possible to define custom relation, mapper and command classes during setup (solnic)
+* New `Env#relation` interface for reading and mapping relations which supports:
+  * `Relation::Lazy` with auto-currying, mapping and composition features (solnic)
+  * `Relation::Composite` allowing data-pipelining with arbitrary objects (solnic)
+  * Passing a block which yields relation with adapter query DSL available (solnic)
+* Relations can be extended with plugins using Options API (solnic)
+* Commands are now composable via `>>` operator (solnic)
+* Mappers support `prefix_separator` option (solnic)
+* Mappers can be registered under custom names (solnic)
+* Relation `dataset` name is inferred from the class name by default (gotar)
+* Relation can be registered under a custom name via `register_as` option (mcls)
+* Adapters can use helper modules for datasets: `ArrayDataset` and `EnumerableDataset` (solnic)
+* Adapter interface can now be tested via a lint test (elskwid + solnic + splattael)
+* `tuple_count` interface in AbstractCommand which can be overridden by adapter (solnic)
+* Custom Inflector API that auto-detects a specific inflection engine (mjtko)
+
+### Changed
+
+* [BREAKING] Command API was simplified - commands should be accessed directly in `.try` block (solnic)
+* [BREAKING] Schema DSL was **removed** - attributes can be specified only in mapper DSL
+  and default repository can be changed when defining a relation (solnic)
+* `.setup` interface requires either an adapter identifier or can accept a repository
+  instance (aflatter)
+* Adapter interface no longer requires specific constructor to be defined (aflatter)
+* Adapters no longer need to handle connection URIs (aflatter)
+* Adapter/Repository has been collapsed to *just* `Repository` (solnic)
+* Relation no longer needs a header object and only operates on an adapters dataset (solnic)
+* Relation no longer uses on Charlatan with method_missing magic (solnic)
+* Adapter's dataset no longer requires header (solnic)
+* Make storage in memory adapter thread-safe #110 (splattael)
+* An Adapter can provide its own Relation subclass with custom behavior (solnic)
+* Relation provides its "public interface" using method_added hook (splattael + solnic)
+* ROM no longer depends on charlatan, concord and inflecto gems (mjtko + solnic)
+
+[Compare v0.5.0...master](https://github.com/rom-rb/rom/compare/v0.5.0...master)
+
 ## v0.5.0 2014-12-31
 
 ### Added

data/Gemfile

@@ -9,6 +9,10 @@ end
 
 group :test do
   gem 'virtus'
+  gem 'minitest'
+  gem 'thread_safe'
+  gem 'activesupport'
+  gem 'inflecto', '~> 0.0', '>= 0.0.2'
 
   platforms :rbx do
     gem 'rubysl-bigdecimal', platforms: :rbx
@@ -35,6 +39,10 @@ group :tools do
   gem 'guard-rspec'
   gem 'guard-rubocop'
 
-  gem 'mutant'
-  gem 'mutant-rspec'
+  gem 'byebug'
+
+  platform :mri do
+    gem 'mutant', '>= 0.7.7'
+    gem 'mutant-rspec'
+  end
 end

data/Guardfile

@@ -1,22 +1,24 @@
 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' }
+  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 supporting files files are modified
-    watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
+    # run all specs if any library code is modified
+    watch(%r{\Alib/.+\.rb\z}) { 'spec' }
 
-    watch(%r{\Alib/(.+)\.rb\z}) { |_m| '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
+    notification :tmux, display_message: true if ENV.key?('TMUX')
   end
 
   guard :rubocop do
-    watch(%r{\Alib/(.+)\.rb\z})
+    # run rubocop on modified file
+    watch(%r{\Alib/.+\.rb\z})
+    watch(%r{\Aspec/.+\.rb\z})
   end
 end

data/README.md

@@ -12,25 +12,23 @@
 [![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]
+[![Inline docs](http://inch-ci.org/github/rom-rb/rom.svg?branch=master&style=flat)][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:
+Ruby Object Mapper (ROM) is an experimental Ruby library with the goal to
+provide powerful object mapping capabilities without limiting the full power of
+your datastore.
 
-  * Querying a database is considered as a private implementation detail
-  * Abstract query interfaces are evil and a source of unnecessary complexity
-  * Reading and mutating data are 2 distinct concerns and should be treated separately
-  * It must be **simple** to use the full power of your database
+Learn more:
 
-With that in mind ROM ships with adapters that allow you to connect to any
-database and exposes a DSL to define **relations**, **mappers** and **commands**
-to simplify accessing and changing the data.
+* [Introduction](http://rom-rb.org/introduction/)
+* [Rails tutorial](http://rom-rb.org/tutorials/rails/)
 
-Database support:
+## Adapters
 
   * [rom-sql](https://github.com/rom-rb/rom-sql)
   * [rom-mongo](https://github.com/rom-rb/rom-mongo)
+  * [rom-yaml](https://github.com/rom-rb/rom-yaml)
+  * [rom-csv](https://github.com/rom-rb/rom-csv)
 
 See [issues](https://github.com/rom-rb/rom/issues?q=is%3Aopen+is%3Aissue+label%3Aadapter+label%3Afeature)
 for a list of adapters that are planned to be added soon.
@@ -41,57 +39,57 @@ Integration with other frameworks is planned.
 ## Synopsis
 
 ``` ruby
-require 'rom-sql'
+ROM.setup(:memory)
 
-setup = ROM.setup(sqlite: "sqlite::memory")
+# This is our domain-specific class
+class User
+  attr_reader :name, :age
 
-setup.sqlite.connection.create_table :users do
-  primary_key :id
-  String :name
-  Integer :age
+  def initialize(attributes)
+    @name, @age = attributes.values_at(:name, :age)
+  end
 end
 
-# set up relations
-
-setup.relation(:users) do
+# Here we define user relation which encapsulates accessing user data that
+# we can map to domain objects
+class Users < ROM::Relation[:memory]
   def by_name(name)
-    where(name: name)
+    restrict(name: name)
   end
 
   def adults
-    where { age >= 18 }
+    restrict { |user| user[:age] >= 18 }
   end
 end
 
-# set up commands
+# Even though mappers can be derived from model definitions here's how you
+# could define it explicitly
+class UserMapper < ROM::Mapper
+  relation :users
 
-setup.commands(:users) do
-  define(:create)
-end
+  model User
 
-# set up mappers
+  attribute :name
+  attribute :age
+end
 
-setup.mappers do
-  define(:users) do
-    model(name: 'User')
-  end
+# You can define specialized commands that handle creating, updating and deleting
+# data, those classes can use external input param handlers and validators too
+class CreateUser < ROM::Commands::Create[:memory]
+  register_as :create
+  relation :users
+  result :one
 end
 
-rom = setup.finalize
+# finalize the setup and retrieve object registry (aka ROM env)
+rom = ROM.finalize.env
 
 # accessing defined commands
-
-rom.command(:users).try { create(name: "Joe", age: 17) }
-rom.command(:users).try { create(name: "Jane", age: 18) }
-
-# accessing registered relations
-users = rom.relations.users
-
-puts users.by_name("Jane").adults.to_a.inspect
-# => [{:id=>2, :name=>"Jane", :age=>18}]
+rom.command(:users).create.call(name: "Joe", age: 17)
+rom.command(:users).create.call(name: "Jane", age: 18)
 
 # reading relations using defined mappers
-puts rom.read(:users).by_name("Jane").adults.to_a.inspect
+puts rom.relation(:users) { |r| r.by_name("Jane").adults }.as(:users).to_a.inspect
 # => [#<User:0x007fdba161cc48 @id=2, @name="Jane", @age=18>]
 ```
 
@@ -102,6 +100,7 @@ for details.
 
 ## Community
 
+* [Official Blog](http://rom-rb.org/blog/)
 * [![Gitter chat](https://badges.gitter.im/rom-rb/chat.png)](https://gitter.im/rom-rb/chat)
 * [Ruby Object Mapper](https://groups.google.com/forum/#!forum/rom-rb) mailing list
 

data/Rakefile

@@ -1,32 +1,22 @@
 require "rspec/core/rake_task"
+require "rake/testtask"
 
 RSpec::Core::RakeTask.new(:spec)
-task default: [:spec]
+task default: [:ci]
 
-begin
-  require "rubocop/rake_task"
-
-  Rake::Task[:default].enhance [:rubocop]
-
-  RuboCop::RakeTask.new do |task|
-    task.options << "--display-cop-names"
+desc 'Run specs in isolation'
+task :"spec:isolation" do
+  FileList["spec/**/*_spec.rb"].each do |spec|
+    sh "rspec", spec
   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(' ')
+desc "Run CI tasks"
+task ci: [:spec, :lint, :"spec:isolation"]
 
-    exec("bundle exec mutant #{opts} #{subject}")
-  end
+Rake::TestTask.new(:lint) do |test|
+  test.description = "Run adapter lint tests against memory adapter"
+  test.test_files = FileList.new('spec/test/*_test.rb')
+  test.libs << 'test'
+  test.verbose = true
 end

data/lib/rom.rb

@@ -1,45 +1,37 @@
-require 'concord'
-require 'charlatan'
-require 'inflecto'
+require 'equalizer'
 
 require 'rom/version'
+require 'rom/constants'
+
+# internal ROM support lib
+require 'rom/support/inflector'
 require 'rom/support/registry'
+require 'rom/support/options'
+require 'rom/support/class_macros'
+require 'rom/support/class_builder'
 
-require 'rom/header'
+# core parts
 require 'rom/relation'
 require 'rom/mapper'
 require 'rom/reader'
+require 'rom/command'
 
+# default mapper processor using Transproc gem
 require 'rom/processor/transproc'
 
-require 'rom/commands'
+# support for global-style setup
+require 'rom/global'
+require 'rom/setup'
 
-require 'rom/adapter'
-require 'rom/repository'
+# TODO: consider to make this part optional and don't require it here
+require 'rom/setup_dsl/setup'
 
-require 'rom/config'
+# env with registries
 require 'rom/env'
 
-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)
-      super("#{option} should be one of #{valid_values.inspect}")
-    end
-  end
-
-  Schema = Class.new(Registry)
+  extend Global
+
   RelationRegistry = Class.new(Registry)
   ReaderRegistry = Class.new(Registry)
-
-  EMPTY_HASH = {}.freeze
-
-  extend Global
 end