RubyGems - odba - Versions diffs - 1.1.9 → 1.2.0 - Mend

odba 1.1.9 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (46) hide show

checksums.yaml +4 -4
data/.github/workflows/devenv.yml +30 -0
data/.github/workflows/ruby.yml +8 -7
data/.gitignore +11 -0
data/{History.txt → History.md} +40 -20
data/README.md +77 -1
data/Rakefile +3 -15
data/devenv.lock +171 -0
data/devenv.nix +53 -0
data/devenv.yaml +8 -0
data/lib/odba/cache.rb +395 -344
data/lib/odba/cache_entry.rb +42 -31
data/lib/odba/connection_pool.rb +99 -72
data/lib/odba/drbwrapper.rb +26 -18
data/lib/odba/id_server.rb +20 -20
data/lib/odba/index.rb +249 -215
data/lib/odba/index_definition.rb +17 -17
data/lib/odba/marshal.rb +15 -14
data/lib/odba/odba.rb +40 -32
data/lib/odba/odba_error.rb +4 -2
data/lib/odba/persistable.rb +460 -414
data/lib/odba/storage.rb +328 -277
data/lib/odba/stub.rb +166 -153
data/lib/odba/version.rb +1 -1
data/lib/odba.rb +9 -9
data/odba.gemspec +8 -3
data/test/example.rb +47 -0
data/test/helper.rb +6 -0
data/test/suite.rb +7 -0
data/test/test_array.rb +38 -33
data/test/test_cache.rb +657 -622
data/test/test_cache_entry.rb +51 -71
data/test/test_connection_pool.rb +70 -25
data/test/test_drbwrapper.rb +24 -19
data/test/test_hash.rb +98 -89
data/test/test_id_server.rb +30 -32
data/test/test_index.rb +191 -158
data/test/test_marshal.rb +15 -25
data/test/test_persistable.rb +378 -369
data/test/test_storage.rb +510 -471
data/test/test_stub.rb +147 -135
metadata +63 -20
data/Guide.txt +0 -36
data/Manifest.txt +0 -38
data/install.rb +0 -1098
data/lib/odba/18_19_loading_compatibility.rb +0 -77

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf433bdf191c8648bff438af766f69c0d67719c16bafc26873224bb3b470dedd
-  data.tar.gz: fac7e49118a2d3be4235b4cd8f6865f6b1f993cb58b11da176ab379a7d8b50fe
+  metadata.gz: 384e9358b0cfe5735935d1b1d2e43706b01adaceb9a0c2cce51a357a2a8321eb
+  data.tar.gz: 79568f015a42389ee5abe8f159f6baefc0e300ac0c6d692b1856ab7c3613d08b
 SHA512:
-  metadata.gz: c3658aaeaed768a1533b2d2f26901a3f1504fca1486061e6b066d4d01eeac4b53c21af09592f217a81ef58b0d19ca09e94655ea002db07fee6c26a5577e62b6d
-  data.tar.gz: e3bd93f6b85575220201abb7350337025fb0a790c9e4af1c7d791a350184b9f4bb25de9b3705bcd6ec2ff5060fe7cbf574bb787aba7fa3b0221f6d9386e9fddc
+  metadata.gz: a2a5cac7871f9d46476e7f45edc3c2afc31dfc2517cfa67b5fdd97e740f331c8b39b018ce2c3928046215d5fcdc11e4dbe2e9b5b70bf6231c33e0690b6bc364f
+  data.tar.gz: 967b6811d2f8833145a9ee90ffe6c5b84c896ef23ee663e616b2a9f25efff33930cde98ea4d35b3d279ee6a74feed785badb249d5ca32cd1ba6eeb989fc794a9

data/.github/workflows/devenv.yml ADDED Viewed

@@ -0,0 +1,30 @@
+name: "devenv test using a real postgres database"
+on:
+  pull_request:
+  push:
+jobs:
+  tests:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v4
+    - uses: cachix/install-nix-action@v26
+    - uses: cachix/cachix-action@v14
+      with:
+        name: devenv
+    - name: Install devenv.sh
+      run: nix profile install nixpkgs#devenv
+    - name: Build the devenv shell and run any pre-commit hooks
+      run: devenv test
+    - name: Run the example.rb which uses a real database
+      shell: devenv shell bash -- -e {0}
+      run: |
+        devenv up --detach
+        devenv shell bundle exec ruby test/example.rb

data/.github/workflows/ruby.yml CHANGED Viewed

@@ -9,9 +9,11 @@ name: Ruby
 on:
   push:
-    branches: [ master ]
+    branches:
+      - '*'
   pull_request:
-    branches: [ master ]
+    branches:
+      - '*'
 jobs:
   test:
@@ -22,14 +24,13 @@ jobs:
       fail-fast: false
       matrix:
         os: [ ubuntu]
-        ruby: [2.7, 3.0, 3.1, head]
-    continue-on-error: ${{ endsWith(matrix.ruby, 'head') }}
+        ruby: [3.2, 3.3, 3.4]
+    continue-on-error: ${{  matrix.ruby.to_s == '3.3' || matrix.ruby.to_s == '3.4' }}
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
-    - name: Run tests via rake test
-      run: bundle exec rake test
+    - name: Run tests via test/suite.rb
+      run: bundle exec ruby test/suite.rb

data/.gitignore CHANGED Viewed

@@ -2,3 +2,14 @@
 vendor/
 coverage/
 pkg/
+Gemfile.lock
+# Devenv
+.devenv*
+devenv.local.nix
+# direnv
+.direnv
+# pre-commit
+.pre-commit-config.yaml

data/{History.txt → History.md} RENAMED Viewed

@@ -1,90 +1,110 @@
-=== 1.1.9 / 28.06.2025
+## 1.2.0 / 21.08.2026
+* Reconnect when the database connection was lost. ydbd-pg reports a lost
+  connection as DBI::ProgrammingError, which the ConnectionPool excluded from
+  its retry, so a restart of the PostgreSQL server left every pooled connection
+  broken until the client process itself was restarted
+* Removed obsolete install.rb. Updated History.txt and moved it to History.md
+* Used standarb for all files
+* Removed obsolete (and not needed) WITH_OIDS to allow running with postgres 12 and later
+* Use SimpleCov. Simplified test/test*.rb to include test/helper.rb and start coverage
+* Updated README.md for devenv
+* Run test/exmple.rb using devenv in .github/workflows/devenv.yml
+* Added test/exmple.rb using a real Postgresql 17. Updated README
+* Merged Guide.txt and into README.md
+* Silence NOTICE if table already exists
+* Removed obsolete Manifest.txt and 18_19_loading_compatibility
+* Added devenv environment for Ruby 3.4 and Postgresql 17
+* limit github CI to rubies 3.2,3.3 and 3.4
+* changelog_uri to gemspec
+## 1.1.9 / 28.06.2025
 * bulk_restore throws OdbaError when stack size > 1000
-=== 1.1.8 / 10.03.2021
+## 1.1.8 / 10.03.2021
 * Removed fixed dependency to pg (is optional like mysql2)
-=== 1.1.7 / 20.01.2021
+## 1.1.7 / 20.01.2021
 * Reworked some tests
 * Updated to use Ruby 3.0.0
 * Added github actions
 * Updated to use ydbi 0.5.7
-=== 1.1.6 / 23.01.2016
+## 1.1.6 / 23.01.2016
 * Updated to use ydbi 0.5.6
-=== 1.1.5 / 23.01.2016
+## 1.1.5 / 23.01.2016
 * Remove unused parameter dict for update_fulltext_index
-=== 1.1.4 / 13.12.2017
+## 1.1.4 / 13.12.2017
 * Drop text search dictionaries/configuration before recreating
 * Remove dictionary argument in fulltext search and index_definition
-=== 1.1.3 / 12.12.2016
+## 1.1.3 / 12.12.2016
 * Avoid errors by always specifying "IF NOT EXISTS" when creating tables and indices
 * Add utility method get_server_version
 * Removed misleading check in generate_dictionary
-=== 1.1.2 / 10.05.2016
+## 1.1.2 / 10.05.2016
 * requires now 'ydbi' and 'ydbd-pg'
-=== 1.1.1 / 10.05.2016
+## 1.1.1 / 10.05.2016
 * Made tests pass under Ruby 1.9.3, 2.x
 * Updated to use minitest
-=== 1.1.0 / 15.03.2013
+## 1.1.0 / 15.03.2013
 * Update dict source file name for multi languages
-=== 1.0.9 / 15.03.2013
+## 1.0.9 / 15.03.2013
 * Update dictionary to be suitable for new tsearch2
   - generate_dictionary API is changed.
   - generate_dictionary needs dict source files(dict, affix, stop)
     into /usr/share/postgresql/tsearch_data.
-=== 1.0.8 / 09.01.2012
+## 1.0.8 / 09.01.2012
 * Added exclusive control to update @accessed_by Hash variable in CacheEntry class using mutex (Patinfo-Invoice Error)
-=== 1.0.7 / 27.12.2011
+## 1.0.7 / 27.12.2011
 * Debugged Hash iteration error during cleaning @fetched and @prefetched objects
-=== 1.0.6 / 23.12.2011
+## 1.0.6 / 23.12.2011
 * Fix all the elements of odba_potentials and odba_exclude_vars to be Symbols for Ruby 1.9.3
-=== 1.0.5 / 20.12.2011
+## 1.0.5 / 20.12.2011
 * Added attr_accessor :odba_persistent so we can update doctor addresses on ch.oddb.org
-=== 1.0.4 / 12.12.2011
+## 1.0.4 / 12.12.2011
 * Fixed file lock process by using @file_lock flag variable to control it in application side
-=== 1.0.3 / 09.12.2011
+## 1.0.3 / 09.12.2011
 * Debugged ODBA::Cache#next_id
-=== 1.0.2 / 09.12.2011
+## 1.0.2 / 09.12.2011
 * Updated cache.rb persitatble.rb 18_19_loading_compatibility.rb to be compatible for both Ruby 1.8 and 1.9
-=== 1.0.1 / 08.12.2011
+## 1.0.1 / 08.12.2011
 * Added file lock exclusive control to create a new odba_id between processes.
-=== 1.0.0 / 20.12.2010
+## 1.0.0 / 20.12.2010
 * Add ODBA.cache.index_matches(index_name, substring)

data/README.md CHANGED Viewed

@@ -1,10 +1,23 @@
 # odba
+ODBA is an unintrusive Object Cache system. It adresses the crosscutting
+concern of object storage by disconnecting and serializing objects into
+storage. All disconnected connections are replaced by instances of
+ODBA::Stub, thus enabling transparent object-loading.
 * https://github.com/zdavatz/odba
 To see a graphical overview of the Library please see
-* https://raw.githubusercontent.com/ngiger/odba/master/odba.jpeg
+* https://raw.githubusercontent.com/zdavatz/odba/master/odba.jpeg
+## ODBA supports
+ * transparent loading of connected objects
+ * index-vectors
+ * transactions
+ * transparently fetches Hash-Elements without loading the entire Hash
 ## DESCRIPTION:
@@ -15,6 +28,68 @@ To see a graphical overview of the Library please see
 * There may still be an sql bottleneck. Has to be investigated further.
 * You will need postgresql installed.
+* The unit test test_clean__prefetched in test/test_cache.rb fails with Ruby 3.3/3.4 sometimes but not always
+* Rework the unit tests to use a test database and less flexmock
+* Rebase the library on the Sequel gem instead of ydbi/ydbd_pg
+## Example
+You may find this code and some tests which is using this (example)[https://github.com/zdavatz/odba/blob/master/test/example.rb]
+    require "odba/connection_pool"
+    class User
+      attr_accessor :first_name, :last_name
+      include ODBA::Persistable
+      def initialize(first_name, last_name)
+        @first_name = first_name
+        @last_name = last_name
+      end
+      def to_s
+        "#{@first_name} #{@last_name}"
+      end
+    end
+    class Example
+      def self.db_setup
+        # connect default storage manager to a relational database  on
+        # our localhost using port 5435 with a user odba_test and an empty password
+        ODBA.storage.dbi = ODBA::ConnectionPool.new("DBI:Pg:dbname=odba_test;host=127.0.0.1;port=5432", "odba_test", "")
+        ODBA.cache.setup
+      end
+      def self.show_last_added_user
+        res = ODBA.storage.dbi.select_all("Select count(*) from object;").first.first
+        odba_id = ODBA.storage.dbi.select_one("select odba_id from object order by odba_id desc limit 1;")
+        puts "show_last_added_user: We have  #{res} objects. Highest odba_id is #{odba_id}"
+        first = ODBA.storage.dbi.select_one("select odba_id, name, prefetchable, extent, content from object order by odba_id desc limit 1;")
+        puts "  DB-content is #{first}"
+        puts "  Fetched object for odba_id #{odba_id} is #{ODBA.cache.fetch(odba_id.first)}"
+      end
+    end
+    Example.db_setup
+    composer = User.new("Ludwig", "Van Beethoven")
+    composer.odba_store
+    Example.show_last_added_user
+    painter = User.new("Vincent", "Van Gogh")
+    painter.odba_store
+    scientist = User.new("Albert", "Einstein")
+    scientist.odba_store
+    Example.show_last_added_user
+You will see something like
+    show_last_added_user: We have  2 objects. Highest odba_id is [2]
+      DB-content is [2, nil, false, "User", "04086f3a09557365720b3a104066697273745f6e616d6549220b4c7564776967063a0645543a0f406c6173745f6e616d6549221256616e2042656574686f76656e063b07543a15406f6462615f70657273697374656e74543a0d406f6462615f696469073a14406f6462615f6f6273657276657273303a13406f6462615f707265666574636830"]
+      Fetched object for odba_id [2] is Ludwig Van Beethoven
+    show_last_added_user: We have  4 objects. Highest odba_id is [4]
+      DB-content is [4, nil, false, "User", "04086f3a09557365720b3a104066697273745f6e616d6549220b416c62657274063a0645543a0f406c6173745f6e616d6549220d45696e737465696e063b07543a15406f6462615f70657273697374656e74543a0d406f6462615f696469093a14406f6462615f6f6273657276657273303a13406f6462615f707265666574636830"]
+      Fetched object for odba_id [4] is Albert Einstein
+This example is run on each push to github via the (github action)[https://github.com/zdavatz/odba/blob/master/.github/workflows/devenv.yml]. It is based on (devenv.sh)[https://devenv.sh/], which ensures reproducability.
 ## INSTALL:
@@ -25,6 +100,7 @@ To see a graphical overview of the Library please see
 * Masamoi Hatakeyama
 * Zeno R.R. Davatz
 * Hannes Wyss (up to Version 1.0)
+* Niklaus Giger (Porting to Ruby 2.x and 3.x, cleanup)
 ## LICENSE:

data/Rakefile CHANGED Viewed

@@ -1,25 +1,13 @@
 #!/usr/bin/env ruby
-# encoding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'odba/version'
 require "bundler/gem_tasks"
 require 'rake/testtask'
-# dependencies are now declared in odba.gemspec
-desc 'Offer a gem task like hoe'
-task :gem => :build do
-  Rake::Task[:build].invoke
-end
-desc "Run tests"
-task :default => :test
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
+task default: "test"
+Rake::TestTask.new(:test) do |task|
+  require_relative 'test/suite'
 end

data/devenv.lock ADDED Viewed

@@ -0,0 +1,171 @@
+{
+  "nodes": {
+    "devenv": {
+      "locked": {
+        "dir": "src/modules",
+        "lastModified": 1736426010,
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "1c384bc4be3ee571511fbbc6fdc94fe47d60f6cf",
+        "type": "github"
+      },
+      "original": {
+        "dir": "src/modules",
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1733328505,
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-compat_2": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1733328505,
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1731533236,
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "git-hooks": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1742649964,
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "rev": "dcf5072734cb576d2b0c59b2ac44f5050b5eac82",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "git-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1709087332,
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1736200483,
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "3f0a8ac25fb674611b98089ca3a5dd6480175751",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-24.11",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-ruby": {
+      "inputs": {
+        "flake-compat": "flake-compat_2",
+        "flake-utils": "flake-utils",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1735192621,
+        "owner": "bobvanderlinden",
+        "repo": "nixpkgs-ruby",
+        "rev": "602c528c8228f231f912c6d117703a1700464202",
+        "type": "github"
+      },
+      "original": {
+        "owner": "bobvanderlinden",
+        "repo": "nixpkgs-ruby",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devenv": "devenv",
+        "git-hooks": "git-hooks",
+        "nixpkgs": "nixpkgs",
+        "nixpkgs-ruby": "nixpkgs-ruby",
+        "pre-commit-hooks": [
+          "git-hooks"
+        ]
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

data/devenv.nix ADDED Viewed

@@ -0,0 +1,53 @@
+{
+  inputs,
+  pkgs,
+  config,
+  lib,
+  ...
+}:
+{
+  # https://devenv.sh/basics/
+  env.GREET = "devenv";
+  # https://devenv.sh/packages/
+  packages = [
+    pkgs.git
+    pkgs.libyaml
+    pkgs.nixfmt-rfc-style
+  ];
+  enterShell = ''
+    echo This is the devenv shell for odba_test
+    git --version
+    ruby --version
+    psql --version
+    bundle install
+  '';
+  services.postgres = {
+    enable = true;
+    package = pkgs.postgresql_17;
+    listen_addresses = "0.0.0.0";
+    port = 5432;
+    initialDatabases = [
+      { name = "odba_test"; }
+    ];
+    initdbArgs = [
+      "--locale=C"
+      "--encoding=UTF8"
+    ];
+    initialScript = ''
+      create role odba_test superuser login password null;
+    '';
+  };
+  languages.ruby.enable = true;
+  languages.ruby.version = "3.4";
+  # See full reference at https://devenv.sh/reference/options/
+  enterTest = ''
+    devenv up --detach
+    bundle exec test/example.rb
+  '';
+}

data/devenv.yaml ADDED Viewed

@@ -0,0 +1,8 @@
+inputs:
+  nixpkgs:
+    url: github:NixOS/nixpkgs/nixos-24.11
+  nixpkgs-ruby:
+    url: github:bobvanderlinden/nixpkgs-ruby
+    inputs:
+      nixpkgs:
+        follows: nixpkgs