nobrainer 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22202d66d5f511c228b92b0a93df97628dd2ad6d
-  data.tar.gz: 28b596c4b83b83300add95b5f9971e4a3c9ceaf8
+  metadata.gz: cc50cb3ae605543bb7ed3df448d0ff32d3b984d4
+  data.tar.gz: b8ae438c48a0d64408f4966f92002be17f6cdff0
 SHA512:
-  metadata.gz: df558fdce2a60deee0e500766a7963769ea6514fb1f97d6129c7d49eb66579f3b45990d9dca0b2506e0e8bb55940a826d1acf33e97233b8162cd4b53ec377862
-  data.tar.gz: 59ef60554676a4eff6919a3168d91803a6c11897cfa7073d52da262c4047640d7de6879a062c086994ea0a6f7fec4e56804ce6b46f444a86777c8151bbc667f5
+  metadata.gz: 118724ce72e1c29432aa208b062f9e107b56dc0401d921f5194708a2c3f2b7a95160572cf2cd83cb22f322cad0fb7cfe3939fdccf8eb6ef401da99f975df275b
+  data.tar.gz: 2d5737b1035583abd7f888f61341b0922d85e654b919aee2c282be2fcd07bb144f3654ef76ad2d016289b5692766d72d7d0e7620f8d13a6923d054acab49de91

data/lib/no_brainer/autoload.rb

@@ -14,7 +14,7 @@ module NoBrainer::Autoload
   end
 
   def autoload_and_include(*constants)
-    constants.each { |constant| autoload constant }
+    autoload(*constants)
     constants.each { |constant| include const_get(constant) }
   end
 end

data/lib/no_brainer/config.rb

@@ -14,7 +14,7 @@ module NoBrainer::Config
     :user_timezone          => { :default => ->{ :local }, :valid_values => [:unchanged, :utc, :local] },
     :db_timezone            => { :default => ->{ :utc }, :valid_values => [:unchanged, :utc, :local] },
     :geo_options            => { :default => ->{ {:geo_system => 'WGS84', :unit => 'm'} } },
-    :distributed_lock_class => { :default => ->{ NoBrainer::Lock } },
+    :distributed_lock_class => { :default => ->{ "NoBrainer::Lock" } },
     :lock_options           => { :default => ->{ { :expire => 60, :timeout => 10 } } },
     :per_thread_connection  => { :default => ->{ false }, :valid_values => [true, false] },
     :machine_id             => { :default => ->{ default_machine_id } },
@@ -58,7 +58,7 @@ module NoBrainer::Config
       assert_valid_options
       @configured = true
 
-      NoBrainer::ConnectionManager.disconnect_if_url_changed
+      NoBrainer::ConnectionManager.notify_url_change
     end
 
     def configured?
@@ -107,18 +107,23 @@ module NoBrainer::Config
       dev_mode? ? 1 : 15
     end
 
+    # XXX Not referencing NoBrainer::Document::PrimaryKey::Generator::MACHINE_ID_MASK
+    # because we don't want to load all the document code to speedup boot time.
+    MACHINE_ID_BITS = 24
+    MACHINE_ID_MASK = (1 << MACHINE_ID_BITS)-1
+
     def default_machine_id
+      return ENV['MACHINE_ID'] if ENV['MACHINE_ID']
+
       require 'socket'
       require 'digest/md5'
 
-      return ENV['MACHINE_ID'] if ENV['MACHINE_ID']
-
       host = Socket.gethostname
       if host.in? %w(127.0.0.1 localhost)
         raise "Please configure NoBrainer::Config.machine_id due to lack of appropriate hostname (Socket.gethostname = #{host})"
       end
 
-      Digest::MD5.digest(host).unpack("N")[0] & NoBrainer::Document::PrimaryKey::Generator::MACHINE_ID_MASK
+      Digest::MD5.digest(host).unpack("N")[0] & MACHINE_ID_MASK
     end
 
     def machine_id=(machine_id)
@@ -127,9 +132,16 @@ module NoBrainer::Config
         when /^[0-9]+$/ then machine_id.to_i
         else raise "Invalid machine_id"
       end
-      max_id = NoBrainer::Document::PrimaryKey::Generator::MACHINE_ID_MASK
+      max_id = MACHINE_ID_MASK
       raise "Invalid machine_id (must be between 0 and #{max_id})" unless machine_id.in?(0..max_id)
       @machine_id = machine_id
     end
+
+    def distributed_lock_class
+      if @distributed_lock_class.is_a?(String)
+        @distributed_lock_class = @distributed_lock_class.constantize
+      end
+      @distributed_lock_class
+    end
   end
 end

data/lib/no_brainer/connection_manager.rb

@@ -71,7 +71,7 @@ module NoBrainer::ConnectionManager
     synchronize { _disconnect }
   end
 
-  def disconnect_if_url_changed
+  def notify_url_change
     synchronize do
       c = current_connection
       _disconnect if c && c.uri != NoBrainer::Config.rethinkdb_url

data/lib/no_brainer/criteria/where.rb

@@ -1,12 +1,4 @@
 module NoBrainer::Criteria::Where
-  NON_CHAINABLE_OPERATORS = %w(in eq gt ge gte lt le lte defined near intersects).map(&:to_sym)
-  CHAINABLE_OPERATORS = %w(not any all).map(&:to_sym)
-  OPERATORS = CHAINABLE_OPERATORS + NON_CHAINABLE_OPERATORS
-
-  require 'symbol_decoration'
-  Symbol::Decoration.register(*NON_CHAINABLE_OPERATORS)
-  Symbol::Decoration.register(*CHAINABLE_OPERATORS, :chainable => true)
-
   extend ActiveSupport::Concern
   include ActiveModel::ForbiddenAttributesProtection
 

data/lib/no_brainer/document/association.rb

@@ -28,11 +28,11 @@ module NoBrainer::Document::Association
           raise "Cannot change the :through option" unless r.options[:through] == options[:through]
           r.options.merge!(options)
         else
-          model_name = (options[:through] ? "#{association}_through" : association.to_s).camelize
-          metadata_model = NoBrainer::Document::Association.const_get(model_name).const_get(:Metadata)
-          r = metadata_model.new(self, target, options)
-          ([self] + descendants).each do |model|
-            model.association_metadata[target] = r
+          class_name = (options[:through] ? "#{association}_through" : association.to_s).camelize
+          metadata_class = NoBrainer::Document::Association.const_get(class_name).const_get(:Metadata)
+          r = metadata_class.new(self, target, options)
+          subclass_tree.each do |subclass|
+            subclass.association_metadata[target] = r
           end
         end
         r.hook

data/lib/no_brainer/document/association/belongs_to.rb

@@ -11,7 +11,22 @@ class NoBrainer::Document::Association::BelongsTo
     end
 
     def primary_key
-      options[:primary_key].try(:to_sym) || target_model.pk_name
+      # We default the primary_key to `:id' and not `target_model.pk_name',
+      # because we don't want to require the target_model to be already loaded.
+      # (We want the ability to load models in any order).
+      # Using target_model.pk_name and allowing lazy loading of models is
+      # difficult due to the inexistant API to remove validations if the
+      # foreign_key name was to be changed as the pk_name gets renamed.
+      return options[:primary_key].to_sym if options[:primary_key]
+
+      NoBrainer::Document::PrimaryKey::DEFAULT_PK_NAME.tap do |default_pk_name|
+        # We'll try to give a warning when we see a different target pk name (best effort).
+        real_pk_name = target_model.pk_name rescue nil
+        if real_pk_name && real_pk_name != default_pk_name
+          raise "Please specify the primary_key name on the following belongs_to association as such:\n" +
+                "  belongs_to :#{target_name}, :primary_key => :#{real_pk_name}"
+        end
+      end
     end
 
     def target_model
@@ -24,11 +39,6 @@ class NoBrainer::Document::Association::BelongsTo
 
     def hook
       super
-      # XXX We are loading the target_model unless the primary_key is specified.
-      # This may eager load a part of the application  Oh well.
-
-      # TODO if the primary key of the target_model changes, we need to revisit
-      # our default foreign_key/primary_key value
 
       # TODO set the type of the foreign key to be the same as the target's primary key
       if owner_model.association_metadata.values.any? { |assoc|
@@ -74,7 +84,7 @@ class NoBrainer::Document::Association::BelongsTo
     return target if loaded?
 
     if fk = owner.read_attribute(foreign_key)
-      preload(target_model.unscoped.where(primary_key => fk).first)
+      preload(base_criteria.where(primary_key => fk).first)
     end
   end
 

data/lib/no_brainer/document/association/eager_loader.rb

@@ -33,7 +33,6 @@ class NoBrainer::Document::Association::EagerLoader
     docs = docs.compact
     return [] if docs.empty?
     meta = docs.first.root_class.association_metadata
-    # TODO test the singularize thingy.
     association = meta[association_name.to_sym] || meta[association_name.to_s.singularize.to_sym]
     raise "Unknown association #{association_name}" unless association
     association.eager_load(docs, criteria)

data/lib/no_brainer/document/attributes.rb

@@ -1,8 +1,9 @@
 module NoBrainer::Document::Attributes
   VALID_FIELD_OPTIONS = [:index, :default, :type, :readonly, :primary_key, :lazy_fetch, :store_as,
                          :validates, :required, :unique, :uniq, :format, :in, :length, :min_length, :max_length]
-  RESERVED_FIELD_NAMES = [:index, :default, :and, :or, :selector, :associations, :pk_value] \
-                          + NoBrainer::Criteria::Where::OPERATORS
+  RESERVED_FIELD_NAMES = [:index, :default, :and, :or, :selector, :associations, :pk_value] +
+                          NoBrainer::SymbolDecoration::OPERATORS
+
   extend ActiveSupport::Concern
   include ActiveModel::ForbiddenAttributesProtection
 
@@ -129,9 +130,9 @@ module NoBrainer::Document::Attributes
         raise "Cannot use a reserved field attr: #{attr}"
       end
 
-      ([self] + descendants).each do |model|
-        model.fields[attr] ||= {}
-        model.fields[attr].deep_merge!(options)
+      subclass_tree.each do |subclass|
+        subclass.fields[attr] ||= {}
+        subclass.fields[attr].deep_merge!(options)
       end
 
       _field(attr, self.fields[attr])
@@ -149,8 +150,8 @@ module NoBrainer::Document::Attributes
 
       _remove_field(attr, options)
 
-      ([self] + descendants).each do |model|
-        model.fields.delete(attr)
+      subclass_tree.each do |subclass|
+        subclass.fields.delete(attr)
       end
     end
 

data/lib/no_brainer/document/criteria.rb

@@ -51,8 +51,8 @@ module NoBrainer::Document::Criteria
       criteria_proc = block || (criteria.is_a?(Proc) ? criteria : proc { criteria })
       raise "default_scope only accepts a criteria or a proc that returns criteria" unless criteria_proc.is_a?(Proc)
 
-      ([self] + self.descendants).each do |model|
-        model.default_scopes << criteria_proc
+      subclass_tree.each do |subclass|
+        subclass.default_scopes << criteria_proc
       end
     end
 

data/lib/no_brainer/document/lazy_fetch.rb

@@ -34,9 +34,9 @@ module NoBrainer::Document::LazyFetch
       model = self
       inject_in_layer :lazy_fetch do
         if options[:lazy_fetch]
-          model.for_each_subclass { |_model| _model.fields_to_lazy_fetch << attr }
+          model.subclass_tree.each { |subclass| subclass.fields_to_lazy_fetch << attr }
         else
-          model.for_each_subclass { |_model|  _model.fields_to_lazy_fetch.delete(attr) }
+          model.subclass_tree.each { |subclass| subclass.fields_to_lazy_fetch.delete(attr) }
         end
 
         # Lazy loading can also specified through criteria.
@@ -57,7 +57,7 @@ module NoBrainer::Document::LazyFetch
 
     def _remove_field(attr, options={})
       super
-      for_each_subclass { |model| model.fields_to_lazy_fetch.delete(attr) }
+      subclass_tree.each { |subclass| subclass.fields_to_lazy_fetch.delete(attr) }
       inject_in_layer :lazy_fetch do
         remove_method("#{attr}") if method_defined?("#{attr}")
       end

data/lib/no_brainer/document/polymorphic.rb

@@ -28,12 +28,12 @@ module NoBrainer::Document::Polymorphic
       self == root_class
     end
 
-    def for_each_subclass(&block)
-      ([self] + self.descendants).each(&block)
+    def subclass_tree
+      [self] + self.descendants
     end
 
     def descendants_type_values
-      for_each_subclass.map(&:type_value)
+      subclass_tree.map(&:type_value)
     end
 
     def model_from_attrs(attrs)

data/lib/no_brainer/document/primary_key.rb

@@ -23,6 +23,10 @@ module NoBrainer::Document::PrimaryKey
 
   delegate :hash, :to => :pk_value
 
+  def cache_key
+    "#{self.class.table_name}/#{pk_value}"
+  end
+
   module ClassMethods
     def define_default_pk
       class_variable_set(:@@pk_name, nil)
@@ -30,6 +34,7 @@ module NoBrainer::Document::PrimaryKey
     end
 
     def define_pk(attr)
+      return if pk_name == attr
       if fields[pk_name].try(:[], :primary_key) == :default
         remove_field(pk_name, :set_default_pk => false)
       end
@@ -50,9 +55,13 @@ module NoBrainer::Document::PrimaryKey
         options = options.merge(:readonly => true) if options[:readonly].nil?
         options = options.merge(:index => true)
 
-        if options[:type].in?([String, nil]) && options[:default].nil?
-          options[:type] = String
-          options[:default] = ->{ NoBrainer::Document::PrimaryKey::Generator.generate }
+        if options[:default].nil?
+          # TODO Maybe we should let the user configure the pk generator
+          default_pk_generator = NoBrainer::Document::PrimaryKey::Generator
+          if options[:type].in?([default_pk_generator.field_type, nil])
+            options[:type] = default_pk_generator.field_type
+            options[:default] = ->{ default_pk_generator.generate }
+          end
         end
       end
       super

data/lib/no_brainer/document/primary_key/generator.rb

@@ -20,6 +20,7 @@ module NoBrainer::Document::PrimaryKey::Generator
   # 1% of chance to have a collision with ~580 servers.
   # When using more than 500 machines, it's therefore a good
   # idea to set the machine_id manually to avoid collisions.
+  # XXX This is referenced in nobrainer/config.rb#default_machine_id
   MACHINE_ID_BITS = 24
 
   # 15 bits for the current pid. We wouldn't need it if the sequence number was
@@ -27,7 +28,7 @@ module NoBrainer::Document::PrimaryKey::Generator
   PID_BITS = 15
 
   # Total: 83 bits
-  # We need at most 14 digits in [A-Za-z0-9] to represent 83 bits:
+  # With 14 digits in [A-Za-z0-9], we can represent 83 bits:
   # Math.log(62**14)/Math.log(2) = 83.35
   ID_STR_LENGTH = 14
 
@@ -80,4 +81,8 @@ module NoBrainer::Document::PrimaryKey::Generator
   def self.generate
     convert_to_alphanum(@lock.synchronize { _generate })
   end
+
+  def self.field_type
+    String
+  end
 end

data/lib/no_brainer/document/serialization.rb

@@ -4,8 +4,6 @@ module NoBrainer::Document::Serialization
   include ActiveModel::Serialization
   include ActiveModel::Serializers::JSON
 
-  included { self.include_root_in_json = false }
-
   def read_attribute_for_serialization(*a, &b)
     read_attribute(*a, &b)
   end

data/lib/no_brainer/document/timestamps.rb

@@ -17,4 +17,8 @@ module NoBrainer::Document::Timestamps
     self.updated_at = Time.now unless updated_at_changed?
     super(attrs.merge('updated_at' => @_attributes['updated_at']))
   end
+
+  def cache_key
+    "#{super}#{updated_at.try(:strftime, "-%s%L")}"
+  end
 end

data/lib/no_brainer/document/validation/uniqueness.rb

@@ -60,7 +60,8 @@ module NoBrainer::Document::Validation::Uniqueness
       super
       self.model = options[:class]
       self.scope = [*options[:scope]].map(&:to_sym)
-      ([model] + model.descendants).each do |subclass|
+
+      model.subclass_tree.each do |subclass|
         subclass.unique_validators << self
       end
     end

data/lib/no_brainer/query_runner/profiler.rb

@@ -9,6 +9,8 @@ class NoBrainer::QueryRunner::Profiler < NoBrainer::QueryRunner::Middleware
 
   private
 
+  require 'no_brainer/profiler/logger'
+
   def profiler_start(env)
     env[:start_time] = Time.now
   end

data/lib/no_brainer/symbol_decoration.rb

@@ -0,0 +1,11 @@
+module NoBrainer::SymbolDecoration
+  NON_CHAINABLE_OPERATORS = %w(in eq gt ge gte lt le lte defined near intersects).map(&:to_sym)
+  CHAINABLE_OPERATORS = %w(not any all).map(&:to_sym)
+  OPERATORS = CHAINABLE_OPERATORS + NON_CHAINABLE_OPERATORS
+
+  def self.hook
+    require 'symbol_decoration'
+    Symbol::Decoration.register(*NON_CHAINABLE_OPERATORS)
+    Symbol::Decoration.register(*CHAINABLE_OPERATORS, :chainable => true)
+  end
+end

data/lib/nobrainer.rb

@@ -14,9 +14,9 @@ module NoBrainer
 
   # We eager load things that could be loaded when handling the first web request.
   # Code that is loaded through the DSL of NoBrainer should not be eager loaded.
-  autoload :Document, :IndexManager, :Loader, :Fork, :Geo, :Lock, :Profiler
-  eager_autoload :Config, :Connection, :ConnectionManager,  :Error,
-                 :QueryRunner, :Criteria, :RQL
+  autoload :Document, :IndexManager, :Loader, :Fork, :Geo, :SymbolDecoration
+  eager_autoload :Config, :Connection, :ConnectionManager, :Error,
+                 :QueryRunner, :Criteria, :RQL, :Lock, :Profiler
 
   class << self
     delegate :connection, :disconnect, :to => 'NoBrainer::ConnectionManager'
@@ -38,11 +38,11 @@ module NoBrainer
   end
 
   Fork.hook unless jruby?
+  SymbolDecoration.hook
 end
 
 ActiveSupport.on_load(:i18n) do
   I18n.load_path << File.dirname(__FILE__) + '/no_brainer/locale/en.yml'
 end
 
-require 'no_brainer/profiler/logger'
 require 'no_brainer/railtie' if defined?(Rails)

data/lib/rails/generators/nobrainer/install_generator.rb

@@ -6,7 +6,7 @@ module NoBrainer::Generators
     extend NoBrainer::Generators::NamespaceFix
     source_root File.expand_path("../../templates", __FILE__)
 
-    desc "Disable ActiveRecord and generates ./config/initializer/nobrainer.rb"
+    desc "Disable ActiveRecord and generates ./config/initializers/nobrainer.rb"
 
     class RequireProxy
       attr_accessor :required_paths
@@ -42,7 +42,7 @@ module NoBrainer::Generators
 
 
     def copy_initializer
-      template('nobrainer.rb', 'config/initializer/nobrainer.rb')
+      template('nobrainer.rb', 'config/initializers/nobrainer.rb')
     end
   end
 end

data/lib/rails/generators/templates/nobrainer.rb

@@ -65,7 +65,7 @@ NoBrainer.configure do |config|
 
   # Configures which mechanism to use in order to perform non-racy uniqueness
   # validations. More about this behavior in the Distributed Locks section.
-  # config.distributed_lock_class = NoBrainer::Lock
+  # config.distributed_lock_class = "NoBrainer::Lock"
 
   # Configures the default timing lock options.
   # config.lock_options = { :expire => 60, :timeout => 10 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nobrainer
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Nicolas Viennot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-20 00:00:00.000000000 Z
+date: 2015-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rethinkdb
@@ -191,6 +191,7 @@ files:
 - lib/no_brainer/railtie.rb
 - lib/no_brainer/railtie/database.rake
 - lib/no_brainer/rql.rb
+- lib/no_brainer/symbol_decoration.rb
 - lib/nobrainer.rb
 - lib/rails/generators/nobrainer/install_generator.rb
 - lib/rails/generators/nobrainer/model_generator.rb