tty-file 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 391c8a79917ab4059cf5e97f8ef9ab897f074e26
-  data.tar.gz: 9763444093d08c160b29ecb8aae0a0af01b0395e
+  metadata.gz: 12c95f3b7bd457b553e6592d5a9c74cf3dff2d9a
+  data.tar.gz: adc293eda605ad68b5f45acff1d37c2849050922
 SHA512:
-  metadata.gz: 8409f8c8fa4f5eb1ec0ac20f96bc6f807599b09ea654c0ddcf389fad464bc7a64d7a512afa377e935e3919a1eb078a3013335934a95b059c780ed2543bb77c6e
-  data.tar.gz: 5915f45e25b27567db2bc970374adf9283a09e91bd6382f16aabed0c81ede0627e5c475d3edd22e2a287602ab28a3385602bae6e10056b50e526536ee714ce3d
+  metadata.gz: 3a86b5c70306a91576514af459e7fd3a458858732352cbe68683afa27786576abdc018c4388e4aa00105e85a23de1d0dcd84f02ea715377ef86e7bbee2ff2197
+  data.tar.gz: a484156abd85e985118467b7cfd087c9672882e763fe0a84867b2543d08c4aa2000fc7640d205ffd6c2201fd18d0a79bcc0f83bf128165668ae4d7d06ca52e5c

data/.travis.yml

@@ -6,9 +6,10 @@ script: "bundle update && bundle exec rake ci"
 rvm:
   - 2.0.0
   - 2.1.10
-  - 2.2.8
+  - 2.2.9
   - 2.3.6
-  - 2.4.3
+  - 2.4.4
+  - 2.5.1
   - ruby-head
   - jruby-9.1.1.0
 env:

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change log
 
+## [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
+* Update tty-prompt dependency
+* Change download_file to preserve query parameters
+
+### Fixed
+* Fix replace_in_file to preserve file original encoding
+
 ## [v0.5.0] - 2018-01-06
 
 ### Changed
@@ -51,6 +64,7 @@
 
 * Initial implementation and release
 
+[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
 [v0.3.0]: https://github.com/piotrmurach/tty-file/compare/v0.2.1...v0.3.0

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'simplecov', '~> 0.12.0'
-  gem 'coveralls', '~> 0.8.17'
-  gem 'webmock',   '~> 2.3.0'
+  gem 'simplecov', '~> 0.14.1'
+  gem 'coveralls', '~> 0.8.21'
+  gem 'public_suffix', '~> 2.0'
 end

data/README.md

@@ -19,7 +19,7 @@
 
 ## Motivation
 
-Though Ruby's `File` and `FileUtils` provide very robust apis for dealing with files, this library aims to provide level of abstraction that is much convenient with useful logging capabilities.
+Though Ruby's `File` and `FileUtils` libraries provide very robust apis for dealing with files, this library aims to provide a level of abstraction that is much more convenient, with useful logging capabilities.
 
 ## Installation
 
@@ -65,7 +65,7 @@ TTY::File.replace_in_file('Gemfile', /gem 'rails'/, "gem 'hanami'")
 
 ## 2. Interface
 
-The following are methods available for creating and manipulating files.
+The following methods are available for creating and manipulating files.
 
 If you wish to silence verbose output use `verbose: false`. Similarly if you wish to run action without actually triggering any action use `noop: true`.
 
@@ -79,14 +79,14 @@ TTY::File.binary?('image.png') # => true
 
 ### 2.2. checksum_file
 
-To generate checksum for a file, IO object or String use `checksum_file`. By default `MD5` algorithm is used which can be changed by passing second argument.
+To generate a checksum for a file, IO object, or String, use `checksum_file`. By default the `MD5` algorithm is used, which can be changed by passing a second argument.
 
-Among supported message digest algorithms are:
+Among the supported message digest algorithms are:
 
 * `sha`, `sha1`, `sha224`, `sha256`, `sha384`, `sha512`
 * `md2`, `md4`, `md5`
 
-For example, to create digest for string using `SHA1` do:
+For example, to create a digest for a string using `SHA1` do:
 
 ```ruby
 TTY::File.checksum_file("Some content\nThe end", 'sha1')
@@ -95,19 +95,19 @@ TTY::File.checksum_file("Some content\nThe end", 'sha1')
 
 ### 2.3. chmod
 
-To change file modes use `chmod` like so:
+To change file modes use `chmod`, like so:
 
 ```ruby
 TTY::File.chmod('filename.rb', 0777)
 ```
 
-There are number of constants available to represent common mode bits such as `TTY::File::U_R`, `TTY::File::O_X` and can be used as follows:
+There are a number of constants available to represent common mode bits such as `TTY::File::U_R` and `TTY::File::O_X`, and they can be used as follows:
 
 ```ruby
 TTY::File.chmod('filename.rb', TTY::File::U_R | TTY::File::O_X)
 ```
 
-Apart from traditional octal number definition for file permissions, you can use more convenient permission notation accepted by Unix `chmod` command:
+Apart from traditional octal number definition for file permissions, you can use the more convenient permission notation used by the Unix `chmod` command:
 
 ```ruby
 TTY::File.chmod('filename.rb', 'u=wrx,g+x')
@@ -117,7 +117,7 @@ The `u`, `g`, and `o` specify the user, group, and other parts of the mode bits.
 
 ### 2.4. copy_file
 
-Copies a file content from relative source to relative destination.
+Copies a file's contents from a relative source to a relative destination.
 
 ```ruby
 TTY::File.copy_file 'Gemfile', 'Gemfile.bak'
@@ -131,7 +131,7 @@ TTY::File.copy_file('Gemfile', 'app/Gemfile') do |content|
 end
 ```
 
-If the source file is an `ERB` template then you can provide `:context` in which the file gets evaluted or if `TTY::File` gets included as a module then approprite object context will be used by default. To use `:context` do:
+If the source file is an `ERB` template then you can provide a `:context` in which the file gets evaluated, or if `TTY::File` gets included as a module then appropriate object context will be used by default. To use `:context` do:
 
 ```ruby
 variables = OpenStruct.new
@@ -140,7 +140,7 @@ variables[:foo] = 'bar'
 TTY::File.copy_file('templates/application.html.erb', context: variables)
 ```
 
-You can also specifie template name surrounding any dynamic variables with `%` to be evaluted:
+You can also specify the template name surrounding any dynamic variables with `%` to be evaluted:
 
 ```ruby
 variables = OpenStruct.new
@@ -325,7 +325,7 @@ TTY::File.download_file("https://gist.github.com/4701967", "doc/README.md", limi
 
 ### 2.10. inject_into_file
 
-Inject content into a file at a given location
+Inject content into a file at a given location and return `true` when performed successfully, `false` otherwise.
 
 ```ruby
 TTY::File.inject_into_file 'filename.rb', "text to add", after: "Code below this line\n"
@@ -343,7 +343,7 @@ You can also use Regular Expressions in `:after` or `:before` to match file loca
 
 ### 2.11. replace_in_file
 
-Replace content of a file matching condition by calling `replace_in_file` or `gsub_file`
+Replace content of a file matching condition by calling `replace_in_file` or `gsub_file`, which returns `true` when substitutions are performed successfully, `false` otherwise.
 
 ```ruby
 TTY::File.replace_in_file 'filename.rb', /matching condition/, 'replacement'
@@ -359,7 +359,7 @@ end
 
 ### 2.12. append_to_file
 
-Appends text to a file. You can provide the text as a second argument:
+Appends text to a file and returns `true` when performed successfully, `false` otherwise. You can provide the text as a second argument:
 
 ```ruby
 TTY::File.append_to_file('Gemfile', "gem 'tty'")
@@ -375,7 +375,7 @@ end
 
 ### 2.13. prepend_to_file
 
-Prepends text to a file. You can provide the text as a second argument:
+Prepends text to a file and returns `true` when performed successfully, `false` otherwise. You can provide the text as a second argument:
 
 ```ruby
 TTY::File.prepend_to_file('Gemfile', "gem 'tty'")

data/appveyor.yml

@@ -9,7 +9,6 @@ test_script:
   - bundle exec rake ci
 environment:
   matrix:
-    - ruby_version: "193"
     - ruby_version: "200"
     - ruby_version: "200-x64"
     - ruby_version: "21"
@@ -20,6 +19,8 @@ environment:
     - ruby_version: "23-x64"
     - ruby_version: "24"
     - ruby_version: "24-x64"
+    - ruby_version: "25"
+    - ruby_version: "25-x64"
 matrix:
   allow_failures:
-    - ruby_version: "193"
+    - ruby_version: "25"

data/lib/tty/file.rb

@@ -500,6 +500,7 @@ module TTY
     #
     # @api public
     def inject_into_file(relative_path, *args, **options, &block)
+      check_path(relative_path)
       replacement = block_given? ? block[] : args.join
 
       flag, match = if options.key?(:after)
@@ -515,17 +516,18 @@ module TTY
                   replacement + '\0'
                 end
 
-      replace_in_file(relative_path, /#{match}/, content, options.merge(verbose: false))
-
       log_status(:inject, relative_path, options.fetch(:verbose, true),
                                          options.fetch(:color, :green))
+      replace_in_file(relative_path, /#{match}/, content,
+                      options.merge(verbose: false))
     end
     module_function :inject_into_file
 
     alias insert_into_file inject_into_file
     module_function :insert_into_file
 
-    # Replace content of a file matching string
+    # Replace content of a file matching string, returning false
+    # when no substitutions were performed, true otherwise.
     #
     # @options [Hash[String]] options
     # @option options [Symbol] :force
@@ -541,26 +543,30 @@ module TTY
     #     match = "gem 'hanami'"
     #   end
     #
+    # @return [Boolean]
+    #   true when replaced content, false otherwise
+    #
     # @api public
     def replace_in_file(relative_path, *args, **options, &block)
       check_path(relative_path)
-      contents    = IO.read(relative_path)
+      contents = IO.read(relative_path)
       replacement = (block ? block[] : args[1..-1].join).gsub('\0', '')
+      match = Regexp.escape(replacement)
+      status = nil
 
       log_status(:replace, relative_path, options.fetch(:verbose, true),
                                           options.fetch(:color, :green))
+      return false if options[:noop]
 
-      return if options[:noop]
-
-      if options[:force] || !contents.include?(replacement)
-        if !contents.gsub!(*args, &block)
-          find = args[0]
-          raise "#{find.inspect} not found in #{relative_path}"
-        end
-        ::File.open(relative_path, 'wb') do |file|
-          file.write(contents)
+      if !(contents =~ /^#{match}(\r?\n)*/m) || options[:force]
+        status = contents.gsub!(*args, &block)
+        if !status.nil?
+          ::File.open(relative_path, 'wb') do |file|
+            file.write(contents)
+          end
         end
       end
+      !status.nil?
     end
     module_function :replace_in_file
 

data/lib/tty/file/create_file.rb

@@ -56,7 +56,7 @@ module TTY
       def detect_collision
         if exist?
           if identical?
-            notify(:identical, :blue)
+            notify(:identical, :cyan)
           elsif options[:force]
             notify(:force, :yellow)
             yield unless options[:noop]

data/lib/tty/file/download_file.rb

@@ -36,7 +36,7 @@ module TTY
 
         Net::HTTP.start(uri.host, uri.port,
                         use_ssl: uri.scheme == 'https') do |http|
-          http.request_get(uri.path) do |response|
+          http.request_get(uri.request_uri) do |response|
             case response
             when Net::HTTPSuccess
               response.read_body do |seg|

data/lib/tty/file/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module File
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end # File
 end # TTY

data/tty-file.gemspec

@@ -22,10 +22,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency 'pastel',     '~> 0.7.2'
-  spec.add_dependency 'tty-prompt', '~> 0.14.0'
+  spec.add_dependency 'tty-prompt', '~> 0.16.1'
   spec.add_dependency 'diff-lcs',   '~> 1.3.0'
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-file
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-06 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.16.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
 description: File manipulation utility methods.
 email:
 - ''