tty-file 0.1.0

data/lib/tty/file/create_file.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+module TTY
+  module File
+    class CreateFile
+      attr_reader :relative_path, :content, :options, :prompt
+
+      def initialize(relative_path, content, options = {})
+        @content = content
+        @options = options
+        @relative_path = convert_encoded_path(relative_path)
+        @prompt  = TTY::Prompt.new
+      end
+
+      def exist?
+        ::File.exist?(relative_path)
+      end
+
+      def identical?
+        ::File.binread(relative_path) == content
+      end
+
+      def log_status(*args)
+        TTY::File.log_status(*args)
+      end
+
+      # Create a file
+      #
+      # @api public
+      def call
+        detect_collision do
+          FileUtils.mkdir_p(::File.dirname(relative_path))
+          ::File.open(relative_path, 'wb') { |f| f.write(content) }
+        end
+        relative_path
+      end
+
+      protected
+
+      def context
+        options[:context]
+      end
+
+      def convert_encoded_path(filename)
+        filename.gsub(/%(.*?)%/) do |match|
+          method = $1.strip
+          if context.respond_to?(method, true)
+            context.public_send(method)
+          else
+            match
+          end
+        end
+      end
+
+      # Check if file already exists and ask for user input on collision
+      #
+      # @api private
+      def detect_collision
+        if exist?
+          if identical?
+            log_status(:identical, relative_path, options.fetch(:verbose, true), :blue)
+          elsif options[:force]
+            log_status(:force, relative_path, options.fetch(:verbose, true), :yellow)
+          elsif options[:skip]
+            log_status(:skip, relative_path, options.fetch(:verbose, true), :yellow)
+          else
+            log_status(:collision, relative_path, options.fetch(:verbose, true), :red)
+            yield if file_collision(relative_path, content)
+          end
+        else
+          log_status(:create, relative_path, options.fetch(:verbose, true), :green)
+          return if options[:noop]
+          yield
+        end
+      end
+
+      # Display conflict resolution menu and gather answer
+      #
+      # @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: 'd', name: 'diff, compare files line by line', value: :diff }
+        ]
+        answer = prompt.expand("Overwrite #{relative_path}?", choices)
+        interpret_answer(answer)
+      end
+
+      # @api private
+      def interpret_answer(answer)
+        case answer
+        when :yes
+          true
+        when :no
+          false
+        when :quit
+          abort
+        end
+      end
+    end # CreateFile
+  end # File
+end # TTY

data/lib/tty/file/differ.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+require 'diff/lcs'
+require 'diff/lcs/hunk'
+require 'enumerator'
+
+module TTY
+  module File
+    class Differ
+      # 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)
+      end
+
+      # Find character difference between two strings
+      #
+      # @return [String]
+      #   the difference between content or empty if no
+      #   difference found
+      #
+      # @api public
+      def call
+        diffs  = Diff::LCS.diff(string_a_lines, string_b_lines)
+        return '' if diffs.empty?
+        hunks  = extract_hunks(diffs)
+        format_hunks(hunks)
+      end
+
+      private
+
+      def convert_to_lines(string)
+        string.split(/\n/).map(&:chomp)
+      end
+
+      def string_a_lines
+        convert_to_lines(@string_a)
+      end
+
+      def string_b_lines
+        convert_to_lines(@string_b)
+      end
+
+      # @api public
+      def extract_hunks(diffs)
+        file_length_difference = 0
+
+        diffs.map do |piece|
+          hunk = Diff::LCS::Hunk.new(string_a_lines, string_b_lines, piece,
+                                     @context_lines, file_length_difference)
+          file_length_difference = hunk.file_length_difference
+          hunk
+        end
+      end
+
+      # @api public
+      def format_hunks(hunks)
+        output = ""
+        hunks.each_cons(2) do |prev_hunk, current_hunk|
+          begin
+            if current_hunk.overlaps?(prev_hunk)
+              current_hunk.unshift(prev_hunk)
+            else
+              output << prev_hunk.diff(@format).to_s
+            end
+          ensure
+            output << "\n"
+          end
+        end
+        output << hunks.last.diff(@format) << "\n" if hunks.last
+      end
+    end # Differ
+  end # File
+end # TTY

data/lib/tty/file/download_file.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'uri'
+require 'net/http'
+
+module TTY
+  module File
+    DownloadError = Class.new(StandardError)
+
+    class DownloadFile
+      attr_reader :uri, :dest_path, :limit
+
+      DEFAULT_REDIRECTS = 3
+
+      # @options
+      #
+      def initialize(url, dest_path, options = {})
+        @uri       = URI.parse(url)
+        @dest_path = dest_path
+        @limit     = options.fetch(:limit) { DEFAULT_REDIRECTS }
+      end
+
+      # Download a file
+      #
+      # @api public
+      def call
+        download(uri, dest_path, limit)
+      end
+
+      private
+
+      # @api private
+      def download(uri, path, limit)
+        raise DownloadError, 'Redirect limit reached!' if limit.zero?
+        content = ''
+
+        Net::HTTP.start(uri.host, uri.port,
+                        use_ssl: uri.scheme == 'https') do |http|
+          http.request_get(uri.path) do |response|
+            case response
+            when Net::HTTPSuccess
+              response.read_body do |seg|
+                content << seg
+              end
+            when Net::HTTPRedirection
+              download(URI.parse(response['location']), path, limit - 1)
+            else
+              response.error!
+            end
+          end
+        end
+        content
+      end
+    end # DownloadFile
+  end # File
+end # TTY

data/lib/tty/file/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module TTY
+  module File
+    VERSION = "0.1.0"
+  end # File
+end # TTY

data/tasks/console.rake

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../../lib/tty-file')
+  ARGV.clear
+  IRB.start
+end

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Measure code coverage'
+task :coverage do
+  begin
+    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
+    Rake::Task['spec'].invoke
+  ensure
+    ENV['COVERAGE'] = original
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

data/tty-file.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tty/file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tty-file"
+  spec.version       = TTY::File::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = [""]
+
+  spec.summary       = %q{File manipulation utility methods}
+  spec.description   = %q{File manipulation utility methods}
+  spec.homepage      = "https://piotrmurach.github.io/tty"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: tty-file
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: File manipulation utility methods
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tty-file.rb
+- lib/tty/file.rb
+- lib/tty/file/create_file.rb
+- lib/tty/file/differ.rb
+- lib/tty/file/download_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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: File manipulation utility methods
+test_files: []