tty-file 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b396379259eca3c11fd09a27eb97b9a777ae747
-  data.tar.gz: c6094ec23477f0ab1e36af36f507d0b36f110ef1
+  metadata.gz: 23702ac1a40d811c8c23a524265585b0f6fecb26
+  data.tar.gz: fdc10c2af852b2c6d935d81439e90c54eaa2550b
 SHA512:
-  metadata.gz: 45cbe892f8379b9a81f3e220aa874a6d49a06097616c826f917972663c681e4faf72b0c06c28727716eda35613d51e5669799f98bcf7e075fe742b02396e865c
-  data.tar.gz: 087d20a6a7100e30c5c419a80534f51f88ce954a69dbf76f3a687e82d52dddd6b54cc8472731ee8830d9cfdbb58efeb7e550dc04e131728a1a9e7adece58089d
+  metadata.gz: 805acf272babab1d6dd610e500502573a2d85ab0c1ed738cde3974fe03f4134b5a447314c8f44ed7da2f8ed26a88f0060ea6547bae8f3c40a177a9ea99ab0639
+  data.tar.gz: 59f161b5ba098f482a2de30a1cbbda0dd42bf63509f0d7118e37c36af0e94f31a0c73cefb8a0854213259126c4d5df9e903c54f7e94aeb91d8399acd3fdcd907

data/.travis.yml

@@ -8,17 +8,15 @@ rvm:
   - 2.1.10
   - 2.2.5
   - 2.3.1
-  - 2.4.0
+  - 2.4.1
   - ruby-head
   - jruby-9.1.1.0
-  - rbx-3
 env:
   global:
     - JRUBY_OPTS=''
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: rbx-3
     - rvm: jruby-9.1.1.0
   fast_finish: true
 branches:

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change log
 
+## [v0.4.0] - 2017-09-16
+
+### Added
+* Add tail_file for reading a given number of lines from end of a file
+
+### Changed
+* Change api calls to accept :color option for disabling/coloring log status
+* Update tty-prompt dependency
+
+### Fixed
+* Fix #log_status to properly handle wrapping of keywords in color
+* Fix #binary? to work correctly on Windows
+
 ## [v0.3.0] - 2017-03-26
 
 ### Changed
@@ -32,6 +45,7 @@
 
 * Initial implementation and release
 
+[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
 [v0.2.1]: https://github.com/piotrmurach/tty-file/compare/v0.2.0...v0.2.1
 [v0.2.0]: https://github.com/piotrmurach/tty-file/compare/v0.1.0...v0.2.0

data/README.md

@@ -1,6 +1,8 @@
 # TTY::File [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+
 [![Gem Version](https://badge.fury.io/rb/tty-file.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/piotrmurach/tty-file.svg?branch=master)][travis]
+[![Build status](https://ci.appveyor.com/api/projects/status/og69rn550s4mt1q3?svg=true)][appveyor]
 [![Code Climate](https://codeclimate.com/github/piotrmurach/tty-file/badges/gpa.svg)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-file/badge.svg)][coverage]
 [![Inline docs](http://inch-ci.org/github/piotrmurach/tty-file.svg?branch=master)][inchpages]
@@ -8,6 +10,7 @@
 [gitter]: https://gitter.im/piotrmurach/tty
 [gem]: http://badge.fury.io/rb/tty-file
 [travis]: http://travis-ci.org/piotrmurach/tty-file
+[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-file
 [codeclimate]: https://codeclimate.com/github/piotrmurach/tty-file
 [coverage]: https://coveralls.io/github/piotrmurach/tty-file
 [inchpages]: http://inch-ci.org/github/piotrmurach/tty-file
@@ -52,6 +55,7 @@ Or install it yourself as:
   * [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)
+  * [2.15. tail_file](#215-tail_file)
 
 ## 1. Usage
 
@@ -323,6 +327,12 @@ TTY::File.download_file("https://gist.github.com/4701967", "doc/README.md", limi
 
 Inject content into a file at a given location
 
+```ruby
+TTY::File.inject_into_file 'filename.rb', "text to add", after: "Code below this line\n"
+```
+
+or using a block
+
 ```ruby
 TTY::File.inject_into_file 'filename.rb', after: "Code below this line\n" do
   "text to add"
@@ -393,6 +403,29 @@ You can also pass in `:force` to remove file ignoring any errors:
 TTY::File.remove_file 'doc/README.md', force: true
 ```
 
+### 2.15. tail_file
+
+To read the last 10 lines from a file do:
+
+```ruby
+TTY::File.tail_file 'doc/README.md'
+# => ['## Copyright', 'Copyright (c) 2016-2017', ...]
+```
+
+You can also pass a block:
+
+```ruby
+TTY::File.tail_file('doc/README.md') do |line|
+  puts line
+end
+```
+
+To change how many lines are read pass a second argument:
+
+```ruby
+TTY::File.tail_file('doc/README.md', 15)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/appveyor.yml

@@ -0,0 +1,25 @@
+---
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - ruby --version
+  - gem --version
+  - bundle install
+build: off
+test_script:
+  - bundle exec rake ci
+environment:
+  matrix:
+    - ruby_version: "193"
+    - ruby_version: "200"
+    - ruby_version: "200-x64"
+    - ruby_version: "21"
+    - ruby_version: "21-x64"
+    - ruby_version: "22"
+    - ruby_version: "22-x64"
+    - ruby_version: "23"
+    - ruby_version: "23-x64"
+    - ruby_version: "24"
+    - ruby_version: "24-x64"
+matrix:
+  allow_failures:
+    - ruby_version: "193"

data/lib/tty/file.rb

@@ -10,6 +10,7 @@ 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
@@ -51,8 +52,8 @@ module TTY
     #
     # @api public
     def binary?(relative_path)
-      bytes = ::File.stat(relative_path).blksize
-      bytes = 4096 if bytes > 4096
+      bytes = ::File.new(relative_path).size
+      bytes = 2**12 if bytes > 2**12
       buffer = ::File.read(relative_path, bytes, 0) || ''
       buffer = buffer.force_encoding(Encoding.default_external)
       begin
@@ -122,7 +123,8 @@ module TTY
           end
         end
       end
-      log_status(:chmod, relative_path, options.fetch(:verbose, true), :green)
+      log_status(:chmod, relative_path, options.fetch(:verbose, true),
+                                        options.fetch(:color, :green))
       ::FileUtils.chmod_R(mode, relative_path) unless options[:noop]
     end
     module_function :chmod
@@ -162,7 +164,8 @@ module TTY
         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)
+          log_status(:create, path, options.fetch(:verbose, true),
+                                    options.fetch(:color, :green))
         end
 
         files.each do |filename, contents|
@@ -359,7 +362,7 @@ module TTY
           end
 
           log_status(:diff, "#{file_a.path} - #{file_b.path}",
-                     options.fetch(:verbose, true), :green)
+                     options.fetch(:verbose, true), options.fetch(:color, :green))
           return output if options[:noop]
 
           block_size = file_a.lstat.blksize
@@ -437,7 +440,8 @@ module TTY
     #
     # @api public
     def prepend_to_file(relative_path, *args, **options, &block)
-      log_status(:prepend, relative_path, options.fetch(:verbose, true), :green)
+      log_status(:prepend, relative_path, options.fetch(:verbose, true),
+                                          options.fetch(:color, :green))
       options.merge!(before: /\A/, verbose: false)
       inject_into_file(relative_path, *(args << options), &block)
     end
@@ -459,7 +463,8 @@ module TTY
     #
     # @api public
     def append_to_file(relative_path, *args, **options, &block)
-      log_status(:append, relative_path, options.fetch(:verbose, true), :green)
+      log_status(:append, relative_path, options.fetch(:verbose, true),
+                                         options.fetch(:color, :green))
       options.merge!(after: /\z/, verbose: false)
       inject_into_file(relative_path, *(args << options), &block)
     end
@@ -512,7 +517,8 @@ module TTY
 
       replace_in_file(relative_path, /#{match}/, content, options.merge(verbose: false))
 
-      log_status(:inject, relative_path, options.fetch(:verbose, true), :green)
+      log_status(:inject, relative_path, options.fetch(:verbose, true),
+                                         options.fetch(:color, :green))
     end
     module_function :inject_into_file
 
@@ -541,7 +547,8 @@ module TTY
       contents    = IO.read(relative_path)
       replacement = (block ? block[] : args[1..-1].join).gsub('\0', '')
 
-      log_status(:replace, relative_path, options.fetch(:verbose, true), :green)
+      log_status(:replace, relative_path, options.fetch(:verbose, true),
+                                          options.fetch(:color, :green))
 
       return if options[:noop]
 
@@ -575,7 +582,8 @@ module TTY
     #
     # @api public
     def remove_file(relative_path, *args, **options)
-      log_status(:remove, relative_path, options.fetch(:verbose, true), :red)
+      log_status(:remove, relative_path, options.fetch(:verbose, true),
+                                         options.fetch(:color, :red))
 
       return if options[:noop]
 
@@ -583,6 +591,51 @@ module TTY
     end
     module_function :remove_file
 
+    # Provide the last number of lines from a file
+    #
+    # @param [String] relative_path
+    #   the relative path to a file
+    #
+    # @param [Integer] num_lines
+    #   the number of lines to return from file
+    #
+    # @example
+    #   tail_file 'filename'
+    #   # =>  ['line 19', 'line20', ... ]
+    #
+    # @example
+    #   tail_file 'filename', 15
+    #   # =>  ['line 19', 'line20', ... ]
+    #
+    # @return [Array[String]]
+    #
+    # @api public
+    def tail_file(relative_path, num_lines = 10, **options, &block)
+      file       = ::File.open(relative_path)
+      chunk_size = options.fetch(:chunk_size, 512)
+      line_sep   = $/
+      lines      = []
+      newline_count = 0
+
+      ReadBackwardFile.new(file, chunk_size).each_chunk do |chunk|
+        # look for newline index counting from right of chunk
+        while (nl_index = chunk.rindex(line_sep, (nl_index || chunk.size) - 1))
+          newline_count += 1
+          break if newline_count > num_lines || nl_index.zero?
+        end
+
+        if newline_count > num_lines
+          lines.insert(0, chunk[(nl_index + 1)..-1])
+          break
+        else
+          lines.insert(0, chunk)
+        end
+      end
+
+      lines.join.split(line_sep).each(&block).to_a
+    end
+    module_function :tail_file
+
     # Escape glob character in a path
     #
     # @param [String] path
@@ -627,9 +680,12 @@ module TTY
       return unless verbose
 
       cmd = cmd.to_s.rjust(12)
-      cmd = decorate(cmd, color) if color
+      if color
+        i = cmd.index(/[a-z]/)
+        cmd = cmd[0...i] + decorate(cmd[i..-1], color)
+      end
 
-      message = "#{cmd} #{message}"
+      message = "#{cmd}  #{message}"
       message += "\n" unless message.end_with?("\n")
 
       @output.print(message)

data/lib/tty/file/create_file.rb

@@ -1,15 +1,10 @@
 # encoding: utf-8
 
-require 'forwardable'
-
 module TTY
   module File
     class CreateFile
-      extend Forwardable
-
-      attr_reader :relative_path, :content, :options, :prompt
 
-      def_delegators "@base", :log_status
+      attr_reader :base, :relative_path, :content, :options, :prompt
 
       def initialize(base, relative_path, content, options = {})
         @base    = base
@@ -61,22 +56,29 @@ module TTY
       def detect_collision
         if exist?
           if identical?
-            log_status(:identical, relative_path, options.fetch(:verbose, true), :blue)
+            notify(:identical, :blue)
           elsif options[:force]
-            log_status(:force, relative_path, options.fetch(:verbose, true), :yellow)
+            notify(:force, :yellow)
             yield unless options[:noop]
           elsif options[:skip]
-            log_status(:skip, relative_path, options.fetch(:verbose, true), :yellow)
+            notify(:skip, :yellow)
           else
-            log_status(:collision, relative_path, options.fetch(:verbose, true), :red)
+            notify(:collision, :red)
             yield if file_collision(relative_path, content)
           end
         else
-          log_status(:create, relative_path, options.fetch(:verbose, true), :green)
+          notify(:create, :green)
           yield unless options[:noop]
         end
       end
 
+      # Notify console about performed action
+      # @api private
+      def notify(name, color)
+        base.__send__(:log_status, name, relative_path,
+                      options.fetch(:verbose, true), options.fetch(:color, color))
+      end
+
       # Display conflict resolution menu and gather answer
       #
       # @api private

data/lib/tty/file/read_backward_file.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+class ReadBackwardFile
+  attr_reader :file,
+              :chunk_size
+
+  # Create a ReadBackwardFile
+  #
+  # @param [File] file
+  #   the file to read backward from
+  # @param [Integer] chunk_size
+  #   the chunk size used to step through the file backwards
+  #
+  # @api public
+  def initialize(file, chunk_size = 512)
+    @file        = file
+    @chunk_size  = chunk_size
+    @file_size   = ::File.stat(file).size
+  end
+
+  # Read file in chunks
+  #
+  # @yield [String]
+  #   the chunk from file content
+  #
+  # @api public
+  def each_chunk
+    file.seek(0, IO::SEEK_END)
+    while file.tell > 0
+      if file.tell < @chunk_size # don't read beyond file size
+        @chunk_size = file.tell
+      end
+      file.seek(-@chunk_size, IO::SEEK_CUR)
+      chunk = file.read(@chunk_size)
+      yield(chunk)
+      file.seek(-@chunk_size, IO::SEEK_CUR)
+    end
+  end
+end # ReadBackwardFile

data/lib/tty/file/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module File
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end # File
 end # TTY

data/tty-file.gemspec

@@ -19,11 +19,11 @@ 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.7.0'
-  spec.add_dependency 'tty-prompt', '~> 0.12.0'
+  spec.add_dependency 'pastel',     '~> 0.7.1'
+  spec.add_dependency 'tty-prompt', '~> 0.13.2'
   spec.add_dependency 'diff-lcs',   '~> 1.3.0'
 
-  spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
+  spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-file
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-26 00:00:00.000000000 Z
+date: 2017-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.2
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -56,22 +56,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +110,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- appveyor.yml
 - bin/console
 - bin/setup
 - lib/tty-file.rb
@@ -124,6 +119,7 @@ files:
 - lib/tty/file/differ.rb
 - lib/tty/file/digest_file.rb
 - lib/tty/file/download_file.rb
+- lib/tty/file/read_backward_file.rb
 - lib/tty/file/version.rb
 - tasks/console.rake
 - tasks/coverage.rake