hanami-model 1.1.0.beta1 → 1.1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c17cc417f16015bc4dafe69467c74e94198a10a
-  data.tar.gz: f18523f952dce748ae2eeba9c6cd4c206236d1cb
+  metadata.gz: f385cfbc1d27e9ea3a846bdf7129cf257c4f1185
+  data.tar.gz: e1bc2f3fd9ebd76abc4d45bcddac40653ad82238
 SHA512:
-  metadata.gz: d7ef2340e7ccd94518079de9aef5ab122fcda34c6daaa7f557bd3f982c4c7b62b36614433af0c4c43935e09677a5d075ab1d7bf005ae656e3e2221c0851235e8
-  data.tar.gz: 511fdf9ee9753b367cc8f03e6f13e8e7058f15f64fbb0ab9e1728d4dfc831b1a4cca0916872159ec33e5bc0dccf408da12463b6bb77daeb5976ab4013cca6a6a
+  metadata.gz: b6696bd2ae3c67d29ff897041762c5b717ff3d03c1e16bf2b42153b101f49e0670bd75a6d086912885a2ff172f07a2a2fd3064dadc0f5d83eee144354d3bc717
+  data.tar.gz: aa9c769a574cd41a7035014cf59eacb7803b582b771395ef9164503d3056b6a64a041f642d03117497cc09b89e0e714194d035e9a1b8eb85e696c18c9f0c8a4c

data/CHANGELOG.md

@@ -1,9 +1,17 @@
 # Hanami::Model
 A persistence layer for Hanami
 
+## v1.1.0.beta2 - 2017-10-03
+### Added
+- [Alfonso Uceda] Introduce `Hanami::Model::Migrator#rollback` to provide database migrations rollback
+- [Alfonso Uceda] Improve connection string for PostgreSQL in order to pass credentials as URI query string
+
+### Fixed
+- [Marcello Rocha] One-To-Many properly destroy the associated methods
+
 ## v1.1.0.beta1 - 2017-08-11
 ### Added
-- [Marcello Rocha] One-To-Many association (aka `belongs_to`)
+- [Marcello Rocha] Many-To-One association (aka `belongs_to`)
 - [Marcello Rocha] One-To-One association (aka `has_one`)
 - [Marcello Rocha] Many-To-Many association (aka `has_many :through`)
 - [Luca Guidi] Introduced new extra behaviors for entity manual schema: `:schema` (default), `:strict`, `:weak`, and `:permissive`

data/hanami-model.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hanami/model/version'
@@ -20,13 +18,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_runtime_dependency 'hanami-utils',    '1.1.0.beta1'
+  spec.add_runtime_dependency 'hanami-utils',    '1.1.0.beta2'
   spec.add_runtime_dependency 'rom-sql',         '~> 1.3'
   spec.add_runtime_dependency 'rom-repository',  '~> 1.4'
   spec.add_runtime_dependency 'dry-types',       '~> 0.11'
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake',    '~> 11'
-  spec.add_development_dependency 'rspec',   '~> 3.5'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake',  '~> 12'
+  spec.add_development_dependency 'rspec', '~> 3.6'
 end

data/lib/hanami-model.rb

@@ -1 +1 @@
-require 'hanami/model'
+require 'hanami/model' # rubocop:disable Naming/FileName

data/lib/hanami/entity.rb

@@ -33,7 +33,7 @@ module Hanami
   #     end
   #   end
   #
-  # **Hanami::Model** ships `Hanami::Entity` for developers's convenience.
+  # **Hanami::Model** ships `Hanami::Entity` for developers' convenience.
   #
   # **Hanami::Model** depends on a narrow and well-defined interface for an
   # Entity - `#id`, `#id=`, `#initialize(attributes={})`.If your object

data/lib/hanami/entity/schema.rb

@@ -95,7 +95,7 @@ module Hanami
         class Dsl
           # @since 1.1.0
           # @api private
-          TYPES = [:schema, :strict, :weak, :permissive, :strict_with_defaults, :symbolized].freeze
+          TYPES = %i[schema strict weak permissive strict_with_defaults symbolized].freeze
 
           # @since 1.1.0
           # @api private

data/lib/hanami/model.rb

@@ -82,7 +82,7 @@ module Hanami
 
     # Disconnect from the database
     #
-    # This is useful for reboot applications in production and to ensure that
+    # This is useful for rebooting applications in production and to ensure that
     # the framework prunes stale connections.
     #
     # @since 1.0.0
@@ -102,7 +102,7 @@ module Hanami
     #     Hanami::Model.load!
     #   end
     def self.disconnect
-      configuration.connection && configuration.connection.disconnect
+      configuration.connection&.disconnect
     end
   end
 end

data/lib/hanami/model/associations/dsl.rb

@@ -5,6 +5,8 @@ module Hanami
       #
       # @since 0.7.0
       # @api private
+      #
+      # rubocop:disable Naming/PredicateName
       class Dsl
         # @since 0.7.0
         # @api private
@@ -20,6 +22,8 @@ module Hanami
           @repository.__send__(:relations, args[:through]) if args[:through]
         end
 
+        # @since 1.1.0
+        # @api private
         def has_one(relation, *)
           @repository.__send__(:relations, Hanami::Utils::String.pluralize(relation).to_sym)
         end
@@ -30,6 +34,7 @@ module Hanami
           @repository.__send__(:relations, Hanami::Utils::String.pluralize(relation).to_sym)
         end
       end
+      # rubocop:enable Naming/PredicateName
     end
   end
 end

data/lib/hanami/model/associations/has_many.rb

@@ -67,9 +67,8 @@ module Hanami
         # @since 0.7.0
         # @api private
         def remove(id)
-          target_relation = relation(target)
-
-          command(:update, target_relation.where(target_relation.primary_key => id), use: [:timestamps])
+          command(:update, relation(target), use: [:timestamps])
+            .by_pk(id)
             .call(unassociate)
         end
 

data/lib/hanami/model/associations/many_to_many.rb

@@ -90,10 +90,11 @@ module Hanami
           association_record = relation(through)
                                .where(target_foreign_key => target_id, source_foreign_key => subject.fetch(source_primary_key))
                                .one
-          if association_record
-            ar_id = association_record.public_send relation(through).primary_key
-            command(:delete, relation(through)).by_pk(ar_id).call
-          end
+
+          return if association_record.nil?
+
+          ar_id = association_record.public_send relation(through).primary_key
+          command(:delete, relation(through)).by_pk(ar_id).call
         end
         # rubocop:enable Metrics/AbcSize
 

data/lib/hanami/model/configuration.rb

@@ -112,7 +112,7 @@ module Hanami
       # @since 1.0.0
       # @api private
       def configure_gateway
-        @gateway_config.call(gateway) unless @gateway_config.nil?
+        @gateway_config&.call(gateway)
       end
 
       # @since 1.0.0
@@ -153,6 +153,12 @@ module Hanami
           super
         end
       end
+
+      # @since 1.1.0
+      # @api private
+      def respond_to_missing?(method_name, include_all)
+        rom.respond_to?(method_name, include_all)
+      end
     end
   end
 end

data/lib/hanami/model/mapped_relation.rb

@@ -2,7 +2,7 @@ module Hanami
   module Model
     # Mapped proxy for ROM relations.
     #
-    # It eliminates the need of use #as for repository queries
+    # It eliminates the need to use #as for repository queries
     #
     # @since 1.0.0
     # @api private

data/lib/hanami/model/migrator.rb

@@ -89,6 +89,7 @@ module Hanami
       #
       # @see Hanami::Model::Configuration#adapter
       # @see Hanami::Model::Configuration#migrations
+      # @see Hanami::Model::Configuration#rollback
       #
       # @example Migrate Up
       #   require 'hanami/model'
@@ -116,7 +117,7 @@ module Hanami
       #   # Reads all files from "db/migrations" and apply them
       #   Hanami::Model::Migrator.migrate
       #
-      #   # Migrate to a specifiy version
+      #   # Migrate to a specific version
       #   Hanami::Model::Migrator.migrate(version: "20150610133853")
       #
       # NOTE: Class level interface SHOULD be removed in Hanami 2.0
@@ -124,6 +125,42 @@ module Hanami
         new.migrate(version: version)
       end
 
+      # Rollback database schema
+      #
+      # @param steps [Number,NilClass] number of versions to rollback
+      #
+      # @raise [Hanami::Model::MigrationError] if an error occurs
+      #
+      # @since 1.1.0
+      #
+      # @see Hanami::Model::Configuration#adapter
+      # @see Hanami::Model::Configuration#migrations
+      # @see Hanami::Model::Configuration#migrate
+      #
+      # @example Rollback
+      #   require 'hanami/model'
+      #   require 'hanami/model/migrator'
+      #
+      #   Hanami::Model.configure do
+      #     # ...
+      #     adapter    :sql, 'postgres://localhost/foo'
+      #     migrations 'db/migrations'
+      #   end
+      #
+      #   # Reads all files from "db/migrations" and apply them
+      #   Hanami::Model::Migrator.migrate
+      #
+      #   # By default only rollback one version
+      #   Hanami::Model::Migrator.rollback
+      #
+      #   # Use a hash passing a number of versions to rollback, it will rollbacks those versions
+      #   Hanami::Model::Migrator.rollback(versions: 2)
+      #
+      # NOTE: Class level interface SHOULD be removed in Hanami 2.0
+      def self.rollback(steps: 1)
+        new.rollback(steps: steps)
+      end
+
       # Migrate, dump schema, delete migrations.
       #
       # This is an experimental feature.
@@ -189,7 +226,7 @@ module Hanami
       #     migrations 'db/migrations'
       #   end
       #
-      #   Hanami::Model::Migrator.prepare # => creates `foo' and run migrations
+      #   Hanami::Model::Migrator.prepare # => creates `foo' and runs migrations
       #
       # @example Prepare Database (with schema dump)
       #   require 'hanami/model'
@@ -266,6 +303,14 @@ module Hanami
         adapter.migrate(migrations, version) if migrations?
       end
 
+      # @since 1.1.0
+      # @api private
+      #
+      # @see Hanami::Model::Migrator.rollback
+      def rollback(steps: 1)
+        adapter.rollback(migrations, steps.abs) if migrations?
+      end
+
       # @since 0.7.0
       # @api private
       #
@@ -282,7 +327,7 @@ module Hanami
       # @see Hanami::Model::Migrator.prepare
       def prepare
         drop
-      rescue
+      rescue # rubocop:disable Lint/HandleExceptions
       ensure
         create
         adapter.load
@@ -297,8 +342,6 @@ module Hanami
         adapter.version
       end
 
-      private
-
       # Hanami::Model configuration
       #
       # @since 0.4.0
@@ -307,6 +350,8 @@ module Hanami
         Model.configuration
       end
 
+      private
+
       # @since 0.7.0
       # @api private
       attr_reader :configuration

data/lib/hanami/model/migrator/adapter.rb

@@ -84,6 +84,17 @@ module Hanami
           raise MigrationError.new(e.message)
         end
 
+        # @since 1.1.0
+        # @api private
+        def rollback(migrations, steps)
+          table = migrations_table_dataset
+          version = version_to_rollback(table, steps)
+
+          Sequel::Migrator.run(connection.raw, migrations, target: version, allow_missing_migration_files: true)
+        rescue Sequel::Migrator::Error => e
+          raise MigrationError.new(e.message)
+        end
+
         # Load database schema.
         # It must be implemented by subclasses.
         #
@@ -100,16 +111,36 @@ module Hanami
         # @since 0.4.0
         # @api private
         def version
-          table = connection.table(MIGRATIONS_TABLE)
+          table = migrations_table_dataset
           return if table.nil?
 
-          if record = table.order(MIGRATIONS_TABLE_VERSION_COLUMN).last
-            record.fetch(MIGRATIONS_TABLE_VERSION_COLUMN).scan(/\A[\d]{14}/).first.to_s
-          end
+          record = table.order(MIGRATIONS_TABLE_VERSION_COLUMN).last
+          return if record.nil?
+
+          record.fetch(MIGRATIONS_TABLE_VERSION_COLUMN).scan(MIGRATIONS_FILE_NAME_PATTERN).first.to_s
         end
 
         private
 
+        # @since 1.1.0
+        # @api private
+        MIGRATIONS_FILE_NAME_PATTERN = /\A[\d]{14}/
+
+        # @since 1.1.0
+        # @api private
+        def version_to_rollback(table, steps)
+          record = table.order(Sequel.desc(MIGRATIONS_TABLE_VERSION_COLUMN)).all[steps]
+          return 0 unless record
+
+          record.fetch(MIGRATIONS_TABLE_VERSION_COLUMN).scan(MIGRATIONS_FILE_NAME_PATTERN).first.to_i
+        end
+
+        # @since 1.1.0
+        # @api private
+        def migrations_table_dataset
+          connection.table(MIGRATIONS_TABLE)
+        end
+
         # @since 0.5.0
         # @api private
         attr_reader :connection
@@ -123,10 +154,10 @@ module Hanami
         # Returns a database connection
         #
         # Given a DB connection URI we can connect to a specific database or not, we need this when creating
-        # or droping a database. Important to notice that we can't always open a _global_ DB connection,
+        # or dropping a database. Important to notice that we can't always open a _global_ DB connection,
         # because most of the times application's DB user has no rights to do so.
         #
-        # @param global [Boolean] determine whether or not a connection should specify an database.
+        # @param global [Boolean] determine whether or not a connection should specify a database.
         #
         # @since 0.5.0
         # @api private

data/lib/hanami/model/plugins/timestamps.rb

@@ -17,7 +17,7 @@ module Hanami
           #
           # @since 0.7.0
           # @api private
-          TIMESTAMPS = [:created_at, :updated_at].freeze
+          TIMESTAMPS = %i[created_at updated_at].freeze
 
           # @since 0.7.0
           # @api private

data/lib/hanami/model/sql.rb

@@ -110,7 +110,7 @@ module Hanami
       #     end
       #
       #     down do
-      #       drop_table :itmes
+      #       drop_table :items
       #       execute 'DROP TYPE inventory_item'
       #     end
       #   end

data/lib/hanami/model/sql/consoles/postgresql.rb

@@ -36,7 +36,7 @@ module Hanami
           # @since 0.7.0
           # @api private
           def host
-            " -h #{@uri.host}"
+            " -h #{query['host'] || @uri.host}"
           end
 
           # @since 0.7.0
@@ -48,19 +48,31 @@ module Hanami
           # @since 0.7.0
           # @api private
           def port
-            " -p #{@uri.port}" unless @uri.port.nil?
+            port = query['port'] || @uri.port
+            " -p #{port}" if port
           end
 
           # @since 0.7.0
           # @api private
           def username
-            " -U #{@uri.user}" unless @uri.user.nil?
+            username = query['user'] || @uri.user
+            " -U #{username}" if username
           end
 
           # @since 0.7.0
           # @api private
           def configure_password
-            ENV[PASSWORD] = CGI.unescape(@uri.password) unless @uri.password.nil?
+            password = query['password'] || @uri.password
+            ENV[PASSWORD] = CGI.unescape(query['password'] || @uri.password) if password
+          end
+
+          # @since 1.1.0
+          # @api private
+          def query
+            return {} if @uri.query.nil? || @uri.query.empty?
+
+            parsed_query = @uri.query.split("&").map { |a| a.split("=") }
+            @query ||= Hash[parsed_query]
           end
         end
       end

data/lib/hanami/model/sql/entity/schema.rb

@@ -22,7 +22,7 @@ module Hanami
           # associations and potentially to mapping defined by the repository.
           #
           # @param registry [Hash] a registry that keeps reference between
-          #   entities klass and their underscored names
+          #   entities class and their underscored names
           # @param relation [ROM::Relation] the database relation
           # @param mapping [Hanami::Model::Mapping] the optional repository
           #   mapping
@@ -75,7 +75,7 @@ module Hanami
           # Build the schema
           #
           # @param registry [Hash] a registry that keeps reference between
-          #   entities klass and their underscored names
+          #   entities class and their underscored names
           # @param relation [ROM::Relation] the database relation
           # @param mapping [Hanami::Model::Mapping] the optional repository
           #   mapping
@@ -112,7 +112,7 @@ module Hanami
           # Merge attributes and associations
           #
           # @param registry [Hash] a registry that keeps reference between
-          #   entities klass and their underscored names
+          #   entities class and their underscored names
           # @param associations [ROM::AssociationSet] a set of associations for
           #   the current relation
           #

data/lib/hanami/model/sql/types.rb

@@ -70,7 +70,7 @@ module Hanami
 
             # NOTE: In the future rom-sql should be able to always return Ruby
             # types instead of Sequel types. When that will happen we can get
-            # rid of this logic in the block and to fallback to:
+            # rid of this logic in the block and fall back to:
             #
             #  MAPPING.fetch(unwrapped.pristine, attribute)
             MAPPING.fetch(unwrapped.pristine) do

data/lib/hanami/model/types.rb

@@ -21,7 +21,7 @@ module Hanami
         # Define an array of given type
         #
         # @since 0.7.0
-        def Collection(type) # rubocop:disable Style/MethodName
+        def Collection(type) # rubocop:disable Naming/MethodName
           type = Schema::CoercibleType.new(type) unless type.is_a?(Dry::Types::Definition)
           Types::Array.member(type)
         end
@@ -48,7 +48,8 @@ module Hanami
           # @api private
           def call(value)
             return if value.nil?
-            if valid?(value)
+
+            if valid?(value) # rubocop:disable Style/GuardClause
               coerce(value)
             else
               raise TypeError.new("#{value.inspect} must be coercible into #{object}")
@@ -58,7 +59,7 @@ module Hanami
           # Check if value can be coerced
           #
           # It is true if value is an instance of `object` type or if value
-          # respond to `#to_hash`.
+          # responds to `#to_hash`.
           #
           # @param value [Object] the value
           #

data/lib/hanami/model/version.rb

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

data/lib/hanami/repository.rb

@@ -54,7 +54,7 @@ module Hanami
   #
   # All the queries and commands are private.
   # This decision forces developers to define intention revealing API, instead
-  # leak storage API details outside of a repository.
+  # of leaking storage API details outside of a repository.
   #
   # @example
   #   require 'hanami/model'
@@ -87,7 +87,7 @@ module Hanami
   #   #  * It expresses a clear intent.
   #   #
   #   #  * The caller can be easily tested in isolation.
-  #   #    It's just a matter of stub this method.
+  #   #    It's just a matter of stubbing this method.
   #   #
   #   #  * If we change the storage, the callers aren't affected.
   #
@@ -114,7 +114,7 @@ module Hanami
     # @api private
     #
     # @see Hanami::Model::Plugins
-    COMMAND_PLUGINS = [:schema, :mapping, :timestamps].freeze
+    COMMAND_PLUGINS = %i[schema mapping timestamps].freeze
 
     # Configuration
     #
@@ -167,7 +167,7 @@ module Hanami
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength
 
-    # Defines the ampping between a database table and an entity.
+    # Defines the mapping between a database table and an entity.
     #
     # It's also responsible to associate table columns to entity attributes.
     #
@@ -314,7 +314,7 @@ module Hanami
     module Commands
       # Create a new record
       #
-      # @return [Hanami::Entity] an new created entity
+      # @return [Hanami::Entity] a new created entity
       #
       # @raise [Hanami::Model::Error] an error in case the command fails
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-model
 version: !ruby/object:Gem::Version
-  version: 1.1.0.beta1
+  version: 1.1.0.beta2
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0.beta1
+        version: 1.1.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0.beta1
+        version: 1.1.0.beta2
 - !ruby/object:Gem::Dependency
   name: rom-sql
   requirement: !ruby/object:Gem::Requirement
@@ -84,44 +84,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 description: A persistence framework with entities and repositories
 email:
 - me@lucaguidi.com
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A persistence layer for Hanami