lotus-model 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49e959406b3eb918c7a4bd905a12ba1c10262710
-  data.tar.gz: d94acfc3ddd8cf6b68acda3df7b6316532c3da3c
+  metadata.gz: d6d28ccedb8722497c957e6b3faf8c8fe885d2cf
+  data.tar.gz: 5eae2a84ec0ccd7be8dfcd3ea1771f99822b437c
 SHA512:
-  metadata.gz: 5fbddd4ce436384d0c76cdb23fe97c836bcb86f68bc43ce18a6c128be5effe992454e0e542d08113e8e0f920498257d06efe8633b9c07256a73c5f9cac24f7fd
-  data.tar.gz: 61a389ebd9c46d67fb19bd5af588c1c5681253f3470eea10b2975c32d246741c66bf53ed888261c07d33f81d99fd7f641ff7b2932f1ac8afc367f84cb2346917
+  metadata.gz: 3354751cde9176e5aae2e4686450f514a5a419afd5dc1e2bd8d345ad551e3728b6712311e7ea297bbb082f7b9b100ad7011a9ad386e416d42210dc6c6970d018
+  data.tar.gz: d9fb84225ab7d354f7bd99d3fdcf9c6ad23d7b07f20eeabb68d95e32fa0e937aceb86a1c72287210b402b41e348b6d208a807600cc24964ce22451b19cded59c

data/CHANGELOG.md

@@ -0,0 +1,159 @@
+## v0.1.1
+### Jun 23, 2014
+
+99ea094 2014-06-13 **Luca Guidi** Introduced Lotus::Model::Mapping::Coercions in order to decouple from Lotus::Utils::Kernel
+
+3fa2693 2014-05-10 **Luca Guidi** Support for Ruby 2.1.2
+
+3682552 2014-04-25 **Peter Suschlik** Iterate over each value using `each_value`
+
+cce7746 2014-04-24 **Peter Suschlik** Just extend the base class. No need to class_eval
+
+719e03c 2014-04-24 **Peter Suschlik** Pass list of attributes to `attr_accessor`
+
+## v0.1.0
+### Apr 23, 2014
+
+ec395d8 2014-04-22 **Luca Guidi** Added an accessor to introspect Mapper collections
+
+96d9d00 2014-04-18 **Luca Guidi** Allow queries to be composed
+
+a7d64c1 2014-04-18 **Damir Zekic**  Don't serialize identity column if it's nil
+
+8484941 2014-04-17 **Luca Guidi** Fixed Sql::Collection#select for Ruby 2.0.0
+
+bd9d679 2014-04-17 **Luca Guidi** Allow Sql#Query#order and #desc to accept multiple columns and/or multiple invokations.
+
+b6a7af8 2014-04-16 **Luca Guidi** Enforce Adapter interface with #command and #query
+
+3787f33 2014-04-16 **Luca Guidi** Allow Mapper to accept a custom coercer for the database
+
+893109a 2014-04-15 **Luca Guidi** Ensure that unmapped attributes doens't interfer with initialization of entities
+
+da37d7a 2014-04-15 **Luca Guidi** Implemented Memory::Query #to_s, #empty? and #any?
+
+94f0ecb 2014-04-15 **Luca Guidi** Implemented Repository#exclude
+
+6998328 2014-04-15 **Luca Guidi** Removed unused require
+
+7211935 2014-04-15 **Luca Guidi** Implemented Sql::Query #to_s, #empty? and #any?
+
+5e7e0c4 2014-04-15 **Luca Guidi** Implemented Sql::Query#negate!
+
+5df30c2 2014-04-15 **Luca Guidi** Define top level constant ::Boolean
+
+a9df2ec 2014-04-15 **Luca Guidi** Load Mapper when the framework is loaded
+
+de21101 2014-04-15 **Luca Guidi** Extracted Mapping::Collection::REPOSITORY_SUFFIX constant
+
+b4ed0fe 2014-04-15 **Luca Guidi** Expose Mapper#load! to make Lotus::Model thread safe
+
+0936848 2014-04-14 **Luca Guidi** Moved UnmappedCollectionError under a separated file
+
+b6e49ff 2014-04-14 **Luca Guidi** Removed serialization responsibility from Mapper
+
+9057fbd 2014-04-14 **Luca Guidi** Removed unnecessary conditional in test
+
+43c462f 2014-04-14 **Luca Guidi** Renamed Lotus::Model::Mapping::Collection#key into #identity
+
+af59039 2014-04-14 **Luca Guidi** Removed serialization responsibility from Sql::Command
+
+92101bb 2014-04-14 **Luca Guidi** Removed deserialization responsibility from Sql::Query
+
+04e9597 2014-04-14 **Luca Guidi** Rewritten Sql::Command, it now works on scoped queries
+
+eb49746 2014-04-14 **Luca Guidi** Coerce with the right type the primary key for Repository.find
+
+daf3e04 2014-04-14 **Luca Guidi** Implemented Command for mutation actions such as insert, update, delete. Removed serialization responsibility to the adapter. Removed unused code.
+
+5ae8b11 2014-04-13 **Luca Guidi** Sql and Memory adapter are now using Query to serve #all, #find, #first, #last
+
+b0a35c5 2014-04-13 **Luca Guidi** Implemented Query#asc and #desc
+
+ef2d1fa 2014-04-13 **Luca Guidi** Make querying thread safe for MemoryAdapter
+
+db7e699 2014-04-12 **Luca Guidi** Implemented Query#select
+
+2d83581 2014-04-12 **Luca Guidi** Implemented Query#exist?
+
+13cfde0 2014-04-12 **Luca Guidi** Implemented Query#exclude
+
+79596de 2014-04-12 **Luca Guidi** Implemented Query#range
+
+70df238 2014-04-12 **Luca Guidi** Implemented Query#interval
+
+a0cbb8c 2014-04-12 **Luca Guidi** Implemented Query#min
+
+41e3d69 2014-04-12 **Luca Guidi** Implemented Query#max
+
+5577283 2014-04-12 **Luca Guidi** Changed the semantic of Query#average: let return a float if needed, handle strings and nil values
+
+3e1bddc 2014-04-12 **Luca Guidi** Implemented Query#sum
+
+97d0fb9 2014-04-12 **Luca Guidi** Implemented Lotus::Model::Adapters::Memory::Query#average
+
+d7068b5 2014-04-12 **Luca Guidi** Implemented Lotus::Model::Adapters::Sql::Query#average
+
+21abc27 2014-04-10 **Luca Guidi** Introduced Sql::Query
+
+7b63b7f 2014-04-10 **Luca Guidi** Implemented Memory::Query#count
+
+517a89a 2014-04-10 **Luca Guidi** Make the results of Repository queries lazy
+
+e6a756c 2014-04-10 **Luca Guidi** Renamed adapters with the "Adapter" suffix, in order to keep namespaces free.
+
+8a076b9 2014-04-10 **Luca Guidi** Implemented Query#or, #limit and #offset
+
+388957d 2014-04-09 **Luca Guidi** Added tests for SQL adapter and implemented #where, #and and #order for all the adapters
+
+5a97c12 2014-04-09 **Luca Guidi** Initial design for quering the datasource
+
+6f804db 2014-04-08 **Luca Guidi** Use Lotus::Utils::Kernel conversions
+
+4ae6967 2014-04-07 **Luca Guidi** Allow the mapper to specify the primary key of a collection with Lotus::Model::Mapper::Collection#key.
+
+85def40 2014-04-07 **Luca Guidi** Extracted Lotus::Model::Adapters::Memory::Collection::PrimaryKey
+
+ff8d6d4 2014-04-07 **Luca Guidi** Lotus::Repository.collection is now configured by the framework internals.
+
+122e040 2014-04-02 **Luca Guidi** Introduced attributes mapping and (de)serializations policies based on it.
+
+f925ebc 2014-03-26 **Luca Guidi** Lotus::Entity#id is always the primary key
+
+0bf8bb5 2014-03-26 **Luca Guidi** Introduced Lotus::Model::Adapters::Sql
+
+cfbed99 2014-03-26 **Luca Guidi** Lotus::Model::Repository => Lotus::Repository
+
+3a72d68 2014-03-26 **Luca Guidi** Lotus::Model::Entity => Lotus::Entity
+
+ed29d2d 2014-03-26 **Luca Guidi** Preload Lotus::Model::Repository
+
+f1bda7f 2014-03-26 **Luca Guidi** Improved tests and better semantic for Lotus::Model::Repository
+
+65b8e1a 2014-03-26 **Luca Guidi** Tests and thready safety for Lotus::Model::Adapters::Memory
+
+63d9fc5 2014-03-26 **Luca Guidi** When generate Entity#initialize use class attribute 'attributes', instead of the homonym argument
+
+442987d 2014-02-17 **Luca Guidi** Lotus::Model::Repository.find raises a Lotus::Model::RecordNotFound exception if it can't find a record, associated with the given ID
+
+c2b94e0 2014-02-15 **Luca Guidi** Ensure memory adapted is able to find a record for a string id
+
+b258ea0 2014-02-07 **Luca Guidi** Make Repository to work with entities
+
+0371b41 2014-02-05 **Luca Guidi** Implemented Entity
+
+9d2bfe3 2014-02-05 **Luca Guidi** Renamed "object" in "entity" in method signatures. Repositories and adapters work on objects that are aware of the identity's concept.
+
+be0e4e0 2014-02-05 **Luca Guidi** Extracted Abstract adapter and made Memory to inherit from it
+
+3ca28af 2014-02-05 **Luca Guidi** Let Repository to delegate operations to the current adapter
+
+3318bd1 2014-02-05 **Luca Guidi** Made Repository methods to accept one object instead of a collection
+
+baf378a 2014-02-05 **Luca Guidi** Implemented Repository.delete
+
+1b8c0a0 2014-02-05 **Luca Guidi** Implemented Repository.persist, .create and .update
+
+c6bde87 2014-02-05 **Luca Guidi** Implemented Repository.find
+
+a45248f 2014-02-05 **Luca Guidi** Initial mess

data/README.md

@@ -3,26 +3,26 @@
 A persistence framework for [Lotus](http://lotusrb.org).
 
 It delivers a convenient public API to execute queries and commands against a database.
-The architecture allows to keep business logic (entities) separated from details such as persistence or validations.
+The architecture eases keeping the business logic (entities) separated from details such as persistence or validations.
 
 It implements the following concepts:
 
   * [Entity](#entities) - An object defined by its identity.
   * [Repository](#repositories) - An object that mediates between the entities and the persistence layer.
-  * [Data Mapper](#datamapper) - A persistence mapper that keep entities independent from database details.
-  * [Adapter](#adapters) – A database adapter.
-  * [Query](#queries) - An object that represents a database query.
+  * [Data Mapper](#data-mapper) - A persistence mapper that keep entities independent from database details.
+  * [Adapter](#adapter) – A database adapter.
+  * [Query](#query) - An object that represents a database query.
 
-Like all the other Lotus compontents, it can be used as a standalone framework or within a full Lotus application.
+Like all the other Lotus components, it can be used as a standalone framework or within a full Lotus application.
 
 ## Status
 
-[![Gem Version](https://badge.fury.io/rb/lotus-model.png)](http://badge.fury.io/rb/lotus-model)
-[![Build Status](https://secure.travis-ci.org/lotus/model.png?branch=master)](http://travis-ci.org/lotus/model?branch=master)
-[![Coverage](https://coveralls.io/repos/lotus/model/badge.png?branch=master)](https://coveralls.io/r/lotus/model)
-[![Code Climate](https://codeclimate.com/github/lotus/model.png)](https://codeclimate.com/github/lotus/model)
-[![Dependencies](https://gemnasium.com/lotus/model.png)](https://gemnasium.com/lotus/model)
-[![Inline docs](http://inch-pages.github.io/github/lotus/model.png)](http://inch-pages.github.io/github/lotus/model)
+[![Gem Version](https://badge.fury.io/rb/lotus-model.svg)](http://badge.fury.io/rb/lotus-model)
+[![Build Status](https://secure.travis-ci.org/lotus/model.svg?branch=master)](http://travis-ci.org/lotus/model?branch=master)
+[![Coverage](https://img.shields.io/coveralls/lotus/model/master.svg)](https://coveralls.io/r/lotus/model)
+[![Code Climate](https://img.shields.io/codeclimate/github/lotus/model.svg)](https://codeclimate.com/github/lotus/model)
+[![Dependencies](https://gemnasium.com/lotus/model.svg)](https://gemnasium.com/lotus/model)
+[![Inline docs](http://inch-ci.org/github/lotus/model.png)](http://inch-ci.org/github/lotus/model)
 
 ## Contact
 
@@ -35,7 +35,7 @@ Like all the other Lotus compontents, it can be used as a standalone framework o
 
 ## Rubies
 
-__Lotus::View__ supports Ruby (MRI) 2+
+__Lotus::Model__ supports Ruby (MRI) 2+
 
 ## Installation
 
@@ -58,7 +58,7 @@ Or install it yourself as:
 An object that is defined by its identity.
 
 An entity is the core of an application, where the part of the domain logic is implemented.
-It's a small, cohesive object that express coherent and meagniful behaviors.
+It's a small, cohesive object that expresses coherent and meaningful behaviors.
 
 It deals with one and only one responsibility that is pertinent to the
 domain of the application, without caring about details such as persistence
@@ -101,18 +101,18 @@ rest of the framework is able to accept any object that implements the interface
 
 ### Repositories
 
-A object that mediates between entites and the persistence layer.
+An object that mediates between entities and the persistence layer.
 It offers a standardized API to query and execute commands on a database.
 
-A repository is **storage idenpendent**, all the queries and commands are
+A repository is **storage independent**, all the queries and commands are
 delegated to the current adapter.
 
 This architecture has several advantages:
 
-  * Applications depends on an standard API, instead of low level details
+  * Applications depend on a standard API, instead of low level details
     (Dependency Inversion principle)
 
-  * Applications depends on a stable API, that doesn't change if the
+  * Applications depend on a stable API, that doesn't change if the
     storage changes
 
   * Developers can postpone storage decisions
@@ -125,9 +125,10 @@ When a class includes `Lotus::Repository`, it will receive the following interfa
 
   * `.persist(entity)` – Create or update an entity
   * `.create(entity)`  – Create a record for the given entity
-  * `.update(entity)`  – Update the record correspoding to the given entity
-  * `.delete(entity)`  – Delete the record correspoding to the given entity
+  * `.update(entity)`  – Update the record corresponding to the given entity
+  * `.delete(entity)`  – Delete the record corresponding to the given entity
   * `.all`   - Fetch all the entities from the collection
+  * `.find`  - Fetch an entity from the collection by its ID
   * `.first` - Fetch the first entity from the collection
   * `.last`  - Fetch the last entity from the collection
   * `.clear` - Delete all the records from the collection
@@ -182,11 +183,11 @@ This is a **huge improvement**, because:
 
   * It expresses a clear intent.
 
-  * The caller can be easily tested in isolation. It's just a matter of stub this method.
+  * The caller can be easily tested in isolation. It's just a matter of stubbing this method.
 
   * If we change the storage, the callers aren't affected.
 
-Here an extended example of a repository that uses the SQL adapter.
+Here is an extended example of a repository that uses the SQL adapter.
 
 ```ruby
 class ArticleRepository
@@ -230,8 +231,8 @@ end
 
 ### Data Mapper
 
-A persistence mapper that keep entities independent from database details.
-It's database independent, it can work with SQL, document, and even with key/value stores.
+A persistence mapper that keeps entities independent from database details.
+It is database independent, it can work with SQL, document, and even with key/value stores.
 
 The role of a data mapper is to translate database columns into the corresponding attribute of an entity.
 
@@ -250,7 +251,7 @@ end
 ```
 
 For simplicity sake, imagine that the mapper above is used with a SQL database.
-We use `#collection` to indicate the table that we want to map, `#entity` to indicate the class that we want to associate.
+We use `#collection` to indicate the name of the table that we want to map, `#entity` to indicate the class that we want to associate.
 In the end, each `#attribute` call, is to associate the column with a Ruby type.
 
 For advanced mapping and legacy databases, please have a look at the API doc.
@@ -263,7 +264,7 @@ An adapter is a concrete implementation of persistence logic for a specific data
   * SqlAdapter
   * MemoryAdapter
 
-An adapter can be associated to one or multiple repositories.
+An adapter can be associated with one or multiple repositories.
 
 ```ruby
 require 'pg'
@@ -280,18 +281,18 @@ PersonRepository.adapter  = adapter
 ArticleRepository.adapter = adapter
 ```
 
-In the example above, we reuse the adpter because the target tables (`people` and `articles`) are defined in the same database.
+In the example above, we reuse the adapter because the target tables (`people` and `articles`) are defined in the same database.
 **As rule of thumb, one adapter instance per database.**
 
 ### Query
 
 An object that implements an interface for quering the database.
 This interface may vary, according to the adapter's specifications.
-Think of an adapter for Redis, it will probably employ different strategies to filter records from an SQL query object.
+Think of an adapter for Redis, it will probably employ different strategies to filter records than an SQL query object.
 
 ### Conventions
 
-  * A repository must be named after an entity, by appeding `"Repository"` to the entity class name (eg. `Article` => `ArticleRepository`).
+  * A repository must be named after an entity, by appending `"Repository"` to the entity class name (eg. `Article` => `ArticleRepository`).
 
 ### Thread safety
 

data/lib/lotus/entity.rb

@@ -6,7 +6,7 @@ module Lotus
   #
   # An entity is the core of an application, where the part of the domain
   # logic is implemented. It's a small, cohesive object that express coherent
-  # and meagniful behaviors.
+  # and meaningful behaviors.
   #
   # It deals with one and only one responsibility that is pertinent to the
   # domain of the application, without caring about details such as persistence
@@ -24,15 +24,14 @@ module Lotus
   #     self.attributes = :name, :age
   #   end
   #
-  # When a class includes `Lotus::Entity` it will receive the following interface:
+  # When a class includes `Lotus::Entity` the `.attributes=` method is exposed.
+  # By then calling the `.attributes=` class method, the following methods are
+  # added:
   #
   #   * #id
   #   * #id=
   #   * #initialize(attributes = {})
   #
-  # Also, the usage of `.attributes=` defines accessors for the given attribute
-  # names.
-  #
   # If we expand the code above in pure Ruby, it would be:
   #
   # @example Pure Ruby
@@ -72,9 +71,7 @@ module Lotus
     #     include Lotus::Entity
     #   end
     def self.included(base)
-      base.class_eval do
-        extend ClassMethods
-      end
+      base.extend ClassMethods
     end
 
     module ClassMethods
@@ -113,11 +110,7 @@ module Lotus
           end
         }
 
-        @attributes.each do |attr|
-          class_eval do
-            attr_accessor attr
-          end
-        end
+        attr_accessor *@attributes
       end
 
       def attributes

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

@@ -129,12 +129,12 @@ module Lotus
           #
           # @example Range
           #
-          #   query.where(year: 1900..1982)
+          #   query.exclude(year: 1900..1982)
           #
           # @example Multiple conditions
           #
-          #   query.where(language: 'java')
-          #        .where(company: 'enterprise')
+          #   query.exclude(language: 'java')
+          #        .exclude(company: 'enterprise')
           def exclude(condition)
             column, value = _expand_condition(condition)
             conditions.push(Proc.new{ reject! {|r| r.fetch(column) == value} })
@@ -261,7 +261,7 @@ module Lotus
 
           # Returns the sum of the values for the given column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return [Numeric]
           #
@@ -286,7 +286,7 @@ module Lotus
 
           # Returns the average of the values for the given column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return [Numeric]
           #
@@ -305,7 +305,7 @@ module Lotus
 
           # Returns the maximum value for the given column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return result
           #
@@ -320,7 +320,7 @@ module Lotus
 
           # Returns the minimum value for the given column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return result
           #
@@ -335,7 +335,7 @@ module Lotus
 
           # Returns the difference between the MAX and MIN for the given column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return [Numeric]
           #
@@ -355,7 +355,7 @@ module Lotus
           # Returns a range of values between the MAX and the MIN for the given
           # column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return [Range]
           #

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

@@ -180,14 +180,14 @@ module Lotus
           #
           # @example Range
           #
-          #   query.where(year: 1900..1982)
+          #   query.exclude(year: 1900..1982)
           #
           #   # => SELECT * FROM `people` WHERE ((`year` < 1900) AND (`year` > 1982))
           #
           # @example Multiple conditions
           #
-          #   query.where(language: 'java')
-          #        .where(company: 'enterprise')
+          #   query.exclude(language: 'java')
+          #        .exclude(company: 'enterprise')
           #
           #   # => SELECT * FROM `projects` WHERE (`language` != 'java') AND (`company` != 'enterprise')
           def exclude(condition)
@@ -338,7 +338,7 @@ module Lotus
 
           # Returns the sum of the values for the given column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return [Numeric]
           #
@@ -355,7 +355,7 @@ module Lotus
 
           # Returns the average of the values for the given column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return [Numeric]
           #
@@ -374,7 +374,7 @@ module Lotus
 
           # Returns the maximum value for the given column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return result
           #
@@ -397,7 +397,7 @@ module Lotus
 
           # Returns the minimum value for the given column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return result
           #
@@ -420,7 +420,7 @@ module Lotus
 
           # Returns the difference between the MAX and MIN for the given column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return [Numeric]
           #
@@ -441,7 +441,7 @@ module Lotus
           # Returns a range of values between the MAX and the MIN for the given
           # column.
           #
-          # @param column [Symbol] the colum name
+          # @param column [Symbol] the column name
           #
           # @return [Range]
           #