vorpal 0.1.0.rc2 → 0.1.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69f36cf61329620f00d5afc82600cb4827072f34
-  data.tar.gz: 2d750d2d81bc23bab69d7491842815bc3a528662
+  metadata.gz: 824912a10087771cda48b9ad66dac75861e80bb1
+  data.tar.gz: 67ff5e87b3e45c8308866036e79cfb83ae5959d8
 SHA512:
-  metadata.gz: 05c571066a636c8ac35e802ed6f27385af70ab22973c10641216e64f122f5c1e9d8776acace14693f4ed559dc1c6ad74d9566449385f7a697b471c786761866a
-  data.tar.gz: 61e7fdb650dfc01c9ec66e59d388ee60fd52411bbe190fd8e79df62ea35340acd3ad63c8f967374a03068ef2cbb0beb6839720bbbd0187a8ab4d60a18a518676
+  metadata.gz: 3db514381c185a0dc4b9b4a408ca35b34a244bb1fe97e899ff1b89ebb84d14cd20d5159c2a459316d77c1e3b4d81e4529e0ff110d02dfdece3f06817531653b1
+  data.tar.gz: 5437e2611a1ae1e75b1143cd1f9732429fa9acb0fb5e11fc105e60bb7d0330fe4e23021ca7c63b676758977fedeafaed2b39f26be24f83b1f431fc5c7ab1a0b2

data/README.md

@@ -1,4 +1,4 @@
-# Vorpal
+# Vorpal [![Build Status](https://travis-ci.org/nulogy/vorpal.svg?branch=master)](https://travis-ci.org/nulogy/vorpal) [![Code Climate](https://codeclimate.com/github/nulogy/vorpal/badges/gpa.svg)](https://codeclimate.com/github/nulogy/vorpal)
 
 Separate your domain model from your persistence mechanism. Some problems call for a really sharp tool.
 

data/lib/vorpal/configs.rb

@@ -266,7 +266,7 @@ module Vorpal
 
   # @private
   class HasManyConfig
-    include HashInitialization
+    include Util::HashInitialization
     include RemoteEndConfig
     include ToManyConfig
 
@@ -276,7 +276,7 @@ module Vorpal
 
   # @private
   class HasOneConfig
-    include HashInitialization
+    include Util::HashInitialization
     include RemoteEndConfig
     include ToOneConfig
 
@@ -286,7 +286,7 @@ module Vorpal
 
   # @private
   class BelongsToConfig
-    include HashInitialization
+    include Util::HashInitialization
     include LocalEndConfig
     include ToOneConfig
 

data/lib/vorpal/db_driver.rb

@@ -1,3 +1,5 @@
+require 'vorpal/util/string_utils.rb'
+
 module Vorpal
   # Interface between the database and Vorpal
   #
@@ -57,27 +59,33 @@ module Vorpal
 
     # Builds an ORM Class for accessing data in the given DB table.
     #
+    # @param model_class [Class] The PORO class that we are creating a DB interface class for.
     # @param table_name [String] Name of the DB table the DB class should interface with.
     # @return [Class] ActiveRecord::Base Class
-    def build_db_class(table_name)
+    def build_db_class(model_class, table_name)
       db_class = Class.new(ActiveRecord::Base) do
-        # This is overridden for two reasons:
-        # 1) For anonymous classes, #name normally returns nil. Class names in Ruby come from the
-        #   name of the constant they are assigned to.
-        # 2) Because the default implementation for Class#name for anonymous classes is very, very
-        #   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}"
-        end
-
-        # Overridden because, like #name, the default implementation for anonymous classes is very,
-        # very slow.
-        def self.to_s
-          name
+        class << self
+          # This is overridden for two reasons:
+          # 1) For anonymous classes, #name normally returns nil. Class names in Ruby come from the
+          #   name of the constant they are assigned to.
+          # 2) Because the default implementation for Class#name for anonymous classes is very, very
+          #   slow. https://bugs.ruby-lang.org/issues/11119
+          # Remove this override once #2 has been fixed!
+          def name
+            @name ||= "Vorpal_generated_ActiveRecord__Base_class_for_#{vorpal_model_class_name}"
+          end
+
+          # Overridden because, like #name, the default implementation for anonymous classes is very,
+          # very slow.
+          def to_s
+            name
+          end
+
+          attr_accessor :vorpal_model_class_name
         end
       end
 
+      db_class.vorpal_model_class_name = Util::StringUtils.escape_class_name(model_class.name)
       db_class.table_name = table_name
       db_class
     end

data/lib/vorpal/db_loader.rb

@@ -72,7 +72,7 @@ module Vorpal
 
   # @private
   class LookupInstructions
-    include ArrayHash
+    include Util::ArrayHash
     def initialize
       @lookup_by_id = {}
       @lookup_by_fk = {}

data/lib/vorpal/dsl/config_builder.rb

@@ -124,4 +124,4 @@ module Vorpal
     end
   end
   end
-end
+end

data/lib/vorpal/dsl/defaults_generator.rb

@@ -12,7 +12,7 @@ module Vorpal
     end
 
     def build_db_class(user_table_name)
-      @db_driver.build_db_class(user_table_name || table_name)
+      @db_driver.build_db_class(@domain_class, user_table_name || table_name)
     end
 
     def table_name
@@ -42,4 +42,4 @@ module Vorpal
     end
   end
   end
-end
+end

data/lib/vorpal/loaded_objects.rb

@@ -5,7 +5,7 @@ module Vorpal
 
   # @private
   class LoadedObjects
-    include ArrayHash
+    include Util::ArrayHash
     extend Forwardable
     include Enumerable
 

data/lib/vorpal/util/array_hash.rb

@@ -1,17 +1,19 @@
 module Vorpal
-  # @private
-  module ArrayHash
-    def add_to_hash(array_hash, key, values)
-      if array_hash[key].nil? || array_hash[key].empty?
-        array_hash[key] = []
+  module Util
+    # @private
+    module ArrayHash
+      def add_to_hash(array_hash, key, values)
+        if array_hash[key].nil? || array_hash[key].empty?
+          array_hash[key] = []
+        end
+        array_hash[key].concat(Array(values))
       end
-      array_hash[key].concat(Array(values))
-    end
 
-    def pop(array_hash)
-      key = array_hash.first.first
-      values = array_hash.delete(key)
-      [key, values]
+      def pop(array_hash)
+        key = array_hash.first.first
+        values = array_hash.delete(key)
+        [key, values]
+      end
     end
   end
 end

data/lib/vorpal/util/hash_initialization.rb

@@ -1,9 +1,11 @@
 module Vorpal
-  # @private
-  module HashInitialization
-    def initialize(attrs)
-      attrs.each do |k,v|
-        instance_variable_set("@#{k}", v)
+  module Util
+    # @private
+    module HashInitialization
+      def initialize(attrs)
+        attrs.each do |k,v|
+          instance_variable_set("@#{k}", v)
+        end
       end
     end
   end

data/lib/vorpal/util/string_utils.rb

@@ -0,0 +1,15 @@
+module Vorpal
+  module Util
+    # @private
+    module StringUtils
+      extend self
+
+      # Escapes the name of a class so that it can be embedded into the name
+      # of another class. This means that the result should always be `#const_defined?`
+      # friendly.
+      def escape_class_name(class_name)
+        class_name.gsub("::", "__")
+      end
+    end
+  end
+end

data/lib/vorpal/version.rb

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

data/spec/vorpal/integration/db_driver_spec.rb

@@ -3,14 +3,40 @@ require 'vorpal'
 
 describe Vorpal::DbDriver do
   describe '#build_db_class' do
-    let(:db_class) { subject.build_db_class('example') }
+    let(:db_class) { subject.build_db_class(DbDriverSpec::Foo, 'example') }
 
-    it 'generates a vald class name so that rails auto-reloading works' do
+    it 'generates a valid 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
+
+    it 'isolates two POROs that map to the same db table' do
+      db_class1 = build_db_class(DbDriverSpec::Foo)
+      db_class2 = build_db_class(DbDriverSpec::Bar)
+
+      expect(db_class1).to_not eq(db_class2)
+      expect(db_class1.name).to_not eq(db_class2.name)
+    end
+
+    it 'uses the model class name to make the generated AR::Base class name unique' do
+      db_class = build_db_class(DbDriverSpec::Foo)
+
+      expect(db_class.name).to match("DbDriverSpec__Foo")
+    end
+  end
+
+  private
+
+  module DbDriverSpec
+    class Foo; end
+    class Bar; end
+  end
+
+  def build_db_class(clazz)
+    db_driver = Vorpal::DbDriver.new
+    db_driver.build_db_class(clazz, 'example')
   end
 end

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

@@ -16,14 +16,14 @@ describe Vorpal::Dsl::DefaultsGenerator do
   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")
+      expect(db_driver).to receive(:build_db_class).with(Tester, "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")
+      expect(db_driver).to receive(:build_db_class).with(Tester, "override")
 
       generator.build_db_class("override")
     end

data/spec/vorpal/unit/util/string_utils_spec.rb

@@ -0,0 +1,25 @@
+require 'unit_spec_helper'
+require 'vorpal/util/string_utils'
+
+describe Vorpal::Util::StringUtils do
+
+  describe '.escape_class_name' do
+    it 'does nothing when there are no :: in the class name' do
+      expect(escape_class_name("Foo")).to eq("Foo")
+    end
+
+    it 'converts :: into __' do
+      expect(escape_class_name("Foo::Bar")).to eq("Foo__Bar")
+    end
+
+    it 'converts multiple :: into __' do
+      expect(escape_class_name("Foo::Bar::Baz")).to eq("Foo__Bar__Baz")
+    end
+  end
+
+  private
+
+  def escape_class_name(class_name)
+    Vorpal::Util::StringUtils.escape_class_name(class_name)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vorpal
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc2
+  version: 0.1.0.rc3
 platform: ruby
 authors:
 - Sean Kirby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_serializer
@@ -170,6 +170,7 @@ files:
 - lib/vorpal/loaded_objects.rb
 - lib/vorpal/util/array_hash.rb
 - lib/vorpal/util/hash_initialization.rb
+- lib/vorpal/util/string_utils.rb
 - lib/vorpal/version.rb
 - spec/helpers/db_helpers.rb
 - spec/helpers/profile_helpers.rb
@@ -184,6 +185,7 @@ files:
 - spec/vorpal/unit/dsl/defaults_generator_spec.rb
 - spec/vorpal/unit/identity_map_spec.rb
 - spec/vorpal/unit/loaded_objects_spec.rb
+- spec/vorpal/unit/util/string_utils_spec.rb
 - vorpal.gemspec
 homepage: https://github.com/nulogy/vorpal
 licenses:
@@ -223,3 +225,4 @@ test_files:
 - spec/vorpal/unit/dsl/defaults_generator_spec.rb
 - spec/vorpal/unit/identity_map_spec.rb
 - spec/vorpal/unit/loaded_objects_spec.rb
+- spec/vorpal/unit/util/string_utils_spec.rb