planck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b15bc70b57a5cb6c992a3d81533cb493502f4232e0253bc039bb784295d4931a
+  data.tar.gz: 409c60c794182379d8d2189320e69d712824b3edd317c4050bda3cd5fed21c72
+SHA512:
+  metadata.gz: 01f9661af3f537f8d26833d7a1696f76966b896c4a019fb7595573f9a714f5ef6a6bf3bd623611b73aae8bf10111942e3a27810b472ef0414458d96989a74a97
+  data.tar.gz: 9a5c1f995ad2969842ad731dfe9cb4c659f2d782de49de71bccdf1dc858851b55fa493a67ce98dea315637a17c115fab083ce6f57f7ec8602445d2cd9df3127b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-19
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Matheus Richard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Planck
+
+Atomic file writes for Ruby.
+
+## Why?
+
+A naive file write:
+
+```ruby
+File.write("secrets.json", json)
+```
+
+is **not atomic**. If your process crashes midway, or if another process reads the file while it’s being written, you can end up with truncated or corrupted data.
+
+`Planck.atomic_write` solves this. It
+
+1. Writes the data to a hidden tempfile in the same directory.
+2. Flushes (`fsync`) to ensure the contents are on disk.
+3. Renames the tempfile into place (`rename` is atomic on POSIX).
+4. Flushes the parent directory entry (`fsync` again) to make the rename durable even in the event of a power loss.
+
+As a result, readers always see either the old file or the fully written new one — never an in-between state.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add planck
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install planck
+```
+
+## Usage
+
+```ruby
+require "planck"
+
+# Safely replace or create a file with 0600 permissions by default
+Planck.atomic_write("secrets.json", '{"token":"abc123"}')
+
+# Preserve existing file permissions (mode) when overwriting
+Planck.atomic_write("config.yml", "new settings", preserve_mode: true)
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thoughtbot/planck.
+
+## License
+
+Open source templates are Copyright (c) thoughtbot, inc. It contains free
+software that may be redistributed under the terms specified in the
+[LICENSE](https://github.com/thoughtbot/planck/blob/main/LICENSE.txt)
+file.
+
+## Code of Conduct
+
+Everyone interacting in the DataCustoms project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/thoughtbot/planck/blob/main/CODE_OF_CONDUCT.md).
+
+<!-- START /templates/footer.md -->
+
+## About thoughtbot
+
+![thoughtbot](https://thoughtbot.com/thoughtbot-logo-for-readmes.svg)
+
+This repo is maintained and funded by thoughtbot, inc. The names and logos for
+thoughtbot are trademarks of thoughtbot, inc.
+
+We love open source software! See [our other projects][community]. We are
+[available for hire][hire].
+
+[community]: https://thoughtbot.com/community?utm_source=github&utm_medium=readme&utm_campaign=planck
+[hire]: https://thoughtbot.com/hire-us?utm_source=github&utm_medium=readme&utm_campaign=planck

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task build: :spec

data/lib/planck/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Planck
+  VERSION = "0.1.0"
+end

data/lib/planck.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "tempfile"
+
+module Planck
+  def self.atomic_write(path, contents, preserve_mode: false)
+    dir = File.dirname(path)
+    stat = (preserve_mode && File.exist?(path)) ? File.stat(path) : nil
+
+    Tempfile.open(".#{File.basename(path)}", dir) do |tmp|
+      tmp.write(contents)
+      tmp.flush
+      tmp.fsync
+      tmp.close
+
+      if stat
+        begin
+          File.chmod(stat.mode, tmp.path)
+        rescue Errno::EPERM, Errno::EACCES
+          # If we lack privileges, proceed without preserving.
+        end
+      end
+
+      File.rename(tmp.path, path)
+      File.open(dir, File::RDONLY) { |d| d.fsync }
+    end
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: planck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matheus Richard
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Planck provides atomic file writes for Ruby. When you call
+  `Planck.atomic_write`, your file is either fully replaced or not touched at
+  all — never left in a half-written state."
+email:
+- matheusrichardt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/planck.rb
+- lib/planck/version.rb
+homepage: https://github.com/thoughtbot/planck
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/thoughtbot/planck
+  source_code_uri: https://github.com/thoughtbot/planck
+  changelog_uri: https://github.com/thoughtbot/planck/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Atomic file writes for Ruby
+test_files: []