ormivore 0.0.1

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+gem 'nested_exceptions'
+
+group :development do
+  gem 'rake'
+  gem 'activesupport', '~>3.2.3'
+  gem 'activerecord', '~>3.2.3'
+  gem 'sqlite3'
+  gem 'rspec'
+  gem 'factory_girl'
+  gem 'database_cleaner'
+  gem 'guard-rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    coderay (1.0.9)
+    database_cleaner (1.0.1)
+    diff-lcs (1.2.4)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    ffi (1.8.1)
+    formatador (0.2.4)
+    guard (1.8.0)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (3.0.1)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    i18n (0.6.1)
+    listen (1.1.4)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.3)
+    method_source (0.8.1)
+    multi_json (1.7.4)
+    nested_exceptions (1.0.1)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.4)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    slop (3.4.5)
+    sqlite3 (1.3.7)
+    thor (0.18.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.2.3)
+  activesupport (~> 3.2.3)
+  database_cleaner
+  factory_girl
+  guard-rspec
+  nested_exceptions
+  rake
+  rspec
+  sqlite3

data/Guardfile

@@ -0,0 +1,17 @@
+# More info at https://github.com/guard/guard#readme
+
+notification :tmux
+notification :terminal_title
+
+guard :rspec,
+  :all_on_start => true,
+  :run_all => { :cli => '--color' },
+  :cli => '--color --format nested' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/(.+)/shared.*\.rb$}) { |m| "spec/#{m[1]}" }
+  watch(%r{^spec/(.+)/.*helpers\.rb$}) { |m| "spec/#{m[1]}" }
+  watch(%r{spec/spec_(db_)?helper.rb}) { 'spec' }
+  watch('spec/factories.rb') { 'spec' }
+  watch(%r{^lib/(.+)\.rb$}) { 'spec' }
+end

data/README.md

@@ -0,0 +1,135 @@
+# ORMivore
+
+[![Build Status](https://secure.travis-ci.org/olek/ormivore.png)](http://travis-ci.org/olek/ormivore)
+
+## Synopsis
+
+ORM framework for **long lived** ruby projects with a twist.
+
+## Caution
+
+ORMivore is highly opinionated and does not quite follow conventional
+rules of wisdom in ruby/rails community. If you want to stay 'in sync'
+with mainstream 'rails engineers' - stay away (and stop reading - it may
+cause permanent brain damage).
+
+## Audience
+
+If you want to be able to maintain your app in couple years, or want
+to get legacy app back under control, ORMivore may have something
+for you.
+
+If quick throw-away projects that require no extension/maintenance in
+the future are your goal, ORMivore is a waste of time (for you).
+
+## Stability
+
+ORMivore is in the R&D 'alpha' stage. In other words, it is my
+playground for experimenting with new approach to ORM. Changes are
+definitely not backward compatible. If you decide to use it, prepare to
+roll up your sleeves, and I disclaim any potential indirect harm to kittens.
+
+If I still need to spell it out - ORMivore is not production ready just yet.
+
+## Motivation
+
+If you have seen legacy Rails app, chances are you noticed:
+
+- persistance logic hopelessly coupled with business logic
+- business rules are forming one clump
+- copious amounts of logged SQL that is hard to relate back to application code
+- bad performance and high database load caused by inefficient SQL
+queries
+
+ORMivore is designed to helps you either avoid those issues on your project, or to
+slowly eliminate them on your legacy app.
+
+## Philosophy summary
+
+- Everything the system does FOR you, the system also does TO you
+- Actions that will lead to long term pain better be painful
+immediately, and never sugar-coated with short term gain
+- Long term maintenability trumps supersonic initial development
+- There is much to be learned from functional programming
+
+## Philosophy explained
+
+Many ORMs simply do too good of a job - they isolate developers from
+storage so much that developers choose to pretend it is just an inconvenient
+abstraction, and ignore it as much as possible. That causes huge loss of
+database efficiency. ORMivore does not abstract storage too far away -
+it does only the bare minimum. No automatic associations management, no
+callbacks, no frills at all.
+
+OOD is great, but frequently overused. ORMivore uses plain data
+structures (functional style) to communicate between different layers,
+solving problem of messy circular dependencies.
+
+Mutable entities have state, and that makes reasoning about them more
+difficult. Immutable entities are easy to reason about and discourage
+placing any "how to" behavior on them, making them a good place for
+"what is" messages.  As a side benefit, immutable entities play well in
+multi-treaded environments.
+
+Ports and adapters pattern (hexagonal architecture) is great for
+isolating persistance logic from entities. It also allows for some
+degree of substitutability of different storages.
+
+While STI and polymorphic relations are bad for your health, your legacy
+database is probably littered with them, and ORMivore provides mean to
+map those to domain objects in a 'classless' way.
+That makes it possible to introduce ORMivore entities in the same
+project/process as legacy ActiveRecord models.
+
+## Installation
+
+Well, I have not built gem for this project just yet, but when I do, just add 'gem
+"ormivore"' to Gemfile, or run 'gem install ormivore'.
+
+## Code Example
+
+```ruby
+new_account = Account.new(firstname: 'John', lastname: 'Doe')
+
+saved_account = repo.persist(account)
+
+changed_account = saved_account.apply(firstname: 'Jane')
+
+saved_changed_account = repo.persist(changed_account)
+
+reloaded_account = repo.find_by_id(saved_changed_account.id)
+```
+
+## Tests
+
+To run tests on ORMivore and embedded sample app, run something along
+those lines:
+
+```bash
+gem install bundle
+
+bundle install --path vendor/bundle
+
+bundle exec rake spec
+```
+
+## Contributors
+
+At this point, this is the playground of experimentation, and it does
+not have to be just mine! Forks and pull requests are welcome. Of
+course, I reserve the right to politely decline or ruthlessly
+'refactor'.
+
+## License
+
+One word - MIT.
+
+## Apologies
+
+> Documentation is like sex: when it is good, it is very, very good; and when it is bad, it is better than nothing.
+
+This README is certainly not enough, but it is indeed better than nothing.
+
+English is not my 'mother tongue'. I am sure this document is littered
+with mistaekes. If your english is any better than mine - please help me
+fix them.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  # task.pattern    = 'spec/{models,javascripts}/**/*_spec.rb'
+  # task.rspec_opts = ['--color', '--format progress', '--timeout 0.1']
+  task.rspec_opts = ['--color', '--format progress']
+  # task.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/app/adapters/account_storage_ar_adapter.rb

@@ -0,0 +1,16 @@
+module App
+  class AccountStorageArAdapter
+    include ORMivore::ArAdapter
+
+    self.table_name = 'accounts'
+    self.default_converter_class = AccountSqlStorageConverter
+
+    expand_on_create do |attrs|
+      {
+        login: attrs[:email],
+        crypted_password: 'Unknown'
+      }
+    end
+  end
+end
+

data/app/adapters/account_storage_memory_adapter.rb

@@ -0,0 +1,7 @@
+module App
+  class AccountStorageMemoryAdapter
+    include ORMivore::MemoryAdapter
+
+    self.default_converter_class = NoopConverter
+  end
+end

data/app/adapters/address_storage_ar_adapter.rb

@@ -0,0 +1,8 @@
+module App
+  class AddressStorageArAdapter
+    include ORMivore::ArAdapter
+
+    self.table_name = 'addresses'
+    self.default_converter_class = AddressSqlStorageConverter
+  end
+end

data/app/adapters/address_storage_memory_adapter.rb

@@ -0,0 +1,7 @@
+module App
+  class AddressStorageMemoryAdapter
+    include ORMivore::MemoryAdapter
+
+    self.default_converter_class = NoopConverter
+  end
+end

data/app/connection_manager.rb

@@ -0,0 +1,17 @@
+module ConnectionManager
+  def self.establish_connection(env, logger=nil)
+    raise unless env
+
+    unless ActiveRecord::Base.connected?
+      configuration = YAML::load(
+        File.open(File.join(RequireHelpers.root, 'db', 'database.yml'))
+      )[env.to_s]
+
+      puts "Connecting to database #{configuration['database']}"
+
+      ActiveRecord::Base.establish_connection(configuration)
+
+      ActiveRecord::Base.logger = logger
+    end
+  end
+end

data/app/console.rb

@@ -0,0 +1,15 @@
+# Allows running a lightweight version of rails console
+# Start it like this:
+#
+# irb -r ./lib/console.rb
+
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require(:default)
+
+require_relative 'require_helpers'
+
+RequireHelpers.require_all
+
+ConnectionManager.establish_connection(YAML::load(File.open('./db/database.yml')), Logger.new(STDOUT))

data/app/converters/account_sql_storage_converter.rb

@@ -0,0 +1,33 @@
+module App
+  class AccountSqlStorageConverter
+    STATUS_MAP = Hash.new { |h, k|
+      raise ArgumentError, "Status #{k.inspect} not known"
+    }.update(
+      active: 1,
+      inactive: 2,
+      deleted: 3
+    ).freeze
+
+    REVERSE_STATUS_MAP = Hash.new { |h, k|
+      raise ArgumentError, "Status #{k.inspect} not known"
+    }.update(
+      Hash[STATUS_MAP.to_a.map(&:reverse)]
+    ).freeze
+
+    def attributes_list_to_storage(list)
+      list
+    end
+
+    def from_storage(attrs)
+      attrs.dup.tap { |copy|
+        copy[:status] = REVERSE_STATUS_MAP[copy[:status]] if copy[:status]
+      }
+    end
+
+    def to_storage(attrs)
+      attrs.dup.tap { |copy|
+        copy[:status] = STATUS_MAP[copy[:status]] if copy[:status]
+      }
+    end
+  end
+end

data/app/converters/address_sql_storage_converter.rb

@@ -0,0 +1,51 @@
+module App
+  class AddressSqlStorageConverter
+    ADDRESS_TYPE_MAP = Hash.new { |h, k|
+      raise ArgumentError, "Addressable type #{k.inspect} not known"
+    }.update(
+      shipping: 'ShippingAddress',
+      billing: 'BillingAddress'
+    ).freeze
+
+    REVERSE_ADDRESS_TYPE_MAP = Hash.new { |h, k|
+      raise ArgumentError, "Addressable type #{k.inspect} not known"
+    }.update(
+      Hash[ADDRESS_TYPE_MAP.to_a.map(&:reverse)]
+    ).freeze
+
+    def attributes_list_to_storage(list)
+      list.dup.tap { |converted|
+        if converted.delete(:account_id)
+          converted << :addressable_id << :addressable_type
+        end
+      }
+    end
+
+    def from_storage(attrs)
+      attrs.dup.tap { |copy|
+        copy[:type] = REVERSE_ADDRESS_TYPE_MAP[copy[:type]] if copy[:type]
+        addressable_id, addressable_type = copy.delete(:addressable_id), copy.delete(:addressable_type)
+        if addressable_id && addressable_type
+          replacement_attr = case addressable_type
+          when 'Account'
+            :account_id
+          else
+            raise ORMivore::BadAttributesError, "Unknown addressable_type #{addressable_type.inspect}"
+          end
+          copy[replacement_attr] = addressable_id
+        end
+      }
+    end
+
+    def to_storage(attrs)
+      attrs.dup.tap { |copy|
+        copy[:type] = ADDRESS_TYPE_MAP[copy[:type]] if copy[:type]
+        account_id = copy.delete(:account_id)
+        if account_id
+          copy[:addressable_id] = account_id
+          copy[:addressable_type] = 'Account'
+        end
+      }
+    end
+  end
+end

data/app/converters/noop_converter.rb

@@ -0,0 +1,15 @@
+module App
+  class NoopConverter
+    def attributes_list_to_storage(list)
+      list
+    end
+
+    def from_storage(attrs)
+      attrs
+    end
+
+    def to_storage(attrs)
+      attrs
+    end
+  end
+end