lotus-model 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de9019e132ab36bb7b30223c52e247df84e3cf3e
-  data.tar.gz: d56eeb3a71e31193b1509527f24ac8f0822df5f0
+  metadata.gz: f21fa9e59f4e1cb1f1892e30557d39293abada84
+  data.tar.gz: 10adc53a8de64a6b6ffbe17d99c62af5c9d37b16
 SHA512:
-  metadata.gz: 8449498885c9eda612f978aed61dfbe362e213b8c392ce86cb37d9586f5d0865b010f9900246b3621d63627e0900f43a52a0dfe954e9b507306987ab1ef9755b
-  data.tar.gz: 478a4d4bf0323970ee7adf7733123418745aa135db6dc79142e9f203962793b039e2e017fca8a3d9f1bee01dd3f7511068220c465a44e29399a57c950eea9e61
+  metadata.gz: 9e2ccc8f6beac3d0fde6826d9f2a6c8d5eafc8084ce0cbc1e6d61e8be89d0ee6f909f0e7a2b9df30c2517d5d1a3f3470d0205379a8d42c670a3aed78f69836c5
+  data.tar.gz: 55c49d4330fa045ace6a741ace5e4ad005c2aaa5680e1c1d5fcd11627f50829a5a5831f37948892a9c3834ea5b4f40d227896e830fd6b3bbc4396f9924c221ab

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Lotus::Model
 A persistence layer for Lotus
 
+## v0.5.1 - 2016-01-12
+### Added
+- [Taylor Finnell] Let `Lotus::Model::Configuration#adapter` to accept arbitrary options (eg. `adapter type: :sql, uri: 'jdbc:...', after_connect: Proc.new { |connection| connection.auto_commit(true) }`)
+
+### Changed
+- [Andrey Deryabin] Improved `Entity#inspect`
+- [Karim Tarek] Introduced `Lotus::Model::Error` and let all the framework exceptions to inherit from it.
+
+### Fixed
+- [Luca Guidi] Improved error message when trying to use a repository without mapping the corresponding collections
+- [Sean Collins] Improved error message when trying to create database, but it fails (eg. missing `createdb` executable)
+- [Andrey Deryabin] Improved error message when trying to drop database, but a client is still connected (useful for PostgreSQL)
+- [Hiếu Nguyễn] Improved error message when trying to "prepare" database, but it fails
+
 ## v0.5.0 - 2015-09-30
 ### Added
 - [Brenno Costa] Official support for JRuby 9k+

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014-2015 Luca Guidi
+Copyright © 2014-2016 Luca Guidi
 
 MIT License
 

data/README.md

@@ -31,7 +31,7 @@ Like all the other Lotus components, it can be used as a standalone framework or
 * API Doc: http://rdoc.info/gems/lotus-model
 * Bugs/Issues: https://github.com/lotus/model/issues
 * Support: http://stackoverflow.com/questions/tagged/lotus-ruby
-* Chat: https://gitter.im/lotus/chat
+* Chat: https://chat.lotusrb.org
 
 ## Rubies
 
@@ -624,4 +624,4 @@ __Lotus::Model__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2015 Luca Guidi – Released under MIT License
+Copyright © 2014-2016 Luca Guidi – Released under MIT License

data/lib/lotus/entity.rb

@@ -140,15 +140,13 @@ module Lotus
       #   DeletedUser.attributes => #<Set: {:id, :name, :deleted_at}>
       #
       def attributes(*attrs)
-        if attrs.any?
-          attrs = Lotus::Utils::Kernel.Array(attrs)
-          self.attributes.merge attrs
+        return @attributes ||= Set.new unless attrs.any?
 
-          attrs.each do |attr|
-            define_attr_accessor(attr) if defined_attribute?(attr)
+        Lotus::Utils::Kernel.Array(attrs).each do |attr|
+          if allowed_attribute_name?(attr)
+            define_attr_accessor(attr)
+            self.attributes << attr
           end
-        else
-          @attributes ||= Set.new
         end
       end
 
@@ -164,11 +162,10 @@ module Lotus
 
       # Check if attr_reader define the given attribute
       #
-      # @since 0.3.1
+      # @since 0.5.1
       # @api private
-      def defined_attribute?(name)
-        name == :id ||
-          !instance_methods.include?(name)
+      def allowed_attribute_name?(name)
+        !instance_methods.include?(name)
       end
 
       protected
@@ -223,9 +220,51 @@ module Lotus
     #   user = User.new(id: 23, name: 'Luca')
     #   user.to_h # => { :id => 23, :name => "Luca" }
     def to_h
-      Hash[self.class.attributes.map { |a| [a, public_send(a)] }]
+      Hash[attribute_names.map { |a| [a, read_attribute(a)] }]
+    end
+
+    # Return the set of attribute names
+    #
+    # @since 0.5.1
+    #
+    # @example
+    #   require 'lotus/model'
+    #   class User
+    #     include Lotus::Entity
+    #     attributes :name
+    #   end
+    #
+    #   user = User.new(id: 23, name: 'Luca')
+    #   user.attribute_names # #<Set: {:id, :name}>
+    def attribute_names
+      self.class.attributes
+    end
+
+    # Return the contents of the entity as a nicely formatted string.
+    #
+    # Display all attributes of the entity for inspection (even if they are nil)
+    #
+    # @since 0.5.1
+    #
+    # @example
+    #   require 'lotus/model'
+    #   class User
+    #     include Lotus::Entity
+    #     attributes :name, :email
+    #   end
+    #
+    #   user = User.new(id: 23, name: 'Luca')
+    #   user.inspect # #<User:0x007fa7eefe0b58 @id=nil @name="Luca" @email=nil>
+    def inspect
+      attr_list = attribute_names.inject([]) do |res, name|
+        res << "@#{name}=#{read_attribute(name).inspect}"
+      end.join(' ')
+
+      "#<#{self.class.name}:0x00#{(__id__ << 1).to_s(16)} #{attr_list}>"
     end
 
+    alias_method :to_s, :inspect
+
     # Set attributes for entity
     #
     # @since 0.2.0
@@ -246,5 +285,14 @@ module Lotus
       end
     end
 
+    private
+
+    # Return the value by attribute name
+    #
+    # @since 0.5.1
+    # @api private
+    def read_attribute(attr_name)
+      public_send(attr_name)
+    end
   end
 end

data/lib/lotus/model.rb

@@ -4,6 +4,7 @@ require 'lotus/entity/dirty_tracking'
 require 'lotus/repository'
 require 'lotus/model/mapper'
 require 'lotus/model/configuration'
+require 'lotus/model/error'
 
 module Lotus
   # Model
@@ -16,7 +17,7 @@ module Lotus
     # @since 0.1.0
     #
     # @see Lotus::Repository.update
-    class NonPersistedEntityError < ::StandardError
+    class NonPersistedEntityError < Lotus::Model::Error
     end
 
     # Error for invalid mapper configuration
@@ -25,13 +26,13 @@ module Lotus
     # @since 0.2.0
     #
     # @see Lotus::Configuration#mapping
-    class InvalidMappingError < ::StandardError
+    class InvalidMappingError < Lotus::Model::Error
     end
 
     # Error for invalid raw command syntax
     #
     # @since 0.5.0
-    class InvalidCommandError < ::StandardError
+    class InvalidCommandError < Lotus::Model::Error
       def initialize(message = "Invalid command")
         super
       end
@@ -40,7 +41,7 @@ module Lotus
     # Error for invalid raw query syntax
     #
     # @since 0.3.1
-    class InvalidQueryError < ::StandardError
+    class InvalidQueryError < Lotus::Model::Error
       def initialize(message = "Invalid query")
         super
       end

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

@@ -11,7 +11,7 @@ module Lotus
       # @see Lotus::Model::Adapters::SqlAdapter#initialize
       #
       # @since 0.1.0
-      class DatabaseAdapterNotFound < ::StandardError
+      class DatabaseAdapterNotFound < Lotus::Model::Error
       end
 
       # It's raised when an adapter does not support a feature.
@@ -22,14 +22,14 @@ module Lotus
       # @see Lotus::Model::Adapters::Abstract#connection_string
       #
       # @since 0.3.0
-      class NotSupportedError < ::StandardError
+      class NotSupportedError < Lotus::Model::Error
       end
 
       # It's raised when an operation is requested to an adapter after it was
       # disconnected.
       #
       # @since 0.5.0
-      class DisconnectedAdapterError < ::StandardError
+      class DisconnectedAdapterError < Lotus::Model::Error
         def initialize
           super "You have tried to perform an operation on a disconnected adapter"
         end
@@ -85,10 +85,13 @@ module Lotus
         #
         # @param uri [String] the optional connection string to the database
         #
+        # @param options [Hash] a list of non-mandatory adapter options
+        #
         # @since 0.1.0
-        def initialize(mapper, uri = nil)
+        def initialize(mapper, uri = nil, options = {})
           @mapper = mapper
           @uri    = uri
+          @options = options
         end
 
         # Creates or updates a record in the database for the given entity.

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

@@ -59,6 +59,7 @@ module Lotus
         #
         # @param mapper [Object] the database mapper
         # @param uri [String] the connection uri
+        # @param options [Hash] a hash of non-mandatory adapter options
         #
         # @return [Lotus::Model::Adapters::FileSystemAdapter]
         #
@@ -66,7 +67,7 @@ module Lotus
         #
         # @api private
         # @since 0.2.0
-        def initialize(mapper, uri)
+        def initialize(mapper, uri, options = {})
           super
           prepare(uri)
 

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

@@ -24,6 +24,7 @@ module Lotus
         #
         # @param mapper [Object] the database mapper
         # @param uri [String] the connection uri (ignored)
+        # @param options [Hash] a hash of non mandatory adapter options
         #
         # @return [Lotus::Model::Adapters::MemoryAdapter]
         #
@@ -31,7 +32,7 @@ module Lotus
         #
         # @api private
         # @since 0.1.0
-        def initialize(mapper, uri = nil)
+        def initialize(mapper, uri = nil, options = {})
           super
 
           @mutex       = Mutex.new

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

@@ -1,10 +1,12 @@
+require 'lotus/model/error'
+
 module Lotus
   module Model
     module Adapters
       # @since 0.2.0
-      class NoAdapterError < ::StandardError
+      class NoAdapterError < Lotus::Model::Error
         def initialize(method_name)
-          super("Cannot invoke `#{ method_name }' without selecting an adapter. Please check your framework configuration.")
+          super("Cannot invoke `#{ method_name }' on repository. Please check if `adapter' and `mapping' are set.")
         end
       end
 

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

@@ -28,6 +28,7 @@ module Lotus
         #
         # @param mapper [Object] the database mapper
         # @param uri [String] the connection uri for the database
+        # @param options [Hash] a hash of non-mandatory adapter options
         #
         # @return [Lotus::Model::Adapters::SqlAdapter]
         #
@@ -41,9 +42,9 @@ module Lotus
         #
         # @api private
         # @since 0.1.0
-        def initialize(mapper, uri)
+        def initialize(mapper, uri, options = {})
           super
-          @connection = Sequel.connect(@uri)
+          @connection = Sequel.connect(@uri, @options)
         rescue Sequel::AdapterNotFound => e
           raise DatabaseAdapterNotFound.new(e.message)
         end

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

@@ -6,7 +6,7 @@ module Lotus
       # Raised when an adapter class does not exist
       #
       # @since 0.2.0
-      class AdapterNotFound < ::StandardError
+      class AdapterNotFound < Lotus::Model::Error
         def initialize(adapter_name)
           super "Cannot find Lotus::Model adapter #{adapter_name}"
         end
@@ -46,6 +46,10 @@ module Lotus
         # @since 0.2.0
         attr_reader :uri
 
+        # @return [Hash] a list of non-mandatory options for the adapter
+        #
+        attr_reader :options
+
         # @return [String] the adapter class name
         #
         # @since 0.2.0
@@ -62,8 +66,12 @@ module Lotus
         #
         # @since 0.2.0
         def initialize(**options)
-          @type = options[:type]
-          @uri  = options[:uri]
+          opts     = options.dup
+
+          @type    = opts.delete(:type)
+          @uri     = opts.delete(:uri)
+          @options = opts
+
           @class_name ||= Lotus::Utils::String.new("#{@type}_adapter").classify
         end
 
@@ -94,7 +102,7 @@ module Lotus
         def instantiate_adapter(mapper)
           begin
             klass = Lotus::Utils::Class.load!(class_name, Lotus::Model::Adapters)
-            klass.new(mapper, uri)
+            klass.new(mapper, uri, options)
           rescue NameError
             raise AdapterNotFound.new(class_name)
           rescue => e

data/lib/lotus/model/error.rb

@@ -0,0 +1,7 @@
+module Lotus
+  module Model
+    # @since 0.5.1
+    class Error < ::StandardError
+    end
+  end
+end

data/lib/lotus/model/mapper.rb

@@ -8,7 +8,7 @@ module Lotus
     # @since 0.2.0
     #
     # @see Lotus::Model::Configuration#mapping
-    class NoMappingError < ::StandardError
+    class NoMappingError < Lotus::Model::Error
       def initialize
         super("Mapping is missing. Please check your framework configuration.")
       end

data/lib/lotus/model/mapping.rb

@@ -14,7 +14,7 @@ module Lotus
       # collection.
       #
       # @since 0.1.0
-      class UnmappedCollectionError < ::StandardError
+      class UnmappedCollectionError < Lotus::Model::Error
         def initialize(name)
           super("Cannot find collection: #{ name }")
         end
@@ -26,7 +26,7 @@ module Lotus
       # entity.
       #
       # @since 0.2.0
-      class EntityNotFound < ::StandardError
+      class EntityNotFound < Lotus::Model::Error
         def initialize(name)
           super("Cannot find class for entity: #{ name }")
         end
@@ -38,7 +38,7 @@ module Lotus
       # repository.
       #
       # @since 0.2.0
-      class RepositoryNotFound < ::StandardError
+      class RepositoryNotFound < Lotus::Model::Error
         def initialize(name)
           super("Cannot find class for repository: #{ name }")
         end

data/lib/lotus/model/migrator.rb

@@ -8,7 +8,7 @@ module Lotus
     # Migration error
     #
     # @since 0.4.0
-    class MigrationError < ::StandardError
+    class MigrationError < Lotus::Model::Error
     end
 
     # Define a migration
@@ -292,6 +292,8 @@ module Lotus
         Sequel.connect(
           configuration.adapter.uri
         )
+      rescue Sequel::AdapterNotFound
+        raise MigrationError.new("Current adapter (#{ configuration.adapter.type }) doesn't support SQL database operations.")
       end
 
       # Lotus::Model configuration

data/lib/lotus/model/migrator/mysql_adapter.rb

@@ -10,6 +10,14 @@ module Lotus
         # @api private
         def create
           new_connection(global: true).run %(CREATE DATABASE #{ database };)
+        rescue Sequel::DatabaseError => e
+          message = if e.message.match(/database exists/)
+            "Database creation failed. There is 1 other session using the database"
+          else
+            e.message
+          end
+
+          raise MigrationError.new(message)
         end
 
         # @since 0.4.0

data/lib/lotus/model/migrator/postgres_adapter.rb

@@ -26,7 +26,16 @@ module Lotus
         # @api private
         def create
           set_environment_variables
-          `createdb #{ database }`
+
+          call_db_command('createdb') do |error_message|
+            message = if error_message.match(/already exists/)
+              "createdb: database creation failed. There is 1 other session using the database."
+            else
+              error_message
+            end
+
+            raise MigrationError.new(message)
+          end
         end
 
         # @since 0.4.0
@@ -34,22 +43,14 @@ module Lotus
         def drop
           set_environment_variables
 
-          require 'open3'
-
-          Open3.popen3('dropdb', database) do |stdin, stdout, stderr, wait_thr|
-            exit_status = wait_thr.value
-
-            unless exit_status.success?
-              error_message = stderr.read
-
-              message = if error_message.match(/does not exist/)
-                "Cannot find database: #{ database }"
-              else
-                message
-              end
-
-              raise MigrationError.new(message)
+          call_db_command('dropdb') do |error_message|
+            message = if error_message.match(/does not exist/)
+              "Cannot find database: #{ database }"
+            else
+              error_message
             end
+
+            raise MigrationError.new(message)
           end
         end
 
@@ -96,6 +97,22 @@ module Lotus
         def dump_migrations_data
           system "pg_dump -t #{ migrations_table } #{ database } >> #{ escape(schema) }"
         end
+
+        # @since 0.5.1
+        # @api private
+        def call_db_command(command)
+          require 'open3'
+
+          begin
+            Open3.popen3(command, database) do |stdin, stdout, stderr, wait_thr|
+              unless wait_thr.value.success? # wait_thr.value is the exit status
+                yield stderr.read
+              end
+            end
+          rescue SystemCallError => e
+            yield e.message
+          end
+        end
       end
     end
   end

data/lib/lotus/model/version.rb

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

data/lotus-model.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_runtime_dependency 'lotus-utils', '~> 0.5'
+  spec.add_runtime_dependency 'lotus-utils', '~> 0.6'
   spec.add_runtime_dependency 'sequel',      '~> 4.9'
 
   spec.add_development_dependency 'bundler',  '~> 1.6'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lotus-model
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lotus-utils
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,7 @@ files:
 - lib/lotus/model/config/adapter.rb
 - lib/lotus/model/config/mapper.rb
 - lib/lotus/model/configuration.rb
+- lib/lotus/model/error.rb
 - lib/lotus/model/mapper.rb
 - lib/lotus/model/mapping.rb
 - lib/lotus/model/mapping/attribute.rb
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A persistence layer for Lotus