pstore 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 581505ed1677d161bfeab6b72527336b3593726a2ef3e354155e944c0189bf8b
-  data.tar.gz: 29a99aead3e82f72c1bbcf821a39dbba0601f58d93cbc8649d6d522da938e8c0
+  metadata.gz: be4c744cb12983612ebef3ae585d25571252869cfef51a8799a0c3328be339c8
+  data.tar.gz: 9527c38bdea78cfee23874de9ecfdfee3ce9beefb541bd6e26abfa3ba55e3a3c
 SHA512:
-  metadata.gz: 2713ed297961e320cc23a3ae9659f233bff05769878312f0516dbdd207dac8bcd6f979ca082717ba5ca65dd7b39c129149b7bcb269b39e243dac4294270353b2
-  data.tar.gz: f3833ca460fe0406a9bb1d21c8b19dfd515a0b5706aa91cfc4114b2f62696962cbad1773b8bfe62701a24321d77aa15d0e96aabbbf91586ca82284dd5d412a84
+  metadata.gz: 7fa202004bbd5761b8a457fda173f69d2b0574d1b995ef3e2800c2881213719fb6e9cacd4d0cccfb29b0864c28f149a0520b4102f0172ecfccf7ae277367d023
+  data.tar.gz: b2724f28ea0ede1bac0675f77bc00665771b88b6e946da3dfd00ab0e946adef9589a350bcce05732c4568b867714b98fc7133810083a5af60ee62fdd67936efc

data/.github/release.yml

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

data/.github/workflows/push_gem.yml

@@ -23,11 +23,11 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
+        uses: step-security/harden-runner@ccd8616d44fd3846e67624a50d5aad6d37bf2d25 # v2.22.1
         with:
           egress-policy: audit
 
-      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@d5126b9b3579e429dd52e51e68624dda2e05be25 # v1.267.0
@@ -36,7 +36,7 @@ jobs:
           ruby-version: ruby
 
       - name: Publish to RubyGems
-        uses: rubygems/release-gem@1c162a739e8b4cb21a676e97b087e8268d8fc40b # v1.1.2
+        uses: rubygems/release-gem@7f9650160c1a4e7989fdc9855807bdbd421d8b6b # v1.4.1
 
       - name: Create GitHub release
         run: |

data/.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
           - { os: windows-latest, ruby: mswin }
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/lib/pstore.rb

@@ -327,12 +327,13 @@ require "digest"
 #
 class PStore
   # :stopdoc:
-  VERSION = "0.2.1"
+  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
-  private_constant :RDWR_ACCESS, :RD_ACCESS, :WR_ACCESS
+  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.
@@ -367,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)
@@ -380,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
@@ -439,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
@@ -527,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
@@ -538,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.
@@ -570,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
 
@@ -583,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
@@ -621,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
 
@@ -651,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
@@ -694,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pstore
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Yukihiro Matsumoto
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - ".document"
 - ".github/dependabot.yml"
+- ".github/release.yml"
 - ".github/workflows/push_gem.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
@@ -44,7 +45,7 @@ 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:
   - - ">="