whirled_peas 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c57dd3e70f4d79c41731d220f9cb3f7fec0a3e554a715f7da556dec5e0a5cde
-  data.tar.gz: 736d62121796101237e9aaa4fc5f37b0fe59f6d8c7670b149e63e0faf0ff9f3e
+  metadata.gz: 8aa42eec508df7b2634b3df5d1e3ac0b568db7051400bc4939f0516c7b34545e
+  data.tar.gz: 858ce91653f22b6e01771fb7397d5899caa116b42af7f8331da4bba85cf6cd74
 SHA512:
-  metadata.gz: 1823dc0eba84af3a78992c349c1d922bfd7837452133a0e1b6e35de2fe1d94ad589b0eda8cf5c7a70ae41ec92345ef8dcde6c2e0eeb63193de806582a5d2578a
-  data.tar.gz: d10d355b30e2cc1a0cc15413c5681b04135ec7f53a2e20e9a4ea307a8ae9bd0b69fb04cacb494dcfee8b7a9d473ae852173d140a708d1bb04210084f824acd99
+  metadata.gz: d646e3833f854b03a200ffb5af37bf19907b0d8dc95a99700e29149ad4e0cf92e53fa911b8eae5749cc931401c1d7323333c1dd2d6e310c5cd3c17154ba1b99d
+  data.tar.gz: 63da3f42f0f83d5158ccd1f4af211791cbb5e6c1cddb438413962edc0cd9703ccd24d816ca08d217ccc8fc94bb4104715066380ee12eb0ad97ca14cf58fdd379

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.13.0- 2021-02-03
+
+- [c4feba9](https://github.com/tcollier/whirled_peas/tree/c4feba92c34cf39e6e12650bae701744dd5999d2): Only paint the diff
+- [fa871e5](https://github.com/tcollier/whirled_peas/tree/fa871e5e9a40feb33d68e8d213b8613e0dcdaa09): Don't require `active_index` for `ListWithActive`
+- [0417b66](https://github.com/tcollier/whirled_peas/tree/0417b66c4a143c7c0ca439699519853f07eb6ac3): Use :soft border as default and for built-in themes
+
 ## v0.12.0- 2021-01-31
 
 - [f218ed5](https://github.com/tcollier/whirled_peas/tree/f218ed5a8bbc20fc332a42ad9720467784a916e2): Optimize rendered frames

data/README.md

@@ -18,7 +18,7 @@
      ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝╚═╝  ╚═╝╚══════╝╚══════╝╚═════╝    ╚═╝     ╚══════╝╚═╝  ╚═╝╚══════╝
 ```
 
-Easily create terminal-based graphics to visualize the execution of your code. Whirled Peas offers templating inspired by HTML and CSS and provides a lightweight tie-in for your code to produce visual animations with these templates.
+Easily create terminal-based graphics to visualize the execution of your code. Whirled Peas offers templating inspired by HTML and CSS and provides a lightweight tie-in for your code to produce visual animations.
 
 ## Installation
 
@@ -41,9 +41,9 @@ Or install it yourself as:
 A Whirled Peas application consists of the following required pieces
 
 - [The application](doc/application.md) - the code that is to be visualized, it dictates the frame contents and playback speed
-- [The template factory](doc/template_factory.md) - builds templates to convert frame from the application into terminal graphics
+- [The template factory](doc/template_factory.md) - builds templates to convert frames from the application into terminal graphics
 
-These pieces are configured as following
+These pieces are configured as follows
 
 ```ruby
 # visualize.rb

data/doc/components.md

@@ -28,11 +28,11 @@ This component takes the following options
 
 #### Required
 
-- `active_index` - the index of the active item
 - `items` - the array of items to be displayed in the box
 
 #### Optional
 
+- `active_index` - the index of the active item, the item at the position will be highlighted and moved to the _preferred_ position. For items in the middle of a long list, the _preferred_ position is roughly 2/3rds to the way to the right in the viewport.
 - `flow` - `:l2r` or `:t2b`
 - `separator` - string used to separate items in the list, e.g. `", "` for a horizontal list or `"----"` for a vertical list
 - `viewport_size` - number of characters of the viewport in the flow direction

data/doc/screen_test.md

@@ -1,11 +1,10 @@
 ## Screen Tests
 
-In addition to standard RSpec tests, WhirledPeas has custom tests for rendered templates. These files live in `screen_test/`. Each ruby file is expected to define a class named `TemplateFactory` that responds to `#build(name, args)` returning a template (the standard template factory role). Each file should also be accompanied by a `.frame` file with the same base name. This file will contain the output of the rendered screen and is considered the correct output when running tests.
+In addition to standard RSpec tests, WhirledPeas has custom tests for rendered templates. These files live in `screen_test/`. Each ruby file is expected to define a class named `TemplateFactory` that responds to `#build(name, args)` returning a template (this is the standard template factory role). Each file should also be accompanied by a `.frame` file with the same base name. This file will contain the output of the rendered screen and is considered the correct output when running tests. Use the `--view` flag to create the `.frame` file for an individual test or the `--view-pedning` flag to interactively create `.frame` files for all tests that do not have one.
 
 Note: viewing `.frame` files with `cat` works better than most other text editors.
 
 ```
-
 Usage: screen_test [file] [options]
 
 If not file or options are provide, all tests are run

data/doc/settings.md

@@ -317,7 +317,17 @@ The border settings consist of 6 boolean values (border are either width 1 or no
 
 Available border styles are
 
-- `:bold` (default)
+- `:soft` (default)
+
+```
+╭──┬──╮
+│  │  │
+├──┼──┤
+│  │  │
+╰──┴──╯
+```
+
+- `:bold`
 
 ```
 ┏━━┳━━┓
@@ -337,16 +347,6 @@ Available border styles are
 ╚══╩══╝
 ```
 
-- `:soft`
-
-```
-╭──┬──╮
-│  │  │
-├──┼──┤
-│  │  │
-╰──┴──╯
-```
-
 ### Display Flow
 
 Child elements can flow in one of 4 directions

data/lib/data/themes.yaml

@@ -2,7 +2,6 @@ bright:
   axis_color: :red
   bg_color: :bright_white
   border_color: :bright_blue
-  border_style: :soft
   color: :blue
   title_font: :default
 
@@ -10,7 +9,6 @@ dark:
   axis_color: :bright_white
   bg_color: :black
   border_color: :gray
-  border_style: :double
   color: :white
   highlight_bg_color: :bright_red
   highlight_color: :black

data/lib/whirled_peas/animator/renderer_consumer.rb

@@ -11,13 +11,16 @@ module WhirledPeas
         @width = width
         @height = height
         @rendered_frames = []
+        @prev_pixel_grid = nil
       end
 
       def add_frameset(frameset)
         frameset.each_frame do |frame, duration, args|
           template = template_factory.build(frame, args)
-          strokes = Graphics::Renderer.new(template, width, height).paint
+          pixel_grid = Graphics::Renderer.new(template, width, height).paint
+          strokes = prev_pixel_grid.nil? ? pixel_grid.to_s : pixel_grid.diff(prev_pixel_grid)
           rendered_frames << Device::RenderedFrame.new(strokes, duration)
+          @prev_pixel_grid = pixel_grid
         end
       end
 
@@ -27,7 +30,7 @@ module WhirledPeas
 
       private
 
-      attr_reader :template_factory, :device, :width, :height, :rendered_frames
+      attr_reader :template_factory, :device, :width, :height, :rendered_frames, :prev_pixel_grid
     end
   end
 end

data/lib/whirled_peas/component/list_with_active.rb

@@ -30,7 +30,7 @@ module WhirledPeas
       end
 
       def compose(composer, settings)
-        %i[items active_index].each do |required_attr|
+        %i[items].each do |required_attr|
           if send(required_attr).nil?
             raise ArgumentError, "Required field #{required_attr} missing"
           end
@@ -40,21 +40,22 @@ module WhirledPeas
           settings.flow = flow
           settings.align = :left
           settings.full_border
+          curr_index = active_index || 0
           if flow == :l2r
             settings.width = viewport_size
-            active_start = separator.nil? ? 0 : active_index * separator.length
-            items.first(active_index).each do |item|
+            active_start = separator.nil? ? 0 : curr_index * separator.length
+            items.first(curr_index).each do |item|
               active_start += item.length
             end
-            active_size = items[active_index].length
+            curr_size = items[curr_index].length
           else
             settings.height = viewport_size
-            active_start = active_index + (separator.nil? ? 0 : active_index)
-            active_size = 1
+            active_start = curr_index + (separator.nil? ? 0 : curr_index)
+            curr_size = 1
           end
 
           if viewport_size < total_size
-            front_padding = (viewport_size - active_size) * 0.667
+            front_padding = (viewport_size - curr_size) * 0.667
             offset = (active_start - front_padding).round
             if offset < 0
               offset = 0

data/lib/whirled_peas/device/screen.rb

@@ -8,14 +8,9 @@ module WhirledPeas
       end
 
       def handle_rendered_frames(rendered_frames)
-        next_frame_at = nil
+        next_frame_at = Time.now
         rendered_frames.each do |rendered_frame|
-          if next_frame_at.nil?
-            next_frame_at = Time.now + rendered_frame.duration
-          else
-            next_frame_at += rendered_frame.duration
-            next if next_frame_at < Time.now
-          end
+          next_frame_at += rendered_frame.duration
           output.print(rendered_frame.strokes)
           output.flush
           sleep([0, next_frame_at - Time.now].max)

data/lib/whirled_peas/graphics/pixel_grid.rb

@@ -14,6 +14,43 @@ module WhirledPeas
         end
       end
 
+      def pixel_at(col, row)
+        pixels[row][col]
+      end
+
+      def diff(other)
+        str = ''
+        formatting = nil
+        chars = ''
+        pixels.each.with_index do |row, row_index|
+          row.each.with_index do |pixel, col_index|
+            if pixel == other.pixel_at(col_index, row_index)
+              if chars != ''
+                str += Utils::FormattedString.new(chars, formatting).to_s
+                chars = ''
+                formatting = nil
+              end
+            elsif chars == ''
+              str += Utils::Ansi.cursor_pos(left: col_index, top: row_index)
+              chars = pixel.char
+              formatting = pixel.formatting
+            elsif formatting != pixel.formatting
+              str += Utils::FormattedString.new(chars, formatting).to_s
+              chars = pixel.char
+              formatting = pixel.formatting
+            else
+              chars += pixel.char
+            end
+          end
+        end
+        if chars != ''
+          str += chars
+          chars = ''
+          formatting = nil
+        end
+        str
+      end
+
       def to_s
         str = Utils::Ansi.cursor_pos(left: 0, top: 0) + Utils::Ansi.clear_down
         formatting = nil

data/lib/whirled_peas/graphics/renderer.rb

@@ -20,7 +20,7 @@ module WhirledPeas
         template.paint(Canvas.new(0, 0, width, height), 0, 0) do |left, top, fstring|
           pixel_grid.add_stroke(left, top, fstring)
         end
-        pixel_grid.to_s
+        pixel_grid
       end
 
       private

data/lib/whirled_peas/settings/border.rb

@@ -34,7 +34,7 @@ module WhirledPeas
           '╚', '═', '╩', '╝'
         )
 
-        DEFAULT = BOLD
+        DEFAULT = SOFT
 
         def self.validate!(style)
           return if style.nil?
@@ -94,7 +94,7 @@ module WhirledPeas
       end
 
       def style
-        @_style || theme.border_style || Styles::BOLD
+        @_style || theme.border_style || Styles::DEFAULT
       end
 
       def style=(val)

data/lib/whirled_peas/version.rb

@@ -1,3 +1,3 @@
 module WhirledPeas
-  VERSION = '0.12.0'
+  VERSION = '0.13.0'
 end

data/screen_test/elements/theme.rb

@@ -4,6 +4,7 @@ WhirledPeas.register_theme(:theme_test) do |theme|
   theme.bg_color = :bright_white
   theme.color = :blue
   theme.border_color = :bright_green
+  theme.border_style = :bold
   theme.axis_color = :bright_red
   theme.title_font = :default
 end

data/tools/whirled_peas/tools/screen_tester.rb

@@ -56,6 +56,7 @@ module WhirledPeas
         theme.color = :bright_white
         theme.bg_color = :black
         theme.border_color = :bright_white
+        theme.border_style = :bold
         theme.axis_color = :bright_white
         Settings::ThemeLibrary.add(:test, theme)
         @defined_theme_library = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whirled_peas
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Tom Collier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline