cli_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b84d0722c4c14f6a4b133bbd6885c5c467eb3db
+  data.tar.gz: 9a145e375a05149a81b18fbc2f01bd6714445ed2
+SHA512:
+  metadata.gz: d2f2400a85cd6c3d3c4a256d3796818f24f096338c989c82f1b6240991c17d929d2314a0dc6cf5fdfe500c56bd9395665e3697fde0199038606840a3a7538ceb
+  data.tar.gz: 7b7eb8385520e57f692cf9cc55f1f656d0b23b924990d25effb32b882847745e12d024ca567f77ea43c0b86aff2f096899f953a4fc31551f23840c2cbfe066d5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 20
+Style/SignalException:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+install:
+  - gem install bundler --version '1.8.5'
+  - bundle install
+rvm:
+  - 2.1.5
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cli_logger.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tomasz Maczukin <tomasz@maczukin.pl>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,34 @@
+# CliLogger
+
+![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)
+[![Build Status](https://travis-ci.org/tmaczukin/cli_logger.svg)](https://travis-ci.org/tmaczukin/cli_logger)
+
+Another loggerm gem for ruby based CLI applications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cli_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cli_logger
+
+## Contributing
+
+1. Fork it ( https://github.com/tmaczukin/cli_logger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+This is free sofware licensed under MIT license. See LICENSE file.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+RuboCop::RakeTask.new
+
+task :test do
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec'].invoke
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cli_logger'
+require 'pry'
+Pry.start

data/bin/example

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cli_logger'
+
+CliLogger.current_level = :debug
+# CliLogger.set_options(:disable_spinner, :disable_progress_bar)
+
+CliLogger.error('Error') do
+  CliLogger.warning('Warning') do |pb|
+    CliLogger.info('Info') do
+      3.times do
+        CliLogger.debug('test')
+        sleep 0.4
+      end
+      sleep 0.4
+    end
+
+    (1..10).each do |tick|
+      sleep 0.4
+      CliLogger.debug("Step #{tick}")
+      pb.progress(tick.to_f / 10) if pb
+    end
+  end
+end

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/cli_logger.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cli_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cli_logger'
+  spec.version       = CliLogger::VERSION
+  spec.authors       = ['Tomasz Maczukin']
+  spec.email         = ['tomasz@maczukin.pl']
+  spec.license       = 'MIT'
+  spec.summary       = 'Another loggerm gem for ruby based CLI applications'
+  spec.homepage      = 'https://github.com/tmaczukin/cli_logger'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^spec/) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',   '~> 1.8'
+  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'rubocop',   '~> 0.31.0'
+  spec.add_development_dependency 'rspec',     '~> 3.2.0'
+  spec.add_development_dependency 'pry',       '~> 0.10.1'
+  spec.add_development_dependency 'simplecov', '~> 0.10.0'
+
+  spec.add_dependency 'colorize', '~> 0.7.5'
+end

data/lib/cli_logger.rb

@@ -0,0 +1,14 @@
+require 'colorize'
+
+require 'cli_logger/exceptions'
+require 'cli_logger/version'
+
+# CliLogger module
+#
+module CliLogger
+  autoload :Logger,      'cli_logger/logger'
+  autoload :Spinner,     'cli_logger/spinner'
+  autoload :ProgressBar, 'cli_logger/progress_bar'
+
+  extend Logger
+end

data/lib/cli_logger/exceptions.rb

@@ -0,0 +1,5 @@
+module CliLogger
+  class CliLoggerError < RuntimeError; end
+
+  class UnknownLogLevelError < CliLoggerError; end
+end

data/lib/cli_logger/logger.rb

@@ -0,0 +1,130 @@
+module CliLogger
+  # Logger module
+  #
+  module Logger
+    # rubocop:disable Style/AccessorMethodName
+    def set_options(*args)
+      @options = args
+    end
+    # rubocop:enable Style/AccessorMethodName
+
+    def method_missing(name, *args, &block)
+      log(name.to_sym, *args, &block) if levels.key?(name.to_sym)
+    end
+
+    def log(log_level, message)
+      validate_level(log_level)
+      return unless levels[log_level] <= current_level
+
+      message = log_message(log_level, message)
+      if block_given?
+        sublog do
+          yield progress_bar
+        end
+        message += log_message(log_level, 'DONE')
+      end
+
+      message
+    end
+
+    def current_level
+      @current_level ||= levels[:info]
+    end
+
+    def current_level=(value)
+      validate_level(value)
+      @current_level = levels[value]
+    end
+
+    def levels
+      {
+        error: 0,
+        warning: 1,
+        info: 2,
+        debug: 3
+      }
+    end
+
+    private
+
+    def validate_level(log_level)
+      raise UnknownLogLevelError, log_level unless levels.key?(log_level)
+    end
+
+    def log_message(log_level, message)
+      progress_bar.clear_line if progress_bar
+
+      message = colorize(log_level, "#{prefix(log_level)}#{message}")
+      puts message
+
+      message
+    end
+
+    def prefix(log_level)
+      "#{nesting_prefix}[#{prefixes[log_level]}] "
+    end
+
+    def prefixes
+      {
+        error:   '!',
+        warning: '-',
+        info:    '*',
+        debug:   '?'
+      }
+    end
+
+    def nesting_prefix
+      level = @nesting_level || 0
+      ' ' * level * 2
+    end
+
+    def colorize(log_level, message)
+      return message unless colors[log_level]
+      message.colorize(colors[log_level])
+    end
+
+    def colors
+      {
+        error: { color: :white, background: :red, mode: :bold },
+        warning: { color: :yellow, mode: :bold },
+        info: {},
+        debug: { color: :light_cyan }
+      }
+    end
+
+    def sublog
+      add_nesting
+      spinner.start if spinner
+
+      yield
+
+      spinner.stop if spinner
+      progress_bar.hide if progress_bar
+      sub_nesting
+    end
+
+    def add_nesting
+      @nesting_level ||= 0
+      @nesting_level += 1
+      @nesting_level
+    end
+
+    def sub_nesting
+      @nesting_level -= 1
+      @nesting_level = 0 if @nesting_level < 0
+      @nesting_level
+    end
+
+    def progress_bar
+      @progress_bar ||= ProgressBar.new(spinner) unless options.include?(:disable_progress_bar)
+    end
+
+    def spinner
+      @spinner ||= Spinner.new unless options.include?(:disable_spinner)
+    end
+
+    def options
+      @options ||= []
+    end
+  end
+end

data/lib/cli_logger/progress_bar.rb

@@ -0,0 +1,53 @@
+module CliLogger
+  # ProgressBar class
+  #
+  class ProgressBar
+    def initialize(spinner)
+      @spinner = spinner
+      @visible = false
+      @width = 40
+    end
+
+    def progress(percent)
+      @spinner.stop if @spinner
+      @visible = true
+      $stdout.sync = true
+
+      raise InvalidProgressValueError, percent if percent < 0 || percent > 1
+
+      @percent = percent
+
+      print prepare_bar
+    end
+
+    def hide
+      $stdout.sync = true
+      @visible = false
+
+      clear_line
+      sleep 0.1
+    end
+
+    def clear_line
+      width = @width + 10
+
+      print "\r"
+      print ' ' * width
+      print "\r"
+    end
+
+    private
+
+    def prepare_bar
+      clear_line
+
+      progress = (@percent * @width).floor
+      progress_trace = '=' * progress
+      progress_bg = '-' * (@width - progress)
+
+      percent = @percent * 100
+
+      "[#{progress_trace}#{progress_bg}] ".green + ('%5.2f%%'.green.bold % percent)
+    end
+  end
+end

data/lib/cli_logger/spinner.rb

@@ -0,0 +1,45 @@
+module CliLogger
+  # Spinner class
+  #
+  class Spinner
+    def initialize
+      @chars = %w( + - - - )
+      @step = 0.095
+    end
+
+    def start
+      stop
+      sleep @step
+
+      @thread = Thread.new { spin }
+    end
+
+    def stop
+      return unless @thread
+      return if @thread[:done]
+
+      @thread[:done] = true
+      sleep @step / (@chars.count - 1)
+      clear_line
+    end
+
+    def spin
+      $stdout.sync = true
+      Thread.current[:done] = false
+      until Thread.current[:done]
+        clear_line
+        print @chars.join.green
+        @chars.unshift @chars.pop
+        sleep @step
+      end
+    end
+
+    def clear_line
+      width = @chars.count
+
+      print "\r"
+      print ' ' * width
+      print "\r"
+    end
+  end
+end

data/lib/cli_logger/version.rb

@@ -0,0 +1,5 @@
+# CliLogger module
+#
+module CliLogger
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: cli_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomasz Maczukin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.31.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+description: 
+email:
+- tomasz@maczukin.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/example
+- bin/setup
+- cli_logger.gemspec
+- lib/cli_logger.rb
+- lib/cli_logger/exceptions.rb
+- lib/cli_logger/logger.rb
+- lib/cli_logger/progress_bar.rb
+- lib/cli_logger/spinner.rb
+- lib/cli_logger/version.rb
+homepage: https://github.com/tmaczukin/cli_logger
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Another loggerm gem for ruby based CLI applications
+test_files: []