tty-file 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 12c95f3b7bd457b553e6592d5a9c74cf3dff2d9a
-  data.tar.gz: adc293eda605ad68b5f45acff1d37c2849050922
+SHA256:
+  metadata.gz: c45f9ae4c83da383b63e7951bbc66f0e335ef0dcfe1e5c23f1730f7e03a4a828
+  data.tar.gz: 9ce415f8dda2fc64aa7d4b288d46bf0ee32942846f7233288b65b88f8f4758c5
 SHA512:
-  metadata.gz: 3a86b5c70306a91576514af459e7fd3a458858732352cbe68683afa27786576abdc018c4388e4aa00105e85a23de1d0dcd84f02ea715377ef86e7bbee2ff2197
-  data.tar.gz: a484156abd85e985118467b7cfd087c9672882e763fe0a84867b2543d08c4aa2000fc7640d205ffd6c2201fd18d0a79bcc0f83bf128165668ae4d7d06ca52e5c
+  metadata.gz: ba8743853a4a962d8e7b7dc7ce9c73cff20ede0d506160782605a1187a50facb8b6addd1a5ec2b73ee1f701e8a991afa95ac441010d894fb5b7b4275a6ac0ae6
+  data.tar.gz: bc7dad3603aac26bdcdcc2016871a52f1a717fbd67d7067e846c08059eb883b719f06c349db023115dc026a41893e51460654e1f5d1fa93b202e537c53d1d926

data/CHANGELOG.md

@@ -1,12 +1,27 @@
 # Change log
 
+## [v0.7.0] - 2018-12-17
+
+### Added
+* Add :secure option to #remove_file call
+* Add #safe_append_to_file, #safe_prepend_to_file, #safe_inject_into_file
+
+### Changed
+* Change #replace_in_file, #append_to_file, #prepend_to_file, and #inject_into_file to perform operation unsafely without checking prior content
+* Change to load gemspec files directly
+* Change to update tty-prompt
+* Change to freeze strings
+* Change to relax tty-prompt & diff-lcs version constraints
+
+### Fixed
+* Fixed windows tests
+
 ## [v0.6.0] - 2018-05-21
 
 ### Changed
 * Change identical files conflict message from blue to cyan for readability
 * Change replace_in_file to stop raising error and allow forcing file overwrite
-* Change replace_in_file, inject_into_file, prepend_to_file, append_to_file to return true
-  when operation is performed successfully, false otherwise
+* Change replace_in_file, inject_into_file, prepend_to_file, append_to_file to return true when operation is performed successfully, false otherwise
 * Update tty-prompt dependency
 * Change download_file to preserve query parameters
 
@@ -64,6 +79,7 @@
 
 * Initial implementation and release
 
+[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
 [v0.4.0]: https://github.com/piotrmurach/tty-file/compare/v0.3.0...v0.4.0

data/README.md

@@ -1,3 +1,7 @@
+<div align="center">
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+</div>
+
 # TTY::File [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://badge.fury.io/rb/tty-file.svg)][gem]
@@ -48,11 +52,11 @@ Or install it yourself as:
   * [2.5. create_file](#25-create_file)
   * [2.6. copy_dir](#26-copy_dir)
   * [2.7. create_dir](#27-create_dir)
-  * [2.8. diff](#28-diff)
+  * [2.8. diff_files](#28-diff_files)
   * [2.9. download_file](#29-download_file)
   * [2.10. inject_into_file](#210-inject_into_file)
   * [2.11. replace_in_file](#211-replace_in_file)
-  * [2.12. append_to_file](#212-apend_to_file)
+  * [2.12. append_to_file](#212-append_to_file)
   * [2.13. prepend_to_file](#213-prepend_to_file)
   * [2.14. remove_file](#214-remove_file)
   * [2.15. tail_file](#215-tail_file)
@@ -140,7 +144,7 @@ variables[:foo] = 'bar'
 TTY::File.copy_file('templates/application.html.erb', context: variables)
 ```
 
-You can also specify the template name surrounding any dynamic variables with `%` to be evaluted:
+You can also specify the template name surrounding any dynamic variables with `%` to be evaluated:
 
 ```ruby
 variables = OpenStruct.new
@@ -190,7 +194,7 @@ Assuming you have the following directory structure:
 #   %name%.rb
 ```
 
-you can copy `doc` folder to `docs` by invoking:
+You can copy `doc` folder to `docs` by invoking:
 
 ```ruby
 TTY::File.copy_directory('doc', 'docs', context: ...)
@@ -223,10 +227,10 @@ TTY::File.copy_directory('doc', 'docs', exclude: 'subcommands')
 To create directory use `create_directory` or its alias `create_dir` passing as a first argument file path:
 
 ```ruby
-TTY::File.create_dir(/path/to/directory)
+TTY::File.create_dir('/path/to/directory')
 ```
 
-or a data structure describing the directory tree including any files with or without content:
+Or a data structure describing the directory tree including any files with or without content:
 
 ```ruby
 tree =
@@ -256,15 +260,15 @@ TTY::File.create_dir(tree)
 As a second argument you can provide a parent directory, otherwise current directory will be assumed:
 
 ```ruby
-TTy::File.create_dir(tree, '/path/to/parent/dir')
+TTY::File.create_dir(tree, '/path/to/parent/dir')
 ```
 
-### 2.8. diff
+### 2.8. diff_files
 
 To compare files line by line in a system independent way use `diff`, or `diff_files`:
 
 ```ruby
-TTY::File.diff('file_a', 'file_b')
+TTY::File.diff_files('file_a', 'file_b')
 # =>
 #  @@ -1,4 +1,4 @@
 #   aaa
@@ -282,7 +286,7 @@ The `:context_lines` specifies how many extra lines around the differing lines t
 The `:threshold` sets maximum file size in bytes, by default files larger than `10Mb` are not processed.
 
 ```ruby
-TTY::File.diff('file_a', 'file_b', format: :old)
+TTY::File.diff_files('file_a', 'file_b', format: :old)
 # =>
 #  1,4c1,4
 #  < aaa
@@ -297,7 +301,7 @@ TTY::File.diff('file_a', 'file_b', format: :old)
 Equally, you can perform a comparison between a file content and a string content like so:
 
 ```ruby
-TTY::File.diff('/path/to/file', 'some long text')
+TTY::File.diff_files('/path/to/file', 'some long text')
 ```
 
 ### 2.9. download_file
@@ -331,7 +335,7 @@ Inject content into a file at a given location and return `true` when performed
 TTY::File.inject_into_file 'filename.rb', "text to add", after: "Code below this line\n"
 ```
 
-or using a block
+Or using a block:
 
 ```ruby
 TTY::File.inject_into_file 'filename.rb', after: "Code below this line\n" do
@@ -339,7 +343,21 @@ TTY::File.inject_into_file 'filename.rb', after: "Code below this line\n" do
 end
 ```
 
-You can also use Regular Expressions in `:after` or `:before` to match file location. The `append_to_file` and `prepend_to_file` allow you to add content at the end and the begging of a file.
+You can also use Regular Expressions in `:after` or `:before` to match file location.
+
+By default, this method will always inject content into file, regardless whether it is already present or not. To change this pass `:force` set to `false` to perform check before actually inserting text:
+
+```ruby
+TTY::File.inject_into_file('filename.rb', "text to add", after: "Code below this line\n"
+```
+
+Alternatively, use `safe_inject_into_file` to check if the text can be safely inserted.
+
+```ruby
+TTY::File.safe_inject_into_file('Gemfile', "gem 'tty'")
+```
+
+The [append_to_file](#212-append_to_file) and [prepend_to_file](#213-prepend_to_file) allow you to add content at the end and the begging of a file.
 
 ### 2.11. replace_in_file
 
@@ -365,7 +383,7 @@ Appends text to a file and returns `true` when performed successfully, `false` o
 TTY::File.append_to_file('Gemfile', "gem 'tty'")
 ```
 
-or inside a block:
+Or inside a block:
 
 ```ruby
 TTY::File.append_to_file('Gemfile') do
@@ -373,6 +391,18 @@ TTY::File.append_to_file('Gemfile') do
 end
 ```
 
+By default, this method will always append content regardless whether it is already present or not. To change this pass `:force` set to `false` to perform check before actually appending:
+
+```ruby
+TTY::File.append_to_file('Gemfile', "gem 'tty'", force: false)
+```
+
+Alternatively, use `safe_append_to_file` to check if the text can be safely appended.
+
+```ruby
+TTY::File.safe_append_to_file('Gemfile', "gem 'tty'")
+```
+
 ### 2.13. prepend_to_file
 
 Prepends text to a file and returns `true` when performed successfully, `false` otherwise. You can provide the text as a second argument:
@@ -381,7 +411,7 @@ Prepends text to a file and returns `true` when performed successfully, `false`
 TTY::File.prepend_to_file('Gemfile', "gem 'tty'")
 ```
 
-or inside a block:
+Or inside a block:
 
 ```ruby
 TTY::File.prepend_to_file('Gemfile') do
@@ -389,6 +419,18 @@ TTY::File.prepend_to_file('Gemfile') do
 end
 ```
 
+By default, this method will always prepend content regardless whether it is already present or not. To change this pass `:force` set to `false` to perform check before actually prepending:
+
+```ruby
+TTY::File.prepend_to_file('Gemfile', "gem 'tty'", force: false)
+```
+
+Alternatively, use `safe_prepend_to_file` to check if the text can be safely appended.
+
+```ruby
+TTY::File.safe_prepend_to_file('Gemfile', "gem 'tty'")
+```
+
 ### 2.14. remove_file
 
 To remove a file do:
@@ -442,4 +484,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Copyright
 
-Copyright (c) 2016-2018 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2016 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require "bundler/gem_tasks"
 

data/lib/tty-file.rb

@@ -1,3 +1 @@
-# encoding: utf-8
-
 require_relative 'tty/file'

data/lib/tty/file.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'pastel'
-require 'tty-prompt'
 require 'erb'
 require 'tempfile'
 require 'pathname'
@@ -344,7 +343,7 @@ module TTY
     # @api public
     def diff(path_a, path_b, **options)
       threshold = options[:threshold] || 10_000_000
-      output = ''
+      output = []
 
       open_tempfile_if_missing(path_a) do |file_a|
         if ::File.size(file_a) > threshold
@@ -363,7 +362,7 @@ module TTY
 
           log_status(:diff, "#{file_a.path} - #{file_b.path}",
                      options.fetch(:verbose, true), options.fetch(:color, :green))
-          return output if options[:noop]
+          return output.join if options[:noop]
 
           block_size = file_a.lstat.blksize
           while !file_a.eof? && !file_b.eof?
@@ -373,7 +372,7 @@ module TTY
           end
         end
       end
-      output
+      output.join
     end
     module_function :diff
 
@@ -447,6 +446,14 @@ module TTY
     end
     module_function :prepend_to_file
 
+    # Safely prepend to file checking if content is not already present
+    #
+    # @api public
+    def safe_prepend_to_file(relative_path, *args, **options, &block)
+      prepend_to_file(relative_path, *args, **(options.merge(force: false)), &block)
+    end
+    module_function :safe_prepend_to_file
+
     # Append to a file
     #
     # @param [String] relative_path
@@ -473,6 +480,14 @@ module TTY
     alias add_to_file append_to_file
     module_function :add_to_file
 
+    # Safely append to file checking if content is not already present
+    #
+    # @api public
+    def safe_append_to_file(relative_path, *args, **options, &block)
+      append_to_file(relative_path, *args, **(options.merge(force: false)), &block)
+    end
+    module_function :safe_append_to_file
+
     # Inject content into file at a given location
     #
     # @param [String] relative_path
@@ -526,6 +541,14 @@ module TTY
     alias insert_into_file inject_into_file
     module_function :insert_into_file
 
+    # Safely prepend to file checking if content is not already present
+    #
+    # @api public
+    def safe_inject_into_file(relative_path, *args, **options, &block)
+      inject_into_file(relative_path, *args, **(options.merge(force: false)), &block)
+    end
+    module_function :safe_inject_into_file
+
     # Replace content of a file matching string, returning false
     # when no substitutions were performed, true otherwise.
     #
@@ -549,7 +572,7 @@ module TTY
     # @api public
     def replace_in_file(relative_path, *args, **options, &block)
       check_path(relative_path)
-      contents = IO.read(relative_path)
+      contents = ::File.binread(relative_path)
       replacement = (block ? block[] : args[1..-1].join).gsub('\0', '')
       match = Regexp.escape(replacement)
       status = nil
@@ -558,7 +581,7 @@ module TTY
                                           options.fetch(:color, :green))
       return false if options[:noop]
 
-      if !(contents =~ /^#{match}(\r?\n)*/m) || options[:force]
+      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|
@@ -582,6 +605,8 @@ module TTY
     #   remove file ignoring errors
     # @option options [Symbol] :verbose
     #   log status
+    # @option options [Symbol] :secure
+    #   for secure removing
     #
     # @example
     #   remove_file 'doc/README.md'
@@ -591,9 +616,10 @@ module TTY
       log_status(:remove, relative_path, options.fetch(:verbose, true),
                                          options.fetch(:color, :red))
 
-      return if options[:noop]
+      return if options[:noop] || !::File.exist?(relative_path)
 
-      ::FileUtils.rm_r(relative_path, force: options[:force], secure: true)
+      ::FileUtils.rm_r(relative_path, force: options[:force],
+                       secure: options.fetch(:secure, true))
     end
     module_function :remove_file
 

data/lib/tty/file/create_file.rb

@@ -1,4 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require 'tty-prompt'
 
 module TTY
   module File

data/lib/tty/file/differ.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'diff/lcs'
 require 'diff/lcs/hunk'
@@ -59,7 +59,7 @@ module TTY
 
       # @api public
       def format_hunks(hunks)
-        output = ""
+        output = []
         hunks.each_cons(2) do |prev_hunk, current_hunk|
           begin
             if current_hunk.overlaps?(prev_hunk)
@@ -72,6 +72,7 @@ module TTY
           end
         end
         output << hunks.last.diff(@format) << "\n" if hunks.last
+        output.join
       end
     end # Differ
   end # File

data/lib/tty/file/digest_file.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'stringio'
 require 'openssl'

data/lib/tty/file/download_file.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'uri'
 require 'net/http'
@@ -32,7 +32,7 @@ module TTY
       # @api private
       def download(uri, path, limit)
         raise DownloadError, 'Redirect limit reached!' if limit.zero?
-        content = ''
+        content = []
 
         Net::HTTP.start(uri.host, uri.port,
                         use_ssl: uri.scheme == 'https') do |http|
@@ -49,7 +49,7 @@ module TTY
             end
           end
         end
-        content
+        content.join
       end
     end # DownloadFile
   end # File

data/lib/tty/file/read_backward_file.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 class ReadBackwardFile

data/lib/tty/file/version.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   module File
-    VERSION = '0.6.0'.freeze
+    VERSION = '0.7.0'
   end # File
 end # TTY

data/spec/fixtures/cli_app/%name%_cli.rb

@@ -0,0 +1,2 @@
+class AppCLI
+end

data/spec/fixtures/cli_app/commands/subcommand.rb

@@ -0,0 +1,2 @@
+class Subcommand < Command
+end

data/spec/fixtures/cli_app/excluded/%name%_cli.rb

@@ -0,0 +1,2 @@
+class AppCLI
+end

data/spec/fixtures/templates/%file_name%.rb

@@ -0,0 +1 @@
+<%= foo %>