sugar_utils 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f9d52c1492ed959f2b33c945732bf36188e6fc1
-  data.tar.gz: b68e7a45954e73eeac4cfe214c5aec54e4602fd2
+  metadata.gz: b7c411a9357b3eaec0a69621f5d90158e73cb529
+  data.tar.gz: 89c32ae0e47afda5f96e893497779a9c50faf183
 SHA512:
-  metadata.gz: cdf2c594969a6c7c0b5279032c18a40b4ce4b6c2b27e86cd814e4f7aa15ded81d661d63890795c5414e27907eb2a4d95c903a22ce3f76803b2f63b41e55bd60b
-  data.tar.gz: 5434657b56c88ee11296ff25d9ee00e43207050da6345f6df4e34717edcb8fbe7bb7dcc492c1cad326cd85efd9fae02f37fe4fd71a7dfffe7162ed9930b5b96e
+  metadata.gz: 5dd4e7190bacaf4eb839da4cc06395c0533b5f21e77e548d634466eb6f2c1aa17e6d38c5578850bbc2e2c93a678ec3626e65b8de2e68e5ae8ebf05866d8e4185
+  data.tar.gz: baf241f695e61396cfd8eaff4ccedca6a8e2c4771a9668d39930fa1c967e0d2bc3a7b055cf167bfa4820d5a6b86ed1b1fb3a132bfa56675b269e6897acdbcabd

data/.rubocop.yml

@@ -1,3 +1,8 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.2
+
 Documentation:
   Enabled: false
 
@@ -6,8 +11,19 @@ Metrics/LineLength:
   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

data/.travis.yml

@@ -1,22 +1,39 @@
 language: ruby
 rvm:
-  - 2.0
-  - 2.1
   - 2.2
   - 2.3
-  - 2.4
-  - 2.5
+  - 2.4.5
+  - 2.5.4
+  - 2.6.2
   - ruby-head
+  - jruby
 matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: 2.0
+  exclude:
+    - rvm: jruby
       os: osx
-    - rvm: 2.4
+    - rvm: ruby-head
       os: osx
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby
 os:
   - linux
   - osx
 sudo: false
-after_success:
-  - bundle exec codeclimate-test-reporter
+cache:
+  bundler: true
+before_script:
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-darwin-amd64 > ./cc-test-reporter ; fi
+  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter ; fi
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+# HACK: Continue to use bundler <2 because of Ruby v2.2 support. Once the
+# lowest dependency is Ruby v2.3 we can consider upgrading to Bundler 2.x.
+# @see https://docs.travis-ci.com/user/languages/ruby/#bundler-20
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
+

data/CHANGELOG.md

@@ -6,6 +6,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [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,7 +1,6 @@
 # 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)
 [![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)
@@ -14,12 +13,16 @@ 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
+* SugarUtils::File.append
 
 These methods will probably be included in the future:
 
@@ -59,6 +62,12 @@ $ gem install sugar_utils
 
 See [CONTRIBUTING](CONTRIBUTING.md) for how you can contribute changes back into this project.
 
-## Acknowledgments
+## Contributors
 
-Copyright 2016 [SugarCRM Inc.](http://sugarcrm.com), released under the Apache2 License.
+* [Andrew Sullivan Cant](https://github.com/acant)
+* [Robert Lockstone](https://github.com/lockstone)
+* [Vadim Kazakov](https://github.com/yads)
+
+## Acknowledgements
+
+Copyright 2019 [SugarCRM Inc.](http://sugarcrm.com), released under the Apache2 License.

data/Rakefile

@@ -1,18 +1,47 @@
-# 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|
+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 +53,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/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"