trax_model 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a86c5949b3cd7f7ac7767f1dbf1a5b19dbc34d5
-  data.tar.gz: 98c3b79365a9481776921ccda2fa84de42e79627
+  metadata.gz: 7872fe10e5e8fcbe93b6897dd20c4b7da7890d1c
+  data.tar.gz: a3844a50a55a3a4d73699e5bddd8551539433e65
 SHA512:
-  metadata.gz: 98dad576741bcaad00821fe586117bf9259ca23c39c198e06d9a2ecf86b523a48d5dbe9a904257947dd9e4207451205d658acbe745cdf4b7c3e68279c640a2ae
-  data.tar.gz: 6f9ead4ee3ce3e17909e53d88c560542300cf65896c265bb58f9e3112b0e0fc3a7014406eb88c039bd000995e2c050167f3b7da283f0c8bfa04003efdee536c8
+  metadata.gz: 9c4010865a9e93b936268e272cc554e1f45fd6082688c165855d5472f7f08bd4ac114cd9aa589e0ac1c08de4936c86b8bc6f187cea7f2412e9683c4c046ec2e1
+  data.tar.gz: 6f33aa0545ab904bee6517f1b58216bbe9b37ef18afa0a46d8ea871d4ea11e6d99d93fbf53fe671ce5332492b2583eb61272fe75473efdbc41415afb25d1e5d4

data/README.md

@@ -58,6 +58,16 @@ bx rails c
 => "1a"
 ```
 
+### Or, register prefixes using dsl rather than in each individual class
+
+``` ruby
+
+Trax::Model::UUID.register do
+  prefix "1a", Product
+  prefix "1b", Category
+end
+```
+
 But wait theires more!
 
 ### UUID utility methods
@@ -140,18 +150,18 @@ end
 
 The main advantages of Multiple Table Inheritance versus Single Table inheritance I see are:
 
-1) Table size. As databases grow, vertically adding more length to traverse the table will continue to get slower. One way to mitigate this issue would be to split up your table into multiple horizontal tables, if it makes sense for your data structure to do so (i.e. like above)
+1. Table size. As databases grow, vertically adding more length to traverse the table will continue to get slower. One way to mitigate this issue would be to split up your table into multiple horizontal tables, if it makes sense for your data structure to do so (i.e. like above)
 
-2) STI will get out of proportion likely. I.e. if 90% of your posts are text posts, then when you are looking for a video post, you are to some degree being slowed down by the video posts in your table. (or at least at some point when you reach past xxxxxx number of records)
+2. STI will get out of proportion likely. I.e. if 90% of your posts are text posts, then when you are looking for a video post, you are to some degree being slowed down by the video posts in your table. (or at least at some point when you reach past xxxxxx number of records)
 
-3) Further on that note, only storing what you need for each individual subset of your data, on that particular subset. I.e. if video post has a video_url attribute, but none of the other post types have that, it will keep holes out of your data tables since video_url is only on the video_posts table.
+3. Further on that note, only storing what you need for each individual subset of your data, on that particular subset. I.e. if video post has a video_url attribute, but none of the other post types have that, it will keep holes out of your data tables since video_url is only on the video_posts table.
 
-4) Real separation at the data level of non common attributes, so you dont have to write safeguards in child classes to make sure that a value didnt slip into a field or whatever, because each child class has its own individual interpretation of the schema.
+4. Real separation at the data level of non common attributes, so you dont have to write safeguards in child classes to make sure that a value didnt slip into a field or whatever, because each child class has its own individual interpretation of the schema.
 
 The main disadvantages are:
 
-1) No shared view between child types. I.E. thats what the MTI entity is for. (want to find all blog posts? You cant unless you select a type first, or are using this gem, or a postgres view or something else)
-2) More difficult to setup since each child table needs its own table.
+1. No shared view between child types. I.E. thats what the MTI entity is for. (want to find all blog posts? You cant unless you select a type first, or are using this gem, or a postgres view or something else)
+2. More difficult to setup since each child table needs its own table.
 
 
 ## Installation

data/lib/trax/model.rb

@@ -15,6 +15,7 @@ module Trax
     extend ::ActiveSupport::Autoload
 
     autoload :Config
+    autoload :Errors
     autoload :Freezable
     autoload :Registry
     autoload :UUID

data/lib/trax/model/config.rb

@@ -4,8 +4,7 @@ module Trax
       ERROR_MESSAGES = {
         :invalid_uuid_prefix => [
           "UUID prefix must be 2 characters long",
-          "First Character must be an integer 0-9",
-          "Second character must be a letter a-f",
+          "and be 0-9 or a-f",
           "for hexadecimal id compatibility"
         ].join("\n")
       }.freeze
@@ -14,8 +13,8 @@ module Trax
       property :uuid_column, :default => :id
 
       def uuid_prefix=(prefix)
-        if prefix.length != 2 || prefix.chars.first !~ /[0-9]/ || prefix.chars.last !~ /[a-f]/
-          raise ERROR_MESSAGES[:invalid_uuid_prefix]
+        if prefix.length != 2 || prefix.chars.any?{|char| char !~ /[0-9a-f]/ }
+          raise ::Trax::Model::Errors::InvalidPrefixForUUID.new(prefix)
         end
 
         self[:uuid_prefix] = ::Trax::Model::UUIDPrefix.new(prefix)

data/lib/trax/model/errors.rb

@@ -0,0 +1,27 @@
+module Trax
+  module Model
+    module Errors
+      class Base < StandardError
+        def initialize(*args)
+          message = (self.class::MESSAGE + args).join("\n")
+          super(message)
+        end
+      end
+
+      class InvalidPrefix < Trax::Model::Errors::Base
+        MESSAGE = [
+          "UUID prefix must be 2 characters long",
+          "and be 0-9 or a-f",
+          "for hexadecimal id compatibility"
+        ]
+      end
+
+      class DuplicatePrefixRegistered < Trax::Model::Errors::Base
+        MESSAGE = [
+          "UUID prefix must be unique, the",
+          "following prefix was already registered"
+        ]
+      end
+    end
+  end
+end

data/lib/trax/model/mti/entity.rb

@@ -10,6 +10,20 @@ module Trax
           scope :records, lambda{
             map(&:entity)
           }
+
+          scope :fully_loaded, lambda{
+            relation = current_scope.dup
+            entity_ids = relation.pluck(:id)
+            entity_types = entity_ids.map { |id| ::Trax::Model::UUID.new(id[0..1]) }
+                                     .map(&:record_type)
+                                     .flatten
+                                     .compact
+                                     .uniq
+
+            relation_names = entity_types.map{ |type| :"#{type.name.demodulize.underscore}_entity" }
+
+            current_scope.includes(relation_names).references(relation_names)
+          }
         end
 
         def model_type
@@ -29,20 +43,6 @@ module Trax
         end
 
         module ClassMethods
-          def all
-            relation = super
-            entity_ids = relation.pluck(:id)
-            entity_types = entity_ids.map { |id| ::Trax::Model::UUID.new(id[0..1]) }
-                                     .map(&:record_type)
-                                     .flatten
-                                     .compact
-                                     .uniq
-
-            relation_names = entity_types.map{ |type| :"#{type.name.demodulize.underscore}_entity" }
-
-            relation.includes(relation_names).references(relation_names)
-          end
-
           def mti_namespace(namespace)
             _mti_namespace = (namespace.is_a?(String)) ? namespace.constantize : namespace
 
@@ -55,7 +55,6 @@ module Trax
           def multiple_table_inheritance_namespace(namespace)
             mti_namespace(namespace)
           end
-
         end
       end
     end

data/lib/trax/model/unique_id.rb

@@ -3,17 +3,16 @@ module Trax
     module UniqueId
       extend ::ActiveSupport::Concern
 
-      ERROR_MESSAGES = {
-        :invalid_uuid_prefix => [
-          "UUID prefix must be 2 characters long",
-          "and can only include a-f0-9",
-          "for hexadecimal id compatibility"
-        ].join("\n")
-      }.freeze
+      included do
+        #grab prefix from uuid registry if using that
+        if ::Trax::Model::UUID.klass_prefix_map.has_key?(self.name)
+          self.trax_defaults.uuid_prefix = ::Trax::Model::UUIDPrefix.new(klass_prefix_map[self.name])
+        end
+      end
 
       def uuid
         uuid_column = self.class.trax_defaults.uuid_column
-        uuid_value = (uuid_column == :uuid) ? super : __send__(uuid_column)
+        uuid_value = (uuid_column == "uuid") ? super : __send__(uuid_column)
 
         ::Trax::Model::UUID.new(uuid_value)
       end

data/lib/trax/model/uuid.rb

@@ -1,12 +1,32 @@
 module Trax
   module Model
     class UUID < String
+      class_attribute :prefix_map
+
+      self.prefix_map = ::Hashie::Mash.new
+
+      def self.klass_prefix_map
+        prefix_map.invert
+      end
+
       def self.generate(prefix = nil)
         uuid = ::SecureRandom.uuid
         uuid[0..1] = prefix if prefix
         uuid
       end
 
+      def self.prefix(prefix_value, klass)
+        if prefix_map.has_key(:"#{prefix_value}") && prefix_map[:"#{prefix_value}"] == klass
+          raise ::Trax::Model::Errors::DuplicatePrefix.new(prefix_value)
+        end
+
+        prefix_map[:"#{prefix_value}"] = klass
+      end
+
+      def self.register(&block)
+        instance_exec(&block)
+      end
+
       def record
         @record ||= record_type ? record_type.find_by(:"#{record_type.uuid_column}" => self) : nil
       end

data/lib/trax/model/uuid_prefix.rb

@@ -3,50 +3,19 @@ module Trax
     class UUIDPrefix < String
       HEX_LETTER_RANGE = ('a'..'f').to_a.freeze
       HEX_DIGIT_RANGE = (0..9).to_a.freeze
-      #9f = 96 so we need to begin at 96 when mapping back down [str,int]
-      DIVIDING_VALUE = 96
+      CHARACTER_RANGE = (HEX_DIGIT_RANGE + HEX_LETTER_RANGE).freeze
+      PREFIX_LENGTH = 2
 
       def self.all
         @all ||= begin
-          lower_value_prefixes = HEX_DIGIT_RANGE.map do |digit|
-            values = HEX_LETTER_RANGE.map do |character|
-              prefix = [digit, character].join
-              new(prefix)
-            end
-
-            values
+          CHARACTER_RANGE.repeated_permutation(PREFIX_LENGTH).to_a.reject! do |permutation|
+              (HEX_LETTER_RANGE.include?(permutation[0]) && HEX_LETTER_RANGE.include?(permutation[1]) || HEX_DIGIT_RANGE.include?(permutation[0]) && HEX_DIGIT_RANGE.include?(permutation[1]))
+          end.uniq.map do |character_array|
+            new(character_array.join)
           end
-
-          higher_value_prefixes = HEX_LETTER_RANGE.map do |digit|
-            values = HEX_DIGIT_RANGE.map do |character|
-              prefix = [digit, character].join
-              new(prefix)
-            end
-
-            values
-          end
-
-          [lower_value_prefixes, higher_value_prefixes].flatten!.sort!
         end
       end
 
-      def self.build_from_integer(value)
-        value_str = "#{value}"
-        return new([value_str.chars.first.to_i, HEX_LETTER_RANGE[value_str.chars.last.to_i]].join)
-      end
-
-      def <=>(comparison_prefix)
-        self.to_i <=> comparison_prefix.to_i
-      end
-
-      def in_higher_partition?
-        "#{self}"[0] =~ /[a-f]/
-      end
-
-      def in_lower_partition?
-        !in_higher_partition?
-      end
-
       def index
         self.class.all.index(self)
       end
@@ -59,19 +28,6 @@ module Trax
         self.class.all.at(index - 1)
       end
 
-      def to_digits
-        digits = self.chars.map do |character|
-          (character.downcase =~ /[a-f]/ ? HEX_LETTER_RANGE.index(character.downcase) : character)
-        end
-
-        #kind of wonky but multiply by 2 will ensure the letter prefixes begin with a higher value
-        in_higher_partition? ? "#{((digits.join.to_i + DIVIDING_VALUE * 2))}".chars : digits
-      end
-
-      def to_i
-        return self.to_digits.join.to_i
-      end
-
       def to_s
         "#{self}"
       end

data/lib/trax_model/version.rb

@@ -1,3 +1,3 @@
 module TraxModel
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/spec/support/schema.rb

@@ -48,6 +48,13 @@ ActiveRecord::Schema.define(:version => 1) do
     t.datetime "created_at",        :null => false
     t.datetime "updated_at",        :null => false
   end
+
+  create_table "people", :force => true do |t|
+    t.string "name"
+    t.string "uuid"
+    t.datetime "created_at",        :null => false
+    t.datetime "updated_at",        :null => false
+  end
 end
 
 class Product < ::ActiveRecord::Base
@@ -87,5 +94,11 @@ end
 class Thing < ::ActiveRecord::Base
   include ::Trax::Model
 
-  defaults :uuid_prefix => "0a", :uuid_column => "uuid"
+  defaults :uuid_prefix => "4a", :uuid_column => "uuid"
+end
+
+class Person < ::ActiveRecord::Base
+  include ::Trax::Model
+
+  defaults :uuid_column => "uuid"
 end

data/spec/trax/model/errors_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe ::Trax::Model::Errors do
+  subject{ Trax::Model::Errors::InvalidPrefix }
+
+  it do
+    expect{raise subject.new("blah")}.to raise_error(subject, /blah/)
+  end
+
+end

data/spec/trax/model/uuid_prefix_spec.rb

@@ -1,26 +1,12 @@
 require 'spec_helper'
 describe ::Trax::Model::UUIDPrefix do
-  subject{ Trax::Model::UUIDPrefix.new('1a') }
-
-  describe "#to_i" do
-    {"1a" => 10, "2a" => 20, "9e" => 94, "8d" => 83, "0a" => 0, "0b" => 1, "f9" => 251}.each_pair do |prefix_string, assertion|
-      it "#{prefix_string} should eq #{assertion}" do
-        prefix = ::Trax::Model::UUIDPrefix.new(prefix_string)
-
-        prefix.to_i.should eq assertion
-      end
-    end
-  end
+  subject{ described_class.new('1a') }
 
   describe ".all" do
-    it { described_class.all.should include("9a") }
-    it { described_class.all.length.should eq 120 }
-  end
-
-  describe ".build_from_integer" do
-    it { described_class.build_from_integer(10).should eq "1a" }
+    it { described_class.all.should include("a1") }
+    it { described_class.all.first.should eq "0a" }
+    it { described_class.all.last.should eq "f9" }
   end
-
   describe "#next" do
     let(:test_subject) { Product.uuid_prefix }
 
@@ -37,12 +23,4 @@ describe ::Trax::Model::UUIDPrefix do
 
     it { test_subject.previous.should eq '0f' }
   end
-
-  describe "#to_i" do
-    context "when prefix in {int,str} order" do
-      let(:test_subject) { Product.uuid_prefix }
-
-      it { test_subject.to_i.should eq 10 }
-    end
-  end
 end

data/spec/trax/model/uuid_spec.rb

@@ -4,9 +4,20 @@ describe ::Trax::Model::UUID do
   let(:product) { ::Product.create(:name => "iMac") }
   subject{ product.uuid }
 
+  context "dsl register methods" do
+    before do
+      ::Trax::Model::UUID.register do
+        prefix "9a", ::Person
+      end
+    end
+
+    it { described_class.prefix_map.should have_key("9a") }
+    it { described_class.klass_prefix_map.should have_key(Person) }
+  end
+
   its(:record_type) { should eq ::Product }
   its(:record) { should eq product }
-  
+
   describe ".generate" do
     context "with prefix" do
       let(:prefixed_uuid) { described_class.generate("1a") }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trax_model
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jason Ayre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2014-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trax_core
@@ -266,6 +266,7 @@ files:
 - lib/trax.rb
 - lib/trax/model.rb
 - lib/trax/model/config.rb
+- lib/trax/model/errors.rb
 - lib/trax/model/freezable.rb
 - lib/trax/model/matchable.rb
 - lib/trax/model/mti.rb
@@ -288,6 +289,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/schema.rb
 - spec/trax/model/config_spec.rb
+- spec/trax/model/errors_spec.rb
 - spec/trax/model/freezable_spec.rb
 - spec/trax/model/matchable_spec.rb
 - spec/trax/model/registry_spec.rb
@@ -329,6 +331,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/schema.rb
 - spec/trax/model/config_spec.rb
+- spec/trax/model/errors_spec.rb
 - spec/trax/model/freezable_spec.rb
 - spec/trax/model/matchable_spec.rb
 - spec/trax/model/registry_spec.rb