sequel_bitemporal 0.9.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f6daa2d7f025cd1281e8cbfc7235d0a6ddd85d2251f8d9195d85cc5340aafb3
-  data.tar.gz: 5d5de257ee011436a1c3959206c31c985d6b11597d63fcab468876865394f9ee
+  metadata.gz: 33df8e3ea5762139cd17bc15469b6f4c0535e698191eff1db9feb1387be4eb9b
+  data.tar.gz: da3482ad1fa5d018fc50e95c45940beba6013205574f65257be300abbfc119ee
 SHA512:
-  metadata.gz: '0309ac260a37ec550e417efb01eaa72120583a5c26c6306f52c15910d36c8dc24f9e74d39319f763e3a566192ddd5887b0b022ce747f820beee388a444726dc8'
-  data.tar.gz: f4f61ba42c6510bcc744f96a27ca9a91fe965762ce4ec6206720441346ec1e5402475e27e87a7b838d342898c47df99a1e8025abf5ebce59691250417bc0015f
+  metadata.gz: 0b6f966365eaf5c42143b5e050c467aaef0b1e479c68fd792cbedc1cf4d3c420962651254ca9dd1344c95e4401f3ee2ba56f6acb54702248a8d4d5684d351265
+  data.tar.gz: 176b15f045e9b91b29857f0b5e1ffcbb313d44cd623bd10718cbdabd359ba929b55c231882d639e47499c496307c8b5bbf9c160cacc11569d46c624bca9439d3

data/.github/workflows/ci.yml

@@ -0,0 +1,64 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: ['**']
+
+jobs:
+  tests:
+    services:
+      postgres:
+        image: postgres:13
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+        - 5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
+    name: Ruby ${{ matrix.ruby }}
+
+    env:
+      SEQUEL: "~> 5.0"
+      BUNDLE_GEMFILE: "ci/sequel.gemfile"
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install db dependencies and check connections
+        run: |
+          env PGPASSWORD=postgres psql -h localhost -p ${{ job.services.postgres.ports[5432] }} -U postgres -l
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Create databases
+        run: |
+          env PGPASSWORD=postgres psql -c 'create database sequel_bitemporal_test;' -U postgres -h localhost -p ${{ job.services.postgres.ports[5432] }}
+      - name: Run PostgreSQL tests
+        run: bundle exec rake spec
+        env:
+          TEST_ADAPTER: postgresql
+          TEST_DATABASE: sequel_bitemporal_test
+          TEST_DATABASE_HOST: localhost
+          TEST_DATABASE_PORT: ${{ job.services.postgres.ports[5432] }}
+          TEST_USERNAME: postgres
+          TEST_PASSWORD: postgres
+      - name: Run SQLite tests
+        run: bundle exec rake spec
+        env:
+          TEST_ADAPTER: sqlite

data/README.md

@@ -14,29 +14,37 @@ Dependencies
 Usage
 -----
 
-* Declare bitemporality inside your model:
+Declare bitemporality inside your model:
 
-        class HotelPriceVersion < Sequel::Model
-        end
+```ruby
+class HotelPriceVersion < Sequel::Model
+end
 
-        class HotelPrice < Sequel::Model
-          plugin :bitemporal, version_class: HotelPriceVersion
-        end
+class HotelPrice < Sequel::Model
+  plugin :bitemporal, version_class: HotelPriceVersion
+end
+```
 
-* You can now create a hotel price with bitemporal versions:
+You can now create a hotel price with bitemporal versions:
 
-        price = HotelPrice.new
-        price.update_attributes price: 18
+```ruby
+price = HotelPrice.new
+price.update_attributes price: 18
+```
 
-* To show all versions:
+To show all versions:
 
-        price.versions
+```ruby
+price.versions
+```
 
-* To get current version:
+To show current version:
 
-        price.current_version
+```ruby
+price.current_version
+```
 
-* Look at the specs for more usage patterns.
+Look at the specs for more usage patterns.
 
 Thanks
 ------
@@ -48,7 +56,17 @@ Thanks to Ksenia Zalesnaya (@ksenia-zalesnaya) for her contributions:
 - define setter methods for versioned columns
 
 Thanks to Denis Kalesnikov (@DenisKem) for his contributions:
-- allow composite primary key
+- add support for composite primary key
+  [#8](https://github.com/TalentBox/sequel_bitemporal/pull/8)
+
+Thanks to Olle Jonsson (@olleolleolle) for his contributions:
+- update specs to work with RSpec: `config.disable_monkey_patching!`
+  [#10](https://github.com/TalentBox/sequel_bitemporal/pull/10)
+- update TravisCI matrix to include more Ruby versions
+  [#11](https://github.com/TalentBox/sequel_bitemporal/pull/10)
+- README improvements
+  [#9](https://github.com/TalentBox/sequel_bitemporal/pull/9)
+  [#12](https://github.com/TalentBox/sequel_bitemporal/pull/12)
 
 License
 -------

data/lib/sequel/plugins/bitemporal.rb

@@ -332,9 +332,9 @@ module Sequel
                 { master_id: id }
               end
 
-            current_version.keys.each do |key|
+            current_version.columns.each do |key|
               next if excluded_columns.include? key
-              current_attributes[key] = current_version.send key
+              current_attributes[key] = current_version.public_send key
             end if current_version?
             model.version_class.new current_attributes
           end
@@ -469,7 +469,7 @@ module Sequel
           last_version_attributes = if last_version
             last_version.columns.each_with_object({}) do |column, hash|
               unless excluded_columns.include? column
-                hash[column] = last_version.send column
+                hash[column] = last_version.public_send column
               end
             end
           else
@@ -539,33 +539,28 @@ module Sequel
           to_check_columns = self.class.version_class.columns - excluded_columns
           updated_by = (send(self.class.audit_updated_by_method) if audited?)
           previous_values = @current_version_values || {}
-          current_version_values = {}
-          columns = pending_version.columns - excluded_columns_for_changes
-          columns.each do |column|
-            current_version_values[column] = pending_version.public_send(column)
-          end
-
+          current_values = values_for_changes pending_version
           futures.each do |future_version|
             attrs = {}
             to_check_columns.each do |col|
               if previous_values[col]==future_version[col] &&
-                  previous_values[col]!=current_version_values[col]
-                attrs[col] = current_version_values[col]
+                  previous_values[col]!=current_values[col]
+                attrs[col] = current_values[col]
               end
             end
             if attrs.any?
               propagated = save_propagated future_version, attrs
+              previous_values = values_for_changes future_version
+              current_values = values_for_changes propagated
               if !propagated.new? && audited? && updated_by
                 self.class.audit_class.audit(
                   self,
-                  future_version.values,
-                  propagated.values,
+                  previous_values,
+                  current_values,
                   propagated.valid_from,
                   updated_by
                 )
               end
-              previous_values = future_version.values.dup
-              current_version_values = propagated.values
               future_version.this.update :expired_at => Sequel::Plugins::Bitemporal.point_in_time
             else
               break
@@ -583,7 +578,7 @@ module Sequel
               self.class.audit_class.audit(
                 self,
                 current_values_for_audit,
-                pending_version.values,
+                values_for_changes(pending_version),
                 pending_version.valid_from,
                 updated_by
               ) if updated_by
@@ -597,8 +592,8 @@ module Sequel
 
         def save_fossil(expired, attributes={})
           fossil = model.version_class.new
-          expired_attributes = expired.keys.each_with_object({}) do |key, hash|
-            hash[key] = expired.send key
+          expired_attributes = expired.columns.each_with_object({}) do |key, hash|
+            hash[key] = expired.public_send key
           end
           expired_attributes.delete :id
           fossil.set_all expired_attributes.merge(attributes)
@@ -608,8 +603,8 @@ module Sequel
 
         def save_propagated(version, attributes={})
           propagated = model.version_class.new
-          version_attributes = version.keys.each_with_object({}) do |key, hash|
-            hash[key] = version.send key
+          version_attributes = version.columns.each_with_object({}) do |key, hash|
+            hash[key] = version.public_send key
           end
           version_attributes.delete :id
           version_attributes[:created_at] = Sequel::Plugins::Bitemporal.point_in_time
@@ -627,10 +622,8 @@ module Sequel
         def pending_version_holds_changes?
           return false unless @pending_version
           return true unless current_version?
-          @current_version_values = current_version.values
-          columns = pending_version.columns - excluded_columns_for_changes
-          columns.detect do |column|
-            new_value = pending_version.send column
+          @current_version_values = values_for_changes current_version
+          values_for_changes(pending_version).any? do |column, new_value|
             case column
             when :id, :created_at, :expired_at, *version_foreign_keys
               false
@@ -653,7 +646,7 @@ module Sequel
                   new_value = model.version_class.input_transformers[:string_nilifier].call(new_value)
                 end
               end
-              current_version.send(column)!=new_value
+              current_version.public_send(column)!=new_value
             end
           end
         end
@@ -670,6 +663,14 @@ module Sequel
           @initial_version ||= model.version_class.new
         end
 
+        def values_for_changes(version)
+          values = {}
+          (version.columns - excluded_columns_for_changes).each do |column|
+            values[column] = version.public_send column
+          end
+          values
+        end
+
       end
     end
   end

data/sequel_bitemporal.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "sequel_bitemporal"
-  s.version     = "0.9.1"
+  s.version     = "0.11.0"
   s.authors     = ["Joseph HALTER", "Jonathan TRON"]
   s.email       = ["joseph.halter@thetalentbox.com", "jonathan.tron@thetalentbox.com"]
   s.homepage    = "https://github.com/TalentBox/sequel_bitemporal"

data/spec/bitemporal_serialization_spec.rb

@@ -72,4 +72,42 @@ RSpec.describe "Sequel::Plugins::Bitemporal", :skip_jdbc_sqlite do
     end
   end
 
+  it "can propage changes to future version per column with defaults" do
+    propagate_per_column = @master_class.propagate_per_column
+    begin
+      @master_class.instance_variable_set :@propagate_per_column, true
+      @version_class.class_eval do
+        define_method :name do
+          super() || {}
+        end
+      end
+      master = @master_class.new
+      expect( master.name ).to eql({})
+      expect( master.save ).to be_truthy
+      @version_class.create master_id: master.id, valid_from: Date.parse("2016-01-01"), valid_to: Date.parse("2017-01-01"), price: 0
+      @version_class.create master_id: master.id, valid_from: Date.parse("2017-01-01"), valid_to: Date.parse("2018-01-01"), price: 0, length: 10
+      @version_class.create master_id: master.id, valid_from: Date.parse("2018-01-01"), valid_to: Date.parse("2019-01-01"), price: 0, length: 20
+      @version_class.create master_id: master.id, valid_from: Date.parse("2019-01-01"), valid_to: Date.parse("2020-01-01"), price: 10, length: 20
+      expect(
+        master.update_attributes valid_from: Date.parse("2016-01-01"), price: 10
+      ).to be_truthy
+      result = master.versions_dataset.all.map do |version|
+        [!!version.expired_at, version.valid_from.year, version.valid_to.year, version.price, version.length, version.width, version[:name]]
+      end
+      expect(result).to match_array [
+        [false, 2016, 2017, 10, nil, nil, nil],
+        [false, 2017, 2018, 0, 10, nil, "{}"],
+        [false, 2018, 2019, 0, 20, nil, nil],
+        [false, 2019, 2020, 10, 20, nil, nil],
+        [true, 2016, 2017, 0, nil, nil, nil],
+        [true, 2017, 2018, 0, 10, nil, nil],
+      ]
+    ensure
+      @version_class.class_eval do
+        undef_method :name
+      end
+      @master_class.instance_variable_set :@propagate_per_column, propagate_per_column
+    end
+  end
+
 end

data/spec/spec_helper.rb

@@ -12,11 +12,7 @@ rspec_exclusions = {}
 DB = if DbHelpers.pg?
   `createdb sequel_bitemporal_test`
   Sequel.extension :pg_range, :pg_range_ops
-  if ::Sequel::Plugins::Bitemporal.jruby?
-    Sequel.connect "jdbc:postgresql://localhost/sequel_bitemporal_test"
-  else
-    Sequel.postgres "sequel_bitemporal_test"
-  end
+  Sequel.connect DbHelpers.pg_ruby_connect_uri
 else
   if Sequel::Plugins::Bitemporal.jruby?
     rspec_exclusions[:skip_jdbc_sqlite] = true

data/spec/support/db.rb

@@ -1,13 +1,26 @@
 module DbHelpers
 
   def self.pg?
-    ENV.has_key? "PG"
+    !ENV.has_key?("TEST_ADAPTER") || ENV["TEST_ADAPTER"]=="postgresql"
   end
 
   def self.jruby?
     (defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby') || defined?(JRUBY_VERSION)
   end
 
+  def self.pg_ruby_connect_uri
+    username = ENV.fetch("TEST_USERNAME", nil)
+    password = ENV.fetch("TEST_PASSWORD", nil)
+    auth = [username, password].compact.join(":")
+
+    uri = "postgresql://#{"#{auth}@" unless auth.empty?}#{ENV.fetch("TEST_DATABASE_HOST", "127.0.0.1")}:#{ENV.fetch("TEST_DATABASE_PORT", "5432")}/#{ENV.fetch("TEST_DATABASE", "sequel_bitemporal_test")}"
+    if jruby?
+      "jdbc:#{uri}"
+    else
+      uri
+    end
+  end
+
   def db_setup(opts={})
     use_time = opts[:use_time]
     DB.drop_table(:room_versions) if DB.table_exists?(:room_versions)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sequel_bitemporal
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Joseph HALTER
 - Jonathan TRON
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-29 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -81,10 +81,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -106,7 +106,7 @@ homepage: https://github.com/TalentBox/sequel_bitemporal
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,9 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Bitemporal versioning for sequel.
 test_files:

data/.travis.yml

@@ -1,24 +0,0 @@
-language: ruby
-cache:
-  bundler: true
-sudo: false
-rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.2
-  - jruby-9.1.13.0
-before_script:
-  - psql  -c 'create database sequel_bitemporal_test;' -U postgres
-env:
-  - SQLITE=1 SEQUEL='~> 4.0'
-  - SQLITE=1 SEQUEL='~> 5.0'
-  - PG=1 SEQUEL='~> 4.0'
-  - PG=1 SEQUEL='~> 5.0'
-gemfile:
-  - ci/sequel.gemfile
-matrix:
-  allow_failures:
-    - rvm: jruby-9.1.13.0
-      env: PG=1 SEQUEL='~> 4.0'
-    - rvm: jruby-9.1.13.0
-      env: PG=1 SEQUEL='~> 5.0'