ruco 0.0.10 → 0.0.11

data/Readme.md

@@ -12,6 +12,7 @@ Finished:
  - backspace / delete
  - find / go to line
  - delete line
+ - configuration via `~/.ruco.rb`
 
 Install
 =======
@@ -21,12 +22,39 @@ Usage
 =====
     ruco file.rb
 
+Customize
+=========
+
+    # ~/.ruco.rb
+    Ruco.configure do
+      # bind a key, you can use Integers and Symbols
+      # use "ruco --debug-keys foo" to see which keys are possible
+      # or have a look at lib/ruco/keyboard.rb
+      bind(:"Ctrl+e") do
+        ask('delete ?') do |response|
+          if response or not response
+            editor.move(:to, 0, 0)
+            editor.delete(9999)
+          end
+        end
+      end
+
+      # bind an existing action
+      puts @actions.keys
+
+      bind(:"Ctrl+x", :quit)
+      bind(:"Ctrl+o", :save)
+      bind(:"Ctrl+k", :delete_line)
+
+      # define a new action and bind it to multiple keys
+      action(:first){ editor.move(:to_column, 0) }
+      bind(:"Ctrl+a", :first)
+      bind(:home, :first)
+    end
+
 TODO
 =====
  - support typing unicode like äöß etc (rework size / make strings utf8-aware)
- - bind/action must use instance_exec
- - read .rucorc.rb
- - write key binding guide
  - smart staying at end of line/column when changing line
  - indentation + paste support
  - warnings / messages

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/lib/ruco.rb

@@ -16,4 +16,12 @@ require 'ruco/text_field'
 module Ruco
   VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
   TAB_SIZE = 2
+
+  class << self
+    attr_accessor :application
+  end
+
+  def self.configure(&block)
+    application.instance_exec(&block)
+  end
 end

data/lib/ruco/application.rb

@@ -4,20 +4,14 @@ module Ruco
       @file = file
       @options = options
 
-      @bindings = {}
-      @actions = {}
-
-      @status_lines = 1
-      @command_lines = 1
-      @editor_lines = @options[:lines] - @status_lines - @command_lines
-      create_components
-
       setup_actions
       setup_keys
+      load_user_config
+      create_components
     end
 
     def view
-      @status.view + "\n" + @editor.view + @command.view
+      status.view + "\n" + editor.view + command.view
     end
 
     def cursor
@@ -56,7 +50,7 @@ module Ruco
 
       when :escape then # escape from focused
         @focused.reset
-        @focused = @editor
+        @focused = editor
       end
     end
 
@@ -71,22 +65,30 @@ module Ruco
     end
 
     def ask(question, options={}, &block)
-      @focused = @command
-      @command.ask(question, options) do |response|
-        @focused = @editor
+      @focused = command
+      command.ask(question, options) do |response|
+        @focused = editor
         block.call(response)
       end
     end
 
+    def configure(&block)
+      instance_exec(&block)
+    end
+
     private
 
+    attr_reader :editor, :status, :command
+
     def setup_actions
+      @actions = {}
+
       action :save do
-        @editor.save
+        editor.save
       end
 
       action :quit do
-        if @editor.modified?
+        if editor.modified?
           ask("Loose changes? Enter=Yes Esc=Cancel") do
             :quit
           end
@@ -96,19 +98,20 @@ module Ruco
       end
 
       action :go_to_line do
-        ask('Go to Line: '){|result| @editor.move(:to_line, result.to_i) }
+        ask('Go to Line: '){|result| editor.move(:to_line, result.to_i - 1) }
       end
 
       action :delete_line do
-        @editor.delete_line
+        editor.delete_line
       end
 
       action :find do
-        ask("Find: ", :cache => true){|result| @editor.find(result) }
+        ask("Find: ", :cache => true){|result| editor.find(result) }
       end
     end
 
     def setup_keys
+      @bindings = {}
       bind :"Ctrl+s", :save
       bind :"Ctrl+w", :quit
       bind :"Ctrl+q", :quit
@@ -117,11 +120,21 @@ module Ruco
       bind :"Ctrl+d", :delete_line
     end
 
+    def load_user_config
+      Ruco.application = self
+      config = File.expand_path("~/.ruco.rb")
+      load config if File.exist?(config)
+    end
+
     def create_components
-      @editor = Ruco::Editor.new(@file, :lines => @editor_lines, :columns => @options[:columns])
+      @status_lines = 1
+      command_lines = 1
+      editor_lines = @options[:lines] - @status_lines - command_lines
+      
+      @editor = Ruco::Editor.new(@file, :lines => editor_lines, :columns => @options[:columns])
       @status = Ruco::StatusBar.new(@editor, :columns => @options[:columns])
       @command = Ruco::CommandBar.new(:columns => @options[:columns])
-      @command.cursor_line = @editor_lines
+      command.cursor_line = editor_lines
       @focused = @editor
     end
   end

data/lib/ruco/core_ext/object.rb

@@ -14,4 +14,33 @@ end
 EOS
     end
   end
-end
+end
+
+class Object
+  unless defined? instance_exec # 1.9
+    module InstanceExecMethods #:nodoc:
+    end
+    include InstanceExecMethods
+
+    # Evaluate the block with the given arguments within the context of
+    # this object, so self is set to the method receiver.
+    #
+    # From Mauricio's http://eigenclass.org/hiki/bounded+space+instance_exec
+    def instance_exec(*args, &block)
+      begin
+        old_critical, Thread.critical = Thread.critical, true
+        n = 0
+        n += 1 while respond_to?(method_name = "__instance_exec#{n}")
+        InstanceExecMethods.module_eval { define_method(method_name, &block) }
+      ensure
+        Thread.critical = old_critical
+      end
+
+      begin
+        send(method_name, *args)
+      ensure
+        InstanceExecMethods.module_eval { remove_method(method_name) } rescue nil
+      end
+    end
+  end
+end

data/ruco.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruco}
-  s.version = "0.0.10"
+  s.version = "0.0.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]

data/spec/ruco/application_spec.rb

@@ -34,7 +34,7 @@ describe Ruco::Application do
     app.key(50) # 2
     app.key(:enter)
     app.view.should == "#{status}123\n456\n789\n#{command}"
-    app.cursor.should == [3,0] # 0 offset + 1 for statusbar
+    app.cursor.should == [2,0] # 0 offset + 1 for statusbar
   end
 
   describe 'closing' do
@@ -59,6 +59,22 @@ describe Ruco::Application do
     end
   end
 
+  describe 'go to line' do
+    it "goes to the line" do
+      app.key(:"Ctrl+g")
+      app.key(?2)
+      app.key(:enter)
+      app.cursor.should == [2,0] # status bar +  2
+    end
+
+    it "goes to 1 when strange stuff entered" do
+      app.key(:"Ctrl+g")
+      app.key(?0)
+      app.key(:enter)
+      app.cursor.should == [1,0] # status bar +  1
+    end
+  end
+
   describe :bind do
     it "can execute bound stuff" do
       test = 0
@@ -79,4 +95,16 @@ describe Ruco::Application do
       test.should == 1
     end
   end
+
+  describe '.ruco.rb' do
+    it "loads it and can use the bound keys" do
+      Tempfile.string_as_file("Ruco.configure{ bind(:'Ctrl+e'){ @editor.insert('TEST') } }") do |file|
+        File.stub!(:exist?).and_return true
+        File.should_receive(:expand_path).with("~/.ruco.rb").and_return file
+        app.view.should_not include('TEST')
+        app.key(:"Ctrl+e")
+        app.view.should include("TEST")
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,15 @@
 $LOAD_PATH.unshift 'lib'
-require 'ruco'
+require 'ruco'
+
+require 'tempfile'
+class Tempfile
+  def self.string_as_file(data)
+    result = nil
+    Tempfile.open('foo') do |f|
+      f.print data
+      f.close
+      result = yield(f.path)
+    end
+    result
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruco
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 0
-  - 10
-  version: 0.0.10
+  - 11
+  version: 0.0.11
 platform: ruby
 authors: 
 - Michael Grosser