hanami-model 0.6.1 → 0.7.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-model
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils
@@ -18,28 +18,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: sequel
+  name: rom-sql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.9'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.9'
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rom-repository
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,16 +116,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
-description: A persistence framework with entities, repositories, data mapper and
-  query objects
+        version: '11'
+description: A persistence framework with entities and repositories
 email:
 - me@lucaguidi.com
 - trung.le@ruby-journal.com
@@ -93,47 +134,44 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- EXAMPLE.md
 - LICENSE.md
 - README.md
 - hanami-model.gemspec
 - lib/hanami-model.rb
 - lib/hanami/entity.rb
-- lib/hanami/entity/dirty_tracking.rb
+- lib/hanami/entity/schema.rb
 - lib/hanami/model.rb
-- lib/hanami/model/adapters/abstract.rb
-- lib/hanami/model/adapters/file_system_adapter.rb
-- lib/hanami/model/adapters/implementation.rb
-- lib/hanami/model/adapters/memory/collection.rb
-- lib/hanami/model/adapters/memory/command.rb
-- lib/hanami/model/adapters/memory/query.rb
-- lib/hanami/model/adapters/memory_adapter.rb
-- lib/hanami/model/adapters/null_adapter.rb
-- lib/hanami/model/adapters/sql/collection.rb
-- lib/hanami/model/adapters/sql/command.rb
-- lib/hanami/model/adapters/sql/console.rb
-- lib/hanami/model/adapters/sql/consoles/mysql.rb
-- lib/hanami/model/adapters/sql/consoles/postgresql.rb
-- lib/hanami/model/adapters/sql/consoles/sqlite.rb
-- lib/hanami/model/adapters/sql/query.rb
-- lib/hanami/model/adapters/sql_adapter.rb
-- lib/hanami/model/coercer.rb
-- lib/hanami/model/config/adapter.rb
-- lib/hanami/model/config/mapper.rb
+- lib/hanami/model/association.rb
+- lib/hanami/model/associations/belongs_to.rb
+- lib/hanami/model/associations/dsl.rb
+- lib/hanami/model/associations/has_many.rb
 - lib/hanami/model/configuration.rb
+- lib/hanami/model/configurator.rb
+- lib/hanami/model/entity_name.rb
 - lib/hanami/model/error.rb
-- lib/hanami/model/mapper.rb
 - lib/hanami/model/mapping.rb
-- lib/hanami/model/mapping/attribute.rb
-- lib/hanami/model/mapping/coercers.rb
-- lib/hanami/model/mapping/collection.rb
-- lib/hanami/model/mapping/collection_coercer.rb
+- lib/hanami/model/migration.rb
 - lib/hanami/model/migrator.rb
 - lib/hanami/model/migrator/adapter.rb
 - lib/hanami/model/migrator/connection.rb
 - lib/hanami/model/migrator/mysql_adapter.rb
 - lib/hanami/model/migrator/postgres_adapter.rb
 - lib/hanami/model/migrator/sqlite_adapter.rb
+- lib/hanami/model/plugins.rb
+- lib/hanami/model/plugins/mapping.rb
+- lib/hanami/model/plugins/schema.rb
+- lib/hanami/model/plugins/timestamps.rb
+- lib/hanami/model/relation_name.rb
+- lib/hanami/model/sql.rb
+- lib/hanami/model/sql/console.rb
+- lib/hanami/model/sql/consoles/abstract.rb
+- lib/hanami/model/sql/consoles/mysql.rb
+- lib/hanami/model/sql/consoles/postgresql.rb
+- lib/hanami/model/sql/consoles/sqlite.rb
+- lib/hanami/model/sql/entity/schema.rb
+- lib/hanami/model/sql/types.rb
+- lib/hanami/model/sql/types/schema/coercions.rb
+- lib/hanami/model/types.rb
 - lib/hanami/model/version.rb
 - lib/hanami/repository.rb
 homepage: http://hanamirb.org
@@ -148,7 +186,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -156,9 +194,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: A persistence layer for Hanami
 test_files: []
-has_rdoc: 

data/EXAMPLE.md

@@ -1,213 +0,0 @@
-# Hanami::Model
-
-This is a guide that helps you to get started with [**Hanami::Model**](https://github.com/hanami/model).
-You can find the full code source [here](https://gist.github.com/jodosha/11211048).
-
-## Gems
-
-First of all, we need to setup a `Gemfile`.
-
-```ruby
-source 'https://rubygems.org'
-
-gem 'sqlite3'
-gem 'hanami-model'
-```
-
-Then we can fetch the dependencies with `bundle install`.
-
-## Setup
-
-<a name="connection-url"></a>
-
-**Hanami::Model** doesn't have migrations.
-For this example we will use [Sequel](http://sequel.jeremyevans.net).
-We create the database first.
-Then we create two tables: `authors` and `articles`.
-
-```ruby
-require 'bundler/setup'
-require 'sqlite3'
-require 'hanami/model'
-require 'hanami/model/adapters/sql_adapter'
-
-connection_uri = "sqlite://#{ __dir__ }/test.db"
-
-database = Sequel.connect(connection_uri)
-
-database.create_table! :authors do
-  primary_key :id
-  String  :name
-end
-
-database.create_table! :articles do
-  primary_key :id
-  Integer :author_id,      null: false
-  String  :title
-  Integer :comments_count, default: 0
-  Boolean :published,      default: false
-end
-```
-
-## Entities
-
-We have two entities in our application: `Author` and `Article`.
-`Author` is a `Struct`, Hanami::Model can persist it.
-`Article` has a small API concerning its publishing process.
-
-```ruby
-Author = Struct.new(:id, :name) do
-  def initialize(attributes = {})
-    self.id = attributes[:id]
-    self.name = attributes[:name]
-  end
-end
-
-class Article
-  include Hanami::Entity
-  attributes :author_id, :title, :comments_count, :published # id is implicit
-
-  def published?
-    !!published
-  end
-
-  def publish!
-    @published = true
-  end
-end
-```
-
-## Repositories
-
-In order to persist and query the entities above, we define two corresponding repositories:
-
-```ruby
-class AuthorRepository
-  include Hanami::Repository
-end
-
-class ArticleRepository
-  include Hanami::Repository
-
-  def self.most_recent_by_author(author, limit = 8)
-    query do
-      where(author_id: author.id).
-        desc(:id).
-        limit(limit)
-    end
-  end
-
-  def self.most_recent_published_by_author(author, limit = 8)
-    most_recent_by_author(author, limit).published
-  end
-
-  def self.published
-    query do
-      where(published: true)
-    end
-  end
-
-  def self.drafts
-    exclude published
-  end
-
-  def self.rank
-    published.desc(:comments_count)
-  end
-
-  def self.best_article_ever
-    rank.limit(1).first
-  end
-
-  def self.comments_average
-    query.average(:comments_count)
-  end
-end
-```
-
-## Loading
-
-```ruby
-Hanami::Model.configure do
-  adapter type: :sql, uri: connection_uri
-
-  mapping do
-    collection :authors do
-      entity     Author
-      repository AuthorRepository
-
-      attribute :id,   Integer
-      attribute :name, String
-    end
-
-    collection :articles do
-      entity     Article
-      repository ArticleRepository
-
-      attribute :id,             Integer
-      attribute :author_id,      Integer
-      attribute :title,          String
-      attribute :comments_count, Integer
-      attribute :published,      Boolean
-    end
-  end
-end.load!
-```
-
-## Persist
-
-We instantiate and persist an `Author` and a few `Articles` for our example:
-
-```ruby
-author = Author.new(name: 'Luca')
-author = AuthorRepository.create(author)
-
-articles = [
-  Article.new(title: 'Announcing Hanami',              author_id: author.id, comments_count: 123, published: true),
-  Article.new(title: 'Introducing Hanami::Router',     author_id: author.id, comments_count: 63,  published: true),
-  Article.new(title: 'Introducing Hanami::Controller', author_id: author.id, comments_count: 82,  published: true),
-  Article.new(title: 'Introducing Hanami::Model',      author_id: author.id)
-]
-
-articles.each do |article|
-  ArticleRepository.create(article)
-end
-```
-
-## Query
-
-We use the repositories to query the database and return the entities we're looking for:
-
-```ruby
-ArticleRepository.first # => return the first article
-ArticleRepository.last  # => return the last article
-
-ArticleRepository.published # => return all the published articles
-ArticleRepository.drafts    # => return all the drafts
-
-ArticleRepository.rank      # => all the published articles, sorted by popularity
-
-ArticleRepository.best_article_ever # => the most commented article
-
-ArticleRepository.comments_average # => calculates the average of comments across all the published articles.
-
-ArticleRepository.most_recent_by_author(author) # => most recent articles by an author (drafts and published).
-ArticleRepository.most_recent_published_by_author(author) # => most recent published articles by an author
-```
-
-## Business Logic
-
-As we've seen above, `Article` implements an API for publishing.
-We use that logic to alter the state of an article (from draft to published).
-We then use the repository to persist this new state.
-
-```ruby
-article = ArticleRepository.drafts.first
-
-article.published? # => false
-article.publish!
-
-article.published? # => true
-
-ArticleRepository.update(article)
-```

data/lib/hanami/entity/dirty_tracking.rb

@@ -1,74 +0,0 @@
-module Hanami
-  module Entity
-    # Dirty tracking for entities
-    #
-    # @since 0.3.1
-    #
-    # @example Dirty tracking
-    #   require 'hanami/model'
-    #
-    #   class User
-    #     include Hanami::Entity
-    #     include Hanami::Entity::DirtyTracking
-    #
-    #     attributes :name
-    #   end
-    #
-    #   article = Article.new(title: 'Generation P')
-    #   article.changed? # => false
-    #
-    #   article.title = 'Master and Margarita'
-    #   article.changed? # => true
-    #
-    #   article.changed_attributes # => {:title => "Generation P"}
-    module DirtyTracking
-      # Override initialize process.
-      #
-      # @param attributes [Hash] a set of attribute names and values
-      #
-      # @since 0.3.1
-      #
-      # @see Hanami::Entity#initialize
-      def initialize(attributes = {})
-        super
-        @_initial_state = Utils::Hash.new(to_h).deep_dup
-      end
-
-      # Getter for hash of changed attributes.
-      # Return empty hash, if there is no changes
-      # Getter for hash of changed attributes. Value in it is the previous one.
-      #
-      # @return [::Hash] the changed attributes
-      #
-      # @since 0.3.1
-      #
-      # @example
-      #   require 'hanami/model'
-      #
-      #   class Article
-      #     include Hanami::Entity
-      #     include Hanami::Entity::DirtyTracking
-      #
-      #     attributes :title
-      #   end
-      #
-      #   article = Article.new(title: 'The crime and punishment')
-      #   article.changed_attributes # => {}
-      #
-      #   article.title = 'Master and Margarita'
-      #   article.changed_attributes # => {:title => "The crime and punishment"}
-      def changed_attributes
-        Hash[@_initial_state.to_a - to_h.to_a]
-      end
-
-      # Checks if the attributes were changed
-      #
-      # @return [TrueClass, FalseClass] the result of the check
-      #
-      # @since 0.3.1
-      def changed?
-        changed_attributes.any?
-      end
-    end
-  end
-end