bovem 2.0.3 → 2.1.0

data/doc/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.8.3
+    &mdash; Documentation by YARD 0.8.4
   
 </title>
 
@@ -103,9 +103,9 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Feb  2 17:05:17 2013 by
+  Generated on Tue Feb  5 13:31:46 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.3 (ruby-1.9.3).
+  0.8.4 (ruby-1.9.3).
 </div>
 
   </body>

data/lib/bovem.rb

@@ -5,10 +5,10 @@
 #
 
 require "logger"
-require "lazier"
 require "open4"
 require "find"
 require "fileutils"
+require "lazier"
 
 Lazier.load!(:object)
 

data/lib/bovem/configuration.rb

@@ -30,6 +30,7 @@ module Bovem
     # @param logger [Logger] The logger to use for notifications.
     # @see #parse
     def initialize(file = nil, overrides = {}, logger = nil)
+      self.i18n_setup(:bovem, ::File.absolute_path(::Pathname.new(::File.dirname(__FILE__)).to_s + "/../../locales/"))
       self.parse(file, overrides, logger)
     end
 
@@ -91,14 +92,21 @@ module Bovem
       def read_configuration_file(file, logger)
         begin
           # Open the file
-          path = ::Pathname.new(file).realpath
+          path = file =~ /^#{File::SEPARATOR}/ ? file : ::Pathname.new(file).realpath.to_s
           logger.info(self.i18n.using(path)) if logger
-          self.tap do |config|
-            eval(::File.read(path))
-          end
+          eval_file(path)
         rescue ::Exception => e
           raise Bovem::Errors::InvalidConfiguration.new(self.i18n.configuration.invalid(file))
         end
       end
+
+      # Eval a configuration file.
+      #
+      # @param path [String] The file to read.
+      def eval_file(path)
+        self.tap do |config|
+          eval(::File.read(path))
+        end
+      end
   end
 end

data/lib/bovem/console.rb

@@ -112,13 +112,6 @@ module Bovem
 
     # Methods for formatting output messages.
     module Output
-      # Gets the current screen width.
-      #
-      # @return [Fixnum] The screen width.
-      def get_screen_width
-        ::Bovem::Console.execute("tput cols").to_integer(80)
-      end
-
       # Sets the new indentation width.
       #
       # @param width [Fixnum] The new width.
@@ -205,7 +198,7 @@ module Bovem
 
         # Compute the real width available for the screen, if we both indent and wrap
         if wrap == true then
-          wrap = @line_width
+          wrap = self.line_width
 
           if indent == true then
             wrap -= @indentation
@@ -234,8 +227,7 @@ module Bovem
 
         rv = go_up ? "\e[A" : ""
 
-        @screen_width ||= self.get_screen_width
-        width = (width == true || width.to_integer < 1 ? @screen_width : width.to_integer)
+        width = (width == true || width.to_integer < 1 ? self.line_width : width.to_integer)
 
         # Get padding
         padding = width - message.to_s.gsub(/(\e\[[0-9]*[a-z]?)|(\\n)/i, "").length
@@ -465,24 +457,20 @@ module Bovem
       # @param prompt [String|Boolean] A prompt to show. If `true`, `Please insert a value:` will be used, if `nil` or `false` no prompt will be shown.
       # @param default_value [String] Default value if user simply pressed the enter key.
       # @param validator [Array|Regexp] An array of values or a Regexp to match the submitted value against.
-      # @param echo [Boolean] If to show submitted text to the user.
+      # @param echo [Boolean] If to show submitted text to the user. **Not supported and thus ignored on Rubinius.**
       def read(prompt = true, default_value = nil, validator = nil, echo = true)
         prompt = sanitize_prompt(prompt)
-
-        # Adjust validator
         validator = sanitize_validator(validator)
 
-        with_echo_handling(echo) do
-          begin
-            catch(:reply) do
-              while true do
-                reply = validate_input_value(read_input_value(prompt, default_value), validator)
-                handle_reply(reply)
-              end
+        begin
+          catch(:reply) do
+            while true do
+              reply = validate_input_value(read_input_value(prompt, echo, default_value), validator)
+              handle_reply(reply)
             end
-          rescue Interrupt => e
-            default_value
           end
+        rescue Interrupt => e
+          default_value
         end
       end
 
@@ -547,32 +535,19 @@ module Bovem
           validator.present? && !validator.is_a?(::Regexp) ? validator.ensure_array.collect {|v| v.ensure_string} : validator
         end
 
-        # Handle terminal echoing.
-        #
-        # @param echo [Boolean] If disabled echoing
-        def with_echo_handling(echo = true)
-          rv = nil
-
-          disable_echo = !echo && @stty.present? && /-echo\b/mix.match(::Bovem::Console.execute(@stty)).nil?
-          ::Bovem::Console.execute("#{@stty} -echo") if disable_echo
-          rv = yield
-          ::Bovem::Console.execute("#{@stty} echo") if disable_echo
-
-          rv
-        end
-
         # Read an input from the terminal.
         #
         # @param prompt [String] A message to show to the user.
+        # @param echo [Boolean] If disable echoing. **Not supported and thus ignored on Rubinius.**
         # @param default_value [Object] A default value to enter if the user just pressed the enter key.
         # @return [Object] The read value.
-        def read_input_value(prompt, default_value = nil)
+        def read_input_value(prompt, echo, default_value = nil)
           if prompt then
             Kernel.print self.format(prompt, false, false)
             $stdout.flush
           end
 
-          reply = $stdin.gets.chop
+          reply = (echo || !$stdin.respond_to?(:noecho) ? $stdin.gets : $stdin.noecho(&:gets)).ensure_string.chop
           reply.present? ? reply : default_value
         end
 
@@ -609,17 +584,11 @@ module Bovem
 
   # This is a text utility wrapper console I/O.
   #
-  # @attribute line_width
-  #   @return [Fixnum] The line width. Default to `80`.
-  # @attribute screen_width
-  #   @return [Fixnum] The current screen width.
   # @attribute indentation
   #   @return [Fixnum] Current indentation width.
   # @attribute indentation_string
   #   @return [String] The string used for indentation.
   class Console
-    attr_accessor :line_width
-    attr_accessor :screen_width
     attr_accessor :indentation
     attr_accessor :indentation_string
 
@@ -638,11 +607,21 @@ module Bovem
 
     # Initializes a new Console.
     def initialize
-      @line_width = self.get_screen_width
       @indentation = 0
       @indentation_string = " "
-      @stty = ::Bovem::Console.execute("which stty").strip
       self.i18n_setup(:bovem, ::File.absolute_path(::Pathname.new(::File.dirname(__FILE__)).to_s + "/../../locales/"))
     end
+
+    # Get the width of the terminal.
+    #
+    # @return [Fixnum] The current width of the terminal. If not possible to retrieve the width, it returns `80.
+    def line_width
+      begin
+        require "io/console" if !defined?($stdin.winsize)
+        $stdin.winsize[1]
+      rescue Exception => e
+        80
+      end
+    end
   end
 end

data/lib/bovem/shell.rb

@@ -19,17 +19,24 @@ module Bovem
       # @param fatal [Boolean] If quit in case of fatal errors.
       # @param show_errors [Boolean] Whether to show errors.
       def handle_failure(e, access_error, not_found_error, general_error, entries, fatal, show_errors)
-        error_type = fatal ? :fatal : :error
-        message = e.message.gsub(/.+ - (.+)/, "\\1")
-        locale = self.i18n.shell
+        error_type, locale, final_entries = setup_error_handling(entries, fatal)
 
         case e.class.to_s
-          when "Errno::EACCES" then @console.send(error_type, locale.send(access_error, message))
-          when "Errno::ENOENT" then @console.send(error_type, locale.send(not_found_error, message))
+          when "Errno::EACCES" then @console.send(error_type, locale.send(access_error, final_entries))
+          when "Errno::ENOENT" then @console.send(error_type, locale.send(not_found_error, final_entries))
           else show_general_failure(e, general_error, entries, fatal) if show_errors
         end
       end
 
+      # Setups error handling.
+      #
+      # @param entries [Array] The list of entries which failed.
+      # @param fatal [Boolean] If quit in case of fatal errors.
+      # @return [Array] Variables for error handling
+      def setup_error_handling(entries, fatal)
+        [fatal ? :fatal : :error, self.i18n.shell, entries.length == 1 ? entries[0] : entries]
+      end
+
       # Shows errors when a directory creation failed.
       #
       # @param e [Exception] The occurred exception.

data/lib/bovem/version.rb

@@ -14,10 +14,10 @@ module Bovem
     MAJOR = 2
 
     # The minor version.
-    MINOR = 0
+    MINOR = 1
 
     # The patch version.
-    PATCH = 3
+    PATCH = 0
 
     # The current version number of Bovem.
     STRING = [MAJOR, MINOR, PATCH].compact.join(".")

data/spec/bovem/configuration_spec.rb

@@ -11,12 +11,12 @@ describe Bovem::Configuration do
     property :property
   end
 
-  let(:log_file) { "/tmp/bovem-test-log-#{Time.now.strftime("%Y%m%d-%H:%M:%S")}" }
-  let(:test_prefix) { "/tmp/bovem-test-#{Time.now.strftime("%Y%m%d-%H:%M:%S")}" }
+  let(:log_file) { "/tmp/bovem-test-log-#{Time.now.strftime("%Y%m%d-%H%M%S")}" }
+  let(:test_prefix) { "/tmp/bovem-test-#{Time.now.strftime("%Y%m%d-%H%M%S")}" }
 
   describe "#parse" do
     it "reads a valid configuration file" do
-      file = ::File.open("#{test_prefix}", "w") {|f| f.write("config.property = 1234") }
+      file = ::File.open(test_prefix, "w") {|f| f.write("config.property = 1234") }
 
       config = BaseConfiguration.new(test_prefix)
       expect(config.property).to eq(1234)

data/spec/bovem/console_spec.rb

@@ -66,20 +66,20 @@ describe Bovem::Console do
   describe "#initialize" do
     it "should correctly set defaults" do
       expect(console.indentation).to eq(0)
-      expect(console.line_width).to eq(`tput cols`.to_integer)
       expect(console.indentation_string).to eq(" ")
     end
   end
 
-  describe "#get_screen_width" do
-    it "should execute \"tput cols\" and \"which stty\"" do
-      ::Bovem::Console.should_receive(:execute).with("tput cols").at_least(1).and_call_original
-      ::Bovem::Console.should_receive(:execute).with("which stty").at_least(1).and_call_original
-      console.get_screen_width
+  describe "#line_width" do
+    it "should return a Fixnum greater than 0" do
+      w = console.line_width
+      expect(w).to be_a(Fixnum)
+      expect(w >= 0).to be_true
     end
 
-    it "should return a number >= 0" do
-      expect(console.get_screen_width).to be >= 0
+    it "should use $stdin.winsize if available" do
+      $stdin.should_receive(:winsize)
+      console.line_width
     end
   end
 
@@ -181,13 +181,13 @@ describe Bovem::Console do
     it "should correctly align messages" do
       message = "ABCDE"
       extended_message = "ABC\e[AD\e[3mE"
-      console.screen_width = 80
+      console.stub(:line_width).and_return(80)
 
       expect(console.format_right(message)).to eq("\e[A\e[0G\e[#{75}CABCDE")
       expect(console.format_right(message, 10)).to eq("\e[A\e[0G\e[#{5}CABCDE")
       expect(console.format_right(extended_message)).to eq("\e[A\e[0G\e[#{75}CABC\e[AD\e[3mE")
       expect(console.format_right(message, nil, false)).to eq("\e[0G\e[#{75}CABCDE")
-      console.screen_width = 10
+      console.stub(:line_width).and_return(10)
       expect(console.format_right(message)).to eq("\e[A\e[0G\e[#{5}CABCDE")
     end
   end
@@ -302,7 +302,7 @@ describe Bovem::Console do
     end
   end
 
-  describe "status" do
+  describe "#status" do
     it "should get the right status" do
       expect(console.status(:ok, false, true, false)).to eq({label: " OK ", color: "bright green"})
       expect(console.status(:pass, false, true, false)).to eq({label: "PASS", color: "bright cyan"})
@@ -390,25 +390,7 @@ describe Bovem::Console do
     end
 
     it "should hide echo to the user when the terminal shows echo" do
-      $stdin.stub(:gets).and_return("VALUE\n")
-      stty = %x{which stty}.strip
-
-      ::Bovem::Console.should_receive(:execute).with("tput cols").and_return(80)
-      ::Bovem::Console.should_receive(:execute).with("which stty").and_return(stty)
-      ::Bovem::Console.should_receive(:execute).with(stty).and_return("speed 9600 baud;\nlflags: echoe echoke echoctl pendin\niflags: iutf8\noflags: -oxtabs\ncflags: cs8 -parenb")
-      ::Bovem::Console.should_receive(:execute).with("#{stty} -echo")
-      ::Bovem::Console.should_receive(:execute).with("#{stty} echo")
-      console.read(nil, nil, nil, false)
-    end
-
-    it "shouldn't hide echo again when the terminal already hides it" do
-      $stdin.stub(:gets).and_return("VALUE\n")
-      stty = %x{which stty}.strip
-
-      ::Bovem::Console.should_receive(:execute).with("which stty").and_return(stty)
-      ::Bovem::Console.should_receive(:execute).with(stty).and_return("speed 9600 baud;\nlflags: -echo echoe echoke echoctl pendin\niflags: iutf8\noflags: -oxtabs\ncflags: cs8 -parenb")
-      ::Bovem::Console.should_not_receive("execute").with("#{stty} -echo")
-      ::Bovem::Console.should_not_receive("execute").with("#{stty} echo")
+      $stdin.should_receive(:noecho).and_return("VALUE")
       console.read(nil, nil, nil, false)
     end
   end

data/spec/bovem/shell_spec.rb

@@ -36,6 +36,10 @@ describe Bovem::Shell do
   end
 
   describe "#run" do
+    before(:each) do
+      ::Open4::stub(:popen4) do |_a, _b, _c, _d| OpenStruct.new(exitstatus: 0) end
+    end
+
     it "should show a message" do
       shell.console.should_receive("begin").with("MESSAGE")
       shell.run("echo OK", "MESSAGE", true, false)
@@ -50,17 +54,22 @@ describe Bovem::Shell do
 
     it "should only print the command if requested to" do
       shell.console.should_receive("warn").with("Will run command: {mark=bright}\"echo OK\"{/mark}...")
-      ::Open4.should_not_receive("open4")
+      ::Open4.should_not_receive("popen4")
       shell.run("echo OK", nil, false, false)
     end
 
     it "should only execute a command" do
       shell.console.should_not_receive("warn").with("Will run command: {mark=bright}\"echo OK\"{/mark}...")
-      ::Open4.should_receive("popen4").and_return(::OpenStruct.new(exitstatus: 0))
       shell.run("echo OK", nil, true, false)
     end
 
     it "should show a exit message" do
+      i = -1
+      ::Open4::stub(:popen4) do |_a, _b, _c, _d|
+        i += 1
+        OpenStruct.new(exitstatus: i)
+      end
+
       shell.console.should_receive(:status).with(:ok)
       shell.run("echo OK", nil, true, true)
       shell.console.should_receive(:status).with(:fail)
@@ -69,10 +78,16 @@ describe Bovem::Shell do
 
     it "should print output" do
       Kernel.should_receive("print").with("OK\n")
+
+      stdout = Object.new
+      stdout.stub(:each_line).and_yield("OK\n")
+      ::Open4::stub(:popen4).and_yield(nil, nil, stdout, nil).and_return(OpenStruct.new(exitstatus: 0))
+
       shell.run("echo OK", nil, true, false, true)
     end
 
     it "should raise a exception for failures" do
+      ::Open4::stub(:popen4) {|_a, _b, _c, _d| OpenStruct.new(exitstatus: 1) }
       expect { shell.run("echo1 OK", nil, true, false, false, false, false) }.to_not raise_error(SystemExit)
       expect { shell.run("echo1 OK", nil, true, false, false) }.to raise_error(SystemExit)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bovem
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lazier
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.6.3
 - !ruby/object:Gem::Dependency
   name: open4
   requirement: !ruby/object:Gem::Requirement
@@ -43,118 +43,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.12.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 10.0.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 10.0.3
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.1
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.3
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.2.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.2.2
-- !ruby/object:Gem::Dependency
-  name: github-markup
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.5
 description: A collection of utilities for developers.
 email:
 - shogun_panda@me.com
@@ -163,10 +51,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis-gemfile
 - .travis.yml
 - .yardopts
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bovem.gemspec
@@ -233,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: