edr 0.0.1 → 0.0.2

data/.gitignore

@@ -11,6 +11,8 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea
+Gemfile.lock
 
 # YARD artifacts
 .yardoc

data/edr.gemspec

@@ -16,4 +16,11 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "activerecord", "~> 3.2.8"
+  gem.add_development_dependency "sqlite3", "1.3.6"
+  gem.add_development_dependency "database_cleaner", "~> 0.9.1"
+  gem.add_dependency "orm_adapter", "~> 0.4.0"
 end

data/lib/edr/ar/data_validator.rb

@@ -0,0 +1,14 @@
+module Edr
+  module AR
+    module DataValidator
+      def self.validate model
+        data = model._data
+        if data.valid?
+          []
+        else
+          data.errors.full_messages
+        end
+      end
+    end
+  end
+end

data/lib/edr/ar/repository.rb

@@ -0,0 +1,17 @@
+module Edr
+  module AR
+    module Repository
+      include ::Edr::Repository
+
+      def persist model
+        data_object = data(model)
+        data_object.save!
+
+        model.id = data_object.id
+        model.send(:repository=, self)
+
+        model
+      end
+    end
+  end
+end

data/lib/edr/model.rb

@@ -0,0 +1,77 @@
+require_relative 'registry'
+
+module Edr
+  module Model
+    def self.included(base)
+      base.extend ClassMethods
+      base.extend ::Forwardable
+    end
+
+    attr_accessor :_data
+
+    def initialize _data = _new_instance
+      if _data.kind_of?(Hash)
+        @_data = _new_instance _data
+      else
+        @_data = _data
+      end
+    end
+
+    def mass_assign(attributes)
+      attributes.each do |k, v|
+        self.send "#{k}=", v
+      end
+    end
+
+    def as_json(options={})
+      _data.as_json(options)
+    end
+
+    protected
+
+    def repository
+      raise "Transient objects don't have repositories" unless @repository
+      @repository
+    end
+
+    def repository= repo
+      @repository = repo
+    end
+
+    def association name
+      _data.send(name)
+    end
+
+    def wrap association
+      if association.respond_to? :first
+        return [] if association.empty?
+        association.map{|c| wrap c}
+      else
+        return nil if association.nil?
+        model_class = Registry.model_class_for(association.class)
+        model_class.new association
+      end
+    end
+
+    def _new_instance hash = {}
+      Registry.data_class_for(self.class).new hash
+    end
+
+    module ClassMethods
+      def fields *field_names
+        field_names.each do |field_name|
+          def_delegators :_data, field_name
+          def_delegators :_data, "#{field_name}="
+        end
+      end
+
+      def wrap_associations *association_names
+        association_names.each do |association_name|
+          define_method association_name do
+            wrap(association association_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/edr/registry.rb

@@ -0,0 +1,52 @@
+require 'ostruct'
+
+module Edr
+  class Registry
+    def self.define(&block)
+      @@instance = self.new(&block)
+    end
+
+    def self.data_class_for(model_class)
+      @@instance.data_class_for(model_class)
+    end
+
+    def self.model_class_for(data_class)
+      @@instance.model_class_for(data_class)
+    end
+
+    def initialize(&block)
+      @data_to_model_map = {}
+      @model_to_data_map = {}
+      self.instance_eval &block
+    end
+
+    def map model_class, data_class
+      @model_to_data_map[model_class] = data_class
+      @data_to_model_map[data_class] = model_class
+    end
+
+    def data_class_for model_class
+      data_class = @model_to_data_map[model_class]
+      return OpenStruct unless data_class
+
+      data_class
+    end
+
+    def model_class_for data_class
+      model_class = @data_to_model_map[data_class]
+      raise "No model class for #{data_class.to_s}" unless model_class
+
+      model_class
+    end
+
+    private
+
+    def model_to_data_map
+      @model_to_data_map
+    end
+
+    def data_to_model_map
+      @data_to_model_map
+    end
+  end
+end

data/lib/edr/repository.rb

@@ -0,0 +1,53 @@
+require_relative 'registry'
+
+module Edr
+  module Repository
+    def delete model
+      data_class.destroy data(model)
+    end
+
+    def delete_by_id id
+      data_class.destroy(data_class.get!(id))
+    end
+
+    def find id
+      wrap(data_class.get!(id))
+    end
+
+    def all
+      data_class.find_all.map do |data|
+        wrap(data)
+      end
+    end
+
+    protected
+
+    def wrap data
+      model_class.new(data).tap do |m|
+        m.send(:repository=, self)
+      end
+    end
+
+    def data model
+      model._data
+    end
+
+    def set_model_class model_class
+      singleton_class.send :define_method, :data_class do
+        Registry.data_class_for(model_class).to_adapter
+      end
+
+      singleton_class.send :define_method, :model_class do
+        model_class
+      end
+    end
+
+    private
+
+    def where attrs
+      data_class.find_all(attrs).map do |data|
+        wrap(data)
+      end
+    end
+  end
+end

data/lib/edr/version.rb

@@ -1,3 +1,3 @@
 module Edr
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/edr.rb

@@ -1,5 +1,9 @@
 require "edr/version"
+require 'orm_adapter'
 
-module Edr
-  # Your code goes here...
-end
+require_relative 'edr/registry'
+require_relative 'edr/repository'
+require_relative 'edr/model'
+
+require_relative 'edr/ar/data_validator'
+require_relative 'edr/ar/repository'

data/spec/edr/data_validator_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require_relative '../test_data'
+
+describe Edr::AR::DataValidator do
+
+  describe "Using data validation for a saved model" do
+    example do
+      order_data = OrderData.create! amount: 10, deliver_at: Date.today
+      order = Order.new(order_data)
+      order.amount = "blah"
+      Edr::AR::DataValidator.validate(order).should be_present
+    end
+  end
+
+  describe "Using data validation for a new model" do
+    example do
+      order = Order.new amount: "blah"
+      Edr::AR::DataValidator.validate(order).should be_present
+    end
+  end
+end

data/spec/edr/model_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require_relative '../test_data'
+
+describe Edr::Model do
+
+  describe "Using data objects directly" do
+    example do
+      order = OrderData.create! amount: 10, deliver_at: Date.today
+      order.items.create! amount: 6, name: 'Item 1'
+      order.items.create! amount: 4, name: 'Item 2'
+
+      order.reload.items.size.should == 2
+      order.items.first.amount.should == 6
+    end
+  end
+
+  describe "Creating a new model object" do
+    example do
+      order = Order.new
+      order.amount = 15
+
+      order.amount.should == 15
+    end
+
+    it "uses hash to initialize fields" do
+      order = Order.new amount: 15
+
+      order.amount.should == 15
+    end
+
+    it "creating an aggregate with children" do
+      order = Order.new
+      item = order.add_item name: 'item1', amount: 10
+
+      item.name.should == 'item1'
+    end
+  end
+
+  describe "Using data structure instead of a data object" do
+    example do
+      order = Order.new OpenStruct.new
+      order.amount = 99
+      order.amount.should == 99
+    end
+  end
+end

data/spec/edr/repository_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require_relative '../test_data'
+
+describe Edr::Repository do
+  describe "Persisting objects" do
+    example do
+      order = Order.new amount: 10
+
+      OrderRepository.persist order
+
+      order.id.should be_present
+      order.amount.should == 10
+    end
+
+    it "persists an aggregate with children" do
+      order = Order.new amount: 10
+      order.add_item name: 'item1', amount: 5
+
+      OrderRepository.persist order
+
+      from_db = OrderRepository.find(order.id)
+      from_db.items.first.amount.should == 5
+    end
+
+    it "raises an exception when invalid data" do
+      order = Order.new amount: "invalid"
+
+      ->{OrderRepository.persist order}.should raise_error
+    end
+  end
+
+  describe "Creating objects through the repository variable" do
+    let(:order) do
+      order = Order.new(amount: 10)
+      OrderRepository.persist order
+      order
+    end
+
+    example do
+      order.add_item_through_repository name: 'item', amount: 10
+      order.items.first.name.should == 'item'
+    end
+
+    it "raises an exception when the root is not persisted" do
+      ->{Order.new(amount: 10).add_item_through_repository({})}.should raise_error
+    end
+  end
+
+  describe "Selecting models" do
+    let!(:data){OrderData.create! amount: 10, deliver_at: Date.today}
+
+    example do
+      orders = OrderRepository.find_by_amount 10
+      orders.first.id == data.id
+    end
+
+    it "finds by id" do
+      order = OrderRepository.find data.id
+      order.id.should == data.id
+    end
+
+    it "returns all saved objects" do
+      orders = OrderRepository.all
+      orders.first.id == data.id
+    end
+
+    it "raises an exception when cannot find cannot find object" do
+      ->{OrderRepository.find 999}.should raise_error
+    end
+  end
+
+  describe "Deleting models" do
+    let!(:order) do
+      order = Order.new amount: 10, deliver_at: Date.today
+      OrderRepository.persist order
+      order
+    end
+
+    example do
+      OrderRepository.delete order
+      OrderRepository.find_by_id(order.id).should be_nil
+    end
+
+    it "deletes by id" do
+      OrderRepository.delete_by_id order.id
+      OrderRepository.find_by_id(order.id).should be_nil
+    end
+
+    it "raises an exception when cannot find cannot find object" do
+      ->{OrderRepository.delete_by_id 999}.should raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+require 'database_cleaner'
+
+ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3',
+    database: ':memory:',
+)
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/test_data.rb

@@ -0,0 +1,116 @@
+require_relative '../lib/edr'
+
+# STEP0: Schema
+# --------------------------------------------------
+ActiveRecord::Schema.define(:version => 1) do
+  create_table "orders", :force => true do |t|
+    t.decimal  "amount"
+    t.date     "deliver_at"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+  create_table "items", :force => true do |t|
+    t.string   "name"
+    t.decimal  "amount"
+    t.integer  "order_id"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+end
+
+
+
+# STEP1: Define data objects
+# --------------------------------------------------
+class OrderData < ActiveRecord::Base
+  self.table_name = "orders"
+
+  attr_accessible :amount, :deliver_at
+
+  validates :amount, numericality: true
+  has_many :items, class_name: 'ItemData', foreign_key: 'order_id'
+end
+
+class ItemData < ActiveRecord::Base
+  self.table_name = "items"
+
+  attr_accessible :amount, :name
+
+  validates :amount, numericality: true
+  validates :name, presence: true
+end
+
+
+
+# STEP2: Define domain objects
+# --------------------------------------------------
+class Order
+  include Edr::Model
+
+  fields :id, :amount, :deliver_at
+  wrap_associations :items
+
+  def add_item attrs
+    wrap association(:items).new(attrs)
+  end
+
+  def add_item_through_repository attrs
+    repository.create_item self, attrs
+  end
+end
+
+class Item
+  include Edr::Model
+
+  fields :id, :name, :amount, :order_id
+end
+
+
+
+# STEP3: map data objects to domain objects
+# --------------------------------------------------
+Edr::Registry.define do
+  map Order, OrderData
+  map Item, ItemData
+end
+
+
+
+# STEP4: Define repository to access data
+# --------------------------------------------------
+module OrderRepository
+  extend Edr::AR::Repository
+
+  set_model_class Order
+
+  def self.find_by_amount amount
+    where(amount: amount)
+  end
+
+  def self.find_by_id id
+    where(id: id).first
+  end
+
+  def self.create_item order, attrs
+    item = ItemRepository.create_item(order, attrs)
+    data(order).reload
+    return item
+  end
+
+  module ItemRepository
+    extend Edr::AR::Repository
+    set_model_class Item
+
+    def self.create_item order, attrs
+      item = Item.new(attrs)
+      item.order_id = order.id
+      persist item
+    end
+  end
+end
+
+
+
+# STEP5: Profit
+# --------------------------------------------------

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -12,8 +12,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-24 00:00:00.000000000 Z
-dependencies: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: orm_adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description: Entity Data-object Repository framework
 email:
 - vsavkin@nulogy.com
@@ -31,7 +127,17 @@ files:
 - Rakefile
 - edr.gemspec
 - lib/edr.rb
+- lib/edr/ar/data_validator.rb
+- lib/edr/ar/repository.rb
+- lib/edr/model.rb
+- lib/edr/registry.rb
+- lib/edr/repository.rb
 - lib/edr/version.rb
+- spec/edr/data_validator_spec.rb
+- spec/edr/model_spec.rb
+- spec/edr/repository_spec.rb
+- spec/spec_helper.rb
+- spec/test_data.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -56,4 +162,9 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Separate persistence from the domain model.
-test_files: []
+test_files:
+- spec/edr/data_validator_spec.rb
+- spec/edr/model_spec.rb
+- spec/edr/repository_spec.rb
+- spec/spec_helper.rb
+- spec/test_data.rb