sugar_utils 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8f9d52c1492ed959f2b33c945732bf36188e6fc1
-  data.tar.gz: b68e7a45954e73eeac4cfe214c5aec54e4602fd2
+SHA256:
+  metadata.gz: a82e583baf8090370611445ae00050bf247d2687d947d84d98fbbac7f8cd1cbe
+  data.tar.gz: 134411bdbc2a675dfc799d73a6d25d5dc0d8760bd8bc3a0583611a7cd1cb50a4
 SHA512:
-  metadata.gz: cdf2c594969a6c7c0b5279032c18a40b4ce4b6c2b27e86cd814e4f7aa15ded81d661d63890795c5414e27907eb2a4d95c903a22ce3f76803b2f63b41e55bd60b
-  data.tar.gz: 5434657b56c88ee11296ff25d9ee00e43207050da6345f6df4e34717edcb8fbe7bb7dcc492c1cad326cd85efd9fae02f37fe4fd71a7dfffe7162ed9930b5b96e
+  metadata.gz: 3fe928e0ec9a19db849034a7691cd44231282f7dbb58dba921d50f62f3403f9f2abf6fdb9c576182c4abc22b50498aee871a3faa7f82879aabe14678cc831845
+  data.tar.gz: d54adcfcaf340cbbf81fb40bd520c772e80c825b3dc02788d0c70fb608f58abf66d84811e163e830968b13cee3e1b6789c6096df24c02ef297fd6fa3fe147e83

data/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+on: [push]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ['2.6', '2.7', '3.0', '3.1', '3.2', head]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake

data/.gitignore

@@ -7,4 +7,3 @@
 /pkg/
 /spec/reports/
 /tmp/
-.ruby-version

data/.rubocop.yml

@@ -1,13 +1,40 @@
-Documentation:
-  Enabled: false
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
 
-Metrics/LineLength:
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle:      table
+
+Layout/LineLength:
   Max: 150
   Include:
     - 'spec/**/*'
 
+RSpec/EmptyExampleGroup:
+  Enabled: false
+
 # Because of the way that blocks are used in RSpecs can end up being long when
 # example groups are nested or many examples are checked.
+# A similar pattern exists in the DSL for gemspec files.
 Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/EmptyLineAfterExample:
+  Enabled: false
+
+# NOTE: The rspec-tabular commands get confused with the default syntax is used
+# for Hashes, so disabling this check for specs so that `Hash[]` can be used.
+Style/HashConversion:
   Exclude:
     - 'spec/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+2.6.2

data/CHANGELOG.md

@@ -6,6 +6,29 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.7.0] - 2022-10-07
+### Changed
+- update the required ruby version from v2.2 to v2.6
+- Sugar::Utils.ensure_boolean to consider `0` to be false
+- Sugar::Utils.ensure_boolean to ignore whitespace around strings before
+  checking if they are 'false'
+
+## [0.6.0] - 2019-05-31
+### Added
+- SugarUtils::File.append, which is explicitly for appending to a file. It will
+  also create a new file if it does not yet exist
+- SugarUtils::scrub_encoding, which is used for cleaning badly encoded
+  characters out of a string
+- SugarUtils::File.change_access, a wrapper for changing ownership and
+  permissions of a file
+- SugarUtils::File.atomic_write, to atomically write a file
+### Removed
+- append support in SugarUtils::File.write (could have been specified by { mode: 'a })
+### Changed
+- :mode and :perm are now aliases for setting permissions on files in all the
+  related methods (i.e., .write, .write_json, .touch, .append)
+- convert SugarUtils::File.write_json to use .atomic_write
+
 ## [0.5.0] - 2018-05-01
 ### Changed
 - bring back :perm as option to set the permissions in SugarUtils::File.write and SugarUtils::File.touch methods

data/README.md

@@ -1,39 +1,31 @@
 # sugar_utils
 
 [![Gem Version](https://badge.fury.io/rb/sugar_utils.svg)](http://badge.fury.io/rb/sugar_utils)
-[![Dependency Status](https://gemnasium.com/sugarcrm/sugar_utils.svg)](https://gemnasium.com/sugarcrm/sugar_utils)
-[![Build Status](https://travis-ci.org/sugarcrm/sugar_utils.svg?branch=master)](https://travis-ci.org/sugarcrm/sugar_utils)
+[![Build Status](https://github.com/sugarcrm/sugar_utils/actions/workflows/ci.yml/badge.svg)](https://github.com/sugarcrm/sugar_utils/actions/workflows/ci.yml)
 [![Code Climate](https://codeclimate.com/github/sugarcrm/sugar_utils/badges/gpa.svg)](https://codeclimate.com/github/sugarcrm/sugar_utils)
 [![Test Coverage](https://codeclimate.com/github/sugarcrm/sugar_utils/badges/coverage.svg)](https://codeclimate.com/github/sugarcrm/sugar_utils/coverage)
-[![Inline docs](http://inch-ci.org/github/sugarcrm/sugar_utils.svg)](http://inch-ci.org/github/sugarcrm/sugar_utils)
 [![License](http://img.shields.io/badge/license-Apache2-green.svg?style=flat)](LICENSE)
 
+[![Inline docs](http://inch-ci.org/github/sugarcrm/sugar_utils.svg)](http://inch-ci.org/github/sugarcrm/sugar_utils)
+[![RubyDoc](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.org/gems/sugar_utils)
+[![CucumberPro](https://img.shields.io/badge/cucumber.pro-sugar_utils-3d10af.svg)](https://app.cucumber.pro/projects/sugar_utils)
+
 Utility methods extracted from SugarCRM Ruby projects.
 
 These methods are included:
 
 * SugarUtils.ensure_boolean
 * SugarUtils.ensure_integer
+* SugarUtils.scrub_encoding
 * SugarUtils::File.flock_shared
 * SugarUtils::File.flock_exclusive
+* SugarUtils::File.change_access
 * SugarUtils::File.read
 * SugarUtils::File.write
+* SugarUtils::File.atomic_write
 * SugarUtils::File.read_json
 * SugarUtils::File.write_json
-
-These methods will probably be included in the future:
-
-* sizeof_dir
-* find_files
-* find_file!
-* gzip
-* gunzip
-* tarball
-* untarball
-* tarball_list
-* encrypt
-* http_get_file
-* timeout_retry
+* SugarUtils::File.append
 
 ## Installation
 
@@ -55,10 +47,46 @@ Or install it yourself as:
 $ gem install sugar_utils
 ```
 
+## Roadmap
+
+These methods might be added in the future:
+
+* sizeof_dir
+* find_files
+* find_file!
+* gzip
+* gunzip
+* tarball
+* untarball
+* tarball_list
+* encrypt
+* http_get_file
+* timeout_retry
+
+## Elsewhere on the web
+
+Links to other places on the web where this projects exists:
+
+* [Code Climate](https://codeclimate.com/github/sugarcrm/sugar_utils)
+* [CucumberPro](https://app.cucumber.pro/projects/sugar_utils)
+* [InchCI](http://inch-ci.org/github/sugarcrm/sugar_utils)
+* [Github](https://github.com/sugarcrm/sugar_utils)
+* [OpenHub](https://www.openhub.net/p/sugar_utils)
+* [RubyDoc](http://rubydoc.org/gems/sugar_utils)
+* [RubyGems](https://rubygems.org/gems/sugar_utils)
+* [Ruby LibHunt](https://ruby.libhunt.com/sugar_utils-alternatives)
+* [Ruby Toolbox](https://www.ruby-toolbox.com/projects/sugar_utils)
+
 ## Contributing
 
 See [CONTRIBUTING](CONTRIBUTING.md) for how you can contribute changes back into this project.
 
-## Acknowledgments
+## Contributors
+
+* [Andrew Sullivan Cant](https://github.com/acant)
+* [Robert Lockstone](https://github.com/lockstone)
+* [Vadim Kazakov](https://github.com/yads)
+
+## Acknowledgements
 
-Copyright 2016 [SugarCRM Inc.](http://sugarcrm.com), released under the Apache2 License.
+Copyright 2019 [SugarCRM Inc.](http://sugarcrm.com), released under the Apache2 License.

data/Rakefile

@@ -1,18 +1,48 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'cucumber'
+require 'cucumber/rake/task'
 require 'rubocop/rake_task'
+require 'bundler/audit/task'
 require 'yard'
 require 'yardstick/rake/measurement'
-require 'fileutils'
+require 'pathname'
+require 'license_finder'
+require 'English'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |task|
+  # task.rspec_opts = '--warnings'
+end
+
+Cucumber::Rake::Task.new(:features) do |task|
+  task.cucumber_opts = '--publish-quiet'
+end
 
 RuboCop::RakeTask.new(:rubocop) do |task|
-  FileUtils.mkdir_p('tmp')
-  task.options = %w[--format progress --format simple --out tmp/rubocop.txt]
+  rubocop_report_pathname =
+    Pathname(Rake.application.original_dir).join('tmp', 'rubocop.txt')
+  rubocop_report_pathname.dirname.mkpath
+  task.options =
+    %w[
+      --display-cop-names
+      --extra-details
+      --display-style-guide
+      --fail-level error
+      --format progress
+      --format simple
+      --out
+    ].push(rubocop_report_pathname.to_s)
+end
+
+Bundler::Audit::Task.new
+
+desc 'Check dependency licenses'
+task :license_finder do
+  puts `license_finder --quiet --format text`
+
+  abort('LicenseFinder failed') unless $CHILD_STATUS.success?
 end
 
 YARD::Rake::YardocTask.new do |t|
@@ -24,6 +54,4 @@ Yardstick::Rake::Measurement.new(:yardstick_measure) do |measurement|
   measurement.output = 'tmp/yard_coverage.txt'
 end
 
-task quality: %i[rubocop yardstick_measure]
-
-task default: %i[spec]
+task default: %i[spec features rubocop yardstick_measure bundle:audit license_finder]

data/doc/dependency_decisions.yml

@@ -0,0 +1,25 @@
+---
+- - :ignore_group
+  - development
+  - :who: Andrew Sullivan Cant <mail@andrewsullivancant.ca>
+    :why: 
+    :versions: []
+    :when: 2018-06-13 15:20:17.351348000 Z
+- - :permit
+  - Apache 2.0
+  - :who: Andrew Sullivan Cant <mail@andrewsullivancant.ca>
+    :why: SugarCRM's primary approved open source license
+    :versions: []
+    :when: 2018-06-18 19:28:33.314061000 Z
+- - :permit
+  - MIT
+  - :who: Andrew Sullivan Cant <mail@andrewsullivancant.ca>
+    :why: SugarCRM's secondary approved open source license
+    :versions: []
+    :when: 2018-06-13 15:18:36.240771000 Z
+- - :permit
+  - BSD
+  - :who: Andrew Sullivan Cant <mail@andrewsullivancant.ca>
+    :why: SugarCRM's secondary approved open source license
+    :versions: []
+    :when: 2018-06-18 19:29:15.003697000 Z

data/features/append_file.feature

@@ -0,0 +1,46 @@
+Feature: Append to a file
+
+Scenario: Append a missing file
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    SugarUtils::File.append('dir/test', 'foobar')
+    """
+  Then the file named "dir/test" should contain exactly:
+    """
+    foobar
+    """
+
+Scenario: Append an existing file
+  Given a file named "dir/test" with "foobar"
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    SugarUtils::File.append('dir/test', 'deadbeef')
+    """
+  Then the file named "dir/test" should contain exactly:
+    """
+    foobardeadbeef
+    """
+
+# TODO: Fix the owner/group setting check
+Scenario: Append a file and reset its permissions
+  Given a file named "dir/test" with "foobar"
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    SugarUtils::File.append(
+      'dir/test',
+      'deadbeef',
+      # owner: 'nobody',
+      # group: 'nogroup',
+      mode:  0o777
+    )
+    """
+  Then the file named "dir/test" should contain exactly:
+    """
+    foobardeadbeef
+    """
+    And the file named "dir/test" should have permissions "777"
+    # And the file named "dir/test" should have owner "nobody"
+    # And the file named "dir/test" should have group "nogroup"

data/features/atomic_write_file.feature

@@ -0,0 +1,46 @@
+Feature: Write to a file atomically
+
+Scenario: Write a file atomically
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils::File.atomic_write('dir/test', 'foobar')
+    """
+  Then the file named "dir/test" should contain exactly:
+    """
+    foobar
+    """
+
+Scenario: Overwrite a file atomically
+  Given a file named "dir/test" with "deadbeef"
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils::File.atomic_write('dir/test', 'foobar')
+    """
+  Then the file named "dir/test" should contain exactly:
+    """
+    foobar
+    """
+
+# TODO: Fix the owner/group setting check
+Scenario: Overwrite a file and reset its permissions atomically
+  Given a file named "dir/test" with "deadbeef"
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils::File.atomic_write(
+      'dir/test',
+      'foobar',
+      # owner: 'nobody',
+      # group: 'nogroup',
+      mode:  0o777
+    )
+    """
+  Then the file named "dir/test" should contain exactly:
+    """
+    foobar
+    """
+    And the file named "dir/test" should have permissions "777"
+    # And the file named "dir/test" should have owner "nobody"
+    # And the file named "dir/test" should have group "nogroup"

data/features/change_file_access.feature

@@ -0,0 +1,27 @@
+Feature: Change a files ownership and permissions
+
+# TODO: Fix the owner/group setting check. I need to figure out how to execute
+# these scenarios correctly across various environments.
+
+Scenario: All the values are skipped
+  Given a file named "test" with "foobar"
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    SugarUtils::File.change_access('test', nil, nil, nil)
+    """
+  # Then the file named "test" should have permissions "644"
+    # And the file named "test" should have owner "nobody"
+    # And the file named "test" should have group "nogroup"
+
+Scenario: All the values are set
+  Given a file named "test" with "foobar"
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    # SugarUtils::File.change_access('test', 'nobody', 'nogroup', 0o777)
+    SugarUtils::File.change_access('test', nil, nil, 0o777)
+    """
+  Then the file named "test" should have permissions "777"
+    # And the file named "test" should have owner "nobody"
+    # And the file named "test" should have group "nogroup"

data/features/ensure_boolean.feature

@@ -0,0 +1,34 @@
+
+Feature: Ensure the specified value is a boolean
+
+Scenario: nil is false
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils.ensure_boolean(nil)
+    """
+  Then the output should contain "false"
+
+Scenario: false is false
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils.ensure_boolean(false)
+    """
+  Then the output should contain "false"
+
+Scenario: String of 'false' is false
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils.ensure_boolean('false')
+    """
+  Then the output should contain "false"
+
+Scenario: Any other value is true
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils.ensure_boolean('value')
+    """
+  Then the output should contain "true"

data/features/ensure_integer.feature

@@ -0,0 +1,19 @@
+Feature: Ensure the specified value is an integer
+
+Scenario: Convert Floats to Integers
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils.ensure_integer(123.456)
+    """
+  Then the output should contain "123"
+
+Scenario: Convert Strings of Integers to Integers
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils.ensure_integer('123.456')
+    """
+  Then the output should contain "123"
+
+

data/features/lock_file.feature

@@ -0,0 +1,26 @@
+# TODO: Fill in this feature
+Feature: Operate locks on files
+
+Scenario: Shared lock
+  Given a file named "test" with "foobar"
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    File.open('test') do |file|
+      SugarUtils::File.flock_shared(file)
+      puts file.read
+    end
+    """
+  Then the file named "test" should contain "foobar"
+
+Scenario: Exclusive lock
+  Given a file named "test" with "foobar"
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    File.open('test') do |file|
+      SugarUtils::File.flock_exclusive(file)
+      puts file.read
+    end
+    """
+  Then the file named "test" should contain "foobar"

data/features/read_file.feature

@@ -0,0 +1,30 @@
+Feature: Read a file
+
+Scenario: Read a missing file with a default value
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils::File.read(
+      'test', value_on_missing: 'missing', raise_on_missing: false
+    )
+    """
+  Then the output should contain "missing"
+
+Scenario: Read an existing file
+  Given a file named "test" with "foobar"
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils::File.read('test')
+    """
+  Then the output should contain "foobar"
+
+Scenario: Read an existing file and scurb encoding errors
+  Given a file named "test" with "test"
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    File.write('test', %(foo\\x92bar\\x93))
+    puts SugarUtils::File.read('test', scrub_encoding: true)
+    """
+  Then the output should contain "foobar"

data/features/read_json_file.feature

@@ -0,0 +1,43 @@
+Feature: Read a file
+
+Scenario: Read a missing file with a default value
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    MultiJson.use(:ok_json)
+
+    puts SugarUtils::File.read_json('test.json', raise_on_missing: false)
+    """
+  Then the output should contain "{}"
+
+Scenario: Read an existing file
+  Given a file named "test.json" with:
+    """
+    {"key":"value"}
+    """
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    MultiJson.use(:ok_json)
+
+    puts SugarUtils::File.read_json('test.json')
+    """
+  Then the output should contain:
+    """
+    {"key"=>"value"}
+    """
+
+Scenario: Read an existing file and scurb encoding errors
+  Given a file named "test.json" with "test"
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    MultiJson.use(:ok_json)
+
+    File.write('test.json', %({\"key\":\"foo\\x92bar\\x93\"}))
+    puts SugarUtils::File.read_json('test.json', scrub_encoding: true)
+    """
+  Then the output should contain:
+    """
+    {"key"=>"foobar"}
+    """

data/features/scrub_encoding.feature

@@ -0,0 +1,25 @@
+Feature: Ensure the specified value is an integer
+
+Scenario: Pass through string without encoding errors
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils.scrub_encoding('foobar')
+    """
+  Then the output should contain "foobar"
+
+Scenario: Erase encoding errors in the string
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils.scrub_encoding(%(foo\\x92bar\\x93))
+    """
+  Then the output should contain "foobar"
+
+Scenario: Replace encoding errors in the string
+  When I run the following Ruby code:
+    """ruby
+    require 'sugar_utils'
+    puts SugarUtils.scrub_encoding(%(foo\\x92bar\\x93), 'xxx')
+    """
+  Then the output should contain "fooxxxbarxxx"

data/features/step_definitions/steps.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+When('I run the following Ruby code:') do |code|
+  run_command_and_stop %(ruby -e "#{code}")
+end
+
+# Copying the pattern for this step from the default Aruba step for checking
+# the permissions of a file.
+# @see lib/aruba/cucumber/file.rb
+Then(/^the (?:file|directory)(?: named)? "([^"]*)" should( not)? have owner "([^"]*)"$/) do |path, negated, owner|
+  if negated
+    expect(path).not_to have_owner(owner)
+  else
+    expect(path).to have_owner(owner)
+  end
+end
+
+# Copying the pattern for this step from the default Aruba step for checking
+# the permissions of a file.
+# @see lib/aruba/cucumber/file.rb
+Then(/^the (?:file|directory)(?: named)? "([^"]*)" should( not)? have group "([^"]*)"$/) do |path, negated, group|
+  if negated
+    expect(path).not_to have_group(group)
+  else
+    expect(path).to have_group(group)
+  end
+end
+
+# Copying the pattern for this step from the default Aruba step for checking
+# the permissions of a file.
+# @see lib/aruba/cucumber/file.rb
+Then(/^the (?:file|directory)(?: named)? "([^"]*)" should( not)? have modification time "([^"]*)"$/) do |path, negated, modification_time|
+  if negated
+    expect(expand_path(path)).not_to have_mtime(modification_time.to_i)
+  else
+    expect(expand_path(path)).to have_mtime(modification_time.to_i)
+  end
+end