scripto 0.0.3 → 0.0.4

data/lib/scripto/main.rb

@@ -15,4 +15,4 @@ module Scripto
       self.verbose = options[:verbose]
     end
   end
-end
+end

data/lib/scripto/misc_commands.rb

@@ -1,9 +1,9 @@
-require "digest/md5"
-require "etc"
+require 'digest/md5'
+require 'etc'
 
 module Scripto
   module MiscCommands
-    BASE_62 = ("0".."9").to_a + ("A".."Z").to_a + ("a".."z").to_a
+    BASE_62 = ('0'..'9').to_a + ('A'..'Z').to_a + ('a'..'z').to_a
 
     # Who is the current user?
     def whoami
@@ -12,16 +12,14 @@ module Scripto
 
     # Return true if the current user is "root".
     def root?
-      whoami == "root"
+      whoami == 'root'
     end
 
     # Return the md5 checksum for the file at +path+.
     def md5_file(path)
       File.open(path) do |f|
-        digest, buf = Digest::MD5.new, ""
-        while f.read(4096, buf)
-          digest.update(buf)
-        end
+        digest, buf = Digest::MD5.new, ''
+        digest.update(buf) while f.read(4096, buf)
         digest.hexdigest
       end
     end
@@ -44,4 +42,4 @@ module Scripto
       (1..len).map { BASE_62.sample }.join
     end
   end
-end
+end

data/lib/scripto/print_commands.rb

@@ -1,9 +1,9 @@
 module Scripto
   module PrintCommands
-    RESET   = "\e[0m"
-    GREEN   = "\e[1;37;42m"
-    YELLOW  = "\e[1;37;43m"
-    RED     = "\e[1;37;41m"
+    RESET   = "\e[0m".freeze
+    GREEN   = "\e[1;37;42m".freeze
+    YELLOW  = "\e[1;37;43m".freeze
+    RED     = "\e[1;37;41m".freeze
 
     attr_accessor :verbose
 
@@ -35,8 +35,8 @@ module Scripto
 
     # Print a colored banner to $stderr in green.
     def banner(str, color: GREEN)
-      now = Time.new.strftime("%H:%M:%S")
-      s = "#{str} ".ljust(72, " ")
+      now = Time.new.strftime('%H:%M:%S')
+      s = "#{str} ".ljust(72, ' ')
       $stderr.puts "#{color}[#{now}] #{s}#{RESET}"
     end
 
@@ -51,4 +51,4 @@ module Scripto
       exit(1)
     end
   end
-end
+end

data/lib/scripto/run_commands.rb

@@ -1,5 +1,5 @@
-require "English"
-require "shellwords"
+require 'English'
+require 'shellwords'
 
 module Scripto
   module RunCommands
@@ -34,12 +34,10 @@ module Scripto
 
     # Returns true if the command succeeds. See #run for details.
     def run_succeeds?(command, args = nil)
-      begin
-        run_quietly(command, args)
-        true
-      rescue Error
-        false
-      end
+      run_quietly(command, args)
+      true
+    rescue Error
+      false
     end
 
     # Returns true if the command fails. See #run for details.
@@ -52,18 +50,18 @@ module Scripto
       Shellwords.escape(str)
     end
 
-    protected
-
     # :nodoc:
     class CommandLine
       attr_accessor :command, :args
 
       def initialize(command, args)
         self.command = command
-        self.args = if args
-          args.map(&:to_s)
-        else
-          [ ]
+        self.args = begin
+          if args
+            args.map(&:to_s)
+          else
+            []
+          end
         end
       end
 
@@ -74,7 +72,7 @@ module Scripto
 
       def capture
         begin
-          captured = `#{to_s}`
+          captured = `#{self}`
         rescue Errno::ENOENT
           raise Error, "#{self} failed : ENOENT (No such file or directory)"
         end
@@ -83,20 +81,21 @@ module Scripto
       end
 
       def raise!(status)
-        if status.termsig == Signal.list["INT"]
+        if status.termsig == Signal.list['INT']
           raise "#{self} interrupted"
         end
+
         raise Error, "#{self} failed : #{status.to_i / 256}"
       end
 
       def to_s
-        if args.length > 0
+        if !args.empty?
           escaped = args.map { |i| Shellwords.escape(i) }
-          "#{command} #{escaped.join(" ")}"
+          "#{command} #{escaped.join(' ')}"
         else
           command
         end
       end
     end
   end
-end
+end

data/lib/scripto/version.rb

@@ -1,4 +1,4 @@
 module Scripto
   # current Scripto version
-  VERSION = "0.0.3"
+  VERSION = '0.0.4'.freeze
 end

data/scripto.gemspec

@@ -1,25 +1,25 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'scripto/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "scripto"
+  spec.name          = 'scripto'
   spec.version       = Scripto::VERSION
   spec.platform      = Gem::Platform::RUBY
-  spec.required_ruby_version = ">= 2.0.0"
-  spec.authors       = ["Adam Doppelt"]
-  spec.email         = ["amd@gurge.com"]
-  spec.summary       = "Helpers for writing command line scripts. An extraction from Dwellable."
-  spec.homepage      = "http://github.com/gurgeous/scripto"
-  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.authors       = [ 'Adam Doppelt' ]
+  spec.email         = [ 'amd@gurge.com' ]
+  spec.summary       = 'Helpers for writing command line scripts. An extraction from Dwellable.'
+  spec.homepage      = 'http://github.com/gurgeous/scripto'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = [ 'lib' ]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
 end

data/test/helper.rb

@@ -1,12 +1,12 @@
-require "fileutils"
-require "minitest/autorun"
-require "minitest/pride"
+require 'fileutils'
+require 'minitest/autorun'
+require 'minitest/pride'
 
-$LOAD_PATH << File.expand_path("../../lib", __FILE__)
-require "scripto"
+$LOAD_PATH << File.expand_path('../lib', __dir__)
+require 'scripto'
 
 module Helper
-  TMP_DIR = "/tmp/_scripto_test"
+  TMP_DIR = '/tmp/_scripto_test'.freeze
 
   # attr_accessor :main
 
@@ -23,4 +23,4 @@ module Helper
     FileUtils.rm_rf(TMP_DIR)
     Dir.chdir(@pwd)
   end
-end
+end

data/test/test_csv.rb

@@ -1,13 +1,13 @@
-require_relative "helper"
+require_relative 'helper'
 
 class TestCsv < Minitest::Test
   include Helper
 
-  FILE = "test.csv"
+  FILE = 'test.csv'.freeze
 
-  ROWS = [ { a: "1", b: "2", c: "3" }, { a: "4", b: "5", c: "6" } ]
-  ROWS_EXP = "a,b,c\n1,2,3\n4,5,6\n"
-  ROWS_REVERSED_EXP = "c,b,a\n3,2,1\n6,5,4\n"
+  ROWS = [ { a: '1', b: '2', c: '3' }, { a: '4', b: '5', c: '6' } ].freeze
+  ROWS_EXP = "a,b,c\n1,2,3\n4,5,6\n".freeze
+  ROWS_REVERSED_EXP = "c,b,a\n3,2,1\n6,5,4\n".freeze
 
   def test_types
     assert_equal(ROWS_EXP, Scripto.csv_to_s(ROWS))
@@ -16,9 +16,9 @@ class TestCsv < Minitest::Test
   end
 
   def test_cols
-    assert_equal(ROWS_REVERSED_EXP, Scripto.csv_to_s(ROWS,     cols: %i(c b a)))
-    assert_equal(ROWS_REVERSED_EXP, Scripto.csv_to_s(structs,  cols: %i(c b a)))
-    assert_equal(ROWS_REVERSED_EXP, Scripto.csv_to_s(ostructs, cols: %i(c b a)))
+    assert_equal(ROWS_REVERSED_EXP, Scripto.csv_to_s(ROWS,     cols: %i[c b a]))
+    assert_equal(ROWS_REVERSED_EXP, Scripto.csv_to_s(structs,  cols: %i[c b a]))
+    assert_equal(ROWS_REVERSED_EXP, Scripto.csv_to_s(ostructs, cols: %i[c b a]))
   end
 
   def test_csv_stdout
@@ -37,14 +37,15 @@ class TestCsv < Minitest::Test
     assert_equal(ROWS, Scripto.csv_read("#{FILE}.gz").map(&:to_h))
   end
 
-  def test_atomic
-    magic = "can't touch this"
-    File.write(FILE, magic)
-    begin
-      Util.csv_write(TMP, rows, cols: %i(bad_column))
-    rescue
-    end
-    assert_equal(magic, File.read(FILE))
+  def test_bom
+    assert_equal('apple', Scripto.csv_read(write_bom).first.fruit)
+  end
+
+  def test_gz_with_bom
+    skip # this doesn't work yet
+    path = write_bom
+    Scripto.run("gzip #{path}")
+    assert_equal('apple', Scripto.csv_read("#{path}.gz").first.fruit)
   end
 
   protected
@@ -57,4 +58,13 @@ class TestCsv < Minitest::Test
   def ostructs
     ROWS.map { |i| OpenStruct.new(i) }
   end
-end
+
+  def write_bom
+    CSV.open(FILE, 'w') do |csv|
+      csv.to_io.write "\uFEFF" # bom
+      csv << %w[fruit]
+      csv << %w[apple]
+    end
+    FILE
+  end
+end

data/test/test_file.rb

@@ -1,16 +1,16 @@
-require_relative "helper"
+require_relative 'helper'
 
 class TestFile < Minitest::Test
   include Helper
 
-  DIR = "dir"
-  SRC, DST = "src.txt", "dst.txt"
-  SRC2, DST2 = "src2.txt", "dst2.txt"
+  DIR = 'dir'.freeze
+  SRC, DST = 'src.txt', 'dst.txt'
+  SRC2, DST2 = 'src2.txt', 'dst2.txt'
 
   def setup
     super
-    File.write(SRC, "something")
-    File.write(SRC2, "another thing")
+    File.write(SRC, 'something')
+    File.write(SRC2, 'another thing')
   end
 
   #
@@ -23,8 +23,8 @@ class TestFile < Minitest::Test
   end
 
   def test_mkdir_mode
-    Scripto.mkdir(DIR, mode: 0644)
-    assert_equal(0644, File.stat(DIR).mode & 0644)
+    Scripto.mkdir(DIR, mode: 0o644)
+    assert_equal(0o644, File.stat(DIR).mode & 0o644)
   end
 
   def test_cp
@@ -33,8 +33,8 @@ class TestFile < Minitest::Test
   end
 
   def test_cp_mode
-    Scripto.cp(SRC, DST, mode: 0644)
-    assert_equal(0644, File.stat(DST).mode & 0644)
+    Scripto.cp(SRC, DST, mode: 0o644)
+    assert_equal(0o644, File.stat(DST).mode & 0o644)
   end
 
   def test_cp_mkdir
@@ -45,13 +45,13 @@ class TestFile < Minitest::Test
 
   def test_mv
     Scripto.mv(SRC, DST)
-    assert_equal("something", File.read(DST))
+    assert_equal('something', File.read(DST))
   end
 
   def test_mv_mkdir
     in_dir = "#{DIR}/in_dir"
     Scripto.mv(SRC, in_dir, mkdir: true)
-    assert_equal("something", File.read(in_dir))
+    assert_equal('something', File.read(in_dir))
   end
 
   def test_ln
@@ -62,7 +62,7 @@ class TestFile < Minitest::Test
   def test_rm
     Scripto.rm(SRC)
     assert(!File.exist?(SRC))
-    Scripto.rm("this_file_doesnt_exist") # shouldn't complain
+    Scripto.rm('this_file_doesnt_exist') # shouldn't complain
   end
 
   #
@@ -80,7 +80,7 @@ class TestFile < Minitest::Test
     assert_equal(SRC, File.readlink(DST2))
 
     # should be silent
-    assert_fu_output(nil, "") do
+    assert_fu_output(nil, '') do
       assert_nil Scripto.mkdir_if_necessary(DIR)
       assert_nil Scripto.cp_if_necessary(SRC, DST)
       assert_nil Scripto.ln_if_necessary(SRC, DST2)
@@ -88,7 +88,7 @@ class TestFile < Minitest::Test
   end
 
   def test_cp_if_necessary_differs
-    File.write(DST, "this is different")
+    File.write(DST, 'this is different')
     assert_fu_output(nil, "cp -rp #{SRC} #{DST}\n") do
       assert Scripto.cp_if_necessary(SRC, DST)
     end
@@ -103,23 +103,23 @@ class TestFile < Minitest::Test
   end
 
   def test_chmod
-    Scripto.chmod(SRC, 0644)
-    assert_equal(0644, File.stat(SRC).mode & 0644)
+    Scripto.chmod(SRC, 0o644)
+    assert_equal(0o644, File.stat(SRC).mode & 0o644)
   end
 
   def test_rm_and_mkdir
     Dir.mkdir(DIR)
-    File.write("#{DIR}/file", "this is a test")
+    File.write("#{DIR}/file", 'this is a test')
     assert Dir["#{DIR}/*"].length == 1
     Scripto.rm_and_mkdir(DIR)
-    assert Dir["#{DIR}/*"].length == 0
+    assert Dir["#{DIR}/*"].empty?
   end
 
   def test_copy_metadata
-    File.chmod(0644, SRC)
+    File.chmod(0o644, SRC)
     File.utime(1234, 5678, SRC)
     Scripto.copy_metadata(SRC, SRC2)
-    assert_equal(0644, File.stat(SRC2).mode & 0644)
+    assert_equal(0o644, File.stat(SRC2).mode & 0o644)
     assert_equal(1234, File.stat(SRC2).atime.to_i)
     assert_equal(5678, File.stat(SRC2).mtime.to_i)
   end
@@ -130,20 +130,40 @@ class TestFile < Minitest::Test
 
   def test_mkdir_owner
     skip if !root?
-    Scripto.mkdir(DIR, owner: "nobody")
-    assert(Etc.getpwnam("nobody").uid, File.stat(DIR).uid)
+    Scripto.mkdir(DIR, owner: 'nobody')
+    assert(Etc.getpwnam('nobody').uid, File.stat(DIR).uid)
   end
 
   def test_cp_owner
     skip if !root?
-    Scripto.cp(SRC, DST, owner: "nobody")
-    assert(Etc.getpwnam("nobody").uid, File.stat(DST).uid)
+    Scripto.cp(SRC, DST, owner: 'nobody')
+    assert(Etc.getpwnam('nobody').uid, File.stat(DST).uid)
   end
 
   def test_chown
     skip if !root?
-    Scripto.chown(SRC, "nobody")
-    assert(Etc.getpwnam("nobody").uid, File.stat(SRC).uid)
+    Scripto.chown(SRC, 'nobody')
+    assert(Etc.getpwnam('nobody').uid, File.stat(SRC).uid)
+  end
+
+  #
+  # atomic
+  #
+
+  def test_atomic
+    Scripto.atomic_write(SRC) { |f| f.write('xyzzy') }
+    assert_equal 'xyzzy', File.read(SRC)
+  end
+
+  def test_atomic_fail
+    assert_raises do
+      Scripto.atomic_write(SRC) do |f|
+        f.write('xyzzy')
+        raise 'uh oh'
+      end
+    end
+    # SRC should be unscathed
+    assert_equal 'something', File.read(SRC)
   end
 
   #
@@ -184,17 +204,17 @@ class TestFile < Minitest::Test
 
   def root?
     if !defined?(@root)
-      @root = `whoami`.strip == "root"
+      @root = `whoami`.strip == 'root'
     end
     @root
   end
 
-  def assert_fu_output(stdout = nil, stderr = nil, &block)
+  def assert_fu_output(stdout = nil, stderr = nil)
     Scripto.verbose!
     assert_output(stdout, stderr) do
       # FileUtils squirrels this away so we have to set it manually
-      FileUtils.instance_eval("@fileutils_output = $stderr")
+      FileUtils.instance_eval('@fileutils_output = $stderr')
       yield
     end
   end
-end
+end