text_editor 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b869a9294584c550357a869d6d61efbda2d7e9a
-  data.tar.gz: 1eafb0f6ffa81a53b43f5b74759e0e5354ba688e
+  metadata.gz: ea27f5f0446c3f7dde33eedab3d63b9638249ad1
+  data.tar.gz: 1c0ff7ad29a6032a1fe7e15a7fd1956acab74c39
 SHA512:
-  metadata.gz: 9c10910e79d481967bde183696d1dfe89a973b8a244d3ee36a38b46abb7769147aad71c84b56ee7153d27288d112eb271bec745c09f24dd5b71dfd2f184ffd7d
-  data.tar.gz: e3f686ec346c8e65c27a51d402bfef9164f7926e6396c30ce129149d8b332969afb0d6c20ccd17dca7e3b8883930e7b05c0b0a2f4cb4e470affb633a77424687
+  metadata.gz: 44feaf376fdda1b09467ff24f48c30b0938d78bcce1c920bd93df0fd79e648c862b03f6d0179d9c46669f3f55403821f88cb0d325bd6f61e0e6f8838bfa2ca92
+  data.tar.gz: 6d5a26618593ad00779f110bbe891cb8dba0bbb5d921f3765a32ddf314dfb2753be91856c1021aa2076eefbaf7395f1b63c6ef9fdd54d8af1e0c8e3b4299c509

data/.rubocop.yml

@@ -11,6 +11,9 @@ Style/CaseEquality:
 Metrics/CyclomaticComplexity:
   Enabled: false
 
+Metrics/LineLength:
+  Enabled: false
+
 Metrics/MethodLength:
   Enabled: false
 

data/.text_editor.rb

@@ -1,9 +1,88 @@
 TextEditor.configure do
-  log.file = nil
+  config.default_flavor ||= :nano
+
+  log.file ||= nil
   log.level = Logger::INFO
   log.options = []
 
-  tab.expand = true
   tab.soft = true
   tab.width = 2
+
+  flavor :nano do
+    mode :insert do
+      bind :ctrl_c, :quit
+
+      bind :up, :cursor_up
+      bind :down, :cursor_down
+      bind :left, :cursor_left_with_wrap
+      bind :right, :cursor_right_with_wrap
+
+      bind :ctrl_p, :cursor_up
+      bind :ctrl_n, :cursor_down
+      bind :ctrl_b, :cursor_left_with_wrap
+      bind :ctrl_f, :cursor_right_with_wrap
+
+      bind :ctrl_a, :cursor_start
+      bind :ctrl_e, :cursor_end
+
+      bind :ctrl_space, :forward_word
+
+      bind :backspace, :backspace
+      bind :ctrl_h, :backspace
+
+      bind :ctrl_o, :write_file
+
+      bind :enter, :insert_line
+      bind :tab, :insert_tab
+
+      bind(/^[[:print:]]$/, :insert_char)
+    end
+  end
+
+  flavor :vim do
+    mode :normal do
+      bind :ctrl_c, :quit
+
+      bind :k, :cursor_up
+      bind :j, :cursor_down
+      bind :h, :cursor_left
+      bind :l, :cursor_right
+
+      bind :^, :cursor_start_without_whitespace
+      bind :"0", :cursor_start
+      bind :"$", :cursor_end
+
+      bind :w, :forward_word
+
+      bind :S, :replace_line
+
+      bind :a, :cursor_right_and_insert
+      bind :A, :cursor_end_and_insert
+
+      bind :o, :append_line_and_insert
+      bind :O, :prepend_line_and_insert
+
+      bind :i, :change_mode, :insert
+    end
+
+    mode :insert do
+      bind :ctrl_c, :change_mode, :normal
+      bind :escape, :change_mode, :normal
+
+      bind :up, :cursor_up
+      bind :down, :cursor_down
+      bind :left, :cursor_left
+      bind :right, :cursor_right
+
+      bind :backspace, :backspace
+      bind :ctrl_h, :backspace
+
+      bind :ctrl_j, :insert_line
+      bind :enter, :insert_line
+
+      bind :tab, :insert_tab
+
+      bind(/^[[:print:]]$/, :insert_char)
+    end
+  end
 end

data/Gemfile.lock

@@ -2,6 +2,7 @@ PATH
   remote: .
   specs:
     text_editor (0.0.0)
+      bundler
       curses (= 1.0.2)
 
 GEM

data/README.org

@@ -1,5 +1,108 @@
 * Text Editor
 Text editor written in [[https://www.ruby-lang.org/en/][Ruby]] and heavily inspired by [[http://www.vim.org/][vim]], [[https://www.gnu.org/software/emacs/][emacs]], [[https://www.nano-editor.org/][nano]], and [[https://github.com/grosser/ruco][ruco]].
+** Commands
+All editor commands inherit the =TextEditor::Command= class. This class provides some convenience methods for referencing various text editor related components.
+#+BEGIN_SRC ruby
+class MoveCursorRight < TextEditor::Command
+  def run(*)
+    window.update(cursor: cursor.move_right)
+  end
+end
+#+END_SRC
+** Configuration
+The =te= executable accepts a couple command line arguments:
+#+BEGIN_SRC text
+Usage: te [options]
+    -l, --log FILE
+    -f, --flavor FLAVOR
+    -v, --version
+#+END_SRC
+
+All other configuration is managed thru =.text_editor.rb= files. These files are searched and loaded in the following order:
+- The root of this gem's directory
+- The =/etc= directory
+- The =$HOME= directory
+- Any directory while traversing the tree down to the current working directory
+
+Here's an example of the configuration file from the root of this gem:
+#+BEGIN_SRC ruby
+TextEditor.configure do
+  config.default_flavor ||= :nano
+
+  log.file ||= nil
+  log.level = Logger::INFO
+  log.options = []
+
+  tab.soft = true
+  tab.width = 2
+
+  flavor :nano do
+    mode :insert do
+      bind :ctrl_c, :quit
+
+      bind :up, :cursor_up
+      bind :down, :cursor_down
+      bind :left, :cursor_left_with_wrap
+      bind :right, :cursor_right_with_wrap
+
+      bind :ctrl_p, :cursor_up
+      bind :ctrl_n, :cursor_down
+      bind :ctrl_b, :cursor_left_with_wrap
+      bind :ctrl_f, :cursor_right_with_wrap
+
+      bind :ctrl_a, :cursor_start
+      bind :ctrl_e, :cursor_end
+
+      bind :ctrl_space, :forward_word
+
+      bind :backspace, :backspace
+      bind :ctrl_h, :backspace
+
+      bind :ctrl_o, :write_file
+
+      bind :enter, :insert_line
+      bind :tab, :insert_tab
+
+      bind(/^[[:print:]]$/, :insert_char)
+    end
+  end
+
+  flavor :vim do
+    mode :normal do
+      bind :ctrl_c, :quit
+
+      bind :k, :cursor_up
+      bind :j, :cursor_down
+      bind :h, :cursor_left
+      bind :l, :cursor_right
+
+      bind :^, :cursor_start
+      bind :"$", :cursor_end
+
+      bind :w, :forward_word
+
+      bind :S, :replace_line
+
+      bind :i, :change_mode, :insert
+    end
+
+    mode :insert do
+      bind :ctrl_c, :change_mode, :normal
+      bind :escape, :change_mode, :normal
+
+      bind :backspace, :backspace
+      bind :ctrl_h, :backspace
+
+      bind :ctrl_j, :insert_line
+      bind :enter, :insert_line
+
+      bind :tab, :insert_tab
+
+      bind(/^[[:print:]]$/, :insert_char)
+    end
+  end
+end
+#+END_SRC
 ** API
 *** Buffer
 - An in-memory text representation of a file

data/bin/console

@@ -2,7 +2,7 @@
 require_relative "../lib/text_editor"
 
 def editor
-  @editor ||= TextEditor.new(ARGV)
+  @editor ||= TextEditor.new(ARGV).tap(&:bootstrap)
 end
 
 require "irb"

data/lib/core_ext/hash.rb

@@ -1,6 +1,8 @@
 module CoreExt
   module Hash
     refine ::Hash do
+      # Returns a new hash with each key replaced
+      # with the return value of the specified block.
       def transform_keys
         reduce({}) do |hash, (key, value)|
           key = yield(key)

data/lib/core_ext/pathname.rb

@@ -1,6 +1,8 @@
 module CoreExt
   module Pathname
     refine ::Pathname do
+      # Returns the file contents if it exists.
+      # Returns nil otherwise.
       def safe_read
         read if exist?
       end

data/lib/text_editor.rb

@@ -15,7 +15,7 @@ require_relative "text_editor/component"
 require_relative "text_editor/buffer"
 require_relative "text_editor/cursor"
 require_relative "text_editor/keyboard"
-require_relative "text_editor/operating_system"
+require_relative "text_editor/logger"
 require_relative "text_editor/reactor"
 require_relative "text_editor/state"
 require_relative "text_editor/terminal"
@@ -29,49 +29,77 @@ require_relative "text_editor/clipboard/unknown"
 require_relative "text_editor/clipboard/windows"
 
 require_relative "text_editor/command"
+require_relative "text_editor/command/append_line_and_insert"
 require_relative "text_editor/command/backspace"
-require_relative "text_editor/command/quit"
+require_relative "text_editor/command/change_mode"
 require_relative "text_editor/command/cursor_down"
 require_relative "text_editor/command/cursor_end"
+require_relative "text_editor/command/cursor_end_and_insert"
 require_relative "text_editor/command/cursor_left"
+require_relative "text_editor/command/cursor_left_with_wrap"
 require_relative "text_editor/command/cursor_right"
+require_relative "text_editor/command/cursor_right_and_insert"
+require_relative "text_editor/command/cursor_right_with_wrap"
 require_relative "text_editor/command/cursor_start"
+require_relative "text_editor/command/cursor_start_without_whitespace"
 require_relative "text_editor/command/cursor_up"
+require_relative "text_editor/command/forward_word"
 require_relative "text_editor/command/insert_char"
 require_relative "text_editor/command/insert_line"
 require_relative "text_editor/command/insert_tab"
+require_relative "text_editor/command/prepend_line_and_insert"
+require_relative "text_editor/command/quit"
+require_relative "text_editor/command/replace_line"
 require_relative "text_editor/command/resolver"
 require_relative "text_editor/command/write_file"
 
 require_relative "text_editor/configuration"
 require_relative "text_editor/configuration/bootstrap"
 require_relative "text_editor/configuration/dsl"
+require_relative "text_editor/configuration/flavor"
+require_relative "text_editor/configuration/log"
+require_relative "text_editor/configuration/mode"
+require_relative "text_editor/configuration/operating_system"
 require_relative "text_editor/configuration/resolver"
+require_relative "text_editor/configuration/tab"
 
-require_relative "text_editor/mode"
-require_relative "text_editor/mode/nano"
-
+# Dependency injection container for the misc
+# components required to run the text editor.
 class TextEditor
   extend Configuration::DSL
 
   GEMSPEC = File.expand_path("../../text_editor.gemspec", __FILE__)
 
-  def initialize(args)
+  attr_writer :mode
+
+  def initialize(args = [])
     @args = args
   end
 
   def bootstrap
-    @bootstrap ||= Configuration::Bootstrap.new(self)
+    Configuration::Bootstrap.new(self).configure(@args)
   end
 
   def clipboard
     @clipboard ||= Clipboard.new(self)
   end
 
+  def command
+    @command ||= Command::Resolver.new(self)
+  end
+
   def config
     @config ||= Configuration.new(self)
   end
 
+  def flavor
+    @flavor ||= flavors[config.default_flavor]
+  end
+
+  def flavors
+    @flavors ||= {}
+  end
+
   def gemspec
     @gemspec ||= Gem::Specification.load(GEMSPEC)
   end
@@ -81,17 +109,15 @@ class TextEditor
   end
 
   def logger
-    @logger ||= Logger.new(config.log.file, *config.log.options).tap do |log|
-      log.level = config.log.level
-    end
+    @logger ||= Logger.new(self)
   end
 
   def mode
-    @mode ||= Mode::Nano.new
+    @mode ||= flavor.modes.values.first # FIXME
   end
 
   def os
-    @os ||= OperatingSystem.new(RbConfig::CONFIG["host_os"])
+    @os ||= Configuration::OperatingSystem.new(ruby.host_os)
   end
 
   def reactor
@@ -102,8 +128,12 @@ class TextEditor
     @root ||= Pathname.new(__FILE__).dirname.dirname
   end
 
+  def ruby
+    @ruby ||= OpenStruct.new(RbConfig::CONFIG)
+  end
+
   def start
-    bootstrap.configure(@args)
+    bootstrap
     terminal.render { reactor.start }
   end
 

data/lib/text_editor/buffer.rb

@@ -1,4 +1,7 @@
 class TextEditor
+  # An internal representation of a buffer.
+  # These buffers are rendered out to the
+  # terminal by {Window} instances.
   class Buffer
     using CoreExt::Pathname
 

data/lib/text_editor/clipboard.rb

@@ -3,7 +3,7 @@ class TextEditor
     extend Forwardable
     include Component
 
-    def_delegators :adapter, :clear, :copy, :paste
+    def_delegators :adapter, :copy, :paste
 
     private
 

data/lib/text_editor/clipboard/cygwin.rb

@@ -3,10 +3,6 @@ class TextEditor
     class Cygwin
       CLIPBOARD = "/dev/clipboard".freeze
 
-      def clear
-        copy("")
-      end
-
       def copy(content)
         File.write(CLIPBOARD, content)
         content

data/lib/text_editor/clipboard/linux.rb

@@ -1,10 +1,6 @@
 class TextEditor
   class Clipboard
     class Linux
-      def clear
-        raise NotImplementedError
-      end
-
       def copy(_content)
         raise NotImplementedError
       end

data/lib/text_editor/clipboard/mac.rb

@@ -1,10 +1,6 @@
 class TextEditor
   class Clipboard
     class Mac
-      def clear
-        copy("")
-      end
-
       def copy(content)
         system("printf #{content.inspect} | pbcopy")
         content

data/lib/text_editor/clipboard/unknown.rb

@@ -1,10 +1,6 @@
 class TextEditor
   class Clipboard
     class Unknown
-      def clear
-        copy("")
-      end
-
       def copy(content)
         @clipboard = content
       end