whirled_peas 0.8.0 → 0.11.1

data/doc/template_factory.md

@@ -0,0 +1,53 @@
+## Template Factory
+
+To render the frame events sent by the application, the application requires a template factory. This factory will be called for each frame event, with the frame name and the arguments supplied by the application. A template factory can be an instance of ruby class and thus can maintain state. Whirled Peas provides a few basic building blocks to make simple, yet elegant terminal-based UIs.
+
+To build a template in a template factory, use `WhirledPeas.template(theme)`, which takes an optional [theme](themes.md) and yields a composer (used to add [elements](elements.md) to the template) and [settings](settings.md) (used to configure the element).
+
+### Full example
+
+```ruby
+class TemplateFactory
+  def build(frame, args)
+    set_state(frame, args)
+    WhirledPeas.template do |composer, settings|
+      settings.flow = :l2r
+      settings.align = :center
+
+      composer.add_box('Title', &method(:title))
+      composer.add_box('Sum', &method(:sum))
+      composer.add_grid('NumberGrid', &method(:number_grid))
+    end
+  end
+
+  private
+
+  def set_state(frame, args)
+    @frame = frame
+    @numbers = args.key?(:numbers) ? args[:numbers] || []
+    @sum = args[:sum] if args.key?(:sum)
+    @low = args[:low] if args.key?(:low)
+    @high = args[:high] if args.key?(:high)
+  end
+
+  def title(_composer, settings)
+    settings.underline = true
+    "Pair Finder"
+  end
+
+  def sum(_composer, settings)
+    settings.color = @frame == 'found-pair' ? :green : :red
+    @sum ? "Sum: #{@sum}" : 'N/A'
+  end
+
+  def number_grid(composer, settings)
+    settings.full_border
+    @numbers.each.with_index do |num, index|
+      composer.add_text do |_, settings|
+        settings.bg_color = (@low == index || @high == index) ? :cyan : :white
+        num
+      end
+    end
+  end
+end
+```

data/doc/themes.md

@@ -0,0 +1,15 @@
+## Themes
+
+The template builder (`WhirledPeas.template`) takes an optional `theme` argument. You can provide the name of a predefined theme (run `whirled_peas themes` to see a list with samples) or define you own with the following
+
+```ruby
+WhirledPeas.register_theme(:my_theme) do |theme|
+  theme.bg_color = :bright_white
+  theme.color = :blue
+  theme.border_color = :bright_green
+  theme.axis_color = :bright_red
+  theme.title_font = :default
+end
+```
+
+Theme settings will be used as default settings throughout the template, however theme settings can be overridden on any element.

data/examples/components.rb

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+require 'whirled_peas'
+require 'whirled_peas/component/list_with_active'
+
+class TemplateFactory
+  ITEMS = 400.times.map(&:itself)
+
+  def build(name, args)
+    active = args[:active]
+    WhirledPeas.template do |composer, settings|
+      WhirledPeas.component(composer, settings, :list_with_active) do |component, settings|
+        component.items = %w[red orange yellow green blue indigo violet]
+        component.separator = ', '
+        component.active_index = active
+        component.viewport_size = 27
+        component.active_color = :green
+        component.active_bg_color = :yellow
+      end
+    end
+  end
+end
+
+class Application
+  def start(producer)
+    producer.frameset(5, easing: :parametric) do |fs|
+      ITEMS.length.times { |i| fs.add_frame('intro', args: { active: i }) }
+    end
+    producer.add_frame('hold', duration: 1, args: { active: ITEMS.length - 1 })
+  end
+end
+
+WhirledPeas.configure do |config|
+  config.template_factory = TemplateFactory.new
+  config.application = Application.new
+end

data/examples/graph.rb

@@ -0,0 +1,54 @@
+require 'bundler/setup'
+require 'whirled_peas'
+require 'whirled_peas/animator/easing'
+
+module WhirledPeas
+  PublicEasing = Animator::Easing
+end
+
+class TemplateFactory
+  INNER_WIDTH = 60
+
+  def build(name, args)
+    WhirledPeas.template do |composer, settings|
+      settings.bg_color = :bright_white
+      settings.align = :center
+      settings.valign = :middle
+      composer.add_grid do |composer, settings|
+        settings.num_cols = 2
+        WhirledPeas::PublicEasing::EASING.keys.each do |func|
+          easing = WhirledPeas::PublicEasing.new(func, :in_out)
+          composer.add_box do |composer, settings|
+            settings.flow = :t2b
+            settings.set_padding(horiz: 4, vert: 2)
+            composer.add_box do |_, settings|
+              settings.margin.bottom = 1
+              settings.color = :blue
+              settings.underline = true
+              "#{func} (in_out)"
+            end
+            composer.add_graph do |composer, settings|
+              settings.axis_color = :black
+              settings.color = :bright_blue
+              settings.height = 15
+              INNER_WIDTH.times.map do |i|
+                easing.ease(i.to_f / (INNER_WIDTH - 1))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+class Application
+  def start(producer)
+    producer.add_frame('intro', duration: 5)
+  end
+end
+
+WhirledPeas.configure do |config|
+  config.template_factory = TemplateFactory.new
+  config.application = Application.new
+end

data/examples/scrolling.rb

@@ -2,38 +2,27 @@ require 'bundler/setup'
 require 'whirled_peas'
 
 class TemplateFactory
-  HPADDING = 0
-  VPADDING = 0
   ITEM_COUNT = 64
 
   def build(name, args)
     top = args[:top]
     WhirledPeas.template do |composer, settings|
-      settings.color = :green
       composer.add_box('Vert') do |composer, settings|
-        settings.bg_color = :bright_red
-        settings.full_border(color: :blue)
+        settings.full_border
         settings.set_scrollbar(vert: true)
         settings.height = 12
-        composer.add_box('Inner') do |composer, settings|
-          settings.flow = :t2b
-          settings.set_padding(left: HPADDING, right: HPADDING, top: VPADDING, bottom: VPADDING)
-          settings.set_position(top: top)
-          ITEM_COUNT.times do |i|
-            composer.add_text { "%2d" % i }
-          end
+        settings.flow = :t2b
+        settings.content_start.top = top
+        ITEM_COUNT.times do |i|
+          composer.add_text { "%2d" % i }
         end
       end
       composer.add_box('Horiz') do |composer, settings|
-        settings.bg_color = :bright_red
-        settings.full_border(color: :blue)
-        settings.set_padding(left: HPADDING, right: HPADDING, top: VPADDING, bottom: VPADDING)
+        settings.full_border
         settings.set_scrollbar(horiz: true)
         settings.width = 12
-        composer.add_box('Inner') do |composer, settings|
-          settings.set_position(left: top)
-          ITEM_COUNT.times.map { |i| (i % 10).to_s }.join
-        end
+        settings.content_start.left = top
+        ITEM_COUNT.times.map { |i| (i % 10).to_s }.join
       end
     end
   end
@@ -42,7 +31,7 @@ end
 class Application
   def start(producer)
     producer.frameset(5, easing: :bezier) do |fs|
-      53.times { |i| fs.add_frame('intro', { top: -i }) }
+      53.times { |i| fs.add_frame('intro', args: { top: -i }) }
     end
     producer.add_frame('hold', duration: 1, args: { top: -52})
   end

data/lib/data/themes.yaml

@@ -0,0 +1,17 @@
+bright:
+  axis_color: :red
+  bg_color: :bright_white
+  border_color: :bright_blue
+  border_style: :soft
+  color: :blue
+  title_font: :default
+
+dark:
+  axis_color: :bright_white
+  bg_color: :black
+  border_color: :gray
+  border_style: :double
+  color: :white
+  highlight_bg_color: :bright_red
+  highlight_color: :black
+  title_font: :swan

data/lib/whirled_peas.rb

@@ -7,16 +7,38 @@ require 'whirled_peas/utils'
 require 'whirled_peas/version'
 
 module WhirledPeas
-  def self.config
-    @config ||= Config.new
-  end
+  class << self
+    def configure(&block)
+      yield config
+    end
 
-  def self.configure(&block)
-    yield config
-  end
+    def register_component(name, klass)
+      require 'whirled_peas/component'
+      Component::Factory.register(name, klass)
+    end
+
+    def component(composer, settings, name, &block)
+      require 'whirled_peas/component'
+      component = Component::Factory.build(name)
+      yield component
+      component.compose(composer, settings)
+    end
+
+    def template(theme_name=nil, &block)
+      require 'whirled_peas/graphics/composer'
+      Graphics::Composer.build(theme_name, &block)
+    end
+
+    def register_theme(name, &block)
+      require 'whirled_peas/settings/theme'
+      require 'whirled_peas/settings/theme_library'
+      theme = Settings::Theme.new
+      yield theme
+      Settings::ThemeLibrary.add(name, theme)
+    end
 
-  def self.template(&block)
-    require 'whirled_peas/graphics/composer'
-    Graphics::Composer.build(&block)
+    def config
+      @config ||= Config.new
+    end
   end
 end

data/lib/whirled_peas/animator/frameset.rb

@@ -10,7 +10,7 @@ module WhirledPeas
         @frames = []
       end
 
-      def add_frame(name, args={})
+      def add_frame(name, args: {})
         frames << [name, args]
       end
 

data/lib/whirled_peas/animator/producer.rb

@@ -17,7 +17,7 @@ module WhirledPeas
 
       def add_frame(name, duration: nil, args: {})
         frameset(duration || 1 / refresh_rate) do |fs|
-          fs.add_frame(name, args)
+          fs.add_frame(name, args: args)
         end
       end
 

data/lib/whirled_peas/command/config_command.rb

@@ -8,9 +8,9 @@ module WhirledPeas
     class ConfigCommand < Base
       def start
         require config_file
-      rescue => e
-        puts "Error loading #{config_file}"
-        puts e.message
+      rescue LoadError => e
+        puts e
+        puts e.backtrace.join("\n")
         exit(1)
       end
 

data/lib/whirled_peas/command/play.rb

@@ -38,6 +38,10 @@ module WhirledPeas
               config.application.start(producer)
             end
           end
+        rescue LoadError => e
+          puts e
+          puts e.backtrace.join("\n")
+          exit(1)
         end
 
         private

data/lib/whirled_peas/command/themes.rb

@@ -0,0 +1,77 @@
+require 'whirled_peas/device/screen'
+require 'whirled_peas/graphics/renderer'
+require 'whirled_peas/settings/theme_library'
+
+require_relative 'base'
+
+module WhirledPeas
+  module Command
+    # Display a still frame with the specified arguments.
+    class Themes < Base
+      def self.description
+        'List all themes with sample template rendered in the theme'
+      end
+
+      def start
+        super
+
+        require config_file unless config_file.nil?
+
+        theme_names = Settings::ThemeLibrary.theme_names
+        theme_names.each.with_index do |name, index|
+          template = WhirledPeas.template(name) do |composer, settings|
+            settings.full_border
+            settings.flow = :t2b
+            composer.add_text do |_, settings|
+              settings.title_font = :theme
+              name
+            end
+            composer.add_text do
+              name == Settings::ThemeLibrary.default_name ? ' (default)' : ''
+            end
+            composer.add_graph do |_, settings|
+              settings.height = 12
+              20.times.map { |i| Math.sqrt(i) }
+            end
+          end
+          Utils::Ansi.with_screen do |width, height|
+            rendered = Graphics::Renderer.new(
+              template,
+              80,
+              30
+            ).paint
+            Device::Screen.new(10000).handle_renders([rendered])
+          end
+
+          if index < theme_names.length - 1
+            print 'See next theme? [Y/q] '
+            STDOUT.flush
+            break if gets.chomp == 'q'
+          end
+        end
+      rescue LoadError => e
+        puts e
+        puts e.backtrace.join("\n")
+        exit(1)
+      end
+
+      private
+
+      attr_reader :config_file
+
+      def validate!
+        super
+        config_file = args.shift
+        @error_text = 'hi'
+        unless config_file.nil?
+          # We think we have a valid ruby config file, set the absolute path to @config
+          @config_file = config_file[0] == '/' ? config_file : File.join(Dir.pwd, config_file)
+        end
+      end
+
+      def options_usage
+        '[config file]'
+      end
+    end
+  end
+end

data/lib/whirled_peas/command_line.rb

@@ -5,6 +5,7 @@ require 'whirled_peas/command/help'
 require 'whirled_peas/command/play'
 require 'whirled_peas/command/record'
 require 'whirled_peas/command/still'
+require 'whirled_peas/command/themes'
 
 module WhirledPeas
   class CommandLine
@@ -15,7 +16,8 @@ module WhirledPeas
       Command::Help,
       Command::Play,
       Command::Record,
-      Command::Still
+      Command::Still,
+      Command::Themes
     ].map.with_object({}) { |c, h| h[c.command_name] = c }
 
     def initialize(args)

data/lib/whirled_peas/component.rb

@@ -0,0 +1,35 @@
+module WhirledPeas
+  module Component
+    module Factory
+      class << self
+        def register(name, klass)
+          classes[name] = klass
+        end
+
+        def build(name)
+          unless classes.key?(name)
+            expected = classes.keys.join(', ')
+            raise ArgumentError, "Unrecognized component: #{name.inspect}, expecting one of #{expected}"
+          end
+          @classes[name].new
+        end
+
+        private
+
+        def classes
+          return @classes if @classes
+          @classes = {}
+          Component.constants.each do |const|
+            next if const == name
+            klass = Component.const_get(const)
+            next unless klass.is_a?(Class)
+            name = const.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.to_sym
+            @classes[name] = klass
+          end
+          @classes
+        end
+      end
+    end
+  end
+  private_constant :Component
+end