tty-file 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c45f9ae4c83da383b63e7951bbc66f0e335ef0dcfe1e5c23f1730f7e03a4a828
-  data.tar.gz: 9ce415f8dda2fc64aa7d4b288d46bf0ee32942846f7233288b65b88f8f4758c5
+  metadata.gz: 5d22dc89aced7b8ab2593a332739545706562d2683f93e9a88ea7fdec5a06453
+  data.tar.gz: c94f59cbaaccf16ce290e08ca44ad9c4ebfb7f105d953db9c6ba0dc00de369da
 SHA512:
-  metadata.gz: ba8743853a4a962d8e7b7dc7ce9c73cff20ede0d506160782605a1187a50facb8b6addd1a5ec2b73ee1f701e8a991afa95ac441010d894fb5b7b4275a6ac0ae6
-  data.tar.gz: bc7dad3603aac26bdcdcc2016871a52f1a717fbd67d7067e846c08059eb883b719f06c349db023115dc026a41893e51460654e1f5d1fa93b202e537c53d1d926
+  metadata.gz: 2a583724c8f93ae02a69cea8c171076f53305fea40b7e6cf04d9de0ec3a0d275847a1d5a3da87ae42453b40835d15165ca7b32156c47b6d5e280b05cd07b3d2c
+  data.tar.gz: 0e737e0619ef7db2d1cc18507b768ca4d62d88cef2dbf12501f8b855598c5aaaed11ecc88b87505a9e4cfd759fc1bfb83afc2fc1b293f6a9e56405482823668e

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change log
 
+## [v0.7.1] - 2019-05-06
+
+### Changed
+* Change all methods to accept Pathname instances as argument by Chris Hoffman(@yarmiganosca)
+
+### Fixed
+* Fix Ruby 2.6.0 ERB#new arguments deprecation warnings
+* Fix #replace_in_file to handle character encoding
+
 ## [v0.7.0] - 2018-12-17
 
 ### Added
@@ -79,6 +88,7 @@
 
 * Initial implementation and release
 
+[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
 [v0.6.0]: https://github.com/piotrmurach/tty-file/compare/v0.5.0...v0.6.0
 [v0.5.0]: https://github.com/piotrmurach/tty-file/compare/v0.4.0...v0.5.0

data/lib/tty/file.rb

@@ -37,7 +37,7 @@ module TTY
 
     # Check if file is binary
     #
-    # @param [String] relative_path
+    # @param [String, Pathname] relative_path
     #   the path to file to check
     #
     # @example
@@ -66,7 +66,7 @@ module TTY
 
     # Create checksum for a file, io or string objects
     #
-    # @param [File,IO,String] source
+    # @param [File, IO, String, Pathname] source
     #   the source to generate checksum for
     # @param [String] mode
     # @param [Hash[Symbol]] options
@@ -92,7 +92,7 @@ module TTY
 
     # Change file permissions
     #
-    # @param [String] relative_path
+    # @param [String, Pathname] relative_path
     # @param [Integer,String] permisssions
     # @param [Hash[Symbol]] options
     # @option options [Symbol] :noop
@@ -130,7 +130,7 @@ module TTY
 
     # Create directory structure
     #
-    # @param [String, Hash] destination
+    # @param [String, Pathname, Hash] destination
     #   the path or data structure describing directory tree
     #
     # @example
@@ -155,8 +155,8 @@ module TTY
     # @api public
     def create_directory(destination, *args, **options)
       parent = args.size.nonzero? ? args.pop : nil
-      if destination.is_a?(String)
-        destination = { destination => [] }
+      if destination.is_a?(String) || destination.is_a?(Pathname)
+        destination = { destination.to_s => [] }
       end
 
       destination.each do |dir, files|
@@ -183,7 +183,7 @@ module TTY
 
     # Create new file if doesn't exist
     #
-    # @param [String] relative_path
+    # @param [String, Pathname] relative_path
     # @param [String|nil] content
     #   the content to add to file
     # @param [Hash] options
@@ -200,6 +200,7 @@ module TTY
     #
     # @api public
     def create_file(relative_path, *args, **options, &block)
+      relative_path = relative_path.to_s
       content = block_given? ? block[] : args.join
 
       CreateFile.new(self, relative_path, content, options).call
@@ -220,6 +221,7 @@ module TTY
     #   vars[:name] = 'foo'
     #   copy_file 'templates/%name%.rb', 'app/%name%.rb', context: vars
     #
+    # @param [String, Pathname] source_path
     # @param [Hash] options
     # @option options [Symbol] :context
     #   the binding to use for the template
@@ -233,7 +235,8 @@ module TTY
     #
     # @api public
     def copy_file(source_path, *args, **options, &block)
-      dest_path = (args.first || source_path).sub(/\.erb$/, '')
+      source_path = source_path.to_s
+      dest_path = (args.first || source_path).to_s.sub(/\.erb$/, '')
 
       ctx = if (vars = options[:context])
               vars.instance_eval('binding')
@@ -242,7 +245,12 @@ module TTY
             end
 
       create_file(dest_path, options) do
-        template = ERB.new(::File.binread(source_path), nil, "-", "@output_buffer")
+        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")
+                   else
+                    ERB.new(::File.binread(source_path), nil, "-", "@output_buffer")
+                   end
         content = template.result(ctx)
         content = block[content] if block
         content
@@ -288,6 +296,7 @@ module TTY
     #    command.rb
     #    README
     #
+    # @param [String, Pathname] source_path
     # @param [Hash[Symbol]] options
     # @option options [Symbol] :preserve
     #   If true, the owner, group, permissions and modified time
@@ -303,9 +312,10 @@ module TTY
     #
     # @api public
     def copy_directory(source_path, *args, **options, &block)
+      source_path = source_path.to_s
       check_path(source_path)
       source = escape_glob_path(source_path)
-      dest_path = args.first || source
+      dest_path = (args.first || source).to_s
       opts = {recursive: true}.merge(options)
       pattern = opts[:recursive] ? ::File.join(source, '**') : source
       glob_pattern = ::File.join(pattern, '*')
@@ -327,8 +337,8 @@ module TTY
 
     # Diff files line by line
     #
-    # @param [String] path_a
-    # @param [String] path_b
+    # @param [String, Pathname] path_a
+    # @param [String, Pathname] path_b
     # @param [Hash[Symbol]] options
     # @option options [Symbol] :format
     #   the diffining output format
@@ -384,9 +394,9 @@ module TTY
     # is provided in place of destination, the content of
     # of the uri is yielded.
     #
-    # @param [String] uri
+    # @param [String, Pathname] uri
     #   the URI address
-    # @param [String] dest
+    # @param [String, Pathname] dest
     #   the relative path to save
     # @param [Hash[Symbol]] options
     # @param options [Symbol] :limit
@@ -403,7 +413,8 @@ module TTY
     #
     # @api public
     def download_file(uri, *args, **options, &block)
-      dest_path = args.first || ::File.basename(uri)
+      uri = uri.to_s
+      dest_path = (args.first || ::File.basename(uri)).to_s
 
       unless uri =~ %r{^https?\://}
         copy_file(uri, dest_path, options)
@@ -425,7 +436,7 @@ module TTY
 
     # Prepend to a file
     #
-    # @param [String] relative_path
+    # @param [String, Pathname] relative_path
     # @param [Array[String]] content
     #   the content to preped to file
     #
@@ -456,7 +467,7 @@ module TTY
 
     # Append to a file
     #
-    # @param [String] relative_path
+    # @param [String, Pathname] relative_path
     # @param [Array[String]] content
     #   the content to append to file
     #
@@ -490,7 +501,7 @@ module TTY
 
     # Inject content into file at a given location
     #
-    # @param [String] relative_path
+    # @param [String, Pathname] relative_path
     #
     # @param [Hash] options
     # @option options [Symbol] :before
@@ -552,6 +563,7 @@ module TTY
     # Replace content of a file matching string, returning false
     # when no substitutions were performed, true otherwise.
     #
+    # @param [String, Pathname] relative_path
     # @options [Hash[String]] options
     # @option options [Symbol] :force
     #   replace content even if present
@@ -572,7 +584,7 @@ module TTY
     # @api public
     def replace_in_file(relative_path, *args, **options, &block)
       check_path(relative_path)
-      contents = ::File.binread(relative_path)
+      contents = ::File.read(relative_path)
       replacement = (block ? block[] : args[1..-1].join).gsub('\0', '')
       match = Regexp.escape(replacement)
       status = nil
@@ -584,7 +596,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, 'wb') do |file|
+          ::File.open(relative_path, 'w') do |file|
             file.write(contents)
           end
         end
@@ -598,6 +610,7 @@ module TTY
 
     # Remove a file or a directory at specified relative path.
     #
+    # @param [String, Pathname] relative_path
     # @param [Hash[:Symbol]] options
     # @option options [Symbol] :noop
     #   pretend removing file
@@ -613,6 +626,7 @@ module TTY
     #
     # @api public
     def remove_file(relative_path, *args, **options)
+      relative_path = relative_path.to_s
       log_status(:remove, relative_path, options.fetch(:verbose, true),
                                          options.fetch(:color, :red))
 
@@ -625,7 +639,7 @@ module TTY
 
     # Provide the last number of lines from a file
     #
-    # @param [String] relative_path
+    # @param [String, Pathname] relative_path
     #   the relative path to a file
     #
     # @param [Integer] num_lines

data/lib/tty/file/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module File
-    VERSION = '0.7.0'
+    VERSION = "0.7.1"
   end # File
 end # TTY

data/spec/spec_helper.rb

@@ -38,6 +38,10 @@ module Helpers
     ::File.join(dir_path('tmp'), filename.to_s)
   end
 
+  def tmp_pathname(filename = nil)
+    Pathname.new(tmp_path(filename))
+  end
+
   def exists_and_identical?(source, dest)
     dest_path = tmp_path(dest)
     expect(::File.exist?(dest_path)).to be(true)

data/spec/unit/append_to_file_spec.rb

@@ -1,85 +1,110 @@
 # frozen_string_literal: true
 
-RSpec.describe TTY::File, '#append_to_file' do
-  it "appends to file" do
-    file = tmp_path('Gemfile')
-    TTY::File.append_to_file(file, "gem 'tty'", verbose: false)
-    expect(File.read(file)).to eq([
-      "gem 'nokogiri'\n",
-      "gem 'rails', '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n",
-      "gem 'tty'"
-    ].join)
-  end
+RSpec.describe TTY::File, "#append_to_file" do
+  shared_context "appending to files" do
+    it "appends to file" do
+      file = path_factory.call('Gemfile')
 
-  it "appends multiple lines to file" do
-    file = tmp_path('Gemfile')
-    TTY::File.append_to_file(file, "gem 'tty'\n", "gem 'rake'", verbose: false)
-    expect(File.read(file)).to eq([
-      "gem 'nokogiri'\n",
-      "gem 'rails', '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n",
-      "gem 'tty'\n",
-      "gem 'rake'"
-    ].join)
-  end
+      TTY::File.append_to_file(file, "gem 'tty'", verbose: false)
 
-  it "appends content in a block" do
-    file = tmp_path('Gemfile')
-    TTY::File.append_to_file(file, verbose: false) { "gem 'tty'"}
-    expect(File.read(file)).to eq([
-      "gem 'nokogiri'\n",
-      "gem 'rails', '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n",
-      "gem 'tty'"
-    ].join)
-  end
+      expect(File.read(file)).to eq([
+        "gem 'nokogiri'\n",
+        "gem 'rails', '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n",
+        "gem 'tty'"
+      ].join)
+    end
 
-  it "doesn't append if already present" do
-    file = tmp_path('Gemfile')
-    TTY::File.append_to_file(file, "gem 'rack', '>=1.0'\n", force: false, verbose: false)
-    expect(::File.read(file)).to eq([
-      "gem 'nokogiri'\n",
-      "gem 'rails', '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n",
-    ].join)
-  end
+    it "appends multiple lines to file" do
+      file = path_factory.call('Gemfile')
 
-  it "appends safely checking if content already present" do
-    file = tmp_path('Gemfile')
-    TTY::File.safe_append_to_file(file, "gem 'rack', '>=1.0'\n", verbose: false)
+      TTY::File.append_to_file(file, "gem 'tty'\n", "gem 'rake'", verbose: false)
 
-    expect(::File.read(file)).to eq([
-      "gem 'nokogiri'\n",
-      "gem 'rails', '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n",
-    ].join)
-  end
+      expect(File.read(file)).to eq([
+        "gem 'nokogiri'\n",
+        "gem 'rails', '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n",
+        "gem 'tty'\n",
+        "gem 'rake'"
+      ].join)
+    end
+
+    it "appends content in a block" do
+      file = path_factory.call('Gemfile')
+
+      TTY::File.append_to_file(file, verbose: false) { "gem 'tty'"}
+
+      expect(File.read(file)).to eq([
+        "gem 'nokogiri'\n",
+        "gem 'rails', '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n",
+        "gem 'tty'"
+      ].join)
+    end
+
+    it "doesn't append if already present" do
+      file = path_factory.call('Gemfile')
+
+      TTY::File.append_to_file(file, "gem 'rack', '>=1.0'\n", force: false, verbose: false)
 
-  it "appends multiple times by default" do
-    file = tmp_path('Gemfile')
-    TTY::File.append_to_file(file, "gem 'tty'\n", verbose: false)
-    TTY::File.append_to_file(file, "gem 'tty'\n", verbose: false)
-    expect(::File.read(file)).to eq([
-      "gem 'nokogiri'\n",
-      "gem 'rails', '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n",
-      "gem 'tty'\n",
-      "gem 'tty'\n"
-    ].join)
+      expect(::File.read(file)).to eq([
+        "gem 'nokogiri'\n",
+        "gem 'rails', '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n",
+      ].join)
+    end
+
+    it "appends safely checking if content already present" do
+      file = path_factory.call('Gemfile')
+
+      TTY::File.safe_append_to_file(file, "gem 'rack', '>=1.0'\n", verbose: false)
+
+      expect(::File.read(file)).to eq([
+        "gem 'nokogiri'\n",
+        "gem 'rails', '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n",
+      ].join)
+    end
+
+    it "appends multiple times by default" do
+      file = path_factory.call('Gemfile')
+
+      TTY::File.append_to_file(file, "gem 'tty'\n", verbose: false)
+      TTY::File.append_to_file(file, "gem 'tty'\n", verbose: false)
+
+      expect(::File.read(file)).to eq([
+        "gem 'nokogiri'\n",
+        "gem 'rails', '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n",
+        "gem 'tty'\n",
+        "gem 'tty'\n"
+      ].join)
+    end
+
+    it "logs action" do
+      file = path_factory.call('Gemfile')
+      expect {
+        TTY::File.add_to_file(file, "gem 'tty'")
+      }.to output(/\e\[32mappend\e\[0m.*Gemfile/).to_stdout_from_any_process
+    end
+
+    it "logs action without color" do
+      file = path_factory.call('Gemfile')
+      expect {
+        TTY::File.add_to_file(file, "gem 'tty'", color: false)
+      }.to output(/\s+append.*Gemfile/).to_stdout_from_any_process
+    end
   end
 
-  it "logs action" do
-    file = tmp_path('Gemfile')
-    expect {
-      TTY::File.add_to_file(file, "gem 'tty'")
-    }.to output(/\e\[32mappend\e\[0m.*Gemfile/).to_stdout_from_any_process
+  context "when passed a String instance for the file argument" do
+    let(:path_factory) { method(:tmp_path) }
+
+    include_context "appending to files"
   end
 
-  it "logs action without color" do
-    file = tmp_path('Gemfile')
-    expect {
-      TTY::File.add_to_file(file, "gem 'tty'", color: false)
-    }.to output(/\s+append.*Gemfile/).to_stdout_from_any_process
+  context "when passed a Pathname instance for the file argument" do
+    let(:path_factory) { method(:tmp_pathname) }
+
+    include_context "appending to files"
   end
 end