hanami-model 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a99014d711cf7b1e4fd9469acdee5a7fefb69d9f
-  data.tar.gz: 71781d9d98ea8e5b5e75bd0df4527ed47f6e6b3a
+  metadata.gz: 29439a9ce3f9aa3cdd0600a6a04a0316209eb91d
+  data.tar.gz: fa6bb573a2e58f14cc3b09126168fdc4ed88f72a
 SHA512:
-  metadata.gz: 312c76418b3d0e8a8c7c41125c009f03bfdd03c4102de60ed87806df705c9584922ff1afc952b6ae383a86805b209333c1ba31dbfb4706810028bcba598e88f9
-  data.tar.gz: 5bba6c44f8cebef794b53c7b7a94d897f09098440feec568f293602fc46e0593c52ce090451cdcaee76e261fc0a908d731aa82ab552afb172b078f07e3be46ba
+  metadata.gz: 10a26d11cb59a13d93664a4e9fd29d35f8fa6ce788d95281b7b805ed04cf9a4ca390ace931c3a943ee65fc8a55b138f9931d5c351a50d09b19d8acf8b1845cae
+  data.tar.gz: 5d5ef5cf0bdee581b7d4d9272fd064c3c8973ea4a6da813fe318f49c24b00a285c6a4b2a410166b19560ddbc6a4a9a69f4a3221d79efc952f3d40e8234599a63

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Hanami::Model
 A persistence layer for Hanami
 
+## v0.6.1 - 2016-02-05
+### Changed
+- [Hélio Costa e Silva & Pascal Betz] Mapping SQL Adapter's errors as `Hanami::Model` errors
+
 ## v0.6.0 - 2016-01-22
 ### Changed
 - [Luca Guidi] Renamed the project

data/EXAMPLE.md

@@ -58,7 +58,8 @@ We have two entities in our application: `Author` and `Article`.
 ```ruby
 Author = Struct.new(:id, :name) do
   def initialize(attributes = {})
-    @id, @name = attributes.values_at(:id, :name)
+    self.id = attributes[:id]
+    self.name = attributes[:name]
   end
 end
 
@@ -159,7 +160,7 @@ We instantiate and persist an `Author` and a few `Articles` for our example:
 
 ```ruby
 author = Author.new(name: 'Luca')
-AuthorRepository.create(author)
+author = AuthorRepository.create(author)
 
 articles = [
   Article.new(title: 'Announcing Hanami',              author_id: author.id, comments_count: 123, published: true),

data/README.md

@@ -19,8 +19,8 @@ Like all the other Hanami components, it can be used as a standalone framework o
 
 [![Gem Version](https://badge.fury.io/rb/hanami-model.svg)](http://badge.fury.io/rb/hanami-model)
 [![Build Status](https://secure.travis-ci.org/hanami/model.svg?branch=master)](http://travis-ci.org/hanami/model?branch=master)
-[![Coverage](https://img.shields.io/coveralls/hanami/model/master.svg)](https://coveralls.io/r/hanami/model)
-[![Code Climate](https://img.shields.io/codeclimate/github/hanami/model.svg)](https://codeclimate.com/github/hanami/model)
+[![Coverage](https://coveralls.io/repos/github/hanami/model/badge.svg?branch=master)](https://coveralls.io/github/hanami/model?branch=master)
+[![Code Climate](https://codeclimate.com/github/hanami/model/badges/gpa.svg)](https://codeclimate.com/github/hanami/model)
 [![Dependencies](https://gemnasium.com/hanami/model.svg)](https://gemnasium.com/hanami/model)
 [![Inline docs](http://inch-ci.org/github/hanami/model.png)](http://inch-ci.org/github/hanami/model)
 
@@ -470,6 +470,20 @@ If you need more information regarding those methods, you can use comments from
 
 Think of an adapter for Redis, it will probably employ different strategies to filter records than an SQL query object.
 
+### Model Error Coercions
+
+All adapters' errors are encapsulated into Hanami error classes.
+
+Hanami Model may raise the following exceptions:
+
+  * `Hanami::Model::UniqueConstraintViolationError`
+  * `Hanami::Model::ForeignKeyConstraintViolationError`
+  * `Hanami::Model::NotNullConstraintViolationError`
+  * `Hanami::Model::CheckConstraintViolationError`
+
+For any other adapter's errors, Hanami will raise the `Hanami::Model::InvalidCommandError` object.
+All errors contains the root cause and the full error message thrown by sql adapter.
+
 ### Conventions
 
   * A repository must be named after an entity, by appending `"Repository"` to the entity class name (eg. `Article` => `ArticleRepository`).

data/lib/hanami/model.rb

@@ -11,42 +11,6 @@ module Hanami
   #
   # @since 0.1.0
   module Model
-    # Error for non persisted entity
-    # It's raised when we try to update or delete a non persisted entity.
-    #
-    # @since 0.1.0
-    #
-    # @see Hanami::Repository.update
-    class NonPersistedEntityError < Hanami::Model::Error
-    end
-
-    # Error for invalid mapper configuration
-    # It's raised when mapping is not configured correctly
-    #
-    # @since 0.2.0
-    #
-    # @see Hanami::Configuration#mapping
-    class InvalidMappingError < Hanami::Model::Error
-    end
-
-    # Error for invalid raw command syntax
-    #
-    # @since 0.5.0
-    class InvalidCommandError < Hanami::Model::Error
-      def initialize(message = "Invalid command")
-        super
-      end
-    end
-
-    # Error for invalid raw query syntax
-    #
-    # @since 0.3.1
-    class InvalidQueryError < Hanami::Model::Error
-      def initialize(message = "Invalid query")
-        super
-      end
-    end
-
     include Utils::ClassAttribute
 
     # Framework configuration
@@ -204,6 +168,5 @@ module Hanami
         duplicated.configure(&blk) if block_given?
       end
     end
-
   end
 end

data/lib/hanami/model/adapters/sql/command.rb

@@ -9,6 +9,15 @@ module Hanami
         # @api private
         # @since 0.1.0
         class Command
+          # @api private
+          # @since 0.6.1
+          SEQUEL_TO_HANAMI_ERROR_MAPPING = {
+            'Sequel::UniqueConstraintViolation'     => Hanami::Model::UniqueConstraintViolationError,
+            'Sequel::ForeignKeyConstraintViolation' => Hanami::Model::ForeignKeyConstraintViolationError,
+            'Sequel::NotNullConstraintViolation'    => Hanami::Model::NotNullConstraintViolationError,
+            'Sequel::CheckConstraintViolation'      => Hanami::Model::CheckConstraintViolationError
+          }.freeze
+
           # Initialize a command
           #
           # @param query [Hanami::Model::Adapters::Sql::Query]
@@ -30,9 +39,7 @@ module Hanami
           # @api private
           # @since 0.1.0
           def create(entity)
-            @collection.insert(entity)
-          rescue Sequel::DatabaseError => e
-            raise Hanami::Model::Error.new(e.message)
+            _handle_database_error { @collection.insert(entity) }
           end
 
           # Updates the corresponding record for the given entity.
@@ -44,9 +51,7 @@ module Hanami
           # @api private
           # @since 0.1.0
           def update(entity)
-            @collection.update(entity)
-          rescue Sequel::DatabaseError => e
-            raise Hanami::Model::Error.new(e.message)
+            _handle_database_error { @collection.update(entity) }
           end
 
           # Deletes all the records for the current query.
@@ -59,15 +64,25 @@ module Hanami
           # @api private
           # @since 0.1.0
           def delete
-            @collection.delete
-          rescue Sequel::DatabaseError => e
-            raise Hanami::Model::Error.new(e.message)
+            _handle_database_error { @collection.delete }
           end
 
           alias_method :clear, :delete
+
+          private
+
+          # Handles any possible Adapter's Database Error
+          #
+          # @api private
+          # @since 0.6.1
+          def _handle_database_error
+            yield
+          rescue Sequel::DatabaseError => e
+            error_class = SEQUEL_TO_HANAMI_ERROR_MAPPING.fetch(e.class.name, Hanami::Model::InvalidCommandError)
+            raise error_class, e.message
+          end
         end
       end
     end
   end
 end
-

data/lib/hanami/model/error.rb

@@ -1,7 +1,79 @@
 module Hanami
   module Model
+
+    # Default Error class
+    #
     # @since 0.5.1
-    class Error < ::StandardError
+    Error = Class.new(::StandardError)
+
+    # Error for non persisted entity
+    # It's raised when we try to update or delete a non persisted entity.
+    #
+    # @since 0.1.0
+    #
+    # @see Hanami::Repository.update
+    NonPersistedEntityError = Class.new(Error)
+
+    # Error for invalid mapper configuration
+    # It's raised when mapping is not configured correctly
+    #
+    # @since 0.2.0
+    #
+    # @see Hanami::Configuration#mapping
+    InvalidMappingError = Class.new(Error)
+
+    # Error for invalid raw command syntax
+    #
+    # @since 0.5.0
+    class InvalidCommandError < Error
+      def initialize(message = "Invalid command")
+        super
+      end
+    end
+
+    # Error for invalid raw query syntax
+    #
+    # @since 0.3.1
+    class InvalidQueryError < Error
+      def initialize(message = "Invalid query")
+        super
+      end
+    end
+
+    # Error for Unique Constraint Violation
+    #
+    # @since 0.6.1
+    class UniqueConstraintViolationError < Error
+      def initialize(message = "Unique constraint has been violated")
+        super
+      end
+    end
+
+    # Error for Foreign Key Constraint Violation
+    #
+    # @since 0.6.1
+    class ForeignKeyConstraintViolationError < Error
+      def initialize(message = "Foreign key constraint has been violated")
+        super
+      end
+    end
+
+    # Error for Not Null Constraint Violation
+    #
+    # @since 0.6.1
+    class NotNullConstraintViolationError < Error
+      def initialize(message = "NOT NULL constraint has been violated")
+        super
+      end
+    end
+
+    # Error for Check Constraint Violation raised by Sequel
+    #
+    # @since 0.6.1
+    class CheckConstraintViolationError < Error
+      def initialize(message = "Check constraint has been violated")
+        super
+      end
     end
   end
 end

data/lib/hanami/model/version.rb

@@ -3,6 +3,6 @@ module Hanami
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.6.0'.freeze
+    VERSION = '0.6.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-model
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils