terminal-layout 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69a8c9c2bf542621e42aaefcd221d552b507a333
-  data.tar.gz: 029d171fa3c85d36edd1312e6a1ba45b1f77c4b6
+  metadata.gz: c65b1156a204469a85174ffa2bb761a1f4f15593
+  data.tar.gz: 70c589abe13e269025404af7efe2555c2567e906
 SHA512:
-  metadata.gz: ad0a729599af474de93c42ef4b704b326514e7515e703a1377f583b6e018185de12c0bcb87fe26dd323bf1ddb70f2429c0f4f19230737d26aff56117cfd6ee73
-  data.tar.gz: 69d6c4ca7dac9d55941bf94404b780fdc07e8918363dc3b8b5b7124fcba9b82644d986ad249bffbd4d92526b56e807359da21ccf3a5f3135baa84ce530e0cbed
+  metadata.gz: 85ba780f984691a236879b5fc8754e0cf490f7df4d5b9288aa03411c735f985d335a5a454bbb72de72a16fe93b69458acf6c8dc8b2d1c2323d3eb9bc91857abc
+  data.tar.gz: 47c7317c78a4d5814682665fa77e27e9782b07c5af658eb8a60e73c78bb65ba90ccf490f3284240f08448a54bb38599ddb70d2e4d170574aac489e9e7620da69

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    terminal-layout (0.1.0)
+    terminal-layout (0.2.0)
       highline
       ruby-terminfo (~> 0.1.1)
       ruby-termios (~> 0.9.6)
@@ -14,7 +14,7 @@ GEM
     coderay (1.1.0)
     columnize (0.9.0)
     diff-lcs (1.2.5)
-    highline (1.7.2)
+    highline (1.7.8)
     method_source (0.8.2)
     pry (0.10.1)
       coderay (~> 1.1.0)
@@ -57,4 +57,4 @@ DEPENDENCIES
   terminal-layout!
 
 BUNDLED WITH
-   1.10.4
+   1.11.2

data/lib/ansi_string.rb

@@ -1,6 +1,14 @@
+# encoding: UTF-8
+
+require 'forwardable'
+
 class ANSIString
+  extend Forwardable
   attr_reader :raw, :without_ansi
 
+  def_delegators :@without_ansi, :each_char, :each_byte, :index,
+    :match, :=~
+
   def initialize(str)
     process_string raw_string_for(str)
   end
@@ -16,6 +24,10 @@ class ANSIString
     self
   end
 
+  def empty?
+    length == 0
+  end
+
   def [](range)
     # convert numeric position to a range
     range = (range..range) if range.is_a?(Integer)
@@ -47,15 +59,6 @@ class ANSIString
     self
   end
 
-  # See String#index for arguments
-  def index(*args)
-    @without_ansi.index(*args)
-  end
-
-  def match(*args, &blk)
-    @without_ansi.match(*args, &blk)
-  end
-
   # See String#rindex for arguments
   def rindex(*args)
     @without_ansi.rindex(*args)
@@ -73,6 +76,22 @@ class ANSIString
     ANSIString.new str
   end
 
+  def scan(pattern)
+    results = []
+    without_ansi.enum_for(:scan, pattern).each do
+      md = Regexp.last_match
+      if md.captures.any?
+        results << md.captures.map.with_index do |_, i|
+          # captures use 1-based indexing
+          self[md.begin(i+1)...md.end(i+1)]
+        end
+      else
+        results << self[md.begin(0)...md.end(0)]
+      end
+    end
+    results
+  end
+
   def slice(index, length=nil)
     range = nil
     index = index.without_ansi if index.is_a?(ANSIString)
@@ -178,6 +197,10 @@ class ANSIString
     (other.class == self.class && other.raw == @raw) || (other.kind_of?(String) && other == @raw)
   end
 
+  def <=>(other)
+    (other.class == self.class && @raw <=> other.raw)
+  end
+
   private
 
   def raw_string_for(str)
@@ -312,12 +335,12 @@ class ANSIString
         str << [location[:start_ansi_sequence], location[:text], location[:end_ansi_sequence]].join
 
       elsif location[:begins_at] >= range.begin && location[:begins_at] <= range.end
-        str << [location[:start_ansi_sequence], location[:text][range.begin..(range.end - location[:begins_at])], location[:end_ansi_sequence]].join
+        str << [location[:start_ansi_sequence], location[:text][0..(range.end - location[:begins_at])], location[:end_ansi_sequence]].join
 
       # If the location falls within the given range then  make sure we pull
       # out the bits that we want, and keep ANSI escape sequenece intact while
       # doing so.
-    elsif (location[:begins_at] <= range.begin && location[:ends_at] >= range.end) || range.cover?(location[:ends_at])
+      elsif (location[:begins_at] <= range.begin && location[:ends_at] >= range.end) || range.cover?(location[:ends_at])
         start_index = range.begin - location[:begins_at]
         end_index = range.end - location[:begins_at]
         str << [location[:start_ansi_sequence], location[:text][start_index..end_index], location[:end_ansi_sequence]].join

data/lib/terminal_layout.rb

@@ -1,4 +1,3 @@
-require 'pry'
 require 'ansi_string'
 require 'ostruct'
 
@@ -348,9 +347,18 @@ module TerminalLayout
     end
 
     def content=(str)
-      old = @content
-      @content = ANSIString.new(str)
-      emit :content_changed, old, @content
+      new_content = ANSIString.new(str)
+      if @content != new_content
+        old_content = @content
+        @content = new_content
+        emit :content_changed, old_content, @content
+      end
+    end
+
+    def children=(new_children)
+      old_children = @children
+      @children = new_children
+      emit :child_changed, old_children, new_children
     end
 
     def position
@@ -398,14 +406,27 @@ module TerminalLayout
 
     def initialize(*args)
       super
+      @computed = { x: 0, y: 0 }
       @cursor_offset_x = 0
       @cursor_position = OpenStruct.new(x: 0, y: 0)
+      @position = 0
+    end
+
+    def cursor_off
+      @style.update(cursor: 'none')
+    end
+
+    def cursor_on
+      @style.update(cursor: 'auto')
     end
 
     def content=(str)
-      old = @content
-      @content = ANSIString.new(str)
-      emit :content_changed, old, @content
+      new_content = ANSIString.new(str)
+      if @content != new_content
+        old_content = @content
+        @content = new_content
+        emit :content_changed, old_content, @content
+      end
     end
 
     def position=(position)
@@ -416,7 +437,11 @@ module TerminalLayout
 
     def update_computed(style)
       @computed.merge!(style)
-      @cursor_position.x = style[:x] + @cursor_offset_x
+      if style[:y] > 0
+        @cursor_position.x = @computed[:width] #@computed[:width] - (style[:x] + @cursor_offset_x)
+      else
+        @cursor_position.x = style[:x] + @cursor_offset_x
+      end
       @cursor_position.y = style[:y]
     end
   end
@@ -433,6 +458,7 @@ module TerminalLayout
     def initialize(output: $stdout)
       @output = output
       @term_info = TermInfo.new ENV["TERM"], @output
+      @previously_printed_lines = []
       @x, @y = 0, 0
     end
 
@@ -445,27 +471,45 @@ module TerminalLayout
       cursor_y = cursor_position.y
 
       # TODO: make this work when lines wrap
-      if cursor_x < 0
+      if cursor_x < 0 && cursor_y == 0
         cursor_x = terminal_width
         cursor_y -= 1
       elsif cursor_x >= terminal_width
+        cursor_y  = cursor_x / terminal_width
+        cursor_x -= terminal_width
       end
 
-      move_right_n_characters cursor_position.x
-      move_down_n_rows cursor_position.y
+      if @y < cursor_y
+        # moving backwards
+        move_up_n_rows(@y - cursor_y)
+      elsif @y > cursor_y
+        # moving forwards
+        move_down_n_rows(cursor_y - @y)
+      end
 
-      @y = input_box.cursor_position.y
-    end
+      move_down_n_rows cursor_y
+      move_to_beginning_of_row
+      move_right_n_characters cursor_x
 
-    def render(object)
-      dumb_render(object)
+      @x = cursor_x
+      @y = cursor_y
+
+      if input_box.style[:cursor] == 'none'
+        @output.print @term_info.control_string "civis"
+      else
+        @output.print @term_info.control_string "cnorm"
+      end
     end
 
-    def reset
-      @y = 0
+    def render(object, reset: false)
+      dumb_render(object, reset: reset)
     end
 
-    def dumb_render(object)
+    def dumb_render(object, reset: false)
+      if reset
+        @y = 0
+        @previously_printed_lines.clear
+      end
       @output.print @term_info.control_string "civis"
       move_up_n_rows @y
       move_to_beginning_of_row
@@ -476,26 +520,38 @@ module TerminalLayout
       end
 
       object_width = object.width
-      clear_screen_down
 
       rendered_content = object.render
       printable_content = rendered_content.sub(/\s*\Z/m, '')
 
-      printable_content.lines.each do |line|
-        move_to_beginning_of_row
-        @output.puts line
+      printable_lines = printable_content.split(/\n/).each_with_object([]) do |line, results|
+        if line.empty?
+          results << line
+        else
+          results.concat line.scan(/.{1,#{terminal_width}}/)
+        end
+      end
+
+      printable_lines.zip(@previously_printed_lines) do |new_line, previous_line|
+        if new_line != previous_line
+          term_info.control "el"
+          move_to_beginning_of_row
+          @output.puts new_line
+        else
+          move_down_n_rows 1
+        end
       end
       move_to_beginning_of_row
+      clear_screen_down
 
       # calculate lines drawn so we know where we are
       lines_drawn = (printable_content.length / object_width.to_f).ceil
       @y = lines_drawn
 
       input_box = find_input_box(object.box)
-
       render_cursor(input_box)
 
-      @output.print @term_info.control_string "cnorm"
+      @previously_printed_lines = printable_lines
     end
 
     def find_input_box(dom_node)

data/spec/ansi_string_spec.rb

@@ -14,6 +14,13 @@ describe 'ANSIString' do
       ansi_string = ANSIString.new "this #{blue('is')} a string"
       expect(ansi_string).to be
     end
+
+    it "can be constructed with UTF-8 characters" do;
+      expect do
+        ansi_string = ANSIString.new "this #{blue('ƒ')} a string"
+        expect(ansi_string).to be
+      end.to_not raise_error
+    end
   end
 
   describe "redundant ANSI sequences" do
@@ -48,6 +55,30 @@ describe 'ANSIString' do
     end
   end
 
+  describe "#each_byte" do
+    let(:blue_ansi_string){ ANSIString.new blue_string }
+    let(:blue_string){ blue("this is blue") }
+
+    it "iterates over each character ignoring ANSI sequences" do
+      expected = "this is blue"
+      actual = ""
+      blue_ansi_string.each_byte { |ch| actual << ch }
+      expect(actual).to eq(expected)
+    end
+  end
+
+  describe "#each_char" do
+    let(:blue_ansi_string){ ANSIString.new blue_string }
+    let(:blue_string){ blue("this is blue") }
+
+    it "iterates over each character ignoring ANSI sequences" do
+      expected = "this is blue"
+      actual = ""
+      blue_ansi_string.each_char { |ch| actual << ch }
+      expect(actual).to eq(expected)
+    end
+  end
+
   describe "#<<" do
     it "appends a String onto the end of the current ANSIString" do
       ansi_string = ANSIString.new ""
@@ -83,6 +114,22 @@ describe 'ANSIString' do
     end
   end
 
+  describe "#empty?" do
+    it "returns true when empty" do
+      expect(ANSIString.new("").empty?).to be(true)
+    end
+
+    it "returns true when it only contains ANSI sequences" do
+      expect(ANSIString.new(blue("")).empty?).to be(true)
+    end
+
+    it "returns false when there are non-ANSI characters" do
+      expect(ANSIString.new("a").empty?).to be(false)
+      expect(ANSIString.new(blue("a")).empty?).to be(false)
+    end
+
+  end
+
   describe "#index" do
     it "returns the index of the first occurrence of the given substring" do
       ansi_string = ANSIString.new("this is not blue")
@@ -179,6 +226,11 @@ describe 'ANSIString' do
       expect(ansi_string[17..-5]).to eq yellow("is is ye")
     end
 
+    it "returns the correct substring when location of an ANSI sequence comes before the end of the request" do
+      s = ANSIString.new("ABC \e[7mGemfile.lock\e[0m LICENSE.txt  README.md")
+      expect(s[4...28]).to eq ANSIString.new("\e[7mGemfile.lock\e[0m LICENSE.txt")
+    end
+
     it "returns text that is not ANSI escaped" do
       expect(ansi_string[12..14]).to eq "ABC"
     end
@@ -398,6 +450,17 @@ describe 'ANSIString' do
     end
   end
 
+  describe "<=>" do
+    let(:string_1){ ANSIString.new blue("abc") }
+    let(:string_2){ ANSIString.new blue("def") }
+
+    it "behaves the same as a normal string" do
+      expect(string_1 <=> string_2).to eq(-1)
+      expect(string_1 <=> string_1).to eq(0)
+      expect(string_2 <=> string_1).to eq(1)
+    end
+  end
+
   describe "#match" do
     it "matches on a string pattren" do
       string = "apples are bananas are they not?"
@@ -412,6 +475,40 @@ describe 'ANSIString' do
     end
   end
 
+  describe "#=~" do
+    it "matches on a regex pattren" do
+      string = "apples are bananas are they not?"
+      ansi_string = ANSIString.new("app#{red('les are bananas')} are they not?")
+      expect(ansi_string =~ /are/).to eq(string =~ /are/)
+    end
+  end
+
+  describe "#scan" do
+    it "scans without capture groups" do
+      string = "567"
+      ansi_string = ANSIString.new("1234#{red('5678')}90")
+      expect(ansi_string.scan(/.{2}/)).to eq([
+        ANSIString.new("12"),
+        ANSIString.new("34"),
+        ANSIString.new("#{red('56')}"),
+        ANSIString.new("#{red('78')}"),
+        ANSIString.new("90")
+      ])
+    end
+
+    it "scans with capture groups" do
+      string = "567"
+      ansi_string = ANSIString.new("1234#{red('5678')}90")
+      expect(ansi_string.scan(/(.)./)).to eq([
+        [ANSIString.new("1")],
+        [ANSIString.new("3")],
+        [ANSIString.new("#{red('5')}")],
+        [ANSIString.new("#{red('7')}")],
+        [ANSIString.new("9")]
+      ])
+    end
+  end
+
   describe "#replace" do
     it "replaces the contents of the current string with the new string" do
       ansi_string = ANSIString.new("abc")

data/terminal-layout.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "terminal-layout"
-  spec.version       = "0.1.1"
+  spec.version       = "0.2.0"
   spec.authors       = ["Zach Dennis"]
   spec.email         = ["zach.dennis@gmail.com"]
   spec.summary       = %q{A terminal layout manager}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal-layout
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Zach Dennis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2016-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-terminfo
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A terminal layout manager
@@ -156,3 +156,4 @@ test_files:
 - spec/ansi_string_spec.rb
 - spec/spec_helper.rb
 - spec/terminal_layout_spec.rb
+has_rdoc: