tty-file 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff0231767c10a14f731dcf153855ef3c652f0db9996e0a9588ad17b8c6bb4bdc
-  data.tar.gz: a441339b4d10b0ab58e6775d1df7471c36a475700ffdd385ad18d75c0b28459b
+  metadata.gz: 3c14d1cde8381d3b5e40e0b73139df56495bf4247abc1e5b28cfa5cfc17ed94a
+  data.tar.gz: 752eebdc5b63125700de9ed06aa8abd700ab1518a595e26b2bbaa767dadc31c4
 SHA512:
-  metadata.gz: 322c2d767842c0a315c98eb01175cb0b2ca1b32ce6a5d961ef274d67db9428c5c6b32a710c81345a6383ca92cd67862f2a3354a853f587ed00b47196eb75f664
-  data.tar.gz: 340eb4e7b495e9ed91224fd6eec7df4e4990c4ef5dd5024e08110285560bf3e1bf5dd6c33433493f145f8b5dc3f76aa60052fbca5933816dbca0569c60e2ef77
+  metadata.gz: 2625754b9f281800439fbc63eea1b978bf3711ec38eb5040e8279f3ce68de5880c8a58003f2f42b7717f86660f987aa321db128f095cef9a81360b19a020da3f
+  data.tar.gz: e87cd920b9f868ed0774d986b997e697a1351cc83916b05fd148e439b0e9fc5c24ace82d41add7c287dced567ba5ce43010cd58667f04409c3a49d1988fbf38d

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+## [v0.9.0] - 2020-04-28
+
+### Changed
+* Change #chmod custom permission implementation for built-in FileUtils one
+* Change to update tty-prompt dependency
+* Change gemspec to include metadata and stop loading test artefacts
+
+### Fixed
+* Fix Ruby 2.7 hash to keywords conversion warnings
+
 ## [v0.8.0] - 2019-07-25
 
 ### Added
@@ -96,6 +106,7 @@
 
 * Initial implementation and release
 
+[v0.9.0]: https://github.com/piotrmurach/tty-file/compare/v0.8.0...v0.9.0
 [v0.8.0]: https://github.com/piotrmurach/tty-file/compare/v0.7.1...v0.8.0
 [v0.7.1]: https://github.com/piotrmurach/tty-file/compare/v0.7.0...v0.7.1
 [v0.7.0]: https://github.com/piotrmurach/tty-file/compare/v0.6.0...v0.7.0

data/lib/tty/file.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'pastel'
-require 'erb'
-require 'tempfile'
-require 'pathname'
-
-require_relative 'file/create_file'
-require_relative 'file/digest_file'
-require_relative 'file/download_file'
-require_relative 'file/differ'
-require_relative 'file/read_backward_file'
-require_relative 'file/version'
+require "pastel"
+require "erb"
+require "tempfile"
+require "pathname"
+
+require_relative "file/create_file"
+require_relative "file/digest_file"
+require_relative "file/download_file"
+require_relative "file/differ"
+require_relative "file/read_backward_file"
+require_relative "file/version"
 
 module TTY
   module File
@@ -41,10 +41,10 @@ module TTY
     #   the path to file to check
     #
     # @example
-    #   binary?('Gemfile') # => false
+    #   binary?("Gemfile") # => false
     #
     # @example
-    #   binary?('image.jpg') # => true
+    #   binary?("image.jpg") # => true
     #
     # @return [Boolean]
     #   Returns `true` if the file is binary, `false` otherwise
@@ -103,18 +103,18 @@ module TTY
     #   No operation
     #
     # @example
-    #   checksum_file('/path/to/file')
+    #   checksum_file("/path/to/file")
     #
     # @example
-    #   checksum_file('Some string content', 'md5')
+    #   checksum_file("Some string content", "md5")
     #
     # @return [String]
     #   the generated hex value
     #
     # @api public
     def checksum_file(source, *args, **options)
-      mode     = args.size.zero? ? 'sha256' : args.pop
-      digester = DigestFile.new(source, mode, options)
+      mode     = args.size.zero? ? "sha256" : args.pop
+      digester = DigestFile.new(source, mode)
       digester.call unless options[:noop]
     end
     module_function :checksum_file
@@ -129,31 +129,19 @@ module TTY
     # @option options [Symbol] :force
     #
     # @example
-    #   chmod('Gemfile', 0755)
+    #   chmod("Gemfile", 0755)
     #
     # @example
-    #   chmod('Gemilfe', TTY::File::U_R | TTY::File::U_W)
+    #   chmod("Gemilfe", TTY::File::U_R | TTY::File::U_W)
     #
     # @example
-    #   chmod('Gemfile', 'u+x,g+x')
+    #   chmod("Gemfile", "u+x,g+x")
     #
     # @api public
     def chmod(relative_path, permissions, **options)
-      mode = ::File.lstat(relative_path).mode
-      if permissions.to_s =~ /\d+/
-        mode = permissions
-      else
-        permissions.scan(/[ugoa][+-=][rwx]+/) do |setting|
-          who, action = setting[0], setting[1]
-          setting[2..setting.size].each_byte do |perm|
-            mask = const_get("#{who.upcase}_#{perm.chr.upcase}")
-            (action == '+') ? mode |= mask : mode ^= mask
-          end
-        end
-      end
       log_status(:chmod, relative_path, options.fetch(:verbose, true),
-                                        options.fetch(:color, :green))
-      ::FileUtils.chmod_R(mode, relative_path) unless options[:noop]
+                 options.fetch(:color, :green))
+      ::FileUtils.chmod_R(permissions, relative_path) unless options[:noop]
     end
     module_function :chmod
 
@@ -163,18 +151,18 @@ module TTY
     #   the path or data structure describing directory tree
     #
     # @example
-    #   create_directory('/path/to/dir')
+    #   create_directory("/path/to/dir")
     #
     # @example
     #   tree =
-    #     'app' => [
-    #       'README.md',
-    #       ['Gemfile', "gem 'tty-file'"],
-    #       'lib' => [
-    #         'cli.rb',
-    #         ['file_utils.rb', "require 'tty-file'"]
+    #     "app" => [
+    #       "README.md",
+    #       ["Gemfile", "gem "tty-file""],
+    #       "lib" => [
+    #         "cli.rb",
+    #         ["file_utils.rb", "require "tty-file""]
     #       ]
-    #       'spec' => []
+    #       "spec" => []
     #     ]
     #
     #   create_directory(tree)
@@ -198,9 +186,9 @@ module TTY
 
         files.each do |filename, contents|
           if filename.respond_to?(:each_pair)
-            create_directory(filename, path, options)
+            create_directory(filename, path, **options)
           else
-            create_file(::File.join(path, filename), contents, options)
+            create_file(::File.join(path, filename), contents, **options)
           end
         end
       end
@@ -220,11 +208,11 @@ module TTY
     #   forces ovewrite if conflict present
     #
     # @example
-    #   create_file('doc/README.md', '# Title header')
+    #   create_file("doc/README.md", "# Title header")
     #
     # @example
-    #   create_file 'doc/README.md' do
-    #     '# Title Header'
+    #   create_file "doc/README.md" do
+    #     "# Title Header"
     #   end
     #
     # @api public
@@ -243,12 +231,12 @@ module TTY
     # destination running it through ERB.
     #
     # @example
-    #   copy_file 'templates/test.rb', 'app/test.rb'
+    #   copy_file "templates/test.rb", "app/test.rb"
     #
     # @example
     #   vars = OpenStruct.new
-    #   vars[:name] = 'foo'
-    #   copy_file 'templates/%name%.rb', 'app/%name%.rb', context: vars
+    #   vars[:name] = "foo"
+    #   copy_file "templates/%name%.rb", "app/%name%.rb", context: vars
     #
     # @param [String, Pathname] source_path
     # @param [Hash] options
@@ -265,15 +253,15 @@ module TTY
     # @api public
     def copy_file(source_path, *args, **options, &block)
       source_path = source_path.to_s
-      dest_path = (args.first || source_path).to_s.sub(/\.erb$/, '')
+      dest_path = (args.first || source_path).to_s.sub(/\.erb$/, "")
 
       ctx = if (vars = options[:context])
-              vars.instance_eval('binding')
+              vars.instance_eval("binding")
             else
-              instance_eval('binding')
+              instance_eval("binding")
             end
 
-      create_file(dest_path, options) do
+      create_file(dest_path, **options) do
         version = ERB.version.scan(/\d+\.\d+\.\d+/)[0]
         template = if version.to_f >= 2.2
                     ERB.new(::File.binread(source_path), trim_mode: "-", eoutvar: "@output_buffer")
@@ -285,7 +273,8 @@ module TTY
         content
       end
       return unless options[:preserve]
-      copy_metadata(source_path, dest_path, options)
+
+      copy_metadata(source_path, dest_path, **options)
     end
     module_function :copy_file
 
@@ -300,7 +289,7 @@ module TTY
     def copy_metadata(src_path, dest_path, **options)
       stats = ::File.lstat(src_path)
       ::File.utime(stats.atime, stats.mtime, dest_path)
-      chmod(dest_path, stats.mode, options)
+      chmod(dest_path, stats.mode, **options)
     end
     module_function :copy_metadata
 
@@ -318,7 +307,7 @@ module TTY
     #  Invoking:
     #    copy_directory("app", "new_app")
     #  The following directory structure should be created where
-    #  name resolves to 'cli' value:
+    #  name resolves to "cli" value:
     #
     #  new_app/
     #    cli.rb
@@ -345,15 +334,15 @@ module TTY
       check_path(source_path)
       source = escape_glob_path(source_path)
       dest_path = (args.first || source).to_s
-      opts = {recursive: true}.merge(options)
-      pattern = opts[:recursive] ? ::File.join(source, '**') : source
-      glob_pattern = ::File.join(pattern, '*')
+      opts = { recursive: true }.merge(options)
+      pattern = opts[:recursive] ? ::File.join(source, "**") : source
+      glob_pattern = ::File.join(pattern, "*")
 
       Dir.glob(glob_pattern, ::File::FNM_DOTMATCH).sort.each do |file_source|
         next if ::File.directory?(file_source)
         next if opts[:exclude] && file_source.match(opts[:exclude])
 
-        dest = ::File.join(dest_path, file_source.gsub(source_path, '.'))
+        dest = ::File.join(dest_path, file_source.gsub(source_path, "."))
         file_dest = ::Pathname.new(dest).cleanpath.to_s
 
         copy_file(file_source, file_dest, **options, &block)
@@ -446,7 +435,7 @@ module TTY
       dest_path = (args.first || ::File.basename(uri)).to_s
 
       unless uri =~ %r{^https?\://}
-        copy_file(uri, dest_path, options)
+        copy_file(uri, dest_path, **options)
         return
       end
 
@@ -456,7 +445,7 @@ module TTY
         content = (block.arity.nonzero? ? block[content] : block[])
       end
 
-      create_file(dest_path, content, options)
+      create_file(dest_path, content, **options)
     end
     module_function :download_file
 
@@ -470,19 +459,19 @@ module TTY
     #   the content to preped to file
     #
     # @example
-    #   prepend_to_file('Gemfile', "gem 'tty'")
+    #   prepend_to_file("Gemfile", "gem "tty"")
     #
     # @example
-    #   prepend_to_file('Gemfile') do
+    #   prepend_to_file("Gemfile") do
     #     "gem 'tty'"
     #   end
     #
     # @api public
     def prepend_to_file(relative_path, *args, **options, &block)
       log_status(:prepend, relative_path, options.fetch(:verbose, true),
-                                          options.fetch(:color, :green))
+                 options.fetch(:color, :green))
       options.merge!(before: /\A/, verbose: false)
-      inject_into_file(relative_path, *(args << options), &block)
+      inject_into_file(relative_path, *args, **options, &block)
     end
     module_function :prepend_to_file
 
@@ -501,19 +490,19 @@ module TTY
     #   the content to append to file
     #
     # @example
-    #   append_to_file('Gemfile', "gem 'tty'")
+    #   append_to_file("Gemfile", "gem 'tty'")
     #
     # @example
-    #   append_to_file('Gemfile') do
+    #   append_to_file("Gemfile") do
     #     "gem 'tty'"
     #   end
     #
     # @api public
     def append_to_file(relative_path, *args, **options, &block)
       log_status(:append, relative_path, options.fetch(:verbose, true),
-                                         options.fetch(:color, :green))
+                 options.fetch(:color, :green))
       options.merge!(after: /\z/, verbose: false)
-      inject_into_file(relative_path, *(args << options), &block)
+      inject_into_file(relative_path, *args, **options, &block)
     end
     module_function :append_to_file
 
@@ -543,13 +532,13 @@ module TTY
     #   log status
     #
     # @example
-    #   inject_into_file('Gemfile', "gem 'tty'", after: "gem 'rack'\n")
+    #   inject_into_file("Gemfile", "gem 'tty'", after: "gem 'rack'\n")
     #
     # @example
-    #   inject_into_file('Gemfile', "gem 'tty'\n", "gem 'loaf'", after: "gem 'rack'\n")
+    #   inject_into_file("Gemfile", "gem 'tty'\n", "gem 'loaf'", after: "gem 'rack'\n")
     #
     # @example
-    #   inject_into_file('Gemfile', after: "gem 'rack'\n") do
+    #   inject_into_file("Gemfile", after: "gem 'rack'\n") do
     #     "gem 'tty'\n"
     #   end
     #
@@ -574,7 +563,7 @@ module TTY
       log_status(:inject, relative_path, options.fetch(:verbose, true),
                                          options.fetch(:color, :green))
       replace_in_file(relative_path, /#{match}/, content,
-                      options.merge(verbose: false))
+                      **options.merge(verbose: false))
     end
     module_function :inject_into_file
 
@@ -600,10 +589,10 @@ module TTY
     #   log status
     #
     # @example
-    #   replace_in_file('Gemfile', /gem 'rails'/, "gem 'hanami'")
+    #   replace_in_file("Gemfile", /gem 'rails'/, "gem 'hanami'")
     #
     # @example
-    #   replace_in_file('Gemfile', /gem 'rails'/) do |match|
+    #   replace_in_file("Gemfile", /gem 'rails'/) do |match|
     #     match = "gem 'hanami'"
     #   end
     #
@@ -614,7 +603,7 @@ module TTY
     def replace_in_file(relative_path, *args, **options, &block)
       check_path(relative_path)
       contents = ::File.read(relative_path)
-      replacement = (block ? block[] : args[1..-1].join).gsub('\0', '')
+      replacement = (block ? block[] : args[1..-1].join).gsub('\0', "")
       match = Regexp.escape(replacement)
       status = nil
 
@@ -625,7 +614,7 @@ module TTY
       if options.fetch(:force, true) || !(contents =~ /^#{match}(\r?\n)*/m)
         status = contents.gsub!(*args, &block)
         if !status.nil?
-          ::File.open(relative_path, 'w') do |file|
+          ::File.open(relative_path, "w") do |file|
             file.write(contents)
           end
         end
@@ -651,7 +640,7 @@ module TTY
     #   for secure removing
     #
     # @example
-    #   remove_file 'doc/README.md'
+    #   remove_file "doc/README.md"
     #
     # @api public
     def remove_file(relative_path, *args, **options)
@@ -675,12 +664,12 @@ module TTY
     #   the number of lines to return from file
     #
     # @example
-    #   tail_file 'filename'
-    #   # =>  ['line 19', 'line20', ... ]
+    #   tail_file "filename"
+    #   # =>  ["line 19", "line20", ... ]
     #
     # @example
-    #   tail_file 'filename', 15
-    #   # =>  ['line 19', 'line20', ... ]
+    #   tail_file "filename", 15
+    #   # =>  ["line 19", "line20", ... ]
     #
     # @return [Array[String]]
     #
@@ -736,6 +725,7 @@ module TTY
     # @api private
     def check_path(path)
       return if ::File.exist?(path)
+
       raise InvalidPathError, "File path \"#{path}\" does not exist."
     end
     private_module_function :check_path
@@ -779,7 +769,7 @@ module TTY
       if ::FileTest.file?(object)
         ::File.open(object, &block)
       else
-        tempfile = Tempfile.new('tty-file-diff')
+        tempfile = Tempfile.new("tty-file-diff")
         tempfile << object
         tempfile.rewind
 

data/lib/tty/file/create_file.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'tty-prompt'
+require "tty-prompt"
 
 module TTY
   module File
@@ -34,7 +34,7 @@ module TTY
       def call
         detect_collision do
           FileUtils.mkdir_p(::File.dirname(relative_path))
-          ::File.open(relative_path, 'wb') { |f| f.write(content) }
+          ::File.open(relative_path, "wb") { |f| f.write(content) }
         end
         relative_path
       end
@@ -86,9 +86,9 @@ module TTY
       # @api private
       def file_collision(relative_path, content)
         choices = [
-          { key: 'y', name: 'yes, overwrite', value: :yes },
-          { key: 'n', name: 'no, do not overwrite', value: :no },
-          { key: 'q', name: 'quit, abort', value: :quit }
+          { key: "y", name: "yes, overwrite", value: :yes },
+          { key: "n", name: "no, do not overwrite", value: :no },
+          { key: "q", name: "quit, abort", value: :quit }
         ]
         answer = prompt.expand("Overwrite #{relative_path}?", choices)
         interpret_answer(answer)