logzomg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c62b72556a339925393753589f92925d63347584
+  data.tar.gz: 11dedeeb8b5f4bc2d36c821aeff053228ab66497
+SHA512:
+  metadata.gz: 8d029c7328cc8ea4373fc1b1bc2c143cd6018a87f4ed10a4e53a963ceb0eccbd0c6d11c02348636f0e1c857fce4b32305b0bbfd842cbdd7480cde596de0de158
+  data.tar.gz: 43d4917e4f3df95db18d322e672aed5c095d76489bf485e8e0a6b79be654ed3c68253eda029beedba49dc4c18f27d7d8a429de64e98f2113fd694f124830879e

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rasmus
+
+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,77 @@
+# Logzomg
+
+**Logzomg is still in development. Do not expect crazy functionality yet :)**
+
+An easy to use and lightweight logging gem for Ruby.
+
+![Terminal output](http://i.imgur.com/reu3xof.png)
+
+Logzomg currently supports varying levels of severity.
+
+`
+Debug
+`
+`
+Info
+`
+`
+Warn
+`
+`
+Error
+`
+`
+Fatal
+`
+
+## Usage
+
+You can instantiate the logger and use it like so:
+
+```ruby
+def log
+  l = Logzomg::Logger.new
+  l.log({
+          "msg": "Frank took the last coffee and forgot to make some new. Fire him?", 
+          "level": "info",                    # Optional. Sets log level. Default is warning
+          "file": "frank.txt"                 # Optional. Sets name of file to log to. Default is log.txt
+        })
+end  
+```
+
+By default Logzomg color codes the logging levels when viewed in a terminal. If you want to turn this off you can instead pass a TextFormatter when instantiating the logger.
+
+The TextFormatter takes a hash of options.
+
+`
+  Logzomg::Logger.new(TextFormatter.new({with_colors: false}))
+`
+
+Currently Logzomg only supports logging as plaintext. Soon it will support logging as JSON as well.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logzomg'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logzomg
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Evilbits/logzomg
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+
+# For development
+
+task :console do
+  exec "irb -r logzomg -I ./lib"
+end
+
+task :c => :console

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logzomg"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/formatters/text_formatter.rb

@@ -0,0 +1,81 @@
+require 'date'
+
+# Default TextFormatter for logzomg.rb
+# Allows color output to logfile
+
+class TextFormatter
+
+  def initialize(init_hash = Hash.new)
+    @color =  init_hash.has_key?(:with_color) ? init_hash[:with_color] : true
+    puts "Init color: " + @color.to_s
+  end
+
+  # Split the message into 145 char chunks. 
+  # Prepend level. Append DateTime
+  def format_msg(msg, level)
+    @level = level
+    str = ""
+    s_msg = split_msg(msg)                                # Split message incase it's 150+ chars
+    count = 0                                             # Use to indent on 2nd+ iteration
+    
+    s_msg.each do |n|
+      str += add_msg_identifier(str)
+      text = count >= 1 ? "  " + n : n                    # Indent if 2nd+ iteration
+      str += text
+      indented = count >= 1                               # Set indented to determine space amount
+      str += right_align_date(n, indented)
+      str += " | " + DateTime.now.to_s + "\n"
+      count += 1
+    end
+    
+    str
+  end
+
+
+  private
+    # Adds spaces to right align date depending on str length and row number
+    def right_align_date(msg, indented)
+      indented ? s = 60 : s = 58
+      " " * (s - msg.length)  
+    end
+
+    # Adds log level to start of log
+    # Add color if color is true
+    def add_msg_identifier(str)
+      if @level == 'debug'
+        str += "DBUG"
+      elsif @level == 'info' 
+        str += "INFO"
+      elsif @level == 'warning'
+        str += "WARN"
+      elsif @level == 'error'
+        str += "ERRO"
+      elsif @level == 'fatal'
+        str += "FATA"
+      end 
+      str = add_color(str) if @color
+      str += + " | "
+    end 
+
+    # Adds color if color is true
+    def add_color(str)
+      colors = {debug: "\e[34m", info: "\e[96m", warning: "\e[33m", error: "\e[91m", fatal: "\e[31m"}
+      close_color = "\e[0m"
+      str.prepend(colors[@level.to_sym])
+      str += close_color
+    end
+
+    # Splits the message every 150 chars to make everything look prettier
+    def split_msg(msg)
+      arr = []
+      start = 0
+      ending = 145
+      c = msg.length > 150 ? ((msg.length).to_f/150.00).ceil : 1
+      (1..c).each do |n|
+        arr << msg[start,ending]
+        start += 146
+        ending += 145
+      end
+      arr  
+    end 
+end

data/lib/logzomg/version.rb

@@ -0,0 +1,3 @@
+module Logzomg
+  VERSION = "0.1.0"
+end

data/lib/logzomg.rb

@@ -0,0 +1,84 @@
+require_relative 'formatters/text_formatter'
+require "logzomg/version"
+
+module Logzomg
+  class Logger
+    # TODO change this to proper file path
+    LOG_PATH = File.expand_path('../../logs/', __FILE__)
+    LEVELS = ['debug','info','warning','error','fatal']
+
+    UnsupportedType = Class.new(StandardError)
+    UnsupportedLevel = Class.new(StandardError)
+
+    def initialize(formatter=TextFormatter.new)
+      @level = 'warning'
+      @formatter = formatter
+    end 
+
+    # First set level -> 
+    # Format message -> 
+    # Write message to file
+    def log(hash)
+      raise UnsupportedType, "Must be of type Hash" unless valid_hash?(hash)
+      level(hash[:level]) if hash.has_key?(:level)        # Use default if not included
+      msg = @formatter.format_msg(hash[:msg], @level)
+      write(hash, msg)
+    end 
+
+    # Sets the log level
+    def level(level)
+      raise UnsupportedLevel, "Level " + level + " is not a valid level" unless valid_level?(level)
+      @level = level
+      self
+    end
+
+    # REMOVE AFTER DONE CODING
+    def test
+      l = Logzomg::Logger.new
+      l.log({
+              "msg": "Something is on the horizon!", 
+              "level": "debug"
+            })
+      #l.log({
+      #        "msg": "This is a really really really really really really really really really " +
+      #                "really really really really really really really really really really really " +
+      #                "really really really really really really debug message", 
+      #        "level": "debug"
+      #      })
+      l.log({
+              "msg": "Three wild acro-yoga enthusiasts have been spotted!", 
+              "level": "info"
+            })
+      l.log({
+              "msg": "They are coming closer!", 
+              "level": "warning"
+            })
+      l.log({
+              "msg": "I don\'t know how to handle them!!", 
+              "level": "error"
+            })
+      l.log({
+              "msg": "You have died", 
+              "level": "fatal"
+            })
+    end  
+  
+    private
+      # Writes the log message to the logfile 
+      # If given one in hash[:file] use that
+      def write(hash, msg)
+        file = hash.has_key?(:file) ? "/" + hash[:file] : '/log.txt'
+        File.open(LOG_PATH + file, 'a') {|f| f.write(msg) }
+      end  
+
+      # Checks if message is hash
+      def valid_hash?(hash)
+        return hash.class == Hash
+      end 
+
+      # Checks if the level value is valid (part of LEVELS)
+      def valid_level?(level)
+        return !level.nil? && LEVELS.any? { |l| l == level.downcase }
+      end 
+  end
+end

data/logzomg.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logzomg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logzomg"
+  spec.version       = Logzomg::VERSION
+  spec.authors       = ["Rasmus"]
+  spec.email         = ["Rasmusbreiler@gmail.com"]
+
+  spec.summary       = %q{Logging gem with Asana API integration}
+  spec.homepage      = "https://github.com/Evilbits/logzomg"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: logzomg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rasmus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-01 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- Rasmusbreiler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/formatters/text_formatter.rb
+- lib/logzomg.rb
+- lib/logzomg/version.rb
+- logzomg.gemspec
+homepage: https://github.com/Evilbits/logzomg
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Logging gem with Asana API integration
+test_files: []