amun 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 10726ce656cbf6445cbee3177cda26541982d3b7
-  data.tar.gz: 0da415d031b8e63ff1fb5fb4b92537117ed1ad4f
+SHA256:
+  metadata.gz: c19c96c195a1b4c07b725041f93ab2d4b55c686bfe43f43f3b073ae05cc12ade
+  data.tar.gz: 1760fc63a9b6748b887c5f502736713c18b1428b03ecc72488073e5444f99a29
 SHA512:
-  metadata.gz: a6eef223a7d0a123259da8edea864b7a701b8d8d048fdef6ff0dc1002a187b4008c4ed0b967e1db95fb5345156c611063ef4525e67550efbe7da2017c925d486
-  data.tar.gz: b475175d8acf045f52ac748be2243c7b46d1a4576334a768d671a42295bcf899f8cdd0e8bbf12152135b1bf22ce7537f8fb9ac38b8481a75be651a2e63f88d7b
+  metadata.gz: 7f424f219a3815db2c5499862f5ffdb65c27a1f55eaecb50a79fbda5a9b6fc69aac93bc392a6b19d318cc107953b491bae528e605b07f2c26e6ded8b5b22bfaa
+  data.tar.gz: '0866d9947a3e98b8e5a08d8d3f3c09e6c0b41727f86e15cd383f20b1780a0999cdcf14ed3d5087ecd7dd903aad600cb2ac7846b2b971a3d19eb821e5c97dd2bd'

data/.rspec

@@ -0,0 +1 @@
+--color --format doc

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
+  TargetRubyVersion: 2.0
   Exclude:
-    - 'test/**/*'
+    - 'spec/**/*'
     - '*.gemspec'
   DisplayCopNames: true
 Style/FrozenStringLiteralComment:
@@ -9,3 +10,7 @@ Style/StringLiterals:
   Enabled: false
 Style/WordArray:
   Enabled: false
+Metrics/LineLength:
+  Max: 120
+Security/Eval:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.4.0
+2.6.6

data/Guardfile

@@ -1,7 +1,27 @@
-directories ['lib', 'test']
-guard :minitest do
-  # with Minitest::Unit
-  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
-  watch(%r{^test/test_helper\.rb$})      { 'test' }
+directories ['lib', 'spec']
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
 end

data/README.md

@@ -5,6 +5,7 @@
 [![Build Status](https://travis-ci.org/blazeeboy/amun.svg?branch=master)](https://travis-ci.org/blazeeboy/amun)
 [![Code Climate](https://codeclimate.com/github/blazeeboy/amun/badges/gpa.svg)](https://codeclimate.com/github/blazeeboy/amun)
 [![Test Coverage](https://codeclimate.com/github/blazeeboy/amun/badges/coverage.svg)](https://codeclimate.com/github/blazeeboy/amun)
+[![Inline docs](http://inch-ci.org/github/blazeeboy/amun.svg?branch=master)](http://inch-ci.org/github/blazeeboy/amun)
 
 A minimal CLI text editor, built on Ruby, looking for Emacs as it's father and idol.
 

data/Rakefile

@@ -1,10 +1,8 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
 end
 
-task default: :test
+task default: :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

data/amun.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "amun"
   spec.version       = Amun::VERSION
   spec.authors       = ["Emad Elsaid"]
-  spec.email         = ["blazeeboy@gmail.com"]
+  spec.email         = ["emad.elsaid.hamed@gmail.com"]
 
   spec.summary       = "Emacs like editor, with Ruby core instead of ELisp"
   spec.description   = "A CLI editor built to have an Emacs similar development environment, with ruby in the heart of it instead of Elisp, that will make developing plugins and extensions faster and more enjoyable, this editor is kept to the minimum, anything that could be written as an pluging will be found as a plugin."
@@ -21,13 +21,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "curses", "~> 1.2"
-  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_dependency "curses"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
 end

data/exe/amun

@@ -4,4 +4,4 @@ $LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
 
 require 'amun'
 
-Amun::Application.instance.run
+Amun::Application.run

data/lib/amun/application.rb

@@ -1,6 +1,7 @@
 require 'curses'
 require 'singleton'
-require 'amun/ui/windows/frame'
+require 'forwardable'
+require 'amun/windows/frame'
 require 'amun/event_manager'
 require 'amun/features_loader'
 require 'amun/helpers/keyboard'
@@ -14,7 +15,7 @@ module Amun
     attr_writer :frame
 
     def frame
-      @frame ||= UI::Windows::Frame.new
+      @frame ||= Windows::Frame.new
     end
 
     def run
@@ -24,6 +25,12 @@ module Amun
       keyboard_thread.join
     end
 
+    class << self
+      extend Forwardable
+      def_delegators :instance,
+                     :run, :frame, :frame=
+    end
+
     private
 
     def init_curses
@@ -41,9 +48,8 @@ module Amun
         chain = []
         while (ch = Helpers::Keyboard.char)
           chain << ch
-          if EventManager.join(chain.join(' '), frame) != EventManager::CHAINED
-            chain.clear
-          end
+          chain.clear if frame.trigger(chain.join(' ')) != EventManager::CHAINED
+          frame.render
         end
       end
     end

data/lib/amun/behaviours/emacs.rb

@@ -1,130 +1,22 @@
-require 'amun/ui/buffer'
+require 'amun/behaviours/movement'
+require 'amun/behaviours/erasing'
+require 'amun/behaviours/insertion'
 require 'curses'
 
 module Amun
   module Behaviours
+    # Emacs default behaviour module
+    # should be included in the mode
+    # which needs this behaviour as part of it
     module Emacs
-      def emacs_behaviour_initialize(event_manager)
-        event_manager.bind "\C-f", self, :forward_char
-        event_manager.bind Curses::KEY_RIGHT.to_s, self, :forward_char
-
-        event_manager.bind "\C-b", self, :backward_char
-        event_manager.bind Curses::KEY_LEFT.to_s, self, :backward_char
-
-        event_manager.bind "\C-n", self, :next_line
-        event_manager.bind Curses::KEY_DOWN.to_s, self, :next_line
-
-        event_manager.bind "\C-p", self, :previous_line
-        event_manager.bind Curses::KEY_UP.to_s, self, :previous_line
-
-        event_manager.bind "\C-a", self, :beginning_of_line
-        event_manager.bind Curses::KEY_HOME.to_s, self, :beginning_of_line
-
-        event_manager.bind "\C-e", self, :end_of_line
-        event_manager.bind Curses::KEY_END.to_s, self, :end_of_line
-
-        event_manager.bind "\C-d", self, :delete_char
-        event_manager.bind Curses::Key::BACKSPACE.to_s, self, :backward_delete_char # this doesn't work, check linux
-        event_manager.bind "\C-?", self, :backward_delete_char # C-? is backspace on mac terminal for some reason
-
-        event_manager.bind Curses::Key::DC.to_s, self, :forward_delete_char
-
-        event_manager.bind "\C-k", self, :kill_line
-        event_manager.bind "\M-d", self, :kill_word
-      end
-
-      def forward_char(*)
-        buffer.point += 1
-        true
-      end
-
-      def backward_char(*)
-        buffer.point -= 1
-        true
-      end
-
-      def next_line(*)
-        line_begin = buffer.text.rindex("\n", buffer.point) || 0
-        line_end = buffer.text.index("\n", buffer.point + 1) || buffer.text.size + 1
-        next_line_end = buffer.text.index("\n", line_end + 1) || buffer.text.size + 1
-        point_offset = buffer.point - line_begin
-        buffer.point = [line_end + point_offset, next_line_end].min
-        true
-      end
-
-      def previous_line(*)
-        line_begin = buffer.text.rindex("\n", buffer.point) || 0
-        previous_line_begin = buffer.text.rindex("\n", line_begin - 1) || 0
-        point_offset = buffer.point - line_begin
-        buffer.point = [previous_line_begin + point_offset, line_begin - 1].min
-        true
-      end
-
-      def beginning_of_line(*)
-        point = buffer.point
-        return true if point.zero?
-        return true if buffer.text[point - 1] == "\n"
-
-        line_start = buffer.text.rindex("\n", point - 1)
-        buffer.point = line_start.nil? ? 0 : line_start + 1
-        true
-      end
-
-      def end_of_line(*)
-        point = buffer.point
-        return true if buffer.text[point] == "\n"
-
-        line_end = buffer.text.index("\n", point)
-        buffer.point = line_end || buffer.text.length
-        true
-      end
-
-      def delete_char(*)
-        buffer.text.slice!(buffer.point)
-        true
-      end
-
-      def backward_delete_char(*)
-        return true if buffer.point.zero?
-
-        buffer.point -= 1
-        buffer.text.slice!(buffer.point)
-        true
-      end
-
-      def forward_delete_char(*)
-        delete_char
-      end
-
-      # TODO should move text to kill ring
-      def kill_line(*)
-        if buffer.text[buffer.point] == "\n"
-          buffer.text.slice!(buffer.point)
-          return true
-        end
-
-        line_end = buffer.text.index(/$/, buffer.point)
-        buffer.text.slice!(buffer.point...line_end)
-        true
-      end
-
-      # TODO should move text to kill ring
-      def kill_word(*)
-        first_non_letter = buffer.text.index(/\P{L}/, buffer.point) || buffer.text.size
-        word_beginning = buffer.text.index(/\p{L}/, first_non_letter) || buffer.text.size
-        buffer.text.slice!(buffer.point...word_beginning)
-        true
-      end
-
-      # This should be bound to \M-BACKSPACE or \M-DEL but I think the terminal doesn't send it
-      # So the implementation will remain there until we find a way to catch this key
-      #
-      # TODO should move text to kill ring
-      def backward_kill_word(*)
-        first_letter_backward = buffer.text.rindex(/\p{L}/, buffer.point) || 0
-        first_non_letter_before_word = buffer.text.rindex(/\P{L}/, first_letter_backward) || -1
-        buffer.text.slice!(first_non_letter_before_word + 1 .. buffer.point)
-        true
+      include Movement
+      include Erasing
+      include Insertion
+
+      def emacs_behaviour_initialize
+        movement_keymap_initialize
+        erasing_keymap_initialize
+        insertion_keymap_initialize
       end
     end
   end

data/lib/amun/behaviours/erasing.rb

@@ -0,0 +1,67 @@
+module Amun
+  module Behaviours
+    # erasing, killing and deleting text from buffer and Emacs keymap for it
+    module Erasing
+      def erasing_keymap_initialize
+        bind "\C-d", self, :delete_char
+
+        # this doesn't work, check linux
+        bind Curses::Key::BACKSPACE, self, :backward_delete_char
+        # C-? is backspace on mac terminal for some reason
+        bind "\C-?", self, :backward_delete_char
+
+        bind Curses::Key::DC, self, :forward_delete_char
+        bind "\C-k", self, :kill_line
+        bind "\M-d", self, :kill_word
+      end
+
+      def delete_char(*)
+        buffer.slice!(buffer.point)
+        true
+      end
+
+      def backward_delete_char(*)
+        return true if buffer.point.zero?
+
+        buffer.point -= 1
+        buffer.slice!(buffer.point)
+        true
+      end
+
+      def forward_delete_char(*)
+        delete_char
+      end
+
+      # TODO: should move text to kill ring
+      def kill_line(*)
+        if buffer[buffer.point] == "\n"
+          buffer.slice!(buffer.point)
+          return true
+        end
+
+        line_end = buffer.index(/$/, buffer.point)
+        buffer.slice!(buffer.point, line_end - buffer.point)
+        true
+      end
+
+      # TODO: should move text to kill ring
+      def kill_word(*)
+        first_non_letter = buffer.index(/\P{L}/, buffer.point) || buffer.length
+        word_beginning = buffer.index(/\p{L}/, first_non_letter) || buffer.length
+        buffer.slice!(buffer.point, word_beginning - buffer.point)
+        true
+      end
+
+      # This should be bound to \M-BACKSPACE or \M-DEL but I think the terminal doesn't send it
+      # So the implementation will remain there until we find a way to catch this key
+      #
+      # TODO: should move text to kill ring
+      def backward_kill_word(*)
+        first_letter_backward = buffer.rindex(/\p{L}/, buffer.point) || 0
+        first_non_letter_before_word = buffer.rindex(/\P{L}/, first_letter_backward) || -1
+        buffer.slice!(first_non_letter_before_word + 1..buffer.point)
+        true
+      end
+    end
+  end
+end

data/lib/amun/behaviours/insertion.rb

@@ -0,0 +1,22 @@
+module Amun
+  module Behaviours
+    # inserting text to buffer behaviour and emacs keymap
+    module Insertion
+      def insertion_keymap_initialize
+        bind_all self, :insert_char
+      end
+
+      def insert_char(char)
+        return true unless char.is_a? String
+        return true unless char.length == 1
+        return true unless char.valid_encoding?
+        return true unless char.match?(/[[:print:]\n\t]/)
+
+        buffer.insert(buffer.point, char)
+        buffer.point += 1
+
+        true
+      end
+    end
+  end
+end

data/lib/amun/behaviours/movement.rb

@@ -0,0 +1,83 @@
+module Amun
+  module Behaviours
+    # Movement behaviour between lines, characters and paragraphs
+    # along with emacs keymap for it
+    module Movement
+      # attach the movement events only
+      def movement_keymap_initialize
+        bind "\C-f", self, :forward_char
+        bind Curses::KEY_RIGHT, self, :forward_char
+
+        bind "\C-b", self, :backward_char
+        bind Curses::KEY_LEFT, self, :backward_char
+
+        bind "\C-n", self, :next_line
+        bind Curses::KEY_DOWN, self, :next_line
+
+        bind "\C-p", self, :previous_line
+        bind Curses::KEY_UP, self, :previous_line
+
+        bind "\C-a", self, :beginning_of_line
+        bind Curses::KEY_HOME, self, :beginning_of_line
+
+        bind "\C-e", self, :end_of_line
+        bind Curses::KEY_END, self, :end_of_line
+      end
+
+      def forward_char(*)
+        buffer.point += 1
+        true
+      end
+
+      def backward_char(*)
+        buffer.point -= 1
+        true
+      end
+
+      def next_line(*)
+        point = buffer.point
+
+        line_begin = buffer.rindex(/^/, point)
+
+        line_end = buffer.index(/$/, point)
+        return true if line_end == buffer.size
+
+        next_line_end = buffer.index(/$/, line_end + 1)
+        point_offset = point - line_begin
+        buffer.point = [line_end + 1 + point_offset, next_line_end].min
+        true
+      end
+
+      def previous_line(*)
+        point = buffer.point
+
+        line_begin = point == buffer.size && buffer[point - 1] == "\n" ? point : buffer.rindex(/^/, point)
+        return true if line_begin.zero?
+
+        previous_line_begin = buffer.rindex(/^/, line_begin - 1)
+
+        point_offset = point - line_begin
+        buffer.point = [previous_line_begin + point_offset, line_begin - 1].min
+        true
+      end
+
+      def beginning_of_line(*)
+        point = buffer.point
+        return true if point == buffer.size
+
+        line_start = buffer.rindex(/^/, point)
+        buffer.point = line_start <= point ? line_start : 0
+        true
+      end
+
+      def end_of_line(*)
+        point = buffer.point
+        return true if buffer[point] == "\n"
+
+        line_end = buffer.index("\n", point)
+        buffer.point = line_end || buffer.length
+        true
+      end
+    end
+  end
+end