ark-util 0.2.2.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a6bd3265dcdb1a7ab4533989f6f8cc86d10fe4f
+  data.tar.gz: 5fb51d42381ae0af8841e8cd1b4ff7c23014ca4e
+SHA512:
+  metadata.gz: 9a8feba0cb8f50b1dbc7efe9f1b6b06e8cb887f5e54d8f411f598975bb915cecd7e53acc8ca88ebc91cfb83a368c6a1e70d3c81690dee3853442136e308310f3
+  data.tar.gz: 56ade2e7834f5e234941741c95e5e5342657097d50d8357d3f74f5e1ec5db120a7a157c740d0da59306c04e6af6733e8ae0a64bac1e5f020129b289961146286

data/lib/ark/utility.rb

@@ -0,0 +1,163 @@
+# ark-util - utility library for ark-* gems
+# Copyright 2015 Macquarie Sharpless <macquarie.sharpless@gmail.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+module Ark
+
+  # A stopwatch-like timer
+  class Timer
+    # Configuration details for Ark::Timer. Settings:
+    # [+:round+] Number of places to round the returned time to
+    Conf = {}
+    Conf[:round] = 2
+
+    # Reset the timer start time to now
+    def self.reset()
+      @@start = Time.now
+    end
+
+    # Return the time in seconds from the last call to #reset, or from the
+    # beginning of program execution
+    def self.time()
+      t = Time.now - @@start
+      t.round(Conf[:round]).to_s.ljust(5,'0')
+    end
+
+    reset
+
+  end
+
+  # Logging/messaging facilities intended for STDOUT
+  module Log
+    # Configuration details for Ark::Log. Settings:
+    # [+:quiet+] Suppress all messages of any verbosity
+    # [+:verbose+] Allow high-verbosity messages to be printed
+    # [+:timed+] Include the time since Timer#reset was called in all messages
+    Conf = {}
+    Conf[:quiet] = false
+    Conf[:verbose] = false
+    Conf[:timed] = true
+
+    # Write +msg+ to standard output according to verbosity settings. Not meant
+    # to be used directly
+    def say(msg, sym='...', loud=false, indent=0)
+      return false if Conf[:quiet]
+      return false if loud && !Conf[:verbose]
+      unless msg == ''
+        time = ""
+        if Conf[:timed]
+          time = Timer.time.to_s.ljust(4, '0')
+          time = time + " "
+        end
+        indent = "    " * indent
+        indent = " " if indent == ""
+        puts "#{time}#{sym}#{indent}#{msg}"
+      else
+        puts
+      end
+    end
+    # Write a low-verbosity message to STDOUT
+    def msg(str, indent=0)
+      say(str, '>>>', false, indent)
+    end
+    # Write high-verbosity debugging information to STDOUT
+    def dbg(str, indent=0)
+      say(str, '...', true, indent)
+    end
+    # Write a high-verbosity warning to STDOUT
+    def wrn(str, indent=0)
+      say(str, '???', true, indent)
+    end
+
+    # Pulse a message for the duration of the execution of a block
+    def pulse(str, time, &block)
+      # TODO
+    end
+  end
+
+  # Methods for manipulating text
+  module Text
+    # Wrap a string to a given width, with an optional indent. Indented text
+    # will fall within the specified width.
+    # [+text+] The text to be wrapped
+    # [+width+] The number of columns to wrap within
+    # [+indent+] Indent each wrapped line of +text+ by this number of columns
+    def self.wrap(text, width: 78, indent: 0)
+      width -= indent
+      text = text.gsub(/\s+/, " ").gsub(/(.{1,#{width}})( |\Z)/, "\\1\n")
+      text.gsub(/^/, ' ' * indent)
+    end
+  end
+
+  # Build text progressively, line by line
+  class TextBuilder
+    # Initialize a TextBuilder instance
+    def initialize()
+      @lines = [[]]
+      @line  = 0
+    end
+
+    # Push a string onto the current line
+    def push(str)
+      if str.is_a?(Array)
+        @lines[@line] += str.map(&:to_s)
+      else
+        @lines[@line] << str.to_s
+      end
+    end
+
+    # Add +str+ to the last string on the line. This avoids a space between the
+    # strings when the text is printed
+    def add(str)
+      @lines[@line][-1] += str.to_s
+    end
+
+    # Wrap the current line to +width+, with an optional +indent+. After
+    # wrapping, the current line will be the last line wrapped.
+    def wrap(width: 78, indent: 0)
+      text = @lines[@line].join(' ')
+      text = Text.wrap(text, width: width, indent: indent)
+      @lines.delete_at(@line)
+      @line -= 1
+      text.split("\n").each {|line| self.next(line) }
+    end
+
+    # Indent the current line by +count+ columns
+    def indent(count)
+      @lines[@line].unshift(' ' * (count - 1))
+    end
+
+    # Start a new line. If +str+ is provided, push +str+ onto the new line
+    def next(str=nil)
+      @lines << []
+      @line  += 1
+      self.push(str) if str
+    end
+
+    # Insert a blank line and start the line after it. If +str+ is given, push
+    # +str+ onto the new line.
+    def skip(str=nil)
+      self.next()
+      self.next(str)
+    end
+
+    # Print the constructed text
+    def print()
+      @lines.map {|line| line.join(' ') }.join("\n")
+    end
+  end
+end
+

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: ark-util
+version: !ruby/object:Gem::Version
+  version: 0.2.2.pre
+platform: ruby
+authors:
+- Macquarie Sharpless
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-03 00:00:00.000000000 Z
+dependencies: []
+description: Utility library for ark-* gems
+email:
+- macquarie.sharpless@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ark/utility.rb
+homepage: https://github.com/grimheart/ark-util
+licenses:
+- GPL-3.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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Utility library for ark-* gems
+test_files: []