whirled_peas 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85262725d00d4055dceb88c2672afc6a7f5027626a3038998706b5d8e2d1a3aa
-  data.tar.gz: 15bc9278fd2945d0ea5cf6a5436ba11e00724e71f128ec487f5569c3689bfaeb
+  metadata.gz: 6608e1e6c9505eefea5409bcdc0f8af117b5bcf390564d163315f05b9fe73323
+  data.tar.gz: 713b7ff1c83c462b137e1a9203282ad74f8dc71e660237da35b40d472ae1d486
 SHA512:
-  metadata.gz: 7270704f5ff2adc5d225dd7c612f489a968c9d5efc2fef399b65a8ad7320fcad2920ec355645f961744577df740efbfcf4947f477e13224702764bf64931a52b
-  data.tar.gz: a46f83016c3038275fccc907894c0ea7fc3ce0553c5da343d77fbfbbdf9f619ca169346e11b5862cf502e7785372a750a0ab668bfffb3198b1d529a75cd198a5
+  metadata.gz: 81d5ae8c86907fa5a32025be54fd4649d1c75c93726d0f581f0f63cd7182f8381285451cef1c2350b223c378ba98c00682b2a96ac65b31cabc05b5871cbaf1fc
+  data.tar.gz: 52cdda8685d24cd1ad89c5a2acc70b7fb77c22cf6c21cb3d3eb20dce5df2660bc2e9d285e04fbb13018189f9b2f9700203e3915c13f678ecb4d92f2ce173bfab

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## v0.1.1 - 2021-01-20
+
+- [3852c8c](https://github.com/tcollier/whirled_peas/tree/3852c8c700c2e8fb92e65bbca1c99be74304c6d0): Improve error handling
+
+## v0.1.0 - 2021-01-20
+
+- [f343434](https://github.com/tcollier/whirled_peas/tree/f34343458097da04d5846ab13533e8226ba04d75): Inaugural release

data/README.md

@@ -122,6 +122,36 @@ A `ComposableElement` provides the following methods to add child elements
 - `add_grid` - yields a `ComposableElement` and a `GridSettings`, which will be added to the parent's children
 - `add_text` - yields `nil` and a `TextSettings`, which will be added to the parent's children
 
+E.g.
+
+```ruby
+WhirledPeas.template do |template, template_settings|
+  template_settings.bg_color = :blue
+  template.add_grid do |grid, grid_settings|
+    grid_settings.num_cols = 10
+    100.times do |i|
+      grid.add_text { i.to_s }
+    end
+  end
+end
+```
+
+The above template can also be broken down into more manageable methods, e.g.
+
+```ruby
+def number_grid(grid, settings)
+  settings.num_cols = 10
+  100.times do |i|
+    grid.add_text { i.to_s }
+  end
+end
+
+WhirledPeas.template do |template, settings|
+  settings.bg_color = :blue
+  template.add_grid(&method(:number_grid))
+end
+```
+
 Additionally, if no child element is explicitly added to a `GridElement`, but the block returns an array of strings or numbers, those will be converted to `TextElements` and added as children to the `GridElement`. For example, these are identical ways to create a grid of strings
 
 ```ruby
@@ -276,39 +306,51 @@ Many of these also have a "bright" option:
 
 ```ruby
 class TemplateFactory
-  def initialize
-    @numbers = []
+  def build(frame, args)
+    set_state(frame, args)
+    WhirledPeas.template do |t|
+      t.add_box(&method(:body))
+    end
   end
 
-  def build(name, args)
-    @numbers = args['numbers'] if args.key?('numbers')
+  private
 
-    WhirledPeas.template do |t|
-      t.add_box do |body, settings|
-        settings.flow = :l2r
-        settings.auto_margin = true
-        body.add_box do |title, settings|
-          settings.underline = true
-          "Pair Finder"
-        end
-        body.add_box do |_, settings|
-          settings.color = name == 'found-pair' ? :green : :red
-          args.key?('sum') ? "Sum: #{args['sum']}" : 'N/A'
-        end
-        body.add_grid do |g, settings|
-          settings.full_border
-          @numbers.each.with_index do |num, index|
-            is_low = args.key?('low') && args['low'] == index
-            is_high = args.key?('high') && args['high'] == index
-            g.add_text do |_, settings|
-              settings.bg_color = (is_low || is_high) ? :cyan : :white
-              num.to_s
-            end
-          end
-        end
+  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(_elem, settings)
+    settings.underline = true
+    "Pair Finder"
+  end
+
+  def sum(_elem, settings)
+    settings.color = @frame == 'found-pair' ? :green : :red
+    @sum ? "Sum: #{@sum}" : 'N/A'
+  end
+
+  def number_grid(elem, settings)
+    settings.full_border
+    @numbers.each.with_index do |num, index|
+      g.add_text do |_, settings|
+        settings.bg_color = (@low == index || @high == index) ? :cyan : :white
+        num.to_s
       end
     end
   end
+
+  def body(elem, settings)
+    settings.flow = :l2r
+    settings.auto_margin = true
+
+    elem.add_box(&method(:title))
+    elem.add_box(&method(:sum))
+    elem.add_grid(&method(:number_grid))
+  end
 end
 ```
 

data/lib/whirled_peas.rb

@@ -11,6 +11,7 @@ module WhirledPeas
   DEFAULT_PORT = 8765
   DEFAULT_REFRESH_RATE = 30
 
+  LOGGER_ID = 'MAIN'
 
   def self.start(driver, template_factory, log_level: Logger::INFO, refresh_rate: DEFAULT_REFRESH_RATE, host: DEFAULT_HOST, port: DEFAULT_PORT)
     logger = Logger.new(File.open('whirled_peas.log', 'a'))
@@ -20,16 +21,19 @@ module WhirledPeas
     end
 
     consumer = Frame::Consumer.new(template_factory, refresh_rate, logger)
-    consumer_thread = Thread.new { consumer.start(host: host, port: port) }
+    consumer_thread = Thread.new do
+      Thread.current.report_on_exception = false
+      consumer.start(host: host, port: port)
+    end
 
     Frame::Producer.start(logger: logger, host: host, port: port) do |producer|
       begin
         driver.start(producer)
         producer.stop
       rescue => e
-        logger.warn('MAIN') { "Driver exited with error, terminating producer..." }
-        logger.error('MAIN') { e }
-        logger.error('MAIN') { e.backtrace.join("\n") }
+        logger.warn(LOGGER_ID) { 'Driver exited with error, terminating producer...' }
+        logger.error(LOGGER_ID) { e }
+        logger.error(LOGGER_ID) { e.backtrace.join("\n") }
         producer.terminate
         raise
       end

data/lib/whirled_peas/frame/consumer.rb

@@ -1,13 +1,15 @@
 require 'socket'
 require 'json'
 
-require_relative 'loop'
+require_relative 'event_loop'
 
 module WhirledPeas
   module Frame
     class Consumer
+      LOGGER_ID = 'CONSUMER'
+
       def initialize(template_factory, refresh_rate, logger=NullLogger.new)
-        @loop = Loop.new(template_factory, refresh_rate, logger)
+        @event_loop = EventLoop.new(template_factory, refresh_rate, logger)
         @logger = logger
         @running = false
         @mutex = Mutex.new
@@ -15,10 +17,13 @@ module WhirledPeas
 
       def start(host:, port:)
         mutex.synchronize { @running = true }
-        loop_thread = Thread.new { loop.start }
+        loop_thread = Thread.new do
+          Thread.current.report_on_exception = false
+          event_loop.start
+        end
         socket = TCPSocket.new(host, port)
-        logger.info('CONSUMER') { "Connected to #{host}:#{port}" }
-        while @running
+        logger.info(LOGGER_ID) { "Connected to #{host}:#{port}" }
+        while @running && event_loop.running?
           line = socket.gets
           if line.nil?
             sleep(0.001)
@@ -27,35 +32,36 @@ module WhirledPeas
           args = JSON.parse(line)
           name = args.delete('name')
           if [Frame::EOF, Frame::TERMINATE].include?(name)
-            logger.info('CONSUMER') { "Received #{name} event, stopping..." }
-            loop.stop if name == Frame::TERMINATE
+            logger.info(LOGGER_ID) { "Received #{name} event, stopping..." }
+            event_loop.stop if name == Frame::TERMINATE
             @running = false
           else
             duration = args.delete('duration')
-            loop.enqueue(name, duration, args)
+            event_loop.enqueue(name, duration, args)
           end
         end
-        logger.info('CONSUMER') { "Exited normally" }
+        logger.info(LOGGER_ID) { 'Exited normally' }
+        logger.info(LOGGER_ID) { 'Waiting for loop thread to exit' }
+        loop_thread.join
       rescue => e
-        logger.warn('CONSUMER') { "Exited with error" }
-        logger.error('CONSUMER') { e.message }
-        logger.error('CONSUMER') { e.backtrace.join("\n") }
-        loop.stop
+        event_loop.stop if event_loop.running?
+        logger.warn(LOGGER_ID) { 'Exited with error' }
+        logger.error(LOGGER_ID) { e.message }
+        logger.error(LOGGER_ID) { e.backtrace.join("\n") }
+        raise
       ensure
-        logger.info('CONSUMER') { "Waiting for loop thread to exit" }
-        loop_thread.join
-        logger.info('CONSUMER') { "Closing socket" }
+        logger.info(LOGGER_ID) { 'Closing socket' }
         socket.close if socket
       end
 
       def stop
-        logger.info('CONSUMER') { "Stopping..." }
+        logger.info(LOGGER_ID) { 'Stopping...' }
         mutex.synchronize { @running = false }
       end
 
       private
 
-      attr_reader :loop, :logger, :mutex
+      attr_reader :event_loop, :logger, :mutex
     end
   end
 end

data/lib/whirled_peas/frame/{loop.rb → event_loop.rb}

@@ -1,6 +1,6 @@
 module WhirledPeas
   module Frame
-    class Loop
+    class EventLoop
       def initialize(template_factory, refresh_rate, logger=NullLogger.new)
         @template_factory = template_factory
         @queue = Queue.new
@@ -12,8 +12,12 @@ module WhirledPeas
         queue.push([name, duration, args])
       end
 
+      def running?
+        @running
+      end
+
       def start
-        logger.info('EVENT LOOP') { "Starting" }
+        logger.info('EVENT LOOP') { 'Starting' }
         @running = true
         screen = UI::Screen.new
         sleep(0.01) while queue.empty?  # Wait for the first event
@@ -33,17 +37,17 @@ module WhirledPeas
           end
           sleep(next_frame_at - Time.now)
         end
-        logger.info('EVENT LOOP') { "Exiting normally" }
-      rescue => e
-        logger.warn('EVENT LOOP') { "Exiting with error" }
-        logger.error('EVENT LOOP') { e.message }
-        logger.error('EVENT LOOP') { e.backtrace.join("\n") }
+        logger.info('EVENT LOOP') { 'Exiting normally' }
+      rescue
+        logger.warn('EVENT LOOP') { 'Exiting with error' }
+        @running = false
+        raise
       ensure
         screen.finalize if screen
       end
 
       def stop
-        logger.info('EVENT LOOP') { "Stopping..." }
+        logger.info('EVENT LOOP') { 'Stopping...' }
         @running = false
       end
 
@@ -51,6 +55,6 @@ module WhirledPeas
 
       attr_reader :template_factory, :queue, :refresh_rate, :logger
     end
-    private_constant :Loop
+    private_constant :EventLoop
   end
 end

data/lib/whirled_peas/frame/producer.rb

@@ -4,19 +4,26 @@ require 'json'
 module WhirledPeas
   module Frame
     class Producer
+      LOGGER_ID = 'PRODUCER'
+
       def self.start(logger: NullLogger.new, host:, port:, &block)
         server = TCPServer.new(host, port)
         client = server.accept
-        logger.info('PRODUCER') { "Connected to #{host}:#{port}" }
+        logger.info(LOGGER_ID) { "Connected to #{host}:#{port}" }
         producer = new(client, logger)
         yield producer
-        logger.info('PRODUCER') { "Exited normally" }
+        logger.info(LOGGER_ID) { 'Exited normally' }
       rescue => e
-        logger.warn('PRODUCER') { "Exited with error" }
-        logger.error('PRODUCER') { e.message }
-        logger.error('PRODUCER') { e.backtrace.join("\n") }
+        producer.terminate
+        logger.warn(LOGGER_ID) { 'Exited with error' }
+        logger.error(LOGGER_ID) { e.message }
+        logger.error(LOGGER_ID) { e.backtrace.join("\n") }
+        raise
       ensure
-        client.close if client
+        if client
+          logger.info(LOGGER_ID) { 'Closing connection'}
+          client.close
+        end
       end
 
       def initialize(client, logger=NullLogger.new)
@@ -27,7 +34,7 @@ module WhirledPeas
 
       def send(name, duration: nil, args: {})
         client.puts(JSON.generate('name' => name, 'duration' => duration, **args))
-        logger.debug('PRODUCER') { "Sending frame: #{name}" }
+        logger.debug(LOGGER_ID) { "Sending frame: #{name}" }
       end
 
       def enqueue(name, duration: nil, args: {})

data/lib/whirled_peas/version.rb

@@ -1,3 +1,3 @@
 module WhirledPeas
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whirled_peas
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tom Collier
@@ -73,7 +73,7 @@ files:
 - lib/whirled_peas.rb
 - lib/whirled_peas/frame.rb
 - lib/whirled_peas/frame/consumer.rb
-- lib/whirled_peas/frame/loop.rb
+- lib/whirled_peas/frame/event_loop.rb
 - lib/whirled_peas/frame/producer.rb
 - lib/whirled_peas/null_logger.rb
 - lib/whirled_peas/ui.rb