puts_debug 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b5045d6b353e5ed671ecd5593e5cca502d7c5b8f50a90e9b476b374e557538f
+  data.tar.gz: 20cdf993397c80391642843b642447b52cc14188609b54ed9b99a8aa7f29e7fb
+SHA512:
+  metadata.gz: a96703aca8706f660e2ffa8f3accf0b54cf923e79a3048389b9e95426d8c0c407df328ffe0cb36c4e88ff5a2f9100a6dc9e5e8802d4169615e110507a595b9b3
+  data.tar.gz: df06601eff1b8812d7ef839039bb4ceafd65ba39aee8760c42d3482019980625c1ed487efc3e74f4a0f29f35783a87285caf5f162f418c39f552d362a72f53aa

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.travis.yml

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

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 oleh.novosad@gmail.com. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in puts_debug.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    puts_debug (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  puts_debug!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Oleh Novosad
+
+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,103 @@
+# PutsDebug
+
+This simple gem adds method pd() to Ruby that helps with puts debugging. 
+I found myself copying this method from project to project that is why I decided to move it to gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puts_debug'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puts_debug
+
+## Usage
+
+Adds method pd (Puts Debugging) to Ruby. Defined in Kernel module which is included into Object class so this method
+is accessible from everywhere. Output is sent to standard error stream (stderr) so it could be further separated
+from standard output like this:
+
+  
+    $ rails s 2>> error
+
+then you can
+
+  
+    $ tail -f error
+  
+ to watch error stream output.
+ 
+ Usage examples: 
+  
+```ruby 
+
+# Method signature: 
+
+def pd(h = {}, line_symbol = nil, show_lines = :both, empty_lines_margin = nil)
+  # ...
+end  
+
+
+pd('something') # => 
+something       
+   
+pd({name: 'Yogurt', calories: 200}) # =>
+name: Yogurt
+calories: 200
+  
+  
+pd(1, '-', :both, 1) #=>
+  
+------------------------------------------------------------
+1
+------------------------------------------------------------
+  
+pd({a: 1, b: 3}, '*', :both, 2) #=>
+ 
+
+************************************************************
+a: 1
+b: 3
+************************************************************
+
+
+pd({a: 1, b: 3}, '=', :top, 1)
+pd('In the midlle')
+pd({c:2, d: 33}, '=', :bottom, 1)  
+#=>
+
+============================================================
+a: 1
+b: 3
+In the midlle
+c: 2
+d: 33
+============================================================
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/puts_debug. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PutsDebug project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/puts_debug/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

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

data/lib/puts_debug.rb

@@ -0,0 +1,61 @@
+require "puts_debug/version"
+
+module Kernel
+
+  ##
+  # For easier puts debugging (pd). Defined in Kernel module which is included into Object class so this method
+  # is accessible from everywhere. Output is sent to standard error stream (stderr) so it could be further separated
+  # from standard output like this:
+  #
+  #   rails s 2>> error
+  #
+  #   then you can
+  #
+  #   tail -f error
+  #
+  #   to watch error stream output.
+  #
+  #   Examples:
+  #
+  #     pd('something') =>
+  #     something
+  #
+  #     pd(name: 'Yogurt') =>
+  #     name: Yogurt
+  #
+  #     pd(1, '-', :both, 1) =>
+  #
+  #     ------------------------------------------------------------
+  #     1
+  #     ------------------------------------------------------------
+  #
+  #     pd({a: 1, b: 3}, '*', :both, 2) =>
+  #
+  #
+  #     ************************************************************
+  #     a: 1
+  #     b: 3
+  #     ************************************************************
+  #
+  #
+  def pd(h = {}, line_symbol = nil, show_lines = :both, empty_lines_margin = nil)
+
+    return unless Rails.env.development?
+
+    $stderr.puts "\n" * empty_lines_margin if empty_lines_margin.present? && show_lines.in?([:both, :top])
+    $stderr.puts (line_symbol * 60) if line_symbol.present? && show_lines.in?([:both, :top])
+
+    if h.is_a? Hash
+      h.each do |k, v|
+        $stderr.puts "#{k}: #{v}"
+      end
+    else
+      $stderr.puts h
+    end
+
+    $stderr.puts line_symbol * 60 if line_symbol.present? && show_lines.in?([:both, :bottom])
+    $stderr.puts "\n" * empty_lines_margin if empty_lines_margin.present? && show_lines.in?([:both, :bottom])
+
+  end
+
+end

data/puts_debug.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "puts_debug/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "puts_debug"
+  spec.version       = PutsDebug::VERSION
+  spec.authors       = ["Oleh Novosad"]
+  spec.email         = ["oleh.novosad@gmail.com"]
+
+  spec.summary       = %q{This simple gem adds method pd() to Ruby that helps with puts debugging}
+  spec.description   = %q{Adds method pd (Puts Debugging) to Ruby. Defined in Kernel module which is included into Object class so this method
+  is accessible from everywhere}
+  spec.homepage      = "https://github.com/izbor/puts_debug"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: puts_debug
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oleh Novosad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  Adds method pd (Puts Debugging) to Ruby. Defined in Kernel module which is included into Object class so this method
+    is accessible from everywhere
+email:
+- oleh.novosad@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/puts_debug.rb
+- lib/puts_debug/version.rb
+- puts_debug.gemspec
+homepage: https://github.com/izbor/puts_debug
+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.7.7
+signing_key: 
+specification_version: 4
+summary: This simple gem adds method pd() to Ruby that helps with puts debugging
+test_files: []