bogo-ui 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3806ec515d426c9a9ce068b1a2f31d786890f7e8
-  data.tar.gz: 19e031956c263db5be7c8e4b94503451ed76cf4a
+  metadata.gz: 086eb9d9922c79a9021fe2ee6ea4b6644f472c9c
+  data.tar.gz: 109ea6e43441e94a1da2a78e42cc22aa1e0de5f2
 SHA512:
-  metadata.gz: 4b4143699d0bc034ab3705c221e4c0e2e7e0f4d8420e790d7ff7c6fd922cd2c842454fc02fcdd1f82220db261fa6a3772be465445656fddb229fd5d49a2ed460
-  data.tar.gz: 7828448db39baa5c94b0655ad98e331255083a21a62b9110655f8c49e61dd8f4564e12d5ea0af231a375320bc536de9181dc66ac636e3ab7f9856948dc797e82
+  metadata.gz: 5719ce584cccc14b5d4143888ad728e65142fbd43cc19533774a1341b003bd157c651838826b2f813b13bd63dd4ded40c4d316d755334276b320b488a0ca8d4e
+  data.tar.gz: 0d0595a972d9a6d0504ed34e6744006797dc3136f2ccb43a2b1e9e94658a92d6178b6ce6e5794b0e4cdcd961008d1ce6ed5141574da9f047198b4710201499eb

data/CHANGELOG.md

@@ -1,2 +1,6 @@
+## v0.1.2
+* Fix table generation
+* Add test coverage
+
 ## v0.1.0
 * Initial release

data/README.md

@@ -1,6 +1,84 @@
 # Bogo UI
 
-A collection of UI libraries.
+Simple CLI output helpers.
+
+## Bogo::Ui
+
+Output formatted information to the CLI.
+
+```ruby
+require 'bogo-ui'
+
+ui = Bogo::Ui.new(
+  :app_name => 'TestApp'
+)
+
+ui.info 'This is information'
+ui.warn 'This is a warning'
+ui.error 'This is an error'
+
+ui.info "This is information with #{ui.color('color', :bold, :green)}"
+
+result = ui.ask('Type a word')
+ui.info "You provided: #{result}"
+```
+
+## Bogo::Ui::Table
+
+This is a table helper. Under the hood it uses the Command Line Reporter
+with a few modifications. Direct usage:
+
+```ruby
+require 'bogo-ui'
+
+ui = Bogo::Ui.new(:app_name => 'TestApp')
+Bogo::Ui::Table.new(ui) do
+  table do
+    row do
+      column 'Name'
+      column 'Age'
+    end
+    row do
+      column 'me'
+      column '100'
+    end
+  end
+end.display
+```
+
+This helper allows for appending data to an existing table. Useful
+for when polling for updates and wanting to keep the existing table
+structure:
+
+```ruby
+require 'bogo-ui'
+
+ui = Bogo::Ui.new(:app_name => 'TestApp')
+tbl = Bogo::Ui::Table.new(ui) do
+  table do
+    row do
+      column 'Name'
+      column 'Age'
+    end
+    row do
+      column 'me'
+      column '100'
+    end
+  end
+end
+
+tbl.display
+
+tbl.update do
+  row do
+    column 'you'
+    column '50'
+  end
+end
+
+tbl.display
+```
 
 ## Info
-* Repository: https://github.com/spox/bogo-ui
+* Repository: https://github.com/spox/bogo-ui
+* Command Line Reporter: https://github.com/wbailey/command_line_reporter

data/lib/bogo-ui/table.rb

@@ -42,7 +42,19 @@ module Bogo
       def table(options={})
         @table = BufferedTable.new(options)
         yield
-        [self]
+        self
+      end
+
+      # Override to provide buffered support
+      #
+      # @param options [Hash]
+      # @return [self]
+      def row(options={})
+        options[:encoding] ||= @table.encoding
+        @row = BufferedRow.new(options.merge(:buffer => @table.buffer))
+        yield
+        @table.add(@row)
+        self
       end
 
       # Output table to defined UI
@@ -56,6 +68,8 @@ module Bogo
         @content.each do |tblock|
           instance_exec(&tblock)
         end
+        @table.output
+        @table.buffer.rewind
         output = @table.buffer.read.split("\n")
         output.slice!(0, @printed_lines)
         @printed_lines = output.size
@@ -89,6 +103,32 @@ module Bogo
 
       end
 
+      # Wrapper class to get desired buffering
+      class BufferedRow < CommandLineReporter::Row
+
+        # @return [StringIO]
+        attr_reader :buffer
+
+        # Create new instance and init buffer
+        #
+        # @return [self]
+        def initialize(options={})
+          @buffer = options.delete(:buffer)
+          super
+        end
+
+        # buffered puts
+        def puts(string)
+          buffer.puts(string)
+        end
+
+        # buffered print
+        def print(string)
+          buffer.print(string)
+        end
+
+      end
+
     end
   end
 

data/lib/bogo-ui/version.rb

@@ -1,6 +1,6 @@
 module Bogo
   class Ui
     # Current library version
-    VERSION = Gem::Version.new('0.1.0')
+    VERSION = Gem::Version.new('0.1.2')
   end
 end

data/lib/bogo-ui.rb

@@ -1,6 +1,3 @@
 require 'bogo'
+require 'bogo-ui/ui'
 require 'bogo-ui/version'
-
-module Bogo
-  autoload :Ui, 'bogo-ui/ui'
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bogo-ui
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo