merrol 0.0.2

data/lib/merrol/keyboard_map.rb

@@ -0,0 +1,136 @@
+require 'gtk2'
+require 'gtksourceview2'
+require 'yaml'
+require File.expand_path(File.dirname(__FILE__) + '/yaml.rb')
+require File.expand_path(File.dirname(__FILE__) + '/file.rb')
+require_relative 'command_dispatcher'
+include Merrol::CommandDispatcher
+load_commands
+
+window = Gtk::Window.new "Keyboard Shortcuts"
+window.set_default_size(300, 200)
+window.signal_connect("destroy") do |w|
+  Gtk.main_quit
+end
+window.signal_connect('key_press_event') do |w, e|
+  if !toggle_button(shortcut(e), true)
+    shortcut = shortcut(e)
+    help = command_for(key_from_event(e)).last
+    $help.buffer.text = help if help
+  end
+end
+
+window.signal_connect('key_release_event') do |w, e|
+  toggle_button shortcut(e), false
+end
+
+def toggle_button modifier, active
+  if %w(CTRL ALT SHIFT).include?(modifier)
+    $modifiers.each do |button|
+      button.active = active if button.children.first.text.split("\n").first == modifier
+    end
+    render_keys
+    true
+  else
+    false
+  end
+end
+
+def render_keys
+  $rows.children[0..-2].each do |row|
+    row.children.each do |button|
+      next if button.is_a?(Gtk::Label)
+      label = button.children.first
+      key = label.text.split("\n").first
+      command = command_for(key).first
+      button.sensitive = !command.nil? unless %w(CTRL SHIFT ALT).include?(key)
+      label.markup = "<small><b>#{key}</b>\n#{command}</small>"
+    end
+  end
+end
+
+def shortcut shortcut
+  keys = []
+  key = key_from_event(shortcut)
+  return key if %w(CTRL SHIFT ALT).include?(key)
+  keys << "CTRL" if shortcut.state.control_mask?
+  keys << "ALT" if shortcut.state.mod1_mask?
+  keys << "SHIFT" if shortcut.state.shift_mask?
+  keys << key
+  keys.join('+')
+end
+
+def key_from_event e
+  unmodified_keyval = Gdk::Keymap.default.lookup_key(e.hardware_keycode, 0, 0)
+  key = Gdk::Keyval.to_name(unmodified_keyval).upcase
+  {'RETURN' => 'ENTER', 'ESCAPE' => 'ESC',
+    'CONTROL_L' => 'CTRL', 'ALT_L' => 'ALT', 'SHIFT_L' => 'SHIFT',
+    'CONTROL_R' => 'CTRL', 'ALT_R' => 'ALT', 'SHIFT_R' => 'SHIFT'
+  }[key] || key
+end
+
+keys = [
+  %w(ESC F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12),
+  %w(` 1 2 3 4 5 6 7 8 9 0 - = BACK),
+  %w(TAB Q W E R T Y U I O P [ ] ENTER),
+  %w(CAPS A S D F G H J K L ; ' #),
+  %w(SHIFT \\ Z X C V B N M , . / SHIFT),
+  %w(CTRL WIN ALT SPACE ALT FN CTRL)
+]
+
+$modifiers = []
+$rows = Gtk::VBox.new
+
+keys.each do |row|
+  hbox = Gtk::HBox.new
+  $rows.pack_start(hbox, false, false, 1)
+  row.each do |key|
+    command = @commands[key].first if @commands[key]
+    if %w(CTRL SHIFT ALT).include?(key)
+      button = Gtk::ToggleButton.new
+      $modifiers << button
+      button.signal_connect('toggled') do |w, e|
+        modifier = w.children.first.text.split("\n").first
+        toggle_button modifier, w.active?
+      end
+
+    else
+      button = Gtk::Button.new
+      button.signal_connect('clicked') do |w, e|
+        key = w.children.first.text.split("\n").first
+        $help.buffer.text = command_for(key).last
+      end
+      button.sensitive = false unless command
+    end
+    label = Gtk::Label.new
+    label.markup = "<small><b>#{key}</b>\n#{command}</small>"
+    button.add(label)
+    button.width_request = key.length * 10 + 40
+    button.width_request = 300 if key == 'SPACE'
+    hbox.pack_start(button, true, true, 1)
+
+    hbox.pack_start(Gtk::Label.new.set_width_request(50), true, true, 1) if key == '#'
+  end
+end
+
+$help = Gtk::TextView.new
+$help.buffer.text = "Use the keyboard or mouse to press (or click) on modifiers and keys to see more information."
+$help.height_request = 60
+$help.wrap_mode = Gtk::TextTag::WRAP_WORD
+$help.sensitive = false
+$help.modify_font Pango::FontDescription.new('FreeSans Normal 11')
+$rows.pack_start(Gtk::Frame.new.add($help), true, true, 2)
+window.add($rows)
+
+def command_for key
+  modifiers = ''
+  modifiers << 'CTRL+' if $modifiers[2].active?
+  modifiers << 'ALT+' if $modifiers[3].active?
+  modifiers << 'SHIFT+' if $modifiers[0].active?
+  @commands[modifiers + key] || []
+end
+
+window.show_all
+
+Gtk.main
+

data/lib/merrol/lib/application.rb

@@ -0,0 +1,29 @@
+module Merrol
+  class Application
+    attr_reader :views, :controllers
+
+    def initialize working_dir, paths
+      @views = WidgetBuilder.build :main, :status_bar, :hbox, :file_list, :scroll_bars, :edit, :file_status, :file_path
+      main_view = @views[:main]
+      commands = Commands.new main_view
+
+      @controllers = {}
+      controller_paths = Dir[File.app_relative('lib/merrol/controllers') + '/*_controller.rb']
+      controller_paths.each do |controller|
+        controller = File.basename(controller, '.rb')
+        name = controller.gsub(/_controller/, '')
+        @controllers[name] = eval(controller.classify).new commands, @views
+      end
+
+      @controllers['main'].working_dir = working_dir
+      @controllers['file'].load_all paths
+
+      # TODO: move both to a controller
+      @views[:file_path].text = paths.last if paths.last
+      @views[:edit].grab_focus
+
+      main_view.show_all
+    end
+  end
+end
+

data/lib/merrol/lib/commands.rb

@@ -0,0 +1,40 @@
+module Merrol
+  class Commands
+    def initialize(window)
+      @accel_group = Gtk::AccelGroup.new
+      window.add_accel_group @accel_group
+      load
+    end
+
+    def register controller
+      @commands[controller.name.to_s].each do |command, detail|
+        if detail['key'] =~ /TAB/
+          Gtk::Window.toplevels.first.signal_connect('key_press_event') do |widget, event|
+            if detail['key'] == Shortcut.from(event)
+              controller.send(command)
+            else
+              false
+            end
+          end
+        else
+          @accel_group.connect "<#{APP_NAME}>/#{controller.name}/#{command}" do
+            controller.send(command)
+          end
+        end
+      end
+    end
+
+  private
+
+    def load
+      @commands = YAML.load_config 'commands'
+      @commands.each do |category, commands|
+        commands.each do |command, detail|
+          event = Shortcut.to_event(detail['key'])
+          Gtk::AccelMap.add_entry("<#{APP_NAME}>/#{category}/#{command}", event.keyval, event.state)
+        end
+      end
+    end
+  end
+end
+

data/lib/merrol/lib/file.rb

@@ -0,0 +1,6 @@
+class File
+  def self.app_relative relative_path
+    expand_path join(dirname(__FILE__), '..', '..', '..', relative_path)
+  end
+end
+

data/lib/merrol/lib/shortcut.rb

@@ -0,0 +1,35 @@
+module Merrol
+  class Shortcut
+    def self.from event
+      shortcut = Gdk::Keyval.to_name(event.keyval).upcase
+      shortcut = shortcut.gsub(/(_L|_R)$/, '').gsub('CONTROL', 'CTRL').gsub('ESCAPE', 'ESC').gsub('RETURN', 'ENTER')
+
+      if !%w(CTRL ALT SHIFT).include? shortcut
+        keys = []
+        keys << "CTRL" if event.state.control_mask?
+        keys << "ALT" if event.state.mod1_mask?
+        keys << "SHIFT" if event.state.shift_mask?
+        keys << shortcut
+        shortcut = keys.join('+')
+      end
+      shortcut
+    end
+
+    def self.to_event key, release = nil
+      event = Gdk::EventKey.new(release ? Gdk::Event::KEY_RELEASE : Gdk::Event::KEY_PRESS)
+      key = key.gsub(/ESC/, 'ESCAPE').gsub(/ENTER/, 'RETURN')
+
+      if %w(CTRL ALT SHIFT).include? key
+        key = key.gsub('CTRL', 'CONTROL').capitalize + '_L'
+      else
+        event.state |= Gdk::Window::CONTROL_MASK if key =~ /CTRL+/
+        event.state |= Gdk::Window::MOD1_MASK if key =~ /ALT+/
+        event.state |= Gdk::Window::SHIFT_MASK if key =~ /SHIFT+/
+        key = key.split('+').last.capitalize
+      end
+      event.keyval = Gdk::Keyval.from_name(key)
+      event
+    end
+  end
+end
+

data/lib/merrol/lib/widget_builder.rb

@@ -0,0 +1,49 @@
+module Merrol
+  class WidgetBuilder
+    def self.build *view_names
+      widgets = {}
+      view_names.each do |view_name|
+        yaml = YAML.load_view(view_name.to_s)
+        widget = nil
+        add_to = nil
+        pack = {:expand => false, :fill => false, :padding => 0}
+        yaml['layout'].merge(yaml['options'] || {}).each do |key, value|
+          if key == 'type'
+            widget = eval('Gtk::' + value).new
+          elsif value.is_a?(Hash)
+            widget.send("#{key}=", constants_from(value))
+          elsif key == 'add_to'
+            add_to = widgets[value.to_sym]
+          elsif %w(expand fill padding).include?(key)
+            pack[key.to_sym] = value
+          else
+            widget.send("#{key}=", value)
+          end
+        end
+
+        if add_to
+          container = add_to.container if add_to.respond_to?(:container)
+          container ||=  add_to
+          if container.is_a?(Gtk::Bin)
+            container.add(widget)
+          else
+            container.pack_start(widget, pack[:expand], pack[:fill], pack[:padding])
+          end
+        end
+        widgets[view_name] = widget
+      end
+      widgets
+    end
+
+  private
+
+    def self.constants_from value
+      type = value['type']
+      value = value['value']
+      value = [value] unless value.is_a?(Array)
+
+      eval(value.map{ |v| ['Gtk', type, v].compact.join('::') }.join(' | '))
+    end
+  end
+end
+

data/lib/merrol/lib/yaml.rb

@@ -0,0 +1,10 @@
+module YAML
+  LOCATIONS = {'config' => 'config', 'view' => 'lib/merrol/views'}
+
+  def self.method_missing(meth, *args, &block)
+    dir = LOCATIONS[meth.to_s.gsub(/load_/, '')]
+    super unless dir
+    self.load File.open(File.app_relative("#{dir}/#{args[0]}.yml"))
+  end
+end
+

data/lib/merrol/models/source_model.rb

@@ -0,0 +1,44 @@
+module Merrol
+  class SourceModel < Gtk::SourceBuffer
+
+    def initialize path = nil
+      super(nil)
+      @path = path
+      load
+      language_from_filetype
+    end
+
+    def save
+      File.open(@path, 'w') {|f| f.write(self.text) }
+      self.modified = false
+    end
+
+    def load
+      if @path && File.exist?(@path)
+        begin_not_undoable_action { self.text = File.read(@path) }
+        self.modified = false
+      end
+    end
+
+    def language_from_filetype
+      yaml = YAML.load_config('language')
+      yaml.each do |name, hash|
+        hash['pattern'].split(' ').each do |pattern|
+          if pattern[0..0] == '.' && @path[0..0] != '.'
+            name_or_ext = File.extname(@path)
+          else
+            name_or_ext = File.basename(@path)
+          end
+
+          bang_line = "#!/usr/bin/env #{hash['bang']}"
+          file_exists = hash['exists'] ? File.exist?(hash['exists']) : true
+          if (pattern == name_or_ext || self.text[0..(bang_line.length - 1)] == bang_line) && file_exists
+            self.language = Gtk::SourceLanguageManager.new.get_language name
+            return
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/merrol/views/edit.yml

@@ -0,0 +1,50 @@
+layout:
+  type: SourceView
+  add_to: scroll_bars
+
+options:
+  auto_indent: true
+  theme: config/styles/Railscasts
+  font: monospace 9
+  highlight_current_line: true
+  indent_on_tab: true
+  indent_width: 2
+  insert_spaces_instead_of_tabs: true
+  right_margin_position: 120
+  show_line_marks: false
+  show_line_numbers: true
+  show_right_margin: true
+  tab_width: 2
+
+#TODO: Provide support for buffer preferences
+#buffer:
+  highlight_matching_brackets: true
+#  bracket_match_style:
+#    type: SourceStyle
+#    background: nil
+#    line_background: nil
+#    foreground: nil
+#    bold: false
+#    italic: false
+#    mask: false
+#    strikethrough: false
+#    underline: false
+
+  # value can be one or more of the following as an array or singular
+  # DRAW_SPACES_SPACE, DRAW_SPACES_TAB, DRAW_SPACES_NEWLINE
+  # DRAW_SPACES_NBSP, DRAW_SPACES_LEADING, DRAW_SPACES_TEXT
+  # DRAW_SPACES_TRAILING, or just DRAW_SPACES_ALL
+#  draw_spaces:
+#    type: SourceView
+#    value: [DRAW_SPACES_SPACE, DRAW_SPACES_NEWLINE]
+
+  # SMART_HOME_END_BEFORE, SMART_HOME_END_BEFORE, SMART_HOME_END_BEFORE
+  smart_home_end:
+    type: SourceView
+    value: SMART_HOME_END_BEFORE
+
+  # WRAP_NONE, WRAP_CHAR, WRAP_WORD, WRAP_WORD_CHAR
+  wrap_mode:
+    type: TextTag
+    value: WRAP_WORD
+

data/lib/merrol/views/file_list.yml

@@ -0,0 +1,11 @@
+layout:
+  type: ListView
+  add_to: hbox
+  initially_hidden: true
+
+options:
+  padding: 2
+  width_request: 250
+  border_width: 2
+  font: arial 9
+

data/lib/merrol/views/file_path.yml

@@ -0,0 +1,8 @@
+layout:
+  type: Label
+  add_to: status_bar
+  padding: 2
+
+options:
+  font: arial 9
+

data/lib/merrol/views/file_status.yml

@@ -0,0 +1,6 @@
+layout:
+  type: Image
+  add_to: status_bar
+  padding: 2
+  file: data/images/saved.svg
+

data/lib/merrol/views/hbox.yml

@@ -0,0 +1,6 @@
+layout:
+  type: HBox
+  add_to: main
+  expand: true
+  fill: true
+

data/lib/merrol/views/main.yml

@@ -0,0 +1,9 @@
+layout:
+  type: Window
+  icon: data/images/merrol2.svg
+  container: VBox
+
+options:
+  default_position: 0, 0
+  default_size: 1000, 700
+

data/lib/merrol/views/scroll_bars.yml

@@ -0,0 +1,15 @@
+layout:
+  type: ScrolledWindow
+  add_to: hbox
+  expand: true
+  fill: true
+  padding: 1
+
+options:
+  hscrollbar_policy:
+    type:
+    value: POLICY_AUTOMATIC # show horizontal scrollbar: POLICY_NEVER, POLICY_AUTOMATIC, POLICY_ALWAYS
+  vscrollbar_policy:
+    type:
+    value: POLICY_AUTOMATIC # show vertical scrollbar: POLICY_NEVER, POLICY_AUTOMATIC, POLICY_ALWAYS
+

data/lib/merrol/views/status_bar.yml

@@ -0,0 +1,7 @@
+layout:
+  type: HBox
+  add_to: main
+  expand: false
+  fill: true
+  padding: 1
+

data/lib/merrol.rb

@@ -0,0 +1,16 @@
+require_relative  'prerequisites'
+
+require 'gtk2'
+require 'gtksourceview2'
+require 'yaml'
+require 'active_support/inflector'
+require 'observer'
+
+APP_NAME = "Merrol"
+WORKING_DIR = Dir.getwd
+
+require "#{File.dirname(__FILE__)}/merrol/controllers/controller"
+merrol_path = "#{File.dirname(__FILE__)}/merrol/**/*.rb"
+to_include = Dir[merrol_path]
+to_include.each { |file| require file unless file.include?('keyboard_map') }
+

data/lib/prerequisites.rb

@@ -0,0 +1,54 @@
+class LibNotFoundError < StandardError; end
+
+def check_packages
+  selections = `dpkg --get-selections`
+  libs = %w(libglib2.0-dev libatk1.0-dev libpango1.0-dev libgtk2.0-dev libgtksourceview2.0-dev)
+  libs.each do |lib|
+    raise LibNotFoundError unless selections =~ Regexp.new(lib)
+  end
+rescue LibNotFoundError => e
+  puts 'Some packages needed for installation are missing'
+  puts 'To install the rquired packages please run:'
+  puts '    sudo apt-get install libglib2.0-dev libatk1.0-dev libpango1.0-dev libgtk2.0-dev libgtksourceview2.0-dev'
+  puts
+  exit
+end
+
+def install_ruby_gnome2
+  trap("INT") { puts "\rAborted."; exit }
+
+  puts "Some ruby libraries need to be compiled and installed to run merrol (gtk2 and gtksourceview2)"
+  puts "Press ENTER to install or CTRL+C to abort"
+  gets
+
+  logfile = '/tmp/ruby-gnome2-install.log'
+
+  package = 'ruby-gnome2-all-0.90.4'
+  system "gem install pkg-config > #{logfile}"
+  puts 'pkg-config installed'
+
+  puts 'Downloading sources...'
+  system "cd /tmp && wget http://downloads.sourceforge.net/ruby-gnome2/#{package}.tar.gz >> #{logfile}"
+
+  puts 'Extracting sources...'
+  system "cd /tmp && tar xf #{package}.tar.gz"
+
+  puts 'Configuring ...'
+  system "cd /tmp/#{package} && ruby extconf.rb >> #{logfile}"
+
+  puts 'Building ...'
+  system "cd /tmp/#{package} && sudo make >> #{logfile}"
+
+  puts 'Installing ...'
+  system "cd /tmp/#{package} && sudo make install >> #{logfile}"
+
+  puts 'Done.'
+end
+
+begin
+  check_packages
+  require 'gtksourceview2'
+rescue LoadError
+  install_ruby_gnome2
+end
+

data/merrol.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name        = "merrol"
+  s.version     = "0.0.2"
+  s.authors     = "Phil Thompson"
+  s.email       = "phil@electricvisions.com"
+  s.homepage    = "http://merrol.com"
+  s.summary     = "MERROL - Minimalist Editor for Ruby, Rails and Other Languages"
+  s.description = "An editor for Ruby, Rails and supporting langauges, written in pure Ruby with an open design to allow customization and improvement."
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "merrol"
+
+  s.add_dependency "activesupport"
+
+  s.add_development_dependency "autotest"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "rspec", '2.0.0'
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- spec/*`.split("\n")
+
+  s.executables  = ['m']
+  s.require_path = 'lib'
+end
+

data/spec/controllers/controller_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Controller do
+  it 'gets the name without controller suffix' do
+    mock_view = mock Gtk::Window, :signal_connect => nil
+    MainController.new(mock(Commands, :register => nil), {:main => mock_view}).name.should == :main
+  end
+
+  it 'access views using <name>_view method' do
+    mock_view = mock Gtk::Window, :signal_connect => nil
+    controller = Controller.new(mock(Commands, :register => nil), {:main => mock_view})
+    controller.main_view.should == mock_view
+  end
+
+  it 'raises method missing error when view not found' do
+    mock_view = mock Gtk::Window, :signal_connect => nil
+    controller = Controller.new(mock(Commands, :register => nil), {:main => mock_view})
+    lambda {controller.non_existent_view}.should raise_error NoMethodError
+  end
+
+  it 'raises method missing error when not a view method' do
+    mock_view = mock Gtk::Window, :signal_connect => nil
+    controller = Controller.new(mock(Commands, :register => nil), {:main => mock_view})
+    lambda {controller.non_existent_method}.should raise_error NoMethodError
+  end
+end
+

data/spec/controllers/edit_controller_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe EditController do
+  before(:each) do
+    @mock_commands = mock Commands, :register => nil
+    @mock_view = mock(Gtk::SourceView)
+    @edit = EditController.new(@mock_commands, {:edit => @mock_view})
+  end
+
+  it 'selects all text' do
+    @mock_view.should_receive(:select_all).with true
+    @edit.select_all
+  end
+
+  it 'deselects all text' do
+    @mock_view.should_receive(:select_all).with false
+    @edit.select_none
+  end
+
+  it 'calls redo on view' do
+    @mock_view.should_receive(:redo)
+    @edit.redo
+  end
+
+  it 'calls undo on view' do
+    @mock_view.should_receive(:undo)
+    @edit.undo
+  end
+
+  it 'calls delete on view' do
+    @mock_buffer = mock SourceModel
+    @mock_view.stub(:buffer).and_return @mock_buffer
+    @mock_buffer.should_receive(:delete_selection).with(true, true)
+    @edit.delete
+  end
+
+end
+