tty-file 0.6.0 → 0.10.0

data/lib/tty/file/compare_files.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "differ"
+
+module TTY
+  module File
+    class CompareFiles
+      extend Forwardable
+
+      def initialize(format: :unified, header: true, context_lines: 5,
+                     verbose: true, color: :green, noop: false, diff_colors: nil)
+        @format = format
+        @header = header
+        @context_lines = context_lines
+        @verbose = verbose
+        @color = color
+        @noop = noop
+        @diff_colors = diff_colors
+      end
+
+      # Compare files
+      #
+      # @api public
+      def call(file_a, file_b, file_a_path, file_b_path)
+        differ = Differ.new(format: @format, context_lines: @context_lines)
+        block_size = file_a.lstat.blksize
+        file_a_chunk = file_a.read(block_size)
+        file_b_chunk = file_b.read(block_size)
+        hunks = differ.(file_a_chunk, file_b_chunk)
+
+        return "" if file_a_chunk.empty? && file_b_chunk.empty?
+        return "No differences found\n" if hunks.empty?
+
+        output = []
+
+        if %i[unified context old].include?(@format) && @header
+          output << "#{differ.delete_char * 3} #{file_a_path}\n"
+          output << "#{differ.add_char * 3} #{file_b_path}"
+        end
+
+        output << "\n" unless hunks =~ /\A\n+@@/
+        output << hunks
+        while !file_a.eof? && !file_b.eof?
+          output << differ.(file_a.read(block_size), file_b.read(block_size))
+        end
+        color_diff_lines(output.join)
+      end
+
+      private
+
+      # @api private
+      def color_diff_lines(hunks)
+        return hunks unless @color && @format == :unified
+
+        newline = "\n"
+        hunks.lines.map do |line|
+          if matched = line.to_s.match(/^(\+[^+]*?)\n/)
+            @diff_colors[:green].(matched[1]) + newline
+          elsif matched = line.to_s.match(/^(\-[^-].*?)\n/)
+            @diff_colors[:red].(matched[1]) + newline
+          elsif matched = line.to_s.match(/^(@@.+?@@)\n/)
+            @diff_colors[:cyan].(matched[1]) + newline
+          else
+            line
+          end
+        end.join
+      end
+    end # CompareFiles
+  end # File
+end # TTY

data/lib/tty/file/create_file.rb

@@ -1,21 +1,26 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require "tty-prompt"
 
 module TTY
   module File
     class CreateFile
 
-      attr_reader :base, :relative_path, :content, :options, :prompt
+      attr_reader :base, :relative_path, :content, :prompt, :context
 
-      def initialize(base, relative_path, content, options = {})
+      def initialize(base, relative_path, content, context: nil, force: false,
+                     skip: false, verbose: true, noop: false, color: :green,
+                     quiet: true)
         @base    = base
         @content = content
-        @options = options
+        @context = context || @base
+        @force   = force
+        @skip    = skip
+        @noop    = noop
+        @verbose = verbose
+        @color   = color
         @relative_path = convert_encoded_path(relative_path)
-        @prompt  = TTY::Prompt.new
-      end
-
-      def context
-        options[:context] || @base
+        @prompt  = TTY::Prompt.new(quiet: quiet)
       end
 
       def exist?
@@ -32,7 +37,7 @@ module TTY
       def call
         detect_collision do
           FileUtils.mkdir_p(::File.dirname(relative_path))
-          ::File.open(relative_path, 'wb') { |f| f.write(content) }
+          ::File.open(relative_path, "wb") { |f| f.write(content) }
         end
         relative_path
       end
@@ -57,10 +62,10 @@ module TTY
         if exist?
           if identical?
             notify(:identical, :cyan)
-          elsif options[:force]
+          elsif @force
             notify(:force, :yellow)
-            yield unless options[:noop]
-          elsif options[:skip]
+            yield unless @noop
+          elsif @skip
             notify(:skip, :yellow)
           else
             notify(:collision, :red)
@@ -68,15 +73,16 @@ module TTY
           end
         else
           notify(:create, :green)
-          yield unless options[:noop]
+          yield unless @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))
+                      verbose: @verbose, color: @color ? color : false)
       end
 
       # Display conflict resolution menu and gather answer
@@ -84,14 +90,24 @@ module TTY
       # @api private
       def file_collision(relative_path, content)
         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: "y", name: "yes, overwrite", value: :yes },
+          { key: "d", name: "diff, compare files", value: :diff },
+          { key: "n", name: "no, do not overwrite", value: :no },
+          { key: "q", name: "quit, abort", value: :quit }
         ]
-        answer = prompt.expand("Overwrite #{relative_path}?", choices)
+        while (answer = prompt.expand("Overwrite #{relative_path}?", choices)) == :diff do
+          show_diff
+        end
         interpret_answer(answer)
       end
 
+      # Display difference between old and new file
+      #
+      # @api private
+      def show_diff
+        print base.__send__(:diff_files, relative_path, content, verbose: @verbose)
+      end
+
       # @api private
       def interpret_answer(answer)
         case answer

data/lib/tty/file/differ.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'diff/lcs'
-require 'diff/lcs/hunk'
-require 'enumerator'
+require "diff/lcs"
+require "diff/lcs/hunk"
 
 module TTY
   module File
@@ -10,11 +9,9 @@ module TTY
       # Create a Differ
       #
       # @api public
-      def initialize(string_a, string_b, options = {})
-        @string_a      = string_a
-        @string_b      = string_b
-        @format        = options.fetch(:format, :unified)
-        @context_lines = options.fetch(:context_lines, 3)
+      def initialize(format: :unified, context_lines: 3)
+        @format = format
+        @context_lines = context_lines
       end
 
       # Find character difference between two strings
@@ -24,29 +21,53 @@ module TTY
       #   difference found
       #
       # @api public
-      def call
-        diffs  = Diff::LCS.diff(string_a_lines, string_b_lines)
-        return '' if diffs.empty?
-        hunks  = extract_hunks(diffs)
+      def call(string_a, string_b)
+        string_a_lines = convert_to_lines(string_a)
+        string_b_lines = convert_to_lines(string_b)
+        diffs = Diff::LCS.diff(string_a_lines, string_b_lines)
+        return "" if diffs.empty?
+
+        hunks = extract_hunks(diffs, string_a_lines, string_b_lines)
         format_hunks(hunks)
       end
 
-      private
-
-      def convert_to_lines(string)
-        string.split(/\n/).map(&:chomp)
+      # Diff add char
+      #
+      # @api public
+      def add_char
+        case @format
+        when :old
+          ">"
+        when :unified
+          "+"
+        else
+          "*"
+        end
       end
 
-      def string_a_lines
-        convert_to_lines(@string_a)
+      # Diff delete char
+      #
+      # @api public
+      def delete_char
+        case @format
+        when :old
+          "<"
+        when :unified
+          "-"
+        else
+          "*"
+        end
       end
 
-      def string_b_lines
-        convert_to_lines(@string_b)
+      private
+
+      # @api private
+      def convert_to_lines(string)
+        string.split(/\n/).map(&:chomp)
       end
 
-      # @api public
-      def extract_hunks(diffs)
+      # @api private
+      def extract_hunks(diffs, string_a_lines, string_b_lines)
         file_length_difference = 0
 
         diffs.map do |piece|
@@ -57,9 +78,9 @@ module TTY
         end
       end
 
-      # @api public
+      # @api private
       def format_hunks(hunks)
-        output = ""
+        output = []
         hunks.each_cons(2) do |prev_hunk, current_hunk|
           begin
             if current_hunk.overlaps?(prev_hunk)
@@ -72,6 +93,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,21 +1,21 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'stringio'
-require 'openssl'
+require "stringio"
+require "openssl"
 
 module TTY
   module File
     class DigestFile
       attr_reader :source
 
-      def initialize(source, mode, options)
+      def initialize(source, mode)
         @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) }
+          ::File.open(source, "rb") { |f| checksum_io(f, @digest) }
         else
           non_file = source
           if non_file.is_a?(String)

data/lib/tty/file/download_file.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'uri'
-require 'net/http'
+require "uri"
+require "net/http"
 
 module TTY
   module File
@@ -14,10 +14,10 @@ module TTY
 
       # @options
       #
-      def initialize(url, dest_path, options = {})
+      def initialize(url, dest_path, limit: nil)
         @uri       = URI.parse(url)
         @dest_path = dest_path
-        @limit     = options.fetch(:limit) { DEFAULT_REDIRECTS }
+        @limit     = limit || DEFAULT_REDIRECTS
       end
 
       # Download a file
@@ -31,11 +31,11 @@ module TTY
 
       # @api private
       def download(uri, path, limit)
-        raise DownloadError, 'Redirect limit reached!' if limit.zero?
-        content = ''
+        raise DownloadError, "Redirect limit reached!" if limit.zero?
+        content = []
 
         Net::HTTP.start(uri.host, uri.port,
-                        use_ssl: uri.scheme == 'https') do |http|
+                        use_ssl: uri.scheme == "https") do |http|
           http.request_get(uri.request_uri) do |response|
             case response
             when Net::HTTPSuccess
@@ -43,13 +43,13 @@ module TTY
                 content << seg
               end
             when Net::HTTPRedirection
-              download(URI.parse(response['location']), path, limit - 1)
+              download(URI.parse(response["location"]), path, limit - 1)
             else
               response.error!
             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.10.0"
   end # File
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-file
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-05-21 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -16,82 +16,68 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '0.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
@@ -100,49 +86,46 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
 description: File manipulation utility methods.
 email:
-- ''
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- appveyor.yml
-- bin/console
-- bin/setup
 - lib/tty-file.rb
 - lib/tty/file.rb
+- lib/tty/file/compare_files.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/read_backward_file.rb
 - lib/tty/file/version.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-file.gemspec
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-file/issues
+  changelog_uri: https://github.com/piotrmurach/tty-file/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-file
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/tty-file
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -158,8 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: File manipulation utility methods.