lumos 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e662e8a14acb448c195481fd0695f902efa6f30b
+  data.tar.gz: 96989e2c5815ab117671a61579a5761797e3c664
+SHA512:
+  metadata.gz: d605efe5be6043cfac0d48c7bf1acc1fd0f56b17b620c3133eeb723ac7170c76c4c7db8678d1d2615ee43ed025dd68b8abae0d250a583949a5baad8219866a45
+  data.tar.gz: 56dba760f56e8a45d87e1fa1f4844101a0c37a2c58a2e6baf18aaee8084c801f1a01c4ecfe87344075f23f9b5d9ef173a89f7eb6b54a2a0503144afa5cc6d43a

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+*.gem

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.1.5
+  - 2.2
+
+addons:
+  code_climate:
+    repo_token: 30676ff831772153d0238cd5ccbab7b8044a17d57c2878b07aa04904e7246328

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 query-string
+
+MIT License
+
+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,130 @@
+# Lumos
+
+[![Build Status](https://travis-ci.org/query-string/lumos.svg)](https://travis-ci.org/query-string/lumos)
+[![Code Climate](https://codeclimate.com/github/query-string/lumos/badges/gpa.svg)](https://codeclimate.com/github/query-string/lumos)
+[![Test Coverage](https://codeclimate.com/github/query-string/lumos/badges/coverage.svg)](https://codeclimate.com/github/query-string/lumos)
+
+<pre>
+☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢
+☢                            ☢
+☢                            ☢
+☢  Objects wrapping library  ☢
+☢                            ☢
+☢                            ☢
+☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢☢
+</pre>
+
+Have you ever tried to highlight your Ruby objects from your controllers/models/whatever in the Rails log? I bet you have ). I usually do something like that ` p "###"; p %w(foo bar baz ); p "###"` and in general it works fine, until you have to repeat this construction again and again, with different objects, in different places. I have a good news – `lumos` can easily wrap and make any object perceptible amongs common Rails log mess.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lumos'
+```
+
+And call inside your controller/model/whatever
+ ```ruby
+class My::MoviesController < ApplicationController
+  def checked
+    lumos params
+    @movie = Movie.find(params[:movie_id])
+    current_user.send(params[:scope]) << @movie
+    #redirect_to root_path
+  end
+end
+ ```
+
+## Usage
+
+Depend on passed parameters, `lumos` can act as a **divider** or as a **wrapper**.
+
+### Divider
+
+For example, simple call of `lumos` without params will print a `###` message in your log. Of course you're able to change a divider sign (`lumos :>, "☭"` will print a `☭☭☭` message) and number of repetitions – `lumos :>, "☢", 10`.
+
+```ruby
+lumos
+print "###"
+
+lumos :>, "☭"
+print "☭☭☭"
+
+lumos :>, "☢", 10
+print "☢☢☢☢☢☢☢☢☢☢"
+```
+
+### Wrapper
+
+But main reason of `lumos` existence is necessity of objects highlighting besides ambient noise. So, initial array might be highlighted with `lumos %w(foo bar baz)` that will give us such output:
+
+<pre>
+#########################
+#                       #
+# ["foo", "bar", "baz"] #
+#                       #
+#########################
+</pre>
+
+Wrapping method also takes few options such as:
+
+#### position:
+
+`:surround` (by default), `:top`, `:bottom`, `:left`, `:right`, `:horizontal`, `:vertical`
+
+```ruby
+domains = {ru: "Russia", th: "Thailand", "com.au" => "Australia", ph: "Philippines", la: "Laos"}
+lumos domains, {position: :horizontal}
+```
+
+<pre>
+######################################################################
+{:ru=>"Russia", :th=>"Thailand", "com.au"=>"Australia", :ph=>"Philippi
+nes", :la=>"Laos"}
+######################################################################
+</pre>
+
+#### delimiter:
+
+```ruby
+lumos domains, {position: :horizontal, delimiter: "❤★"}
+```
+
+<pre>
+{:ru=>"Russia", :th=>"Thailand", "com.au"=>"Australia", :ph=>"Philippi
+nes", :la=>"Laos"}
+❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★❤★
+</pre>
+
+#### padding:
+
+```ruby
+lumos domains, {delimiter: "❄", padding: 2}
+```
+
+<pre>
+❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄
+❄                                                                            ❄
+❄                                                                            ❄
+❄                                                                            ❄
+❄   {:ru=>"Russia", :th=>"Thailand", "com.au"=>"Australia", :ph=>"Philippi   ❄
+❄   nes", :la=>"Laos"}                                                       ❄
+❄                                                                            ❄
+❄                                                                            ❄
+❄                                                                            ❄
+❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄❄
+</pre>
+
+#### length:
+
+```ruby
+lumos domains, {position: :horizontal, delimiter: "->", length: 140}
+```
+
+<pre>
+->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->
+{:ru=>"Russia", :th=>"Thailand", "com.au"=>"Australia", :ph=>"Philippines", :la=>"Laos"}
+->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->
+</pre>

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+RSpec::Core::RakeTask.new

data/TODO.md

@@ -0,0 +1,13 @@
+# Lumos TODO
+
+## Release
+- [x] Cases when length is wider than message
+- [x] Test different input objects behaviour (Set, Struct, OpenStruct, Class, ActiveRecord)
+- [x] Refactor Lumos::Formatters::Base
+- [x] Rewrite README
+- [ ] Release on Rubygems
+
+## Next
+- [ ] Changeable default options
+- [ ] Add colors support
+- [ ] Add emoji support

data/lib/lumos/core_ext/kernel.rb

@@ -0,0 +1,23 @@
+module Kernel
+  def lumos(message = nil, *args)
+    if message.nil? || message == :>
+      lumos_divide args[0], args[1]
+    else
+      lumos_wrap message, args[0]
+    end
+  end
+
+private
+
+  def lumos_divide(delimiter, iterations)
+    delimiter  ||= "#"
+    iterations ||= 3
+
+    print delimiter * iterations.to_i
+  end
+
+  def lumos_wrap(message = nil, options)
+    options ||= {}
+    print Lumos::Wrapper.new(message, options).result
+  end
+end

data/lib/lumos/formatters/base.rb

@@ -0,0 +1,33 @@
+module Lumos
+  module Formatters
+    class Base
+      include BaseChopper
+      include BaseHorizontal
+
+      attr_reader :message, :delimiter, :padding, :length
+
+      def initialize(options = {})
+        @message   = unwrap_message options.fetch(:message)
+        @delimiter = options.fetch(:delimiter, "#").to_s
+        @padding   = options.fetch(:padding, 1).to_i.abs
+        @length    = options.fetch(:length, 70).to_i.abs
+      end
+
+      def message_length
+        message.to_s.size
+      end
+
+    private
+
+      def unwrap_message(message)
+        object_id_hex = (message.object_id << 1).to_s(16)
+        message.to_s.include?(object_id_hex) ? message.inspect : message.to_s
+      end
+
+
+      def vertical_padding
+        " " * padding if padding > 0
+      end
+    end
+  end
+end

data/lib/lumos/formatters/base_chopper.rb

@@ -0,0 +1,34 @@
+module Lumos
+  module Formatters
+    module BaseChopper
+      def chopped_message
+        message.scan(/.{1,#{( length > message_length ? message_length : length )}}/)
+      end
+
+      def chopped_message_length
+        chopped_message[0].size
+      end
+
+      def iterate_chopped_lines(string = "")
+        chopped_message.each{ |line| string += yield line }
+        string
+      end
+
+      def chopping_line(line)
+        "\n" if chopped_message.size > 1 && !chopping_last_line?(line)
+      end
+
+      def chopping_last_line?(line)
+        chopped_message.index(line) == chopped_message.size - 1
+      end
+
+      def chopping_padding(line)
+        if chopping_last_line?(line)
+          first_line = chopped_message.first.size
+          last_line  = chopped_message.last.size
+          " " * (first_line - last_line) if first_line > last_line
+        end
+      end
+    end
+  end
+end

data/lib/lumos/formatters/base_horizontal.rb

@@ -0,0 +1,29 @@
+module Lumos
+  module Formatters
+    module BaseHorizontal
+      def horizontal_pattern
+        delimiter * chopped_message_length
+      end
+
+      def horizontal_line
+        paragraph      = content_paragraph(chopped_message[0])
+        paragraph_size = paragraph.size
+        draft_size     = horizontal_pattern.size
+
+        draft_size > paragraph_size ? horizontal_pattern[0...paragraph_size] : horizontal_pattern
+      end
+
+      def horizontal_padding
+        "\n" * padding if padding > 0
+      end
+
+      def horizontal_result
+        "#{horizontal_line}\n"\
+        "#{horizontal_padding}"\
+        "#{iterate_chopped_lines{ |line| "#{content_paragraph(line)}\n" }}"\
+        "#{horizontal_padding}"\
+        "#{horizontal_line}"
+      end
+    end
+  end
+end

data/lib/lumos/formatters/bottom.rb

@@ -0,0 +1,22 @@
+module Lumos
+  module Formatters
+    class Bottom < Lumos::Formatters::Base
+      def initialize(options = {})
+        super
+        @padding = options.fetch(:padding, 0).to_i.abs
+      end
+
+      def result
+        "#{iterate_chopped_lines{ |line| "#{content_paragraph(line)}\n" }}"\
+        "#{horizontal_padding}"\
+        "#{horizontal_line}"
+      end
+
+    private
+
+      def content_paragraph(line)
+        line
+      end
+    end
+  end
+end

data/lib/lumos/formatters/horizontal.rb

@@ -0,0 +1,20 @@
+module Lumos
+  module Formatters
+    class Horizontal < Lumos::Formatters::Base
+      def initialize(options = {})
+        super
+        @padding = options.fetch(:padding, 0).to_i.abs
+      end
+
+      def result
+        horizontal_result
+      end
+
+    private
+
+      def content_paragraph(line)
+        line
+      end
+    end
+  end
+end

data/lib/lumos/formatters/left.rb

@@ -0,0 +1,12 @@
+module Lumos
+  module Formatters
+    class Left < Lumos::Formatters::Base
+      def result
+        iterate_chopped_lines do |line|
+          "#{delimiter}#{vertical_padding}#{line}"\
+          "#{chopping_line line}"
+        end
+      end
+    end
+  end
+end

data/lib/lumos/formatters/right.rb

@@ -0,0 +1,12 @@
+module Lumos
+  module Formatters
+    class Right < Lumos::Formatters::Base
+      def result
+        iterate_chopped_lines do |line|
+          "#{line}#{vertical_padding}#{chopping_padding line}#{delimiter}"\
+          "#{chopping_line line}"
+        end
+      end
+    end
+  end
+end

data/lib/lumos/formatters/surround.rb

@@ -0,0 +1,25 @@
+module Lumos
+  module Formatters
+    class Surround < Lumos::Formatters::Base
+      def result
+        horizontal_result
+      end
+
+    private
+
+      def horizontal_pattern
+        "#{delimiter * chopped_message_length}"\
+        "#{padding > 0 ? (delimiter * padding) * 2 : nil}"\
+        "#{delimiter * 2}"
+      end
+
+      def horizontal_padding
+        "#{content_paragraph(" " * chopped_message_length)}\n" * padding if padding > 0
+      end
+
+      def content_paragraph(line)
+        "#{delimiter}#{vertical_padding}#{line}#{vertical_padding}#{chopping_padding line}#{delimiter}"
+      end
+    end
+  end
+end

data/lib/lumos/formatters/top.rb

@@ -0,0 +1,22 @@
+module Lumos
+  module Formatters
+    class Top < Lumos::Formatters::Base
+      def initialize(options = {})
+        super
+        @padding = options.fetch(:padding, 0).to_i.abs
+      end
+
+      def result
+        "#{horizontal_line}\n"\
+        "#{horizontal_padding}"\
+        "#{iterate_chopped_lines{ |line| content_paragraph line }}"
+      end
+
+    private
+
+      def content_paragraph(line)
+        "#{line}#{chopping_line line}"
+      end
+    end
+  end
+end

data/lib/lumos/formatters/vertical.rb

@@ -0,0 +1,12 @@
+module Lumos
+  module Formatters
+    class Vertical < Lumos::Formatters::Base
+      def result
+        iterate_chopped_lines do |line|
+          "#{delimiter}#{vertical_padding}#{line}#{vertical_padding}#{chopping_padding line}#{delimiter}"\
+          "#{chopping_line line}"
+        end
+      end
+    end
+  end
+end

data/lib/lumos/version.rb

@@ -0,0 +1,3 @@
+module Lumos
+  VERSION = "0.0.1"
+end

data/lib/lumos/wrapper.rb

@@ -0,0 +1,39 @@
+module Lumos
+  class Wrapper
+    attr_reader :message, :options, :position
+
+    def initialize(message, options = {})
+      @message  = message
+      @options  = options
+      @position = options.fetch(:position, :surround).to_sym
+
+      validate_position
+    end
+
+    def formatter(name = position)
+      ("Lumos::Formatters::" + "#{name}".classify).constantize.new(merged_options)
+    end
+
+    def result
+      formatter.result
+    end
+
+    def method_missing(name)
+      available_positions.include?(name) ? formatter(name).result : super
+    end
+
+  private
+
+    def available_positions
+      [:surround, :left, :right, :top, :bottom, :horizontal, :vertical]
+    end
+
+    def validate_position
+      raise ArgumentError, "#{position} is not correct position. You can use one of following: #{available_positions.join(", ")}." unless available_positions.include?(position)
+    end
+
+    def merged_options
+      options.except(:position).merge(message: message)
+    end
+  end
+end

data/lib/lumos.rb

@@ -0,0 +1,9 @@
+require "active_support/core_ext/string"
+
+%w(base_chopper base_horizontal base surround left right top bottom horizontal vertical).each do |file|
+  require File.dirname(__FILE__) + "/lumos/formatters/#{file}"
+end
+
+require "lumos/wrapper"
+require "lumos/core_ext/kernel"
+require "lumos/version"

data/lumos.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lumos/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lumos"
+  spec.version       = Lumos::VERSION
+  spec.authors       = ["query-string"]
+  spec.email         = ["atimofeev@reactant.ru"]
+  spec.summary       = "Objects wrapping library"
+  spec.description   = "Have you ever tried to highlight your Ruby objects from your controllers/models/whatever in the Rails log? Lumos can easily wrap and make any object perceptible amongs common Rails log mess!"
+  spec.homepage      = "https://github.com/query-string/lumos"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "activesupport", "4.2"
+  spec.add_development_dependency "activerecord", "4.2"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+end

data/spec/active_record_helper.rb

@@ -0,0 +1,13 @@
+# Establish connection to in-memory SQLite DB
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+# Create the coffee table
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Migration.create_table :coffees do |t|
+  t.string :sort
+  t.integer :price
+  t.integer :saturation
+end
+
+# Create model
+class Coffee < ActiveRecord::Base; end

data/spec/core_ext/kernel_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+require "active_record_helper"
+require "set"
+
+RSpec.describe "Lumos kernel extensions" do
+  context "divider" do
+    it "returns sharps if no arguments defined" do
+      expect { lumos }.to output("###").to_stdout
+    end
+
+    it "returns sharps if only pointer defined" do
+      expect { lumos :> }.to output("###").to_stdout
+    end
+
+    it "returns delimiter based string" do
+      expect { lumos :>, "-" }.to output("---").to_stdout
+    end
+
+    it "returns delimiter based string repeated 10 times" do
+      expect { lumos :>, "@", 10 }.to output("@@@@@@@@@@").to_stdout
+    end
+  end
+
+  context "wrapper" do
+    it "returns wrapped messages if no arguments except message defined" do
+      expect { lumos "Accio" }.to output("#########\n#       #\n# Accio #\n#       #\n#########").to_stdout
+    end
+
+    it "returns bottom positioned message" do
+      expect { lumos "Accio", {position: :bottom, delimiter: "@"} }.to output("Accio\n@@@@@").to_stdout
+    end
+  end
+
+  context "objects" do
+    it "returns wra pped Array" do
+      expect { lumos %w(One Two Freddy is coming for you Three Four better lock your door ) }.to output("##########################################################################\n#                                                                        #\n# [\"One\", \"Two\", \"Freddy\", \"is\", \"coming\", \"for\", \"you\", \"Three\", \"Four\" #\n# , \"better\", \"lock\", \"your\", \"door\"]                                    #\n#                                                                        #\n##########################################################################").to_stdout
+    end
+
+    it "returns wrapped Hash" do
+      domains = {ru: "Russia", th: "Thailand", "com.au" => "Australia", ph: "Philippines"}
+      expect { lumos domains, {length: 56}}.to output("############################################################\n#                                                          #\n# {:ru=>\"Russia\", :th=>\"Thailand\", \"com.au\"=>\"Australia\",  #\n# :ph=>\"Philippines\"}                                      #\n#                                                          #\n############################################################").to_stdout
+    end
+
+    it "returns wrapped Set" do
+      expect { lumos Set.new([1,2,3])}.to output("#####################\n#                   #\n# #<Set: {1, 2, 3}> #\n#                   #\n#####################").to_stdout
+    end
+
+    it "returns wrapped Struct" do
+      Struct.new("Customer", :name, :address)
+      expect { lumos Struct::Customer.new("Dave", "123 Main")}.to output("##############################################################\n#                                                            #\n# #<struct Struct::Customer name=\"Dave\", address=\"123 Main\"> #\n#                                                            #\n##############################################################").to_stdout
+    end
+
+    it "returns wrapped OpenStruct" do
+      expect { lumos OpenStruct.new(country: "Russia", population: 143_975_923)}.to output("########################################################\n#                                                      #\n# #<OpenStruct country=\"Russia\", population=143975923> #\n#                                                      #\n########################################################").to_stdout
+    end
+
+    it "returns wrapped ActiveRecord" do
+      Struct.new("Customer", :name, :address)
+      expect { lumos Coffee.new(sort: "Cappuccino", price: 105, saturation: 25)}.to output("#####################################################################\n#                                                                   #\n# #<Coffee id: nil, sort: \"Cappuccino\", price: 105, saturation: 25> #\n#                                                                   #\n#####################################################################").to_stdout
+    end
+  end
+end

data/spec/formatters/base_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Lumos::Formatters::Base do
+
+  context "subsidary methods" do
+    it "returns number of message characters" do
+      expect(described_class.new(message: "Cave Inimicum").message_length).to eq(13)
+    end
+
+    it "returns number of short message lines" do
+      expect(described_class.new(message: "Colloportus").chopped_message.size).to eq(1)
+    end
+
+    it "returns number of long message lines" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.").chopped_message.size).to eq(3)
+    end
+
+    it "returns messages size based on lenght of first chopped line" do
+      expect(described_class.new(message: "Confringo").chopped_message_length).to eq(9)
+    end
+  end
+
+end

data/spec/formatters/bottom_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Lumos::Formatters::Bottom do
+  context "messages" do
+    it "returns wrapped message" do
+      expect(described_class.new(message: "Langlock").result).to eq("Langlock\n########")
+    end
+
+    it "returns multiline message" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.").result).to eq("Coffee has long had a reputation as being unhealthy. But in almost eve\nry single respect that reputation is backward. The potential health be\nnefits are surprisingly large.\n######################################################################")
+    end
+
+    it "returns multiline message with defined length" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.", length: 35).result).to eq("Coffee has long had a reputation as\n being unhealthy. But in almost eve\nry single respect that reputation i\ns backward. The potential health be\nnefits are surprisingly large.\n###################################")
+    end
+  end
+
+  context "paddings" do
+    it "returns zero-padding message" do
+      expect(described_class.new(message: "Levicorpus", padding: 0).result).to eq("Levicorpus\n##########")
+    end
+
+    it "returns 1-digit padding message" do
+      expect(described_class.new(message: "Levicorpus", padding: 1).result).to eq("Levicorpus\n\n##########")
+    end
+
+    it "returns 2-digits padding message" do
+      expect(described_class.new(message: "Levicorpus", padding: 2).result).to eq("Levicorpus\n\n\n##########")
+    end
+  end
+
+  context "delimiters" do
+    it "returns delimiter message" do
+      expect(described_class.new(message: "Legilimens", delimiter: "☯").result).to eq("Legilimens\n☯☯☯☯☯☯☯☯☯☯")
+    end
+
+    it "returns message with multichar delimiter" do
+      expect(described_class.new(message: "Legilimens", delimiter: "=->").result).to eq("Legilimens\n=->=->=->=")
+    end
+  end
+end

data/spec/formatters/horizontal_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Lumos::Formatters::Horizontal do
+  context "messages" do
+    it "returns message" do
+      expect(described_class.new(message: "Meteolojinx Recanto").result).to eq("###################\nMeteolojinx Recanto\n###################")
+    end
+
+    it "returns multiline message" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.").result).to eq("######################################################################\nCoffee has long had a reputation as being unhealthy. But in almost eve\nry single respect that reputation is backward. The potential health be\nnefits are surprisingly large.\n######################################################################")
+    end
+
+    it "returns multiline message with defined length" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.", length: 35).result).to eq("###################################\nCoffee has long had a reputation as\n being unhealthy. But in almost eve\nry single respect that reputation i\ns backward. The potential health be\nnefits are surprisingly large.\n###################################")
+    end
+  end
+
+  context "paddings" do
+    it "returns zero-padding message" do
+      expect(described_class.new(message: "Mobilicorpus", padding: 0).result).to eq("############\nMobilicorpus\n############")
+    end
+
+    it "returns 1-digit message" do
+      expect(described_class.new(message: "Mobilicorpus", padding: 1).result).to eq("############\n\nMobilicorpus\n\n############")
+    end
+
+    it "returns 2-digits padding message" do
+      expect(described_class.new(message: "Mobilicorpus", padding: 2).result).to eq("############\n\n\nMobilicorpus\n\n\n############")
+    end
+  end
+
+  context "delimiters" do
+    it "returns delimiter message" do
+      expect(described_class.new(message: "Mobiliarbus", delimiter: "❄").result).to eq("❄❄❄❄❄❄❄❄❄❄❄\nMobiliarbus\n❄❄❄❄❄❄❄❄❄❄❄")
+    end
+
+    it "returns message with multichar delimiter" do
+      expect(described_class.new(message: "Mobiliarbus", delimiter: "=->").result).to eq("=->=->=->=-\nMobiliarbus\n=->=->=->=-")
+    end
+  end
+end

data/spec/formatters/left_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Lumos::Formatters::Left do
+  context "messages" do
+    it "returns wrapped message" do
+      expect(described_class.new(message: "Engorgio").result).to eq("# Engorgio")
+    end
+
+    it "returns multiline message" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.").result).to eq("# Coffee has long had a reputation as being unhealthy. But in almost eve\n# ry single respect that reputation is backward. The potential health be\n# nefits are surprisingly large.")
+    end
+
+    it "returns multiline message with defined length" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.", length: 35).result).to eq("# Coffee has long had a reputation as\n#  being unhealthy. But in almost eve\n# ry single respect that reputation i\n# s backward. The potential health be\n# nefits are surprisingly large.")
+    end
+  end
+
+  context "paddings" do
+    it "returns zero-digit padding message" do
+      expect(described_class.new(message: "Episkey", padding: 0).result).to eq("#Episkey")
+    end
+
+    it "returns 1-digit padding message" do
+      expect(described_class.new(message: "Episkey", padding: 1).result).to eq("# Episkey")
+    end
+
+    it "returns 2-digits padding message" do
+      expect(described_class.new(message: "Episkey", padding: 2).result).to eq("#  Episkey")
+    end
+  end
+
+  it "returns delimiter message" do
+    expect(described_class.new(message: "Ennervate", delimiter: "☭").result).to eq("☭ Ennervate")
+  end
+end

data/spec/formatters/right_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Lumos::Formatters::Right do
+  context "messages" do
+    it "returns wrapped message" do
+      expect(described_class.new(message: "Ferula").result).to eq("Ferula #")
+    end
+
+    it "returns multiline message" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.").result).to eq("Coffee has long had a reputation as being unhealthy. But in almost eve #\nry single respect that reputation is backward. The potential health be #\nnefits are surprisingly large.                                         #")
+    end
+
+    it "returns multiline message with defined length" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.", length: 35).result).to eq("Coffee has long had a reputation as #\n being unhealthy. But in almost eve #\nry single respect that reputation i #\ns backward. The potential health be #\nnefits are surprisingly large.      #")
+    end
+  end
+
+  context "paddings" do
+    it "returns zero-padding message" do
+      expect(described_class.new(message: "Finite Incantatum", padding: 0).result).to eq("Finite Incantatum#")
+    end
+
+    it "returns 1-digit padding message" do
+      expect(described_class.new(message: "Finite Incantatum", padding: 1).result).to eq("Finite Incantatum #")
+    end
+
+    it "returns 2-digits padding message" do
+      expect(described_class.new(message: "Finite Incantatum", padding: 2).result).to eq("Finite Incantatum  #")
+    end
+  end
+
+  it "returns delimiter message" do
+    expect(described_class.new(message: "Fidelius", delimiter: "->").result).to eq("Fidelius ->")
+  end
+
+end

data/spec/formatters/surround_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Lumos::Formatters::Surround do
+  context "messages" do
+    it "returns wrapped message" do
+      expect(described_class.new(message: "Defodio").result).to eq("###########\n#         #\n# Defodio #\n#         #\n###########")
+    end
+
+    it "returns multiline message" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.").result).to eq("##########################################################################\n#                                                                        #\n# Coffee has long had a reputation as being unhealthy. But in almost eve #\n# ry single respect that reputation is backward. The potential health be #\n# nefits are surprisingly large.                                         #\n#                                                                        #\n##########################################################################")
+    end
+
+    it "returns multiline message with defined length" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.", length: 35).result).to eq("#######################################\n#                                     #\n# Coffee has long had a reputation as #\n#  being unhealthy. But in almost eve #\n# ry single respect that reputation i #\n# s backward. The potential health be #\n# nefits are surprisingly large.      #\n#                                     #\n#######################################")
+    end
+  end
+
+  context "paddings" do
+    it "returns zero-digit padding message" do
+      expect(described_class.new(message: "Densaugeo", padding: 0).result).to eq("###########\n#Densaugeo#\n###########")
+    end
+
+    it "returns 1-digit padding message" do
+      expect(described_class.new(message: "Densaugeo", padding: 1).result).to eq("#############\n#           #\n# Densaugeo #\n#           #\n#############")
+    end
+
+    it "returns 2-digits padding message" do
+      expect(described_class.new(message: "Densaugeo", padding: 2).result).to eq("###############\n#             #\n#             #\n#  Densaugeo  #\n#             #\n#             #\n###############")
+    end
+  end
+
+  context "delimiters" do
+    it "returns delimiter message" do
+      expect(described_class.new(message: "Deletrius", delimiter: "❤").result).to eq("❤❤❤❤❤❤❤❤❤❤❤❤❤\n❤           ❤\n❤ Deletrius ❤\n❤           ❤\n❤❤❤❤❤❤❤❤❤❤❤❤❤")
+    end
+
+    it "returns message with multichar delimiter" do
+      expect(described_class.new(message: "Deletrius", delimiter: "=->").result).to eq("=->=->=->=->=->=-\n=->           =->\n=-> Deletrius =->\n=->           =->\n=->=->=->=->=->=-")
+    end
+  end
+end

data/spec/formatters/top_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Lumos::Formatters::Top do
+  context "messages" do
+    it "returns wrapped message" do
+      expect(described_class.new(message: "Immobulus").result).to eq("#########\nImmobulus")
+    end
+
+    it "returns multiline message" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.").result).to eq("######################################################################\nCoffee has long had a reputation as being unhealthy. But in almost eve\nry single respect that reputation is backward. The potential health be\nnefits are surprisingly large.")
+    end
+
+    it "returns multiline message with defined length" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.", length: 35).result).to eq("###################################\nCoffee has long had a reputation as\n being unhealthy. But in almost eve\nry single respect that reputation i\ns backward. The potential health be\nnefits are surprisingly large.")
+    end
+  end
+
+  context "paddings" do
+    it "returns zero-padding message" do
+      expect(described_class.new(message: "Imperio", padding: 0).result).to eq("#######\nImperio")
+    end
+
+    it "returns 1-digit padding message" do
+      expect(described_class.new(message: "Imperio", padding: 1).result).to eq("#######\n\nImperio")
+    end
+
+    it "returns 2-digits padding message" do
+      expect(described_class.new(message: "Imperio", padding: 2).result).to eq("#######\n\n\nImperio")
+    end
+  end
+
+  context "delimiters" do
+    it "returns delimiter message" do
+      expect(described_class.new(message: "Impedimenta", delimiter: "★").result).to eq("★★★★★★★★★★★\nImpedimenta")
+    end
+
+    it "returns message with multichar delimiter" do
+      expect(described_class.new(message: "Impedimenta", delimiter: "=->").result).to eq("=->=->=->=-\nImpedimenta")
+    end
+  end
+end

data/spec/formatters/vertical_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Lumos::Formatters::Vertical do
+  context "messages" do
+    it "returns message" do
+      expect(described_class.new(message: "Obliviate").result).to eq("# Obliviate #")
+    end
+
+    it "returns multiline message" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.").result).to eq("# Coffee has long had a reputation as being unhealthy. But in almost eve #\n# ry single respect that reputation is backward. The potential health be #\n# nefits are surprisingly large.                                         #")
+    end
+
+    it "returns multiline message with defined length" do
+      expect(described_class.new(message: "Coffee has long had a reputation as being unhealthy. But in almost every single respect that reputation is backward. The potential health benefits are surprisingly large.", length: 35).result).to eq("# Coffee has long had a reputation as #\n#  being unhealthy. But in almost eve #\n# ry single respect that reputation i #\n# s backward. The potential health be #\n# nefits are surprisingly large.      #")
+    end
+  end
+
+  context "paddings" do
+    it "returns zero-padding message" do
+      expect(described_class.new(message: "Oppugno", padding: 0).result).to eq("#Oppugno#")
+    end
+
+    it "returns 1-digit padding message" do
+      expect(described_class.new(message: "Oppugno", padding: 1).result).to eq("# Oppugno #")
+    end
+
+    it "returns 2-digits padding message" do
+      expect(described_class.new(message: "Oppugno", padding: 2).result).to eq("#  Oppugno  #")
+    end
+  end
+
+  it "returns delimiter message" do
+    expect(described_class.new(message: "Obscuro", delimiter: "☢").result).to eq("☢ Obscuro ☢")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+ENV['CODECLIMATE_REPO_TOKEN'] = "331d5a46a9d322bb39ba65ac61954d3f5453f7eb20ffd4d3825165cf7a2c19c1"
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "active_record"
+require "lumos"
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end

data/spec/wrapper_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Lumos::Wrapper do
+  context "position" do
+    it "returns surround if position was not defined" do
+      expect(described_class.new("Aguamenti").position).to eq(:surround)
+    end
+
+    it "raises an ArgumentError exception if wrong position defined" do
+      expect { described_class.new("Avada Kedavra", {position: :unknown}) }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "service methods" do
+    it "instantiates class based on defined position" do
+      expect(described_class.new("Alohomora", {position: :left}).formatter.class).to eq(Lumos::Formatters::Left)
+    end
+  end
+
+  context "missing methods" do
+    it "returns left positioned message" do
+      expect(described_class.new("Anapneo").left).to eq("# Anapneo")
+    end
+
+    it "returns bottom positioned message" do
+      expect(described_class.new("Aparecium").bottom).to eq("Aparecium\n#########")
+    end
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: lumos
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- query-string
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Have you ever tried to highlight your Ruby objects from your controllers/models/whatever
+  in the Rails log? Lumos can easily wrap and make any object perceptible amongs common
+  Rails log mess!
+email:
+- atimofeev@reactant.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- lib/lumos.rb
+- lib/lumos/core_ext/kernel.rb
+- lib/lumos/formatters/base.rb
+- lib/lumos/formatters/base_chopper.rb
+- lib/lumos/formatters/base_horizontal.rb
+- lib/lumos/formatters/bottom.rb
+- lib/lumos/formatters/horizontal.rb
+- lib/lumos/formatters/left.rb
+- lib/lumos/formatters/right.rb
+- lib/lumos/formatters/surround.rb
+- lib/lumos/formatters/top.rb
+- lib/lumos/formatters/vertical.rb
+- lib/lumos/version.rb
+- lib/lumos/wrapper.rb
+- lumos.gemspec
+- spec/active_record_helper.rb
+- spec/core_ext/kernel_spec.rb
+- spec/formatters/base_spec.rb
+- spec/formatters/bottom_spec.rb
+- spec/formatters/horizontal_spec.rb
+- spec/formatters/left_spec.rb
+- spec/formatters/right_spec.rb
+- spec/formatters/surround_spec.rb
+- spec/formatters/top_spec.rb
+- spec/formatters/vertical_spec.rb
+- spec/spec_helper.rb
+- spec/wrapper_spec.rb
+homepage: https://github.com/query-string/lumos
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Objects wrapping library
+test_files:
+- spec/active_record_helper.rb
+- spec/core_ext/kernel_spec.rb
+- spec/formatters/base_spec.rb
+- spec/formatters/bottom_spec.rb
+- spec/formatters/horizontal_spec.rb
+- spec/formatters/left_spec.rb
+- spec/formatters/right_spec.rb
+- spec/formatters/surround_spec.rb
+- spec/formatters/top_spec.rb
+- spec/formatters/vertical_spec.rb
+- spec/spec_helper.rb
+- spec/wrapper_spec.rb