pstore 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4af5fcacc680025ce66c1ada2096341526492d999f65d9e406a4f48f105c60e
-  data.tar.gz: fcb504575c025d4797935076248d4490fd2ceaa72a17176129481f40aaadd95b
+  metadata.gz: be4c744cb12983612ebef3ae585d25571252869cfef51a8799a0c3328be339c8
+  data.tar.gz: 9527c38bdea78cfee23874de9ecfdfee3ce9beefb541bd6e26abfa3ba55e3a3c
 SHA512:
-  metadata.gz: 16e1c1157c8edfdaabb2e5f90979a6e05bb1c77ebec3f4dc4b3bf503715e0e36bbc4efaa0ddcd56fcbe035a55dca4cadc72f493b6242da14912e1842f78de0a3
-  data.tar.gz: 64b2f0fbe41c31a35a991ea1b1abfce61907ae880a9bab90ba58875c4abdbe922ecaf2dd8bbaa3d83001fbea272104484a3358571b58f3ab4ecb917d6417d9da
+  metadata.gz: 7fa202004bbd5761b8a457fda173f69d2b0574d1b995ef3e2800c2881213719fb6e9cacd4d0cccfb29b0864c28f149a0520b4102f0172ecfccf7ae277367d023
+  data.tar.gz: b2724f28ea0ede1bac0675f77bc00665771b88b6e946da3dfd00ab0e946adef9589a350bcce05732c4568b867714b98fc7133810083a5af60ee62fdd67936efc

data/.document

@@ -0,0 +1,4 @@
+BSDL
+COPYING
+README.md
+lib/

data/.github/release.yml

@@ -0,0 +1,4 @@
+changelog:
+  exclude:
+    labels:
+      - dependencies # Added by Dependabot

data/.github/workflows/push_gem.yml

@@ -23,24 +23,24 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        uses: step-security/harden-runner@ccd8616d44fd3846e67624a50d5aad6d37bf2d25 # v2.22.1
         with:
           egress-policy: audit
 
-      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@a6e6f86333f0a2523ece813039b8b4be04560854 # v1.190.0
+        uses: ruby/setup-ruby@d5126b9b3579e429dd52e51e68624dda2e05be25 # v1.267.0
         with:
           bundler-cache: true
           ruby-version: ruby
 
       - name: Publish to RubyGems
-        uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32 # v1.1.1
+        uses: rubygems/release-gem@7f9650160c1a4e7989fdc9855807bdbd421d8b6b # v1.4.1
 
       - name: Create GitHub release
         run: |
           tag_name="$(git describe --tags --abbrev=0)"
           gh release create "${tag_name}" --verify-tag --generate-notes
         env:
-          GITHUB_TOKEN: ${{ secrets.MATZBOT_GITHUB_WORKFLOW_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/test.yml

@@ -15,13 +15,17 @@ jobs:
     strategy:
       matrix:
         ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
-        os: [ ubuntu-latest, macos-latest ]
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
         exclude:
           - { os: macos-latest, ruby: '2.4' }
           - { os: macos-latest, ruby: '2.5' }
+          - { os: windows-latest, ruby: head }
+        include:
+          - { os: windows-latest, ruby: mingw }
+          - { os: windows-latest, ruby: mswin }
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/lib/pstore.rb

@@ -326,11 +326,15 @@ require "digest"
 #  end
 #
 class PStore
-  VERSION = "0.2.0"
+  # :stopdoc:
+  VERSION = "0.3.0"
 
-  RDWR_ACCESS = {mode: IO::RDWR | IO::CREAT | IO::BINARY, encoding: Encoding::ASCII_8BIT}.freeze
-  RD_ACCESS = {mode: IO::RDONLY | IO::BINARY, encoding: Encoding::ASCII_8BIT}.freeze
-  WR_ACCESS = {mode: IO::WRONLY | IO::CREAT | IO::TRUNC | IO::BINARY, encoding: Encoding::ASCII_8BIT}.freeze
+  RDWR_ACCESS = IO::RDWR | IO::CREAT | IO::BINARY
+  RD_ACCESS = IO::RDONLY | IO::BINARY
+  WR_ACCESS = IO::WRONLY | IO::CREAT | IO::TRUNC | IO::BINARY
+  NOFOLLOW = IO.const_defined?(:NOFOLLOW) ? IO::NOFOLLOW : 0
+  private_constant :RDWR_ACCESS, :RD_ACCESS, :WR_ACCESS, :NOFOLLOW
+  # :startdoc:
 
   # The error type thrown by all PStore methods.
   class Error < StandardError
@@ -364,12 +368,26 @@ class PStore
   #
   # A \PStore object is
   # {reentrant}[https://en.wikipedia.org/wiki/Reentrancy_(computing)].
-  # If argument +thread_safe+ is given as +true+,
+  # If argument or keyword argument +thread_safe+ is given as +true+,
   # the object is also thread-safe (at the cost of a small performance penalty):
   #
   #   store = PStore.new(path, true)
+  #   store = PStore.new(path, thread_safe: true)
   #
-  def initialize(file, thread_safe = false)
+  # If keyword argument +ultra_safe+ is given as +true+, the object is
+  # set to +ultra_safe+ mode.
+  #
+  #   store = PStore.new(path, ultra_safe: true)
+  #
+  # If keyword argument +follow_symlink+ is given as +false+, the store file
+  # itself must not be a symbolic link.  This option has no effect on platforms
+  # that do not support IO::NOFOLLOW.  Symbolic links in parent directories are
+  # not affected.
+  #
+  #   store = PStore.new(path, follow_symlink: false)
+  #
+  def initialize(file, _thread_safe = false, thread_safe: _thread_safe,
+                 ultra_safe: false, follow_symlink: true)
     dir = File::dirname(file)
     unless File::directory? dir
       raise PStore::Error, format("directory %s does not exist", dir)
@@ -377,16 +395,17 @@ class PStore
     if File::exist? file and not File::readable? file
       raise PStore::Error, format("file %s not readable", file)
     end
-    @filename = file
+    @filename = File.path(file)
     @abort = false
-    @ultra_safe = false
+    @ultra_safe = ultra_safe
     @thread_safe = thread_safe
+    @nofollow = follow_symlink ? 0 : NOFOLLOW
     @lock = Thread::Mutex.new
   end
 
   # Raises PStore::Error if the calling code is not in a PStore#transaction.
   def in_transaction
-    raise PStore::Error, "not in transaction" unless @lock.locked?
+    raise PStore::Error, "not in transaction" unless @lock.owned?
   end
   #
   # Raises PStore::Error if the calling code is not in a PStore#transaction or
@@ -436,7 +455,7 @@ class PStore
   def fetch(key, default=PStore::Error)
     in_transaction
     unless @table.key? key
-      if default == PStore::Error
+      if PStore::Error.equal?(default)
         raise PStore::Error, format("undefined key '%s'", key)
       else
         return default
@@ -524,7 +543,7 @@ class PStore
   def commit
     in_transaction
     @abort = false
-    throw :pstore_abort_transaction
+    throw self
   end
 
   # Exits the current transaction block, discarding any changes
@@ -535,7 +554,7 @@ class PStore
   def abort
     in_transaction
     @abort = true
-    throw :pstore_abort_transaction
+    throw self
   end
 
   # Opens a transaction block for the store.
@@ -567,7 +586,7 @@ class PStore
         begin
           @table, checksum, original_data_size = load_data(file, read_only)
 
-          catch(:pstore_abort_transaction) do
+          catch(self) do
             value = yield(self)
           end
 
@@ -580,7 +599,7 @@ class PStore
       else
         # This can only occur if read_only == true.
         @table = {}
-        catch(:pstore_abort_transaction) do
+        catch(self) do
           value = yield(self)
         end
       end
@@ -591,6 +610,8 @@ class PStore
   end
 
   private
+  # :stopdoc:
+
   # Constant for relieving Ruby's garbage collector.
   CHECKSUM_ALGO = %w[SHA512 SHA384 SHA256 SHA1 RMD160 MD5].each do |algo|
     begin
@@ -604,6 +625,7 @@ class PStore
 
   EMPTY_MARSHAL_DATA.freeze
   EMPTY_MARSHAL_CHECKSUM.freeze
+  private_constant :CHECKSUM_ALGO, :EMPTY_STRING, :EMPTY_MARSHAL_DATA, :EMPTY_MARSHAL_CHECKSUM
 
   #
   # Open the specified filename (either in read-only mode or in
@@ -615,23 +637,26 @@ class PStore
   # All exceptions are propagated.
   #
   def open_and_lock_file(filename, read_only)
-    if read_only
-      begin
-        file = File.new(filename, **RD_ACCESS)
+    filename = File.path(filename)
+    loop do
+      if read_only
         begin
-          file.flock(File::LOCK_SH)
-          return file
-        rescue
-          file.close
-          raise
+          file = File.new(filename, mode: RD_ACCESS | @nofollow, encoding: Encoding::ASCII_8BIT)
+        rescue Errno::ENOENT
+          return nil
         end
-      rescue Errno::ENOENT
-        return nil
+      else
+        file = File.new(filename, mode: RDWR_ACCESS | @nofollow, encoding: Encoding::ASCII_8BIT)
+      end
+      current = false
+      begin
+        file.flock(read_only ? File::LOCK_SH : File::LOCK_EX)
+        # An atomic save may have replaced the file while this lock was pending.
+        current = File.identical?(file, filename)
+        return file if current
+      ensure
+        file.close unless current
       end
-    else
-      file = File.new(filename, **RDWR_ACCESS)
-      file.flock(File::LOCK_EX)
-      return file
     end
   end
 
@@ -645,6 +670,7 @@ class PStore
         table = load(file)
         raise Error, "PStore file seems to be corrupted." unless table.is_a?(Hash)
       rescue EOFError
+        raise unless file.size == 0
         # This seems to be a newly-created file.
         table = {}
       end
@@ -667,23 +693,16 @@ class PStore
     end
   end
 
-  def on_windows?
-    is_windows = RUBY_PLATFORM =~ /mswin|mingw|bccwin|wince/
-
-    on_windows_proc = Proc.new do
-      is_windows
-    end
-    Ractor.make_shareable(on_windows_proc) if defined?(Ractor)
-    self.class.__send__(:define_method, :on_windows?, &on_windows_proc) 
-    is_windows
-  end
+  ON_WINDOWS = true & (/mswin|mingw|bccwin|wince/ =~ RUBY_PLATFORM) # :nodoc:
+  private_constant :ON_WINDOWS
 
   def save_data(original_checksum, original_file_size, file)
     new_data = dump(@table)
 
     if new_data.bytesize != original_file_size || CHECKSUM_ALGO.digest(new_data) != original_checksum
-      if @ultra_safe && !on_windows?
-        # Windows doesn't support atomic file renames.
+      if @ultra_safe && !ON_WINDOWS
+        # Once a file is locked, Windows does not guarantee that the
+        # lock will be released until the file is closed.
         save_data_with_atomic_file_rename_strategy(new_data, file)
       else
         save_data_with_fast_strategy(new_data, file)
@@ -695,13 +714,14 @@ class PStore
 
   def save_data_with_atomic_file_rename_strategy(data, file)
     temp_filename = "#{@filename}.tmp.#{Process.pid}.#{rand 1000000}"
-    temp_file = File.new(temp_filename, **WR_ACCESS)
+    temp_file = File.new(temp_filename, mode: WR_ACCESS | @nofollow, encoding: Encoding::ASCII_8BIT, perm: 0o000)
     begin
       temp_file.flock(File::LOCK_EX)
       temp_file.write(data)
       temp_file.flush
+      temp_file.chmod(file.stat.mode)
       File.rename(temp_filename, @filename)
-    rescue
+    rescue Exception
       File.unlink(temp_file) rescue nil
       raise
     ensure

data/pstore.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/ruby/pstore"
   spec.licenses      = ["Ruby", "BSD-2-Clause"]
+  spec.required_ruby_version = ">= 2.4"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/ruby/pstore"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pstore
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yukihiro Matsumoto
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Transactional File Storage for Ruby Objects
 email:
@@ -17,7 +16,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".document"
 - ".github/dependabot.yml"
+- ".github/release.yml"
 - ".github/workflows/push_gem.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
@@ -37,7 +38,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ruby/pstore
   source_code_uri: https://github.com/ruby/pstore
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -45,15 +45,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Transactional File Storage for Ruby Objects
 test_files: []