rvm2-ui 0.0.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b5f6425992ae9e1c4ed457d91464499d8feecd2
-  data.tar.gz: a5278539ab6f31e28204f3a3ee1c5b0355d90b12
+  metadata.gz: e9d620b2ab7b9614bbe190c16c3621374597241b
+  data.tar.gz: 5189ea015f85edb6e0c3a77ec81721c43750686c
 SHA512:
-  metadata.gz: 02f871b65ebe50095edfccf90e0e05ce66b3292a5bd806d2ac743bba372e4f448226c852dc06f1c87883459f155b5f239505f105f12593760c0c6269eded07e3
-  data.tar.gz: 66415ddcf05e009ce9c3645711f70af90726a38a2f3d30e05e19134fc061fac50c9fe38b143a365ba548c51ef480d58b9414912d8ff298ed5001ff5babe5b988
+  metadata.gz: cbdcb4ba42ae9a28e1f4c1e0bdbafecaf7b6321504a5044630f317f64a0b9ccbf20f91e6ac4a61b2d0b85f47f6eed68f9dec3a342e2067d703f4d1d5f5756463
+  data.tar.gz: b616024af9297757e1d9ba388aa36d45c15fd87361ac9d764b771098ae88b969fca169950a88f1134283e8cd104610fbc5993e10fb00bf4fb7488ae1086002d5

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 coverage/
+*.gem

data/.travis.yml

@@ -9,3 +9,4 @@ notifications:
     recipients:
       - mpapis@gmail.com
     on_failure: change
+cache: bundler

data/README.md

@@ -5,5 +5,109 @@
 [![Coverage Status](https://coveralls.io/repos/rvm/rvm2-ui/badge.png?branch=master)](https://coveralls.io/r/rvm/rvm2-ui?branch=master)
 [![Build Status](https://travis-ci.org/rvm/rvm2-ui.png?branch=master)](https://travis-ci.org/rvm/rvm2-ui)
 [![Dependency Status](https://gemnasium.com/rvm/rvm2-ui.png)](https://gemnasium.com/rvm/rvm2-ui)
-[![Documentation](https://f.cloud.github.com/assets/23423/241231/303578dc-899b-11e2-84e7-50387dcc3abe.png)](http://rubydoc.info/gems/rvm2-ui/frames)
+[![Documentation](http://b.repl.ca/v1/yard-docs-blue.png)](http://rubydoc.info/gems/rvm2-ui/frames)
 
+## Example output
+
+Using `:console` handler:
+
+    [ ] Command 1
+      Log output 1
+      [x] Command 2
+      [ ] Command 3
+        Log output 2
+      [v] Command 3
+    [v] Command 1
+
+## Installation
+
+Get the gem:
+
+    gem install rvm2-ui
+
+Load it:
+
+    require 'rvm2/ui'
+
+## Usage
+
+Different handlers can be loaded using `pluginator` group `rvm2` type `ui/output`:
+
+    Rvm2::Ui.get(type = :console, rvm2_plugins = nil, *args)
+
+the `args` will be passed to the handler constructor.
+
+To get the default console output:
+
+    @ui = Rvm2::Ui.get
+
+## Wrapping code blocks
+
+The `command` will produce checklist like item:
+
+   @ui.command('display name') do
+     do_something
+   end
+
+Example output with `:console` output - before finish:
+
+    [ ] Group 1
+
+after finish:
+
+    [v] Group 1
+
+## Logging output
+
+The `log` allows giving messages, warnings and errors to user:
+
+    log(message, type = :log)
+Supported types are `:log`, `:warn`, `:warn_important`, `:error`, any other type might be supported
+or should be handled as `:log` with the capitalized `type` as prefix.
+
+Example:
+
+    @ui.log("something went wrong", :error)
+
+Would produce with console:
+
+    Error: something went wrong
+
+## Handling extra outputs
+
+In some cases like running shell commands an `stdout` and `stderr` objects are available with `IO`
+interface allowing proper output handling (not injecting text in random places):
+
+    @ui.command("test") do
+      @ui.stderr.puts("debugging output")
+    end
+
+would produce with `:console`:
+
+    [ ] test
+      debugging output
+    [v] test
+
+## Combining multiple outputs
+
+In some cases it might be useful to send the same output to different targets like UI and log:
+
+    Rvm2::UI.multi(rvm2_plugins)
+
+Example use:
+
+    @ui = Rvm2::UI.multi
+    @ui.add(:console)
+    @ui.add(:log, "my_app.log")
+    @ui.log("text")
+    @ui.remove # removes the last added logger
+
+Example - temporarily use logger:
+
+    @ui = Rvm2::UI.multi
+    @ui.add(:console)
+    @ui.with(:log, "my_app.log") do
+      @ui.log("text")
+    end
+
+In bot examples the output will be written to both standard output and log file.

data/lib/plugins/rvm2/ui/output/log.rb

@@ -0,0 +1,17 @@
+module Rvm2
+  module Ui
+    module Output
+      class Log < Console
+        attr_reader :file_name
+        def initialize(file_name, flags = "w")
+          @file_name = file_name
+          @file = File.new(@file_name, flags)
+          super(@file, @file)
+        end
+        def finalize
+          @file.close
+        end
+      end
+    end
+  end
+end

data/lib/rvm2/ui.rb

@@ -1,28 +1,13 @@
-require 'hooks'
-require 'hooks/instance_hooks'
-
 module Rvm2
   module Ui
-    class Router
-      define_hooks :on_start, :on_finish, :on_log
-
-      # ui.command "bla" { do_something; }
-      def command(name, &block)
-        raise "No block given" unless block_given?
-        run_hook(:on_start,  name)
-        status = block.call
-        run_hook(:on_finish, status)
-        status
-      end
-
-      # ui.log 'message'
-      # ui.log 'message', :important
-      # standard types => :log, :warn, :important, :error
-      # in case unsupported type is used :log will be used
-      def log(message, type = :log)
-        run_hook(:on_log, message, type)
-      end
-
+    def self.get(type = :console, rvm2_plugins = nil, *args)
+      Rvm2::Ui::Single.new(type, rvm2_plugins, *args)
+    end
+    def self.multi(rvm2_plugins = nil)
+      Rvm2::Ui::Multi.new(rvm2_plugins)
     end
   end
 end
+
+require_relative 'ui/single'
+require_relative 'ui/multi'

data/lib/rvm2/ui/multi.rb

@@ -0,0 +1,55 @@
+module Rvm2
+  module Ui
+    class Multi
+
+      attr_reader :handlers
+
+      def initialize(rvm2_plugins = nil)
+        @rvm2_plugins = rvm2_plugins || Pluginator.find("rvm2", extends: %i{first_class})
+        @handlers = []
+      end
+
+      def add(handler, *args)
+        @handlers << @rvm2_plugins.first_class!('ui/output', handler).new(*args)
+      end
+
+      def remove
+        @handlers.pop
+      end
+
+      def with(handler, *args, &block)
+        add(handler, *args)
+        block.call
+        remove
+      end
+
+      # ui.command "message" { do_something; }
+      def command(name, &block)
+        raise "No block given" unless block_given?
+        @handlers.each {|h| h.start(name) }
+        status = block.call
+        @handlers.each {|h| h.finish(status) }
+        status
+      end
+
+      # ui.log 'message'
+      # ui.log 'message', :important
+      # standard types => :log, :warn, :important, :error
+      # in case unsupported type is used :log will be used
+      def log(message, type = :log)
+        @handlers.each {|h| h.log(message, type) }
+      end
+
+      def stdout
+        @stdout ||= IoWriteRouter.new(self, :stdout)
+      end
+
+      def stderr
+        @stderr ||= IoWriteRouter.new(self, :stderr)
+      end
+
+    end
+  end
+end
+
+require_relative 'multi/io_write_router'

data/lib/rvm2/ui/multi/io_write_router.rb

@@ -0,0 +1,32 @@
+module Rvm2
+  module Ui
+    class Multi
+      class IoWriteRouter
+
+        def initialize(parent, type)
+          @parent = parent
+          @type   = type
+        end
+        def write(*args)
+          @parent.handlers.each{|h| h.send(@type).write(*args) }
+        end
+        def <<(*args)
+          @parent.handlers.each{|h| h.send(@type).<<(*args) }
+        end
+        def print(*args)
+          @parent.handlers.each{|h| h.send(@type).print(*args) }
+        end
+        def printf(*args)
+          @parent.handlers.each{|h| h.send(@type).printf(*args) }
+        end
+        def puts(*args)
+          @parent.handlers.each{|h| h.send(@type).puts(*args) }
+        end
+        def write_nonblock(*args)
+          @parent.handlers.each{|h| h.send(@type).write_nonblock(*args) }
+        end
+
+      end
+    end
+  end
+end

data/lib/rvm2/ui/single.rb

@@ -0,0 +1,41 @@
+require 'pluginator'
+
+module Rvm2
+  module Ui
+    class Single
+
+      attr_reader :handler
+
+      def initialize(handler = :console, rvm2_plugins = nil, *args)
+        @rvm2_plugins = rvm2_plugins || Pluginator.find("rvm2", extends: %i{first_class})
+        @handler = @rvm2_plugins.first_class!('ui/output', handler).new(*args)
+      end
+
+      # ui.command "message" { do_something; }
+      def command(name, &block)
+        raise "No block given" unless block_given?
+        @handler.start(name)
+        status = block.call
+        @handler.finish(status)
+        status
+      end
+
+      # ui.log 'message'
+      # ui.log 'message', :important
+      # standard types => :log, :warn, :important, :error
+      # in case unsupported type is used :log will be used
+      def log(message, type = :log)
+        @handler.log(message, type)
+      end
+
+      def stdout
+        @handler.stdout
+      end
+
+      def stderr
+        @handler.stderr
+      end
+
+    end
+  end
+end

data/lib/rvm2/ui/version.rb

@@ -1,5 +1,5 @@
 module Rvm2
   module Ui
-    VERSION = '0.0.1'
+    VERSION = '0.9.0'
   end
 end

data/rvm2-ui.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.required_ruby_version = ">= 2.0.0"
+  s.add_dependency('pluginator')
   %w{rake minitest simplecov coveralls redcarpet}.each do |name|
     s.add_development_dependency(name)
   end

data/test/README.md

@@ -0,0 +1 @@
+Note the `plugins_test` contains `_test` to avoid being discovered as `plugins` by `pluginator`.

data/test/plugins_test/rvm2/ui/output/log_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+require 'plugins/rvm2/ui/output/log'
+require 'tempfile'
+
+describe Rvm2::Ui::Output::Log do
+  before do
+    @tempfile = Tempfile.new("rvm2-ui-output-log-test")
+    @tempfile.close
+  end
+  after do
+    @tempfile.unlink
+  end
+  subject do
+    Rvm2::Ui::Output::Log.new(@tempfile.path)
+  end
+
+  it "adds messages" do
+    subject.log("Test me 1")
+    subject.finalize
+    File.open(@tempfile.path, "r") do |file|
+      file.read.must_equal(<<-EXPECTED)
+Test me 1
+      EXPECTED
+    end
+  end
+end

data/test/rvm2/ui/multi/io_write_router_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+require 'rvm2/ui/multi/io_write_router'
+require 'plugins/rvm2/ui/output/fake'
+
+class HandlersParent
+  attr_reader :handlers
+  def initialize
+    @handlers = [Rvm2::Ui::Output::Fake.new, Rvm2::Ui::Output::Fake.new]
+  end
+end
+
+describe Rvm2::Ui::Multi::IoWriteRouter do
+  before do
+    @parent = HandlersParent.new
+  end
+
+  subject do
+    Rvm2::Ui::Multi::IoWriteRouter.new(@parent, :stdout)
+  end
+
+  it "supports write" do
+    subject.write("test 1")
+    @parent.handlers[0].root.list.map(&:message).must_equal(["test 1"])
+    @parent.handlers[1].root.list.map(&:message).must_equal(["test 1"])
+  end
+
+  it "supports <<" do
+    subject << "test 1"
+    @parent.handlers[0].root.list.map(&:message).must_equal(["test 1"])
+    @parent.handlers[1].root.list.map(&:message).must_equal(["test 1"])
+  end
+
+  it "supports print" do
+    subject.print("test 1")
+    @parent.handlers[0].root.list.map(&:message).must_equal(["test 1"])
+    @parent.handlers[1].root.list.map(&:message).must_equal(["test 1"])
+  end
+
+  it "supports printf" do
+    subject.printf("test 1")
+    @parent.handlers[0].root.list.map(&:message).must_equal(["test 1"])
+    @parent.handlers[1].root.list.map(&:message).must_equal(["test 1"])
+  end
+
+  it "supports puts" do
+    subject.puts("test 1")
+    @parent.handlers[0].root.list.map(&:message).must_equal(["test 1", "\n"])
+    @parent.handlers[1].root.list.map(&:message).must_equal(["test 1", "\n"])
+  end
+
+  it "supports write_nonblock" do
+    subject.write_nonblock("test 1")
+    @parent.handlers[0].root.list.map(&:message).must_equal(["test 1"])
+    @parent.handlers[1].root.list.map(&:message).must_equal(["test 1"])
+  end
+
+end

data/test/rvm2/ui/multi_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+require 'rvm2/ui/multi'
+
+describe Rvm2::Ui::Multi do
+  before do
+    @stdout = StringIO.new
+    @stderr = StringIO.new
+  end
+
+  subject do
+    ui = Rvm2::Ui::Multi.new
+    ui.add(:console, @stdout, @stderr)
+    ui.add(:fake)
+    ui
+  end
+
+  it "removes handlers" do
+    subject.remove
+    subject.handlers.map{|h| h.class.name }.must_equal(["Rvm2::Ui::Output::Console"])
+  end
+
+  it "supports multiple outputs" do
+    subject.handlers.map{|h| h.class.name }.must_equal(["Rvm2::Ui::Output::Console", "Rvm2::Ui::Output::Fake"])
+  end
+
+  it "handles commands" do
+    subject.command("test true" ){ true  }.must_equal(true)
+    subject.command("test false"){ false }.must_equal(false)
+    @stdout.string.must_equal(<<-EXPECTED)
+[ ] test true\r[v] test true
+[ ] test false\r[x] test false
+EXPECTED
+    subject.handlers[1].root.list.map(&:message).must_equal(["test true", "test false"])
+  end
+
+  it "handles log" do
+    subject.log("test log")
+    @stdout.string.must_equal(<<-EXPECTED)
+test log
+EXPECTED
+    subject.handlers[1].root.list.map(&:message).must_equal(["test log"])
+  end
+
+  it "supports outputs" do
+    subject.stdout.write("test stdout")
+    subject.stderr.write("test stderr")
+    @stdout.string.must_equal("test stdout")
+    @stderr.string.must_equal("test stderr")
+    subject.handlers[1].root.list.map(&:message).must_equal(["test stdout", "test stderr"])
+    subject.handlers[1].root.list.map(&:type).must_equal([:stdout, :stderr])
+  end
+
+  it "handles temporary adding of a log" do
+    subject.handlers.count.must_equal(2)
+    subject.with(:fake) do
+      subject.handlers.count.must_equal(3)
+      subject.handlers[2].class.name.must_equal("Rvm2::Ui::Output::Fake")
+    end
+    subject.handlers.count.must_equal(2)
+  end
+
+end

data/test/rvm2/ui/single_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+require 'rvm2/ui/single'
+
+describe Rvm2::Ui::Single do
+  subject do
+    Rvm2::Ui::Single
+  end
+
+  it "loads console by default" do
+    subject.new.handler.class.name.must_equal("Rvm2::Ui::Output::Console")
+  end
+
+  it "handles commands" do
+    @obj = subject.new(:fake)
+    @obj.command("test true" ){ true  }.must_equal(true)
+    @obj.command("test false"){ false }.must_equal(false)
+    @obj.handler.root.list.map(&:message).must_equal(["test true", "test false"])
+  end
+
+  it "handles log" do
+    @obj = subject.new(:fake)
+    @obj.log("test log")
+    @obj.handler.root.list.map(&:message).must_equal(["test log"])
+  end
+
+  it "supports outputs" do
+    @obj = subject.new(:fake)
+    @obj.stdout.write("test stdout")
+    @obj.stderr.write("test stderr")
+    @obj.handler.root.list.map(&:message).must_equal(["test stdout", "test stderr"])
+    @obj.handler.root.list.map(&:type   ).must_equal([:stdout, :stderr])
+  end
+
+end

data/test/rvm2/ui_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+require 'rvm2/ui'
+
+describe Rvm2::Ui do
+  it "gets instance of single" do
+    Rvm2::Ui.get.class.name.must_equal("Rvm2::Ui::Single")
+  end
+  it "gets instance of multi" do
+    Rvm2::Ui.multi.class.name.must_equal("Rvm2::Ui::Multi")
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rvm2-ui
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Michal Papis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2013-12-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: pluginator
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,11 +109,21 @@ files:
 - Rakefile
 - lib/plugins/rvm2/ui/output/console.rb
 - lib/plugins/rvm2/ui/output/fake.rb
+- lib/plugins/rvm2/ui/output/log.rb
 - lib/rvm2/ui.rb
+- lib/rvm2/ui/multi.rb
+- lib/rvm2/ui/multi/io_write_router.rb
+- lib/rvm2/ui/single.rb
 - lib/rvm2/ui/version.rb
 - rvm2-ui.gemspec
-- test/plugins/rvm2/ui/output/console_test.rb
-- test/plugins/rvm2/ui/output/fake_test.rb
+- test/README.md
+- test/plugins_test/rvm2/ui/output/console_test.rb
+- test/plugins_test/rvm2/ui/output/fake_test.rb
+- test/plugins_test/rvm2/ui/output/log_test.rb
+- test/rvm2/ui/multi/io_write_router_test.rb
+- test/rvm2/ui/multi_test.rb
+- test/rvm2/ui/single_test.rb
+- test/rvm2/ui_test.rb
 - test/test_helper.rb
 homepage: https://github.com/rvm/rvm2-ui
 licenses:
@@ -126,6 +150,12 @@ signing_key:
 specification_version: 4
 summary: Abstract user interface handling in RVM2
 test_files:
-- test/plugins/rvm2/ui/output/console_test.rb
-- test/plugins/rvm2/ui/output/fake_test.rb
+- test/README.md
+- test/plugins_test/rvm2/ui/output/console_test.rb
+- test/plugins_test/rvm2/ui/output/fake_test.rb
+- test/plugins_test/rvm2/ui/output/log_test.rb
+- test/rvm2/ui/multi/io_write_router_test.rb
+- test/rvm2/ui/multi_test.rb
+- test/rvm2/ui/single_test.rb
+- test/rvm2/ui_test.rb
 - test/test_helper.rb