amun 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6430d19551a385610563d0305e205315fb57afd3
+  data.tar.gz: d17d801b580e7cb7207713e43f7b635167aa159d
+SHA512:
+  metadata.gz: 33457f2a5eb0d21f8aefee6277673e9473661c78e8c471ff4627a2c3b36676a822a1af8e1d53f70918ff94ee8346c659d65baaaef8d958742a14e83e9ba11585
+  data.tar.gz: b7f75bb84a7875b23be10d43a3513158c1da27dccd82944a620f1ebd5b715ce852b7712b5024ca8509ad84532049ea52d652cef473498c5d924ef6f90f3b6ee9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.4

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+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' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Emad Elsaid
+
+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.md

@@ -0,0 +1,31 @@
+# Amun (Work in progress)
+
+A minimal CLI text editor, built on Ruby, looking for Emacs as it's father and idol.
+
+As developing packages for Emacs with Elisp wasn't always a fun or easy task, Starting a project that leverage ruby ability for fast development will be a good move towards
+an open, easy to extend editor.
+
+When I started this project I had 2 options, taking the VIM way or emacs way, looking in the current state of the two editors, It's obvious that emacs abbroach has a better
+extensibility over VIM, emacs customizability is far superior to VIM, so building this project as a minimal and emacs-like would open the door for vim users to have their own
+bindings as a package like emacs Evil mode, but doing the other way around won't help emacs users.
+
+## Installation
+
+    $ gem install amun
+
+## Usage
+
+amun install an executable to your path, so executing `amun` from your commandline should launch amun
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/blazeeboy/amun.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+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']
+end
+
+task :default => :test

data/amun.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amun/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amun"
+  spec.version       = Amun::VERSION
+  spec.authors       = ["Emad Elsaid"]
+  spec.email         = ["blazeeboy@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."
+  spec.homepage      = "http://www.github.com/blazeeboy/amun"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  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_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"
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "amun"
+require "pry"
+
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/amun

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'amun'
+
+Amun::Application.instance.run

data/lib/amun.rb

@@ -0,0 +1,65 @@
+require 'amun/version'
+require 'amun/event_manager'
+require 'amun/ui/echo_area'
+require 'curses'
+
+module Amun
+  module_function
+
+  class Application
+    attr_accessor :keyboard, :events, :echo_area
+
+    def self.instance
+      @instance ||= new
+    end
+
+    def quit(_event)
+      exit 0
+    end
+
+    def write_char(char)
+      screen.addstr(char.to_s)
+    end
+
+    def run
+      init_curses
+      init_ui
+
+      echo_area.echo 'Press ESC to exit.'
+
+      Thread.new do
+        while ch = screen.get_char
+          keyboard.trigger(ch)
+          echo_area.refresh
+        end
+      end.join
+    end
+
+    def screen
+      @screen ||= Curses.stdscr
+    end
+
+    private
+
+    def initialize(keyboard = EventManager.new, events: EventManager.new)
+      self.keyboard = keyboard
+      self.events = events
+
+      keyboard.bind "\e", self, :quit
+      keyboard.bind_all self, :write_char
+    end
+
+    def init_curses
+      Curses.init_screen
+      Curses.raw
+      Curses.noecho
+      Curses.start_color
+      Curses.stdscr.keypad(true)
+      Curses.ESCDELAY = 0
+    end
+
+    def init_ui
+      self.echo_area = Amun::UI::EchoArea.new
+    end
+  end
+end

data/lib/amun/event_manager.rb

@@ -0,0 +1,81 @@
+module Amun
+  # = Event manager
+  # Stores a stack of methods to call for each event,
+  # when an event is triggered it executes methods in Last-In-First-Out
+  # if a method returned true it continue execution of the next item in stack,
+  # if the method returned false it will stop executing the rest of stack.
+  #
+  # == Usage
+  # could be used to register keyboard events, registering a set of actions to
+  # be executed when a key combination is pressed, the stack implementation will
+  # help stop execution at certain action if it needs to hijack that key.
+  #
+  # Also could be used to as instrumentation tool between modules, some modules
+  # register for event, and others fire it when happens, e.g *Window*
+  # module needs to update it's title when a file is saved, so it
+  # register *update_title* method to *after_file_save* event,
+  # when the *Buffer* module saves a file it should trigger
+  # that event, which executed the *update_title*.
+  class EventManager
+    def initialize
+      @bindings = Hash.new { |h, k| h[k] = [] }
+    end
+
+    # register an *objects*' *method* to be executed when the *event* is triggered
+    #
+    # event(String):: and event to bind the method to
+    # object(Object):: an object or class, that respond to +method+
+    # method(Symbol):: a method name that should be executed when the event is triggered
+    def bind(event, object, method)
+      unless object.respond_to? method
+        raise ArgumentError, "#{method} : is not a method for #{object}"
+      end
+
+      @bindings[event].unshift(object: object, method: method)
+    end
+
+    # remove all occurence of *method* from the *event* stack
+    #
+    # event(String):: the event name
+    # object(Object):: object that we #bind it's method before
+    # method(Symbol):: method name we #bind before
+    def unbind(event, object, method)
+      @bindings[event].delete_if do |binding|
+        binding[:object] == object && binding[:method] == method
+      end
+    end
+
+    # bind an object method to be executed when any event is triggered
+    # it uses a stack called *all* to register this method, this stack will
+    # be executed after the event specific stack is executed and didn't
+    # stop execution
+    def bind_all(object, method)
+      bind :all, object, method
+    end
+
+    # remove the *method* from executing after every event,
+    # only if you registered this method with #bind_all,
+    #
+    # this won't remove the method if it was registered with #bind
+    def unbind_all(object, method)
+      unbind :all, object, method
+    end
+
+    # execute *event* stack of methods in Last-In-First-Out,
+    # then execute methods registered
+    # to be executed after all events with #bind_all method
+    # if any method in this chain returned false, it will stop the rest
+    # of the stack.
+    def trigger(event)
+      trigger_for_event(event, event) && trigger_for_event(:all, event)
+    end
+
+    private
+
+    def trigger_for_event(stack, event)
+      @bindings[stack].all? do |binding|
+        binding[:object].send binding[:method], event
+      end
+    end
+  end
+end

data/lib/amun/helpers/colors.rb

@@ -0,0 +1,65 @@
+require 'curses'
+
+module Amun
+  module Helpers
+    ##
+    # Colors is responsible for registering new colors pairs (foreground and background)
+    # associate the pair with a name, then #use that pair for the next text printed
+    # on screen, also contains styles constants could be passed to #use to print bold
+    # or underline text for example
+    #
+    # it's important to understand that the number of pairs that coul'd be registered
+    # is limited to a number the current terminal specify, so registering, more color
+    # pairs than allowed will result in a RuntimeError.
+    #
+    # color values could be taken from the xterm-256 color schema from here:
+    # https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg
+    module Colors
+      module_function
+
+      ALTCHARSET = Curses::A_ALTCHARSET
+      COLOR = Curses::A_COLOR
+      LOW = Curses::A_LOW
+      STANDOUT = Curses::A_STANDOUT
+      DIM = Curses::A_DIM
+      NORMAL = Curses::A_NORMAL
+      TOP = Curses::A_TOP
+      BLINK = Curses::A_BLINK
+      HORIZONTAL = Curses::A_HORIZONTAL
+      PROTECT = Curses::A_PROTECT
+      UNDERLINE = Curses::A_UNDERLINE
+      BOLD = Curses::A_BOLD
+      INVIS = Curses::A_INVIS
+      REVERSE = Curses::A_REVERSE
+      VERTICAL = Curses::A_VERTICAL
+      CHARTEXT = Curses::A_CHARTEXT
+      LEFT = Curses::A_LEFT
+      RIGHT = Curses::A_RIGHT
+
+      COLORS = Hash.new { |h, k| h[k] = h.length + 1 }
+      private_constant :COLORS
+
+      # register or update a color pair with *foreground* and *background*
+      # colors, this method will raise RuntimeError if we exceeded the limit
+      # of color pairs allowed by the terminal
+      # name(Symbol):: name of pair, could be used with the #use method
+      # foreground(Number):: foreground color in current terminal color schema
+      # background(Number):: background color in current terminal color schema
+      def register(name, foreground, background)
+        if COLORS.size >= Curses.color_pairs - 1
+          raise "Can't register color #{name} as the colors exceeded the limit #{Curses.color_pairs}"
+        end
+
+        Curses.init_pair(COLORS[name], foreground, background)
+      end
+
+      # use color pair for the next printed text
+      # name(Symbol):: a color pair name registered before with #register
+      # type(Colors::Constant):: a text style constant defined in Colors, that manipulate the text style (Bold, Underline, Invert colors)
+      def use(name, type = NORMAL)
+        index = COLORS.key?(name) ? COLORS[name] : 0
+        Curses.attron(Curses.color_pair(index)| type)
+      end
+    end
+  end
+end

data/lib/amun/ui/echo_area.rb

@@ -0,0 +1,26 @@
+require 'curses'
+
+module Amun
+  module UI
+    # a line that is rendered by default at the end on the screen
+    # takes one line height and extends to take the whole width of screen
+    # should be linked to \*messages\* memory buffer and each time the #log
+    # is called it will display the message next time #render is called
+    class EchoArea
+      def initialize
+        @window = Curses::Window.new(1, Curses.cols, Curses.lines - 1, 0)
+      end
+
+      # display a *message* in the echo area
+      def echo(message)
+        @window << message
+      end
+
+      # render the echo area window
+      def refresh
+        @window.noutrefresh
+        @window.clear
+      end
+    end
+  end
+end

data/lib/amun/version.rb

@@ -0,0 +1,3 @@
+module Amun
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: amun
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Emad Elsaid
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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.
+email:
+- blazeeboy@gmail.com
+executables:
+- amun
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- amun.gemspec
+- bin/console
+- bin/setup
+- exe/amun
+- lib/amun.rb
+- lib/amun/event_manager.rb
+- lib/amun/helpers/colors.rb
+- lib/amun/ui/echo_area.rb
+- lib/amun/version.rb
+homepage: http://www.github.com/blazeeboy/amun
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Emacs like editor, with Ruby core instead of ELisp
+test_files: []