file_writer 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b5007d923c6efea42dcf1bcd1baa5ec8025c5df79f1e91b8bbf1b8414c50342
-  data.tar.gz: 34ad34c8575345920f18c3c797cf96cfe0a4e3d912166307bc4af87e09d09e1e
+  metadata.gz: 50aeafa6cca7a75defbdc12934fd5e453d30dc3cdc6e53fa0484efab3045a6be
+  data.tar.gz: 4956aa84d50d48bd3bf71bb982e0509cfbec74126003e8c3db278b0029179834
 SHA512:
-  metadata.gz: f7d549bf34857b17560480b9f8be8936fb35ead31af0f80a5ee5c0004633119447972504073290e5419c846206e1180099f7c60d65bedd631a90a0d38412180c
-  data.tar.gz: a6d50156cfd955084dfb67f2481da2af8255a74885a7e028b6d13987afd9782e0b414e2634008710763a8086e7533aad7d0e195349299aef8944b0a633169848
+  metadata.gz: c20d348d7bb7db67efc89b2ecebafe075c99e53cc6209f9105ea58c6b7e824fca9f071c8e67b0146e3f1ce3eadd387748c431e1d02021e06269c4293d75413c9
+  data.tar.gz: 944b96bb826fd877c943a5b2d2e623c9ee3c6cab2e5664aa1d782df049597e01c14e77a9f0042a41faaa9ecfa52668eab09d0abb5dbe37653c8035d7f94e976c

data/file_writer.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/file_writer/version.rb

@@ -1,3 +1,3 @@
 class FileWriter
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/file_writer.rb

@@ -15,6 +15,8 @@ class FileWriter
     @fname = fname
   end
 
+  SPLIT_SIZE = 65536
+
   # Overwrite the file
   #
   # @param String contents The new contents for the file.
@@ -25,19 +27,43 @@ class FileWriter
     existing = File.exists?(fname)
 
     if existing
-      mode   = File.stat(fname).mode
+      fmode   = File.stat(fname).mode
       begin
         File.rename(fname, backup)
       rescue SystemCallError
         FileUtils.cp(fname,fname+"~")
       end
     else
-      mode = nil
+      fmode = nil
     end
 
-    File.open(fname, "wb+", mode) do |f|
-      if f.syswrite(contents) != contents.bytesize
-        raise SystemCallError.new("FileWriter#write: syswrite returned unexpected length")
+    File.open(fname, "wb+", fmode) do |f|
+      size    = contents.bytesize
+
+      #
+      #We do this rather than f.write or f.syswrite as it
+      # gives substantially better latency in a threaded
+      # environment as of MRI 2.7.2 than a single write,
+      # at the cost of throughput
+      #
+      # See tests/latency.rb for a test case, and try
+      # replacing the below with
+      #
+      # ```
+      #     written = File.write(contents)
+      # ```
+      #
+      written = 0
+      while (size - written) > SPLIT_SIZE
+        if (w = f.write(contents[written .. (written+SPLIT_SIZE-1)])) != SPLIT_SIZE
+          raise SystemCallError.new("FileWriter#write: write returned unexpected length (#{w.inspect})")
+        end
+        written += w
+      end
+      written += f.write(contents[written .. -1])
+
+      if written != size
+        raise SystemCallError.new("FileWriter#write: write returned unexpected length")
       end
       f.flush
       f.fsync

data/tests/latency.rb

@@ -0,0 +1,33 @@
+#
+# To test latency on writing large chunks of data in one go
+#
+
+$: << "../lib"
+
+require 'benchmark'
+require 'file_writer'
+
+data = " " * (16_777_216*100 + 42)
+t1 = Thread.new do
+  loop do
+    FileWriter.write("./test", data)
+  end
+end
+
+accum = []
+t2 = Thread.new do
+  loop do
+    b = Benchmark.measure do
+      100000.times do
+        " "*1024
+      end
+    end
+    accum << b.total
+    break if accum.length > 1000
+  end
+
+  p accum.sum / accum.size
+end
+
+t1.join
+t2.join

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: file_writer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Vidar Hokstad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-31 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +71,7 @@ files:
 - file_writer.gemspec
 - lib/file_writer.rb
 - lib/file_writer/version.rb
+- tests/latency.rb
 homepage: https://github.com/vidarh/file_writer
 licenses:
 - MIT
@@ -90,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Overwrite/replace files in a safe way with backups