file_writer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2588f97b8687bc26c9afeca413f56f999395819d
+  data.tar.gz: 006a58d139ca8df5df541410f5a4a5585a25f25e
+SHA512:
+  metadata.gz: 7f73385192dda8c81de9137a83b152ef416bea28c5af36db1ad0246270075669b83d55ad7df1bd7ad328a8d458ff1c43559037c540b3d74d1b6b4768ec680bf1
+  data.tar.gz: 2c83f38db05c09d4222c2da8947b6e28d9d6fd96b7baf4dfa80633d43792f28c384bc733f4c2fdd9e759b346ee91b95473037d2df52c42abfca67db1d657d55e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in file_writer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Vidar Hokstad
+
+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,78 @@
+# FileWriter
+
+The simplistic way to overwrite a file with new content is to
+simply open and truncate the file and write to it, but that risks
+data-loss in the case of a power loss or write error.
+
+The goal of FileWriter is to package up the best practice in the
+one specific use-case of replacing a file entirely with new
+content.
+
+It should at a minimum:
+
+ * maintain permissions of the overwritten file.
+ * keep a Unix-style backup file (original filename +"~")
+ * use `rename` to create the backup file if possible.
+ * call `fsync` to ensure durability
+ * raise an exception if an unexpected number of bytes gets written
+ * leave the backup intact if overwriting the file fails.
+
+See the rspec specs for specifics.
+
+In the future, the intent is to replicate more of the options
+provided by emacs (see [the emacs manual](https://www.gnu.org/software/emacs/manual/html_node/emacs/Saving.html) )
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'file_writer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install file_writer
+
+## Usage
+
+```
+   FileWriter.new(filename).write(contents)
+```
+
+or 
+
+```
+   FileWriter.write(filename,contents)
+```
+
+
+## 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 tags, 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/vhokstad/file_writer.
+
+
+## License
+
+The gem is available as open source under the terms of
+the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "file_writer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/file_writer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'file_writer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "file_writer"
+  spec.version       = FileWriter::VERSION
+  spec.authors       = ["Vidar Hokstad"]
+  spec.email         = ["vidar@hokstad.com"]
+
+  spec.summary       = "Overwrite/replace files in a safe way with backups"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/vidarh/file_writer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  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 "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/file_writer.rb

@@ -0,0 +1,49 @@
+require "file_writer/version"
+require "fileutils"
+
+#
+# Overwrite files safely
+#
+class FileWriter
+  # The filename of the file to overwrite
+  attr_reader :fname
+
+  # Create new FileWriter
+  #
+  # @param String fname The name of he file to overwrite
+  def initialize(fname)
+    @fname = fname
+  end
+
+  # Overwrite the file
+  #
+  # @param String contents The new contents for the file.
+  #
+  def write(contents)
+    backup = fname + "~"
+    mode   = File.stat(fname).mode
+
+    begin
+      File.rename(fname, backup)
+    rescue SystemCallError
+      FileUtils.cp(fname,fname+"~")
+    end
+
+    File.open(fname, "wb+", mode) do |f|
+      if f.syswrite(contents) != contents.length
+        raise SystemCallError.new("FileWriter#write: syswrite returned unexpected length")
+      end
+      f.flush
+      f.fsync
+    end
+  end
+
+  # Overwrite the file
+  #
+  # @param String fname The name of the file to overwrite
+  # @param String contents The new contents for the file.
+  #
+  def self.write(fname, contents)
+    FileWriter.new(fname).write(contents)
+  end
+end

data/lib/file_writer/version.rb

@@ -0,0 +1,3 @@
+class FileWriter
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: file_writer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vidar Hokstad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Overwrite/replace files in a safe way with backups
+email:
+- vidar@hokstad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- file_writer.gemspec
+- lib/file_writer.rb
+- lib/file_writer/version.rb
+homepage: https://github.com/vidarh/file_writer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Overwrite/replace files in a safe way with backups
+test_files: []