rom-session 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+Gemfile.lock
+*.rbx
+*.rbc
+.yardoc/
+doc/
+measurements/
+coverage/
+profiling/
+tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+#--backtrace

data/.ruby-gemset

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

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+bundler_args: --without yard guard benchmarks
+script: "bundle exec rake ci"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - 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/Gemfile

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+module GemfileHelper
+  def self.source(name)
+    if Dir.exist?("../#{name}")
+      { path: "../#{name}" }
+    else
+      { git: "https://github.com/rom-rb/#{name}.git" }
+    end
+  end
+end
+
+gemspec
+
+gem 'axiom', '~> 0.1.1'
+gem 'axiom-memory-adapter', '~> 0.0.2'
+
+gem 'rom-relation', GemfileHelper.source('rom-relation')
+gem 'rom-mapper',   GemfileHelper.source('rom-mapper')
+
+gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
+
+group :test do
+  gem 'bogus', '~> 0.1'
+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.3.0'
+  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,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

@@ -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-session
+
+[![Gem Version](https://badge.fury.io/rb/rom-session.png)][gem]
+[![Build Status](https://travis-ci.org/rom-rb/rom-session.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom-session.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/rom-rb/rom-session.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/rom-rb/rom-session/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/rom-session
+[travis]: https://travis-ci.org/rom-rb/rom-session
+[gemnasium]: https://gemnasium.com/rom-rb/rom-session
+[codeclimate]: https://codeclimate.com/github/rom-rb/rom-session
+[coveralls]: https://coveralls.io/r/rom-rb/rom-session
+
+Session and state tracker 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/config/devtools.yml

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

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 9
+total_score: 126

data/config/flog.yml

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

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: rom-session
+namespace: 'ROM::Session'

data/config/reek.yml

@@ -0,0 +1,96 @@
+UncommunicativeParameterName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+TooManyMethods:
+  max_methods: 12
+  enabled: true
+  exclude: []
+  max_instance_variables: 3
+UncommunicativeMethodName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LongParameterList:
+  enabled: true
+  max_params: 2
+  overrides: {}
+  exclude:
+    - ROM::Session::IdentityMap#store
+FeatureEnvy:
+  enabled: true
+  exclude:
+    - ROM::Session::ObjectNotTrackedError
+    - ROM::Proxy
+ClassVariable:
+  exclude: []
+  enabled: true
+BooleanParameter:
+  exclude: []
+  enabled: true
+IrresponsibleModule:
+  exclude: []
+  enabled: true
+UncommunicativeModuleName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+NestedIterators:
+  ignore_iterators: []
+  exclude: []
+  enabled: true
+  max_allowed_nesting: 1
+TooManyStatements:
+  max_statements: 7
+  exclude: []
+  enabled: true
+DuplicateMethodCall:
+  allow_calls: []
+  exclude: []
+  enabled: false
+  max_calls: 1
+UtilityFunction:
+  enabled: true
+  max_helper_calls: 0
+  exclude:
+    - ROM::Session::ObjectNotTrackedError
+    - ROM::Proxy
+Attribute:
+  exclude: []
+  enabled: false
+UncommunicativeVariableName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+RepeatedConditional:
+  enabled: true
+  max_ifs: 1
+DataClump:
+  enabled: true
+  max_copies: 0
+  min_clump_size: 2
+  exclude:
+    - ROM::Session::Tracker
+ControlParameter:
+  exclude: []
+  enabled: true
+LongYieldList:
+  max_params: 0
+  enabled: true
+  exclude:
+    - ROM::Session#self.start

data/config/rubocop.yml

@@ -0,0 +1,45 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.devtools'
+  Excludes:
+    - '**/vendor/**'
+
+# 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: 108
+
+Blocks:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+EmptyLineBetweenDefs:
+  Enabled: false # TODO: re-enable once SpecHelper.mock_model case is properly handled

data/lib/rom-session.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'adamantium'
+require 'equalizer'
+require 'abstract_type'
+require 'concord'
+
+require 'rom-relation'
+require 'rom-mapper'
+
+module ROM
+
+  # Session namespace
+  class Session
+
+    # Raised when an object is expected to be tracked and it's not
+    #
+    class ObjectNotTrackedError < StandardError
+      def initialize(object)
+        super("Tracker doesn't include #{object.inspect}")
+      end
+    end
+
+  end # Session
+
+end # ROM
+
+require 'rom/support/proxy'
+
+require 'rom/session'
+
+require 'rom/session/environment'
+require 'rom/session/tracker'
+require 'rom/session/identity_map'
+require 'rom/session/relation'
+require 'rom/session/mapper'
+
+require 'rom/session/state'
+require 'rom/session/state/transient'
+require 'rom/session/state/persisted'
+require 'rom/session/state/created'
+require 'rom/session/state/updated'
+require 'rom/session/state/deleted'

data/lib/rom/session.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+module ROM
+
+  # Extends ROM's environment with IdentityMap and state-tracking functionality
+  #
+  # @api public
+  class Session
+    include Concord.new(:environment)
+
+    # Start a new session
+    #
+    # @example
+    #
+    #   ROM::Session.start(env) do |session|
+    #     user = session[:users].new(name: 'Jane')
+    #     session[:users].save(user)
+    #     session[:users].flush
+    #   end
+    #
+    # @param [ROM::Environment] rom's environment
+    #
+    # @yieldparam [Session::Environment]
+    #
+    # @api public
+    def self.start(environment)
+      yield(new(Environment.build(environment)))
+    end
+
+    # Return a session relation identified by name
+    #
+    # @param [Symbol] relation name
+    #
+    # @return [Session::Relation]
+    #
+    # @api public
+    def [](relation_name)
+      environment[relation_name]
+    end
+
+    # Flush this session committing all the state changes
+    #
+    # @return [Session]
+    #
+    # @api public
+    def flush
+      environment.commit
+      self
+    end
+
+    # Return if there are any pending state changes
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def clean?
+      environment.clean?
+    end
+
+  end # Session
+
+end # ROM