wrapped_print 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b2b462407500f5c9bc47f7da2768d980beb29957efd2bf57dc390e61317bf71b
+  data.tar.gz: 3e12747f68ba6071fc766ddfd85c4419edbaed6aa4c1ef6567accdeee1a39c67
+SHA512:
+  metadata.gz: 43fccb41a34c859b6533faa3c33bb3c8a1febdebee3fdfcfcfa36b499571da8ea2abe6133d5d063d481d99c390590f090ea9b0ee814b3af7e3426a40c5908bb1
+  data.tar.gz: 027da432b75fd2e26b7c3673d28334645094bf1368f55ca881a0f03faabe40c5d0623bd4497f645cbb1cb2c38dad952a33ed7f38eddebb82d465c6be06cf4513

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.3

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in wrapped_print.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem 'activesupport'

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    wrapped_print (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  wrapped_print!
+
+BUNDLED WITH
+   2.1.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Igor Kasyanchuk
+
+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,102 @@
+# WrappedPrint
+
+How usually you debug your code? Binding.pry, byebug, puts, ... 
+
+How ofter do you write a code something like:
+
+```ruby
+puts "="*50
+puts current_user.full_name
+puts "="*50
+```
+
+I do this at least few times per week, sometimes per day. 
+
+This is annoying. It's need to be automated. And this gem is a simple solution.
+
+Just add this gem and use a global method `.wp` to see in the console value of your object or wrap code in block with `wp { ... }`.
+
+See screenshot below with examples of usage (gem can be used not only in specs, this is just an example).
+
+[<img src="https://raw.githubusercontent.com/igorkasyanchuk/wrapped_print/main/docs/demo_print.png"
+/>](https://raw.githubusercontent.com/igorkasyanchuk/wrapped_print/main/docs/demo_print.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wrapped_print'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wrapped_print
+
+And then `require "wrapped_print"`
+
+## Usage
+
+You can do a simple configuration to the gem:
+
+```ruby
+WrappedPrint.setup do |config|
+  # config.log_to = :console # simply puts
+  config.log_to = :logs # e.g. Rails.logger.info....
+
+  # # applicable only for Logger (not console)
+  config.level = :debug
+  # config.level = :info
+end
+```
+
+You can print using `puts` or to `Rails.logger`.
+
+Output could be customized with several options:
+
+```ruby
+wp(label = nil, pattern: "-", count: 80, prefix: nil, suffix: nil, color: nil)
+```
+
+For example:
+
+```ruby
+"Demo with color 3".wp("COLORIZED: ", color: :pur, pattern: '*')
+```
+
+or
+
+```ruby
+#
+# see how .wp is called. This method `.wp` returning the original value, so you can use it as normal variable.
+# 
+class A
+  def calc
+    z = balance.wp # same as z = balance
+    100 + 200 + z
+  end
+
+  def balance
+    500
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/igorkasyanchuk/wrapped_print.
+
+
+## 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,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 "wrapped_print"
+
+# 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/lib/wrapped_print.rb

@@ -0,0 +1,78 @@
+require "wrapped_print/version"
+require "active_support"
+
+# WrappedPrint.setup do |config|
+  # config.log_to = :console # simply puts
+  # config.log_to = :logs # e.g. Rails.logger.info....
+
+  # # applicable only for Logger (not console)
+  # config.level = :debug
+  # config.level = :info
+# end
+
+module WrappedPrint
+  mattr_accessor :log_to
+  @@log_to = :console
+
+  mattr_accessor :level
+  @@level = :debug
+
+  def self.setup
+    yield(self)
+  end
+
+  module Main
+    COLORS  = [:none, :red, :green, :dark_blue, :dark_green, :yellow, :blue, :pur]
+    PATTERN = "-"
+    COUNT   = 80
+
+    def wp(label = nil, pattern: PATTERN, count: COUNT, prefix: nil, suffix: nil, color: nil)
+      line          = pattern * count
+      color_method  = detect_color_method(color)
+      logger_method = detect_logger_method
+
+      if block_given?
+        result = yield
+        result.tap do
+          logger_method.call color_method.call "#{prefix}#{line}"
+          logger_method.call color_method.call "#{label}#{result}"
+          logger_method.call color_method.call "#{line}#{suffix}"
+        end
+      else
+        self.tap do
+          logger_method.call color_method.call "#{prefix}#{line}"
+          logger_method.call color_method.call "#{label}#{self}"
+          logger_method.call color_method.call "#{line}#{suffix}"
+        end
+      end
+    end
+
+    alias :__wp__ :wp
+
+    private
+    def detect_logger_method
+      if WrappedPrint.log_to == :logs
+        Rails.logger.method(WrappedPrint.level)
+      else
+        method(:puts)
+      end
+    end
+
+    def detect_color_method(e)
+      raise "Unknown color: #{e}. Only #{COLORS} are available." if e && !COLORS.include?(e.to_sym)
+      method(e || :none)
+    end
+
+    def none(text); text; end
+    def red(text); colorize(text, "\e[1m\e[31m"); end
+    def green(text); colorize(text, "\e[1m\e[32m"); end
+    def dark_green(text); colorize(text, "\e[32m"); end
+    def yellow(text); colorize(text, "\e[1m\e[33m"); end
+    def blue(text); colorize(text, "\e[1m\e[34m"); end
+    def dark_blue(text); colorize(text, "\e[34m"); end
+    def pur(text); colorize(text, "\e[1m\e[35m"); end
+    def colorize(text, color_code)  "#{color_code}#{text}\e[0m" end
+  end
+end
+
+Object.send :include, WrappedPrint::Main

data/lib/wrapped_print/version.rb

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

data/wrapped_print.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/wrapped_print/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wrapped_print"
+  spec.version       = WrappedPrint::VERSION
+  spec.authors       = ["Igor Kasyanchuk"]
+  spec.email         = ["igorkasyanchuk@gmail.com"]
+
+  spec.summary       = %q{Very simple utility to help your with debugging code and print values to console}
+  spec.description   = %q{Very simple utility to help your with debugging code and print values to console}
+  spec.homepage      = "https://github.com/igorkasyanchuk/wrapped_print"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  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_dependency "activesupport"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: wrapped_print
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: Very simple utility to help your with debugging code and print values
+  to console
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docs/demo_print.png
+- lib/wrapped_print.rb
+- lib/wrapped_print/version.rb
+- wrapped_print.gemspec
+homepage: https://github.com/igorkasyanchuk/wrapped_print
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/igorkasyanchuk/wrapped_print
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Very simple utility to help your with debugging code and print values to
+  console
+test_files: []