nobrainer 0.25.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71e9e6216a8508d483d0c0769b6d8f5137b5f2c2
-  data.tar.gz: 91cc415c1d35b3120fc94edfc322bdc30652aa30
+  metadata.gz: 22202d66d5f511c228b92b0a93df97628dd2ad6d
+  data.tar.gz: 28b596c4b83b83300add95b5f9971e4a3c9ceaf8
 SHA512:
-  metadata.gz: b4a4656ab19c63e12e194b3c90dd7f25ffc806cfefee029a352e22deccca5908029bf06f14af097d8ebd069ef5eb0a923550d7411dc520fdb2fa8ef2e34378d6
-  data.tar.gz: 37f77aef1ca56aeda705659162bab344f4c1e6495ea0c9fe5682ac7a3276eaee642b9313153ecbb80caf839054a499db19c3dd20eb144820ea0a9a97cf1e7f50
+  metadata.gz: df558fdce2a60deee0e500766a7963769ea6514fb1f97d6129c7d49eb66579f3b45990d9dca0b2506e0e8bb55940a826d1acf33e97233b8162cd4b53ec377862
+  data.tar.gz: 59ef60554676a4eff6919a3168d91803a6c11897cfa7073d52da262c4047640d7de6879a062c086994ea0a6f7fec4e56804ce6b46f444a86777c8151bbc667f5

data/lib/no_brainer/connection_manager.rb

@@ -11,9 +11,29 @@ module NoBrainer::ConnectionManager
     end
   end
 
+  def warn_for_other_orms
+    if defined?(ActiveRecord) && NoBrainer::Config.warn_on_active_record
+      STDERR.puts "[NoBrainer] ActiveRecord is loaded which is probably not what you want."
+      STDERR.puts "[NoBrainer] Follow the instructions on http://nobrainer.io/docs/configuration/#removing_activerecord"
+      STDERR.puts "[NoBrainer] Configure NoBrainer with 'config.warn_on_active_record = false' to disable with warning."
+    end
+
+    if defined?(Mongoid)
+      STDERR.puts "[NoBrainer] WARNING: Mongoid is loaded, and we conflict on the symbol decorations"
+      STDERR.puts "[NoBrainer] They are used in queries such as Model.where(:tags.in => ['fun', 'stuff'])"
+      STDERR.puts "[NoBrainer] This is a problem!"
+    end
+  end
+
   def get_new_connection
     url = NoBrainer::Config.rethinkdb_url
     raise "Please specify a database connection to RethinkDB" unless url
+
+    # We don't want to warn on "rails g nobrainer:install", but because it's
+    # hard to check when the generator is running because of spring as it wipes
+    # ARGV. So we check for other ORMs during the connection instantiation.
+    warn_for_other_orms
+
     NoBrainer::Connection.new(url)
   end
 

data/lib/no_brainer/document/atomic_ops.rb

@@ -56,14 +56,20 @@ module NoBrainer::Document::AtomicOps
 
     def compile_rql_value(rql_doc)
       field = @instance.class.lookup_field_alias(@field)
-      value = @is_user_value ? RethinkDB::RQL.new.expr(@value) : rql_doc[field]
+      if @is_user_value
+        casted_value = @instance.class.cast_model_to_db_for(@field, @value)
+        value = RethinkDB::RQL.new.expr(casted_value)
+      else
+        value = rql_doc[field]
+      end
       value = value.default(default_value) if default_value
       @ops.reduce(value) { |v, (method, a, b)| v.__send__(method, *a, &b) }
     end
 
     def modify_source!
-      unless @instance._is_attribute_touched?(@field)
-        @instance.write_attribute(@field, self)
+      if (@is_user_value && @instance.instance_eval { @_attributes[@field].equal?(@value) }) ||
+          !@instance._is_attribute_touched?(@field)
+        @instance._write_attribute(@field, self)
       end
     end
   end

data/lib/no_brainer/document/dirty.rb

@@ -1,10 +1,11 @@
 module NoBrainer::Document::Dirty
   extend ActiveSupport::Concern
-  # We need to save the changes as seen through read_attribute because
-  # the user sees attributes through the read_attribute getters.
-  # But we want to detect changes based on @_attributes to track
-  # things like undefined -> nil. Going through the getters will
-  # not give us that.
+  # 1) We should save the changes as seen through read_attribute, because the
+  # user sees attributes through the read_attribute getters, but it's near
+  # impossible because we would need to wrap the user defined getters, so we'll
+  # go through _read_attribute.
+  # 2) We want to detect changes based on @_attributes to track things like
+  # undefined -> nil. Going through the getters will not give us that.
 
   def _create(*args)
     super.tap { clear_dirtiness }
@@ -36,7 +37,7 @@ module NoBrainer::Document::Dirty
   def changes
     result = {}.with_indifferent_access
     @_old_attributes.each do |attr, old_value|
-      current_value = read_attribute(attr)
+      current_value = _read_attribute(attr)
       if current_value != old_value || !@_old_attributes_keys.include?(attr)
         result[attr] = [old_value, current_value]
       end
@@ -49,7 +50,7 @@ module NoBrainer::Document::Dirty
     if current_value == None
       current_value = begin
         assert_access_field(attr)
-        read_attribute(attr)
+        _read_attribute(attr)
       rescue NoBrainer::Error::MissingAttribute => e
         e
       end
@@ -81,7 +82,7 @@ module NoBrainer::Document::Dirty
       inject_in_layer :dirty_tracking do
         define_method("#{attr}_change") do
           if @_old_attributes.has_key?(attr)
-            result = [@_old_attributes[attr], read_attribute(attr)]
+            result = [@_old_attributes[attr], _read_attribute(attr)]
             result if result.first != result.last || !@_old_attributes_keys.include?(attr)
           end
         end
@@ -91,7 +92,7 @@ module NoBrainer::Document::Dirty
         end
 
         define_method("#{attr}_was") do
-          @_old_attributes.has_key?(attr) ? @_old_attributes[attr] : read_attribute(attr)
+          @_old_attributes.has_key?(attr) ? @_old_attributes[attr] : _read_attribute(attr)
         end
       end
     end

data/lib/no_brainer/document/index/synchronizer.rb

@@ -48,12 +48,22 @@ class NoBrainer::Document::Index::Synchronizer
   end
 
   def sync_indexes(options={})
-    plan = generate_plan
-    plan.each { |op| op.run(options) }
+    lock = NoBrainer::Lock.new('nobrainer:sync_indexes')
+
+    lock.synchronize do
+      plan = generate_plan
+      plan.each { |op| lock.refresh; op.run(options) }
+    end
+
     unless options[:wait] == false
-      models = plan.map(&:index).map(&:model).uniq
-      models.each { |model| NoBrainer.run(model.rql_table.index_wait()) }
+      # Waiting on all models due to possible races when performing concurrent
+      # sync_indexes()
+      @models_indexes_map.each_key do |model|
+        NoBrainer.run(model.rql_table.index_wait())
+      end
     end
+
+    true
   end
 
   class << self

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

@@ -1,6 +1,9 @@
 module NoBrainer::Document::Validation::Uniqueness
   extend ActiveSupport::Concern
 
+  # XXX we don't use read_attribute_for_validation, which goes through the user
+  # getters, but read internal attributes instead. It makes more sense.
+
   def save?(options={})
     lock_unique_fields
     super
@@ -22,7 +25,7 @@ module NoBrainer::Document::Validation::Uniqueness
     self.class.unique_validators
       .flat_map { |validator| validator.attributes.map { |attr| [attr, validator] } }
       .select { |f, validator| validator.should_validate_field?(self, f) }
-      .map { |f, validator| [f, *validator.scope].map { |k| [k, read_attribute(k)] } }
+      .map { |f, validator| [f, *validator.scope].map { |k| [k, _read_attribute(k)] } }
       .map { |params| self.class._uniqueness_key_name_from_params(params) }
       .sort.each { |key| _lock_for_uniqueness_once(key) }
   end
@@ -79,7 +82,7 @@ module NoBrainer::Document::Validation::Uniqueness
     end
 
     def apply_scopes(criteria, doc)
-      criteria.where(scope.map { |k| {k => doc.read_attribute(k)} })
+      criteria.where(scope.map { |k| {k => doc._read_attribute(k)} })
     end
 
     def exclude_doc(criteria, doc)

data/lib/no_brainer/lock.rb

@@ -35,7 +35,7 @@ class NoBrainer::Lock
     begin
       block.call
     ensure
-      unlock
+      unlock if @locked
     end
   end
 

data/lib/no_brainer/query_runner/reconnect.rb

@@ -36,9 +36,8 @@ class NoBrainer::QueryRunner::Reconnect < NoBrainer::QueryRunner::Middleware
       Errno::ECONNRESET, Errno::ETIMEDOUT, IOError
       true
     when RethinkDB::RqlRuntimeError
-      e.message =~ /No master available/ ||
-      e.message =~ /Master .* not available/ ||
-      e.message =~ /Error: Connection Closed/
+      e.message =~ /Primary .* not available/ ||
+      e.message =~ /Connection.*closed/
     else
       false
     end

data/lib/no_brainer/railtie.rb

@@ -26,18 +26,6 @@ class NoBrainer::Railtie < Rails::Railtie
   config.after_initialize do
     NoBrainer::Config.configure unless NoBrainer::Config.configured?
 
-    if defined?(ActiveRecord) && NoBrainer::Config.warn_on_active_record
-      STDERR.puts "[NoBrainer] ActiveRecord is loaded which is probably not what you want."
-      STDERR.puts "[NoBrainer] Follow the instructions on http://nobrainer.io/docs/configuration/#removing_activerecord"
-      STDERR.puts "[NoBrainer] Configure NoBrainer with 'config.warn_on_active_record = false' to disable with warning."
-    end
-
-    if defined?(Mongoid)
-      STDERR.puts "[NoBrainer] WARNING: Mongoid is loaded, and we conflict on the symbol decorations"
-      STDERR.puts "[NoBrainer] They are used in queries such as Model.where(:tags.in => ['fun', 'stuff'])"
-      STDERR.puts "[NoBrainer] This is a problem!"
-    end
-
     ActionDispatch::Reloader.to_prepare do
       NoBrainer::Loader.cleanup
     end

data/lib/no_brainer/rql.rb

@@ -13,19 +13,19 @@ module NoBrainer::RQL
         RethinkDB::RQL.new.new_func(&block)))
   end
 
-  def is_write_query?(rql_query)
-    type_of(rql_query) == :write
+  def is_write_query?(rql)
+    type_of(rql) == :write
   end
 
-  def type_of(rql_query)
-    case rql_query.body.first
+  def type_of(rql)
+    case rql.is_a?(RethinkDB::RQL) && rql.body.is_a?(Array) && rql.body.first
     when UPDATE, DELETE, REPLACE, INSERT
       :write
     when DB_CREATE, DB_DROP, DB_LIST, TABLE_CREATE, TABLE_DROP, TABLE_LIST, SYNC,
          INDEX_CREATE, INDEX_DROP, INDEX_LIST, INDEX_STATUS, INDEX_WAIT
       :management
     else
-      # XXX Not sure if that's correct, but we'll be happy for logging colors.
+      # XXX Not necessarily correct, but we'll be happy for logging colors.
       :read
     end
   end

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

@@ -0,0 +1,48 @@
+require "rails/generators/nobrainer/namespace_fix"
+require 'rails/generators/base'
+
+module NoBrainer::Generators
+  class InstallGenerator < Rails::Generators::Base
+    extend NoBrainer::Generators::NamespaceFix
+    source_root File.expand_path("../../templates", __FILE__)
+
+    desc "Disable ActiveRecord and generates ./config/initializer/nobrainer.rb"
+
+    class RequireProxy
+      attr_accessor :required_paths
+      def initialize
+        self.required_paths = []
+      end
+
+      def require(path)
+        self.required_paths << path
+      end
+
+      def resolve_require_path(path)
+        $:.map { |dir| File.join(dir, path) }.detect { |f| File.exists?(f) }
+      end
+    end
+
+    def expand_require_rails_all
+      require_proxy = RequireProxy.new
+      rails_all_file = require_proxy.resolve_require_path('rails/all.rb')
+      require_proxy.instance_eval(File.read(rails_all_file))
+
+      gsub_file('config/application.rb', %r(^require 'rails/all'$)) do
+        require_proxy.required_paths.map { |f| "require '#{f}'" }.join("\n")
+      end
+    end
+
+    def remove_active_record
+      (Dir['config/environments/*'] + ['config/application.rb']).each do |config_file|
+        comment_lines(config_file, /active_record/)
+      end
+      remove_file('config/database.yml')
+    end
+
+
+    def copy_initializer
+      template('nobrainer.rb', 'config/initializer/nobrainer.rb')
+    end
+  end
+end

data/lib/rails/generators/nobrainer/{model/model_generator.rb → model_generator.rb}

@@ -1,7 +1,11 @@
-require "rails/generators/nobrainer"
+require "rails/generators/nobrainer/namespace_fix"
+require 'rails/generators/named_base'
 
 module NoBrainer::Generators
-  class ModelGenerator < Base
+  class ModelGenerator < Rails::Generators::NamedBase
+    extend NoBrainer::Generators::NamespaceFix
+    source_root File.expand_path("../../templates", __FILE__)
+
     argument(:attributes, :type => :array, default: [],
              banner: "field[:type][:index] ... field[:type][:index]")
 
@@ -10,7 +14,7 @@ module NoBrainer::Generators
     class_option :parent, :type => :string, :desc => "The parent class for the generated model"
 
     def create_model_file
-      template "model.rb.tt", File.join("app/models", class_path, "#{file_name}.rb")
+      template "model.rb", File.join("app", "models", class_path, "#{file_name}.rb")
     end
 
     hook_for :test_framework

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

@@ -0,0 +1,15 @@
+module NoBrainer::Generators
+  module NamespaceFix
+    def base_name
+      'nobrainer'
+    end
+
+    def base_root
+      File.dirname(__FILE__)
+    end
+
+    def namespace
+      super.gsub(/no_brainer/, 'nobrainer')
+    end
+  end
+end

data/lib/rails/generators/{nobrainer/model/templates/model.rb.tt → templates/model.rb}

@@ -7,7 +7,7 @@ class <%= class_name %><%= " < #{options[:parent].classify}" if options[:parent]
 <% end -%>
 <% attributes.reject(&:reference?).each do |attribute| -%>
   field :<%= attribute.name -%>
-<%= puts attribute; ", :type => #{attribute.type.to_s.classify}" if attribute.type != :object -%>
+<%= ", :type => #{attribute.type.to_s.classify}" if attribute.type != :object -%>
 <%= ", :index => true" if attribute.has_index? %>
 <% end -%>
 <% attributes.select(&:reference?).each do |attribute| -%>

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

@@ -0,0 +1,92 @@
+NoBrainer.configure do |config|
+  # app_name is the name of your application in lowercase.
+  # When using Rails, the application name is automatically inferred.
+  # config.app_name = config.default_app_name
+
+  # environment defaults to Rails.env for Rails apps or to the environment
+  # variables RUBY_ENV, RAILS_ENV, RACK_ENV, or :production.
+  # config.environment = config.default_environment
+
+  # The rethinkdb_url specifies the RethinkDB database connection url.
+  # When left unspecified, NoBrainer picks a database connection by default.
+  # The default is to use localhost, with a database name matching the
+  # application name and the environment.
+  # NoBrainer also reads environment variables when defined:
+  # * RETHINKDB_URL, RDB_URL
+  # * RETHINKDB_HOST, RETHINKDB_PORT, RETHINKDB_DB, RETHINKDB_AUTH
+  # * RDB_HOST, RDB_PORT, RDB_DB, RDB_AUTH
+  # config.rethinkdb_url = config.default_rethinkdb_url
+
+  # NoBrainer uses logger to emit debugging information.
+  # The default logger is the Rails logger if run with Rails,
+  # otherwise Logger.new(STDERR) with a WARN level.
+  # If the logger is configured with a DEBUG level,
+  # then each database query is emitted.
+  # config.logger = config.default_logger
+
+  # NoBrainer will colorize the queries if colorize_logger is true.
+  # Specifically, NoBrainer will colorize management RQL queries in yellow,
+  # write queries in red and read queries in green.
+  # config.colorize_logger = true
+
+  # You probably do not want to use both NoBrainer and ActiveRecord in your
+  # application. NoBrainer will emit a warning if you do so.
+  # You can turn off the warning if you want to use both.
+  # config.warn_on_active_record = true
+
+  # When the network connection is lost, NoBrainer can retry running a given
+  # query a few times before giving up. Note that this can be a problem with
+  # non idempotent write queries such as increments.
+  # Setting it to 0 disable retries during reconnections.
+  # The default is 1 for development or test environment, otherwise 15.
+  # config.max_retries_on_connection_failure = \
+  #   config.default_max_retries_on_connection_failure
+
+  # Configures the durability for database writes.
+  # The default is :soft for development or test environment, otherwise :hard.
+  # config.durability = config.default_durability
+
+  # Persisted Strings have a configurable maximum length. To get rid of the
+  # length validation, you may use the Text type instead.
+  # config.max_string_length = 255
+
+  # user_timezone can be configured with :utc, :local, or :unchanged.
+  # When reading an attribute from a model which type is Time, the timezone
+  # of that time is translated according to this setting.
+  # config.user_timezone = :local
+
+  # db_timezone can be configured with :utc, :local, or :unchanged.
+  # When writting to the database, the timezone of Time attributes are
+  # translated according to this setting.
+  # config.db_timezone = :utc
+
+  # Default options used when compiling geo queries.
+  # config.geo_options => { :geo_system => 'WGS84', :unit => 'm' }
+
+  # 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
+
+  # Configures the default timing lock options.
+  # config.lock_options = { :expire => 60, :timeout => 10 }
+
+  # Instead of using a single connection to the database, You can tell
+  # NoBrainer to spin up a new connection for each thread. This is
+  # useful for multi-threading usage such as Sidekiq.
+  # Call NoBrainer.disconnect before a thread exits, otherwise you will have
+  # a resource leak, and you will run out of connections.
+  # Note that this is solution is temporary, until we get a connection pool.
+  # config.per_thread_connection = false
+
+  # The machine id is used to generate primary keys. The default one is seeded
+  # with the machine IP with Socket.gethostname.
+  # The env variable MACHINE_ID can also be used to set the machine id.
+  # When using distinct machine_id, then primary keys are guaranteed to be
+  # generated without conflicts.
+  # config.machine_id = config.default_machine_id
+
+  # Criteria cache elements. For example, the result of a has_many association
+  # is cached. The per criteria cache is disabled if it grows too big to avoid
+  # out of memory issues.
+  # config.criteria_cache_max_entries = 10_000
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nobrainer
 version: !ruby/object:Gem::Version
-  version: 0.25.1
+  version: 0.26.0
 platform: ruby
 authors:
 - Nicolas Viennot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-01 00:00:00.000000000 Z
+date: 2015-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rethinkdb
@@ -192,9 +192,11 @@ files:
 - lib/no_brainer/railtie/database.rake
 - lib/no_brainer/rql.rb
 - lib/nobrainer.rb
-- lib/rails/generators/nobrainer.rb
-- lib/rails/generators/nobrainer/model/model_generator.rb
-- lib/rails/generators/nobrainer/model/templates/model.rb.tt
+- lib/rails/generators/nobrainer/install_generator.rb
+- lib/rails/generators/nobrainer/model_generator.rb
+- lib/rails/generators/nobrainer/namespace_fix.rb
+- lib/rails/generators/templates/model.rb
+- lib/rails/generators/templates/nobrainer.rb
 homepage: http://nobrainer.io
 licenses:
 - LGPLv3

data/lib/rails/generators/nobrainer.rb

@@ -1,18 +0,0 @@
-require 'rails/generators/named_base'
-require 'nobrainer'
-
-module NoBrainer::Generators
-  class Base < Rails::Generators::NamedBase
-    def self.base_name
-      'nobrainer'
-    end
-
-    def self.base_root
-      File.dirname(__FILE__)
-    end
-
-    def self.namespace
-      super.gsub(/no_brainer/, 'nobrainer')
-    end
-  end
-end