byebye_pp 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87c897319481bc600c1d4c254d3f17c8b1bcad01abee0ab3bc4ac0b767d5a1a4
+  data.tar.gz: e8f6c21b0b7f38c66e6bd741f92851fbb3589f45d7ca7892c1ea74a1348678e1
+SHA512:
+  metadata.gz: 61d8e7782c67c6c6f7b1c5b0b6fdb687b9fd8e05b4e993358b0e1149a17e9ef304304e15a05309b4a73f23b177047109b726742b9628db2f79a9b3f69097c5e8
+  data.tar.gz: 208850656245d064a9978b93d0da27c95bb54da402e1d1971105a636fc51e25b900163e59bb19f9546af58eb7c2b013d09dd0a6ec6787e8e5411c4413e4f6a06

data/.rubocop.yml

@@ -0,0 +1,356 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+  NewCops: enable
+
+Layout/BeginEndAlignment:
+  Enabled: true
+
+# Align `when` with `end`.
+Layout/CaseIndentation:
+  Enabled: true
+  EnforcedStyle: end
+
+Layout/DefEndAlignment:
+  Enabled: true
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+
+Layout/EmptyLines:
+  Enabled: true
+
+# Ruby coding rule of ESM, inc.
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+  EnforcedStyle: around
+
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
+  Enabled: true
+
+Layout/ExtraSpacing:
+  Enabled: true
+
+Layout/HeredocIndentation:
+  Enabled: true
+
+# Ruby coding rule of ESM, inc.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: normal
+
+Layout/SpaceAroundBlockParameters:
+  Enabled: true
+
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
+Layout/SpaceInLambdaLiteral:
+  Enabled: true
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  SpaceBeforeBlockParameters: true
+  EnforcedStyleForEmptyBraces: no_space
+
+# Ruby coding rule of ESM, inc.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: no_space
+
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: true
+
+Layout/SpaceInsideRangeLiteral:
+  Enabled: true
+
+Layout/SpaceInsideStringInterpolation:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+  DebuggerMethods:
+    # Groups are available so that a specific group can be disabled in
+    # a user's configuration, but are otherwise not significant.
+    Kernel:
+      - binding.irb
+      - p # `p` is an extended config.
+    Byebug:
+      - byebug
+      - remote_byebug
+      - Kernel.byebug
+      - Kernel.remote_byebug
+    Capybara:
+      - save_and_open_page
+      - save_and_open_screenshot
+    PP:
+      - PP.pp # `PP.pp` is an extended config.
+      - pp # `pp` is an extended config.
+    Pry:
+      - binding.pry
+      - binding.remote_pry
+      - binding.pry_remote
+      - Pry.rescue
+    Rails:
+      - debugger
+      - Kernel.debugger
+    WebConsole:
+      - binding.console
+
+Lint/IneffectiveAccessModifier:
+  Enabled: true
+
+Lint/NonAtomicFileOperation:
+  Enabled: true
+
+Lint/OrderedMagicComments:
+  Enabled: true
+
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/RefinementImportMethods:
+  Enabled: true
+
+Lint/SendWithMixinArgument:
+  Enabled: true
+
+Lint/ShadowedArgument:
+  Enabled: true
+
+Lint/Syntax:
+  Enabled: true
+
+Lint/UselessAccessModifier:
+  Enabled: true
+
+Lint/Void:
+  Enabled: true
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: true
+
+Naming/PredicateName:
+  Enabled: true
+
+Style/CommentAnnotation:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: true
+  EnforcedStyle: empty
+  AllowComments: true
+
+Style/EmptyLambdaParameter:
+  Enabled: true
+
+Style/FileRead:
+  Enabled: true
+
+Style/FileWrite:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: true
+
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+
+Style/InverseMethods:
+  Enabled: true
+
+Style/MapToSet:
+  Enabled: true
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: true
+
+Style/MultilineIfThen:
+  Enabled: true
+
+Style/MultilineTernaryOperator:
+  Enabled: true
+
+Style/MultilineWhenThen:
+  Enabled: true
+
+Style/NegatedIf:
+  Enabled: true
+
+Style/NestedTernaryOperator:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    default: ()
+    '%i': '()'
+    '%I': '()'
+    '%r': '||'
+    '%w': '()'
+    '%W': '()'
+
+Style/RedundantArgument:
+  Enabled: true
+
+Style/RedundantArrayConstructor:
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantConstantBase:
+  Enabled: true
+
+Style/RedundantEach:
+  Enabled: true
+
+Style/RedundantDoubleSplatHashBraces:
+  Enabled: true
+
+Style/RedundantFilterChain:
+  Enabled: true
+
+Style/RedundantHeredocDelimiterQuotes:
+  Enabled: true
+
+Style/RedundantInitialize:
+  Enabled: true
+
+Style/RedundantParentheses:
+  Enabled: true
+
+Style/RedundantRegexpArgument:
+  Enabled: true
+
+Style/RedundantRegexpConstructor:
+  Enabled: true
+
+Style/RedundantSort:
+  Enabled: true
+
+Style/SafeNavigation:
+  Enabled: true
+
+Style/SelectByRegexp:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/StringChars:
+  Enabled: true
+
+# Ruby coding rule of ESM, inc.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/SymbolProc:
+  Enabled: true
+  AllowMethodsWithArguments: true
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+
+Style/YAMLFileRead:
+  Enabled: true
+
+RSpec/BeEq:
+  Enabled: true
+
+RSpec/BeNil:
+  Enabled: true
+
+RSpec/EmptyLineAfterExample:
+  Enabled: true
+
+RSpec/EmptyLineAfterExampleGroup:
+  Enabled: true
+
+RSpec/EmptyLineAfterFinalLet:
+  Enabled: true
+
+RSpec/EmptyLineAfterHook:
+  Enabled: true
+
+RSpec/EmptyLineAfterSubject:
+  Enabled: true
+
+RSpec/ExpectChange:
+  Enabled: true
+  EnforcedStyle: block
+
+RSpec/ExcessiveDocstringSpacing:
+  Enabled: true
+
+RSpec/Focus:
+  Enabled: true
+  # Prevents autocorrectoin when developing on LSP.
+  AutoCorrect: false
+
+RSpec/ImplicitBlockExpectation:
+  Enabled: true
+
+RSpec/ImplicitExpect:
+  Enabled: true
+
+RSpec/PredicateMatcher:
+  Enabled: true
+
+RSpec/RepeatedExampleGroupDescription:
+  Enabled: true
+
+RSpec/SpecFilePathFormat:
+  Enabled: true
+
+RSpec/SpecFilePathSuffix:
+  Enabled: true
+
+RSpec/UnspecifiedException:
+  Enabled: true
+
+# Copyright (c) 2023 ESM, Inc
+
+# 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/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-08
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Fu-ga
+
+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,74 @@
+# ByebyePp
+
+ByeByePp is gem for debug.
+
+Are you writing code like the following for debug? If so, this gem will help.
+
+```ruby
+a = 'This is A.'
+b = 10
+c = %w[one two three]
+
+pp '=' * 40
+pp a.class
+pp a.inspect
+
+pp '=' * 40
+pp b.class
+pp b.inspect
+
+.
+.
+```
+
+## Installation
+
+Install the `byebye_pp` gem. `$ gem install byebye_pp` from the command line, or add a line in your Gemfile.
+
+```sh
+$ gem byebye_pp
+```
+
+## Usage
+
+All that remains is to pass the debugging target to the `bbpp` method.
+
+```ruby
+require 'byebye_pp'
+
+a = 'This is A.'
+b = 10
+c = %w[one two three]
+
+bbpp a
+bbpp b
+bbpp c
+```
+
+The following output is obtained by `#bbpp`.
+
+```sh
+========================================
+class: String
+inspect: "This is A."
+========================================
+class: Integer
+inspect: 10
+========================================
+class: Array
+inspect: ["one", "two", "three"]
+```
+
+## 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 the created tag, 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/fugakkbn/byebye_pp.
+
+## 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,16 @@
+# frozen_string_literal: true
+
+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
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i(test rubocop)

data/lib/byebye_pp/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ByebyePp
+  VERSION = '0.1.1'
+end

data/lib/byebye_pp.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'byebye_pp/version'
+
+module ByebyePp
+  def bbpp(obj)
+    text = <<~TEXT
+      #{'=' * 40}
+      class: #{obj.class}
+      inspect: #{obj.inspect}
+    TEXT
+
+    puts text
+  end
+end
+
+Kernel.include ByebyePp

data/sig/byebye_pp.rbs

@@ -0,0 +1,4 @@
+module ByebyePp
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: byebye_pp
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- fugakkbn
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-12 00:00:00.000000000 Z
+dependencies: []
+description: Output the separator line, the variable name of the object and inspections
+  are output.
+email:
+- aax.chiri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/byebye_pp.rb
+- lib/byebye_pp/version.rb
+- sig/byebye_pp.rbs
+homepage: https://github.com/fugakkbn/byebye_pp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fugakkbn/byebye_pp
+  source_code_uri: https://github.com/fugakkbn/byebye_pp
+  changelog_uri: https://github.com/fugakkbn/byebye_pp/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.0.dev
+signing_key:
+specification_version: 4
+summary: byebye_pp makes stdout easier to read.
+test_files: []