Contents

# frozen_string_literal: true

require 'tempfile'

require_relative '../helpers/os_helper.rb'

module Geet
  module Commandline
    class Editor
      include Geet::Helpers::OsHelper

      # Git style!
      HELP_SEPARATOR = '------------------------ >8 ------------------------'

      # Edits a content in the default editor, optionally providing help.
      #
      # When the help is provided, it's appended to the bottom, separated by HELP_SEPARATOR.
      # The help is stripped after the content if edited.
      #
      def edit_content(content: '', help: nil)
        content += "\n\n" + HELP_SEPARATOR + "\n" + help if help

        edited_content = edit_content_in_default_editor(content)

        edited_content = edited_content.split(HELP_SEPARATOR, 2).first if help

        edited_content.strip
      end

      private

      # MAIN STEPS #######################################################################

      # The gem `tty-editor` does this, although it requires in turn other 7/8 gems.
      # Interestingly, the API `TTY::Editor.open(content: 'text')` is not very useful,
      # as it doesn't return the filename (!).
      #
      def edit_content_in_default_editor(content)
        tempfile = Tempfile.open(['geet_editor', '.md']) { |file| file << content }.path
        command = "#{system_editor} #{tempfile.shellescape}"

        execute_command(command, description: 'editing', interactive: true)

        content = IO.read(tempfile)

        File.unlink(tempfile)

        content
      end

      # HELPERS ##########################################################################

      def system_editor
        ENV['EDITOR'] || ENV['VISUAL'] || 'vi'
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
geet-0.3.3	lib/geet/commandline/editor.rb
geet-0.3.2	lib/geet/commandline/editor.rb
geet-0.3.1	lib/geet/commandline/editor.rb