rom 0.1.2 → 0.2.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+bundler_args: --without yard guard benchmarks
+script: "bundle exec rake metrics:coverage"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - rbx
+  - 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

data/Changelog.md

@@ -1,3 +1,19 @@
+# v0.2.0 2014-04-06
+
+* [BREAKING] rom-relation, rom-mapper and rom-session were merged into rom project (solnic)
+* [BREAKING] changed mapping DSL (users do...end => relation(:users) do...end) (solnic)
+* [BREAKING] added :from option to mapping DSL which replaced :to (solnic)
+* [feature] added :rename option to schema attribute DSL (solnic)
+* [feature] added support for join, group, wrap, project and rename operations (solnic)
+* [feature] added support for setting domain object loading strategy (solnic)
+* [feature] Environment.setup can be used with a block to define schema and mapping (solnic)
+* [feature] added public interface for building mappers (see Mapper.build) (solnic)
+* [feature] added support for mapping embedded objects using wrap/group (solnic)
+* [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)
+
 # 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)

data/Gemfile

@@ -1,12 +1,19 @@
 source 'https://rubygems.org'
 
-gem 'rom', :path => '.'
+gemspec
 
-gem 'rom-relation', :git => 'https://github.com/rom-rb/rom-relation.git'
-gem 'rom-mapper',   :git => 'https://github.com/rom-rb/rom-mapper.git'
-gem 'rom-session',  :git => 'https://github.com/rom-rb/rom-session.git'
+group :test do
+  gem 'axiom-memory-adapter', '~> 0.2'
+  gem 'bogus', '~> 0.1'
+  gem 'rubysl-bigdecimal', :platforms => :rbx
+end
 
 group :benchmarks do
-  gem 'faker'
-  gem 'axiom-memory-adapter'
+  gem 'perftools.rb'
 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'

data/Gemfile.devtools

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',       '~> 10.2.1'
+  gem 'rspec',      '~> 2.14.1'
+  gem 'rspec-core', '~> 2.14.8'
+  gem 'yard',       '~> 0.8.7.4'
+
+  platform :rbx do
+    gem 'rubysl-singleton', '~> 2.0.0'
+  end
+end
+
+group :yard do
+  gem 'kramdown', '~> 1.3.3'
+end
+
+group :guard do
+  gem 'guard',         '~> 2.6.0'
+  gem 'guard-bundler', '~> 2.0.0'
+  gem 'guard-rspec',   '~> 4.2.8'
+  gem 'guard-rubocop', '~> 1.0.2'
+
+  # file system change event handling
+  gem 'listen',     '~> 2.7.1'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.4', require: false
+  gem 'rb-inotify', '~> 0.9.3', require: false
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.2', 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 'reek',      '~> 1.3.7'
+  gem 'rubocop',   '~> 0.19.1'
+  gem 'simplecov', '~> 0.8.2'
+  gem 'yardstick', '~> 0.9.9'
+
+  platforms :mri do
+    gem 'mutant',       '~> 0.5.9'
+    gem 'mutant-rspec', '~> 0.5.3'
+  end
+
+  platforms :ruby_19, :ruby_20 do
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platform :rbx do
+    gem 'json',               '~> 1.8.1'
+    gem 'racc',               '~> 1.4.11'
+    gem 'rubysl-logger',      '~> 2.0.0'
+    gem 'rubysl-open-uri',    '~> 2.0.0'
+    gem 'rubysl-prettyprint', '~> 2.0.3'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.5'
+  end
+end

data/Guardfile

@@ -0,0 +1,19 @@
+guard :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 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'                               }
+
+  # run a spec if it is modified
+  watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
+
+  notification :tmux, :display_message => true
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Ruby Object Mapper Team
+Copyright (c) 2013-2014 Ruby Object Mapper Team
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,35 +1,38 @@
 # Ruby Object Mapper
 
-This is a meta-project grouping pieces of ROM's default stack:
-
-* [rom-relation](https://github.com/rom-rb/rom-relation)
-* [rom-mapper](https://github.com/rom-rb/rom-mapper)
-* [rom-session](https://github.com/rom-rb/rom-session)
+[![Gem Version](https://badge.fury.io/rb/rom.png)][gem]
+[![Build Status](https://travis-ci.org/rom-rb/rom.png?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]
+
+[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/
+
+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).
 
 ## Getting started
 
-### 1. Set up environment and define schema
-
-```ruby
-  require 'rom'
-
-  env = ROM::Environment.setup(memory: 'memory://test')
+Currently the setup is a bit verbose. Automatization will come in the future once
+the API becomes stable.
 
-  env.schema do
-    base_relation :users do
-      repository :memory
-
-      attribute :id,   Integer
-      attribute :name, String
-
-      key :id
-    end
-  end
+```
+gem install rom axiom-memory-adapter
 ```
 
-### 2. Set up mapping
+### 1. Set up environment and define schema with mappings
 
 ```ruby
+  require 'rom'
+  require 'axiom-memory-adapter'
+
   class User
     attr_reader :id, :name
 
@@ -38,25 +41,44 @@ This is a meta-project grouping pieces of ROM's default stack:
     end
   end
 
-  env.mapping do
-    users do
-      map :id, :name
-      model User
+  env = ROM::Environment.setup(memory: 'memory://test') do
+    schema do
+      base_relation :users do
+        repository :memory
+
+        attribute :id,   Integer
+        attribute :name, String
+
+        key :id
+      end
+    end
+
+    mapping do
+      relation(:users) do
+        map :id, :name
+        model User
+      end
     end
   end
 ```
 
-### 3. Work with Plain Old Ruby Objects
+### 2. Work with Plain Old Ruby Objects
 
 ```ruby
   env.session do |session|
-    session[:users].save(User.new(id: 1, name: 'Jane'))
-    session.commit
+    user = session[:users].new(id: 1, name: 'Jane')
+    session[:users].save(user)
+    session.flush
   end
 
   jane = env[:users].restrict(name: 'Jane').one
 ```
 
+## Community
+
+* #rom-rb channel on freenode
+* [Ruby Object Mapper](https://groups.google.com/forum/#!forum/rom-rb) mailing list
+
 ## Authors
 
 * [Dan Kubb](https://github.com/dkubb)
@@ -64,6 +86,6 @@ This is a meta-project grouping pieces of ROM's default stack:
 * [Martin Gamsjaeger](https://github.com/snusnu)
 * [Piotr Solnica](https://github.com/solnic)
 
-## Licence
+## License
 
 See `LICENSE` file.

data/Rakefile

@@ -0,0 +1,3 @@
+# Added by devtools
+require 'devtools'
+Devtools.init_rake_tasks

data/config/devtools.yml

@@ -0,0 +1,4 @@
+---
+unit_test_timeout: 0.1
+fail_on_branch:
+- "master"

data/config/flay.yml

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

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 0

data/config/mutant.yml

@@ -0,0 +1,5 @@
+---
+name: rom
+namespace:
+  - ROM::Relation
+  - ROM::Mapper

data/config/reek.yml

@@ -0,0 +1,103 @@
+---
+Attribute:
+  enabled: true
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 2
+  overrides:
+    initialize:
+      max_params: 3
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 2
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 3
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 10
+TooManyStatements:
+  enabled: true
+  exclude:
+  - each
+  max_statements: 2
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 0

data/config/rubocop.yml

@@ -0,0 +1,62 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.devtools'
+  Excludes:
+    - '**/vendor/**'
+    - '**/benchmarks/**'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessModifierIndentation:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Max: 79
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false
+
+# Allow empty lines around body
+EmptyLinesAroundBody:
+  Enabled: false