text_editor 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b869a9294584c550357a869d6d61efbda2d7e9a
+  data.tar.gz: 1eafb0f6ffa81a53b43f5b74759e0e5354ba688e
+SHA512:
+  metadata.gz: 9c10910e79d481967bde183696d1dfe89a973b8a244d3ee36a38b46abb7769147aad71c84b56ee7153d27288d112eb271bec745c09f24dd5b71dfd2f184ffd7d
+  data.tar.gz: e3f686ec346c8e65c27a51d402bfef9164f7926e6396c30ce129149d8b332969afb0d6c20ccd17dca7e3b8883930e7b05c0b0a2f4cb4e470affb633a77424687

data/.gitignore

@@ -0,0 +1,3 @@
+log
+tmp
+vendor/bundle

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInLiteral:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.text_editor.rb

@@ -0,0 +1,9 @@
+TextEditor.configure do
+  log.file = nil
+  log.level = Logger::INFO
+  log.options = []
+
+  tab.expand = true
+  tab.soft = true
+  tab.width = 2
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+gemspec
+
+gem "codeclimate-test-reporter"
+gem "rspec"
+gem "rubocop"

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    text_editor (0.0.0)
+      curses (= 1.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    curses (1.0.2)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (2.0.2)
+    parser (2.3.1.4)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.43.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    unicode-display_width (1.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter
+  rspec
+  rubocop
+  text_editor!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Sean Huber - sean@shuber.io
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.org

@@ -0,0 +1,29 @@
+* 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]].
+** API
+*** Buffer
+- An in-memory text representation of a file
+- Does not overwrite the file until the buffer is saved
+*** Component
+- Convenience methods for working with =TextEditor= objects
+*** Configuration
+- Manages misc editor configuration
+*** Cursor
+- A cursor instance specific to an individual =Window=
+*** Keyboard
+- Listens for keyboard input
+- Translates raw input into character symbols e.g. =:escape=
+*** Window
+- A viewport of a specific buffer
+- Multiple windows may reference the same buffer
+- Windows have their own settings and viewport or cursor positions
+- Windows have three possible states: active, hidden, inactive
+*** Tab
+- A collection of windows
+- Only one tab is visible at a time
+*** Terminal
+- Responsible for interacting with the console
+*** TextEditor
+- Dependency injection container
+** Inspiration
+https://github.com/showcases/text-editors

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require_relative "../lib/text_editor"
+
+def editor
+  @editor ||= TextEditor.new(ARGV)
+end
+
+require "irb"
+IRB.start

data/bin/te

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative "../lib/text_editor"
+TextEditor.new(ARGV).start

data/lib/core_ext/hash.rb

@@ -0,0 +1,12 @@
+module CoreExt
+  module Hash
+    refine ::Hash do
+      def transform_keys
+        reduce({}) do |hash, (key, value)|
+          key = yield(key)
+          hash.update(key => value)
+        end
+      end
+    end
+  end
+end

data/lib/core_ext/pathname.rb

@@ -0,0 +1,9 @@
+module CoreExt
+  module Pathname
+    refine ::Pathname do
+      def safe_read
+        read if exist?
+      end
+    end
+  end
+end

data/lib/text_editor/buffer.rb

@@ -0,0 +1,85 @@
+class TextEditor
+  class Buffer
+    using CoreExt::Pathname
+
+    def initialize(lines = nil)
+      @lines = parse_lines(lines)
+    end
+
+    def delete_char(line, column)
+      validate_line!(line)
+      content = self.line(line)
+      content.slice!(column)
+      replace_line(line, content)
+    end
+
+    def delete_line(line)
+      lines = @lines.dup
+      lines.delete_at(line)
+      self.class.new(lines)
+    end
+
+    def each_line(&block)
+      @lines.each(&block)
+    end
+
+    def insert_char(line, column, char)
+      validate_line!(line)
+      content = self.line(line)
+      content.insert(column, char)
+      replace_line(line, content)
+    end
+
+    def insert_line(line, content = "")
+      lines = @lines.dup.insert(line, content)
+      self.class.new(lines.compact)
+    end
+
+    def line(line)
+      @lines[line].to_s.dup
+    end
+
+    def replace_char(line, column, char)
+      validate_line!(line)
+      content = self.line(line)
+      content[column] = char
+      replace_line(line, content)
+    end
+
+    def replace_line(line, content = "")
+      validate_line!(line)
+      lines = @lines.dup
+      lines[line] = content
+      self.class.new(lines.compact)
+    end
+
+    def size
+      @lines.size
+    end
+
+    def to_s
+      @lines.join("\n")
+    end
+
+    private
+
+    def parse_lines(lines)
+      case lines
+      when nil, ""
+        [""]
+      when Array
+        lines
+      when Pathname
+        parse_lines(lines.safe_read)
+      when String
+        lines.each_line.map(&:chomp)
+      else
+        raise ArgumentError
+      end
+    end
+
+    def validate_line!(line)
+      raise IndexError if line >= size
+    end
+  end
+end

data/lib/text_editor/clipboard/cygwin.rb

@@ -0,0 +1,20 @@
+class TextEditor
+  class Clipboard
+    class Cygwin
+      CLIPBOARD = "/dev/clipboard".freeze
+
+      def clear
+        copy("")
+      end
+
+      def copy(content)
+        File.write(CLIPBOARD, content)
+        content
+      end
+
+      def paste
+        File.read(CLIPBOARD)
+      end
+    end
+  end
+end

data/lib/text_editor/clipboard/linux.rb

@@ -0,0 +1,17 @@
+class TextEditor
+  class Clipboard
+    class Linux
+      def clear
+        raise NotImplementedError
+      end
+
+      def copy(_content)
+        raise NotImplementedError
+      end
+
+      def paste
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/text_editor/clipboard/mac.rb

@@ -0,0 +1,18 @@
+class TextEditor
+  class Clipboard
+    class Mac
+      def clear
+        copy("")
+      end
+
+      def copy(content)
+        system("printf #{content.inspect} | pbcopy")
+        content
+      end
+
+      def paste
+        `pbpaste`
+      end
+    end
+  end
+end

data/lib/text_editor/clipboard/unknown.rb

@@ -0,0 +1,17 @@
+class TextEditor
+  class Clipboard
+    class Unknown
+      def clear
+        copy("")
+      end
+
+      def copy(content)
+        @clipboard = content
+      end
+
+      def paste
+        @clipboard.to_s
+      end
+    end
+  end
+end

data/lib/text_editor/clipboard/windows.rb

@@ -0,0 +1,17 @@
+class TextEditor
+  class Clipboard
+    class Windows
+      def clear
+        raise NotImplementedError
+      end
+
+      def copy(_content)
+        raise NotImplementedError
+      end
+
+      def paste
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/text_editor/clipboard.rb

@@ -0,0 +1,18 @@
+class TextEditor
+  class Clipboard
+    extend Forwardable
+    include Component
+
+    def_delegators :adapter, :clear, :copy, :paste
+
+    private
+
+    def adapter
+      @adapter ||= type.new
+    end
+
+    def type
+      self.class.const_get(editor.os.type)
+    end
+  end
+end

data/lib/text_editor/command/backspace.rb

@@ -0,0 +1,26 @@
+class TextEditor
+  class Command
+    class Backspace < Command
+      def run(*)
+        if column.zero? && line.nonzero?
+          content = buffer.line(line.pred)
+          new_column = content.size
+          content << buffer.line(line)
+
+          new_buffer = buffer.replace_line(line.pred, content)
+          new_buffer = new_buffer.delete_line(line)
+
+          new_cursor = cursor.move(line.pred, new_column)
+        elsif column.nonzero?
+          new_buffer = buffer.delete_char(line, column.pred)
+          new_cursor = cursor.left
+        else
+          new_buffer = buffer
+          new_cursor = cursor
+        end
+
+        window.update(new_buffer, new_cursor)
+      end
+    end
+  end
+end

data/lib/text_editor/command/cursor_down.rb

@@ -0,0 +1,14 @@
+class TextEditor
+  class Command
+    class CursorDown < Command
+      def run(*)
+        lines = buffer.size.pred
+        return if line == lines
+
+        columns = buffer.line(line.next).size
+        new_cursor = cursor.down.clamp(lines, columns)
+        window.update(buffer, new_cursor)
+      end
+    end
+  end
+end

data/lib/text_editor/command/cursor_end.rb

@@ -0,0 +1,10 @@
+class TextEditor
+  class Command
+    class CursorEnd < Command
+      def run(*)
+        new_cursor = cursor.move(line, content.size)
+        window.update(buffer, new_cursor)
+      end
+    end
+  end
+end

data/lib/text_editor/command/cursor_left.rb

@@ -0,0 +1,16 @@
+class TextEditor
+  class Command
+    class CursorLeft < Command
+      def run(*)
+        if column.zero? && line.nonzero?
+          column = buffer.line(line.pred).size
+          new_cursor = cursor.move(line.pred, column)
+        else
+          new_cursor = cursor.left
+        end
+
+        window.update(buffer, new_cursor)
+      end
+    end
+  end
+end

data/lib/text_editor/command/cursor_right.rb

@@ -0,0 +1,19 @@
+class TextEditor
+  class Command
+    class CursorRight < Command
+      def run(*)
+        columns = content.size
+        lines = buffer.size.pred
+
+        new_cursor =
+          if column == columns && line != lines
+            cursor.move(line.next, 0)
+          else
+            cursor.right.clamp(lines, columns)
+          end
+
+        window.update(buffer, new_cursor)
+      end
+    end
+  end
+end

data/lib/text_editor/command/cursor_start.rb

@@ -0,0 +1,10 @@
+class TextEditor
+  class Command
+    class CursorStart < Command
+      def run(*)
+        new_cursor = cursor.move(line, 0)
+        window.update(buffer, new_cursor)
+      end
+    end
+  end
+end

data/lib/text_editor/command/cursor_up.rb

@@ -0,0 +1,13 @@
+class TextEditor
+  class Command
+    class CursorUp < Command
+      def run(*)
+        return unless line.zero?
+
+        columns = buffer.line(line.pred).size
+        new_cursor = cursor.up.clamp(line.pred, columns)
+        window.update(buffer, new_cursor)
+      end
+    end
+  end
+end

data/lib/text_editor/command/insert_char.rb

@@ -0,0 +1,11 @@
+class TextEditor
+  class Command
+    class InsertChar < Command
+      def run(key)
+        new_buffer = buffer.insert_char(line, column, key)
+        new_cursor = cursor.right(key.size)
+        window.update(new_buffer, new_cursor)
+      end
+    end
+  end
+end

data/lib/text_editor/command/insert_line.rb

@@ -0,0 +1,16 @@
+class TextEditor
+  class Command
+    class InsertLine < Command
+      def run(*)
+        current = content[0...column]
+        newline = content[column..-1]
+
+        new_buffer = buffer.replace_line(line, current)
+        new_buffer = new_buffer.insert_line(line.next, newline)
+
+        new_cursor = cursor.move(line.next, 0)
+        window.update(new_buffer, new_cursor)
+      end
+    end
+  end
+end

data/lib/text_editor/command/insert_tab.rb

@@ -0,0 +1,9 @@
+class TextEditor
+  class Command
+    class InsertTab < Command
+      def run(*)
+        command.insert_char("  ")
+      end
+    end
+  end
+end

data/lib/text_editor/command/quit.rb

@@ -0,0 +1,9 @@
+class TextEditor
+  class Command
+    class Quit < Command
+      def run(*)
+        editor.reactor.stop
+      end
+    end
+  end
+end

data/lib/text_editor/command/resolver.rb

@@ -0,0 +1,36 @@
+class TextEditor
+  class Command
+    class Resolver
+      include Component
+
+      def method_missing(method, *args, &block)
+        command = resolve(method)
+        return super unless command
+        command.run(*args, &block)
+        self
+      end
+
+      def resolve(method)
+        parts = method.to_s.split("_")
+        name = parts.map(&:capitalize).join
+        command(name)
+      end
+
+      private
+
+      def command(name)
+        namespace.const_get(name).new(editor)
+      rescue NameError
+        nil
+      end
+
+      def namespace
+        Module.nesting[1]
+      end
+
+      def respond_to_missing?(method, include_super)
+        resolve(method) || super
+      end
+    end
+  end
+end

data/lib/text_editor/command/write_file.rb

@@ -0,0 +1,13 @@
+class TextEditor
+  class Command
+    class WriteFile < Command
+      def run(*)
+        if window.file
+          window.file.write(buffer.to_s)
+        else
+          terminal.beep
+        end
+      end
+    end
+  end
+end

data/lib/text_editor/command.rb

@@ -0,0 +1,26 @@
+class TextEditor
+  class Command
+    extend Forwardable
+    include Component
+
+    def_delegators :editor, :window
+    def_delegators :window, :buffer, :cursor, :state
+    def_delegators :cursor, :line, :column
+
+    def self.call(editor, *args, &block)
+      new(editor).run(*args, &block)
+    end
+
+    def command
+      @command ||= Resolver.new(editor)
+    end
+
+    def content
+      buffer.line(line)
+    end
+
+    def run(*)
+      raise NotImplementedError
+    end
+  end
+end