fiedl-log 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c4e782e673e205f0b33c45c64b4770f8f36c28ca
-  data.tar.gz: fe5b2363a8969ae792ec64b76d00e8e96165dec6
+SHA256:
+  metadata.gz: 50633d096202849e748b14cc35cf0badcf887040d719239480c5117dda15d454
+  data.tar.gz: 83cd6b2bc6aea3834a3ef40a52bd1c19a8f573da7027a64fb8c325aa8ec2e352
 SHA512:
-  metadata.gz: f1f0777da381db3ad3620c3dab2c010a4e32642483cbd0d3262f7deacb5037bd4d0971fd437c99d8edaecb18674fbe46581991a0040b1aa8f6d516ab83c20840
-  data.tar.gz: 650e7588e9dbe262dfee9b75518f5aa83920d3e329816448eee3832afc941aa6bf2d0e59e8fc87552560d7f376867217c4df59c3814a6a78f98a08b1e1664d89
+  metadata.gz: 298c22019b349406edb0569f75c416e1209c78cd7715fdb635e093d9de61f3e36b48db493ac55427a816150756c51cd7159ad4cf65f63aabd0567bc65556bd2a
+  data.tar.gz: e36ea52a0268251cebffc7c8b348941e37391f4a884755bb91716e18718ce9bfb0e7bd1d6a39da142e12f91c4463bfc9ecff658cf54edb9114aa4314008c10e6

data/README.md

@@ -2,23 +2,6 @@
 
 Simple colored output helper for ruby scripts.
 
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'fiedl-log'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install fiedl-log
-
 ## Usage
 
 ```ruby
@@ -38,6 +21,8 @@ log.error "This script does nothing, yet."
 raise "This script does nothing, yet, sorry!"
 ```
 
+![screenshot](https://github.com/fiedl/fiedl-log/raw/master/screenshots/Bildschirmfoto%202016-11-24%20um%2018.14.49.png)
+
 ### Manually defining a log instance
 
 This gem defines `log` unless `log` is already defined. But, of course, you may manually instantiate it:
@@ -60,6 +45,68 @@ log.filter_out("my_secret_password")
 
 This will filter out any occurance of "my_secret_password" and replace it by "[...]" in the output.
 
+### Shell commands
+
+Print a shell command, execute it and display the result:
+
+```ruby
+# ~/some_ruby_script.rb
+require 'fiedl/log'
+
+shell "whoami"
+```
+
+![screenshot](https://github.com/fiedl/fiedl-log/raw/master/screenshots/Bildschirmfoto%202016-11-24%20um%2018.15.47.png)
+
+The `shell` command returns both the output of the stdin and the stderr.
+
+To prevent the `shell` command from printing anything, use `verbose: false`:
+
+```ruby
+user = shell "whoami", verbose: false
+```
+
+### 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:
+
+```ruby
+gem 'fiedl-log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fiedl-log
 
 ## Development
 
@@ -69,7 +116,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fiedl-log.
+Bug reports and pull requests are welcome on GitHub at https://github.com/fiedl/fiedl-log.
 
 
 ## License

data/fiedl-log.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "fiedl-log"
   spec.version       = Fiedl::Log::VERSION
   spec.authors       = ["Sebastian Fiedlschuster"]
-  spec.email         = ["sebastian@fiedlschuster.de"]
+  spec.email         = ["rubygems@fiedlschuster.de"]
 
   spec.summary       = %q{Simple colored output helper for ruby scripts.}
   spec.description   = spec.summary
@@ -17,10 +17,10 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.require_paths = ["lib"]
+  spec.require_paths = ["lib", "lib/fiedl/log"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 2.2.10"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_dependency "colored"

data/lib/fiedl/log/log.rb

@@ -1,4 +1,5 @@
 class Fiedl::Log::Log
+
   def head(text)
     info ""
     info "==========================================================".blue
@@ -25,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 ||= []
@@ -40,4 +50,42 @@ class Fiedl::Log::Log
     filter_out expression
   end
 
+  def raise(text)
+    self.error(text.bold)
+    super(text)
+  end
+
+  # Print commant, execute it and display result.
+  # See also: http://stackoverflow.com/a/10224650/2066546
+  #
+  def shell(command, verbose: true)
+    prompt command if verbose
+
+    output = ""
+    r, io = IO.pipe
+    pid = fork do
+      system(command, out: io, err: io)
+    end
+    io.close
+    r.each_char{|c| (print c if verbose); output += c}
+
+    Process.waitpid pid
+    return output.strip
+  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.1.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/fiedl/log.rb

@@ -1,6 +1,7 @@
 require "fiedl/log/version"
 require "fiedl/log/log"
 require "colored"
+require "pp"
 
 STDOUT.sync = true
 
@@ -9,4 +10,14 @@ module Fiedl
   end
 end
 
-log = Fiedl::Log::Log.new unless defined? log
+unless defined? log
+  def log
+    @log ||= Fiedl::Log::Log.new
+  end
+end
+
+unless defined? shell
+  def shell(command, verbose: true)
+    log.shell command, verbose: verbose
+  end
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: fiedl-log
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Sebastian Fiedlschuster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2021-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -68,7 +68,7 @@ dependencies:
         version: '0'
 description: Simple colored output helper for ruby scripts.
 email:
-- sebastian@fiedlschuster.de
+- rubygems@fiedlschuster.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -86,6 +86,8 @@ files:
 - lib/fiedl/log.rb
 - lib/fiedl/log/log.rb
 - lib/fiedl/log/version.rb
+- screenshots/Bildschirmfoto 2016-11-24 um 18.14.49.png
+- screenshots/Bildschirmfoto 2016-11-24 um 18.15.47.png
 homepage: https://github.com/fiedl/fiedl-log
 licenses:
 - MIT
@@ -94,6 +96,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- lib/fiedl/log
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -105,8 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Simple colored output helper for ruby scripts.