tty-file 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad05816965df5179021ae1e70048eac3ae58db78
-  data.tar.gz: 35e7da73870c9bbb6d01a35584bb0537c110903e
+  metadata.gz: 24159965082063c18c0538a86d536db913ac05ee
+  data.tar.gz: 4b751ed2950b3f4725333011ce9351dd3d1a1afe
 SHA512:
-  metadata.gz: 3dbfc53a540c8f43c130274c02fcf3c2a9cfb0d50cab7b7d0a1e1ba2ab8c92073a61b0c4bf4c0108d005abfc353d65e10190169c689b772c54becfee96bc12e6
-  data.tar.gz: 92a918fd84a1e846d04c374644781f940f28ea0705df7f9ab0da5df7e87f9d0e39c2bd08621b021eed86da4cb7b2e4703ba5430b64860c571c5fe856ba7308cc
+  metadata.gz: e08fc675ca19202aeaa3bbbba1c4236253e8f10355354889e384b41f63cc47e71160ecaa3945fcec062cad473fd9f401fcd7b8c71a2c406a5c28a2c625a2c8c0
+  data.tar.gz: 79793d79c75630d2e81228fbbc78ee023d81ba2c425d1dcd4896ea2f72813c363c58b0c39f6b0947f83edcd7f156cb292209bb7ccfbebe294f294195e9aa715f

data/.travis.yml

@@ -2,24 +2,24 @@
 language: ruby
 sudo: false
 cache: bundler
-script: "bundle exec rake ci"
+script: "bundle update && bundle exec rake ci"
 rvm:
   - 2.0.0
   - 2.1.10
   - 2.2.5
   - 2.3.1
+  - 2.4.0
   - ruby-head
-  - rbx
+  - jruby-9.1.1.0
+  - rbx-3
+env:
+  global:
+    - JRUBY_OPTS=''
 matrix:
-  include:
-    - rvm: jruby
-      env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false -Xcompat.version=2.0'
-    - rvm: jruby-9.1.2.0
-      env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false'
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby
-    - rvm: rbx
+    - rvm: rbx-3
+    - rvm: jruby-9.1.1.0
   fast_finish: true
 branches:
   only: master

data/CHANGELOG.md

@@ -1,7 +1,25 @@
 # Change log
 
+## [v0.2.0] - 2017-01-22
+
+### Added
+* Add #checksum_file to generate checksum for a file, IO object or String
+* Add #create_dir to create directory structure with directories and files
+* Add #copy_dir to copy directory recurisvely
+* Add #escape_glob_path for escaping glob characters in a path
+
+### Changed
+* Change #binary? to only read max 4Kb of file
+* Change CreateFile to accept context in constructor
+* Change to separate config_options from utility options
+
+### Fixed
+* Fix all aliases being incorrectly defined
+* Fix #copy_file to stop appending to source paths
+
 ## [v0.1.0] - 2016-11-06
 
 * Initial implementation and release
 
+[v0.2.0]: https://github.com/piotrmurach/tty-file/compare/v0.1.0...v0.2.0
 [v0.1.0]: https://github.com/piotrmurach/tty-file/compare/v0.1.0

data/Gemfile

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

data/README.md

@@ -39,16 +39,19 @@ Or install it yourself as:
 * [1. Usage](#1-usage)
 * [2. Interface](#2-interface)
   * [2.1. binary?](#21-binary)
-  * [2.2. chmod](#22-chmod)
-  * [2.3. copy_file](#23-copy_file)
-  * [2.4. create_file](#24-create_file)
-  * [2.5. diff](#25-diff)
-  * [2.6. download_file](#26-download_file)
-  * [2.7. inject_into_file](#27-inject_into_file)
-  * [2.8. replace_in_file](#28-replace_in_file)
-  * [2.9. append_to_file](#29-apend_to_file)
-  * [2.10. prepend_to_file](#30-prepend_to_file)
-  * [2.11. remove_file](#211-remove_file)
+  * [2.2. checksum_file](#22-checksum_file)
+  * [2.3. chmod](#23-chmod)
+  * [2.4. copy_file](#24-copy_file)
+  * [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.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.13. prepend_to_file](#213-prepend_to_file)
+  * [2.14. remove_file](#214-remove_file)
 
 ## 1. Usage
 
@@ -70,7 +73,23 @@ To check whether a file is a binary file, i.e. image, executable etc. do:
 TTY::File.binary?('image.png') # => true
 ```
 
-### 2.2. chmod
+### 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.
+
+Among supported message digest algorithms are:
+
+* `sha`, `sha1`, `sha224`, `sha256`, `sha384`, `sha512`
+* `md2`, `md4`, `md5`
+
+For example, to create digest for string using `SHA1` do:
+
+```ruby
+TTY::File.checksum_file("Some content\nThe end", 'sha1')
+# => "289388f187404135e6c15b21460442cf867180dd"
+```
+
+### 2.3. chmod
 
 To change file modes use `chmod` like so:
 
@@ -92,7 +111,7 @@ TTY::File.chmod('filename.rb', 'u=wrx,g+x')
 
 The `u`, `g`, and `o` specify the user, group, and other parts of the mode bits. The `a` symbol is equivalent to `ugo`.
 
-### 2.3. copy_file
+### 2.4. copy_file
 
 Copies a file content from relative source to relative destination.
 
@@ -141,7 +160,7 @@ If you wish to preserve original owner, group, permission and modified time use
 TTY::File.copy_file 'docs/README.md', 'app', preserve: true
 ```
 
-### 2.4. create_file
+### 2.5. create_file
 
 To create a file at a given destination with the given content use `create_file`:
 
@@ -153,9 +172,92 @@ On collision with already existing file, a menu is displayed:
 
 You can force to always overwrite file with `:force` option or always skip by providing `:skip`.
 
-### 2.5. diff
+### 2.6. copy_dir
+
+To recursively copy a directory of files from source to destination location use `copy_directory` or its alias 'copy_dir'.
+
+Assuming you have the following directory structure:
+
+```ruby
+# doc/
+#   subcommands/
+#     command.rb.erb
+#   README.md
+#   %name%.rb
+```
+
+you can copy `doc` folder to `docs` by invoking:
+
+```ruby
+TTY::File.copy_directory('doc', 'docs', context: ...)
+```
+
+The `context` needs to respond to `name` message and given it returns `foo` value the following directory gets created:
+
+```ruby
+# docs/
+#   subcommands/
+#     command.rb
+#   README.md
+#   foo.rb
+```
+
+If you only need to copy top level files use option `recursive: false`:
+
+```ruby
+TTY::File.copy_directory('doc', 'docs', recursive: false)
+```
+
+By passing `:exclude` option you can instruct the method to ignore any files including the given pattern:
 
-To compare files line by line in a system independent way use `diff`:
+```ruby
+TTY::File.copy_directory('doc', 'docs', exclude: 'subcommands')
+```
+
+### 2.7. create_dir
+
+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)
+```
+
+or a data structure describing the directory tree including any files with or without content:
+
+```ruby
+tree =
+  'app' => [
+    'README.md',
+    ['Gemfile', "gem 'tty-file'"],
+    'lib' => [
+      'cli.rb',
+      ['file_utils.rb', "require 'tty-file'"]
+    ]
+    'spec' => []
+  ]
+```
+
+```ruby
+TTY::File.create_dir(tree)
+# =>
+# app
+# app/README.md
+# app/Gemfile
+# app/lib
+# app/lib/cli.rb
+# app/lib/file_utils.rb
+# app/spec
+```
+
+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')
+```
+
+### 2.8. diff
+
+To compare files line by line in a system independent way use `diff`, or `diff_files`:
 
 ```ruby
 TTY::File.diff('file_a', 'file_b')
@@ -194,7 +296,7 @@ Equally, you can perform a comparison between a file content and a string conten
 TTY::File.diff('/path/to/file', 'some long text')
 ```
 
-### 2.6. download_file
+### 2.9. download_file
 
 To download a content from a given address and to save at a given relative location do:
 
@@ -217,7 +319,7 @@ TTY::File.download_file("https://gist.github.com/4701967", "doc/README.md", limi
 # => raises TTY::File::DownloadError
 ```
 
-### 2.7. inject_into_file
+### 2.10. inject_into_file
 
 Inject content into a file at a given location
 
@@ -229,15 +331,23 @@ 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.
 
-### 2.8. replace_in_file
+### 2.11. replace_in_file
 
-Replace content of a file matching condition.
+Replace content of a file matching condition by calling `replace_in_file` or `gsub_file`
 
 ```ruby
 TTY::File.replace_in_file 'filename.rb', /matching condition/, 'replacement'
 ```
 
-### 2.9. append_to_file
+The replacement content can be provided in a block
+
+```ruby
+TTY::File.gsub_file 'filename.rb', /matching condition/ do
+  'replacement'
+end
+```
+
+### 2.12. append_to_file
 
 Appends text to a file. You can provide the text as a second argument:
 
@@ -253,7 +363,7 @@ TTY::File.append_to_file('Gemfile') do
 end
 ```
 
-### 2.10. prepend_to_file
+### 2.13. prepend_to_file
 
 Prepends text to a file. You can provide the text as a second argument:
 
@@ -269,7 +379,7 @@ TTY::File.prepend_to_file('Gemfile') do
 end
 ```
 
-### 2.11. remove_file
+### 2.14. remove_file
 
 To remove a file do:
 
@@ -299,4 +409,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Copyright
 
-Copyright (c) 2016 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2016-2017 Piotr Murach. See LICENSE for further details.

data/lib/tty/file/create_file.rb

@@ -1,17 +1,28 @@
 # encoding: utf-8
 
+require 'forwardable'
+
 module TTY
   module File
     class CreateFile
+      extend Forwardable
+
       attr_reader :relative_path, :content, :options, :prompt
 
-      def initialize(relative_path, content, options = {})
+      def_delegators "@base", :log_status
+
+      def initialize(base, relative_path, content, options = {})
+        @base    = base
         @content = content
         @options = options
         @relative_path = convert_encoded_path(relative_path)
         @prompt  = TTY::Prompt.new
       end
 
+      def context
+        options[:context] || @base
+      end
+
       def exist?
         ::File.exist?(relative_path)
       end
@@ -20,10 +31,6 @@ module TTY
         ::File.binread(relative_path) == content
       end
 
-      def log_status(*args)
-        TTY::File.log_status(*args)
-      end
-
       # Create a file
       #
       # @api public
@@ -37,10 +44,6 @@ module TTY
 
       protected
 
-      def context
-        options[:context]
-      end
-
       def convert_encoded_path(filename)
         filename.gsub(/%(.*?)%/) do |match|
           method = $1.strip
@@ -69,8 +72,7 @@ module TTY
           end
         else
           log_status(:create, relative_path, options.fetch(:verbose, true), :green)
-          return if options[:noop]
-          yield
+          yield unless options[:noop]
         end
       end
 
@@ -81,8 +83,7 @@ module TTY
         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: 'd', name: 'diff, compare files line by line', value: :diff }
+          { key: 'q', name: 'quit, abort', value: :quit }
         ]
         answer = prompt.expand("Overwrite #{relative_path}?", choices)
         interpret_answer(answer)

data/lib/tty/file/digest_file.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'stringio'
+require 'openssl'
+
+module TTY
+  module File
+    class DigestFile
+      attr_reader :source
+
+      def initialize(source, mode, options)
+        @source = source
+        @digest = OpenSSL::Digest.new(mode)
+      end
+
+      def call
+        if ::FileTest.file?(source.to_s)
+          ::File.open(source, 'rb') { |f| checksum_io(f, @digest) }
+        else
+          non_file = source
+          if non_file.is_a?(String)
+            non_file = StringIO.new(non_file)
+          end
+          if non_file.is_a?(StringIO)
+            checksum_io(non_file, @digest)
+          end
+        end
+      end
+
+      def checksum_io(io, digest)
+        while (chunk = io.read(1024 * 8))
+          digest << chunk
+        end
+        digest.hexdigest
+      end
+    end # DigestFile
+  end # File
+end # TTY

data/lib/tty/file/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module File
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end # File
 end # TTY

data/lib/tty/file.rb

@@ -4,8 +4,10 @@ require 'pastel'
 require 'tty-prompt'
 require 'erb'
 require 'tempfile'
+require 'pathname'
 
 require 'tty/file/create_file'
+require 'tty/file/digest_file'
 require 'tty/file/download_file'
 require 'tty/file/differ'
 require 'tty/file/version'
@@ -16,6 +18,8 @@ module TTY
       module_function(method)
       private_class_method(method)
     end
+    # Invalid path erorr
+    InvalidPathError = Class.new(ArgumentError)
 
     # File permissions
     U_R = 0400
@@ -43,13 +47,14 @@ module TTY
     #   binary?('image.jpg') # => true
     #
     # @return [Boolean]
-    #   Returns `true` if the file is binary
+    #   Returns `true` if the file is binary, `false` otherwise
     #
     # @api public
     def binary?(relative_path)
       bytes = ::File.stat(relative_path).blksize
       bytes = 4096 if bytes > 4096
-      buffer = ::File.read(relative_path) || ''
+      buffer = ::File.read(relative_path, bytes, 0) || ''
+      buffer = buffer.force_encoding(Encoding.default_external)
       begin
         return buffer !~ /\A[\s[[:print:]]]*\z/m
       rescue ArgumentError => error
@@ -59,11 +64,40 @@ module TTY
     end
     module_function :binary?
 
+    # Create checksum for a file, io or string objects
+    #
+    # @param [File,IO,String] source
+    #   the source to generate checksum for
+    # @param [String] mode
+    # @param [Hash[Symbol]] options
+    # @option options [String] :noop
+    #   No operation
+    #
+    # @example
+    #   checksum_file('/path/to/file')
+    #
+    # @example
+    #   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)
+      digester.call unless options[:noop]
+    end
+    module_function :checksum_file
+
     # Change file permissions
     #
     # @param [String] relative_path
     # @param [Integer,String] permisssions
     # @param [Hash[Symbol]] options
+    # @option options [Symbol] :noop
+    # @option options [Symbol] :verbose
+    # @option options [Symbol] :force
     #
     # @example
     #   chmod('Gemfile', 0755)
@@ -75,7 +109,7 @@ module TTY
     #   chmod('Gemfile', 'u+x,g+x')
     #
     # @api public
-    def chmod(relative_path, permissions, options = {})
+    def chmod(relative_path, permissions, **options)
       mode = ::File.lstat(relative_path).mode
       if permissions.to_s =~ /\d+/
         mode = permissions
@@ -93,6 +127,58 @@ module TTY
     end
     module_function :chmod
 
+    # Create directory structure
+    #
+    # @param [String, Hash] destination
+    #   the path or data structure describing directory tree
+    #
+    # @example
+    #   create_directory('/path/to/dir')
+    #
+    # @example
+    #   tree =
+    #     'app' => [
+    #       'README.md',
+    #       ['Gemfile', "gem 'tty-file'"],
+    #       'lib' => [
+    #         'cli.rb',
+    #         ['file_utils.rb', "require 'tty-file'"]
+    #       ]
+    #       'spec' => []
+    #     ]
+    #
+    #   create_directory(tree)
+    #
+    # @return [void]
+    #
+    # @api public
+    def create_directory(destination, *args, **options)
+      parent = args.size.nonzero? ? args.pop : nil
+      if destination.is_a?(String)
+        destination = { destination => [] }
+      end
+
+      destination.each do |dir, files|
+        path = parent.nil? ? dir : ::File.join(parent, dir)
+        unless ::File.exist?(path)
+          ::FileUtils.mkdir_p(path)
+          log_status(:create, path, options.fetch(:verbose, true), :green)
+        end
+
+        files.each do |filename, contents|
+          if filename.respond_to?(:each_pair)
+            create_directory(filename, path, options)
+          else
+            create_file(::File.join(path, filename), contents, options)
+          end
+        end
+      end
+    end
+    module_function :create_directory
+
+    alias create_dir create_directory
+    module_function :create_dir
+
     # Create new file if doesn't exist
     #
     # @param [String] relative_path
@@ -111,21 +197,27 @@ module TTY
     #   end
     #
     # @api public
-    def create_file(relative_path, *args, &block)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-
+    def create_file(relative_path, *args, **options, &block)
       content = block_given? ? block[] : args.join
 
-      CreateFile.new(relative_path, content, options).call
+      CreateFile.new(self, relative_path, content, options).call
     end
     module_function :create_file
 
+    alias add_file create_file
+    module_function :add_file
+
     # Copy file from the relative source to the relative
     # destination running it through ERB.
     #
     # @example
     #   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
+    #
     # @param [Hash] options
     # @option options [Symbol] :context
     #   the binding to use for the template
@@ -138,13 +230,8 @@ module TTY
     #   If true log the action status to stdout
     #
     # @api public
-    def copy_file(source_path, *args, &block)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      dest_path = args.first || source_path.sub(/\.erb$/, '')
-
-      if ::File.directory?(dest_path)
-        dest_path = ::File.join(dest_path, ::File.basename(source_path))
-      end
+    def copy_file(source_path, *args, **options, &block)
+      dest_path = (args.first || source_path).sub(/\.erb$/, '')
 
       ctx = if (vars = options[:context])
               vars.instance_eval('binding')
@@ -152,7 +239,6 @@ module TTY
               instance_eval('binding')
             end
 
-      options[:context] ||= self
       create_file(dest_path, options) do
         template = ERB.new(::File.binread(source_path), nil, "-", "@output_buffer")
         content = template.result(ctx)
@@ -166,14 +252,77 @@ module TTY
 
     # Copy file metadata
     #
+    # @param [String] src_path
+    #   the source file path
+    # @param [String] dest_path
+    #   the destination file path
+    #
     # @api public
-    def copy_metadata(src_path, dest_path, options = {})
+    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)
     end
     module_function :copy_metadata
 
+    # Copy directory recursively from source to destination path
+    #
+    # Any files names wrapped within % sign will be expanded by
+    # executing corresponding method and inserting its value.
+    # Assuming the following directory structure:
+    #
+    #  app/
+    #    %name%.rb
+    #    command.rb.erb
+    #    README.md
+    #
+    #  Invoking:
+    #    copy_directory("app", "new_app")
+    #  The following directory structure should be created where
+    #  name resolves to 'cli' value:
+    #
+    #  new_app/
+    #    cli.rb
+    #    command.rb
+    #    README
+    #
+    # @param [Hash[Symbol]] options
+    # @option options [Symbol] :preserve
+    #   If true, the owner, group, permissions and modified time
+    #   are preserved on the copied file, defaults to false.
+    # @option options [Symbol] :recursive
+    #   If false, copies only top level files, defaults to true.
+    # @option options [Symbol] :exclude
+    #   A regex that specifies files to ignore when copying.
+    #
+    # @example
+    #   copy_directory("app", "new_app", recursive: false)
+    #   copy_directory("app", "new_app", exclude: /docs/)
+    #
+    # @api public
+    def copy_directory(source_path, *args, **options, &block)
+      check_path(source_path)
+      source = escape_glob_path(source_path)
+      dest_path = args.first || source
+      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, '.'))
+        file_dest = ::Pathname.new(dest).cleanpath.to_s
+
+        copy_file(file_source, file_dest, **options, &block)
+      end
+    end
+    module_function :copy_directory
+
+    alias copy_dir copy_directory
+    module_function :copy_dir
+
     # Diff files line by line
     #
     # @param [String] path_a
@@ -190,7 +339,7 @@ module TTY
     #   diff(file_a, file_b, format: :old)
     #
     # @api public
-    def diff(path_a, path_b, options = {})
+    def diff(path_a, path_b, **options)
       threshold = options[:threshold] || 10_000_000
       output = ''
 
@@ -224,7 +373,9 @@ module TTY
       output
     end
     module_function :diff
+
     alias diff_files diff
+    module_function :diff_files
 
     # Download the content from a given address and
     # save at the given relative destination. If block
@@ -249,8 +400,7 @@ module TTY
     #   end
     #
     # @api public
-    def download_file(uri, *args, &block)
-      options = args.last.is_a?(Hash) ? args.pop : {}
+    def download_file(uri, *args, **options, &block)
       dest_path = args.first || ::File.basename(uri)
 
       unless uri =~ %r{^https?\://}
@@ -261,13 +411,16 @@ module TTY
       content = DownloadFile.new(uri, dest_path, options).call
 
       if block_given?
-        content = (block.arity == 1 ? block[content] : block[])
+        content = (block.arity.nonzero? ? block[content] : block[])
       end
 
       create_file(dest_path, content, options)
     end
     module_function :download_file
 
+    alias get_file download_file
+    module_function :get_file
+
     # Prepend to a file
     #
     # @param [String] relative_path
@@ -283,8 +436,7 @@ module TTY
     #   end
     #
     # @api public
-    def prepend_to_file(relative_path, *args, &block)
-      options = args.last.is_a?(Hash) ? args.pop : {}
+    def prepend_to_file(relative_path, *args, **options, &block)
       log_status(:prepend, relative_path, options.fetch(:verbose, true), :green)
       options.merge!(before: /\A/, verbose: false)
       inject_into_file(relative_path, *(args << options), &block)
@@ -306,14 +458,15 @@ module TTY
     #   end
     #
     # @api public
-    def append_to_file(relative_path, *args, &block)
-      options = args.last.is_a?(Hash) ? args.pop : {}
+    def append_to_file(relative_path, *args, **options, &block)
       log_status(:append, relative_path, options.fetch(:verbose, true), :green)
       options.merge!(after: /\z/, verbose: false)
       inject_into_file(relative_path, *(args << options), &block)
     end
     module_function :append_to_file
+
     alias add_to_file append_to_file
+    module_function :add_to_file
 
     # Inject content into file at a given location
     #
@@ -341,9 +494,7 @@ module TTY
     #   end
     #
     # @api public
-    def inject_into_file(relative_path, *args, &block)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-
+    def inject_into_file(relative_path, *args, **options, &block)
       replacement = block_given? ? block[] : args.join
 
       flag, match = if options.key?(:after)
@@ -364,7 +515,9 @@ module TTY
       log_status(:inject, relative_path, options.fetch(:verbose, true), :green)
     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
     #
@@ -383,12 +536,9 @@ module TTY
     #   end
     #
     # @api public
-    def replace_in_file(relative_path, *args, &block)
+    def replace_in_file(relative_path, *args, **options, &block)
       check_path(relative_path)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-
-      contents = IO.read(relative_path)
-
+      contents    = IO.read(relative_path)
       replacement = (block ? block[] : args[1..-1].join).gsub('\0', '')
 
       log_status(:replace, relative_path, options.fetch(:verbose, true), :green)
@@ -400,13 +550,15 @@ module TTY
           find = args[0]
           raise "#{find.inspect} not found in #{relative_path}"
         end
-        ::File.open(relative_path, 'w') do |file|
+        ::File.open(relative_path, 'wb') do |file|
           file.write(contents)
         end
       end
     end
     module_function :replace_in_file
+
     alias gsub_file replace_in_file
+    module_function :gsub_file
 
     # Remove a file or a directory at specified relative path.
     #
@@ -422,9 +574,7 @@ module TTY
     #   remove_file 'doc/README.md'
     #
     # @api public
-    def remove_file(relative_path, *args)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-
+    def remove_file(relative_path, *args, **options)
       log_status(:remove, relative_path, options.fetch(:verbose, true), :red)
 
       return if options[:noop]
@@ -433,14 +583,32 @@ module TTY
     end
     module_function :remove_file
 
+    # Escape glob character in a path
+    #
+    # @param [String] path
+    #   the path to escape
+    #
+    # @example
+    #   escape_glob_path("foo[bar]") => "foo\\[bar\\]"
+    #
+    # @return [String]
+    #
+    # @api public
+    def escape_glob_path(path)
+      path.gsub(/[\\\{\}\[\]\*\?]/) { |x| "\\" + x }
+    end
+    module_function :escape_glob_path
+
     # Check if path exists
     #
+    # @param [String] path
+    #
     # @raise [ArgumentError]
     #
     # @api private
     def check_path(path)
       return if ::File.exist?(path)
-      raise ArgumentError, "File path #{path} does not exist."
+      raise InvalidPathError, "File path \"#{path}\" does not exist."
     end
     private_module_function :check_path
 
@@ -467,7 +635,7 @@ module TTY
       @output.print(message)
       @output.flush
     end
-    module_function :log_status
+    private_module_function :log_status
 
     # If content is not a path to a file, create a
     # tempfile and open it instead.

data/tty-file.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'pastel',     '~> 0.6.0'
-  spec.add_dependency 'tty-prompt', '~> 0.7.0'
-  spec.add_dependency 'diff-lcs',   '~> 1.2.5'
+  spec.add_dependency 'pastel',     '~> 0.7.0'
+  spec.add_dependency 'tty-prompt', '~> 0.10.0'
+  spec.add_dependency 'diff-lcs',   '~> 1.3.0'
 
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-file
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-06 00:00:00.000000000 Z
+date: 2017-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,7 @@ files:
 - lib/tty/file.rb
 - lib/tty/file/create_file.rb
 - lib/tty/file/differ.rb
+- lib/tty/file/digest_file.rb
 - lib/tty/file/download_file.rb
 - lib/tty/file/version.rb
 - tasks/console.rake