ruby-edit 0.1.0

data/lib/ruby_edit/apply_prompt.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'ruby_edit/command'
+
+module RubyEdit
+  class ApplyPrompt < RubyEdit::Command
+    def continue?
+      prompt.yes?('Do you want to apply these changes?')
+    end
+  end
+end
+

data/lib/ruby_edit/cli.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module RubyEdit
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    desc 'version', 'ruby-edit version'
+    def version
+      require_relative 'version'
+      puts "v#{RubyEdit::VERSION}"
+    end
+    map %w[--version -v] => :version
+
+    desc 'grep', 'search for an expression in your directory'
+    method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
+    method_option :expression, aliases: %w[-e --expression], type: :string,
+                               desc: 'the grep expression'
+    method_option :path, aliases: %w[-p --path], type: :string, desc: 'the path you want to search'
+    def grep(*)
+      if options[:help]
+        invoke :help, ['grep']
+      else
+        require_relative 'commands/grep'
+        RubyEdit::Commands::Grep.new(options).execute
+      end
+    end
+
+    map %w[--grep -g] => :grep
+
+    desc 'configure', 'set and read your settings'
+    method_option :help, aliases: '-h', type: :boolean, desc: 'Display useage information'
+    method_option :editor, aliases: %w[-e --editor], type: :string,
+                           desc: 'Set or view your default text editor'
+    def configure(*)
+      if options[:help]
+        invoke :help, ['configure']
+      else
+        require_relative 'commands/configure'
+        RubyEdit::Commands::Configure.new(options).execute
+      end
+    end
+
+    map %w[--configure -c] => :configure
+
+    desc 'edit', '[Default] Perform a grep and edit the changes in one file'
+    method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
+    method_option :expression, aliases: %w[-e --expression], type: :string,
+                               desc: 'the grep expression'
+    method_option :path, aliases: %w[-p --path], type: :string, desc: 'the path you want to search'
+
+    def edit(*)
+      if options[:help]
+        invoke :help, ['edit']
+      elsif options.empty?
+        invoke :help
+      else
+        require_relative 'commands/edit'
+        RubyEdit::Commands::Edit.new(options).execute
+      end
+    end
+
+    default_task :edit
+  end
+end
+

data/lib/ruby_edit/command.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module RubyEdit
+  class Command
+    extend Forwardable
+
+    def_delegators :command, :run
+
+    # Execute this command
+    #
+    # @api public
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "#{self.class}##{__method__} must be implemented"
+      )
+    end
+
+    # The external commands runner
+    #
+    # @see http://www.rubydoc.info/gems/tty-command
+    #
+    # @api public
+    def command(**options)
+      require 'tty-command'
+      TTY::Command.new(options)
+    end
+
+    # The cursor movement
+    #
+    # @see http://www.rubydoc.info/gems/tty-cursor
+    #
+    # @api public
+    def cursor
+      require 'tty-cursor'
+      TTY::Cursor
+    end
+
+    # Open a file or text in the user's preferred editor
+    #
+    # @see http://www.rubydoc.info/gems/tty-editor
+    #
+    # @api public
+    def editor
+      require 'tty-editor'
+      TTY::Editor
+    end
+
+    # File manipulation utility methods
+    #
+    # @see http://www.rubydoc.info/gems/tty-file
+    #
+    # @api public
+    def generator
+      require 'tty-file'
+      TTY::File
+    end
+
+    # Terminal output paging
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def pager(**options)
+      require 'tty-pager'
+      TTY::Pager.new(options)
+    end
+
+    # Terminal platform and OS properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def platform
+      require 'tty-platform'
+      TTY::Platform.new
+    end
+
+    # The interactive prompt
+    #
+    # @see http://www.rubydoc.info/gems/tty-prompt
+    #
+    # @api public
+    def prompt(**options)
+      require 'tty-prompt'
+      TTY::Prompt.new(options)
+    end
+
+    # Get terminal screen properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-screen
+    #
+    # @api public
+    def screen
+      require 'tty-screen'
+      TTY::Screen
+    end
+
+    # The unix which utility
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def which(*args)
+      require 'tty-which'
+      TTY::Which.which(*args)
+    end
+
+    # Check if executable exists
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def exec_exist?(*args)
+      require 'tty-which'
+      TTY::Which.exist?(*args)
+    end
+  end
+end
+

data/lib/ruby_edit/commands/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/ruby_edit/commands/configure.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'ruby_edit'
+
+module RubyEdit
+  module Commands
+    class Configure
+      def initialize(options)
+        @options = options
+      end
+
+      def execute(output: $stdout)
+        # This may need to be made dynamic if more configuration options are added
+        if editor == 'editor'
+          output.puts RubyEdit.config.editor
+        else
+          RubyEdit.config.editor = editor
+          output.puts "Editor changed to #{editor}"
+        end
+      end
+
+      private
+
+      def editor
+        @options[:editor]
+      end
+    end
+  end
+end
+

data/lib/ruby_edit/commands/edit.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'ruby_edit'
+require 'ruby_edit/apply_prompt'
+require 'ruby_edit/editor'
+require 'ruby_edit/grep'
+require 'ruby_edit/source_file'
+require 'ruby_edit/writer'
+
+module RubyEdit
+  module Commands
+    # TODO: Write an integration spec for this
+    class Edit
+      def initialize(options)
+        @grep       = RubyEdit::Grep.new(options)
+        @sourcefile = RubyEdit::SourceFile.new
+        @editor     = RubyEdit::Editor.new
+        @output     = $stdout
+        @errors     = $stderr
+      end
+
+      def execute
+        grep_search
+        populate_sourcefile
+        edit_file
+        apply_changes if apply_changes?
+        delete_sourcefile
+      end
+
+      private
+
+      def grep_search
+        @grep.search(output: @output, errors: @errors)
+      end
+
+      def populate_sourcefile
+        @sourcefile.populate(@grep.result.out)
+      end
+
+      def edit_file
+        @editor.edit_sourcefile
+      end
+
+      def apply_changes?
+        RubyEdit::ApplyPrompt.new.continue?
+      end
+
+      def apply_changes
+        RubyEdit::Writer.new.write
+      end
+
+      def delete_sourcefile
+        @sourcefile.delete
+      end
+    end
+  end
+end
+

data/lib/ruby_edit/commands/grep.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'ruby_edit/grep'
+
+module RubyEdit
+  module Commands
+    class Grep
+      def initialize(options)
+        @options = options
+        @grep = RubyEdit::Grep.new(@options)
+      end
+
+      def execute(output: $stdout)
+        @result = @grep.search
+        output.puts 'OK'
+      end
+    end
+  end
+end
+

data/lib/ruby_edit/configuration.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'tty/config'
+
+module RubyEdit
+  class Configuration
+    LOCATION = File.expand_path('../../configuration', __dir__)
+
+    def initialize
+      @config          = TTY::Config.new
+      @config.filename = LOCATION
+      @config.read("#{LOCATION}.yml")
+    end
+
+    def editor
+      @config.fetch(:editor).to_sym
+    end
+
+    def editor=(editor)
+      @config.set(:editor, value: editor.to_s)
+      write
+    end
+
+    def reset_defaults
+      @config.set(:editor, value: 'vim')
+      write
+    end
+
+    private
+
+    def write
+      @config.write
+    end
+  end
+end
+

data/lib/ruby_edit/editor.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'ruby_edit/command'
+
+module RubyEdit
+  class Editor < RubyEdit::Command
+    def initialize
+      @config = RubyEdit.config
+    end
+
+    def edit_sourcefile
+      editor.open RubyEdit::SOURCE_FILE_LOCATION, command: @config.editor
+    end
+  end
+end
+

data/lib/ruby_edit/grep.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'ruby_edit/command'
+
+module RubyEdit
+  class Grep < RubyEdit::Command
+    attr_reader :result
+
+    def initialize(options)
+      @path       = options[:path] || '.'
+      @expression = options[:expression]
+    end
+
+    def search(output: $stdout, errors: $stderr)
+      if empty_expression?
+        output.puts 'No expression given'
+        return false
+      end
+      @result = run "grep -irn #{@path} -e '#{@expression}'" do |out, err|
+        output << out if out
+        errors << err if err
+      end
+    rescue TTY::Command::ExitError => error
+      output.puts error
+    end
+
+    private
+
+    def empty_expression?
+      @expression.nil? || @expression.empty?
+    end
+  end
+end
+

data/lib/ruby_edit/source_file.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'ruby_edit/command'
+
+module RubyEdit
+  class SourceFile < RubyEdit::Command
+    def populate(content)
+      generator.create_file(RubyEdit::SOURCE_FILE_LOCATION, content, force: true)
+    end
+
+    def delete
+      generator.remove_file(RubyEdit::SOURCE_FILE_LOCATION)
+    end
+  end
+end
+

data/lib/ruby_edit/templates/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/ruby_edit/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RubyEdit
+  VERSION = '0.1.0'
+end
+

data/lib/ruby_edit/writer.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'tempfile'
+require 'ruby_edit/command'
+
+module RubyEdit
+  class Writer < RubyEdit::Command
+    LINE_REGEX = /^.*\d+./
+
+    def write
+      File.open(RubyEdit::SOURCE_FILE_LOCATION, 'rb') do |file|
+        file.each_line { |line| find_and_replace_line line }
+      end
+    end
+
+    private
+
+    def find_and_replace_line(new_line)
+      @temp_file = Tempfile.new('temp_file')
+      split_file_and_line(new_line)
+      @new_line = new_line.sub LINE_REGEX, ''
+      begin
+        replace_line
+        replace_file
+      ensure
+        @temp_file.close
+        @temp_file.unlink
+      end
+    end
+
+    def split_file_and_line(line)
+      @file_name, @line_number = line.match(LINE_REGEX)[0].split(':')
+    rescue NoMethodError
+      false
+    end
+
+    # Replaces the line in the original file, with the line from the sourcefile
+    def replace_line
+      File.open(@file_name, 'r+') do |file|
+        file.each_with_index do |line, index|
+          output = index + 1 == @line_number.to_i ? @new_line : line
+          @temp_file.puts output
+        end
+      end
+    end
+
+    # Replaces the old file, with the new edited file
+    def replace_file
+      @temp_file.close
+      FileUtils.mv(@temp_file.path, @file_name)
+    end
+  end
+end
+