o_lo 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61959a8a7ce1427a8b1d3d668892bd7189d8f6df9fcf35c2b653d77746a6404f
-  data.tar.gz: f3b5f595a68c185469e22f8899d3fa7c30d49934ec091a6eb8944f6626c777ae
+  metadata.gz: 2a5a812346059789bf9154aba27398c921afc583a04ae19083c21f885f319617
+  data.tar.gz: eb11db020a360e1d278052a13cd5742e06f6e00476d568811c2002f76a6a9b45
 SHA512:
-  metadata.gz: 8e88778f298fea3c193b8a33d4c7be6f6ce550eb70b5d1598f5ba0b896570ddaba665fd9d531506298bef441813e4169bca42af62f7eeb2bb4891a66e019a7ad
-  data.tar.gz: be1f4066b6fdd4fe1e40628fb96bff865196ffbe32a3d66bef3cba7879ea2d72d7a413814a0bf6021235cc8b275257ccc3916edcefd5c90fb9aa2269d18ea7b8
+  metadata.gz: 48f7cc499b9da69cfb3c9f51a4feba51acc6bd7a62f2ca414601abb77fdec2f6079bc628f6e78b5d509afa74728c072a7544f9619dc8ca999cdcf0d2f23dfcc8
+  data.tar.gz: 6978071862f807c4b2e7727a48724b5e1aae966ab1ad1a16a8f9a10d1aced551ca722b79b89298cffdc0e814069a9d8181e6df2d66e4150377ee9bb5aec2c9d5

data/.gitignore

@@ -0,0 +1,10 @@
+log/**
+pkg/**
+.DS_Store
+lib/.DS_Store
+.*.swp
+coverage.data
+tags
+.bundle
+*.gem
+Gemfile*.lock

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+gemspec
+
+gem 'rails'
+
+gem 'rspec'
+gem 'guard'
+gem 'guard-rspec'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Ryan S Stuhl
+
+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,76 @@
+# Olo
+
+Olo is short for Obvious Logger. It allows developers to output a decorated version of an Object (String, Integer, Class, etc) in the rails console.
+
+Best practice is to use Olo in development mode or custom mode (staging, profile, etc.). Using in production could have nasty consequences and just isn't worth the headaches.
+
+## Install
+
+You can add Olo as a gem:
+
+```
+gem install o_lo
+```
+
+or add it to a Gemfile (Bundler):
+
+```ruby
+gem 'o_lo', group: 'development'
+```
+
+## Usage
+
+Olo is set up to work from any controller, model, or view.
+
+In a controller or model:
+
+```ruby
+Olo.log("something to log", "%", 100)
+```
+
+In a view
+
+```
+#ERB
+<% meaningful_variable = User.email %>
+<% Olo.log(meaningful_variable, ":", 42) %>
+
+#HAML
+- meaningful_variable = User.email
+- Olo.log(meaningful_variable, ":", 42)
+```
+
+The arguments for Olo.log are:
+
+- thing: The string, variable, or value of a thing you want to output to the stdout logs _(\* required)_
+- decorator: Any string value that will be repeated to provide a visual way to find the output log _(optional, default is "\*")_
+- decorator: length: How many times the decorator will be repeated. The max is 200. _(optional, default is 100)_
+
+## Output
+
+```ruby
+thing = "Thanks for all the fish"
+decorator = "ß"
+decorator_length = 42
+Olo.log(thing, decorator, decorator_length)
+```
+
+```
+# output
+
+
+
+ßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßß
+ßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßß
+ßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßß
+
+Thanks for all the fish
+
+ßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßß
+ßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßß
+ßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßß
+
+
+
+#end of output
+```

data/bin/o_lo

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'o_lo'
+puts Olo.log("Greetings")

data/init.rb

@@ -0,0 +1 @@
+require 'o_lo'

data/lib/o_lo/version.rb

@@ -0,0 +1,3 @@
+module Olo
+  VERSION = '0.0.3'
+end

data/lib/o_lo.rb

@@ -0,0 +1,38 @@
+require 'action_controller'
+require 'active_record'
+require 'action_view'
+
+module Olo
+  ActionController::Base.send(:include, Olo) 
+  ActiveRecord::Base.send(:include, Olo) 
+  ActionView::Base.send(:include, Olo)
+
+  def self.log(thing, decorator="*", decorator_length=100)
+    decorator_length = validate_decorator_length(decorator_length)
+    decorator = validate_decorator(decorator)
+    return if thing.nil?
+    3.times { puts "" }
+    3.times { puts "#{decorator}" * decorator_length }
+    puts ""
+    puts thing
+    puts ""
+    3.times { puts "#{decorator}" * decorator_length }
+    3.times { puts "" }
+  end
+
+  private
+
+  def self.validate_decorator_length(length)
+    length = 0 if length.nil?
+    length = 100 if length < 1
+    length = 100 if !length.is_a?(Integer)
+    length = 200 if length > 200
+    length
+  end
+
+  def self.validate_decorator(decorator)
+    decorator = decorator.to_s if decorator.is_a?(Integer)
+    decorator = "*" if !decorator.is_a?(String)
+    decorator
+  end
+end

data/o_lo.gemspec

@@ -0,0 +1,20 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'o_lo/version'
+
+Gem::Specification.new do |s|
+  s.name               = 'o_lo'
+  s.version            = Olo::VERSION
+  s.executables        << 'o_lo'
+  s.platform           = Gem::Platform::RUBY
+  s.summary            = 'Obvious Logger for use in development.'
+  s.description        = 'Displays output in logs with decorators, making it easy to find in a log stream.'
+  s.authors            = ["Ryan Stuhl"]
+  s.email              = "designstuhltech@gmail.com"
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths      = ['lib']
+  s.homepage           = 'https://rubygems.org/gems/o_lo'
+  s.license            = 'MIT'
+end

data/spec/o_lo_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe ::Olo do
+  subject { Olo.log(thing, decorator, decorator_length) }
+
+  describe "#log" do
+    context "happy path" do
+      context "thing is a string" do
+        let(:thing)               { "Testing the output of a string in o_lo." }
+        let(:decorator)           { "#" }
+        let(:decorator_length)    { 99 }
+
+        it "calls log and outputs a string including the decorator" do
+          expect{subject}.to output(a_string_including(decorator * decorator_length)).to_stdout
+        end
+
+        it "calls log and outputs a string including the thing" do
+          expect{subject}.to output(a_string_including(thing)).to_stdout
+        end
+      end
+
+      context "thing is an object" do
+        let(:thing)               { Object.new }
+        let(:decorator)           { "^" }
+        let(:decorator_length)    { 42 }
+
+        it "calls log and outputs a string including the decorator" do
+          expect{subject}.to output(a_string_including(decorator * decorator_length)).to_stdout
+        end
+
+        it "calls log and outputs an object" do
+          expect{subject}.to output(a_string_including(thing.inspect)).to_stdout
+        end
+      end
+
+      context "thing is defined but decorator and decorator_length are not" do
+        let(:thing)               { "Thanks for all the fish!" }
+        let(:decorator)           { nil }
+        let(:decorator_length)    { nil}
+      end 
+    end
+
+    context "sad path" do
+      context "thing is blank" do
+        let(:thing)               { nil }
+        let(:decorator)           { nil }
+        let(:decorator_length)    { nil }
+
+        it "does not output anything" do
+          expect{subject}.not_to output(a_string_including("*" * 100)).to_stdout
+        end
+      end
+
+      context "decorator is an object" do
+        let(:thing) { "Some people like to watch the world burn" }
+        let(:decorator) { Object.new }
+        let(:decorator_length) { 42 }
+
+        it "omits the decorator if it is an object" do
+          expect{subject}.to output(a_string_including("*" * decorator_length)).to_stdout
+        end
+      end
+
+      context "decorator is an integer" do
+        let(:thing) { Object.new }
+        let(:decorator) { 7 }
+        let(:decorator_length) { nil }
+
+        it "sets the decorator to a stringified version of itself" do
+          expect{subject}.to output(a_string_including("7" * 100)).to_stdout
+        end
+      end
+
+      context "decorator_length is greater than 200" do
+        let(:thing) { Object.new }
+        let(:decorator) { "!" }
+        let(:decorator_length) { 1000 }
+
+        it "truncates the decorator length if it is over 200" do
+          expect{subject}.not_to output(a_string_including(decorator * decorator_length)).to_stdout
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+require 'o_lo'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: o_lo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Ryan Stuhl
@@ -13,10 +13,23 @@ dependencies: []
 description: Displays output in logs with decorators, making it easy to find in a
   log stream.
 email: designstuhltech@gmail.com
-executables: []
+executables:
+- o_lo
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- bin/o_lo
+- init.rb
+- lib/o_lo.rb
+- lib/o_lo/version.rb
+- o_lo.gemspec
+- spec/o_lo_spec.rb
+- spec/spec_helper.rb
 homepage: https://rubygems.org/gems/o_lo
 licenses:
 - MIT
@@ -40,4 +53,6 @@ rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Obvious Logger for use in development.
-test_files: []
+test_files:
+- spec/o_lo_spec.rb
+- spec/spec_helper.rb