whirled_peas 0.3.0 → 0.7.0

data/screen_test/settings/valign/grid_top.frame

@@ -0,0 +1 @@
+[?25l┏━┓┃ ┃┃ ┃┃ ┃┗━┛A[?25h

data/screen_test/settings/valign/grid_top.rb

@@ -0,0 +1,15 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_grid('Alignment') do |composer, settings|
+        settings.num_cols = 1
+        settings.full_border
+        settings.height = 3
+        settings.valign = :top
+        composer.add_text { 'A' }
+      end
+    end
+  end
+end

data/screen_test/settings/width/box_border_sizing.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━┓┃             ┃┗━━━━━━━━━━━━━┛15/bor[?25h

data/screen_test/settings/width/box_border_sizing.rb

@@ -0,0 +1,15 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box('Wide') do |_, settings|
+        settings.full_border
+        settings.set_padding(left: 3, right: 4)
+        settings.width = 15
+        settings.sizing = :border
+        '15/border'
+      end
+    end
+  end
+end

data/screen_test/settings/width/box_content.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━━━━━━━━┓┃                      ┃┗━━━━━━━━━━━━━━━━━━━━━━┛15/content[?25h

data/screen_test/settings/width/box_content.rb

@@ -0,0 +1,15 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box('Wide') do |_, settings|
+        settings.full_border
+        settings.set_padding(left: 3, right: 4)
+        settings.width = 15
+        settings.sizing = :content
+        '15/content'
+      end
+    end
+  end
+end

data/screen_test/settings/width/box_default.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━━━━━━━━┓┃                      ┃┗━━━━━━━━━━━━━━━━━━━━━━┛15/default[?25h

data/screen_test/settings/width/box_default.rb

@@ -0,0 +1,14 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box('Wide') do |_, settings|
+        settings.full_border
+        settings.set_padding(left: 3, right: 4)
+        settings.width = 15
+        '15/default'
+      end
+    end
+  end
+end

data/screen_test/settings/width/grid.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━┳━━━━━━┓┃      ┃      ┃┣━━━━━━╋━━━━━━┫┃      ┃      ┃┣━━━━━━╋━━━━━━┫┃      ┃      ┃┗━━━━━━┻━━━━━━┛666666[?25h

data/screen_test/settings/width/grid.rb

@@ -0,0 +1,14 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_grid('Wide') do |_, settings|
+        settings.full_border
+        settings.width = 6
+        settings.num_cols = 2
+        6.times.map { '6' }
+      end
+    end
+  end
+end

data/screen_test/settings/width/overflow_align_center.frame

@@ -0,0 +1 @@
+[?25l┏━━━┓┃   ┃┗━━━┛345[?25h

data/screen_test/settings/width/overflow_align_center.rb

@@ -0,0 +1,14 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box('Container') do |composer, settings|
+        settings.width = 3
+        settings.align = :center
+        settings.full_border
+        '123456'
+      end
+    end
+  end
+end

data/screen_test/settings/width/overflow_align_right.frame

@@ -0,0 +1 @@
+[?25l┏━━━┓┃   ┃┗━━━┛456[?25h

data/screen_test/settings/width/overflow_align_right.rb

@@ -0,0 +1,14 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box do |composer, settings|
+        settings.width = 3
+        settings.align = :right
+        settings.full_border
+        '123456'
+      end
+    end
+  end
+end

data/screen_test/settings/width/overflow_box.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━┓┃          ┃┗━━━━━━━━━━┛ABCDEFGHIJ[?25h

data/screen_test/settings/width/overflow_box.rb

@@ -0,0 +1,13 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box do |_, settings|
+        settings.width = 10
+        settings.full_border
+        "ABCDEFGHIJKLMNOPQRSTUVWZYZ"
+      end
+    end
+  end
+end

data/screen_test/settings/width/overflow_box_l2r.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━┓┃          ┃┗━━━━━━━━━━┛0|0|1|0|1|[?25h

data/screen_test/settings/width/overflow_box_l2r.rb

@@ -0,0 +1,16 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box do |composer, settings|
+        settings.width = 10
+        settings.full_border
+        str = ''
+        10.times do |i|
+          composer.add_text { str += "#{i}|" }
+        end
+      end
+    end
+  end
+end

data/screen_test/settings/width/overflow_box_t2b.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━┓┃          ┃┃          ┃┃          ┃┃          ┃┃          ┃┃          ┃┃          ┃┃          ┃┃          ┃┃          ┃┗━━━━━━━━━━┛XOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXOXO[?25h

data/screen_test/settings/width/overflow_box_t2b.rb

@@ -0,0 +1,17 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box do |composer, settings|
+        settings.width = 10
+        settings.flow = :t2b
+        settings.full_border
+        str = ''
+        10.times do
+          composer.add_text { str += 'XO' }
+        end
+      end
+    end
+  end
+end

data/screen_test/settings/width/overflow_grid.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━┓┃          ┃┗━━━━━━━━━━┛ABCDEFGHIJ[?25h

data/screen_test/settings/width/overflow_grid.rb

@@ -0,0 +1,14 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer, settings|
+      composer.add_grid('grid') do |_, settings|
+        settings.width = 10
+        settings.full_border
+        settings.num_cols = 1
+        ["ABCDEFGHIJKLMNOPQRSTUVWZYZ"]
+      end
+    end
+  end
+end

data/tools/whirled_peas/tools/screen_tester.rb

@@ -0,0 +1,233 @@
+require 'bundler/setup'
+require 'whirled_peas'
+require 'whirled_peas/frame/event_loop'
+require 'whirled_peas/frame/producer'
+require 'whirled_peas/graphics/debugger'
+require 'whirled_peas/graphics/renderer'
+require 'whirled_peas/graphics/screen'
+require 'whirled_peas/settings/text_color'
+require 'whirled_peas/utils/formatted_string'
+
+module WhirledPeas
+  module Tools
+    # levels_up = 0 returns the directory of the current file. If the current file is a
+    # directory, then it will return a parent directory
+    def self.parent_directory(file, levels_up=0)
+      return File.dirname(file) if levels_up == 0
+      parent_directory(File.dirname(file), levels_up - 1)
+    end
+
+    class ScreenTester
+      SCREEN_WIDTH = 32
+      SCREEN_HEIGHT = 24
+
+      def self.base_dir
+        Tools.parent_directory(__FILE__, 3)
+      end
+
+      def self.test_files
+        Dir.glob(File.join(base_dir, 'screen_test', '**', '*.rb'))
+      end
+
+      def self.run_all
+        failures = {}
+        pendings = Set.new
+        puts "Running #{test_files.length} rendered screen test(s)"
+        puts
+        test_files.each do |file|
+          tester = new(file)
+          if tester.pending?
+            print Utils::FormattedString.new('.', Settings::TextColor::YELLOW)
+            pendings << file
+          elsif tester.failed?
+            print Utils::FormattedString.new('.', Settings::TextColor::RED)
+            failures[file] = tester.error
+          else
+            print Utils::FormattedString.new('.', Settings::TextColor::GREEN)
+          end
+          STDOUT.flush
+        end
+        puts
+        puts if pendings.count > 0
+        pendings.each do |file|
+          puts Utils::FormattedString.new("PENDING: #{file}", Settings::TextColor::YELLOW)
+        end
+        puts if failures.count > 0
+        failures.each do |file, error|
+          puts Utils::FormattedString.new("Failed: #{file}:\n\n    #{error}\n", Settings::TextColor::RED)
+        end
+
+        if failures.count == 0
+          puts
+          puts Utils::FormattedString.new('No failures', Settings::TextColor::GREEN)
+        else
+          exit(1)
+        end
+      end
+
+      def self.update_all
+        num_attempted = 0
+        test_files.map do |file|
+          num_attempted += 1 if new(file).update(false)
+        end
+        if num_attempted == 0
+          puts 'All rendered output matched expected.'
+        end
+      end
+
+      attr_reader :error
+
+      def initialize(test_file)
+        @full_test_file = test_file[0] == '/' ? test_file : File.join(Dir.pwd, test_file)
+        raise ArgumentError, "File not found: #{test_file}" unless File.exist?(@full_test_file)
+        @test_file = @full_test_file.sub(self.class.base_dir, '').sub(/^\//, '')
+        @full_output_file = @full_test_file.sub(/\.rb$/, '.frame')
+        @output_file = @full_output_file.sub(self.class.base_dir, '').sub(/^\//, '')
+      end
+
+      def update(report_passing=true)
+        if pending?
+          ask_pending
+          return true
+        elsif failed?
+          ask_failed
+          return true
+        elsif report_passing
+          puts "Actual rendered output for #{test_file} matches expected."
+        end
+        false
+      end
+
+      def pending?
+        !File.exist?(full_output_file)
+      end
+
+      def failed?
+        if rendered != File.read(full_output_file)
+          @error = 'Rendered output does not match saved output'
+        end
+        !@error.nil?
+      end
+
+      def view
+        with_template_factory do |template_factory|
+          render_screen(template_factory, STDOUT)
+        end
+      end
+
+      def debug
+        with_template_factory do |template_factory|
+          orig_debug = Graphics.debug
+          Graphics.debug = true
+          render_screen(template_factory, StringIO.new)
+          Graphics.debug = orig_debug
+        end
+      end
+
+      def template
+        with_template_factory do |template_factory|
+          template = template_factory.build('Test', {})
+          puts Graphics::Debugger.new(template).debug
+        end
+      end
+
+      def save
+        if File.exist?(full_output_file)
+          puts "Existing output file found: #{full_output_file}"
+          puts "overwriting..."
+        else
+          puts "Writing output to file: #{full_output_file}"
+        end
+
+        with_template_factory do |template_factory|
+          File.open(full_output_file, 'w') do |file|
+            render_screen(template_factory, file)
+          end
+        end
+      end
+
+      def ask_pending
+        puts "File: #{test_file}"
+        puts Utils::FormattedString.new('Frame file does not exist', Settings::TextColor::YELLOW)
+        print 'View rendered frame? [Y/n/q] '
+        STDOUT.flush
+        response = STDIN.gets.strip.downcase
+        case response
+        when 'q'
+          exit
+        when 'n'
+          return
+        end
+        puts rendered
+        STDOUT.flush
+        ask_to_save
+      end
+
+      def ask_failed
+        puts "File: #{test_file}"
+        puts Utils::FormattedString.new('Output from test does not match saved output', Settings::TextColor::RED)
+        print 'View expected output? [Y/q] '
+        STDOUT.flush
+        exit if 'q' == STDIN.gets.strip.downcase
+        puts File.read(full_output_file)
+        puts "File: #{test_file}"
+        print 'View actual output? [Y/q] '
+        STDOUT.flush
+        exit if 'q' == STDIN.gets.strip.downcase
+        puts rendered
+        STDOUT.flush
+        ask_to_save
+      end
+
+      private
+
+      attr_reader :full_test_file, :test_file, :full_output_file, :output_file
+
+      def ask_to_save
+        puts "File: #{test_file}"
+        print 'Save actual as the expected test output? [y/N/q] '
+        STDOUT.flush
+        response = STDIN.gets.strip.downcase
+        print Utils::Ansi.cursor_pos(left: 0, top: 0)
+        print Utils::Ansi.clear_down
+        if response == 'y'
+          File.open(full_output_file, 'w') { |file| file.print(rendered) }
+          puts "Saved to #{output_file}"
+        elsif response == 'q'
+          puts 'Exiting'
+          exit
+        else
+          puts 'Skipped'
+        end
+      end
+
+      def rendered
+        @rendered ||= begin
+          string_io = StringIO.new
+          with_template_factory do |template_factory|
+            render_screen(template_factory, string_io)
+          end
+          string_io.string
+        end
+      end
+
+      def with_template_factory(&block)
+        require full_test_file
+        raise 'TemplateFactory must be defined' unless defined?(TemplateFactory)
+        yield TemplateFactory.new
+      ensure
+        Object.send(:remove_const, :TemplateFactory)
+      end
+
+      def render_screen(template_factory, output)
+        screen = Graphics::Screen.new(output: output, width: SCREEN_WIDTH, height: SCREEN_HEIGHT)
+        consumer = Frame::EventLoop.new(
+          template_factory, screen: screen, refresh_rate: 100000
+        )
+        Frame::Producer.produce(consumer) do |producer|
+          producer.send_frame('test', args: {})
+        end
+      end
+    end
+  end
+end

data/whirled_peas.gemspec

@@ -18,10 +18,13 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|sandbox)/}) }
   end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'highline', '~> 2.0'
   spec.add_runtime_dependency 'json', '~> 2.5'
+  spec.add_runtime_dependency 'ruby_figlet', '~> 0.6'
 end