sugar_utils 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1742a971ec43f0580b8a66eb40a6068f0bd70a5
-  data.tar.gz: 35a2e24ceb3eeac3109f9e9d300c20ea7a59ffe6
+  metadata.gz: 6e0e229f79ac2862d3410a0af00c9193c63e95bc
+  data.tar.gz: db296249a7db975a57b0931ae02bd2f5f3e7339c
 SHA512:
-  metadata.gz: 82dd25fd3f8de787bf325343a948f44bc6f539d65b5b29f2476ae3f24fe235422159129184998cafc0505597a215e69d47a725e17e60ed8f40068de84090f4e6
-  data.tar.gz: 95b3f9228923c4aad53fb11d4d7a42a31b8ac832480aac4dc338f6859006f596765e9e8f5f853b053d83cb58afed9e19f2d6f68e682692b323f005deff94499a
+  metadata.gz: 12f986da3764bc8c2ef501a0f93eed04309f0a8d1063de8595a82af448e2d02fbe7ba89ebbcbd0e970a5e51af232e77366d3dc9827d8c260693dbf6a1599a2de
+  data.tar.gz: 24f18068100970ee7eff0fcf0d63d1aa8ab50dbf130e0f608d3367ca52f7a896a7d7a45e5b5f129ee6af712783eaac4d96c792eefb96715e949a7f96422f3ff3

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.4.1] - 2017-05-17
+### Added
+- options :owner, :group, :mode to SugarUtils::File.write and .touch
+
+### Changed
+- marked the :perm option as deprecated by :mode
+
 ## [0.4.0] - 2017-05-17
 ### Added
 - SugarUtils::File.touch, which will ensure the directory before touching the

data/lib/sugar_utils/file.rb

@@ -74,11 +74,24 @@ module SugarUtils
     end
 
     # @param [String] filename
+    # @param [Hash] options
+    # @option options [String, Integer] :owner
+    # @option options [String, Integer] :group
+    # @option options [Integer] :mode
+    # @option options [Integer] :perm @deprecated
     #
     # @return [void]
-    def self.touch(filename)
+    def self.touch(filename, options = {})
+      owner = options[:owner]
+      group = options[:group]
+      mode  = options[:mode] || options[:perm]
+
+      deprecate_option(:touch, :perm, :mode, 2017, 8) if options.has_key?(:perm)
+
       FileUtils.mkdir_p(::File.dirname(filename))
       FileUtils.touch(filename)
+      FileUtils.chown(owner, group, filename)
+      FileUtils.chmod(mode, filename) if mode
     end
 
     # @param [String] filename
@@ -86,17 +99,24 @@ module SugarUtils
     # @param [Hash] options
     # @option options [Integer] :timeout (10)
     # @option options [Boolean] :flush (false)
-    # @option options [Integer] :perm (0666)
+    # @option options [String, Integer] :owner
+    # @option options [String, Integer] :group
+    # @option options [Integer] :mode (0o666)
+    # @option options [Integer] :perm (0o666) @deprecated
     #
     # @raise [SugarUtils::File::Error]
     #
     # @return [void]
     def self.write(filename, data, options = {})
-      perm  = options[:perm] || 0o666
       flush = options[:flush] || false
+      owner = options[:owner]
+      group = options[:group]
+      mode  = options[:mode] || options[:perm] || 0o666
+
+      deprecate_option(:touch, :perm, :mode, 2017, 8) if options.has_key?(:perm)
 
       FileUtils.mkdir_p(::File.dirname(filename))
-      ::File.open(filename, ::File::RDWR | ::File::CREAT, perm) do |file|
+      ::File.open(filename, ::File::RDWR | ::File::CREAT, mode) do |file|
         flock_exclusive(file, options)
 
         file.truncate(0) # Ensure file is empty before proceeding.
@@ -112,8 +132,9 @@ module SugarUtils
         end
 
         # Ensure that the permissions are correct if the file already existed.
-        file.chmod(perm)
+        file.chmod(mode)
       end
+      FileUtils.chown(owner, group, filename)
     rescue Timeout::Error
       raise(Error, "Unable to write #{filename} because it is locked")
     rescue SystemCallError, IOError => boom
@@ -133,5 +154,33 @@ module SugarUtils
     def self.write_json(filename, data, options = {})
       write(filename, MultiJson.dump(data, pretty: true), options)
     end
+
+    ############################################################################
+
+    # 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)
+      return if Gem::Deprecate.skip
+
+      klass  = self.is_a?(Module)
+      target = klass ? "#{self}." : "#{self.class}#"
+
+      # Determine the method
+      method = caller_locations(1,1).first.label
+
+      # Determine the caller
+      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],
+        "\n#{target}#{method} called from #{location_of_external_caller}"
+      ]
+      warn("#{msg.join}.")
+    end
+    private_class_method :deprecate_option
   end
 end

data/lib/sugar_utils/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 
 module SugarUtils
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.1'.freeze
 end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'sugar_utils'
 require 'rspec/tabular'
 require 'fakefs/spec_helpers'
+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
 # README
@@ -46,8 +47,28 @@ RSpec::Matchers.define :have_file_permission do |expected|
   match do |actual|
     next false unless File.exist?(actual)
 
-    @actual   = format('%o', File.stat(filename).mode)
+    @actual   = format('%o', File.stat(actual).mode)
     @expected = format('%o', expected)
     values_match?(@expected, @actual)
   end
 end
+
+RSpec::Matchers.define :have_owner do |expected|
+  match do |actual|
+    next false unless File.exist?(actual)
+
+    @actual   = Etc.getpwuid(File.stat(filename).uid).name
+    @expected = expected
+    values_match?(@expected, @actual)
+  end
+end
+
+RSpec::Matchers.define :have_group do |expected|
+  match do |actual|
+    next false unless File.exist?(actual)
+
+    @actual   = Etc.getgrgid(File.stat(actual).gid).name
+    @expected = expected
+    values_match?(@expected, @actual)
+  end
+end

data/spec/sugar_utils/file_spec.rb

@@ -98,23 +98,22 @@ describe SugarUtils::File do
   end
 
   describe '.touch', :fakefs do
-    subject { described_class.touch(filename) }
+    subject { described_class.touch(filename, *options) }
 
-    before { subject }
-
-    context 'without path' do
-      let(:filename) { 'filename' }
-      it { expect(File.exist?(filename)).to eq(true) }
-    end
+    let(:filename) { 'path1/path2/filename' }
 
-    context 'with path' do
-      let(:filename) { 'path1/path2/filename' }
-      it { expect(File.exist?(filename)).to eq(true) }
-    end
+    before { subject }
 
-    context 'with absolute path' do
-      let(:filename) { '/path1/path2/filename' }
-      it { expect(File.exist?(filename)).to eq(true) }
+    inputs       :options
+    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
+      expect(filename).to have_owner('nobody')
+      expect(filename).to have_group('nogroup')
+      expect(filename).to have_file_permission(0o100600)
     end
   end
 
@@ -161,14 +160,25 @@ describe SugarUtils::File do
           specify { expect(filename).to have_file_permission(0o100666) }
         end
 
-        context 'options' do
-          let(:options) { { flush: true, perm: 0o600 } }
+        context 'with deprecated options' do
+          let(:options) { { perm: 0o600 } }
+          before { subject }
+          specify { expect(filename).to have_content(data) }
+          specify { expect(filename).to have_file_permission(0o100600) }
+        end
+
+        context 'with deprecated options' do
+          let(:options) do
+            { flush: true, owner: 'nobody', group: 'nogroup', mode: 0o600 }
+          end
           before do
             expect_any_instance_of(File).to receive(:flush)
             expect_any_instance_of(File).to receive(:fsync)
             subject
           end
           specify { expect(filename).to have_content(data) }
+          specify { expect(filename).to have_owner('nobody') }
+          specify { expect(filename).to have_group('nogroup') }
           specify { expect(filename).to have_file_permission(0o100600) }
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sugar_utils
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Andrew Sullivan Cant