nobrainer 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea32475119089388850bb55326aab70d4a3dbc16
-  data.tar.gz: dfbef7c1a239b75cb3b45d32b593026ef4d8df93
+  metadata.gz: 0fa1301301888d07f8c607cfd1102555aad40a92
+  data.tar.gz: f05a189ae40c4e6b1f2d420dd84a4928a6f65203
 SHA512:
-  metadata.gz: d83f20ced889fba1ba1048e6ad41f4c7a6a1ae02562c8bf230580a66e64306d9a064eb179a500b61b230f026bbc93a8bf8876f4b4edbf2e21c1a2140decb743d
-  data.tar.gz: a9a671db853f43d369550c7b1031a3a9ad17b9d5307aee6aea659e3808364c6d3d77b0ecfe9d2354a08efb99df7f44f085566d36d2f787a3e1d7469ec915ba52
+  metadata.gz: 1bfa4718cb043f4847f972d46b2728c772475b8d07683a591d38d6ec039d06c09508d2df855791e935bbaa85f5d11780a367a383e9ebae0c19dce278dab7c83d
+  data.tar.gz: 4584d38e6646c426672cea00c0f9aa58f05a6df4778586ae2d699662d927984b1f32ba3b87ebc3b787d4ad9181b19e9e4ecf3f4cfafdbc116f85920566534ed0

data/lib/no_brainer/autoload.rb

@@ -1,14 +1,25 @@
 module NoBrainer::Autoload
   include ActiveSupport::Autoload
 
-  def autoload(*args)
-    args.each { |mod| super mod }
+  def self.extended(base)
+    ActiveSupport::Autoload.extended(base)
   end
 
-  def autoload_and_include(*mods)
-    mods.each do |mod|
-      autoload mod
-      include const_get mod
-    end
+  def autoload(*constants)
+    constants.each { |constant| super(constant) }
+  end
+
+  def eager_autoload(*constants)
+    super() { autoload(*constants) }
+  end
+
+  def autoload_and_include(*constants)
+    constants.each { |constant| autoload constant }
+    constants.each { |constant| include const_get constant }
+  end
+
+  def eager_autoload_and_include(*constants)
+    eager_autoload(*constants)
+    constants.each { |constant| include const_get constant }
   end
 end

data/lib/no_brainer/config.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module NoBrainer::Config
   class << self
     mattr_accessor :rethinkdb_url, :logger, :warn_on_active_record,

data/lib/no_brainer/criteria/termination/cache.rb

@@ -45,7 +45,7 @@ module NoBrainer::Criteria::Termination::Cache
       block.call(instance)
       cache << instance
     end
-    @cache = cache.freeze
+    @cache = cache
     self
   end
 

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

@@ -33,7 +33,9 @@ class NoBrainer::Document::Association::EagerLoader
   def eager_load_association(docs, association_name, criteria=nil)
     docs = docs.compact
     return [] if docs.empty?
-    association = docs.first.root_class.association_metadata[association_name.to_sym]
+    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)
   end

data/lib/no_brainer/document/association.rb

@@ -1,6 +1,7 @@
 module NoBrainer::Document::Association
   extend NoBrainer::Autoload
   autoload :Core, :BelongsTo, :HasMany, :HasManyThrough, :HasOne, :HasOneThrough, :EagerLoader
+  METHODS = [:belongs_to, :has_many, :has_one]
 
   extend ActiveSupport::Concern
 
@@ -19,7 +20,7 @@ module NoBrainer::Document::Association
       subclass.association_metadata = self.association_metadata.dup
     end
 
-    [:belongs_to, :has_many, :has_one].each do |association|
+    METHODS.each do |association|
       define_method(association) do |target, options={}|
         target = target.to_sym
 

data/lib/no_brainer/document/attributes.rb

@@ -1,5 +1,5 @@
 module NoBrainer::Document::Attributes
-  VALID_FIELD_OPTIONS = [:index, :default]
+  VALID_FIELD_OPTIONS = [:index, :default, :type]
   RESERVED_FIELD_NAMES = [:index, :default, :and, :or, :selector, :associations] + NoBrainer::DecoratedSymbol::MODIFIERS.keys
   extend ActiveSupport::Concern
 
@@ -40,39 +40,31 @@ module NoBrainer::Document::Attributes
     end
   end
 
+  def _assign_attributes(attrs, options={})
+    attrs.each { |k,v| self.write_attribute(k,v) }
+  end
+
   def assign_attributes(attrs, options={})
-    # XXX We don't save field that are not explicitly set. The row will
-    # therefore not contain nil for unset attributes.
     @attributes.clear if options[:pristine]
-
-    if options[:from_db]
-      # TODO Should we reject undeclared fields ?
-      #
-      # TODO Not using the getter/setters, the dirty tracking won't notice it,
-      # also we should start thinking about custom serializer/deserializer.
-      @attributes.merge! attrs
-    else
-      attrs.each { |k,v| self.write_attribute(k, v) }
-    end
-
-    assign_defaults if options[:pristine] || options[:from_db]
+    _assign_attributes(attrs, options)
+    assign_defaults if options[:pristine]
     self
   end
   def attributes=(*args); assign_attributes(*args); end
 
-  # TODO test that thing
-  def inspect
-    attrs = self.class.fields.keys.map { |f| "#{f}: #{@attributes[f.to_s].inspect}" }
-    "#<#{self.class} #{attrs.join(', ')}>"
+  def inspectable_attributes
+    # TODO test that thing
+    Hash[@attributes.sort_by { |k,v| self.class.fields.keys.index(k.to_sym) || 2**10 }]
   end
 
-  def to_s
-    inspect
+  def inspect
+    "#<#{self.class} #{inspectable_attributes.map { |k,v| "#{k}: #{v.inspect}" }.join(', ')}>"
   end
 
   module ClassMethods
     def new_from_db(attrs, options={})
-      klass_from_attrs(attrs).new(attrs, options.reverse_merge(:from_db => true)) if attrs
+      options = options.reverse_merge(:pristine => true, :from_db => true)
+      klass_from_attrs(attrs).new(attrs, options) if attrs
     end
 
     def inherited(subclass)

data/lib/no_brainer/document/dirty.rb

@@ -15,9 +15,9 @@ module NoBrainer::Document::Dirty
     @changed_attributes ||= {}
   end
 
-  def assign_attributes(attrs, options={})
-    clear_dirtiness if options[:pristine] || options[:from_db]
+  def _assign_attributes(attrs, options={})
     super
+    clear_dirtiness if options[:pristine]
   end
 
   def clear_dirtiness

data/lib/no_brainer/document/index.rb

@@ -23,7 +23,6 @@ module NoBrainer::Document::Index
         else raise "Index argument must be a lambda or a list of fields"
       end
 
-      # FIXME Primary key may not always be :id
       if name.in?(NoBrainer::Document::Attributes::RESERVED_FIELD_NAMES)
         raise "Cannot use a reserved field name: #{name}"
       end

data/lib/no_brainer/document/injection_layer.rb

@@ -3,7 +3,7 @@ module NoBrainer::Document::InjectionLayer
 
   module ClassMethods
     def inject_in_layer(name, code=nil, file=nil, line=nil, &block)
-      mod = class_eval "module NoBrainer; module #{name.to_s.camelize}; self; end; end"
+      mod = class_eval "module NoBrainerLayer; module #{name.to_s.camelize}; self; end; end"
       mod.module_eval(code, file, line) if code
       mod.module_exec(&block) if block
       include mod

data/lib/no_brainer/document/timestamps.rb

@@ -2,8 +2,8 @@ module NoBrainer::Document::Timestamps
   extend ActiveSupport::Concern
 
   included do
-    self.field :created_at
-    self.field :updated_at
+    self.field :created_at, :type => Time
+    self.field :updated_at, :type => Time
 
     before_create { self.created_at = Time.now if self.respond_to?(:created_at=) }
     before_save   { self.updated_at = Time.now if self.respond_to?(:updated_at=) }

data/lib/no_brainer/document/types.rb

@@ -0,0 +1,129 @@
+module NoBrainer::Document::Types
+  extend ActiveSupport::Concern
+
+  included do
+    # We namespace our fake Boolean class to avoid polluting the global namespace
+    class_exec { class Boolean; def initialize; raise; end; end }
+    before_validation :add_type_errors
+  end
+
+  module CastingRules
+    extend self
+
+    def String(value)
+      case value
+      when Symbol then value.to_s
+      else raise InvalidType
+      end
+    end
+
+    def Integer(value)
+      case value
+      when String
+        value = value.strip.gsub(/^\+/, '')
+        value.to_i.tap { |new_value| new_value.to_s == value or raise InvalidType }
+      when Float
+        value.to_i.tap { |new_value| new_value.to_f == value or raise InvalidType }
+      else raise InvalidType
+      end
+    end
+
+    def Float(value)
+      case value
+      when Integer then value.to_f
+      when String
+        value = value.strip.gsub(/^\+/, '')
+        value = value.gsub(/0+$/, '') if value['.']
+        value = value.gsub(/\.$/, '')
+        value = "#{value}.0" unless value['.']
+        value.to_f.tap { |new_value| new_value.to_s == value or raise InvalidType }
+      else raise InvalidType
+      end
+    end
+
+    def Boolean(value)
+      case value
+      when TrueClass  then true
+      when FalseClass then false
+      when String, Integer
+        value = value.to_s.strip.downcase
+        return true  if value.in? %w(true yes t 1)
+        return false if value.in? %w(false no f 0)
+        raise InvalidType
+      else raise InvalidType
+      end
+    end
+
+    def Symbol(value)
+      case value
+      when String
+        value = value.strip
+        raise InvalidType if value.empty?
+        value.to_sym
+      else raise InvalidType
+      end
+    end
+  end
+
+  def self.cast(value, type, cast_method)
+    return value if value.nil? || type.nil? || value.is_a?(type)
+    cast_method.call(value)
+  end
+
+  def self.lookup_cast_method(type)
+    type = type.to_s
+    type = 'Boolean' if type == 'NoBrainer::Document::Types::Boolean'
+    CastingRules.method(type)
+  rescue NameError
+    proc { raise InvalidType }
+  end
+
+  class InvalidType < RuntimeError
+    attr_accessor :type
+    def initialize(type=nil)
+      @type = type
+    end
+
+    def validation_error_args
+      [:invalid_type, :type => type.to_s.underscore.humanize.downcase]
+    end
+  end
+
+  def add_type_errors
+    return unless @pending_type_errors
+    @pending_type_errors.each do |name, error|
+      errors.add(name, *error.validation_error_args)
+    end
+  end
+
+  module ClassMethods
+    def field(name, options={})
+      super
+      return unless options.has_key?(:type)
+      name = name.to_sym
+      type = options[:type]
+      cast_method = NoBrainer::Document::Types.lookup_cast_method(type)
+
+      inject_in_layer :types do
+        define_method("#{name}=") do |value|
+          begin
+            value = NoBrainer::Document::Types.cast(value, type, cast_method)
+            @pending_type_errors.try(:delete, name)
+          rescue NoBrainer::Document::Types::InvalidType => error
+            error.type ||= type
+            @pending_type_errors ||= {}
+            @pending_type_errors[name] = error
+          end
+          super(value)
+        end
+      end
+    end
+
+    def remove_field(name)
+      super
+      inject_in_layer :types, <<-RUBY, __FILE__, __LINE__ + 1
+        undef #{name}=
+      RUBY
+    end
+  end
+end

data/lib/no_brainer/document/validation.rb

@@ -3,7 +3,6 @@ module NoBrainer::Document::Validation
   include ActiveModel::Validations
   include ActiveModel::Validations::Callbacks
 
-  # TODO Test that thing
   def valid?(context=nil)
     super(context || (new_record? ? :create : :update))
   end

data/lib/no_brainer/document.rb

@@ -4,8 +4,8 @@ module NoBrainer::Document
   extend ActiveSupport::Concern
   extend NoBrainer::Autoload
 
-  autoload_and_include :Core, :StoreIn, :InjectionLayer, :Attributes, :Persistance, :Dirty,
-                       :Id, :Association, :Serialization, :Criteria, :Validation,
+  autoload_and_include :Core, :StoreIn, :InjectionLayer, :Attributes, :Validation, :Types,
+                       :Persistance, :Dirty, :Id, :Association, :Serialization, :Criteria,
                        :Polymorphic, :Index, :Timestamps
 
   autoload :DynamicAttributes

data/lib/no_brainer/locale/en.yml

@@ -2,3 +2,4 @@ en:
   errors:
     messages:
       taken: "is already taken"
+      invalid_type: "should be a %{type}"

data/lib/no_brainer/railtie.rb

@@ -1,7 +1,9 @@
-require "nobrainer"
-require "rails"
+require 'nobrainer'
 
 class NoBrainer::Railtie < Rails::Railtie
+  config.app_generators.orm :nobrainer
+  config.eager_load_namespaces << NoBrainer
+
   config.action_dispatch.rescue_responses.merge!(
     "NoBrainer::Errors::DocumentNotFound" => :not_found,
     "NoBrainer::Errors::DocumentInvalid"  => :unprocessable_entity,
@@ -16,7 +18,7 @@ class NoBrainer::Railtie < Rails::Railtie
 
     if defined?(ActiveRecord) && NoBrainer::Config.warn_on_active_record
       STDERR.puts "[NoBrainer] WARNING: ActiveRecord is loaded which is probably not what you want."
-      STDERR.puts "[NoBrainer] Follow the instructions on http://todo/ to learn how to remove ActiveRecord."
+      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
 
@@ -30,6 +32,4 @@ class NoBrainer::Railtie < Rails::Railtie
       NoBrainer::Loader.cleanup
     end
   end
-
-  #config.eager_load_namespaces << NoBrainer
 end

data/lib/nobrainer.rb

@@ -1,15 +1,19 @@
-require 'active_support/core_ext'
-
 if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9')
   raise 'Please use Ruby 1.9 or later'
 end
 
+require 'active_support'
+%w(module/delegation module/attribute_accessors class/attribute object/blank object/inclusion
+   object/duplicable object/try hash/keys hash/reverse_merge array/extract_options)
+    .each { |dep| require "active_support/core_ext/#{dep}" }
+
 module NoBrainer
   require 'no_brainer/autoload'
   extend NoBrainer::Autoload
 
-  autoload :Config, :Document, :Connection, :Database, :Error, :QueryRunner,
-           :Criteria, :DecoratedSymbol, :IndexManager, :Loader, :Logging, :Util, :Fork
+  # We eager load things that could be loaded for the first time during the web request
+  autoload :Document, :IndexManager, :Loader, :Fork, :DecoratedSymbol
+  eager_autoload :Config, :Connection, :Error, :QueryRunner, :Criteria, :Util
 
   class << self
     # Note: we always access the connection explicitly, so that in the future,
@@ -34,14 +38,14 @@ module NoBrainer
       end
     end
 
-    # Not using modules to extend, it's nicer to see the NoBrainer module API here.
     delegate :db_create, :db_drop, :db_list,
              :table_create, :table_drop, :table_list,
              :drop!, :purge!, :to => :connection
-    delegate :run, :to => 'NoBrainer::QueryRunner'
-    delegate :update_indexes, :to => 'NoBrainer::IndexManager'
+
+    delegate :configure, :logger,   :to => 'NoBrainer::Config'
+    delegate :run,                  :to => 'NoBrainer::QueryRunner'
+    delegate :update_indexes,       :to => 'NoBrainer::IndexManager'
     delegate :with, :with_database, :to => 'NoBrainer::QueryRunner::RunOptions'
-    delegate :configure, :logger, :to => 'NoBrainer::Config'
 
     def jruby?
       RUBY_PLATFORM == 'java'

data/lib/rails/generators/nobrainer/model/model_generator.rb

@@ -0,0 +1,17 @@
+require "rails/generators/nobrainer"
+
+module NoBrainer::Generators
+  class ModelGenerator < Base
+    argument :attributes, :type => :array, default: [], banner: "field ... field"
+
+    check_class_collision
+
+    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")
+    end
+
+    hook_for :test_framework
+  end
+end

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

@@ -0,0 +1,13 @@
+<% module_namespacing do -%>
+class <%= class_name %><%= " < #{options[:parent].classify}" if options[:parent] %>
+<% unless options[:parent] -%>
+  include NoBrainer::Document
+<% end -%>
+<% attributes.reject(&:reference?).each do |attribute| -%>
+  field :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>
+end
+<% end -%>

data/lib/rails/generators/nobrainer.rb

@@ -0,0 +1,18 @@
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nobrainer
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Nicolas Viennot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-05 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rethinkdb
@@ -66,27 +66,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/no_brainer/document/id.rb
-- lib/no_brainer/document/injection_layer.rb
-- lib/no_brainer/document/timestamps.rb
 - lib/no_brainer/document/association/belongs_to.rb
-- lib/no_brainer/document/association/core.rb
-- lib/no_brainer/document/association/eager_loader.rb
-- lib/no_brainer/document/association/has_many_through.rb
 - lib/no_brainer/document/association/has_many.rb
 - lib/no_brainer/document/association/has_one.rb
 - lib/no_brainer/document/association/has_one_through.rb
-- lib/no_brainer/document/dirty.rb
+- lib/no_brainer/document/association/has_many_through.rb
+- lib/no_brainer/document/association/eager_loader.rb
+- lib/no_brainer/document/association/core.rb
 - lib/no_brainer/document/dynamic_attributes.rb
-- lib/no_brainer/document/persistance.rb
-- lib/no_brainer/document/validation.rb
-- lib/no_brainer/document/serialization.rb
 - lib/no_brainer/document/criteria.rb
-- lib/no_brainer/document/index.rb
 - lib/no_brainer/document/polymorphic.rb
 - lib/no_brainer/document/store_in.rb
-- lib/no_brainer/document/attributes.rb
 - lib/no_brainer/document/core.rb
+- lib/no_brainer/document/injection_layer.rb
+- lib/no_brainer/document/index.rb
+- lib/no_brainer/document/serialization.rb
 - lib/no_brainer/document/association.rb
+- lib/no_brainer/document/validation.rb
+- lib/no_brainer/document/timestamps.rb
+- lib/no_brainer/document/dirty.rb
+- lib/no_brainer/document/persistance.rb
+- lib/no_brainer/document/attributes.rb
+- lib/no_brainer/document/types.rb
 - lib/no_brainer/query_runner/connection.rb
 - lib/no_brainer/query_runner/database_on_demand.rb
 - lib/no_brainer/query_runner/logger.rb
@@ -120,11 +121,13 @@ files:
 - lib/no_brainer/connection.rb
 - lib/no_brainer/query_runner.rb
 - lib/no_brainer/error.rb
-- lib/no_brainer/document.rb
-- lib/no_brainer/config.rb
 - lib/no_brainer/railtie.rb
+- lib/no_brainer/config.rb
 - lib/no_brainer/autoload.rb
-- lib/no_brainer/version.rb
+- lib/no_brainer/document.rb
+- lib/rails/generators/nobrainer.rb
+- lib/rails/generators/nobrainer/model/model_generator.rb
+- lib/rails/generators/nobrainer/model/templates/model.rb.tt
 - lib/nobrainer.rb
 - README.md
 - LICENSE.md

data/lib/no_brainer/version.rb

@@ -1,3 +0,0 @@
-module NoBrainer
-  VERSION = '0.9.0'
-end