vorpal 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9833373892cb8a97f3b37ba1ec0fe9d06fe0b39dc6caaf9f7b333b28f20c2a47
-  data.tar.gz: 47df18148ce8412236a13032055da0ca6d3c1c21c9839e99c329a2df88982a55
+  metadata.gz: c866f3e83daac73f28e5c9a53875b73d7f8db95cbf437200f0b0c69cce81d317
+  data.tar.gz: e1e91f848552e1f3710849370978d4a1e322e65b12c65bebcd995b76960ba44e
 SHA512:
-  metadata.gz: 24c5cd71c9d56d8b882bb6691808c22749317d81ca1b104c90ddcf846c35ee0d8b36809cf1558f5a973f3696a48dc2aa9e80a6c0d6f7ea80dac275ef7b1d8597
-  data.tar.gz: c1012c585122a6259137e9de766247222b7c1a20606b27aca7fb219d947914a860016c1ec1c7ba8387d223d9bbde53c416065f52b837680b0bcff2fc6d177d40
+  metadata.gz: 5bcd5518f56b4c43f4180d3f63c75c6186c1bd89bee939b8410e656f3df411920238eaf51da4a590367f929507c3bdb1ada98cf972d6ebf6785432417018b9a2
+  data.tar.gz: 85e53e6946ea0d0f06e14d8913ac3eba45668b3d08bfc0036a789620ea05af587cb5a97991467eadfea1f76d5dd3fccaf71c96aeec2345327d9538e714e0e720

data/README.md

@@ -1,4 +1,4 @@
-# Vorpal [![Build Status](https://travis-ci.org/nulogy/vorpal.svg?branch=master)](https://travis-ci.org/nulogy/vorpal) [![Code Climate](https://codeclimate.com/github/nulogy/vorpal/badges/gpa.svg)](https://codeclimate.com/github/nulogy/vorpal) [![Code Coverage](https://codecov.io/gh/nulogy/vorpal/branch/master/graph/badge.svg)](https://codecov.io/gh/nulogy/vorpal/branch/master)
+# Vorpal [![Build Status](https://travis-ci.com/nulogy/vorpal.svg?branch=master)](https://travis-ci.com/nulogy/vorpal) [![Code Climate](https://codeclimate.com/github/nulogy/vorpal/badges/gpa.svg)](https://codeclimate.com/github/nulogy/vorpal) [![Code Coverage](https://codecov.io/gh/nulogy/vorpal/branch/master/graph/badge.svg)](https://codecov.io/gh/nulogy/vorpal/branch/master)
 
 Separate your domain model from your persistence mechanism. Some problems call for a really sharp tool.
 
@@ -181,13 +181,11 @@ It also does not do some things that you might expect from other ORMs:
 1. Only supports PostgreSQL.
 
 ## Future Enhancements
-* Aggregate updated_at.
-* Support for other DBMSs (no MySQL support until ids can be generated without inserting into a table!)
-* Support for other ORMs.
-* Value objects.
-* Remove dependency on ActiveRecord (optimistic locking? updated_at, created_at support? Data type conversions? TimeZone support?)
-* More efficient updates (use fewer queries.)
+* Support for UUID primary keys.
 * Nicer DSL for specifying attributes that have different names in the domain model than in the DB.
+* Show how to implement POROs without using Virtus (it is unsupported and can be crazy slow)
+* Aggregate updated_at.
+* Better support for value objects.
 
 ## FAQ
 
@@ -203,11 +201,12 @@ It also does not do some things that you might expect from other ORMs:
 
 **A.** Create a method on a [Repository](http://martinfowler.com/eaaCatalog/repository.html)! They have full access to the DB/ORM so you can use [Arel](https://github.com/rails/arel) and go [crazy](http://asciicasts.com/episodes/239-activerecord-relation-walkthrough) or use direct SQL if you want. 
 
-For example:
+For example, use the [#query](https://rubydoc.info/github/nulogy/vorpal/master/Vorpal/AggregateMapper#query-instance_method) method on the [AggregateMapper](https://rubydoc.info/github/nulogy/vorpal/master/Vorpal/AggregateMapper) to access the underyling [ActiveRecordRelation](https://api.rubyonrails.org/classes/ActiveRecord/Relation.html):
 
 ```ruby
-  def find_all
-    @mapper.query.load_all # use the mapper to load all the aggregates
+  def find_special_ones
+    # use `load_all` or `load_one` to convert from ActiveRecord objects to domain POROs.
+    @mapper.query.where(special: true).load_all 
   end
 ```
 
@@ -229,6 +228,10 @@ For example:
 
 **A.** You can use [ActiveModel::Serialization](http://api.rubyonrails.org/classes/ActiveModel/Serialization.html) or [ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers) but they are not heartily recommended. The former is too coupled to the model and the latter is too coupled to Rails controllers. Vorpal uses [SimpleSerializer](https://github.com/nulogy/simple_serializer) for this purpose.
 
+**Q.** Are `updated_at` and `created_at` supported?
+
+**A.** Yes. If they exist on your database tables, they will behave exactly as if you were using vanilla ActiveRecord.
+
 ## Contributing
 
 1. Fork it ( https://github.com/nulogy/vorpal/fork )

data/lib/vorpal/aggregate_mapper.rb

@@ -84,6 +84,17 @@ module Vorpal
       @engine
     end
 
+    # Returns a 'Vorpal-aware' [ActiveRecord::Relation](https://api.rubyonrails.org/classes/ActiveRecord/Relation.html)
+    # for the ActiveRecord object underlying the domain entity mapped by this mapper.
+    #
+    # This method allows you to easily access the power of ActiveRecord::Relation to do more complex
+    # queries in your repositories.
+    #
+    # The ActiveRecord::Relation is 'Vorpal-aware' because it has the {#load_one} and {#load_many} methods
+    # mixed in so that you can get the POROs from your domain model instead of the ActiveRecord
+    # objects normally returned by ActiveRecord::Relation.
+    #
+    # @return [ActiveRecord::Relation]
     def query
       @engine.query(@domain_class)
     end

data/lib/vorpal/driver/postgresql.rb

@@ -9,7 +9,12 @@ module Vorpal
       end
 
       def insert(db_class, db_objects)
-        if defined? ActiveRecord::Import
+        if ActiveRecord::VERSION::MAJOR >= 6
+          return if db_objects.empty?
+
+          update_timestamps_on_create(db_class, db_objects)
+          db_class.insert_all!(db_objects.map(&:attributes))
+        elsif defined? ActiveRecord::Import
           db_class.import(db_objects, validate: false)
         else
           db_objects.each do |db_object|
@@ -19,8 +24,15 @@ module Vorpal
       end
 
       def update(db_class, db_objects)
-        db_objects.each do |db_object|
-          db_object.save!(validate: false)
+        if ActiveRecord::VERSION::MAJOR >= 6
+          return if db_objects.empty?
+
+          update_timestamps_on_update(db_class, db_objects)
+          db_class.upsert_all(db_objects.map(&:attributes))
+        else
+          db_objects.each do |db_object|
+            db_object.save!(validate: false)
+          end
         end
       end
 
@@ -100,6 +112,30 @@ module Vorpal
 
       private
 
+      # Adapted from https://github.com/rails/rails/blob/614580270d7789e5275defc3da020ce27b3b2302/activerecord/lib/active_record/timestamp.rb#L99
+      def update_timestamps_on_create(db_class, db_objects)
+        return unless db_class.record_timestamps
+
+        current_time = db_class.current_time_from_proper_timezone
+        db_objects.each do |db_object|
+          db_class.all_timestamp_attributes_in_model.each do |column|
+            db_object.write_attribute(column, current_time) unless db_object.read_attribute(column)
+          end
+        end
+      end
+
+      #Adapted from https://github.com/rails/rails/blob/614580270d7789e5275defc3da020ce27b3b2302/activerecord/lib/active_record/timestamp.rb#L111
+      def update_timestamps_on_update(db_class, db_objects)
+        return unless db_class.record_timestamps
+
+        current_time = db_class.current_time_from_proper_timezone
+        db_objects.each do |db_object|
+          db_class.timestamp_attributes_for_update_in_model.each do |column|
+            db_object.write_attribute(column, current_time)
+          end
+        end
+      end
+
       def sequence_name(db_class)
         @sequence_names[db_class] ||= execute(
           "SELECT substring(column_default from '''(.*)''') FROM INFORMATION_SCHEMA.COLUMNS WHERE table_name = $1 AND column_name = 'id' LIMIT 1",

data/lib/vorpal/version.rb

@@ -1,3 +1,3 @@
 module Vorpal
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/vorpal.gemspec

@@ -13,15 +13,16 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/nulogy/vorpal"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = Dir["CHANGELOG.md", "LICENSE.txt", "README.md", "vorpal.gemspec", "lib/**/*"]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "simple_serializer", "~> 1.0"
   spec.add_runtime_dependency "equalizer"
   spec.add_runtime_dependency "activesupport"
 
-  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "rake", "~> 13"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "virtus", "~> 1.0"
   spec.add_development_dependency "appraisal", "~> 2.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vorpal
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Sean Kirby
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2020-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_serializer
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -172,29 +172,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".envrc"
-- ".gitignore"
-- ".rspec"
-- ".ruby-version"
-- ".travis.yml"
-- ".yardopts"
-- Appraisals
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/appraisal
-- bin/rake
-- bin/rspec
-- docker-compose.yml
-- gemfiles/rails_5_1.gemfile
-- gemfiles/rails_5_1.gemfile.lock
-- gemfiles/rails_5_2.gemfile
-- gemfiles/rails_5_2.gemfile.lock
-- gemfiles/rails_6_0.gemfile
-- gemfiles/rails_6_0.gemfile.lock
 - lib/vorpal.rb
 - lib/vorpal/aggregate_mapper.rb
 - lib/vorpal/aggregate_traversal.rb
@@ -213,27 +193,12 @@ files:
 - lib/vorpal/util/hash_initialization.rb
 - lib/vorpal/util/string_utils.rb
 - lib/vorpal/version.rb
-- spec/acceptance/vorpal/aggregate_mapper_spec.rb
-- spec/helpers/codecov_helper.rb
-- spec/helpers/db_helpers.rb
-- spec/helpers/profile_helpers.rb
-- spec/integration/vorpal/driver/postgresql_spec.rb
-- spec/integration_spec_helper.rb
-- spec/performance/vorpal/performance_spec.rb
-- spec/unit/vorpal/configs_spec.rb
-- spec/unit/vorpal/db_loader_spec.rb
-- spec/unit/vorpal/dsl/config_builder_spec.rb
-- spec/unit/vorpal/dsl/defaults_generator_spec.rb
-- spec/unit/vorpal/identity_map_spec.rb
-- spec/unit/vorpal/loaded_objects_spec.rb
-- spec/unit/vorpal/util/string_utils_spec.rb
-- spec/unit_spec_helper.rb
 - vorpal.gemspec
 homepage: https://github.com/nulogy/vorpal
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -249,22 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Separate your domain model from your persistence mechanism.
-test_files:
-- spec/acceptance/vorpal/aggregate_mapper_spec.rb
-- spec/helpers/codecov_helper.rb
-- spec/helpers/db_helpers.rb
-- spec/helpers/profile_helpers.rb
-- spec/integration/vorpal/driver/postgresql_spec.rb
-- spec/integration_spec_helper.rb
-- spec/performance/vorpal/performance_spec.rb
-- spec/unit/vorpal/configs_spec.rb
-- spec/unit/vorpal/db_loader_spec.rb
-- spec/unit/vorpal/dsl/config_builder_spec.rb
-- spec/unit/vorpal/dsl/defaults_generator_spec.rb
-- spec/unit/vorpal/identity_map_spec.rb
-- spec/unit/vorpal/loaded_objects_spec.rb
-- spec/unit/vorpal/util/string_utils_spec.rb
-- spec/unit_spec_helper.rb
+test_files: []

data/.editorconfig

@@ -1,13 +0,0 @@
-root = true
-
-[*]
-
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false

data/.envrc

@@ -1,4 +0,0 @@
-#@IgnoreInspection BashAddShebang
-# Configuration for direnv (see https://github.com/direnv/direnv)
-
-PATH_add bin

data/.gitignore

@@ -1,16 +0,0 @@
-/.bundle/
-/.idea/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-/projectFilesBackup

data/.rspec

@@ -1 +0,0 @@
---colour

data/.ruby-version

@@ -1 +0,0 @@
-2.7.0

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-services:
-  - postgresql
-matrix:
-  include:
-    - rvm: 2.5.7
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: 2.6
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: 2.6
-      gemfile: gemfiles/rails_5_2.gemfile
-    - rvm: 2.7
-      gemfile: gemfiles/rails_6_0.gemfile
-cache:
-  - bundler
-script: "bundle exec rake"
-env:
-  - CODECOV_TOKEN="fab4ddb8-ba2c-47cb-a407-941209ad54a4"

data/.yardopts

@@ -1 +0,0 @@
---no-private -m markdown lib/**/*.*

data/Appraisals

@@ -1,18 +0,0 @@
-appraise "rails-6-0" do
-  ruby ">= 2.7.0"
-  gem "activerecord", "~> 6.0.0"
-end
-
-appraise "rails-5-2" do
-  ruby ">= 2.5.7"
-  gem "activerecord", "~> 5.2.0"
-  gem "pg", "~> 0.18.0"
-  gem "activerecord-import", "= 0.13.0"
-end
-
-appraise "rails-5-1" do
-  ruby ">= 2.5.7"
-  gem "activerecord", "~> 5.1.0"
-  gem "pg", "~> 0.18.0"
-  gem "activerecord-import", "= 0.13.0"
-end

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in vorpal.gemspec
-gemspec

data/Rakefile

@@ -1,39 +0,0 @@
-#!/usr/bin/env rake
-begin
-  require "bundler/gem_tasks"
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks associated with creating new versions of the gem.'
-end
-
-begin
-  require 'rspec/core/rake_task'
-
-  namespace :spec do
-    RSpec::Core::RakeTask.new(:acceptance) do |t|
-      t.pattern = "spec/acceptance/**/*_spec.rb"
-    end
-
-    RSpec::Core::RakeTask.new(:integration) do |t|
-      t.pattern = "spec/integration/**/*_spec.rb"
-    end
-
-    RSpec::Core::RakeTask.new(:performance) do |t|
-      t.pattern = "spec/performance/**/*_spec.rb"
-    end
-
-    RSpec::Core::RakeTask.new(:unit) do |t|
-      t.pattern = "spec/unit/**/*_spec.rb"
-    end
-
-    desc "Run all non-performance related specs"
-    task non_perf: [:unit, :integration, :acceptance]
-
-    desc "Run all specs"
-    task all: [:acceptance, :integration, :unit, :performance]
-  end
-
-  task default: :'spec:all'
-rescue LoadError
-  # Allow the Rakefile to be used in environments where the RSpec gem is unavailable
-  # (e.g. Production)
-end

data/bin/appraisal

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'appraisal' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("appraisal", "appraisal")