fiedl-log 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c5a56e0c4fc76b55797ff6d1cafaa5d013689ef
-  data.tar.gz: e66f0a11e239932fbc3200df64f6685f6532fb01
+  metadata.gz: 9c288e07d37916e6352cb8d15b65e7ebf1134930
+  data.tar.gz: 8d0f3703fa32c7a8d2301905e959f3e97356f99f
 SHA512:
-  metadata.gz: 38fcd880973d29deabcc6c16722287ba2d34cbee74636ad7cc696d818b0e76314b701a1296d8fcae6d0674854005023c0e49c86ea321e9ce65dd592be250fd7a
-  data.tar.gz: 362f6ac6c8308408d95b262d4d5a18bba480c1b295ad090cd20c916ab5bcdb539c24bbb4d461134547bf74df33f0237c9158afaf79b277736d8963cb79618813
+  metadata.gz: 84a6d781078865f827b6f0e9ad145c64fea6d5bc74b590c20ee8eacadb68d1efb12f14645a71eea2fefe3db9130fd438e46751fc54ad454dbce651310d6ad183
+  data.tar.gz: ff1a02a8a2fcdfe710bae3e0f550364567ca31d9d057d127c10502a4ca11be3507b553890958674b54c6dcee878e8901d283ab325b7c5354d3853279b7d524e2

data/README.md

@@ -58,6 +58,32 @@ shell "whoami"
 
 ![screenshot](screenshots/Bildschirmfoto 2016-11-24 um 18.15.47.png)
 
+### Logging variables
+
+```ruby
+# ~/some_ruby_script.rb
+require 'fiedl/log'
+
+foo = "bar"
+log.variable foo, "foo"
+
+options = {
+  foo: 'bar'
+}
+log.configuration options
+```
+
+### Other helpers
+
+Ensure that a certain file is present before continuing: If the file is missing, the error is logged and the script is stopped.
+
+```ruby
+# ~/some_ruby_script.rb
+require 'fiedl/log'
+
+log.ensure_file "$HOME/.zshrc"
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/fiedl/log.rb

@@ -1,6 +1,7 @@
 require "fiedl/log/version"
 require "fiedl/log/log"
 require "colored"
+require "pp"
 
 STDOUT.sync = true
 

data/lib/fiedl/log/log.rb

@@ -26,12 +26,21 @@ class Fiedl::Log::Log
   def prompt(text)
     self.write "$ " + text.bold
   end
+  def variable(variable, variable_name)
+    self.write "#{variable_name.to_s.blue} = #{variable}"
+  end
+  def configuration(hash)
+    pp hash
+  end
   def write(text)
+    self.p "#{text}\n"
+  end
+  def p(text)
     @filter_out ||= []
     @filter_out.each do |expression|
       text = text.gsub(expression, "[...]")
     end
-    print text + "\n"
+    print text
   end
   def filter_out(expression)
     @filter_out ||= []
@@ -58,4 +67,19 @@ class Fiedl::Log::Log
     return output
   end
 
+  # Ensure that a certain file is present.
+  #
+  def ensure_file(filename, options = {})
+    if File.exists?(filename)
+      log.success "File: #{filename}"
+    else
+      log.error "Something went wrong. File #{filename} is missing."
+      if options[:show_log]
+        log.section "Last log"
+        shell "tail -n 20 #{options[:show_log]}"
+      end
+      raise "File is missing."
+    end
+  end
+
 end

data/lib/fiedl/log/version.rb

@@ -1,5 +1,5 @@
 module Fiedl
   module Log
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fiedl-log
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sebastian Fiedlschuster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2016-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler