sugar_utils 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b470d625c6383906e21070cde292ed14a90fd80e
-  data.tar.gz: 455983e1fc7a18e0d6a2eea4f9cef67ed25a2804
+  metadata.gz: 8f9d52c1492ed959f2b33c945732bf36188e6fc1
+  data.tar.gz: b68e7a45954e73eeac4cfe214c5aec54e4602fd2
 SHA512:
-  metadata.gz: cddd4ee3cabe8b6e76f93d4ac9c2be1be91d0a441d408f8234e07fddadd269d6a9ac257e527b8e9aba5203ae12d2157d40fa2107b15490968710010d413601f1
-  data.tar.gz: 01b451f98527ac178922e6c1f0f9bf6bc493fa6632cd3633d87f6a245f644e9b8a7ea577052e8b3db2942b2f8968d51f67d48a10aaa3717c9281f861d9fc0042
+  metadata.gz: cdf2c594969a6c7c0b5279032c18a40b4ce4b6c2b27e86cd814e4f7aa15ded81d661d63890795c5414e27907eb2a4d95c903a22ce3f76803b2f63b41e55bd60b
+  data.tar.gz: 5434657b56c88ee11296ff25d9ee00e43207050da6345f6df4e34717edcb8fbe7bb7dcc492c1cad326cd85efd9fae02f37fe4fd71a7dfffe7162ed9930b5b96e

data/.travis.yml

@@ -18,8 +18,5 @@ os:
   - linux
   - osx
 sudo: false
-addons:
-  code_climate:
-    repo_token: c250bc1551dd13a07efdd5bc8a594924f6f762f7be9762e79da0c8f065cf93dd
 after_success:
   - bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [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
+- :mode option in SugarUtils::File.write is now to be used for setting the file mode (e.g. read/write, append, etc). It can still be used for setting the permissions if it is an integer value for backwards compatibility purposes, but this usage has been deprecated.
+
 ## [0.4.4] - 2018-01-31
 ### Changed
 - fixed a bug in SugarUtils::File.read_json which it would raise an exception

data/lib/sugar_utils/file.rb

@@ -105,23 +105,26 @@ module SugarUtils
     # @param [Hash] options
     # @option options [String, Integer] :owner
     # @option options [String, Integer] :group
-    # @option options [Integer] :mode
-    # @option options [Integer] :perm @deprecated
+    # @option options [Integer] :mode @deprecated
+    # @option options [Integer] :perm
     # @option options [Integer] :mtime
     #
     # @return [void]
     def self.touch(filename, options = {})
       owner         = options[:owner]
       group         = options[:group]
-      mode          = options[:mode] || options[:perm]
+      perm          = options[:perm]
       touch_options = options.select { |k| %i[mtime].include?(k) }
 
-      deprecate_option(:touch, :perm, :mode, 2017, 8) if options.key?(:perm)
+      if options[:mode].is_a?(Integer)
+        perm = options[:mode]
+        deprecate_option(:touch, :mode, :perm, 2018, 7)
+      end
 
       FileUtils.mkdir_p(::File.dirname(filename))
       FileUtils.touch(filename, touch_options)
       FileUtils.chown(owner, group, filename)
-      FileUtils.chmod(mode, filename) if mode
+      FileUtils.chmod(perm, filename) if perm
     end
 
     # @param [String] filename
@@ -131,8 +134,8 @@ module SugarUtils
     # @option options [Boolean] :flush (false)
     # @option options [String, Integer] :owner
     # @option options [String, Integer] :group
-    # @option options [Integer] :mode (0o644)
-    # @option options [Integer] :perm (0o644) @deprecated
+    # @option options [String] :mode (w+)
+    # @option options [Integer] :perm (0o644)
     #
     # @raise [SugarUtils::File::Error]
     #
@@ -141,15 +144,21 @@ module SugarUtils
       flush = options[:flush] || false
       owner = options[:owner]
       group = options[:group]
-      mode  = options[:mode] || options[:perm] || 0o644
+      perm  = options[:perm] || 0o644
+      mode  = 'w+'
+
+      if options[:mode].is_a?(Integer)
+        perm = options[:mode]
 
-      deprecate_option(:touch, :perm, :mode, 2017, 8) if options.key?(:perm)
+        deprecate_option(:write, :mode, ' with an integer value; use perm instead', 2018, 7)
+      elsif !options[:mode].nil?
+        mode = options[:mode]
+      end
 
       FileUtils.mkdir_p(::File.dirname(filename))
-      ::File.open(filename, ::File::RDWR | ::File::CREAT, mode) do |file|
+      ::File.open(filename, mode, perm) do |file|
         flock_exclusive(file, options)
 
-        file.truncate(0) # Ensure file is empty before proceeding.
         file.puts(data.to_s)
 
         # Flush and fsync to be 100% sure we write this data out now because we
@@ -162,7 +171,7 @@ module SugarUtils
         end
 
         # Ensure that the permissions are correct if the file already existed.
-        file.chmod(mode)
+        file.chmod(perm)
       end
       FileUtils.chown(owner, group, filename)
     rescue Timeout::Error
@@ -205,7 +214,14 @@ module SugarUtils
 
       msg = [
         "NOTE: #{target}#{method} option :#{option_name} is deprecated",
-        option_repl == :none ? ' with no replacement' : "; use :#{option_repl} instead",
+        case option_repl
+        when :none
+          ' with no replacement' 
+        when String
+          option_repl
+        else
+          "; use :#{option_repl} instead"
+        end,
         format('. It will be removed on or after %4d-%02d-01.', year, month),
         "\n#{target}#{method} called from #{location_of_external_caller}"
       ]

data/lib/sugar_utils/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module SugarUtils
-  VERSION = '0.4.4'
+  VERSION = '0.5.0'
 end

data/spec/sugar_utils/file_spec.rb

@@ -171,7 +171,7 @@ describe SugarUtils::File do
         end
 
         context 'with deprecated options' do
-          let(:options) { { perm: 0o600 } }
+          let(:options) { { mode: 0o600 } }
           before { subject }
           specify { expect(filename).to have_content(data) }
           specify { expect(filename).to have_file_permission(0o100600) }
@@ -179,7 +179,7 @@ describe SugarUtils::File do
 
         context 'without deprecated options' do
           let(:options) do
-            { flush: true, owner: 'nobody', group: 'nogroup', mode: 0o600 }
+            { flush: true, owner: 'nobody', group: 'nogroup', mode: 'w', perm: 0o600 }
           end
           before do
             expect_any_instance_of(File).to receive(:flush)
@@ -201,6 +201,16 @@ describe SugarUtils::File do
         before { write(filename, 'foobar', 0o777) }
         context 'not locked' do
           it_behaves_like 'file is written'
+
+          context 'with append mode' do
+            let(:options) { { mode: 'a+' } }
+            before do
+              expect(described_class).to receive(:flock_exclusive)
+                .with(kind_of(File), options)
+              subject
+            end
+            specify { expect(filename).to have_content("foobar#{data}") }
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugar_utils
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrew Sullivan Cant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json