HelperClasses 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e9d72b8fe43505cae6d07152f6bf45f9d94cec5
-  data.tar.gz: c8ec6b3f48a225602628f578122ac32f5bb7388a
+  metadata.gz: 93e502dfc1275307448cbb1a400fb2e9f66cc9bb
+  data.tar.gz: 9a11df7ce26d9d05413b1fc26c56943adec234b7
 SHA512:
-  metadata.gz: cdd44f845254cadfc4771dce2c205fdca28139550e0d1bf6d2393cb67fd0f03f12a3cca089ce8ff3e5f5f117cd82a16f2614cd4288504d621f1ead249ec733a0
-  data.tar.gz: 3404bd78e68baa95a8c991714c80a0f9326c50dd8624e40ea907e76fa5c79315a0a12368cb44321826cc3b0dac0d1060c092d35e16cc9f78e0e6928dcf83b84c
+  metadata.gz: 8dc8b0468193eb16e9b776b17951f9cfd353b6f84624edb65817bb9ec0b1ae3f9a84a58d7de96f9ecb9e784983e592b49fe55928579e33bc6fb4a5b69594aa15
+  data.tar.gz: 93af48558a982873408929fd5a57ac57e633ee5180dcd22aa461d8b44db3d61723bdeb88f52e15e163240a92fd13542d634597d58d1a8ed8d97cf29b0fdb3dcf

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+/nbproject
+.hg*
+.idea
+commit
+.DS_Store
+test/test_config

data/{README → README.md}

@@ -36,6 +36,28 @@ will NOT evaluate it! The debug-levels are arbitrarily chosen like this:
 4
 5 - Dumping lots of raw data
 
+==== Fine-grained debugging
+
+If you have a function with lots of _dputs_ in it, and you'd like to output
+all debugging messages just from that function, you simply add
+
+```
+dputs_func
+```
+
+at the beginning of your function.
+
+If you want just one specific _dputs_ to be evaluated, just change its name to
+_ddputs_:
+
+```
+DEBUG_LVL = 0
+
+ddputs(5){"String with lots of data#{huge_var.inspect}"}
+```
+
+will be evaluated!
+
 === Arraysym
 
 to_sym and to_sym! - calls .to_sym on all elements. Usage:

data/helperclasses.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name = 'HelperClasses'
+  s.version = '0.2.0'
+  s.date = '2015-04-06'
+  s.summary = 'Hash._accessor Array.to_sym and DPuts'
+  s.description = 'Added accessors to Hash, to_sym to Array and a nice debugging-interface called DPuts'
+  s.authors = ['Linus Gasser']
+  s.email = 'ineiti@linusetviviane.ch'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.homepage =
+      'https://github.com/ineiti/HelperClasses'
+  s.license = 'GPLv3'
+end

data/lib/helperclasses.rb

@@ -1,3 +1,7 @@
-require 'helperclasses/hashaccessor'
 require 'helperclasses/arraysym'
 require 'helperclasses/dputs'
+require 'helperclasses/hashaccessor'
+require 'helperclasses/readconfig'
+require 'helperclasses/service'
+require 'helperclasses/system'
+require 'helperclasses/timing'

data/lib/helperclasses/arraysym.rb

@@ -1,11 +1,11 @@
 
 module HelperClasses
   module ArraySym
-    refine Array do
-      # Comptaibility for Ruby < 1.9
-      if ! Array.respond_to? :to_h
+    class Array
+      # Comptaibility for Ruby <= 2.0
+      if ![].respond_to? :to_h
         def to_h
-          Hash[ *self ]
+          Hash[*self.flatten]
         end
       end
 

data/lib/helperclasses/dputs.rb

@@ -5,27 +5,27 @@ module HelperClasses
   module DPuts
     extend self
     attr_accessor :mutex, :silent, :show_time, :terminal_width, :log_file
-    
+
     @mutex = Mutex.new
     @silent = false
     @show_time = 60
     @terminal_width = 160
     @log_file = false
-	
-    def dputs_out( n, s, call )
+
+    def dputs_out(n, s, call)
       return if DPuts.silent
       if precision = DPuts.show_time
         $dputs_time ||= Time.now - 120
         now = Time.now
         show = false
         case precision
-        when /sec/
-          show = now.to_i != $dputs_time.to_i
-        when /min/
-          show = ( now.to_i / 60 ).floor != ( $dputs_time.to_i / 60 ).floor
+          when /sec/
+            show = now.to_i != $dputs_time.to_i
+          when /min/
+            show = (now.to_i / 60).floor != ($dputs_time.to_i / 60).floor
         end
-        show and puts "\n   *** It is now: " + 
-          Time.now.strftime( "%Y-%m-%d %H:%M:%S" )
+        show and puts "\n   *** It is now: " +
+                          Time.now.strftime("%Y-%m-%d %H:%M:%S")
         $dputs_time = now
       end
       DPuts.mutex.synchronize do
@@ -33,54 +33,72 @@ module HelperClasses
         width -= 30.0
         file, func = call.split(" ")
         file = file[/^.*\/([^.]*)/, 1]
-        who = ( ":" + n.to_s + ":" + file.to_s + 
-            func.to_s ).ljust(30, [ "X","x","*","-","."," "][n])
+        who = (":" + n.to_s + ":" + file.to_s +
+            func.to_s).ljust(30, ["X", "x", "*", "-", ".", " "][n])
         lines = []
         pos = 0
-        while ( pos < s.length )
+        while (pos < s.length)
           len = width
           if s.length - pos > width
-            len = s.rindex( /[, .;=&>]/, pos + width )
+            len = s.rindex(/[, .;=&>]/, pos + width)
             len and len = len - pos + 1
             if len < width / 2
               len = width
             end
           end
-          lines.push s.slice( pos, len )
+          lines.push s.slice(pos, len)
           pos += len
         end
         puts who + " " + lines.shift.to_s
-        lines.each{|l|
-          puts " " * ( 32 ) + l
+        lines.each { |l|
+          puts " " * (32) + l
         }
       end
     end
-	
+
+
+    def dputs_getcaller
+      caller(0)[2].sub(/:.*:in/, '').sub(/block .*in /, '')
+    end
+
+    def dputs_func
+      $DPUTS_FUNCS ||= []
+      $DPUTS_FUNCS.push(dputs_getcaller) unless $DPUTS_FUNCS.index(dputs_getcaller)
+    end
+
+    def dputs_unfunc
+      $DPUTS_FUNCS ||= []
+      $DPUTS_FUNCS.index(dputs_getcaller) and $DPUTS_FUNCS.delete(dputs_getcaller)
+    end
+
     def dputs(n, &s)
-      if DEBUG_LVL >= n
+      n *= -1 if ($DPUTS_FUNCS and $DPUTS_FUNCS.index(dputs_getcaller))
+      if  !self.class.const_defined?(:DEBUG_LVL) or
+          self.class.const_get(:DEBUG_LVL) >= n
         s = yield s
-        dputs_out( n, s, caller(0)[1] )
+        dputs_out(n, s, caller(0)[1])
       end
     end
 
-    def ddputs( n, &s )
+    def ddputs(n, &s)
       s = yield s
-      dputs_out( -n, s, caller(0)[1] )
+      #dp caller(0)
+      dputs_out(-n, s, caller(0)[1])
     end
-  
-    def dp( s )
-      dputs_out( 0, s.class == String ? s : s.inspect, caller(0)[1] )
+
+    def dp(s)
+      dputs_out(0, s.class == String ? s : s.inspect, caller(0)[1])
       s
     end
 
-    def log_msg( mod, msg )
-      dputs( 1 ){ "Info from #{mod}: #{msg}" }
+    def log_msg(mod, msg)
+      dputs(1) { "Info from #{mod}: #{msg}" }
       return if not DPuts.log_file
-      File.open( DPuts.log_file, "a" ){ |f|
-        str = Time.now.strftime( "%a %y.%m.%d-%H:%M:%S #{mod}: #{msg}" )
+      File.open(DPuts.log_file, "a") { |f|
+        str = Time.now.strftime("%a %y.%m.%d-%H:%M:%S #{mod}: #{msg}")
         f.puts str
       }
     end
 
   end
-end
+end

data/lib/helperclasses/hashaccessor.rb

@@ -1,41 +1,44 @@
 module HelperClasses
   module HashAccessor
     refine Hash do
-      # Converts all keys of a hash to syms recursively
-      def to_sym
-        ret = {}
-        each{|k,v|
-          ret[ k.to_sym ] = v.class == Hash ? v.to_sym : v
-        }
-        ret
-      end
+    end
+  end
+end
+
+class Hash
+  # Converts all keys of a hash to syms recursively
+  def to_sym
+    ret = {}
+    each { |k, v|
+      ret[k.to_sym] = v.class == Hash ? v.to_sym : v
+    }
+    ret
+  end
+
+  def to_sym!
+    self.replace(to_sym())
+  end
 
-      def to_sym!
-        self.replace( to_sym() )
-      end
-  
-      def method_missing( s, *args )
-        case s.to_s
-        when "to_ary"
-          super( s, args )
-        when /^_.*[^=]$/
-          key = s.to_s.sub(/^_{1,2}/, '').to_sym
-          self.has_key? key and return self[key]
-          self.has_key? key.to_s and return self[key.to_s]
-          if s.to_s =~ /^__/
-            return self[key] = {}
-          else
-            return nil
-          end
-        when /^_.*=$/
-          key = /^_{1,2}(.*)=$/.match(s.to_s)[1].to_sym
-          self.has_key? key and return self[key] = args[0]
-          self.has_key? key.to_s and return self[key.to_s] = args[0]
-          return self[key] = args[0]
+  def method_missing(s, *args)
+    case s.to_s
+      when "to_ary"
+        super(s, args)
+      when /^_.*[^=]$/
+        key = s.to_s.sub(/^_{1,2}/, '').to_sym
+        self.has_key? key and return self[key]
+        self.has_key? key.to_s and return self[key.to_s]
+        if s.to_s =~ /^__/
+          return self[key] = {}
         else
-          super( s, args )
+          return nil
         end
-      end
+      when /^_.*=$/
+        key = /^_{1,2}(.*)=$/.match(s.to_s)[1].to_sym
+        self.has_key? key and return self[key] = args[0]
+        self.has_key? key.to_s and return self[key.to_s] = args[0]
+        return self[key] = args[0]
+      else
+        super(s, args)
     end
   end
 end

data/lib/helperclasses/readconfig.rb

@@ -0,0 +1,50 @@
+module HelperClasses
+  module ReadConfig
+    extend self
+
+    # Searches in this order:
+    # ~/.config
+    # ~
+    # /etc
+    #
+    # Returns nil if nothing found
+    def file_name(file)
+      %w( ~/.config ~ /etc ).each { |d|
+        file_abs = File.expand_path("#{d}/#{file}")
+        File.exists?(file_abs) and return file_abs
+      }
+      nil
+    end
+
+    # Very simple bash-reader, doesn't do array or multi-line configurations
+    def bash(file, downcase = false)
+      return nil unless File.exists? file
+      IO.readlines(file).collect { |l|
+        if l =~ /^#/
+          nil
+        elsif l =~ /([^ ]+)=(.*)/
+          [(downcase ? $1.downcase : $1).to_sym, $2]
+        end
+      }.compact.to_h
+    end
+
+    # Ruby file-reader, returns created hash
+    # THIS IS ABSOLUTELY INSECURE AND WILL EAT YOUR KITTENS!
+    # It returns what the file returns at the end - so most probably you'll want
+    # something like
+    #
+    #   { one: 1,
+    #     two: 2 }
+    #
+    # in that config-file
+    def ruby(file)
+      return {} unless File.exists? file.to_s
+      return eval(IO.readlines(file).join)
+    end
+
+    def json(file)
+      p 'Not implemented yet'
+      exit
+    end
+  end
+end

data/lib/helperclasses/service.rb

@@ -0,0 +1,104 @@
+require 'helperclasses/dputs'
+require 'helperclasses/system'
+
+module HelperClasses
+  module Service
+    attr_accessor :system, :services
+
+    extend self
+    extend HelperClasses::DPuts
+    @system = case System.run_str 'uname -a'
+                when /ARCH/
+                  :ArchLinux
+                when /Ubuntu/
+                  :Ubuntu
+                when /Darwin/
+                  :MacOSX
+                else
+                  nil
+              end
+
+    @services = {
+        samba: {ArchLinux: %w( smbd nmbd ), Ubuntu: %w(smbd nmbd)},
+        cups: {ArchLinux: 'org.cups.cupsd', Ubuntu: 'cupsd'}
+    }
+
+    def service_get(service)
+      begin
+        @services[service.to_sym][@system]
+      rescue NoMethodError => _e
+        service.to_s
+      end
+    end
+
+    def service_run(service, cmd)
+      return unless @system
+      if !cmd
+        log_msg :Services, "System #{@system} can't start services"
+        return false
+      end
+      service_name = service_get(service)
+      if !service_name
+        log_msg :Services, "System #{@system} doesn't have service #{service}"
+        return false
+      end
+      cmd_system = cmd[@system]
+      if !cmd_system
+        log_msg :Services, "System #{@system} doesn't know how to do #{cmd}"
+        return false
+      end
+      [service_name].flatten.each { |s|
+        c = cmd_system.sub(/##/, s)
+        if !System.run_bool(c)
+          log_msg :Services, "Command #{c} failed"
+          return false
+        end
+      }
+    end
+
+    def start(service)
+      service_run(service, {ArchLinux: 'systemctl start ##',
+                            Ubuntu: '/etc/init.d/## start',
+                            MacOSX: nil}
+      )
+    end
+
+    def stop(service)
+      service_run(service, {ArchLinux: 'systemctl stop ##',
+                            Ubuntu: '/etc/init.d/## stop',
+                            MacOSX: nil}
+      )
+    end
+
+    def restart(service)
+      service_run(service, {ArchLinux: 'systemctl restart ##',
+                            Ubuntu: '/etc/init.d/## restart',
+                            MacOSX: nil}
+      )
+    end
+
+    def enable(service)
+      service_run(service, {ArchLinux: 'systemctl enable ##',
+                            Ubuntu: nil,
+                            MacOSX: nil}
+      )
+    end
+
+    def disable(service)
+      service_run(service, {ArchLinux: 'systemctl disable ##',
+                            Ubuntu: nil,
+                            MacOSX: nil}
+      )
+    end
+
+    def enable_start(service)
+      enable(service)
+      start(service)
+    end
+
+    def stop_disable(service)
+      disable(service)
+      stop(service)
+    end
+  end
+end

data/lib/helperclasses/system.rb

@@ -0,0 +1,36 @@
+# System-interaction for different flavours of Unix
+require 'helperclasses/dputs'
+
+module HelperClasses
+  module System
+    extend self
+    extend HelperClasses::DPuts
+    include HelperClasses::DPuts
+
+    def run_str(cmd)
+      dputs(3) { "Running command --#{cmd}--" }
+      %x[ #{cmd} ]
+    end
+
+    def run_bool(cmd)
+      dputs(3) { "Running command --#{cmd}--" }
+      Kernel.system("#{cmd} > /dev/null 2>&1")
+    end
+
+    def exists?(cmd)
+      dputs(3) { "Exist command --#{cmd}--?" }
+      run_bool("which #{cmd} > /dev/null 2>&1")
+    end
+
+    def rescue_all(msg = nil)
+      begin
+        yield
+      rescue Exception => e
+        msg and dputs(0) { msg }
+        dputs(0) { "#{e.inspect}" }
+        dputs(0) { "#{e.to_s}" }
+        e.backtrace.each { |l| dputs(0) { l } }
+      end
+    end
+  end
+end

data/lib/helperclasses/timing.rb

@@ -0,0 +1,21 @@
+module HelperClasses
+  class Timing
+    def initialize(dbg = 0)
+      @dbg_lvl = dbg
+      @time = Time.now
+    end
+
+    def probe(msg = '')
+      t = sprintf('%6f', (Time.now - @time).to_f)
+      dputs(@dbg_lvl) { "#{msg}: #{t}" }
+      @time = Time.now
+    end
+
+    def self.measure(msg = '', dbg = 0)
+      t = Timing.new(dbg)
+      ret = yield
+      t.probe(msg)
+      ret
+    end
+  end
+end

data/test/hc_service.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+
+class TC_Service < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def test_service_get
+    Service.system = :ArchLinux
+
+    assert_equal %w(smbd nmbd), Service.service_get(:samba)
+    assert_equal 'dnsmasq', Service.service_get(:dnsmasq)
+  end
+end

data/test/test.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.push '../lib', '.'
+
+require 'test/unit'
+require 'helperclasses'
+include HelperClasses
+
+tests = Dir.glob( 'hc_*.rb' )
+#tests = %w(  )
+
+tests.each{|t|
+  begin
+    require "hc_#{t}"
+  rescue LoadError => e
+    require t
+  end
+}

data/test/test_readconfig.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.push('../lib')
+require 'helperclasses/readconfig'
+
+include HelperClasses
+
+testfile = 'test_config'
+IO.write(testfile, "#!/bin/bash
+# This is an example config
+TEST=hi
+DB=foo.db
+# This shouldn't pass
+TEST2 = hi
+# And some unrelated stuff
+if '$1'; then
+fi
+")
+
+test = ReadConfig.bash( testfile )
+p test
+
+def printit
+  p test
+end
+
+printit

data/test/test_system.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.push '../lib'
+
+require 'helperclasses/system'
+include HelperClasses::System
+
+rescue_all do
+  puts 'Hello there'
+end
+puts
+
+rescue_all do
+  puts "Some math: #{10/0}"
+end
+puts
+
+rescue_all('math-error') do
+  puts "Some math: #{10/0}"
+end

metadata

@@ -1,32 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: HelperClasses
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Linus Gasser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies: []
-description: Array.to_sym, Hash-accessors and debug-outputs with lazy evaluation
+description: Added accessors to Hash, to_sym to Array and a nice debugging-interface
+  called DPuts
 email: ineiti@linusetviviane.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- "./LICENSE"
-- "./README"
-- "./lib/helperclasses.rb"
-- "./lib/helperclasses/arraysym.rb"
-- "./lib/helperclasses/dputs.rb"
-- "./lib/helperclasses/hashaccessor.rb"
-- "./test/test_arraysym.rb"
-- "./test/test_dputs.rb"
-- "./test/test_hashaccessor.rb"
+- ".gitignore"
 - LICENSE
-- README
+- README.md
+- helperclasses.gemspec
+- lib/helperclasses.rb
+- lib/helperclasses/arraysym.rb
+- lib/helperclasses/dputs.rb
+- lib/helperclasses/hashaccessor.rb
+- lib/helperclasses/readconfig.rb
+- lib/helperclasses/service.rb
+- lib/helperclasses/system.rb
+- lib/helperclasses/timing.rb
+- test/hc_service.rb
+- test/test.rb
+- test/test_arraysym.rb
+- test/test_dputs.rb
+- test/test_hashaccessor.rb
+- test/test_readconfig.rb
+- test/test_system.rb
 homepage: https://github.com/ineiti/HelperClasses
 licenses:
 - GPLv3
@@ -47,8 +56,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Helpers for Array, Hash and debug-output
-test_files: []
+summary: Hash._accessor Array.to_sym and DPuts
+test_files:
+- test/hc_service.rb
+- test/test.rb
+- test/test_arraysym.rb
+- test/test_dputs.rb
+- test/test_hashaccessor.rb
+- test/test_readconfig.rb
+- test/test_system.rb