fiva 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 457621ec4d3b3fa14f01dabce896377e76fde859e171ce471d64b65ca2ed4b53
+  data.tar.gz: c692ac9532b0d5e28158c6be38618a8166319d6af39676e93034857065165b59
+SHA512:
+  metadata.gz: 9857ec3b63ba1de23b9ec6cd6709e875f83da139d2c90aaa98271a6956345c370ac485c5d9ff30a17d769d944ae535ea8524fe3b0ae8bd323ec05555f762d13d
+  data.tar.gz: 630eaa295e23b016cd9f10fc4c43e9e6a0c06ab0d4546633b07cb6407c2e77d9134be622a0ca5d2609d08d3651f70c4136b52554f233a343cd470d7c4dd2c2d6

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fiva.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    fiva (0.1.0)
+      pastel (~> 0.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    equatable (0.5.0)
+    pastel (0.7.2)
+      equatable (~> 0.5.0)
+      tty-color (~> 0.4.0)
+    rake (10.5.0)
+    tty-color (0.4.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  fiva!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nickolay Ilyushin
+
+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,50 @@
+# Fiva
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fiva'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fiva
+
+## Usage
+
+```ruby
+require 'fiva'
+require 'json'
+
+Fiva::Logger.new
+  .add_handler(Fiva::puts_handler(level: Fiva::DEBUG))
+  .add_handler(Fiva::putsr_handler(level: Fiva::DEBUG, func: ->(msg) { msg.to_json }))
+  .write(Fiva::DEBUG, 'Hello!', foo: 'bar')
+  .debug('Debug', tv: Fiva::TextValue.new('Foo'))
+  .io('A message', text: 'Hello, World!', payload: "foo\n  asdf")
+  .info('Info')
+  .important('Important')
+  .warning('Warning')
+  .error('Error')
+  .fatal('Fatal')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/handicraftsman/fiva.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fiva"
+
+# 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(__FILE__)

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/fiva.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fiva/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fiva'
+  spec.version       = Fiva::VERSION
+  spec.authors       = ['Nickolay (handicraftsman) Ilyushin']
+  spec.email         = ['nickolay02@inbox.ru']
+
+  spec.summary       = 'A structured logging implementation for Ruby'
+  spec.description   = 'A structured logging implementation for Ruby'
+  spec.homepage      = 'https://github.com/handicraftsman/fiva'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'pastel', '~> 0.7'
+end

data/lib/fiva.rb

@@ -0,0 +1,25 @@
+require 'date'
+
+require 'pastel'
+
+require 'fiva/version'
+
+module Fiva
+  class Error < StandardError; end
+
+  FATAL = 6
+  ERROR = 5
+  WARNING = 4
+  IMPORTANT = 3
+  INFO = 2
+  IO = 1
+  DEBUG = 0
+
+  LEVELS = ['DBG', ' IO', 'INF', 'IMP', 'WRN', 'ERR', 'FTL']
+  FULL_LEVELS = ['DEBUG', 'IO', 'INFO', 'IMPORTANT', 'WARNING', 'ERROR', 'FATAL']
+end
+
+require 'fiva/text_value'
+require 'fiva/message'
+require 'fiva/handlers'
+require 'fiva/logger'

data/lib/fiva/handlers.rb

@@ -0,0 +1,65 @@
+module Fiva
+  PLE = ['data', 'text', 'body', 'info', 'payload']
+
+  def self.puts_handler(**opts)
+    level   = opts.fetch :level,   Fiva::INFO
+    padding = opts.fetch :padding, 32
+    ple     = opts.fetch :ple,     Fiva::PLE
+    target  = opts.fetch :target,  STDERR
+    colored = opts.fetch :colored, true
+
+    pastel = Pastel.new
+    
+    lc = [
+      pastel.green.detach,
+      pastel.cyan.detach,
+      pastel.blue.detach,
+      pastel.white.detach,
+      pastel.yellow.detach,
+      pastel.red.detach,
+      pastel.magenta.detach
+    ]
+
+    gl = ->(l) {
+      return (Fiva::LEVELS[l] || "UNK") unless colored
+      (lc[l] || pastel.clear.detach).(Fiva::LEVELS[l] || "UNK")
+    }
+
+    cl = ->(l, t) {
+      return t unless colored
+      (lc[l] || pastel.clear.detach).(t)
+    }
+
+    return ->(logger, msg) {
+      return if msg.level < level
+      
+      data = msg.data
+        .filter { |k, v| not Fiva::PLE.include? k.to_s }
+        .map { |k, v| "#{cl.(msg.level, k)}: #{v.inspect}" }
+        .join(' ')
+
+      str = "#{msg.timestamp.strftime} " +
+        "#{gl.(msg.level)} " +
+        "#{"%-#{padding}s" % msg.msg.to_s} " +
+        "#{data}"
+      
+      msg.data
+        .filter { |k, v| Fiva::PLE.include? k.to_s }
+        .each_pair { |k, v| str << "\n#{cl.(msg.level, k)}:\n  #{v.to_s.gsub(/\n/, "\n  ")}" }
+
+      target.puts(str)
+    }
+  end
+
+  def self.putsr_handler(**opts)
+    level  = opts.fetch :level,  Fiva::INFO
+    target = opts.fetch :target, STDERR
+    func   = opts.fetch :func,   ->(msg) { msg.msg.to_s }
+
+    return ->(logger, msg) {
+      return if msg.level < level
+
+      target.puts func.(msg)
+    }
+  end
+end

data/lib/fiva/logger.rb

@@ -0,0 +1,59 @@
+module Fiva
+  class Logger
+    def initialize
+      @handlers = []
+    end
+
+    def add_handler(h)
+      @handlers << h
+      self
+    end
+
+    def write_m(msg)
+      @handlers.each do |h|
+        h.(self, msg)
+      end
+      self
+    end
+
+    def write(level, msg, **data)
+      self.write_m(Message.new(level, msg, **data))
+      self
+    end
+
+    def debug(msg, **data)
+      self.write(Fiva::DEBUG, msg, **data)
+      self
+    end
+
+    def io(msg, **data)
+      self.write(Fiva::IO, msg, **data)
+      self
+    end
+
+    def info(msg, **data)
+      self.write(Fiva::INFO, msg, **data)
+      self
+    end
+
+    def important(msg, **data)
+      self.write(Fiva::IMPORTANT, msg, **data)
+      self
+    end
+
+    def warning(msg, **data)
+      self.write(Fiva::WARNING, msg, **data)
+      self
+    end
+
+    def error(msg, **data)
+      self.write(Fiva::ERROR, msg, **data)
+      self
+    end
+
+    def fatal(msg, **data)
+      self.write(Fiva::FATAL, msg, **data)
+      self
+    end
+  end
+end

data/lib/fiva/message.rb

@@ -0,0 +1,25 @@
+module Fiva
+  class Message
+    attr_accessor :timestamp, :level, :msg, :data
+
+    def initialize(level, msg, **data)
+      @timestamp = DateTime.now
+      @level = level
+      @msg   = msg
+      @data  = data
+    end
+
+    def to_hash
+      {
+        timestamp: @timestamp,
+        level:     @level,
+        msg:       @msg,
+        data:      @data
+      }
+    end
+
+    def to_json
+      self.to_hash.to_json
+    end
+  end
+end

data/lib/fiva/text_value.rb

@@ -0,0 +1,7 @@
+module Fiva
+  class TextValue < String
+    def inspect
+      self.to_s
+    end
+  end
+end

data/lib/fiva/version.rb

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

data/test.rb

@@ -0,0 +1,14 @@
+require 'fiva'
+require 'json'
+
+Fiva::Logger.new
+  .add_handler(Fiva::puts_handler(level: Fiva::DEBUG))
+  .add_handler(Fiva::putsr_handler(level: Fiva::DEBUG, func: ->(msg) { msg.to_json }))
+  .write(Fiva::DEBUG, 'Hello!', foo: 'bar')
+  .debug('Debug', tv: Fiva::TextValue.new('Foo'))
+  .io('A message', text: 'Hello, World!', payload: "foo\n  asdf")
+  .info('Info')
+  .important('Important')
+  .warning('Warning')
+  .error('Error')
+  .fatal('Fatal')

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: fiva
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nickolay (handicraftsman) Ilyushin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: A structured logging implementation for Ruby
+email:
+- nickolay02@inbox.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fiva.gemspec
+- lib/fiva.rb
+- lib/fiva/handlers.rb
+- lib/fiva/logger.rb
+- lib/fiva/message.rb
+- lib/fiva/text_value.rb
+- lib/fiva/version.rb
+- test.rb
+homepage: https://github.com/handicraftsman/fiva
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A structured logging implementation for Ruby
+test_files: []