sugar_utils 0.5.0 → 0.7.0

data/lib/sugar_utils.rb

@@ -1,19 +1,22 @@
-# encoding : utf-8
 # frozen_string_literal: true
 
 require 'sugar_utils/version'
 require 'sugar_utils/file'
 
+# @api
 module SugarUtils
-  # @param [Object] value
+  # @param value [Object]
   #
   # @return [Boolean]
   def self.ensure_boolean(value)
-    return false if value.respond_to?(:to_s) && value.to_s.casecmp('false').zero?
+    return false if value == 0 # rubocop:disable Style/NumericPredicate
+
+    return false if value.respond_to?(:to_s) && value.to_s.strip.casecmp('false').zero?
+
     value ? true : false
   end
 
-  # @param [String, Float, Integer] value
+  # @param value [String, Float, Integer]
   #
   # @raise [ArgumentError] if the value is a string which cannot be converted
   # @raise [TypeError] if value is type which cannot be converted
@@ -22,6 +25,33 @@ module SugarUtils
   def self.ensure_integer(value)
     return value      if value.is_a?(Integer)
     return value.to_i if value.is_a?(Float)
+
     Float(value).to_i
   end
+
+  # @overload scrub_encoding(data)
+  #   Scrub the string's encoding, and replace any bad characters with ''.
+  #   @param data [String]
+  # @overload scrub_encoding(data, replacement_character)
+  #   Scrub the string's encoding, and replace any bad characters with the
+  #   specified character.
+  #   @param data [String]
+  #   @param replacement_character [String]
+  #
+  # @return [String]
+  def self.scrub_encoding(data, replacement_character = nil)
+    replacement_character = '' unless replacement_character.is_a?(String)
+
+    # If the Ruby version being used supports String#scrub, then just use it.
+    return data.scrub(replacement_character) if data.respond_to?(:scrub)
+
+    # Otherwise, fall back to String#encode.
+    data.encode(
+      data.encoding,
+      'binary',
+      invalid: :replace,
+      undef:   :replace,
+      replace: replacement_character
+    )
+  end
 end

data/spec/spec_helper.rb

@@ -1,10 +1,9 @@
-# encoding : utf-8
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'sugar_utils'
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'rspec/tabular'
 require 'fakefs/spec_helpers'
+require 'rspec/side_effects'
 require 'etc'
 # HACK: including pp seems to resolve an error with FakeFS and File.read
 # This seems to be related to but not the same as the problem mentioned in the
@@ -16,6 +15,9 @@ require 'pp'
 require 'simplecov'
 SimpleCov.start
 
+require 'sugar_utils'
+MultiJson.use(:ok_json)
+
 SolidAssert.enable_assertions
 
 RSpec.configure do |config|
@@ -48,8 +50,8 @@ RSpec::Matchers.define :have_file_permission do |expected|
   match do |actual|
     next false unless File.exist?(actual)
 
-    @actual   = format('%o', File.stat(actual).mode)
-    @expected = format('%o', expected)
+    @actual   = format('%<mode>o', mode: File.stat(actual).mode)
+    @expected = format('%<mode>o', mode: expected)
     values_match?(@expected, @actual)
   end
 end
@@ -78,7 +80,7 @@ RSpec::Matchers.define :have_mtime do |expected|
   match do |actual|
     next false unless File.exist?(actual)
 
-    @actual   = File.stat(actual).mtime
+    @actual   = File.stat(actual).mtime.to_i
     @expected = expected
     values_match?(@expected, @actual)
   end

data/spec/sugar_utils/file/write_options_spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SugarUtils::File::WriteOptions do
+  subject(:write_options) { described_class.new(filename, options) }
+
+  let(:filename) { nil }
+
+  before do
+    allow(File).to receive(:exist?).with('missing').and_return(false)
+    allow(File).to receive(:exist?).with('found').and_return(true)
+    allow(File::Stat).to receive(:new).with('found').and_return(
+      instance_double(File::Stat, uid: :uid, gid: :gid)
+    )
+  end
+
+  describe '#flush?' do
+    subject { write_options.flush? }
+
+    inputs  :options
+    it_with Hash[],              false
+    it_with Hash[flush: :flush], :flush
+  end
+
+  describe '#perm' do
+    subject { write_options.perm(*args) }
+
+    inputs  :options, :args
+    it_with Hash[],                         [],                0o644
+    it_with Hash[],                         %i[default_value], :default_value
+    it_with Hash[mode: :mode],              [],                :mode
+    it_with Hash[mode: :mode],              %i[default_value], :mode
+    it_with Hash[perm: :perm, mode: :mode], [],                :mode
+    it_with Hash[perm: :perm, mode: :mode], %i[default_value], :mode
+    it_with Hash[perm: :perm],              [],                :perm
+    it_with Hash[perm: :perm],              %i[default_value], :perm
+  end
+
+  describe '#owner' do
+    subject { write_options.owner }
+
+    inputs  :filename, :options
+    it_with nil,       Hash[],              nil
+    it_with 'missing', Hash[],              nil
+    it_with 'found',   Hash[],              :uid
+    it_with nil,       Hash[owner: :owner], :owner
+    it_with 'missing', Hash[owner: :owner], :owner
+    it_with 'found',   Hash[owner: :owner], :owner
+  end
+
+  describe '#group' do
+    subject { write_options.group }
+
+    inputs  :filename, :options
+    it_with nil,       Hash[],              nil
+    it_with 'missing', Hash[],              nil
+    it_with 'found',   Hash[],              :gid
+    it_with nil,       Hash[group: :group], :group
+    it_with 'missing', Hash[group: :group], :group
+    it_with 'found',   Hash[group: :group], :group
+  end
+
+  describe '#slice' do
+    subject { write_options.slice(*args) }
+
+    let(:options) { { key1: :value1, key2: :value2, key3: :value3 } }
+
+    inputs  :args
+    it_with [],                        Hash[]
+    it_with %i[key1],                  Hash[key1: :value1]
+    it_with %i[key2],                  Hash[key2: :value2]
+    it_with %i[key3],                  Hash[key3: :value3]
+    it_with %i[key1 key3],             Hash[key1: :value1, key3: :value3]
+    it_with [%i[key1], nil, %i[key3]], Hash[key1: :value1, key3: :value3]
+  end
+end