bogo-ui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3806ec515d426c9a9ce068b1a2f31d786890f7e8
+  data.tar.gz: 19e031956c263db5be7c8e4b94503451ed76cf4a
+SHA512:
+  metadata.gz: 4b4143699d0bc034ab3705c221e4c0e2e7e0f4d8420e790d7ff7c6fd922cd2c842454fc02fcdd1f82220db261fa6a3772be465445656fddb229fd5d49a2ed460
+  data.tar.gz: 7828448db39baa5c94b0655ad98e331255083a21a62b9110655f8c49e61dd8f4564e12d5ea0af231a375320bc536de9181dc66ac636e3ab7f9856948dc797e82

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## v0.1.0
+* Initial release

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+## Branches
+
+### `master` branch
+
+The master branch is the current stable released version.
+
+### `develop` branch
+
+The develop branch is the current edge of development.
+
+## Pull requests
+
+* https://github.com/spox/bogo-ui/pulls
+
+Please base all pull requests of the `develop` branch. Merges to
+`master` only occur through the `develop` branch. Pull requests
+based on `master` will likely be cherry picked.
+
+## Issues
+
+Need to report an issue? Use the github issues:
+
+* https://github.com/spox/bogo-ui/issues

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2014 Chris Roberts
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,6 @@
+# Bogo UI
+
+A collection of UI libraries.
+
+## Info
+* Repository: https://github.com/spox/bogo-ui

data/bogo-ui.gemspec

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'bogo-ui/version'
+Gem::Specification.new do |s|
+  s.name = 'bogo-ui'
+  s.version = Bogo::Ui::VERSION.version
+  s.summary = 'UI Helper libraries'
+  s.author = 'Chris Roberts'
+  s.email = 'code@chrisroberts.org'
+  s.homepage = 'https://github.com/spox/bogo-ui'
+  s.description = 'UI Helper libraries'
+  s.require_path = 'lib'
+  s.license = 'Apache 2.0'
+  s.add_dependency 'bogo'
+  s.add_dependency 'command_line_reporter'
+  s.add_dependency 'paint'
+  s.files = Dir['lib/**/*'] + %w(bogo-ui.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
+end

data/lib/bogo-ui/table.rb

@@ -0,0 +1,95 @@
+require 'bogo-ui'
+require 'command_line_reporter'
+
+module Bogo
+
+  class Ui
+    # Table output helper
+    class Table
+
+      include CommandLineReporter
+
+      # @return [Bogo::Ui]
+      attr_reader :ui
+      # @return [Array<Proc>]
+      attr_reader :table
+
+      # Create a new instance
+      #
+      # @param ui [Bogo::Ui]
+      # @yield table content
+      # @return [self]
+      def initialize(ui, &block)
+        @ui = ui
+        @base = block
+        @content = []
+        @printed_lines = 0
+      end
+
+      # Update the table content
+      #
+      # @yield table content
+      # @return [self]
+      def update(&block)
+        @content << block
+        self
+      end
+
+      # Override to provide buffered support
+      #
+      # @param options [Hash]
+      # @return [self]
+      def table(options={})
+        @table = BufferedTable.new(options)
+        yield
+        [self]
+      end
+
+      # Output table to defined UI
+      #
+      # @return [self]
+      # @note can be called multiple times to print table updates
+      def display
+        # init the table
+        instance_exec(&@base)
+        # load the table
+        @content.each do |tblock|
+          instance_exec(&tblock)
+        end
+        output = @table.buffer.read.split("\n")
+        output.slice!(0, @printed_lines)
+        @printed_lines = output.size
+        ui.puts output.join("\n")
+        self
+      end
+
+      # Wrapper class to get desired buffering
+      class BufferedTable < CommandLineReporter::Table
+
+        # @return [StringIO]
+        attr_reader :buffer
+
+        # Create new instance and init buffer
+        #
+        # @return [self]
+        def initialize(*args)
+          @buffer = StringIO.new
+          super
+        end
+
+        # buffered puts
+        def puts(string)
+          buffer.puts(string)
+        end
+
+        # buffered print
+        def print(string)
+          buffer.print(string)
+        end
+
+      end
+
+    end
+  end
+
+end

data/lib/bogo-ui/ui.rb

@@ -0,0 +1,115 @@
+require 'bogo-ui'
+require 'paint'
+
+module Bogo
+  # CLI UI helper
+  class Ui
+
+    autoload :Table, 'bogo-ui/table'
+
+    # @return [Truthy, Falsey]
+    attr_accessor :colorize
+    # @return [String]
+    attr_accessor :application_name
+
+    # Build new UI instance
+    #
+    # @param args [Hash]
+    # @option args [String] :app_name name of application
+    # @option args [TrueClass, FalseClass] :colors enable/disable colors
+    # @option args [IO] :output_to IO to write
+    # @return [self]
+    def initialize(args={})
+      @application_name = args.fetch(:app_name)
+      @colorize = args.fetch(:colors, true)
+      @output_to = args.fetch(:output_to, $stdout)
+    end
+
+    # Output directly
+    #
+    # @param string [String]
+    # @return [String]
+    def puts(string='')
+      @output_to.puts string
+      string
+    end
+
+    # Output directly
+    #
+    # @param string [String]
+    # @return [String]
+    def print(string='')
+      @output_to.print string
+      string
+    end
+
+    # Output information string
+    #
+    # @param string [String]
+    # @return [String]
+    def info(string, *args)
+      output_method = args.include?(:nonewline) ? :print : :puts
+      self.send(output_method, "#{color("[#{application_name}]:", :green)} #{string}")
+      string
+    end
+
+    # Format warning string
+    #
+    # @param string [String]
+    # @return [String]
+    def warn(string, *args)
+      output_method = args.include?(:nonewline) ? :print : :puts
+      self.send(output_method, "#{color('[WARN]:', :yellow, :bold)} #{string}")
+      string
+    end
+
+    # Format error string
+    #
+    # @param string [String]
+    # @return [String]
+    def error(string, *args)
+      output_method = args.include?(:nonewline) ? :print : :puts
+      self.send(output_method, "#{color('[ERROR]:', :red, :bold)} #{string}")
+      string
+    end
+
+    # Colorize string
+    #
+    # @param string [String]
+    # @param args [Symbol]
+    # @return [String]
+    def color(string, *args)
+      if(colorize)
+        Paint[string, *args]
+      else
+        string
+      end
+    end
+
+    # Prompt for question and receive answer
+    #
+    # @param question [String]
+    # @param default [String]
+    # @return [String]
+    def ask(question, default=nil)
+      string = question.dup
+      if(default)
+        string << " [#{default}]"
+      end
+      result = nil
+      until(result)
+        info "#{string}: ", :nonewline
+        result = $stdin.gets.strip
+        if(result.empty? && default)
+          result = default
+        end
+        if(result.empty?)
+          error 'Please provide a value'
+          result = nil
+        end
+      end
+      result
+    end
+
+  end
+end

data/lib/bogo-ui/version.rb

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

data/lib/bogo-ui.rb

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

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: bogo-ui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bogo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: command_line_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: UI Helper libraries
+email: code@chrisroberts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- bogo-ui.gemspec
+- lib/bogo-ui.rb
+- lib/bogo-ui/table.rb
+- lib/bogo-ui/ui.rb
+- lib/bogo-ui/version.rb
+homepage: https://github.com/spox/bogo-ui
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: UI Helper libraries
+test_files: []
+has_rdoc: