persistent_hash 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06b320eea13bba423859587cff01a544d305ec19
-  data.tar.gz: 2c5a643b36f877b1aaa3ad210fee8c011a73f750
+SHA256:
+  metadata.gz: f01509aa35f1f9eed7a0467d37532b84beaab132afb7b23ef17966668df91335
+  data.tar.gz: 30edd6d30e5d666261be5ce537cce845ca24cd58032a7f0774f3819efb4c8cb9
 SHA512:
-  metadata.gz: 71cfed0122f4b6599e573004a3aa69fb167af398f75ce5f710dbe6ad96d2cd54f33f348de365397d533dc2da2183ddced1fa11665fb38743310bdbdf98d0f123
-  data.tar.gz: ad6f5667e8316b8d24ad130e8d5ba0010f927dce8b9c707fd98511fded7c5f3d9acf3443f70625ee110c0febfb4b247e797fd253a81880a963d5161210ae6cae
+  metadata.gz: f1056539aa88fd5ec3b240281eda31b5c026611a0cf80f2922a02dcaf2f9129a28c30b9f5c5522b51751e13e19bea74e3c6e031493b0effd05d3fe8153897ed7
+  data.tar.gz: 63a87f7cc42789c4cda1404d1dedbf57a12872dff0f7d349b4fcba30cb157b8f4f5d8d8c1c226285f411efc02b3439cb6cbaf516af93d5dd97809b7574c1a9b5

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+## 1.0.0 : June 8, 2026
+
+  - **Breaking:** drop support for end-of-life Ruby and Rails versions.
+  - Supported Ruby versions are now 3.3, 3.4 and 4.0 (Ruby 4.0 requires Rails 8.0+).
+  - Supported Rails versions are now 7.2, 8.0 and 8.1 (`rails >= 7.2`).
+  - Fix compatibility with Rails 7.1+ by removing the `legacy_connection_handling`
+    setting from the dummy app (the option was removed from Rails).
+  - Refresh the CI matrix and bump GitHub Actions, MySQL and PostgreSQL service versions.
+
+## 0.7.0 : July 25, 2019
+
+  - do "select then insert/update/delete" instead of "always delete then always insert"
+    to consume fewer autoinc values and hopefully prevent some deadlocks. [#6](https://github.com/alexdean/persistent_hash/pull/6)
+
+## 0.0.6 : February 2, 2017
+
+  - ensure that keys are updated within a transaction, so another thread cannot
+    see a NULL value if it SELECTs while another thread is doing a
+    DELETE and then INSERT.
+
+## 0.0.5 : January 19, 2017
+
+  - value column is now a TEXT rather than a VARCHAR. allow larger values.
+
+## 0.0.4 : July 25, 2016
+
+  - rails 5 support.

data/README.md

@@ -0,0 +1,99 @@
+## Overview
+
+PersistentHash provides an ActiveRecord-base key/value store which can be used
+for various bits of application state which don't need dedicated models of
+their own.
+
+## Build Status
+
+[![Test Suite](https://github.com/alexdean/persistent_hash/actions/workflows/rspec.yml/badge.svg)](https://github.com/alexdean/persistent_hash/actions/workflows/rspec.yml)
+
+## Supported versions
+
+`persistent_hash` is tested against currently-supported (non-EOL) Ruby and Rails
+releases:
+
+  - Ruby 3.3, 3.4, 4.0
+  - Rails 7.2, 8.0, 8.1
+
+Ruby 4.0 is supported with Rails 8.0 and 8.1. Rails 7.2 does not support Ruby 4.0.
+
+For older Ruby/Rails versions, use `persistent_hash` 0.7.x.
+
+## Usage
+
+```ruby
+# inserts a record into the database
+PersistentHash['foo'] = :bar
+
+# retrieves that record
+PersistentHash['foo']
+# => :bar
+```
+
+## Installation
+
+```ruby
+# Gemfile
+gem 'persistent_hash'
+```
+
+```
+$ bundle
+$ rake persistent_hash:install:migrations
+$ rake db:migrate
+```
+
+## Formatters
+
+PersistentHash stores data in marshalled Ruby objects. Because these marshalled
+objects are hard to read at a glance, the class also stores a formatted version
+which is intended to be readable outside of Ruby. This is useful for inspecting
+data via a SQL client or if you have a non-Ruby process (like nagios) watching
+the values in this table.
+
+```ruby
+# config/initializers/persistent_hash.rb
+Rails.application.config.to_prepare do
+  PersistentHash::Formatter.add(Integer, ->(val) { "This Integer is #{val}."})
+end
+
+PersistentHash['number'] = 5
+
+PersistentHash::Hash.where(key_name: 'number').first.readable_value
+# => "This Integer is 5."
+```
+
+## Limitations
+
+### Low-volume
+
+I've used this gem in production for storing relatively low volumes of data.
+Typically it serves as a registry for configuration values and current-state
+information. It may not be suitable as a high-volume key/value store.
+
+### Marshal usage
+
+Stored objects are [marshalled](http://ruby-doc.org/core-2.2.2/Marshal.html) for
+storage, and unmarshalled on retrieval.
+
+This means:
+
+  - you can store most Ruby objects
+  - storage is not necessarily portable across Ruby versions
+
+Read more about the [Marshal](http://ruby-doc.org/core-2.2.2/Marshal.html)
+module to understand the limitations of this approach.
+
+## Why?
+
+To minimize dependencies.
+
+Projects I work on already have a primary database (typically mysql), and adding
+an additional dedicated database (like redis) for key/value pairs increases
+service dependencies for no real benefit. Mysql is perfectly capable of doing
+this job on its own. PersistentHash is just a nice way of doing it.
+
+I've got nothing against redis. (In fact, I use it every day.) I'm just very
+wary of addition additional dependencies to projects when they're not absolutely
+necessary.

data/app/models/persistent_hash/hash.rb

@@ -1,22 +1,21 @@
 module PersistentHash
   class Hash < ActiveRecord::Base
-
     self.table_name = 'persistent_hash'
 
     # save a value in the hash
     def self.[]=(key_name, value)
-      transaction do
-        where(key_name: key_name).delete_all
-
-        if ! value.nil?
-          formatted = PersistentHash::Formatter.format(value)
+      item = where(key_name: key_name)
+             .lock
+             .first_or_initialize
 
-          create!(
-            key_name: key_name,
-            readable_value: formatted,
-            marshalled: Base64.encode64(Marshal.dump(value))
-          )
-        end
+      if value.nil?
+        item.destroy
+      else
+        formatted = PersistentHash::Formatter.format(value)
+        item.update(
+          readable_value: formatted,
+          marshalled: Base64.encode64(Marshal.dump(value))
+        )
       end
     end
 
@@ -32,6 +31,5 @@ module PersistentHash
 
       value
     end
-
   end
 end

data/db/migrate/20150518213536_create_persistent_hash.rb

@@ -1,4 +1,4 @@
-class CreatePersistentHash < ActiveRecord::Migration
+class CreatePersistentHash < ActiveRecord::Migration[4.2]
   def change
     create_table :persistent_hash do |t|
       t.string   :key_name, null: false
@@ -7,6 +7,6 @@ class CreatePersistentHash < ActiveRecord::Migration
       t.datetime :updated_at, null: false
     end
 
-    add_index :persistent_hash, :key_name, unique: true
+    add_index :persistent_hash, :key_name, unique: true, name: 'persistent_hash_uniq'
   end
 end

data/db/migrate/20161110111600_convert_readable_value_to_text.rb

@@ -1,4 +1,4 @@
-class ConvertReadableValueToText < ActiveRecord::Migration
+class ConvertReadableValueToText < ActiveRecord::Migration[4.2]
   def change
     change_column :persistent_hash, :readable_value, :text
   end

data/db/migrate/20190618182005_utf8_mb4.rb

@@ -0,0 +1,5 @@
+class Utf8Mb4 < ActiveRecord::Migration[5.2]
+  def change
+    change_column 'persistent_hash', 'key_name', :string, limit: 191
+  end
+end

data/lib/persistent_hash/version.rb

@@ -1,3 +1,3 @@
 module PersistentHash
-  VERSION = "0.0.6"
+  VERSION = "1.0.0"
 end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,33 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'active_record/railtie'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+  # action_mailer/railtie
+  # active_job/railtie
+  # action_cable/engine
+  # action_mailbox/engine
+  # action_text/engine
+  # rails/test_unit/railtie
+
+Bundler.require(*Rails.groups)
+require "persistent_hash"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks. (added in 4.2)
+    # config.active_record.raise_in_transactional_callbacks = true
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,32 @@
+default: &default
+  password: <%= ENV['DB_PASSWORD'] %>
+<% if !ENV['DB'] %>
+  adapter: mysql2
+  username: root
+  encoding: utf8mb4
+  collation: utf8mb4_unicode_ci
+<% elsif ENV['DB'] == 'mysql' %>
+  adapter: mysql2
+  host: 127.0.0.1
+  port: 3306
+  username: <%= ENV['DB_USERNAME'] %>
+  encoding: utf8mb4
+  collation: utf8mb4_unicode_ci
+<% elsif ENV['DB'] == 'pgsql' %>
+  adapter: postgresql
+  host: localhost
+  port: 5432
+  user: <%= ENV['DB_USERNAME'] %>
+<%
+  else
+    raise "unknown DB value '#{ENV['DB']}'"
+  end
+%>
+
+development:
+  <<: *default
+  database: persistent_hash_development
+
+test:
+  <<: *default
+  database: persistent_hash_test

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  # config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  # config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  # config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,79 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,42 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # config.action_mailer.delivery_method = :test
+
+  # Randomize the order test cases are executed.
+  config.active_support.test_order = :random
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/dummy/config/initializers/assets.rb

@@ -0,0 +1,11 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+# Rails.application.config.assets.version = '1.0'
+
+# Add additional assets to the asset load path
+# Rails.application.config.assets.paths << Emoji.images_path
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+# Rails.application.config.assets.precompile += %w( search.js )

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/cookies_serializer.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end