vorpal 0.1.0.rc1 → 0.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17ab11df546bfd8e01294e22adea87aca049266c
-  data.tar.gz: 1e25a0a08f20f54b277c05e2e90b8bc0d825e85e
+  metadata.gz: 69f36cf61329620f00d5afc82600cb4827072f34
+  data.tar.gz: 2d750d2d81bc23bab69d7491842815bc3a528662
 SHA512:
-  metadata.gz: 5c6f183685c1b5fbd7a89926556a545a20ef87aa604184d5a90223f234780a5a63dd0d69a7e72c864b7dfe79c1fad917f51cb0a8785496400e28d481d7356a27
-  data.tar.gz: 70c6768539ac3214339352902e752ae3178eb109d6cb1f791f62719ba18473cc65a7d950435dac40e936e854d4c06b6a4e1050a95edbe39aa7c190810ad2eb89
+  metadata.gz: 05c571066a636c8ac35e802ed6f27385af70ab22973c10641216e64f122f5c1e9d8776acace14693f4ed559dc1c6ad74d9566449385f7a697b471c786761866a
+  data.tar.gz: 61e7fdb650dfc01c9ec66e59d388ee60fd52411bbe190fd8e79df62ea35340acd3ad63c8f967374a03068ef2cbb0beb6839720bbbd0187a8ab4d60a18a518676

data/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/lib/vorpal/configs.rb

@@ -1,4 +1,5 @@
 require 'vorpal/util/hash_initialization'
+require 'vorpal/exceptions'
 require 'equalizer'
 
 module Vorpal
@@ -10,7 +11,9 @@ module Vorpal
     end
 
     def config_for(clazz)
-      @class_configs.detect { |conf| conf.domain_class == clazz }
+      config = @class_configs.detect { |conf| conf.domain_class == clazz }
+      raise Vorpal::ConfigurationNotFound.new("No configuration found for #{clazz}") unless config
+      config
     end
 
     def config_for_db_object(db_object)

data/lib/vorpal/db_driver.rb

@@ -68,7 +68,7 @@ module Vorpal
         #   slow. https://bugs.ruby-lang.org/issues/11119
         # Remove this override once #2 has been fixed!
         def self.name
-          @name ||= "Vorpal Generated ActiveRecord::Base Class for #{table_name}. Object ID: #{object_id}"
+          @name ||= "Vorpal_Generated_ActiveRecord_Base_Class_for_#{table_name}_Object_ID_#{object_id}"
         end
 
         # Overridden because, like #name, the default implementation for anonymous classes is very,
@@ -132,4 +132,4 @@ module Vorpal
       end
     end
   end
-end
+end

data/lib/vorpal/{config_builder.rb → dsl/config_builder.rb}

@@ -1,21 +1,19 @@
-require 'simple_serializer/serializer'
-require 'simple_serializer/deserializer'
 require 'vorpal/configs'
-require 'active_support/inflector/methods'
-require 'active_support/core_ext/module/introspection'
+require 'vorpal/dsl/defaults_generator'
 
 module Vorpal
+  module Dsl
   class ConfigBuilder
 
     # @private
     def initialize(clazz, options, db_driver)
       @domain_class = clazz
       @class_options = options
-      @db_driver = db_driver
       @has_manys = []
       @has_ones = []
       @belongs_tos = []
       @attributes = []
+      @defaults_generator = DefaultsGenerator.new(clazz, db_driver)
     end
 
     # Maps the given attributes to and from the domain object and the DB. Not needed
@@ -80,28 +78,14 @@ module Vorpal
       [:id].concat @attributes
     end
 
-    # @private
-    def table_name
-      @class_options[:table_name] || ActiveSupport::Inflector.tableize(@domain_class.name)
-    end
-
-    # @private
-    def build_db_class
-      @db_driver.build_db_class(table_name)
-    end
-
     private
 
-    def db_class_name
-      ActiveSupport::Inflector.demodulize(@domain_class.name) + 'DB'
-    end
-
     def build_class_config
       Vorpal::ClassConfig.new(
         domain_class: @domain_class,
-        db_class: @class_options[:to] || build_db_class,
-        serializer: @class_options[:serializer] || serializer(attributes_with_id),
-        deserializer: @class_options[:deserializer] || deserializer(attributes_with_id),
+        db_class: @class_options[:to] || @defaults_generator.build_db_class(@class_options[:table_name]),
+        serializer: @class_options[:serializer] || @defaults_generator.serializer(attributes_with_id),
+        deserializer: @class_options[:deserializer] || @defaults_generator.deserializer(attributes_with_id),
       )
     end
 
@@ -110,29 +94,19 @@ module Vorpal
     end
 
     def build_has_many(options)
-      options[:child_class] ||= child_class(options[:name])
-      options[:fk] ||= foreign_key(@domain_class.name)
+      options[:child_class] ||= @defaults_generator.child_class(options[:name])
+      options[:fk] ||= @defaults_generator.foreign_key(@domain_class.name)
       options[:owned] = options.fetch(:owned, true)
       Vorpal::HasManyConfig.new(options)
     end
 
-    def foreign_key(name)
-      ActiveSupport::Inflector.foreign_key(name.to_s)
-    end
-
-    def child_class(association_name)
-      # Module#parent comes from 'active_support/core_ext/module/introspection'
-      parent_module = @domain_class.parent
-      parent_module.const_get(ActiveSupport::Inflector.classify(association_name.to_s))
-    end
-
     def build_has_ones
       @has_ones.map { |options| build_has_one(options) }
     end
 
     def build_has_one(options)
-      options[:child_class] ||= child_class(options[:name])
-      options[:fk] ||= foreign_key(@domain_class.name)
+      options[:child_class] ||= @defaults_generator.child_class(options[:name])
+      options[:fk] ||= @defaults_generator.foreign_key(@domain_class.name)
       options[:owned] = options.fetch(:owned, true)
       Vorpal::HasOneConfig.new(options)
     end
@@ -142,23 +116,12 @@ module Vorpal
     end
 
     def build_belongs_to(options)
-      child_class = options[:child_classes] || options[:child_class] || child_class(options[:name])
+      child_class = options[:child_classes] || options[:child_class] || @defaults_generator.child_class(options[:name])
       options[:child_classes] = Array(child_class)
-      options[:fk] ||= foreign_key(options[:name])
+      options[:fk] ||= @defaults_generator.foreign_key(options[:name])
       options[:owned] = options.fetch(:owned, true)
       Vorpal::BelongsToConfig.new(options)
     end
-
-    def serializer(attrs)
-      Class.new(SimpleSerializer::Serializer) do
-        hash_attributes *attrs
-      end
-    end
-
-    def deserializer(attrs)
-      Class.new(SimpleSerializer::Deserializer) do
-        object_attributes *attrs
-      end
-    end
   end
-end
+  end
+end

data/lib/vorpal/{configuration.rb → dsl/configuration.rb}

@@ -1,7 +1,8 @@
 require 'vorpal/engine'
-require 'vorpal/config_builder'
+require 'vorpal/dsl/config_builder'
 
 module Vorpal
+  module Dsl
   module Configuration
 
     # Configures and creates a {Engine} instance.
@@ -51,4 +52,5 @@ module Vorpal
       MasterConfig.new(@class_configs)
     end
   end
-end
+  end
+end

data/lib/vorpal/dsl/defaults_generator.rb

@@ -0,0 +1,45 @@
+require 'simple_serializer/serializer'
+require 'simple_serializer/deserializer'
+require 'active_support/inflector/methods'
+require 'active_support/core_ext/module/introspection'
+
+module Vorpal
+  module Dsl
+  class DefaultsGenerator
+    def initialize(domain_class, db_driver)
+      @domain_class = domain_class
+      @db_driver = db_driver
+    end
+
+    def build_db_class(user_table_name)
+      @db_driver.build_db_class(user_table_name || table_name)
+    end
+
+    def table_name
+      ActiveSupport::Inflector.tableize(@domain_class.name)
+    end
+
+    def serializer(attrs)
+      Class.new(SimpleSerializer::Serializer) do
+        hash_attributes *attrs
+      end
+    end
+
+    def deserializer(attrs)
+      Class.new(SimpleSerializer::Deserializer) do
+        object_attributes *attrs
+      end
+    end
+
+    def foreign_key(name)
+      ActiveSupport::Inflector.foreign_key(name.to_s)
+    end
+
+    def child_class(association_name)
+      # Module#parent comes from 'active_support/core_ext/module/introspection'
+      parent_module = @domain_class.parent
+      parent_module.const_get(ActiveSupport::Inflector.classify(association_name.to_s))
+    end
+  end
+  end
+end

data/lib/vorpal/exceptions.rb

@@ -2,4 +2,6 @@ module Vorpal
   class InvalidPrimaryKeyValue < StandardError; end
 
   class InvalidAggregateRoot < StandardError; end
-end
+
+  class ConfigurationNotFound < StandardError; end
+end

data/lib/vorpal/version.rb

@@ -1,3 +1,3 @@
 module Vorpal
-  VERSION = "0.1.0.rc1"
+  VERSION = "0.1.0.rc2"
 end

data/lib/vorpal.rb

@@ -1,5 +1,5 @@
 require "vorpal/version"
-require "vorpal/configuration"
+require "vorpal/dsl/configuration"
 
 # Allows easy creation of {Vorpal::Engine} instances.
 #
@@ -25,5 +25,5 @@ require "vorpal/configuration"
 # mapper = engine.mapper_for(Tree)
 # ```
 module Vorpal
-  extend Vorpal::Configuration
+  extend Vorpal::Dsl::Configuration
 end

data/spec/vorpal/acceptance/aggregate_mapper_spec.rb

@@ -858,7 +858,7 @@ private
     end
     engine.mapper_for(Tree)
   end
-  
+
   def configure(options={})
     engine = Vorpal.define(options) do
       map Tree do

data/spec/vorpal/integration/db_driver_spec.rb

@@ -0,0 +1,16 @@
+require 'integration_spec_helper'
+require 'vorpal'
+
+describe Vorpal::DbDriver do
+  describe '#build_db_class' do
+    let(:db_class) { subject.build_db_class('example') }
+
+    it 'generates a vald class name so that rails auto-reloading works' do
+      expect { Vorpal.const_defined?(db_class.name) }.to_not raise_error
+    end
+
+    it 'does not let the user access the generated class' do
+      expect { Vorpal.const_get(db_class.name) }.to raise_error(NameError)
+    end
+  end
+end

data/spec/vorpal/performance/performance_spec.rb

@@ -83,6 +83,13 @@ describe 'performance' do
   # update    2.240000   0.180000   2.420000 (  2.745321)
   # load      2.130000   0.020000   2.150000 (  2.223182)
   # destroy   0.930000   0.010000   0.940000 (  1.038624)
+  #
+  # Vorpal 0.1.0:
+  # user     system      total        real
+  # create    0.870000   0.100000   0.970000 (  1.320534)
+  # update    1.820000   0.210000   2.030000 (  2.351518)
+  # load      1.310000   0.010000   1.320000 (  1.394192)
+  # destroy   0.930000   0.010000   0.940000 (  1.030910)
   it 'benchmarks all operations' do
     trees = build_trees(1000)
     Benchmark.bm(7) do |x|
@@ -93,46 +100,46 @@ describe 'performance' do
     end
   end
 
-  it 'persists aggregates quickly' do
-    trees = build_trees(1000)
-
-    puts 'starting persistence benchmark'
-    puts Benchmark.measure {
-      tree_mapper.persist(trees)
-    }
-  end
-
-  it 'updates aggregates quickly' do
-    trees = build_trees(1000)
-
-    tree_mapper.persist(trees)
-
-    puts 'starting update benchmark'
-    puts Benchmark.measure {
-      tree_mapper.persist(trees)
-    }
-  end
-
-  it 'loads aggregates quickly' do
-    trees = build_trees(1000)
-    tree_mapper.persist(trees)
-    ids = trees.map(&:id)
-
-    puts 'starting loading benchmark'
-    puts Benchmark.measure {
-      tree_mapper.query.where(id: ids).load_many
-    }
-  end
-
-  it 'destroys aggregates quickly' do
-    trees = build_trees(1000)
-    tree_mapper.persist(trees)
-
-    puts 'starting destruction benchmark'
-    puts Benchmark.measure {
-      tree_mapper.destroy(trees)
-    }
-  end
+  # it 'creates aggregates quickly' do
+  #   trees = build_trees(1000)
+  #
+  #   puts 'starting persistence benchmark'
+  #   puts Benchmark.measure {
+  #     tree_mapper.persist(trees)
+  #   }
+  # end
+  #
+  # it 'updates aggregates quickly' do
+  #   trees = build_trees(1000)
+  #
+  #   tree_mapper.persist(trees)
+  #
+  #   puts 'starting update benchmark'
+  #   puts Benchmark.measure {
+  #     tree_mapper.persist(trees)
+  #   }
+  # end
+  #
+  # it 'loads aggregates quickly' do
+  #   trees = build_trees(1000)
+  #   tree_mapper.persist(trees)
+  #   ids = trees.map(&:id)
+  #
+  #   puts 'starting loading benchmark'
+  #   puts Benchmark.measure {
+  #     tree_mapper.query.where(id: ids).load_many
+  #   }
+  # end
+  #
+  # it 'destroys aggregates quickly' do
+  #   trees = build_trees(1000)
+  #   tree_mapper.persist(trees)
+  #
+  #   puts 'starting destruction benchmark'
+  #   puts Benchmark.measure {
+  #     tree_mapper.destroy(trees)
+  #   }
+  # end
 
   def build_trees(count)
     (1..count).map do |i|

data/spec/vorpal/unit/configs_spec.rb

@@ -49,6 +49,16 @@ describe Vorpal::MasterConfig do
     end
   end
 
+  describe 'nice user feedback' do
+    it 'lets the user know what the problem is when a configuration is missing' do
+      master_config = Vorpal::MasterConfig.new([])
+
+      expect {
+        master_config.config_for(String)
+      }.to raise_error(Vorpal::ConfigurationNotFound, "No configuration found for String")
+    end
+  end
+
   describe Vorpal::AssociationConfig do
     describe 'associate' do
       let(:post) { Post.new }
@@ -104,4 +114,4 @@ describe Vorpal::MasterConfig do
       end
     end
   end
-end
+end

data/spec/vorpal/unit/dsl/config_builder_spec.rb

@@ -0,0 +1,19 @@
+require 'unit_spec_helper'
+
+require 'vorpal/dsl/config_builder'
+require 'vorpal/db_driver'
+
+describe Vorpal::Dsl::ConfigBuilder do
+  class Tester; end
+
+  let(:builder) { Vorpal::Dsl::ConfigBuilder.new(Tester, {}, nil) }
+
+  describe 'mapping attributes' do
+    it 'allows the \'attributes\' method to be called multiple times' do
+      builder.attributes :first
+      builder.attributes :second
+
+      expect(builder.attributes_with_id).to eq([:id, :first, :second])
+    end
+  end
+end

data/spec/vorpal/unit/dsl/defaults_generator_spec.rb

@@ -0,0 +1,75 @@
+require 'unit_spec_helper'
+
+require 'vorpal/dsl/defaults_generator'
+require 'vorpal/db_driver'
+
+describe Vorpal::Dsl::DefaultsGenerator do
+  class Tester; end
+  class Author; end
+  module Namespace
+    class Tester; end
+    class Author; end
+  end
+
+  let(:db_driver) { instance_double(Vorpal::DbDriver)}
+
+  describe '#build_db_class' do
+    it 'derives the table_name from the domain class name' do
+      generator = build_generator(Tester)
+      expect(db_driver).to receive(:build_db_class).with("testers")
+
+      generator.build_db_class(nil)
+    end
+
+    it 'specifies the table_name manually' do
+      generator = build_generator(Tester)
+      expect(db_driver).to receive(:build_db_class).with("override")
+
+      generator.build_db_class("override")
+    end
+  end
+
+  describe '#table_name' do
+    it 'namespaces the table name' do
+      generator = build_generator(Namespace::Tester)
+
+      expect(generator.table_name).to eq("namespace/testers")
+    end
+  end
+
+  describe '#child_class' do
+    it 'resolves the associated class' do
+      generator = build_generator(Tester)
+      clazz = generator.child_class("author")
+
+      expect(clazz.name).to eq("Author")
+    end
+
+    it 'resolves the associated class in the same namespace as the owning class' do
+      generator = build_generator(Namespace::Tester)
+      clazz = generator.child_class("author")
+
+      expect(clazz.name).to eq("Namespace::Author")
+    end
+  end
+
+  describe '#foreign_key' do
+    it 'generates a foreign key from an association name' do
+      generator = build_generator(Tester)
+      fk_name = generator.foreign_key("author")
+
+      expect(fk_name).to eq("author_id")
+    end
+
+    it 'generates a foreign key from an association name regardless of the namespace of the owning class' do
+      generator = build_generator(Namespace::Tester)
+      fk_name = generator.foreign_key("author")
+
+      expect(fk_name).to eq("author_id")
+    end
+  end
+
+  def build_generator(domain_clazz)
+    Vorpal::Dsl::DefaultsGenerator.new(domain_clazz, db_driver)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vorpal
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc1
+  version: 0.1.0.rc2
 platform: ruby
 authors:
 - Sean Kirby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_serializer
@@ -144,6 +144,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -157,11 +158,12 @@ files:
 - lib/vorpal/aggregate_mapper.rb
 - lib/vorpal/aggregate_traversal.rb
 - lib/vorpal/aggregate_utils.rb
-- lib/vorpal/config_builder.rb
 - lib/vorpal/configs.rb
-- lib/vorpal/configuration.rb
 - lib/vorpal/db_driver.rb
 - lib/vorpal/db_loader.rb
+- lib/vorpal/dsl/config_builder.rb
+- lib/vorpal/dsl/configuration.rb
+- lib/vorpal/dsl/defaults_generator.rb
 - lib/vorpal/engine.rb
 - lib/vorpal/exceptions.rb
 - lib/vorpal/identity_map.rb
@@ -174,10 +176,12 @@ files:
 - spec/integration_spec_helper.rb
 - spec/unit_spec_helper.rb
 - spec/vorpal/acceptance/aggregate_mapper_spec.rb
+- spec/vorpal/integration/db_driver_spec.rb
 - spec/vorpal/performance/performance_spec.rb
-- spec/vorpal/unit/config_builder_spec.rb
 - spec/vorpal/unit/configs_spec.rb
 - spec/vorpal/unit/db_loader_spec.rb
+- spec/vorpal/unit/dsl/config_builder_spec.rb
+- spec/vorpal/unit/dsl/defaults_generator_spec.rb
 - spec/vorpal/unit/identity_map_spec.rb
 - spec/vorpal/unit/loaded_objects_spec.rb
 - vorpal.gemspec
@@ -211,9 +215,11 @@ test_files:
 - spec/integration_spec_helper.rb
 - spec/unit_spec_helper.rb
 - spec/vorpal/acceptance/aggregate_mapper_spec.rb
+- spec/vorpal/integration/db_driver_spec.rb
 - spec/vorpal/performance/performance_spec.rb
-- spec/vorpal/unit/config_builder_spec.rb
 - spec/vorpal/unit/configs_spec.rb
 - spec/vorpal/unit/db_loader_spec.rb
+- spec/vorpal/unit/dsl/config_builder_spec.rb
+- spec/vorpal/unit/dsl/defaults_generator_spec.rb
 - spec/vorpal/unit/identity_map_spec.rb
 - spec/vorpal/unit/loaded_objects_spec.rb

data/spec/vorpal/unit/config_builder_spec.rb

@@ -1,43 +0,0 @@
-require 'unit_spec_helper'
-
-require 'vorpal/config_builder'
-require 'vorpal/db_driver'
-
-describe Vorpal::ConfigBuilder do
-  class Tester; end
-
-  let(:builder) { Vorpal::ConfigBuilder.new(Tester, {}, nil) }
-
-  describe 'mapping attributes' do
-    it 'allows the \'attributes\' method to be called multiple times' do
-      builder.attributes :first
-      builder.attributes :second
-
-      expect(builder.attributes_with_id).to eq([:id, :first, :second])
-    end
-  end
-
-  describe 'table name' do
-    it 'is derived from the domain class name' do
-      builder = Vorpal::ConfigBuilder.new(A::B::C::Test, {}, nil)
-      expect(builder.table_name).to eq('a/b/c/tests')
-    end
-
-    it 'can be manually specified' do
-      builder = Vorpal::ConfigBuilder.new(Tester, {table_name: 'testing123'}, nil)
-      expect(builder.table_name).to eq('testing123')
-    end
-  end
-
-  private
-
-  module A
-    module B
-      module C
-        class Test
-
-        end
-      end
-    end
-  end
-end