logoris 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c0a5ee228e43ad63eb4c346a40ddca9de1c64f8
+  data.tar.gz: 74a47516c17a20e3f649770b673f5a703194c8f0
+SHA512:
+  metadata.gz: 3812249325fce444e80b3e8f4753907ca776f72728e64abdb3207b30d0099ea5306916cdeca31a43e612df0d926e4442f545b42a7f766b897e5880435c8ea3cc
+  data.tar.gz: 3d8008c9ad306714073ef05f34117bd32855bb29903387c691822e791da72a20149f005cdd256c68cd0be5002a35c325be25025ae9561d2544b400f2281c1421

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kgruber1@emich.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kent Gruber
+
+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,63 @@
+![This guy is cool.](http://i.imgur.com/0PB84Kg.png)
+
+# Logoris
+
+Logoris a Ruby gem that provides a simple, unified interface to manage logging for command-line applications to the appropriate standard stream.
+
+### Why should I use this?
+
+Do you hate having to manage your standard streams? Are your stderr events actually going to stdout, and you're like "whoa I didn't even know?" -- and you want a simple way to do this? You silly rabbit you: this is the gem for you.
+
+#### STDOUT
+
+Basically, when you do a `puts`, then you're going to STDOUT. This is where most of the good stuff happens.
+
+#### STDERR
+
+Whoa, you got some sort of gnarly error. Maybe some sort of diagnostics information that isn't really supposed to be parsed by normal input that happens for STDOUT? Well, we have STDERR for that stuff, silly.
+
+## Installation
+
+    $ gem install logoris
+
+## Usage
+
+```ruby
+require 'logoris'
+
+# create a new logoris instance, ya' know
+logger = Logoris.new(log_file: "/var/log/some_application.log")
+
+logger.error "This will go to STDERR" # for your errors
+logger.out "This will go to STDOUT"   # for your normal stuff
+
+# why not check if the log exists?
+logger.log_exists?(logger.log_file)
+# => true
+# there's almost no reason for this method
+# but, there's a method to my madness
+# :)
+```
+
+Maybe you want to log your errors and regular output in their own special files?
+
+```ruby
+# assuming you've already created a new logoris instance, ya' know
+
+# log them errors
+logger.error_file = "error.log"
+logger.error "This will go a to file (error.log), and to stderr"
+
+# log them... not errors?
+logger.out_file = "not_errors.log"
+logger.out "This will go a to file (not_errors.log), and to stdout"
+
+# Totes proving it works via this static example.
+File.readlines(logger.error_file)
+# => ["This will go a to file (error.log), and to stderr\n"]
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logoris"
+
+# 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/examples/example.rb

@@ -0,0 +1,34 @@
+# Path setting slight of hand you can ignore if not running it for debugging, basically
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+# requre the gem
+require 'logoris'
+
+# New Logoris instance.
+logger = Logoris.new
+
+# Use STDOUT, per usual.
+logger.out "Normal stuff."
+
+# Use STDERR, usually for, like, diagnostics for errors
+# and stuff like that.
+logger.error "Error stuff."
+
+
+# If you were to run this example, you could check the streams
+# are beining handled properly by redirecting the output yourself!
+#
+# ```shell
+# ruby example.rb 2> error.txt
+# ```
+#
+# ```shell
+# ruby example.rb > out.txt
+# ```
+#
+# Redirect both to a file? Easy!
+# ```shell
+# ruby example.rb &> log_em_both.txt
+# ```
+#
+# Do whatever you need to do fam'.

data/lib/logoris.rb

@@ -0,0 +1,81 @@
+class Logoris
+
+  VERSION = "1.0.0"
+
+  # The optional out_file to log stdout events.
+  # @return [String]
+  attr_accessor :out_file
+
+  # The optional error_file to log stderr events.
+  # @return [String]
+  attr_accessor :error_file
+
+  # The optional error_file to log both stdout and stderr events.
+  # @return [String]
+  attr_accessor :log_file
+
+  # @param [Hash] args Logoris options
+  # @option options [Boolean] :out_file the file to log stdout events
+  # @option options [Boolean] :error_file the file to log stderr events
+  # @return [void]
+  def initialize(args={})
+    @out_file   = false # Do not log stdout events to a file by default.
+    @error_file = false # Do not log stderr events to a file by default.
+    @log_file   = false # Do not log both stdout and stderr events to a file by default.
+    out_file    = args[:out_file]   if args[:out_file]   # Set file for stdout, if given.
+    error_file  = args[:error_file] if args[:error_file] # Set file for stderr, if given.
+    log_file    = args[:log_file]   if args[:log_file]   # Set file for stdout and stderr, if given.
+  end
+
+  # @param [String] message
+  # @return [void]
+  def out(message)
+    STDOUT.puts message
+    to_log(@out_file, message) if @out_file
+    to_log(@log_file, message) if @log_file
+  end
+
+  # @param [String] message 
+  # @return [void]
+  def error(message)
+    STDERR.puts message
+    to_log(@error_file, message) if @error_file
+    to_log(@log_file, message)   if @log_file
+  end
+
+  # @param [String] file 
+  # @return [void]
+  def error_file=(file)
+    FileUtils.touch(file) unless log_exists?(file)
+    @error_file = file
+  end
+
+  # @param [String] file 
+  # @return [void]
+  def out_file=(file)
+    FileUtils.touch(file) unless log_exists?(file)
+    @out_file = file
+  end
+  
+  # @param [String] file 
+  # @return [void]
+  def log_file=(file)
+    FileUtils.touch(file) unless log_exists?(file)
+    @log_file = file
+  end
+
+  # @param [String] file 
+  # @param [String] message 
+  # @return [void]
+  def to_log(file, message)
+    File.open(file, 'a') { |f| f.puts message }
+    to_log(@log_file, message) if @log_file
+  end
+
+  # @param [String] file 
+  # @return [Boolean]
+  def log_exists?(file)
+    File.exists?(file)
+  end
+
+end

data/logoris.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logoris'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logoris"
+  spec.version       = Logoris::VERSION
+  spec.authors       = ["Kent 'picat' Gruber"]
+  spec.email         = ["kgruber1@emich.edu"]
+
+  spec.summary       = %q{A simple, unified interface to manage logging for command-line applications to the appropriate standard stream.}   
+  spec.description   = %q{Logoris a Ruby gem that provides a simple, unified interface to manage logging for command-line applications to the appropriate standard stream. Do you hate having to manage your standard streams? Are your stderr events actually going to stdout, and you're like "whoa I didn't even know?" -- and you want a simple way to do this? You silly rabbit you: this is the gem for you.} 
+  spec.homepage      = "https://github.com/picatz/logoris"
+  spec.license       = "MIT"
+
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: logoris
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kent 'picat' Gruber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 'Logoris a Ruby gem that provides a simple, unified interface to manage
+  logging for command-line applications to the appropriate standard stream. Do you
+  hate having to manage your standard streams? Are your stderr events actually going
+  to stdout, and you''re like "whoa I didn''t even know?" -- and you want a simple
+  way to do this? You silly rabbit you: this is the gem for you.'
+email:
+- kgruber1@emich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/example.rb
+- lib/logoris.rb
+- logoris.gemspec
+homepage: https://github.com/picatz/logoris
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A simple, unified interface to manage logging for command-line applications
+  to the appropriate standard stream.
+test_files: []