rom 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 721bf4200ba43797d78160490085ab5f545c4845
+  data.tar.gz: b0931e08715301413a9f21ab95694dee5a1d1074
+SHA512:
+  metadata.gz: 829fd23000ae2dc4f88a05462285f34e47ce2aa288c14d93bd86385bc5ea8d4c281cfd579690f802911b644c49fc756a0fa37428a5429c8ce1427733c7dbbe51
+  data.tar.gz: 6a4513c5fe5f436ada0045ce4a9b7933d5c2a6f6f58a546d013ec8f7e5dc9719dace3cfdb89b75fbc8769f22cb9fd988225eaae1f080d6e2c6cd94718dcc4782

data/.gitignore

@@ -13,11 +13,11 @@ test/version_tmp
 tmp
 Gemfile.lock
 
+.idea/
+
 # YARD artifacts
 .yardoc
 _yardoc
 doc/
 
-rom-relation
-rom-mapper
-rom-session
+Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-1.9.3
+2.1.5

data/.travis.yml

@@ -1,22 +1,21 @@
 language: ruby
-bundler_args: --without yard guard benchmarks
-script: "bundle exec rake metrics:coverage"
+env:
+  - CODECLIMATE_REPO_TOKEN=f7c652b65a700fcf1032174afc5ea243b991e48bf73077cc34c148e1c800a2f7
+bundler_args: --without sql benchmarks
+script: "bundle exec rake spec"
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-  - rbx
+  - 2.0
+  - 2.1
+  - rbx-2
   - jruby
   - ruby-head
 matrix:
   allow_failures:
     - rvm: ruby-head
 notifications:
-  irc:
-    channels:
-      - "irc.freenode.org#rom-rb"
-    on_success: never
-    on_failure: change
-  email:
-    on_success: never
-    on_failure: change
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/39e1225f489f38b0bd09
+    on_success: change
+    on_failure: always
+    on_start: false

data/{Changelog.md → CHANGELOG.md}

@@ -1,3 +1,10 @@
+# v0.3.0 2014-11-24
+
+This version is a rewrite that introduces a new, simplified architecture based
+on a new adapter interface.
+
+[Compare v0.2.0...v0.3.0](https://github.com/rom-rb/rom/compare/v0.2.0...v0.3.0)
+
 # v0.2.0 2014-04-06
 
 * [BREAKING] rom-relation, rom-mapper and rom-session were merged into rom project (solnic)
@@ -12,20 +19,22 @@
 * [feature] environment exposes mapper registry via Environment#mappers (solnic)
 * [internal] mappers are now backed by [morpher](https://github.com/mbj/morpher) (solnic)
 * [internal] renaming and optimizing relations happens on the schema level now (solnic)
-* [internal] environment will raise if unknown relation is referenced via Environment#[] (solnic)
+* [internal] environment will raise if unknown relation is referenced via `Environment#[]` (solnic)
+
+[Compare v0.1.2...v0.2.0](https://github.com/rom-rb/rom/compare/v0.1.2...v0.2.0)
 
 # v0.1.2 2013-09-02
 
 * [updated] [rom-relation](https://github.com/rom-rb/rom-relation/blob/v0.1.2/Changelog.md#v012-2013-09-02)
 
-[Compare v0.1.1..v0.1.2](https://github.com/rom-rb/rom/compare/v0.1.1...v0.1.2)
+[Compare v0.1.1...v0.1.2](https://github.com/rom-rb/rom/compare/v0.1.1...v0.1.2)
 
 # v0.1.1 2013-08-30
 
 * [updated] [rom-relation](https://github.com/rom-rb/rom-relation/blob/v0.1.1/Changelog.md#v011-2013-08-30)
 * [updated] [rom-session](https://github.com/rom-rb/rom-session/blob/v0.1.1/Changelog.md#v011-2013-08-30)
 
-[Compare v0.1.0..v0.1.1](https://github.com/rom-rb/rom/compare/v0.1.0...v0.1.1)
+[Compare v0.1.0...v0.1.1](https://github.com/rom-rb/rom/compare/v0.1.0...v0.1.1)
 
 # v0.1.0 2013-08-23
 

data/Gemfile

@@ -3,17 +3,21 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'axiom-memory-adapter', '~> 0.2'
-  gem 'bogus', '~> 0.1'
-  gem 'rubysl-bigdecimal', :platforms => :rbx
+  gem 'mutant'
+  gem 'mutant-rspec'
+  gem 'rubysl-bigdecimal', platforms: :rbx
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'codeclimate-test-reporter', require: false
 end
 
-group :benchmarks do
-  gem 'perftools.rb'
+group :sql do
+  gem 'rom-sql', git: 'https://github.com/rom-rb/rom-sql.git', branch: 'master'
+  gem 'jdbc-sqlite3', platforms: :jruby
+  gem 'sqlite3', platforms: [:mri, :rbx]
 end
 
-gem 'devtools', git: 'https://github.com/rom-rb/devtools.git', branch: 'master'
-gem 'morpher', git: 'https://github.com/mbj/morpher.git', branch: 'master'
-
-# Added by devtools
-eval_gemfile 'Gemfile.devtools'
+group :benchmarks do
+  gem 'activerecord'
+  gem 'benchmark-ips'
+end

data/Gemfile.devtools

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
 group :development do
-  gem 'rake',       '~> 10.2.1'
-  gem 'rspec',      '~> 2.14.1'
-  gem 'rspec-core', '~> 2.14.8'
+  gem 'rake',       '~> 10.3.2'
+  gem 'rspec',      '~> 3.1.0'
+  gem 'rspec-its',  '~> 1.0.1'
   gem 'yard',       '~> 0.8.7.4'
 
   platform :rbx do
@@ -16,35 +16,35 @@ group :yard do
 end
 
 group :guard do
-  gem 'guard',         '~> 2.6.0'
+  gem 'guard',         '~> 2.6.1'
   gem 'guard-bundler', '~> 2.0.0'
-  gem 'guard-rspec',   '~> 4.2.8'
-  gem 'guard-rubocop', '~> 1.0.2'
+  gem 'guard-rspec',   '~> 4.2.9'
+  gem 'guard-rubocop', '~> 1.1.0'
 
   # file system change event handling
-  gem 'listen',     '~> 2.7.1'
+  gem 'listen',     '~> 2.7.7'
   gem 'rb-fchange', '~> 0.0.6', require: false
   gem 'rb-fsevent', '~> 0.9.4', require: false
-  gem 'rb-inotify', '~> 0.9.3', require: false
+  gem 'rb-inotify', '~> 0.9.5', require: false
 
   # notification handling
-  gem 'libnotify',               '~> 0.8.2', require: false
+  gem 'libnotify',               '~> 0.8.3', require: false
   gem 'rb-notifu',               '~> 0.0.4', require: false
   gem 'terminal-notifier-guard', '~> 1.5.3', require: false
 end
 
 group :metrics do
   gem 'coveralls', '~> 0.7.0'
-  gem 'flay',      '~> 2.4.0'
-  gem 'flog',      '~> 4.2.0'
+  gem 'flay',      '~> 2.5.0'
+  gem 'flog',      '~> 4.2.1'
   gem 'reek',      '~> 1.3.7'
-  gem 'rubocop',   '~> 0.19.1'
-  gem 'simplecov', '~> 0.8.2'
+  gem 'rubocop',   '~> 0.23.0'
+  gem 'simplecov', '~> 0.7.1'
   gem 'yardstick', '~> 0.9.9'
 
   platforms :mri do
-    gem 'mutant',       '~> 0.5.9'
-    gem 'mutant-rspec', '~> 0.5.3'
+    gem 'mutant',       '~> 0.6.3'
+    gem 'mutant-rspec', '~> 0.6.3'
   end
 
   platforms :ruby_19, :ruby_20 do
@@ -66,6 +66,6 @@ end
 
 platform :jruby do
   group :jruby do
-    gem 'jruby-openssl', '~> 0.8.5'
+    gem 'jruby-openssl', '~> 0.9.4'
   end
 end

data/Guardfile

@@ -1,4 +1,4 @@
-guard :rspec do
+guard :rspec, cmd: "rspec" do
   #run all specs if configuration is modified
   watch('Guardfile')           { 'spec' }
   watch('Gemfile.lock')        { 'spec' }
@@ -7,10 +7,7 @@ guard :rspec do
   # run all specs if supporting files files are modified
   watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
 
-  # run unit specs if associated lib code is modified
-  watch(%r{\Alib/(.+)\.rb\z})                                         { |m| Dir["spec/unit/#{m[1]}"]         }
-  watch(%r{\Alib/(.+)/support/(.+)\.rb\z})                            { |m| Dir["spec/unit/#{m[1]}/#{m[2]}"] }
-  watch("lib/#{File.basename(File.expand_path('../', __FILE__))}.rb") { 'spec'                               }
+  watch(%r{\Alib/(.+)\.rb\z}) { |m| 'spec' }
 
   # run a spec if it is modified
   watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})

data/README.md

@@ -1,90 +1,102 @@
-# Ruby Object Mapper
-
-[![Gem Version](https://badge.fury.io/rb/rom.png)][gem]
-[![Build Status](https://travis-ci.org/rom-rb/rom.png?branch=master)][travis]
+[![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.png)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/rom-rb/rom/badge.png?branch=master)][coveralls]
-[![Inline docs](http://inch-pages.github.io/github/rom-rb/rom.png)][inchpages]
+[![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
 [codeclimate]: https://codeclimate.com/github/rom-rb/rom
 [coveralls]: https://coveralls.io/r/rom-rb/rom
-[inchpages]: http://inch-pages.github.io/github/rom-rb/rom/
+[inchpages]: http://inch-ci.org/github/rom-rb/rom/
 
-Ruby Object Mapper is an implementation of [the Data Mapper](http://martinfowler.com/eaaCatalog/dataMapper.html)
-pattern in Ruby language. It consists of multiple loosely coupled pieces and uses
-a powerful relational algebra library called [axiom](https://github.com/dkubb/axiom).
+# Ruby Object Mapper
 
-## Getting started
+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:
 
-Currently the setup is a bit verbose. Automatization will come in the future once
-the API becomes stable.
+  * Quering 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
 
-```
-gem install rom axiom-memory-adapter
-```
+With that in mind ROM ships with adapters that allow you to connect to any
+database and exposes a DSL to define **relations** and **mappers** to simplify
+accessing the data.
 
-### 1. Set up environment and define schema with mappings
+Database support:
 
-```ruby
-  require 'rom'
-  require 'axiom-memory-adapter'
+  * [rom-sql](https://github.com/rom-rb/rom-sql)
+  * [rom-mongo](https://github.com/rom-rb/rom-mongo)
 
-  class User
-    attr_reader :id, :name
+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.
 
-    def initialize(attributes)
-      @id, @name = attributes.values_at(:id, :name)
-    end
-  end
+## Synopsis
 
-  env = ROM::Environment.setup(memory: 'memory://test') do
-    schema do
-      base_relation :users do
-        repository :memory
+``` ruby
+require 'rom-sql'
 
-        attribute :id,   Integer
-        attribute :name, String
+setup = ROM.setup(sqlite: "sqlite::memory")
 
-        key :id
-      end
-    end
+setup.sqlite.connection.create_table :users do
+  primary_key :id
+  String :name
+  Integer :age
+end
 
-    mapping do
-      relation(:users) do
-        map :id, :name
-        model User
-      end
-    end
+setup.relation(:users) do
+  def by_name(name)
+    where(name: name)
   end
-```
 
-### 2. Work with Plain Old Ruby Objects
+  def adults
+    where { age >= 18 }
+  end
+end
 
-```ruby
-  env.session do |session|
-    user = session[:users].new(id: 1, name: 'Jane')
-    session[:users].save(user)
-    session.flush
+setup.mappers do
+  define(:users) do
+    model(name: 'User')
   end
+end
 
-  jane = env[:users].restrict(name: 'Jane').one
+rom = setup.finalize
+
+# accessing registered relations
+users = rom.relations.users
+
+users.insert(name: "Joe", age: 17)
+users.insert(name: "Jane", age: 18)
+
+puts users.by_name("Jane").adults.to_a.inspect
+# => [{:id=>2, :name=>"Jane", :age=>18}]
+
+# reading relations using defined mappers
+puts rom.read(:users).by_name("Jane").adults.to_a.inspect
+# => [#<User:0x007fdba161cc48 @id=2, @name="Jane", @age=18>]
 ```
 
+## ROADMAP
+
+ROM is on its way towards 1.0.0. Please refer to [issues](https://github.com/rom-rb/rom/issues)
+for details.
+
 ## Community
 
-* #rom-rb channel on freenode
+* [![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
 
-## Authors
+## Credits
+
+This project has a long history and wouldn't exist without following people:
 
-* [Dan Kubb](https://github.com/dkubb)
-* [Markus Schirp](https://github.com/mbj)
-* [Martin Gamsjaeger](https://github.com/snusnu)
-* [Piotr Solnica](https://github.com/solnic)
+ * [Dan Kubb](https://github.com/dkubb)
+ * [Markus Schirp](https://github.com/mbj)
+ * [Martin Gamsjaeger](https://github.com/snusnu)
 
 ## License
 

data/Rakefile

@@ -1,3 +1,3 @@
-# Added by devtools
-require 'devtools'
-Devtools.init_rake_tasks
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 18
-total_score: 310
+threshold: 0
+total_score: 0

data/config/mutant.yml

@@ -1,5 +1,3 @@
 ---
-name: rom
-namespace:
-  - ROM::Relation
-  - ROM::Mapper
+name: your_lib
+namespace: YourLib

data/config/rubocop.yml

@@ -12,6 +12,11 @@ ParameterLists:
   Max: 3
   CountKeywordArgs: true
 
+# Limit method length
+MethodLength:
+  CountComments: false
+  Max: 10
+
 # Avoid more than `Max` levels of nesting.
 BlockNesting:
   Max: 3
@@ -41,6 +46,10 @@ LineLength:
 Documentation:
   Enabled: false
 
+# Do not always use &&/|| instead of and/or.
+AndOr:
+  Enabled: false
+
 # Do not favor modifier if/unless usage when you have a single-line body
 IfUnlessModifier:
   Enabled: false
@@ -57,6 +66,27 @@ ConstantName:
 TrivialAccessors:
   Enabled: false
 
+# Do not prefer do/end over {} for multiline blocks
+Blocks:
+  Enabled: false
+
 # Allow empty lines around body
 EmptyLinesAroundBody:
   Enabled: false
+
+# Prefer String#% over Kernel#sprintf
+FormatString:
+  Enabled: false
+
+# Use square brackets for literal Array objects
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': '[]'
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()