rom-relation 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+log
+*.rbx
+*.rbc
+Gemfile.lock
+tmp/
+doc/
+coverage/
+measurements/
+graphviz/
+.yardoc/
+.bundle/
+*.png
+Vagrantfile
+.vagrant
+
+# spiking area
+scratchpad.rb

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--profile
+--order random

data/.ruby-gemset

@@ -0,0 +1 @@
+rom

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+bundler_args: --without yard guard benchmarks
+script: "bundle exec rake ci"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - 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/.yardopts

@@ -0,0 +1,4 @@
+--quiet
+README.md
+lib/**/*.rb
+LICENSE

data/Gemfile

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rom-relation', path: '.'
+
+gem 'axiom',      git: 'https://github.com/dkubb/axiom.git'
+gem 'rom-mapper', git: 'https://github.com/rom-rb/rom-mapper.git'
+
+group :test do
+  gem 'bogus', '~> 0.1'
+  gem 'randexp'
+  gem 'ruby-graphviz'
+  gem 'axiom-memory-adapter', git: 'https://github.com/dkubb/axiom-memory-adapter.git'
+end
+
+group :development do
+  gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
+end
+
+# added by devtools
+eval_gemfile 'Gemfile.devtools'

data/Gemfile.devtools

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',  '~> 10.1.0'
+  gem 'rspec', '~> 2.14.1'
+  gem 'yard',  '~> 0.8.7'
+end
+
+group :yard do
+  gem 'kramdown', '~> 1.1.0'
+end
+
+group :guard do
+  gem 'guard',         '~> 1.8.1'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 3.0.2'
+  gem 'guard-rubocop', '~> 0.2.0'
+  gem 'guard-mutant',  '~> 0.0.1'
+
+  # file system change event handling
+  gem 'listen',     '~> 1.2.2'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.3', require: false
+  gem 'rb-inotify', '~> 0.9.0', require: false
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.0', 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.6.7'
+  gem 'flay',      '~> 2.4.0'
+  gem 'flog',      '~> 4.1.1'
+  gem 'reek',      '~> 1.3.2'
+  gem 'rubocop',   '~> 0.11.0'
+  gem 'simplecov', '~> 0.7.1'
+  gem 'yardstick', '~> 0.9.7', git: 'https://github.com/dkubb/yardstick.git'
+
+  platforms :ruby_19, :ruby_20 do
+    gem 'mutant', git: 'https://github.com/mbj/mutant.git'
+    gem 'yard-spellcheck', '~> 0.1.5'
+  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,25 @@
+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
+
+guard :rubocop, cli: %w[--config config/rubocop.yml] do
+  watch(%r{.+\.(?:rb|rake)\z})
+  watch(%r{\Aconfig/rubocop\.yml\z})  { |m| File.dirname(m[0]) }
+  watch(%r{(?:.+/)?\.rubocop\.yml\z}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,21 @@
+# rom-relation
+
+[![Gem Version](https://badge.fury.io/rb/rom-relation.png)][gem]
+[![Build Status](https://travis-ci.org/rom-rb/rom-relation.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom-relation.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/rom-rb/rom-relation.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/rom-rb/rom-relation/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/rom-relation
+[travis]: https://travis-ci.org/rom-rb/rom-relation
+[gemnasium]: https://gemnasium.com/rom-rb/rom-relation
+[codeclimate]: https://codeclimate.com/github/rom-rb/rom-relation
+[coveralls]: https://coveralls.io/r/rom-rb/rom-relation
+
+Relations with mappers for [Ruby Object Mapper](http://rom-rb.org).
+
+See ROM's [README](https://github.com/rom-rb/rom) for more information.
+
+## License
+
+See LICENSE file.

data/Rakefile

@@ -0,0 +1,4 @@
+# encoding: utf-8
+
+require 'devtools'
+Devtools.init_rake_tasks

data/TODO.md

@@ -0,0 +1,4 @@
+# 0.0.1
+
+* Update README with 'getting started' section
+* Add missing YARD docs

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 3.0

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 11
+total_score: 129

data/config/flog.yml

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

data/config/mutant.yml

@@ -0,0 +1,8 @@
+---
+name: rom
+namespace:
+  - ROM::Relation
+  - ROM::Environment
+  - ROM::Repository
+  - ROM::Schema
+  - ROM::Mapping

data/config/reek.yml

@@ -0,0 +1,97 @@
+---
+Attribute:
+  enabled: false
+  exclude: []
+BooleanParameter:
+  enabled: true
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: false
+  exclude: []
+  max_calls: 1
+FeatureEnvy:
+  enabled: true
+  exclude:
+    - 'ROM::Mapping#build_relation'
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  max_params: 3
+LongYieldList:
+  enabled: true
+  max_params: 2
+NestedIterators:
+  enabled: true
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  max_instance_variables: 3
+  exclude:
+    - ROM::Mapping::Definition
+TooManyMethods:
+  enabled: true
+  exclude:
+    - ROM::Environment
+    - ROM::Relation
+  max_methods: 10
+TooManyStatements:
+  enabled: true
+  max_statements: 4
+UncommunicativeMethodName:
+  enabled: true
+  exclude:
+    - 'n'  # typically used to denote infinity in ROM code
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude:
+    - Axiom::Adapter::Sqlite3
+  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:
+    - 'r' # typically used for 'relation' in blocks
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  max_helper_calls: 0

data/config/rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+  Excludes:
+    - '**/vendor/**'
+    - '**/spec/unit/rom/relation/to_a_spec.rb'
+
+# 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.
+AccessControl:
+  Enabled: false
+
+LineLength:
+  Max: 94
+
+Blocks:
+  Enabled: false
+
+Documentation:
+  Enabled: false

data/lib/rom/environment.rb

@@ -0,0 +1,133 @@
+# encoding: utf-8
+
+module ROM
+
+  # The environment configures repositories and loads schema with relations
+  #
+  class Environment
+    include Concord.new(:repositories, :registry)
+
+    # Build an environment instance from a repository config hash
+    #
+    # @example
+    #
+    #   config = { 'test' => 'memory://test' }
+    #   env    = ROM::Environment.setup(config)
+    #
+    # @param [Environment, Hash<#to_sym, String>] config
+    #   an environment or a hash of adapter uri strings,
+    #   keyed by repository name
+    #
+    # @return [Environment]
+    #
+    # @api public
+    def self.setup(config)
+      return config if config.kind_of?(self)
+
+      repositories = config.each_with_object({}) { |(name, uri), hash|
+        hash[name.to_sym] = Repository.build(name, Addressable::URI.parse(uri))
+      }
+
+      build(repositories)
+    end
+
+    # Build a new environment
+    #
+    # @param [Hash] repositories
+    #
+    # @param [Hash] registry for relations
+    #
+    # @return [Environment]
+    #
+    # @api private
+    def self.build(repositories, registry = {})
+      new(repositories, registry)
+    end
+
+    # Build a relation schema for this environment
+    #
+    # @example
+    #   env = Environment.coerce(test: 'memory://test')
+    #
+    #   env.schema do
+    #     base_relation :users do
+    #       repository :test
+    #
+    #       attribute :id, Integer
+    #       attribute :name, String
+    #     end
+    #   end
+    #
+    # @return [Schema]
+    #
+    # @api public
+    def schema(&block)
+      @schema ||= Schema.build(repositories)
+      @schema.call(&block) if block
+      @schema
+    end
+
+    # Define mapping for relations
+    #
+    # @example
+    #
+    #   env.schema do
+    #     base_relation :users do
+    #       repository :test
+    #
+    #       attribute :id,        Integer
+    #       attribtue :user_name, String
+    #     end
+    #   end
+    #
+    #   env.mapping do
+    #     users do
+    #       model User
+    #
+    #       map :id
+    #       map :user_name, :to => :name
+    #     end
+    #   end
+    #
+    # @return [Mapping]
+    #
+    # @api public
+    def mapping(&block)
+      Mapping.build(self, schema, &block)
+    end
+
+    # Return registered relation
+    #
+    # @example
+    #
+    #   env[:users]
+    #
+    # @param [Symbol] relation name
+    #
+    # @return [Relation]
+    #
+    # @api public
+    def [](name)
+      registry[name]
+    end
+
+    # Register a rom relation
+    #
+    # @return [Environment]
+    #
+    # @api private
+    def []=(name, relation)
+      registry[name] = relation
+    end
+
+    # The repository with the given +name+
+    #
+    # @return [Repository]
+    #
+    # @api public
+    def repository(name)
+      repositories[name]
+    end
+
+  end # Environment
+end # ROM

data/lib/rom/mapping/definition.rb

@@ -0,0 +1,127 @@
+# encoding: utf-8
+
+module ROM
+  class Mapping
+
+    # Mapping definition DSL
+    #
+    # @private
+    class Definition
+      include Adamantium::Flat
+
+      attr_reader :mapping, :attributes
+      private :mapping, :attributes
+
+      # Build new mapping definition
+      #
+      # @api private
+      def self.build(header, &block)
+        new(header, &block)
+      end
+
+      # Initialize a new Definition instance
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def initialize(header, &block)
+        @header     = header
+        @mapping    = {}
+        @attributes = Set.new
+
+        instance_eval(&block)
+
+        build_mapper unless mapper
+      end
+
+      # @api private
+      def header
+        @header.project(attributes + Set[*mapping.keys])
+      end
+      memoize :header
+
+      # Get or set mapper
+      #
+      # @example
+      #
+      #   Mapping.build do
+      #     users do
+      #       mapper my_custom_mapper
+      #     end
+      #   end
+      #
+      # @param [Object]
+      #
+      # @return [Object]
+      #
+      # @api public
+      def mapper(mapper = Undefined)
+        if mapper == Undefined
+          @mapper
+        else
+          @mapper = mapper
+        end
+      end
+
+      # Get or set model for the mapper
+      #
+      # @example
+      #
+      #   Mapping.build do
+      #     users do
+      #       model User
+      #     end
+      #   end
+      #
+      # @param [Class]
+      #
+      # @return [Class]
+      #
+      # @api public
+      def model(model = Undefined)
+        if model == Undefined
+          @model
+        else
+          @model = model
+        end
+      end
+
+      # Configure attribute mappings
+      #
+      # @example
+      #
+      #   Mapping.build do
+      #     users do
+      #       map :id, :email
+      #       map :user_name, to: :name
+      #     end
+      #   end
+      #
+      # @params [Array<Symbol>,Symbol,Hash]
+      #
+      # @return [Definition]
+      #
+      # @api public
+      def map(*args)
+        options = args.last
+
+        if options.kind_of?(Hash)
+          mapping.update(args.first => options[:to])
+        else
+          @attributes += Set[*args]
+        end
+      end
+
+      private
+
+      # Build default rom mapper
+      #
+      # @api private
+      def build_mapper
+        @mapper = Mapper.build(header, model, map: mapping)
+      end
+
+    end # Definition
+
+  end # Mapping
+end # ROM