lotus-model 0.1.2 → 0.2.0

data/lib/lotus/model/adapters/implementation.rb

@@ -36,7 +36,7 @@ module Lotus
           query(collection).all
         end
 
-        # Returns an unique record from the given collection, with the given
+        # Returns a unique record from the given collection, with the given
         # id.
         #
         # @param collection [Symbol] the target collection (it must be mapped).

data/lib/lotus/model/adapters/memory/command.rb

@@ -18,7 +18,8 @@ module Lotus
           # @api private
           # @since 0.1.0
           def initialize(dataset, collection)
-            @dataset, @collection = dataset, collection
+            @dataset    = dataset
+            @collection = collection
           end
 
           # Creates a record for the given entity.

data/lib/lotus/model/adapters/memory/query.rb

@@ -100,12 +100,42 @@ module Lotus
           #        .where(framework: 'lotus')
           def where(condition)
             column, value = _expand_condition(condition)
-            conditions.push(Proc.new{ find_all{|r| r.fetch(column) == value} })
+            conditions.push([:where, Proc.new{ find_all{|r| r.fetch(column) == value} }])
             self
           end
 
           alias_method :and, :where
-          alias_method :or,  :where
+
+          # Adds a condition that behaves like SQL `OR`.
+          #
+          # It accepts a `Hash` with only one pair.
+          # The key must be the name of the column expressed as a `Symbol`.
+          # The value is the one used by the SQL query
+          #
+          # This condition will be ignored if not used with WHERE.
+          #
+          # @param condition [Hash]
+          #
+          # @return self
+          #
+          # @since 0.1.0
+          #
+          # @example Fixed value
+          #
+          #   query.where(language: 'ruby').or(framework: 'lotus')
+          #
+          # @example Array
+          #
+          #   query.where(id: 1).or(author_id: [15, 23])
+          #
+          # @example Range
+          #
+          #   query.where(country: 'italy').or(year: 1900..1982)
+          def or(condition=nil, &blk)
+            column, value = _expand_condition(condition)
+            conditions.push([:or, Proc.new{ find_all{|r| r.fetch(column) == value} }])
+            self
+          end
 
           # Logical negation of a #where condition.
           #
@@ -137,7 +167,7 @@ module Lotus
           #        .exclude(company: 'enterprise')
           def exclude(condition)
             column, value = _expand_condition(condition)
-            conditions.push(Proc.new{ reject! {|r| r.fetch(column) == value} })
+            conditions.push([:where, Proc.new{ reject {|r| r.fetch(column) == value} }])
             self
           end
 
@@ -161,7 +191,7 @@ module Lotus
           #
           #   query.select(:name, :year)
           def select(*columns)
-            columns = Lotus::Utils::Kernel.Array(columns).uniq
+            columns = Lotus::Utils::Kernel.Array(columns)
             modifiers.push(Proc.new{ flatten!; each {|r| r.delete_if {|k,_| !columns.include?(k)} } })
           end
 
@@ -189,7 +219,7 @@ module Lotus
           #   query.order(:name).order(:year)
           def order(*columns)
             Lotus::Utils::Kernel.Array(columns).each do |column|
-              conditions.push(Proc.new{ sort_by{|r| r.fetch(column)} })
+              modifiers.push(Proc.new{ sort_by!{|r| r.fetch(column)} })
             end
 
             self
@@ -221,7 +251,7 @@ module Lotus
           #   query.desc(:name).desc(:year)
           def desc(*columns)
             Lotus::Utils::Kernel.Array(columns).each do |column|
-              conditions.push(Proc.new{ sort_by{|r| r.fetch(column)}.reverse })
+              modifiers.push(Proc.new{ sort_by!{|r| r.fetch(column)}.reverse! })
             end
 
             self
@@ -255,7 +285,7 @@ module Lotus
           #
           #   query.offset(10)
           def offset(number)
-            modifiers.unshift(Proc.new{ replace(flatten.last(number)) })
+            modifiers.unshift(Proc.new{ replace(flatten.drop(number)) })
             self
           end
 
@@ -432,9 +462,18 @@ module Lotus
           def run
             result = @dataset.all.dup
 
-            result = conditions.map do |condition|
-              result.instance_exec(&condition)
-            end if conditions.any?
+            if conditions.any?
+              prev_result = nil
+              conditions.each do |(type, condition)|
+                case type
+                when :where
+                  prev_result = result
+                  result = prev_result.instance_exec(&condition)
+                when :or
+                  result |= prev_result.instance_exec(&condition)
+                end
+              end
+            end
 
             modifiers.map do |modifier|
               result.instance_exec(&modifier)

data/lib/lotus/model/adapters/memory_adapter.rb

@@ -49,7 +49,7 @@ module Lotus
         # @api private
         # @since 0.1.0
         def create(collection, entity)
-          @mutex.synchronize do
+          synchronize do
             entity.id = command(collection).create(entity)
             entity
           end
@@ -65,7 +65,7 @@ module Lotus
         # @api private
         # @since 0.1.0
         def update(collection, entity)
-          @mutex.synchronize do
+          synchronize do
             command(collection).update(entity)
           end
         end
@@ -78,7 +78,7 @@ module Lotus
         # @api private
         # @since 0.1.0
         def delete(collection, entity)
-          @mutex.synchronize do
+          synchronize do
             command(collection).delete(entity)
           end
         end
@@ -91,7 +91,7 @@ module Lotus
         # @api private
         # @since 0.1.0
         def clear(collection)
-          @mutex.synchronize do
+          synchronize do
             command(collection).clear
           end
         end
@@ -123,7 +123,7 @@ module Lotus
         # @api private
         # @since 0.1.0
         def query(collection, context = nil, &blk)
-          @mutex.synchronize do
+          synchronize do
             Memory::Query.new(_collection(collection), _mapped_collection(collection), &blk)
           end
         end
@@ -143,6 +143,14 @@ module Lotus
         def _collection(name)
           @collections[name] ||= Memory::Collection.new(name, _identity(name))
         end
+
+        # Executes the given block within a critical section.
+        #
+        # @api private
+        # @since 0.2.0
+        def synchronize
+          @mutex.synchronize { yield }
+        end
       end
     end
   end

data/lib/lotus/model/adapters/null_adapter.rb

@@ -0,0 +1,20 @@
+module Lotus
+  module Model
+    module Adapters
+      # @since 0.2.0
+      class NoAdapterError < ::StandardError
+        def initialize(method_name)
+          super("Cannot invoke `#{ method_name }' without selecting an adapter. Please check your framework configuration.")
+        end
+      end
+
+      # @since 0.2.0
+      # @api private
+      class NullAdapter
+        def method_missing(m, *args)
+          raise NoAdapterError.new(m)
+        end
+      end
+    end
+  end
+end

data/lib/lotus/model/adapters/sql/collection.rb

@@ -17,16 +17,16 @@ module Lotus
           #
           # @param dataset [Sequel::Dataset] the dataset that maps a table or a
           #   subset of it.
-          # @param collection [Lotus::Model::Mapping::Collection] a mapped
-          #   collection
+          # @param mapped_collection [Lotus::Model::Mapping::Collection] a
+          #   mapped collection
           #
           # @return [Lotus::Model::Adapters::Sql::Collection]
           #
           # @api private
           # @since 0.1.0
-          def initialize(dataset, collection)
+          def initialize(dataset, mapped_collection)
             super(dataset)
-            @collection = collection
+            @mapped_collection = mapped_collection
           end
 
           # Filters the current scope with an `exclude` directive.
@@ -41,7 +41,7 @@ module Lotus
           # @api private
           # @since 0.1.0
           def exclude(*args)
-            Collection.new(super, @collection)
+            Collection.new(super, @mapped_collection)
           end
 
           # Creates a record for the given entity and assigns an id.
@@ -58,7 +58,7 @@ module Lotus
             super _serialize(entity)
           end
 
-          # Filters the current scope with an `limit` directive.
+          # Filters the current scope with a `limit` directive.
           #
           # @param args [Array] the array of arguments
           #
@@ -70,7 +70,7 @@ module Lotus
           # @api private
           # @since 0.1.0
           def limit(*args)
-            Collection.new(super, @collection)
+            Collection.new(super, @mapped_collection)
           end
 
           # Filters the current scope with an `offset` directive.
@@ -85,7 +85,7 @@ module Lotus
           # @api private
           # @since 0.1.0
           def offset(*args)
-            Collection.new(super, @collection)
+            Collection.new(super, @mapped_collection)
           end
 
           # Filters the current scope with an `or` directive.
@@ -100,7 +100,7 @@ module Lotus
           # @api private
           # @since 0.1.0
           def or(*args)
-            Collection.new(super, @collection)
+            Collection.new(super, @mapped_collection)
           end
 
           # Filters the current scope with an `order` directive.
@@ -115,7 +115,7 @@ module Lotus
           # @api private
           # @since 0.1.0
           def order(*args)
-            Collection.new(super, @collection)
+            Collection.new(super, @mapped_collection)
           end
 
           # Filters the current scope with an `order` directive.
@@ -130,10 +130,10 @@ module Lotus
           # @api private
           # @since 0.1.0
           def order_more(*args)
-            Collection.new(super, @collection)
+            Collection.new(super, @mapped_collection)
           end
 
-          # Filters the current scope with an `select` directive.
+          # Filters the current scope with a `select` directive.
           #
           # @param args [Array] the array of arguments
           #
@@ -146,15 +146,15 @@ module Lotus
           # @since 0.1.0
           if RUBY_VERSION >= '2.1'
             def select(*args)
-              Collection.new(super, @collection)
+              Collection.new(super, @mapped_collection)
             end
           else
             def select(*args)
-              Collection.new(__getobj__.select(*Lotus::Utils::Kernel.Array(args)), @collection)
+              Collection.new(__getobj__.select(*Lotus::Utils::Kernel.Array(args)), @mapped_collection)
             end
           end
 
-          # Filters the current scope with an `where` directive.
+          # Filters the current scope with a `where` directive.
           #
           # @param args [Array] the array of arguments
           #
@@ -166,7 +166,7 @@ module Lotus
           # @api private
           # @since 0.1.0
           def where(*args)
-            Collection.new(super, @collection)
+            Collection.new(super, @mapped_collection)
           end
 
           # Updates the record corresponding to the given entity.
@@ -189,7 +189,7 @@ module Lotus
           # @api private
           # @since 0.1.0
           def to_a
-            @collection.deserialize(self)
+            @mapped_collection.deserialize(self)
           end
 
           private
@@ -200,7 +200,7 @@ module Lotus
           # @api private
           # @since 0.1.0
           def _serialize(entity)
-            @collection.serialize(entity)
+            @mapped_collection.serialize(entity)
           end
         end
       end

data/lib/lotus/model/adapters/sql/query.rb

@@ -111,7 +111,14 @@ module Lotus
           #        .where(framework: 'lotus')
           #
           #   # => SELECT * FROM `projects` WHERE (`language` = 'ruby') AND (`framework` = 'lotus')
-          def where(condition)
+          #
+          # @example Expressions
+          #
+          #   query.where{ age > 10 }
+          #
+          #   # => SELECT * FROM `users` WHERE (`age` > 31)
+          def where(condition=nil, &blk)
+            condition = (condition or blk or raise ArgumentError.new('You need to specify a condition.'))
             conditions.push([:where, condition])
             self
           end
@@ -149,7 +156,14 @@ module Lotus
           #   query.where(country: 'italy').or(year: 1900..1982)
           #
           #   # => SELECT * FROM `people` WHERE ((`country` = 'italy') OR ((`year` >= 1900) AND (`year` <= 1982)))
-          def or(condition)
+          #
+          # @example Expressions
+          #
+          #   query.where(name: 'John').or{ age > 31 }
+          #
+          #   # => SELECT * FROM `users` WHERE ((`name` = 'John') OR (`age` < 32))
+          def or(condition=nil, &blk)
+            condition = (condition or blk or raise ArgumentError.new('You need to specify a condition.'))
             conditions.push([:or, condition])
             self
           end
@@ -190,7 +204,13 @@ module Lotus
           #        .exclude(company: 'enterprise')
           #
           #   # => SELECT * FROM `projects` WHERE (`language` != 'java') AND (`company` != 'enterprise')
-          def exclude(condition)
+          # @example Expressions
+          #
+          #   query.exclude{ age > 31 }
+          #
+          #   # => SELECT * FROM `users` WHERE (`age` <= 31)
+          def exclude(condition=nil, &blk)
+            condition = (condition or blk or raise ArgumentError.new('You need to specify a condition.'))
             conditions.push([:exclude, condition])
             self
           end

data/lib/lotus/model/config/adapter.rb

@@ -0,0 +1,108 @@
+require 'lotus/utils/class'
+
+module Lotus
+  module Model
+    module Config
+      # Raised when an adapter class does not exist
+      #
+      # @since 0.2.0
+      class AdapterNotFound < ::StandardError
+        def initialize(adapter_name)
+          super "Cannot find Lotus::Model adapter #{adapter_name}"
+        end
+      end
+
+      # Configuration for the adapter
+      #
+      # Lotus::Model has its own global configuration that can be manipulated
+      # via `Lotus::Model.configure`.
+      #
+      # New adapter configuration can be registered via `Lotus::Model.adapter`.
+      #
+      # @see Lotus::Model.adapter
+      #
+      # @example
+      #   require 'lotus/model'
+      #
+      #   Lotus::Model.configure do
+      #     adapter type: :sql, uri: 'postgres://localhost/database'
+      #   end
+      #
+      #   Lotus::Model.adapter_config
+      #   # => Lotus::Model::Config::Adapter(type: :sql, uri: 'postgres://localhost/database')
+      #
+      # By convention, Lotus inflects type to find the adapter class
+      # For example, if type is :sql, derived class will be `Lotus::Model::Adapters::SqlAdapter`
+      #
+      # @since 0.2.0
+      class Adapter
+        # @return [Symbol] the adapter name
+        #
+        # @since 0.2.0
+        attr_reader :type
+
+        # @return [String] the adapter URI
+        #
+        # @since 0.2.0
+        attr_reader :uri
+
+        # @return [String] the adapter class name
+        #
+        # @since 0.2.0
+        attr_reader :class_name
+
+        # Initialize an adapter configuration instance
+        #
+        # @param options [Hash] configuration options
+        # @option options [Symbol] :type adapter type name
+        # @option options [String] :uri adapter URI
+        #
+        # @return [Lotus::Model::Config::Adapter] a new apdapter configuration's
+        #   instance
+        #
+        # @since 0.2.0
+        def initialize(**options)
+          @type = options[:type]
+          @uri  = options[:uri]
+          @class_name ||= Lotus::Utils::String.new("#{@type}_adapter").classify
+        end
+
+        # Initialize the adapter
+        #
+        # @param mapper [Lotus::Model::Mapper] the mapper instance
+        #
+        # @return [Lotus::Model::Adapters::SqlAdapter, Lotus::Model::Adapters::MemoryAdapter] an adapter instance
+        #
+        # @see Lotus::Model::Adapters
+        #
+        # @since 0.2.0
+        def build(mapper)
+          load_adapter
+          instantiate_adapter(mapper)
+        end
+
+        private
+
+        def load_adapter
+          begin
+            require "lotus/model/adapters/#{type}_adapter"
+          rescue LoadError => e
+            raise LoadError.new("Cannot find Lotus::Model adapter '#{type}' (#{e.message})")
+          end
+        end
+
+        def instantiate_adapter(mapper)
+          begin
+            klass = Lotus::Utils::Class.load!(class_name, Lotus::Model::Adapters)
+            klass.new(mapper, uri)
+          rescue NameError
+            raise AdapterNotFound.new(class_name)
+          rescue => e
+            raise "Cannot instantiate adapter of #{klass} (#{e.message})"
+          end
+        end
+
+      end
+    end
+  end
+end