vorpal 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjM0OTM4MmE4MDUyYjEzOGFiYmM4YTE1ZGE3NTQwZDE1YzcyZDI4MA==
+    ZTFlNjY4ZjU3YWRhNmY2ZDFmZmFiMTBiMTk3ZWY5ZjVhYjc1NTAzYw==
   data.tar.gz: !binary |-
-    OTdmZTA0MzU5YzAwMWRiZTYyODliM2M5YmE3NGY2ZTg3MDQ5MDY4MA==
+    N2FkZmQzZDBiMjg1MWU5MzJjYzcwMzUxNGNjMzk1NGE0NjkyMjNkYw==
 SHA512:
   metadata.gz: !binary |-
-    ZjM0MGQzYjgwNzYzNjM5MTdkYWM3YWVjODgwMTBhMDdiYTU4ZjlmOTcyNWQy
-    MDVjNDY2NmFmNmQ0NWM3MzU2OWYwZmIzMjBlZmU3ZmYzMGIzMTVmZTgxNjkx
-    MTY3MjkxYzEwMDkzZmVhODBlYmNmZDIzZjJiZTgwZDMzZDM5ODk=
+    NTA5MTJmMWMzM2I5YzE5MmNkYjYzNDhlMzA0NjczZThkMzE1M2M2NDBiYzFj
+    ZGE3OTU0Zjc0NGNlNzA4Y2RiNTM4OTgyZjk1ZmY2MjgzNjY4NTNmM2NkMDI4
+    MjFlMGYwNzQzZWNiN2FiYTA1MzE3YTk1YmNmZTRmOTNlYzM2MWI=
   data.tar.gz: !binary |-
-    OTYwMzhhZDQxMDhiNGU2NmNiYjI5NzdmZGRjZWNjNDczMDczMmEwNjczNGQ3
-    OTQ2MzBkMWJhYWFlOTkzYzFlNTk4NDIyYmMxNzE3ZmI5ZjBjZGQ2Zjg4ODhj
-    Yjc5NWRjYmZhN2I0NTRhMTA5MmFhNzM4YWY5OGZiYzVkOWVmMzY=
+    YTJhOTJhMjFkZmYwMDJlYmQwZDVmZWY0MzkwMzgyNzRhZDA0NWYyZGFlM2Iy
+    NDZmYzc5MzUyNGM4MzFiOTIwYWIxMDRiNWUzMzJlYTcwY2YwMWEzNjRmOGM3
+    MGM4Nzg1MzRjMzUxNzgzZmFjOTg2YjU3ZDQ2ZmM0NTlkZDNkMWE=

data/README.md

@@ -108,41 +108,41 @@ require 'vorpal'
 
 module TreeRepository
   extend self
-  
+
+  class TreeDB < ActiveRecord::Base
+    self.table_name = 'trees'
+  end
+
+  class BranchDB < ActiveRecord::Base
+    self.table_name = 'branches'
+  end
+
   @repository = Vorpal.define do
-    map Tree do
+    map Tree, to: TreeDB do
       fields :name
       belongs_to :gardener, owned: false
       has_many :branches
     end
 
-    map Gardener
-  
-    map Branch do
+    map Gardener, to: Gardener
+
+    map Branch, to: BranchDB do
       fields :length, :diameter
       belongs_to :tree
     end
   end
-  
+
   def find(id)
     @repository.load(id, Tree)
   end
-  
+
   def save(tree)
     @repository.persist(tree)
   end
-  
+
   def destroy(tree)
     @repository.destroy(tree)
   end
-  
-  class ARTree < ActiveRecord::Base
-    self.table_name = 'trees'
-  end
-  
-  class ARBranch < ActiveRecord::Base
-    self.table_name = 'branches'
-  end
 end
 ```
 
@@ -184,12 +184,12 @@ It also does not do some things that you might expect from other ORMs:
 
 ## Future Enhancements
 * Aggregate updated_at.
-* Support for other DBMSs.
+* Support for other DBMSs (no MySQL support until ids can be generated without inserting into a table!)
 * Support for other ORMs.
 * Value objects.
-* Remove dependency on ActiveRecord (optimistic locking? updated_at, created_at support? Data type conversions?)
-* More efficient object loading (use fewer queries.)
-* Different fields names in domain models than in the DB.
+* Remove dependency on ActiveRecord (optimistic locking? updated_at, created_at support? Data type conversions? TimeZone support?)
+* More efficient object loading and persisting (use fewer queries.)
+* Nicer DSL for specifying field that have different names in the domain model than in the DB.
  
 ## FAQ
 
@@ -203,7 +203,16 @@ It also does not do some things that you might expect from other ORMs:
 
 **Q.** How do I do more complicated queries against the DB without direct access to ActiveRecord?
 
-**A.** Create a method on a [Repository](http://martinfowler.com/eaaCatalog/repository.html)! They have full access to the DB/ORM so you can use [Arel](https://github.com/rails/arel) and go [crazy](http://asciicasts.com/episodes/239-activerecord-relation-walkthrough) or use direct SQL if you want.
+**A.** Create a method on a [Repository](http://martinfowler.com/eaaCatalog/repository.html)! They have full access to the DB/ORM so you can use [Arel](https://github.com/rails/arel) and go [crazy](http://asciicasts.com/episodes/239-activerecord-relation-walkthrough) or use direct SQL if you want. 
+
+For example:
+
+```ruby
+  def find_all
+    ids = TreeDB.pluck(:id) # use an AR query to determine the aggregate ids
+    @repository.load_all(ids, Tree) # use the repository to load all the aggregates
+  end
+```
 
 **Q.** How do I do validations now that I don't have access to ActiveRecord anymore?
 
@@ -223,6 +232,14 @@ It also does not do some things that you might expect from other ORMs:
 
 **A.** You can use [ActiveModel::Serialization](http://api.rubyonrails.org/classes/ActiveModel/Serialization.html) or [ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers) but they are not heartily recommended. The former is too coupled to the model and the latter is too coupled to Rails controllers. Vorpal includes the [SimpleSerializer](http://rubydoc.info/github/nulogy/vorpal/master/SimpleSerializer) and [SimpleDeserializer](http://rubydoc.info/github/nulogy/vorpal/master/SimpleDeserializer) for this purpose.
 
+## Running Tests
+
+1. Start a PostgreSQL server.
+2. Either:
+  * Create a DB user called `vorpal` with password `pass` and a DB called `vorpal_test`. OR:
+  * Modify `spec/integration_spec_helper.rb`.
+3. Run `rake` from the terminal.
+
 ## Contributors
 
 * [Sean Kirby](https://github.com/sskirby)

data/Rakefile

@@ -1,2 +1,10 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+begin
+  require "bundler/gem_tasks"
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks associated with creating new versions of the gem.'
+end
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/vorpal/aggregate_repository.rb

@@ -36,8 +36,6 @@ class AggregateRepository
   #
   # @param objects [[Object]] array of aggregate roots to be saved.
   # @return [[Object]] array of aggregate roots.
-  #
-  # TODO: Nil out object ids if one of the objects can't be saved?
   def persist_all(objects)
     objects.map(&method(:persist))
   end
@@ -49,6 +47,9 @@ class AggregateRepository
   #   loaded.
   # @param domain_class [Class] Type of the root of the aggregate to
   #   be loaded.
+  # @param identity_map [Vorpal::IdentityMap] Provide your own IdentityMap instance
+  #   if you want entity id - unique object mapping for a greater scope than one
+  #   operation.
   # @return [Object] Entity with the given primary key value and type.
   def load(id, domain_class, identity_map=IdentityMap.new)
     db_object = @configs.config_for(domain_class).load_by_id(id)
@@ -60,6 +61,9 @@ class AggregateRepository
   # @param ids [[Integer]] Array of primary key values of the roots of the
   #   aggregates to be loaded.
   # @param domain_class [Class] Type of the roots of the aggregate to be loaded.
+  # @param identity_map [Vorpal::IdentityMap] Provide your own IdentityMap instance
+  #   if you want entity id - unique object mapping for a greater scope than one
+  #   operation.
   # @return [[Object]] Entities with the given primary key values and type.
   def load_all(ids, domain_class, identity_map=IdentityMap.new)
     ids.map { |id| load(id, domain_class, identity_map) }
@@ -83,8 +87,7 @@ class AggregateRepository
   # @param objects [[Object]] Array of roots of the aggregates to be destroyed.
   # @return [[Object]] Roots that were passed in.
   def destroy_all(objects)
-    objects.each(&method(:destroy))
-    objects
+    objects.map(&method(:destroy))
   end
 
   private

data/lib/vorpal/config_builder.rb

@@ -77,18 +77,18 @@ class ConfigBuilder
   def build_class_config
     Vorpal::ClassConfig.new(
       domain_class: @domain_class,
-      table_name: @class_options[:table_name] || table_name,
+      db_class: @class_options[:to] || db_class,
       serializer: @class_options[:serializer] || serializer(fields_with_id),
       deserializer: @class_options[:deserializer] || deserializer(fields_with_id),
     )
   end
 
-  def fields_with_id
-    [:id].concat @fields
+  def db_class
+    "#{@domain_class.name}DB".constantize
   end
 
-  def table_name
-    @domain_class.name.tableize
+  def fields_with_id
+    [:id].concat @fields
   end
 
   def build_has_manys

data/lib/vorpal/configs.rb

@@ -39,7 +39,7 @@ end
 
 # @private
 class ClassConfig
-  attr_reader :serializer, :deserializer, :domain_class, :table_name
+  attr_reader :serializer, :deserializer, :domain_class, :db_class
   attr_accessor :has_manys, :belongs_tos, :has_ones
 
   def initialize(attrs)
@@ -57,10 +57,6 @@ class ClassConfig
     result.column_values(0).map(&:to_i)
   end
 
-  def db_class
-    @db_class ||= ActiveRecord::Base.descendants.detect { |ar| ar.table_name == table_name }
-  end
-
   def find_in_db(object)
     db_class.find(object.id)
   end
@@ -119,7 +115,7 @@ class ClassConfig
   private
 
   def sequence_name
-    "#{table_name}_id_seq"
+    "#{db_class.table_name}_id_seq"
   end
 end
 
@@ -143,7 +139,7 @@ end
 # Object associations:
 # - All object associations are uni-directional
 # - The end that holds the association is the 'Parent' and the end that
-#   is refered to is the 'Child' or 'Children'
+#   is referred to is the 'Child' or 'Children'
 #
 # Relational associations:
 # - Local end: has FK

data/lib/vorpal/configuration.rb

@@ -18,8 +18,8 @@ module Configuration
   #
   # @param domain_class [Class] Type of the domain model to be mapped
   # @param options [Hash] Configure how to map the domain model
-  # @option options [String] :table_name (Name of the domain class snake-cased and pluralized.)
-  #   Name of the relational DB table.
+  # @option options [String] :to (Class with the same name as the domain class with a 'DB' appended.)
+  #   Class of the ActiveRecord object that will map this domain class to the DB.
   # @option options [Object] :serializer (map the {ConfigBuilder#fields} directly)
   #   Object that will convert the domain objects into a hash.
   #

data/lib/vorpal/version.rb

@@ -1,3 +1,3 @@
 module Vorpal
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/integration_spec_helper.rb

@@ -12,14 +12,6 @@ ActiveRecord::Base.establish_connection(
 )
 
 RSpec.configure do |config|
-  # ## Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
-
   # implements use_transactional_fixtures = true
   # from lib/active_record/fixtures.rb
   # works with Rails 3.2. Probably not with Rails 4

data/spec/vorpal/aggregate_repository_spec.rb

@@ -643,7 +643,7 @@ private
         belongs_to :environment, owned: false, fk: :environment_id, fk_type: :environment_type, child_class: Swamp
       end
 
-      map Swamp
+      map Swamp, to: Swamp
     end
   end
 
@@ -727,7 +727,7 @@ private
         fields :length
       end
 
-      map Fissure
+      map Fissure, to: Fissure
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vorpal
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Sean Kirby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake