sugar_utils 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6893030c35b766b001e15f46081e8b274cb24d7
-  data.tar.gz: e0efa641f67326d5a55187a0c39956b8f14886fd
+  metadata.gz: 36772577f62b9ff9bf97a43c288103e1b653f580
+  data.tar.gz: '089ef8678c5b4bd1c3dd82bd2c31dd5a9cde3f72'
 SHA512:
-  metadata.gz: c25a5a72766c3afdddf497b339586464391411c8513c2522e49f5dc965ef2fe17cf7c5f5e56390c28d95999d8a284b755c1022c215403d69ad049746097548ad
-  data.tar.gz: 93e7052909f52e6780a04b8ddc01456ee927e55effaf0340fcf2432fa8a7828223cb62bf131e509f5ae78408877d62d2b413c6e0633610d10399aef8717eb437
+  metadata.gz: 27010891b94741f46f21632a5b335115d65534745bf374a3a9d78d9c8125a2b355d0b8b8d5dd9cca2ee9eaf6fcab75f11d7efa73bd332ea6a85aae7dddd4aba4
+  data.tar.gz: 694e4ffec92625ef4154ab9cbfb71ed795c7816ecd090e09f866608a358911dee1c69d98fbdb66aa2f17fd2be6c08f6a1acc0dbb34d6cdd56c4cdf84db4099c6

data/.gitignore

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

data/.rspec

@@ -1,2 +1 @@
---format documentation
 --color

data/.rubocop.yml

@@ -2,13 +2,9 @@ Documentation:
   Enabled: false
 
 Metrics/LineLength:
-  Max: 90
-
-Metrics/MethodLength:
-  Max: 20
-
-Metrics/AbcSize:
-  Max: 19
+  Max: 150
+  Include:
+    - 'spec/**/*'
 
 # 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.

data/.travis.yml

@@ -3,12 +3,20 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
-  - 2.3.3
-  - 2.4.0
+  - 2.3
+  - 2.4
   - ruby-head
 matrix:
   allow_failures:
     - rvm: ruby-head
+  exclude:
+    - rvm: 2.4
+      os: osx
+    - rvm: ruby-head
+      os: osx
+os:
+  - linux
+  - osx
 sudo: false
 addons:
   code_climate:

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.4.3] - 2017-08-25
+### Added
+- option to scrub character encoding in SugarUtils::File.read
+- option to set mtime in SugarUtils::File.touch
+
 ## [0.4.2] - 2017-08-01
 ### Changed
 - default file creation permissions from 666 to 644.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sugar_utils.gemspec

data/Rakefile

@@ -1,4 +1,5 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
+# frozen_string_literal: true
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
@@ -25,4 +26,4 @@ end
 
 task quality: %i[rubocop yardstick_measure]
 
-task default: [:spec]
+task default: %i[spec]

data/lib/sugar_utils.rb

@@ -1,4 +1,5 @@
-# -*- encoding : utf-8 -*-
+# encoding : utf-8
+# frozen_string_literal: true
 
 require 'sugar_utils/version'
 require 'sugar_utils/file'

data/lib/sugar_utils/file.rb

@@ -1,4 +1,5 @@
-# -*- encoding : utf-8 -*-
+# encoding : utf-8
+# frozen_string_literal: true
 
 require 'solid_assert'
 require 'fileutils'
@@ -39,17 +40,40 @@ module SugarUtils
     # @option options [Boolean] :raise_on_missing (true)
     # @option options [String] :value_on_missing ('') which specifies the
     #   value to return if the file is missing and raise_on_missing is false
+    # @option options [Boolean, String] :scrub_encoding scrub incorrectly
+    #   encoded characters with this value, or with '' if the value is true
     #
     # @raise [SugarUtils::File::Error]
     #
     # @return [String]
-    def self.read(filename, options = {})
+    def self.read(filename, options = {}) # rubocop:disable MethodLength, AbcSize, CyclomaticComplexity, PerceivedComplexity
       options[:value_on_missing] ||= ''
       options[:raise_on_missing] = true if options[:raise_on_missing].nil?
 
-      ::File.open(filename, ::File::RDONLY) do |file|
-        flock_shared(file, options)
-        file.read
+      result =
+        ::File.open(filename, ::File::RDONLY) do |file|
+          flock_shared(file, options)
+          file.read
+        end
+
+      return result unless options[:scrub_encoding]
+
+      replacement_character =
+        if options[:scrub_encoding].is_a?(String)
+          options[:scrub_encoding]
+        else
+          ''
+        end
+      if result.respond_to?(:scrub)
+        result.scrub(replacement_character)
+      else
+        result.encode(
+          result.encoding,
+          'binary',
+          invalid: :replace,
+          undef:   :replace,
+          replace: replacement_character
+        )
       end
     rescue SystemCallError, IOError
       raise(Error, "Cannot read #{filename}") if options[:raise_on_missing]
@@ -79,17 +103,19 @@ module SugarUtils
     # @option options [String, Integer] :group
     # @option options [Integer] :mode
     # @option options [Integer] :perm @deprecated
+    # @option options [Integer] :mtime
     #
     # @return [void]
     def self.touch(filename, options = {})
-      owner = options[:owner]
-      group = options[:group]
-      mode  = options[:mode] || options[:perm]
+      owner         = options[:owner]
+      group         = options[:group]
+      mode          = options[:mode] || options[:perm]
+      touch_options = options.select { |k| %i[mtime].include?(k) }
 
-      deprecate_option(:touch, :perm, :mode, 2017, 8) if options.has_key?(:perm)
+      deprecate_option(:touch, :perm, :mode, 2017, 8) if options.key?(:perm)
 
       FileUtils.mkdir_p(::File.dirname(filename))
-      FileUtils.touch(filename)
+      FileUtils.touch(filename, touch_options)
       FileUtils.chown(owner, group, filename)
       FileUtils.chmod(mode, filename) if mode
     end
@@ -107,13 +133,13 @@ module SugarUtils
     # @raise [SugarUtils::File::Error]
     #
     # @return [void]
-    def self.write(filename, data, options = {})
+    def self.write(filename, data, options = {}) # rubocop:disable MethodLength, AbcSize, CyclomaticComplexity
       flush = options[:flush] || false
       owner = options[:owner]
       group = options[:group]
       mode  = options[:mode] || options[:perm] || 0o644
 
-      deprecate_option(:touch, :perm, :mode, 2017, 8) if options.has_key?(:perm)
+      deprecate_option(:touch, :perm, :mode, 2017, 8) if options.key?(:perm)
 
       FileUtils.mkdir_p(::File.dirname(filename))
       ::File.open(filename, ::File::RDWR | ::File::CREAT, mode) do |file|
@@ -160,23 +186,23 @@ module SugarUtils
     # Following the same pattern as the existing stdlib method deprecation
     # module.
     # @see http://ruby-doc.org/stdlib-2.0.0/libdoc/rubygems/rdoc/Gem/Deprecate.html
-    def self.deprecate_option(_method, option_name, option_repl, year, month)
+    def self.deprecate_option(_method, option_name, option_repl, year, month) # rubocop:disable MethodLength, AbcSize
       return if Gem::Deprecate.skip
 
-      klass  = self.is_a?(Module)
+      klass  = is_a?(Module)
       target = klass ? "#{self}." : "#{self.class}#"
 
       # Determine the method
-      method = caller_locations(1,1).first.label
+      method = caller_locations(1, 1).first.label
 
       # Determine the caller
-      external_caller             = caller_locations(2,1).first
+      external_caller             = caller_locations(2, 1).first
       location_of_external_caller = "#{external_caller.absolute_path}:#{external_caller.lineno}"
 
       msg = [
         "NOTE: #{target}#{method} option :#{option_name} is deprecated",
         option_repl == :none ? ' with no replacement' : "; use :#{option_repl} instead",
-        ". It will be removed on or after %4d-%02d-01." % [year, month],
+        format('. It will be removed on or after %4d-%02d-01.', year, month),
         "\n#{target}#{method} called from #{location_of_external_caller}"
       ]
       warn("#{msg.join}.")

data/lib/sugar_utils/version.rb

@@ -1,5 +1,6 @@
-# -*- encoding : utf-8 -*-
+# encoding: utf-8
+# frozen_string_literal: true
 
 module SugarUtils
-  VERSION = '0.4.2'.freeze
+  VERSION = '0.4.3'
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
-# -*- encoding : utf-8 -*-
+# encoding : utf-8
+# frozen_string_literal: true
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'sugar_utils'
@@ -72,3 +73,13 @@ RSpec::Matchers.define :have_group do |expected|
     values_match?(@expected, @actual)
   end
 end
+
+RSpec::Matchers.define :have_mtime do |expected|
+  match do |actual|
+    next false unless File.exist?(actual)
+
+    @actual   = File.stat(actual).mtime
+    @expected = expected
+    values_match?(@expected, @actual)
+  end
+end

data/spec/sugar_utils/file_spec.rb

@@ -1,4 +1,5 @@
-# -*- encoding : utf-8 -*-
+# encoding : utf-8
+# frozen_string_literal: true
 
 require 'spec_helper'
 
@@ -35,7 +36,6 @@ describe SugarUtils::File do
     subject { described_class.read('filename', options) }
 
     shared_examples_for 'handles the missing file error' do
-      # rubocop:disable Metrics/LineLength
       inputs           :options
       raise_error_with Hash[],                                                described_class::Error
       raise_error_with Hash[],                                                'Cannot read filename'
@@ -43,7 +43,6 @@ describe SugarUtils::File do
       raise_error_with Hash[raise_on_missing: true],                          'Cannot read filename'
       it_with          Hash[raise_on_missing: false],                         ''
       it_with          Hash[raise_on_missing: false, value_on_missing: 'hi'], 'hi'
-      # rubocop:enable all
     end
 
     context 'missing file' do
@@ -56,10 +55,10 @@ describe SugarUtils::File do
     end
 
     context 'file present' do
-      let(:options) { { key: :value } }
-      before { write('filename', 'content') }
+      before { write('filename', "foo\x92bar") }
 
       context 'and locked' do
+        let(:options) { { key: :value } }
         before do
           expect(described_class).to receive(:flock_shared)
             .with(kind_of(File), options)
@@ -69,11 +68,19 @@ describe SugarUtils::File do
       end
 
       context 'and unlocked' do
+        let(:options) { { key: :value, scrub_encoding: scrub_encoding } }
         before do
           expect(described_class).to receive(:flock_shared)
             .with(kind_of(File), options)
         end
-        it { is_expected.to eq('content') }
+
+        inputs  :scrub_encoding
+        it_with nil,            "foo\x92bar"
+        it_with false,          "foo\x92bar"
+        it_with true,           'foobar'
+        it_with '',             'foobar'
+        it_with 'x',            'fooxbar'
+        it_with 'xxx',          'fooxxxbar'
       end
     end
   end
@@ -104,16 +111,18 @@ describe SugarUtils::File do
 
     before { subject }
 
-    inputs       :options
+    inputs       :options # rubocop:disable ExtraSpacing, SpaceBeforeFirstArg
     specify_with([])                     { expect(File.exist?(filename)).to eq(true) }
     specify_with([{ owner: 'nobody' }])  { expect(filename).to have_owner('nobody') }
     specify_with([{ group: 'nogroup' }]) { expect(filename).to have_group('nogroup') }
     specify_with([{ mode: 0o600 }])      { expect(filename).to have_file_permission(0o100600) }
     specify_with([{ perm: 0o600 }])      { expect(filename).to have_file_permission(0o100600) }
-    specify_with([{ owner: 'nobody', group: 'nogroup', mode: 0o600 }]) do
+    specify_with([{ mtime: 0 }])         { expect(filename).to have_mtime(0) }
+    specify_with([{ owner: 'nobody', group: 'nogroup', mode: 0o600, mtime: 0 }]) do
       expect(filename).to have_owner('nobody')
       expect(filename).to have_group('nogroup')
       expect(filename).to have_file_permission(0o100600)
+      expect(filename).to have_mtime(0)
     end
   end
 
@@ -167,7 +176,7 @@ describe SugarUtils::File do
           specify { expect(filename).to have_file_permission(0o100600) }
         end
 
-        context 'with deprecated options' do
+        context 'without deprecated options' do
           let(:options) do
             { flush: true, owner: 'nobody', group: 'nogroup', mode: 0o600 }
           end

data/spec/sugar_utils_spec.rb

@@ -1,4 +1,5 @@
-# -*- encoding : utf-8 -*-
+# encoding : utf-8
+# frozen_string_literal: true
 
 require 'spec_helper'
 

data/sugar_utils.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugar_utils
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Andrew Sullivan Cant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2017-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -223,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Utility methods extracted from SugarCRM Ruby projects.