spyt 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1f4cd37c51f1e44bb150553d2a20abd74af0b71
+  data.tar.gz: f184d2f9e9a4694654cc237f5fe9ea010994be47
+SHA512:
+  metadata.gz: fc80a32fd0592f97880c1b67c3fba1dc3e72e6253ad25f602fff291bcb4154cb14e0211919f6b5c9d3148179d7728f139c03ee8b5a3652b95b650697e425e12a
+  data.tar.gz: 35dbf06a4abc167ccf421f4342a3c9f32fd2565bb70dc6223b2e620c51d5dcd5c205579c735ff4a3cee6cd12cd966164ba3d692726d894f2a5b9ee215c5203a4

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Paul Duncan
+
+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,65 @@
+# Spyt
+
+Simplify your logging
+
+## Presentation
+
+This library provides a simple logger for any kind of application.
+
+## Installation
+
+### Gemfile
+```ruby
+gem 'spyt'
+```
+
+### Terminal
+```bash
+gem install -V spyt
+```
+
+## Usage
+
+Simply *extend* anything (module, class or whatever) with the *Spyt::Loggable* module.
+This will provide a *log* method which can be used as follows:
+
+```ruby
+module Foo
+	include Spyt::Loggable
+	
+	def foo
+		log.debug 'Debug Info...'
+		log.info 'Hello World!'
+		log.error 'This is an error message'
+	end
+end
+```
+
+### Configuration
+
+Configuration of the Logger can be modified by playing with the Spyt::CONFIG object.
+The following options can be modified:
+* :out - Output stream on which to produce logs (default: $stdout)
+* :lvl - Current log level (default: :info)
+
+```ruby
+# Dumping all the logs to a simple string:
+s = ''
+Spyt::CONFIG[:out] = s
+```
+
+```ruby
+# Changing the log level at runtime:
+Spyt::CONFIG[:lvl] = :debug
+```
+
+### Levels
+
+Three levels are available:
+* debug
+* info
+* error
+
+## 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,9 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+	t.pattern = 'test/**/test*.rb'
+end
+
+task :default => :test

data/lib/spyt/config.rb

@@ -0,0 +1,17 @@
+# Spyt
+# by Eresse <eresse@eresse.net>
+
+# Spyt Module
+module Spyt
+
+	# Configuration:
+	# Defines Spyt's behavior.
+	CONFIG = {
+
+		# Output Stream
+		out: $stdout,
+
+		# Level
+	    lvl: :info
+	}
+end

data/lib/spyt/levels.rb

@@ -0,0 +1,25 @@
+# Spyt
+# by Eresse <eresse@eresse.net>
+
+# Internal Includes
+require 'spyt/version'
+
+# Spyt Module
+module Spyt
+
+	# Levels:
+	# Available Log Levels, mapped to numeric values.
+	LEVELS = {
+		debug: 2,
+		info: 1,
+		error: 0
+	}
+
+	# Level Colors:
+	# When using Spiffup for colorization, this map defines which color corresponds to which level.
+	LEVEL_COLS = {
+		debug: :brown,
+		info: :green,
+		error: :red
+	}
+end

data/lib/spyt/loggable/logger.rb

@@ -0,0 +1,36 @@
+# Spyt
+# by Eresse <eresse@eresse.net>
+
+# External Includes
+require 'aromat'
+require 'spiffup'
+
+# Internal Includes
+require 'spyt/levels'
+
+# Spyt Module
+module Spyt
+
+	# Loggable Module
+	module Loggable
+
+		# Logger Class:
+		# Internal class used by Loggable module to provide logging methods.
+		class Logger
+
+			# Construct:
+			# Builds a *Logger* to represent a given _source_.
+			# @param [String] source Name of this logger's source
+			def initialize source
+				@source = source
+			end
+
+			# Generic Log Handler:
+			# Proxy to Log::method_missing
+			def method_missing name, *args
+				super unless LEVELS.include? name
+				Spyt.send name, @source, *args
+			end
+		end
+	end
+end

data/lib/spyt/loggable.rb

@@ -0,0 +1,25 @@
+# Spyt
+# by Eresse <eresse@eresse.net>
+
+# External Includes
+require 'aromat'
+
+# Internal Includes
+require 'spyt/levels'
+require 'spyt/loggable/logger'
+
+# Spyt Module
+module Spyt
+
+	# Loggable Module:
+	# Include this into anything to provide logging capability.
+	module Loggable
+
+		# Log:
+		# Logger Access
+		# @return [Logger] A Logger tailored to the containing object
+		def log
+			@logger ||= Logger.new self.try(:name) || self.try(:class).try(:name) || self.to_s
+		end
+	end
+end

data/lib/spyt/version.rb

@@ -0,0 +1,9 @@
+# Spyt
+# by Eresse <eresse@eresse.net>
+
+# Spyt Module
+module Spyt
+
+	# Version
+	VERSION = '1.0.0'
+end

data/lib/spyt.rb

@@ -0,0 +1,49 @@
+# Spyt
+# by Eresse <eresse@eresse.net>
+
+# Internal Includes
+require 'spyt/version'
+require 'spyt/levels'
+require 'spyt/config'
+require 'spyt/loggable'
+
+# Spyt Module:
+# Root Module for Spyt.
+module Spyt
+
+	# Generic Log Handler:
+	# Route log calls to each level.
+	def self.method_missing name, *args
+
+		# Fail on unknown Methods
+		super unless LEVELS.include? name
+
+		# Push Log (Level shortcuts)
+		push name, args[0], args[1]
+	end
+
+	# Push Message:
+	# Writes a message _msg_ from _src_ as level _lvl_ to the log.
+	# @param [Symbol] lvl Log level (see LEVELS)
+	# @param [String] src Message source
+	# @param [String] msg Message text
+	def self.push lvl, src, msg
+
+		# Check Level
+		raise "Invalid Log Level [#{lvl.to_s.inspect.bred}] requested" unless LEVELS.include? lvl.to_sym
+
+		# Check Level
+		return unless LEVELS[lvl] <= LEVELS[CONFIG[:lvl]]
+
+		# Ensure Lock is available
+		@lock ||= Mutex.new
+
+		# Synchronize
+		@lock.synchronize do
+
+			# Write & Flush
+			CONFIG[:out] << "#{Time.now.to_s.blue} [#{lvl.to_s.send LEVEL_COLS[lvl.to_sym]}] #{src.bmagenta} :: #{msg}"
+			CONFIG[:out].flush if CONFIG[:out].respond_to? :flush
+		end
+	end
+end

data/spyt.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spyt/version'
+
+Gem::Specification.new do |spec|
+	spec.name = 'spyt'
+	spec.version = Spyt::VERSION
+	spec.authors = ['Eresse']
+	spec.email = ['eresse@eresse.net']
+
+	spec.summary = 'Simplify your logging'
+	spec.description = 'Provides a simple logger for any kind of application.'
+	spec.homepage = 'http://redmine.eresse.net/projects/spyt'
+	spec.license = 'MIT'
+
+	spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	spec.require_paths = ['lib']
+
+	spec.add_development_dependency 'bundler'
+	spec.add_development_dependency 'rake'
+	spec.add_runtime_dependency 'minitest'
+	spec.add_runtime_dependency 'spiffup'
+	spec.add_runtime_dependency 'aromat'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: spyt
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eresse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spiffup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aromat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a simple logger for any kind of application.
+email:
+- eresse@eresse.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spyt.rb
+- lib/spyt/config.rb
+- lib/spyt/levels.rb
+- lib/spyt/loggable.rb
+- lib/spyt/loggable/logger.rb
+- lib/spyt/version.rb
+- spyt.gemspec
+homepage: http://redmine.eresse.net/projects/spyt
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simplify your logging
+test_files: []