rumacs 0.0.1

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Jashank Jeremy.
+
+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,6 @@
+rumacs
+======
+
+[![Build Status](https://secure.travis-ci.org/Jashank/rumacs.png?branch=master)](http://travis-ci.org/Jashank/rumacs)
+
+`rumacs` is an Emacs-alike lightweight text editor in Ruby.

data/Rakefile

@@ -0,0 +1,135 @@
+# -*- ruby -*-
+require 'rubygems'
+require 'rake'
+require 'rdoc'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => [:test]
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg|coverage)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end

data/bin/rumacs

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# -*- ruby -*-
+
+require 'rubygems'
+require 'rumacs'
+
+Rumacs::init()

data/lib/rumacs.rb

@@ -0,0 +1,58 @@
+# -*- ruby -*-
+
+require 'rubygems'
+
+module Rumacs
+  VERSION = '0.0.1'
+
+  def self.version
+    return VERSION
+  end
+
+  KNOWN_BACKENDS = [nil, :curses]
+  $backend = nil
+
+  def self.backend(new_backend)
+    if KNOWN_BACKENDS.include?(new_backend)
+      $backend = new_backend
+      load "rumacs/screen/#{$backend}.rb"
+    else
+      raise Exception "unknown backend #{new_backend}, known backends are #{KNOWN_BACKENDS}"
+    end
+  end
+
+  def self.init()
+    backend(:curses)
+    $screen = Rumacs::Screen.new
+    $filemgr = Rumacs::Files.new
+
+    $screen.init_screen do
+      $filemgr.load_text(<<LOAD_TEXT
+Welcome to Rumacs #{VERSION}!
+========================
+
+C-l :: backend.redraw
+
+C-p, up :: point_move -1 0
+C-n, down :: point_move 1 0
+C-b, left :: point_move 0 -1
+C-f, right :: point_move 0 1
+
+C-a, home :: point_set nil 0
+C-e, end:: point_set nil 0
+
+C-x [...] :: compound_command_x
+C-x C-c :: kill_rumacs
+
+C-c [...] :: compound_command_c
+
+[[other functionality to be implemented]]
+LOAD_TEXT
+)
+      $screen.key_loop
+    end
+  end
+
+  autoload :Screen, 'rumacs/screen'
+  autoload :Files, 'rumacs/files'
+end

data/lib/rumacs/files.rb

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'curses'
+
+module Rumacs
+  class Files
+    def initialize
+    end
+
+    def load_text(text)
+      $screen.put_lines(text.split("\n"))
+    end
+
+    def load_file(path)
+      nil
+    end
+  end
+end

data/lib/rumacs/screen.rb

@@ -0,0 +1,225 @@
+# -*- ruby -*-
+
+require 'rubygems'
+
+module Rumacs
+  class Screen
+    attr_accessor :rows, :cols
+    attr_accessor :point_row, :point_col
+    attr_accessor :window_row, :window_col
+    attr_accessor :lines
+    attr_accessor :top_row
+    attr_accessor :backend
+
+    def initialize()
+      @rows = 0
+      @cols = 0
+      @point_row = 0
+      @point_col = 0
+      @window_row = 0
+      @window_col = 0
+      @lines = ['']
+      @top_row = 0
+      @backend = Rumacs::Screen::Backend.new(self)
+
+      @selected_keys = ""
+    end
+
+    def init_screen()
+      @backend.init_screen do
+        status_line()
+        yield
+      end
+    end
+
+    def kill_rumacs()
+      @backend.clean_exit
+      exit 0
+    end
+
+    def point_move(row_offset, col_offset)
+      if (row_offset != 0) then
+        shunt_row(row_offset)
+      elsif (col_offset != 0) then
+        shunt_col(col_offset)
+      end
+
+      status_line()
+    end
+
+    def shunt_row(row_offset)
+      if (@point_row <= 0) && (row_offset < 0) then
+        minibuf(:error, "Beginning of buffer") { sleep 1 }
+      elsif (@point_row >= @lines.length) && (row_offset > 0) then
+        minibuf(:error, "End of buffer") { sleep 1 }
+      else
+        @point_row += row_offset
+        if @point_col > ((@lines[@point_row] || '').size) then
+          @point_col = (@lines[@point_row] || '').size
+        end
+      end
+
+      @window_row = @point_row
+    end
+
+    def shunt_col(col_offset)
+      prev_line_length = @lines[@point_row-1].size
+      this_line_length = (@lines[@point_row] || '').size
+      if (@point_col >= this_line_length) && (col_offset > 0) then
+        col_offset = ((@point_col + col_offset) - this_line_length) - 1
+        shunt_row( +1 )
+        @point_col = col_offset
+      elsif (@point_col <= 0) && (col_offset < 0) then
+        shunt_row( -1 )
+        col_offset = prev_line_length - (@point_col + col_offset + 1)
+        @point_col = col_offset
+      else
+        @point_col += col_offset
+      end
+
+      @window_col = @point_col
+    end
+
+    def point_set(row, col)
+      if row === true then
+        @point_row = @lines.size
+      else
+        @point_row = (row || @point_row)
+      end
+
+      if col === true then
+        @point_col = (@lines[@point_row] || 0).size
+      else
+        @point_col = (col || @point_col)
+      end
+
+      @window_col = @point_col
+      status_line()
+    end
+
+    def put_lines(lines)
+      @lines = lines
+      @lines.collect! {|line| line || ''}
+      draw_lines
+    end
+
+    def draw_lines()
+      (0..(@rows-2)).to_a.each do |i|
+        @backend.draw_line(i, 0, @lines[@top_row+i])
+      end
+    end
+
+    def status_line()
+      status_string = "- rumacs - [#{@point_row},(#{@point_col}/#{(@lines[@point_row] || '').size}) inside #{@top_row}..#{@top_row + @rows - 2}] (#{@rows}:#{@cols}:#{$$}) "
+      @backend.draw_line_mode(@rows - 2, 0, status_string+("-" * (@cols - (status_string.size))), :statusbar)
+      @backend.jump_to_point()
+    end
+
+    def minibuf(type, str)
+      if (type == :warning) || (type == :error) then
+        @backend.notify
+      end
+      @backend.draw_line_mode(@rows - 1, 0, str, :minibuf)
+      @backend.jump_to_point()
+      @backend.redraw()
+      yield
+      @backend.draw_line_mode(@rows - 1, 0, " "*(@cols-1), :minibuf)
+      @backend.jump_to_point()
+      @backend.redraw()
+    end
+
+    $known_keys = {
+      # Redaw screen
+      :c_l => lambda {|i| i.backend.redraw },
+
+      # compound keys
+      :c_x => lambda {|i| i.compound_key_x },
+      :c_c => lambda {|i| i.compound_key_c },
+
+      # Point manipulation: screenful at a stroke (M-v and C-v)
+      :m_v => lambda {|i| i.point_move(-(@rows/2), 0) },
+      :pgup => :m_v,
+      :c_v => lambda {|i| i.point_move((@rows/2), 0) },
+      :pgdn => :c_v,
+      
+      # Point manipulation: character at a stroke (C-p C-n C-b C-f)
+      :c_p => lambda {|i| i.point_move(-1,  0) },
+      :up => :c_p,
+      :c_n => lambda {|i| i.point_move( 1,  0) },
+      :down => :c_n,
+      :c_b => lambda {|i| i.point_move( 0, -1) },
+      :left => :c_b,
+      :c_f => lambda {|i| i.point_move( 0,  1) },
+      :right => :c_f,
+
+      # Point manipulation: jumps
+      :c_a => lambda {|i| i.point_set(nil, 0) },
+      :home => :c_a,
+      :c_e => lambda {|i| i.point_set(nil, true) },
+      :end => :c_e,
+    }
+
+    $known_compound_x = {
+      #:c_c => lambda {|i| i.compound_key_c },
+      :c_x => lambda {|i| i.compound_key_x },
+
+      :c_c => lambda {|i| i.kill_rumacs },
+    }
+
+    $known_compound_c = {
+      :c_c => lambda {|i| i.compound_key_c },
+      :c_x => lambda {|i| i.compound_key_x },
+    }
+
+    def unbound_key_warning(key)
+      minibuf(:warning, "'#{key.to_s}' is undefined.") { sleep 1 }
+    end
+
+    #
+    # This function is RECURSIVE!  Do NOT refactor!
+    #
+    def call_key_in_table(key, table, rescuer)
+      if key.is_a? Symbol then
+        if table.key?(key) then
+          if table[key].is_a? Proc then
+            table[key].call(self)
+          elsif table[key].is_a? Symbol then
+            call_key_in_table(table[key], table, rescuer)
+          else
+            raise Exception.new("unknown type of known_key in #{key}")
+          end
+        else
+          unbound_key_warning(key)
+        end
+      else
+        rescuer.call(key)
+      end
+    end
+
+    def call_key(c)
+      call_key_in_table(c, $known_keys, lambda {|key| $filemgr.insert_character_at_point(key) })
+    end
+
+    def compound_key_x()
+      @selected_keys += "C-x "
+      minibuf(:notice, "#{@selected_keys}...") do
+        call_key_in_table(@backend.next_character, $known_compound_x, lambda {|key| abort_command })
+      end
+      @selected_keys = ""
+    end
+
+    def compound_key_c()
+      @selected_keys += "C-c "
+      minibuf(:notice, "#{@selected_keys}...") do
+        call_key_in_table(@backend.next_character, $known_compound_c, lambda {|key| abort_command })
+      end
+      @selected_keys = ""
+    end
+
+    def key_loop()
+      loop do
+        call_key(@backend.next_character)
+      end
+    end
+  end
+end

data/lib/rumacs/screen/curses.rb

@@ -0,0 +1,149 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'curses'
+require 'io/console'
+require 'colorize'
+
+module Rumacs
+  class Screen
+    class Backend
+      def initialize(screen)
+        @screen = screen
+        rows, cols = $stdin.winsize
+        @screen.rows = rows
+        @screen.cols = cols
+      end
+      
+      def init_screen()
+        Curses.init_screen
+        Curses.raw
+        Curses.noecho # do not show typed keys
+        Curses.stdscr.keypad(true) # enable arrow keys
+
+        # trap signals from kill; key strokes don't trigger anymore
+        for i in 1 .. 15  # SIGHUP .. SIGTERM
+          if trap(i, "SIG_IGN") != 0 then  # 0 for SIG_IGN
+            trap(i) do |sig|
+              Curses.close_screen
+              puts "rumacs received an unexpected signal #{sig}."
+              exit sig
+            end
+          end
+        end
+
+        begin
+          yield
+        ensure
+          clean_exit
+        end
+      end
+
+      def clean_exit()
+        Curses.close_screen
+      end
+
+      CHARACTER_MAP = {
+        Curses::Key::PPAGE => :pgup,
+        Curses::Key::NPAGE => :pgdn,
+        Curses::Key::UP => :up,
+        Curses::Key::DOWN => :down,
+        Curses::Key::LEFT => :left,
+        Curses::Key::RIGHT => :right,
+        Curses::Key::HOME => :home,
+        Curses::Key::END => :end,
+        Curses::Key::IC => :insert,
+        Curses::Key::BACKSPACE => :backspace,
+        127 => :backspace,
+        Curses::Key::DC => :delete,
+        Curses::Key::BTAB => :backtab,
+
+        265 => :f_1,
+        266 => :f_2,
+        267 => :f_3,
+        268 => :f_4,
+        269 => :f_5,
+        270 => :f_6,
+        271 => :f_7,
+        272 => :f_8,
+        273 => :f_9,
+        274 => :f_10,
+        275 => :f_11,
+        276 => :f_12,
+
+        1   => :c_a,
+        2   => :c_b,
+        3   => :c_c,
+        4   => :c_d,
+        5   => :c_e,
+        6   => :c_f,
+        7   => :c_g,
+        8   => :c_h,
+        9   => :c_i,
+        10  => :c_j,
+        11  => :c_k,
+        12  => :c_l,
+        13  => :c_m,
+        14  => :c_n,
+        15  => :c_o,
+        16  => :c_p,
+        17  => :c_q,
+        18  => :c_r,
+        19  => :c_s,
+        20  => :c_t,
+        21  => :c_u,
+        22  => :c_v,
+        23  => :c_w,
+        24  => :c_x,
+        25  => :c_y,
+        26  => :c_z,
+
+        27  => :c_3,
+        28  => :c_4,
+        29  => :c_5,
+        30  => :c_6,
+        31  => :c_7,
+        34  => :c_0,
+      }
+
+      def next_character
+        c = Curses.getch
+
+        if CHARACTER_MAP.include? c then
+          c = CHARACTER_MAP[c]
+        end
+
+        c
+      end
+
+      def redraw()
+        Curses.refresh
+      end
+
+      def jump_to_point()
+        Curses.setpos(@screen.point_row, @screen.point_col)
+      end
+
+      def draw_line(row, col, text)
+        Curses.setpos(row, col)
+        Curses.addstr((text || ''))
+        Curses.refresh
+      end
+
+      def notify()
+        Curses.beep
+      end
+
+      def draw_line_mode(row, col, text, mode)
+        curses_modes = {
+          :statusbar => Curses::A_REVERSE,
+          :minibuf => Curses::A_NORMAL,
+        }
+
+        Curses.attron(curses_modes[mode])
+        draw_line(row, col, text)
+        Curses.attroff(curses_modes[mode])
+      end      
+    end
+  end
+end

data/lib/rumacs/screen/curses_helper.rb

@@ -0,0 +1,13 @@
+# Assorted helper functions for Curses
+module Rmacs
+  class Screen
+
+    C_A = 1
+    C_B = 2
+    C_C = 3
+    C_D = 4
+    C_E = 5
+    C_F = 6
+
+  end
+end

data/rumacs.gemspec

@@ -0,0 +1,45 @@
+# -*- ruby -*-
+
+Gem::Specification.new do |s|
+  s.name              = 'rumacs'
+  s.version           = '0.0.1'
+  s.date              = '2012-08-19'
+
+  s.summary     = "Emacs-alike lightweight text editor, in Ruby"
+  s.description = "rumacs is a lightweight text editor functionally similar to the Emacs family of text editors."
+
+  s.authors  = ["Jashank Jeremy"]
+  s.email    = 'jashank@rulingia.com'
+  s.homepage = 'http://jashank.github.com/rumacs'
+
+  s.require_paths = %w[lib]
+
+  s.executables = ["rumacs"]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_development_dependency('rake', "~> 0.9")
+  s.add_development_dependency('rdoc', "~> 3.11")
+
+  s.add_runtime_dependency('activesupport', "~> 3.2.0")
+  s.add_runtime_dependency('colorize', "~> 0.5.0")
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    bin/.directory
+    bin/rumacs
+    lib/.directory
+    lib/rumacs.rb
+    lib/rumacs/files.rb
+    lib/rumacs/screen.rb
+    lib/rumacs/screen/curses.rb
+    lib/rumacs/screen/curses_helper.rb
+    rumacs.gemspec
+  ]
+  # = MANIFEST =
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rumacs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jashank Jeremy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: rumacs is a lightweight text editor functionally similar to the Emacs
+  family of text editors.
+email: jashank@rulingia.com
+executables:
+- rumacs
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/.directory
+- bin/rumacs
+- lib/.directory
+- lib/rumacs.rb
+- lib/rumacs/files.rb
+- lib/rumacs/screen.rb
+- lib/rumacs/screen/curses.rb
+- lib/rumacs/screen/curses_helper.rb
+- rumacs.gemspec
+homepage: http://jashank.github.com/rumacs
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 399386248576728796
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 399386248576728796
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Emacs-alike lightweight text editor, in Ruby
+test_files: []