lotus-model 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 672ea74de3e6a010888dbbc8d0289284b6cba6cf
-  data.tar.gz: 9c5504b67e363bb70c258d62a0a77683474caf87
+  metadata.gz: 21b47eded2bba593382296d73c0727abf8ddd66e
+  data.tar.gz: 754980ca9235ce3e9793107df6ca404b8149b989
 SHA512:
-  metadata.gz: 17cc240a81a46c0420dab64e9cd3cb4f82de0c118656558cba64f7bbe0db5331019659e4f78a7657fed7b6454d41ae1b5d913b363c51e8a3690708d846496ead
-  data.tar.gz: 9def5cd833fe45e026744214f3700652a6906a7101d21016aa04997a5e64fb6c0a22125a73a032fa82756e4c2ed04d8fd93df9084dedf006fc4bcbc0919efe68
+  metadata.gz: 513bf99f0c78f425195c4f5267458b50b393ce39ee0de5247b1a9c8a53605b9ae2f8c4ecfbaf01539dcbea67958c1866fbe30fe010709f6996aed86b0cbed78c
+  data.tar.gz: 2082546bca510c65e6ca5ee453dfc9d49500589893443078282bf69eac16070973febcefb2da1313ea19c4a06297941c5c3c966776f2015e9b4f7ed220edd71b

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Lotus::Model
 A persistence layer for Lotus
 
+## v0.2.3 - 2015-02-13
+### Added
+- [Alfonso Uceda Pompa] Added support for database transactions in repositories
+
+### Fixed
+- [Luca Guidi] Ensure file system adapter old data is read when a new process is started
+
 ## v0.2.2 - 2015-01-18
 ### Added
 - [Luca Guidi] Coerce entities when persisted

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Luca Guidi
+Copyright © 2014-2015 Luca Guidi
 
 MIT License
 

data/README.md

@@ -75,7 +75,7 @@ Lotus::Model.configure do
   mapping do
     collection :users do
       entity      User
-      respository UserRepository
+      repository UserRepository
 
       attribute :id,   Integer
       attribute :name, String
@@ -421,7 +421,7 @@ Think of an adapter for Redis, it will probably employ different strategies to f
 
 ### Configurations
 
-  * Non-standard respository can be configured for an entity, by setting `repository` on the collection.
+  * Non-standard repository can be configured for an entity, by setting `repository` on the collection.
 
   ```ruby
   require 'lotus/model'
@@ -467,4 +467,4 @@ __Lotus::Model__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright 2014 Luca Guidi – Released under MIT License
+Copyright © 2014-2015 Luca Guidi – Released under MIT License

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

@@ -162,6 +162,24 @@ module Lotus
         def query(collection, &blk)
           raise NotImplementedError
         end
+
+        # Wraps the given block in a transaction.
+        #
+        # For performance reasons the block isn't in the signature of the method,
+        # but it's yielded at the lower level.
+        #
+        # Please note that it's only supported by some databases.
+        # For this reason, the options may vary from adapter to adapter.
+        #
+        # @param options [Hash] options for transaction
+        #
+        # @see Lotus::Model::Adapters::SqlAdapter#transaction
+        # @see Lotus::Model::Adapters::MemoryAdapter#transaction
+        #
+        # @since 0.2.3
+        def transaction(options = {})
+          raise NotImplementedError
+        end
       end
     end
   end

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

@@ -231,6 +231,12 @@ module Lotus
         def prepare(uri)
           @root = Pathname.new(uri.sub(FILE_SCHEME, ''))
           @root.mkpath
+
+          # Eager load previously persisted data.
+          @root.each_child do |collection|
+            collection = collection.basename.to_s.to_sym
+            read(collection)
+          end
         end
 
         # @api private

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

@@ -127,6 +127,19 @@ module Lotus
           end
         end
 
+        # WARNING: this is a no-op. For "real" transactions please use
+        # `SqlAdapter` or another adapter that supports them
+        #
+        # @param options [Hash] options for transaction
+        #
+        # @see Lotus::Model::Adapters::SqlAdapter#transaction
+        # @see Lotus::Model::Adapters::Abstract#transaction
+        #
+        # @since 0.2.3
+        def transaction(options = {})
+          yield
+        end
+
         private
 
         # Returns a collection from the given name.

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

@@ -132,6 +132,89 @@ module Lotus
           Sql::Query.new(_collection(collection), context, &blk)
         end
 
+        # Wraps the given block in a transaction.
+        #
+        # For performance reasons the block isn't in the signature of the method,
+        # but it's yielded at the lower level.
+        #
+        # @param options [Hash] options for transaction
+        # @option rollback [Symbol] the optional rollback policy: `:always` or
+        #   `:reraise`.
+        #
+        # @see Lotus::Repository::ClassMethods#transaction
+        #
+        # @since 0.2.3
+        # @api private
+        #
+        # @example Basic usage
+        #   require 'lotus/model'
+        #
+        #   class Article
+        #     include Lotus::Entity
+        #     attributes :title, :body
+        #   end
+        #
+        #   class ArticleRepository
+        #     include Lotus::Repository
+        #   end
+        #
+        #   article = Article.new(title: 'Introducing transactions',
+        #     body: 'lorem ipsum')
+        #
+        #   ArticleRepository.transaction do
+        #     ArticleRepository.dangerous_operation!(article) # => RuntimeError
+        #     # !!! ROLLBACK !!!
+        #   end
+        #
+        # @example Policy rollback always
+        #   require 'lotus/model'
+        #
+        #   class Article
+        #     include Lotus::Entity
+        #     attributes :title, :body
+        #   end
+        #
+        #   class ArticleRepository
+        #     include Lotus::Repository
+        #   end
+        #
+        #   article = Article.new(title: 'Introducing transactions',
+        #     body: 'lorem ipsum')
+        #
+        #   ArticleRepository.transaction(rollback: :always) do
+        #     ArticleRepository.create(article)
+        #     # !!! ROLLBACK !!!
+        #   end
+        #
+        #   # The operation is rolled back, even in no exceptions were raised.
+        #
+        # @example Policy rollback reraise
+        #   require 'lotus/model'
+        #
+        #   class Article
+        #     include Lotus::Entity
+        #     attributes :title, :body
+        #   end
+        #
+        #   class ArticleRepository
+        #     include Lotus::Repository
+        #   end
+        #
+        #   article = Article.new(title: 'Introducing transactions',
+        #     body: 'lorem ipsum')
+        #
+        #   ArticleRepository.transaction(rollback: :reraise) do
+        #     ArticleRepository.dangerous_operation!(article) # => RuntimeError
+        #     # !!! ROLLBACK !!!
+        #   end # => RuntimeError
+        #
+        #   # The operation is rolled back, but RuntimeError is re-raised.
+        def transaction(options = {})
+          @connection.transaction(options) do
+            yield
+          end
+        end
+
         private
 
         # Returns a collection from the given name.

data/lib/lotus/model/mapping/coercer.rb

@@ -55,7 +55,7 @@ module Lotus
             }
           end.join("\n")
 
-          instance_eval %{
+          instance_eval <<-EVAL, __FILE__, __LINE__
             def to_record(entity)
               if entity.id
                 Hash[#{ @collection.attributes.map{|name,(klass,mapped)| ":#{mapped},Lotus::Model::Mapping::Coercions.#{klass}(entity.#{name})"}.join(',') }]
@@ -71,7 +71,7 @@ module Lotus
             end
 
             #{ code }
-          }
+          EVAL
         end
       end
     end

data/lib/lotus/model/version.rb

@@ -3,6 +3,6 @@ module Lotus
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.2.2'.freeze
+    VERSION = '0.2.3'.freeze
   end
 end

data/lib/lotus/repository.rb

@@ -505,6 +505,49 @@ module Lotus
         @adapter.clear(collection)
       end
 
+      # Wraps the given block in a transaction.
+      #
+      # For performance reasons the block isn't in the signature of the method,
+      # but it's yielded at the lower level.
+      #
+      # Please note that it's only supported by some databases.
+      # For this reason, the accepted options may be different from adapter to
+      # adapter.
+      #
+      # For advanced scenarios, please check the documentation of each adapter.
+      #
+      # @param options [Hash] options for transaction
+      #
+      # @see Lotus::Model::Adapters::SqlAdapter#transaction
+      # @see Lotus::Model::Adapters::MemoryAdapter#transaction
+      #
+      # @since 0.2.3
+      #
+      # @example Basic usage with SQL adapter
+      #   require 'lotus/model'
+      #
+      #   class Article
+      #     include Lotus::Entity
+      #     attributes :title, :body
+      #   end
+      #
+      #   class ArticleRepository
+      #     include Lotus::Repository
+      #   end
+      #
+      #   article = Article.new(title: 'Introducing transactions',
+      #     body: 'lorem ipsum')
+      #
+      #   ArticleRepository.transaction do
+      #     ArticleRepository.dangerous_operation!(article) # => RuntimeError
+      #     # !!! ROLLBACK !!!
+      #   end
+      def transaction(options = {})
+        @adapter.transaction(options) do
+          yield
+        end
+      end
+
       private
       # Fabricates a query and yields the given block to access the low level
       # APIs exposed by the query itself.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lotus-model
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Luca Guidi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-18 00:00:00.000000000 Z
+date: 2015-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lotus-utils