yap-rawline 0.1.0

data/spec/history_buffer_spec.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/rawline/history_buffer.rb"
+
+describe RawLine::HistoryBuffer do
+
+  before :each do
+    @history = RawLine::HistoryBuffer.new(5)
+  end
+
+  it "instantiates an empty array when created" do
+    expect(@history.length).to eq(0)
+  end
+
+  it "allows items to be added to the history" do
+    @history.duplicates = false
+    @history << "line #1"
+    @history << "line #2"
+    @history << "line #3"
+    @history << "line #2"
+    expect(@history).to eq(["line #1", "line #3", "line #2"])
+    @history.duplicates = true
+    @history << "line #3"
+    expect(@history).to eq(["line #1", "line #3", "line #2", "line #3"])
+    @history.exclude = lambda { |i| i.match(/line #[456]/) }
+    @history << "line #4"
+    @history << "line #5"
+    @history << "line #6"
+    expect(@history).to eq(["line #1", "line #3", "line #2", "line #3"])
+  end
+
+  it "does not overflow" do
+    @history << "line #1"
+    @history << "line #2"
+    @history << "line #3"
+    @history << "line #4"
+    @history << "line #5"
+    @history << "line #6"
+    expect(@history.length).to eq(5)
+  end
+
+  it "allows navigation back and forward" do
+    @history.back
+    @history.forward
+    expect(@history.position).to eq(nil)
+    @history << "line #1"
+    @history << "line #2"
+    @history << "line #3"
+    @history << "line #4"
+    @history << "line #5"
+    @history.back
+    @history.back
+    @history.back
+    @history.back
+    @history.back
+    expect(@history.position).to eq(0)
+    @history.back
+    expect(@history.position).to eq(0)
+    @history.forward
+    expect(@history.position).to eq(1)
+    @history.forward
+    @history.forward
+    @history.forward
+    @history.forward
+    expect(@history.position).to eq(4)
+    @history.forward
+    expect(@history.position).to eq(4)
+    @history.cycle = true
+    @history.forward
+    @history.forward
+    expect(@history.position).to eq(1)
+  end
+
+  it "can retrieve the last element or the element at @position via 'get'" do
+    expect(@history.get).to eq(nil)
+    @history << "line #1"
+    @history << "line #2"
+    @history << "line #3"
+    @history << "line #4"
+    @history << "line #5"
+    expect(@history.get).to eq("line #5")
+    @history.back
+    expect(@history.get).to eq("line #4")
+    @history.forward
+    expect(@history.get).to eq("line #5")
+  end
+
+  it "can be cleared and resized" do
+    @history << "line #1"
+    @history << "line #2"
+    @history << "line #3"
+    @history << "line #4"
+    @history << "line #5"
+    @history.back
+    @history.back
+    expect(@history.get).to eq("line #4")
+    @history.resize(6)
+    expect(@history.position).to eq(nil)
+    @history << "line #6"
+    expect(@history.get).to eq("line #6")
+    @history.empty
+    expect(@history).to eq([])
+    expect(@history.size).to eq(6)
+    expect(@history.position).to eq(nil)
+  end
+end

data/spec/keycode_parser_spec.rb

@@ -0,0 +1,96 @@
+require "spec_helper"
+
+require_relative "../lib/rawline/keycode_parser.rb"
+
+describe RawLine::KeycodeParser do
+  subject(:keycode_parser) { described_class.new(keymap) }
+  let(:keymap) { {} }
+
+  describe "#parse_bytes" do
+    def parse_bytes(bytes)
+      keycode_parser.parse_bytes(bytes)
+    end
+
+    context "given a char that isn't in the keymap" do
+      it "returns the byte as a keycode" do
+        expect(parse_bytes(["a"])).to eq ["a".ord]
+      end
+    end
+
+    context "given a char that isn't in the keymap" do
+      it "returns the byte as a keycode" do
+        expect(parse_bytes([97])).to eq ["a".ord]
+      end
+    end
+
+    context "given multiple characters that aren't in the keymap" do
+      it "returns the bytes as individual keycodes" do
+        expect(parse_bytes(["a", "b", "C"])).to eq ["a", "b", "C"].map(&:ord)
+      end
+    end
+
+    context "given multiple characters that aren't in the keymap" do
+      it "returns the bytes as individual keycodes" do
+        expect(parse_bytes([97, 98, 67])).to eq ["a", "b", "C"].map(&:ord)
+      end
+    end
+
+    context "given a byte in the keymap" do
+      let(:keymap) do
+        { backspace: [?\C-?.ord] }
+      end
+
+      it "returns the bytes as a single key code" do
+        expect(parse_bytes([127])).to eq [[127]]
+      end
+    end
+
+    context "given multiple bytes – some in the keymap, some not" do
+      let(:keymap) do
+        { backspace: [?\C-?.ord] }
+      end
+
+      it "returns the key codes appropriately" do
+        expect(parse_bytes([97, 127, 67])).to eq [97, [127], 67]
+      end
+    end
+
+    context "given multiple bytes which make up a single keycode in the keymap" do
+      let(:keymap) do
+        { left_arrow: [?\e.ord, ?[.ord, ?D.ord] }
+      end
+
+      it "returns a single key code" do
+        expect(parse_bytes([?\e.ord, ?[.ord, ?D.ord])).to eq [[?\e.ord, ?[.ord, ?D.ord]]
+      end
+    end
+
+    context "given multiple bytes where some bytes make up a multi-byte keycode and others don't" do
+      let(:keymap) do
+        { left_arrow: [?\e.ord, ?[.ord, ?D.ord] }
+      end
+
+      it "returns a keycodes appropriately" do
+        expect(parse_bytes([97, ?\e.ord, ?[.ord, ?D.ord, 67])).to eq [97, [?\e.ord, ?[.ord, ?D.ord], 67]
+      end
+    end
+
+  end
+
+end
+
+
+__END__
+      @escape_codes = [?\e.ord]
+      @keys.merge!(
+        {
+          :up_arrow => [?\e.ord, ?[.ord, ?A.ord],
+          :down_arrow => [?\e.ord, ?[.ord, ?B.ord],
+          :right_arrow => [?\e.ord, ?[.ord, ?C.ord],
+          :left_arrow => [?\e.ord, ?[.ord, ?D.ord],
+          :insert => [?\e.ord, ?[, ?2.ord, ?~.ord],
+          :delete => [?\e.ord, ?[, ?3.ord, ?~.ord],
+          :backspace => [?\C-?.ord],
+          :enter => (HighLine::SystemExtensions::CHARACTER_MODE == 'termios' ? [?\n.ord] : [?\r.ord]),
+
+          :ctrl_alt_a => [?\e.ord, ?\C-a.ord],

data/spec/line_spec.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'highline'
+
+require_relative "../lib/rawline/history_buffer.rb"
+require_relative "../lib/rawline/line.rb"
+
+describe RawLine::Line do
+
+  before :each do
+    @line = RawLine::Line.new(5) {|l| l.prompt = "=>" }
+  end
+
+  it "allows characters to be added to @text via the '<<' operator" do
+    @line.text = "test #1"
+    @line << 'a'[0]
+    expect(@line.text).to eq("test #1a")
+  end
+
+  it "allows characters to be retrieved and substituted via '[]' and '[]=' operators" do
+    @line.text = 'test #2'
+    @line[0] = 't'
+    expect(@line[0..3]).to eq('test')
+    @line[4..6] = ''
+    @line[0] = "This is a t"
+    expect(@line.text).to eq("This is a test")
+  end
+
+  it "updates @position via 'left' and 'right'" do
+    @line.text = "test #3"
+    @line.right 2
+    expect(@line.position).to eq(2)
+    @line.left
+    expect(@line.position).to eq(1)
+    @line.left 4
+    expect(@line.position).to eq(0)
+    @line.right HighLine::SystemExtensions.terminal_size[0]+10
+
+    expect(@line.position).to eq(HighLine::SystemExtensions.terminal_size[0]+10)
+    expect(@line.eol).to eq(6)
+  end
+
+  it "is aware of the word in which the cursor is" do
+    @line.text = "This is another test"
+    expect(@line.word).to eq({:start => 0, :end => 3, :text => "This"})
+    @line.right 2
+    expect(@line[2]).to eq('i'[0])
+    expect(@line.word).to eq({:start => 0, :end => 3, :text => "This"})
+    @line.right
+    expect(@line.word).to eq({:start => 0, :end => 3, :text => "This"})
+    @line.right
+    expect(@line.word).to eq({:start => 0, :end => 3, :text => "This"})
+    @line.right
+    expect(@line.word).to eq({:start => 5, :end => 6, :text => "is"})
+  end
+
+end

data/spec/prompt_spec.rb

@@ -0,0 +1,8 @@
+describe RawLine::Prompt do
+  describe "#length" do
+    it "returns the length of prompt ignoring  ANSI escape sequences" do
+      prompt = RawLine::Prompt.new("\e[01;31mhello\e[00m")
+      expect(prompt.length).to eq("hello".length)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: yap-rawline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabio Cevasco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: terminal-layout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'RawLine can be used to define custom key bindings, perform common line
+  editing operations, manage command history and define custom command completion
+  rules. '
+email: h3rald@h3rald.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- examples/key_tester.rb
+- examples/rawline_irb.rb
+- examples/rawline_rush.rb
+- examples/rawline_shell.rb
+- examples/readline_emulation.rb
+- lib/rawline.rb
+- lib/rawline/completer.rb
+- lib/rawline/editor.rb
+- lib/rawline/event_loop.rb
+- lib/rawline/event_registry.rb
+- lib/rawline/history_buffer.rb
+- lib/rawline/keycode_parser.rb
+- lib/rawline/line.rb
+- lib/rawline/prompt.rb
+- lib/rawline/terminal.rb
+- lib/rawline/terminal/vt220_terminal.rb
+- lib/rawline/terminal/windows_terminal.rb
+- spec/editor_spec.rb
+- spec/history_buffer_spec.rb
+- spec/keycode_parser_spec.rb
+- spec/line_spec.rb
+- spec/prompt_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubyforge.org/projects/rawline
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A library for defining custom key bindings and perform line editing operations
+test_files: []