scripto 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 682b3b4d477f4c653c2f4f28b650eeb539d7c7fd
-  data.tar.gz: 1b9e0f393c6d9666f6cb374ca2c485ca95272fc6
+SHA256:
+  metadata.gz: e0ea62ce310b383c38d173c5e3cd61b2eb4e7ea345c92f6b2f1874e7c6a3c93f
+  data.tar.gz: 0fc744955f01e99d7ee44f53b927d1a93ca6d46e35a7e1b9baf36f62e9939711
 SHA512:
-  metadata.gz: 2780520e158ddcf2843a38361c1fd64a9d041c7c215901ad6fe95e5932c43acca75fbda8bf2af8bb6c3928b795e41edf46e2ef3e7cd913d758558d7d8428bcd2
-  data.tar.gz: de8a0e1eb329fddfe4ff9e86efc65ecbaacc2765c6bbaed3877492b5e58f97b5f89af5d9d5f719fd4743a5171c9c31632c52b2fc63311b460f692bcfb50f5f32
+  metadata.gz: fee85c4a32b32d4caf1f54aec0efac6e0634f2217154c1c6367b1c184878d08b14f9f4e035eda2d78b4157bef41d839b7044fbe230957bf81eba2df3bf451f8e
+  data.tar.gz: 7664c604a09572d1cecf1e4e7cc1d3b8845e6dfb5ff1ea1e37edf660a58007f19a17a46668786a8014a71f36c373e6eff7b8f811abe5d3b3f14dd854cb068e8f

data/.gitignore

@@ -1,14 +1,15 @@
-*.gem
-*.rbc
+_yardoc
 .bundle
 .config
+.ruby-version
 .vagrant
 .yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
+*.gem
+*.rbc
 coverage
 doc/
+Gemfile.lock
+InstalledFiles
 lib/bundler/man
 pkg
 rdoc

data/.travis.yml

@@ -1,7 +1,9 @@
 language: ruby
+before_install:
+  - gem install bundler
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
   - 2.3.0
   - 2.4.0
+  - 2.5.0
+  - 2.6.0
+  - 2.7.0

data/README.md

@@ -1,11 +1,13 @@
 # Scripto
 
+[![Build Status](https://travis-ci.org/gurgeous/scripto.svg?branch=master)](https://travis-ci.org/gurgeous/scripto)
+
 Scripto is a framework for writing command line applications. It fills in many of the blanks that Ruby's standard library is missing:
 
-* **print to $stderr** - Colored banners and a verbose mode to make your scripts louder.
-* **file operations** - Mkdir, cp, mv, ln. These operations can take care of common edge cases, like creating the target directory before copying a file.
-* **run commands** - Run external commands and raise errors on failure.
-* **csv** - Read and write CSV files from hashes, Structs, or OpenStructs.
+- **print to \$stderr** - Colored banners and a verbose mode to make your scripts louder.
+- **file operations** - Mkdir, cp, mv, ln. These operations can take care of common edge cases, like creating the target directory before copying a file.
+- **run commands** - Run external commands and raise errors on failure.
+- **csv** - Read and write CSV files from hashes, Structs, or OpenStructs.
 
 Rdoc at [rdoc.info](http://rdoc.info/github/gurgeous/scripto/). Thanks!
 
@@ -65,7 +67,7 @@ Install.new(verbose: true)
 
 ## Methods
 
-### Print to $stderr
+### Print to \$stderr
 
 ```
 banner(str)  - print a banner in green
@@ -151,3 +153,10 @@ md5_string(str)    - calculate md5 for a string
 prompt?(question)  - ask the user a question, return true if they say yes
 random_string(len) - calculate a random alphanumeric string
 ```
+
+# Changelog
+
+0.0.4 (late 2020)
+
+- Added support for reading CSV with BOM.
+- Only support Ruby 2.3+, since we moved to modern Bundler

data/Rakefile

@@ -1,16 +1,21 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "rdoc/task"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'rubocop/rake_task'
 
 Rake::TestTask.new(:test) do |test|
-  test.libs << "test"
+  test.libs << 'test'
 end
 task default: :test
 
 RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
+  rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "scripto #{Scripto::VERSION}"
-  rdoc.main = "README.md"
-  rdoc.rdoc_files.include("lib/**/*.rb")
-  rdoc.rdoc_files.include("README.md")
-end
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('README.md')
+end
+
+RuboCop::RakeTask.new do |task|
+  task.options << '--display-cop-names'
+end

data/Vagrantfile

@@ -1,121 +1,16 @@
-# -*- mode: ruby -*-
-# vi: set ft=ruby :
-
-# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
-VAGRANTFILE_API_VERSION = "2"
-
-Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-  # All Vagrant configuration is done here. The most common configuration
-  # options are documented and commented below. For a complete reference,
-  # please see the online documentation at vagrantup.com.
-
-  # Every Vagrant virtual environment requires a box to build off of.
-  config.vm.box = "precise32"
-
-  # The url from where the 'config.vm.box' box will be fetched if it
-  # doesn't already exist on the user's system.
-  config.vm.box_url = "http://files.vagrantup.com/precise32.box"
-
-  # amd
-  config.vm.provision :shell, path: "vagrant_provision", privileged: false
-
-  # Create a forwarded port mapping which allows access to a specific port
-  # within the machine from a port on the host machine. In the example below,
-  # accessing "localhost:8080" will access port 80 on the guest machine.
-  # config.vm.network :forwarded_port, guest: 80, host: 8080
-
-  # Create a private network, which allows host-only access to the machine
-  # using a specific IP.
-  # config.vm.network :private_network, ip: "192.168.33.10"
-
-  # Create a public network, which generally matched to bridged network.
-  # Bridged networks make the machine appear as another physical device on
-  # your network.
-  # config.vm.network :public_network
-
-  # If true, then any SSH connections made will enable agent forwarding.
-  # Default value: false
-  # config.ssh.forward_agent = true
-
-  # Share an additional folder to the guest VM. The first argument is
-  # the path on the host to the actual folder. The second argument is
-  # the path on the guest to mount the folder. And the optional third
-  # argument is a set of non-required options.
-  # config.vm.synced_folder "../data", "/vagrant_data"
-
-  # Provider-specific configuration so you can fine-tune various
-  # backing providers for Vagrant. These expose provider-specific options.
-  # Example for VirtualBox:
-  #
-  # config.vm.provider :virtualbox do |vb|
-  #   # Don't boot with headless mode
-  #   vb.gui = true
-  #
-  #   # Use VBoxManage to customize the VM. For example to change memory:
-  #   vb.customize ["modifyvm", :id, "--memory", "1024"]
-  # end
-  #
-  # View the documentation for the provider you're using for more
-  # information on available options.
-
-  # Enable provisioning with Puppet stand alone.  Puppet manifests
-  # are contained in a directory path relative to this Vagrantfile.
-  # You will need to create the manifests directory and a manifest in
-  # the file precise32.pp in the manifests_path directory.
-  #
-  # An example Puppet manifest to provision the message of the day:
-  #
-  # # group { "puppet":
-  # #   ensure => "present",
-  # # }
-  # #
-  # # File { owner => 0, group => 0, mode => 0644 }
-  # #
-  # # file { '/etc/motd':
-  # #   content => "Welcome to your Vagrant-built virtual machine!
-  # #               Managed by Puppet.\n"
-  # # }
-  #
-  # config.vm.provision :puppet do |puppet|
-  #   puppet.manifests_path = "manifests"
-  #   puppet.manifest_file  = "site.pp"
-  # end
-
-  # Enable provisioning with chef solo, specifying a cookbooks path, roles
-  # path, and data_bags path (all relative to this Vagrantfile), and adding
-  # some recipes and/or roles.
-  #
-  # config.vm.provision :chef_solo do |chef|
-  #   chef.cookbooks_path = "../my-recipes/cookbooks"
-  #   chef.roles_path = "../my-recipes/roles"
-  #   chef.data_bags_path = "../my-recipes/data_bags"
-  #   chef.add_recipe "mysql"
-  #   chef.add_role "web"
-  #
-  #   # You may also specify custom JSON attributes:
-  #   chef.json = { :mysql_password => "foo" }
-  # end
-
-  # Enable provisioning with chef server, specifying the chef server URL,
-  # and the path to the validation key (relative to this Vagrantfile).
-  #
-  # The Opscode Platform uses HTTPS. Substitute your organization for
-  # ORGNAME in the URL and validation key.
-  #
-  # If you have your own Chef Server, use the appropriate URL, which may be
-  # HTTP instead of HTTPS depending on your configuration. Also change the
-  # validation key to validation.pem.
-  #
-  # config.vm.provision :chef_client do |chef|
-  #   chef.chef_server_url = "https://api.opscode.com/organizations/ORGNAME"
-  #   chef.validation_key_path = "ORGNAME-validator.pem"
-  # end
-  #
-  # If you're using the Opscode platform, your validator client is
-  # ORGNAME-validator, replacing ORGNAME with your organization name.
-  #
-  # If you have your own Chef Server, the default validation client name is
-  # chef-validator, unless you changed the configuration.
-  #
-  #   chef.validation_client_name = "ORGNAME-validator"
+Vagrant.configure('2') do |config|
+  config.vm.box = 'ubuntu/xenial64'
+  config.vm.provision 'shell', privileged: false, inline: <<-EOF
+    export DEBIAN_FRONTEND=noninteractive
+
+    # ruby 2.3
+    sudo apt-add-repository ppa:brightbox/ruby-ng
+    sudo apt-get update
+    sudo apt-get install -y ruby2.3
+    sudo gem install bundler
+
+    # Gemfile
+    cd /vagrant
+    bundle install
+  EOF
 end

data/lib/scripto.rb

@@ -1,10 +1,10 @@
-require "scripto/csv_commands"
-require "scripto/file_commands"
-require "scripto/misc_commands"
-require "scripto/print_commands"
-require "scripto/run_commands"
-require "scripto/version"
-require "scripto/main"
+require 'scripto/csv_commands'
+require 'scripto/file_commands'
+require 'scripto/misc_commands'
+require 'scripto/print_commands'
+require 'scripto/run_commands'
+require 'scripto/version'
+require 'scripto/main'
 
 module Scripto
   extend CsvCommands

data/lib/scripto/csv_commands.rb

@@ -1,17 +1,25 @@
-require "csv"
-require "zlib"
+require 'csv'
+require 'tempfile'
+require 'zlib'
 
 module Scripto
   module CsvCommands
     # Read a csv from +path+. Returns an array of Structs, using the keys from
     # the csv header row.
     def csv_read(path)
-      lines = if path =~ /\.gz$/
-        Zlib::GzipReader.open(path) do |f|
-          CSV.new(f).read
+      lines = begin
+        if path =~ /\.gz$/
+          Zlib::GzipReader.open(path) do |f|
+            CSV.new(f).read
+          end
+        else
+          encoding = 'bom|utf-8'
+          if RUBY_VERSION >= "2.6.0"
+            CSV.read(path, encoding: encoding)
+          else
+            CSV.read(path, "r:#{encoding}")
+          end
         end
-      else
-        CSV.read(path)
       end
       keys = lines.shift.map(&:to_sym)
       klass = Struct.new(*keys)
@@ -23,12 +31,8 @@ module Scripto
     # first row are used as the csv header. If +cols+ is specified, it will be
     # used as the column keys instead.
     def csv_write(path, rows, cols: nil)
-      begin
-        tmp = "/tmp/_scripto_csv.csv"
-        CSV.open(tmp, "wb") { |f| csv_write0(f, rows, cols: cols) }
-        mv(tmp, path)
-      ensure
-        rm_if_necessary(tmp)
+      atomic_write(path) do |tmp|
+        CSV.open(tmp.path, 'wb') { |f| csv_write0(f, rows, cols: cols) }
       end
     end
 
@@ -39,7 +43,7 @@ module Scripto
 
     # Returns a string containing +rows+ as a csv. Similar to csv_write.
     def csv_to_s(rows, cols: nil)
-      string = ""
+      string = ''
       f = CSV.new(StringIO.new(string))
       csv_write0(f, rows, cols: cols)
       string
@@ -60,4 +64,4 @@ module Scripto
       end
     end
   end
-end
+end

data/lib/scripto/file_commands.rb

@@ -1,5 +1,5 @@
-require "etc"
-require "fileutils"
+require 'etc'
+require 'fileutils'
 
 module Scripto
   module FileCommands
@@ -36,13 +36,11 @@ module Scripto
     # Like ln -sf +src+ +dst. The command will be printed out if
     # verbose?.
     def ln(src, dst)
-      begin
-        FileUtils.ln_sf(src, dst, verbose: verbose?)
-      rescue Errno::EEXIST => e
-        # It's a race - this can occur because ln_sf removes the old
-        # dst, then creates the symlink. Raise if they don't match.
-        raise e if !(File.symlink?(dst) && src == File.readlink(dst))
-      end
+      FileUtils.ln_sf(src, dst, verbose: verbose?)
+    rescue Errno::EEXIST => e
+      # It's a race - this can occur because ln_sf removes the old
+      # dst, then creates the symlink. Raise if they don't match.
+      raise e if !(File.symlink?(dst) && src == File.readlink(dst))
     end
 
     # Like rm -f +file+. Like all file commands, the operation will be printed
@@ -55,45 +53,43 @@ module Scripto
     # directory had to be created. This is useful with verbose?, to get an
     # exact changelog.
     def mkdir_if_necessary(dir, owner: nil, mode: nil)
-      if !(File.exist?(dir) || File.symlink?(dir))
-        mkdir(dir, owner: owner, mode: mode)
-        true
-      end
+      return if File.exist?(dir) || File.symlink?(dir)
+
+      mkdir(dir, owner: owner, mode: mode)
+      true
     end
 
     # Runs #cp, but ONLY if +dst+ doesn't exist or differs from +src+. Returns
     # true if the file had to be copied. This is useful with verbose?, to get
     # an exact changelog.
     def cp_if_necessary(src, dst, mkdir: false, owner: nil, mode: nil)
-      if !(File.exist?(dst) && FileUtils.compare_file(src, dst))
-        cp(src, dst, mkdir: mkdir, owner: owner, mode: mode)
-        true
-      end
+      return if File.exist?(dst) && FileUtils.compare_file(src, dst)
+
+      cp(src, dst, mkdir: mkdir, owner: owner, mode: mode)
+      true
     end
 
     # Runs #ln, but ONLY if +dst+ isn't a symlink or differs from +src+.
     # Returns true if the file had to be symlinked. This is useful with
     # verbose?, to get an exact changelog.
     def ln_if_necessary(src, dst)
-      ln = if !File.symlink?(dst)
-        true
-      elsif File.readlink(dst) != src
+      if File.symlink?(dst)
+        return if src == File.readlink(dst)
+
         rm(dst)
-        true
-      end
-      if ln
-        ln(src, dst)
-        true
       end
+
+      ln(src, dst)
+      true
     end
 
     # Runs #rm, but ONLY if +file+ exists. Return true if the file had to be
     # removed. This is useful with verbose?, to get an exact changelog.
     def rm_if_necessary(file)
-      if File.exist?(file)
-        rm(file)
-        true
-      end
+      return if !File.exist?(file)
+
+      rm(file)
+      true
     end
 
     # Like chown user:user file. Like all file commands, the operation will be printed
@@ -103,23 +99,24 @@ module Scripto
       @scripto_uids ||= {}
       @scripto_uids[user] ||= Etc.getpwnam(user).uid
       uid = @scripto_uids[user]
-      if File.stat(file).uid != uid
-        FileUtils.chown(uid, uid, file, verbose: verbose?)
-      end
+      return if File.stat(file).uid == uid
+
+      FileUtils.chown(uid, uid, file, verbose: verbose?)
     end
 
     # Like chmod mode file. Like all file commands, the operation will be
     # printed out if verbose?.
     def chmod(file, mode)
-      if File.stat(file).mode != mode
-        FileUtils.chmod(mode, file, verbose: verbose?)
-      end
+      return if File.stat(file).mode == mode
+
+      FileUtils.chmod(mode, file, verbose: verbose?)
     end
 
     # Like rm -rf && mkdir -p. Like all file commands, the operation will be
     # printed out if verbose?.
     def rm_and_mkdir(dir)
-      raise "don't do this" if dir == ""
+      raise "don't do this" if dir == ''
+
       FileUtils.rm_rf(dir, verbose: verbose?)
       mkdir(dir)
     end
@@ -131,5 +128,16 @@ module Scripto
       File.chmod(stat.mode, dst)
       File.utime(stat.atime, stat.mtime, dst)
     end
+
+    # Atomically write to +path+. An open temp file is yielded.
+    def atomic_write(path)
+      tmp = Tempfile.new(File.basename(path))
+      yield(tmp)
+      tmp.close
+      chmod(tmp.path, 0o644)
+      mv(tmp.path, path)
+    ensure
+      rm_if_necessary(tmp.path)
+    end
   end
-end
+end