ricecream 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e240fcc9c162e65feccf6a68d1c5c3821e95fddeae647d02b86b5eace9a1c6fc
+  data.tar.gz: fdbe210b294b1a9c98c41783d0e89f6e4411f4572017c12fb1d5a65d1c63d882
+SHA512:
+  metadata.gz: 81e9f4aa536c4c5efc979f713a1beaea3f72055a7c9f06d4fc8053f5da2f75c44887c79e96348424a1a592ef9bf241fa303ac26e31dd1875920fb66754ff8fdd
+  data.tar.gz: 29d22355a67bc956749cf91fcf3a9bdfd07ff493005eaeda2fd05a073e600f6944b15f06613b2a77edf2578a0360d006dc2a96173013c02a7abb52acc352de80

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ricecream.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 nodai2hITC
+
+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,209 @@
+# Ricecream (icecream-ruby)
+
+A Ruby port of Python's debugging library [IceCream](https://github.com/gruns/icecream).
+
+## Usage
+
+### Inspect Variables
+
+Have you ever written code like this to debug?
+
+```ruby
+foo = 123
+puts foo # => 123
+# Simple, but we don't know what the output is.
+
+puts "foo: #{foo}" # => foo: 123
+# Easy to understand, but coding is boring.
+```
+
+With Ricecream, you can easily write:
+
+```ruby
+require "ricecream"
+foo = 123
+ic foo # => ic| foo: 123
+```
+
+It can handle multiple arguments and arbitrary expressions.
+
+```ruby
+ic foo * 2, Integer.sqrt(foo) # => ic| foo * 2: 246, Integer.sqrt(foo): 11
+```
+
+### Inspect Execution
+
+You want to check the operation of the following method.
+
+```ruby
+def foo
+  return if cond1
+  if cond2
+    method1
+  else
+    method2
+  end
+end
+```
+
+Using `puts`, you would write:
+
+```ruby
+def foo
+  puts 1
+  return if cond1
+  puts 2
+  if cond2
+    method1
+    puts 3
+  else
+    method2
+    puts 4
+  end
+end
+```
+
+Output
+
+```
+1
+2
+4
+```
+
+With Ricecream, you can easily write:
+
+```ruby
+def foo
+  ic
+  return if cond1
+  ic
+  if cond2
+    method1
+    ic
+  else
+    method2
+    ic
+  end
+end
+```
+
+Output
+
+```
+ic| script.rb:2 in foo at 17:33:40.227
+ic| script.rb:4 in foo at 17:33:40.227
+ic| script.rb:10 in foo at 17:33:40.228
+```
+
+### Return Value
+
+`ic` returns its argument(s), so `ic` can easily be inserted into pre-existing code.
+
+```ruby
+foo = 123
+def bar(num)
+  num * 2
+end
+result = bar(foo) # I want to know foo value.
+puts result # => 246
+```
+
+```ruby
+foo = 123
+def bar(num)
+  num * 2
+end
+result = bar(ic foo) # => ic| foo: 123
+puts result # => 246
+```
+
+### Refinements
+
+If you want to use `ic` only within a limited scope, then you can use Refinements.
+
+```ruby
+require "ricecream/refine"
+
+using Ricecream
+ic
+```
+
+### Miscellaneous
+
+- `ic_format(*args)` is like `ic` but the output is returned as a string instead of written to stderr.
+- `ic`'s output can be entirely disabled, and later re-enabled, with `Ricecream.disable` and `Ricecream.enable` respectively.
+
+### Configuration
+
+Change prefix.
+
+```ruby
+  Ricecream.prefix = "ic!!!! "
+  # => ic!!!! foo: 123
+
+  def Ricecream.prefix(location)
+    Time.now.to_s + "| "
+  end
+  # => 2021-01-25 23:39:25 +0900| foo: 123
+```
+
+Change the output destination.
+
+```ruby
+  Ricecream.output = STDOUT # default: STDERR
+
+  def Ricecream.output(str)
+    @log ||= Logger.new("logfile.log")
+    @log.debug(str)
+  end
+```
+
+Change the string conversion method.
+
+```ruby
+  def Ricecream.arg_to_s(arg)
+    PP.pp(arg, +"", 60)
+  end
+```
+
+Output with caller information.
+
+```ruby
+  Ricecream.include_context = true # default: false
+  # => ic| script.rb:10 in <main>- foo: 123
+```
+
+(experimental) colorize.
+
+```ruby
+  Ricecream.colorize = true # default: false, required irb >= 1.2.0
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ricecream'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ricecream
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nodai2hITC/ricecream. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nodai2hITC/ricecream/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Ricecream project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nodai2hITC/ricecream/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# 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
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ricecream"
+
+# 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/ricecream.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "ricecream/ic"
+
+module Kernel
+  def ic(*args)
+    Ricecream.ic(caller_locations(1, 1).first, :ic, args)
+    return *args
+  end
+
+  def ic_format(*args)
+    Ricecream.format(caller_locations(1, 1).first, :ic_format, args)
+  end
+
+  private :ic, :ic_format
+end

data/lib/ricecream/analyzer.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "ripper"
+require_relative "ic_method"
+
+module Ricecream
+  class Analyzer < Ripper
+    MethodName = /\Aic(?:_format)?\z/
+
+    def initialize(path)
+      @ic_methods = []
+      @last_loc = [1, 0]
+      @path = File.absolute_path(path)
+      return unless File.exist?(@path)
+      @script = File.binread(@path) + " "
+      super(@script, @path)
+      parse
+      enc = encoding
+      enc = Encoding::UTF_8 if enc == Encoding::ASCII_8BIT
+      @script.force_encoding(enc)
+      @script_lines = @script.lines
+    end
+
+    def ic_methods
+      @ic_methods.select { |ic| ic[:locs].size > 1 }.map do |ic|
+        args = ic[:locs].each_cons(2).map do |locs|
+          byteslice(locs[0], locs[1]).delete_prefix(",").strip.gsub(/\R+/, " ")
+        end
+        ICMethod.new(ic[:name], @path, ic[:lineno], ic[:column], args.size, args)
+      end
+    end
+
+    def byteslice(from, to)
+      return @script_lines[from[0] - 1].byteslice(from[1]...to[1]) if from[0] == to[0]
+
+      str = @script_lines[from[0] - 1][from[1]...-1]
+      (from[0]...(to[0] - 1)).each do |i|
+        str += @script_lines[i]
+      end
+      str += @script_lines[to[0] - 1].byteslice(0...to[1])
+    end
+
+    (PARSER_EVENTS - %i[command vcall method_add_arg]).each do |event|
+      module_eval(<<-End, __FILE__, __LINE__ + 1)
+        def on_#{event}(*args)
+          @token = ""
+          args.unshift [:#{event}, @last_loc]
+          args
+        end
+      End
+    end
+
+    SCANNER_EVENTS.each do |event|
+      module_eval(<<-End, __FILE__, __LINE__ + 1)
+        def on_#{event}(tok)
+          @last_loc = [lineno(), column()]
+          [:@#{event}, tok, @last_loc]
+        end
+      End
+    end
+
+    def on_command(*args)
+      args.unshift [:command, @last_loc]
+      return args unless args.dig(1, 0) == :@ident
+      method_name = args.dig(1, 1)
+      if MethodName === method_name
+        line = args.dig(1, 2, 0)
+        col1 = args.dig(1, 2, 1)
+        col2 = col1 + args.dig(1, 1).length
+        add_method_data(method_name, line, col1, col2, args.dig(2, 1))
+      end
+      args
+    end
+
+    def on_vcall(*args)
+      args.unshift [:vcall, @last_loc]
+      return args unless args.dig(1, 0) == :@ident
+      method_name = args.dig(1, 1)
+      if MethodName === method_name
+        line = args.dig(1, 2, 0)
+        col1 = args.dig(1, 2, 1)
+        col2 = col1 + args.dig(1, 1).length
+        add_method_data(method_name, line, col1, col2, args.dig(2, 1, 1))
+      end
+      args
+    end
+
+    def on_method_add_arg(*args)
+      args.unshift [:method_add_arg, @last_loc]
+      return args unless args.dig(1, 0, 0) == :fcall && args.dig(1, 1, 0) == :@ident
+      method_name = args.dig(1, 1, 1)
+      if MethodName === method_name
+        line = args.dig(1, 1, 2, 0)
+        col1 = args.dig(1, 1, 2, 1)
+        col2 = col1 + args.dig(1, 1, 1).length + 1
+        add_method_data(method_name, line, col1, col2, args.dig(2, 1, 1))
+      end
+      args
+    end
+
+    def add_method_data(name, line, col1, col2, args_add)
+      locs = []
+      while args_add
+        break unless args_add.dig(0, 0) == :args_add
+        locs.unshift args_add.dig(0, 1)
+        args_add = args_add.dig(1)
+      end
+      locs.unshift [line, col2]
+      @ic_methods.push({ name: name.to_sym, lineno: line, column: col1, locs: locs })
+    end
+  end
+end

data/lib/ricecream/colorize.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Ricecream
+  def self.colorize_code(code)
+    return code unless @colorize
+    require "irb"
+    unless defined?(IRB::Color) &&
+           IRB::Color.respond_to?(:colorize_code) &&
+           @output.respond_to?(:tty?) &&
+           @output.tty?
+      return code
+    end
+    IRB::Color.colorize_code(code.to_s)
+  end
+end

data/lib/ricecream/config.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Ricecream
+  @enable = true
+  @prefix = "ic| "
+  @output = STDERR
+  @include_context = false
+  @colorize = false
+
+  module Config
+    def enable
+      @enable = true
+    end
+
+    def disable
+      @enable = false
+    end
+
+    def prefix(location)
+      @prefix
+    end
+
+    def prefix=(value)
+      @prefix = value
+    end
+
+    def output(str)
+      @output.puts str
+    end
+
+    def output=(value)
+      @output = value
+    end
+
+    def arg_to_s(arg)
+      arg.inspect
+    end
+
+    def include_context=(value)
+      @include_context = value
+    end
+
+    def colorize=(value)
+      @colorize = value
+    end
+  end
+
+  extend Config
+end

data/lib/ricecream/ic.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "ic_method"
+require_relative "colorize"
+require_relative "config"
+require_relative "version"
+
+module Ricecream
+  @ic_methods = {}
+
+  def self.ic(location, name, args)
+    output format(location, name, args) if @enable
+  end
+
+  def self.format(location, name, args)
+    str = prefix(location)
+    arity = args.size
+    if arity == 0
+      return "#{str}#{context(location)} at #{Time.now.strftime('%H:%M:%S.%L')}"
+    end
+
+    path = location.absolute_path
+    unless @ic_methods[path]
+      require_relative "analyzer"
+      @ic_methods[path] = Analyzer.new(path).ic_methods
+    end
+
+    lineno = location.lineno
+    method = @ic_methods[path].find do |m|
+      m.lineno == lineno && m.arity == arity && m.name == name
+    end
+
+    str += "#{context(location)}- " if @include_context || !method
+    argstrs = method ? method.args.map { |arg| colorize_code(arg) } :
+                       1.upto(arity).map { |i| "<arg#{i}>" }
+    args = args.map { |arg| colorize_code(arg_to_s(arg)) }
+    argpairs = argstrs.zip(args).map do |argstr, arg|
+      argstr == arg ? argstr : "#{argstr}: #{arg}"
+    end
+    str + argpairs.join(", ")
+  end
+
+  def self.context(location)
+    "#{location.path}:#{colorize_code(location.lineno)} in #{location.label}"
+  end
+end

data/lib/ricecream/ic_method.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ricecream
+  ICMethod = Struct.new("ICMethod", :name, :script, :lineno, :column, :arity, :args)
+end

data/lib/ricecream/refine.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "ic"
+
+module Ricecream
+  refine Kernel do
+    def ic(*args)
+      Ricecream.ic(caller_locations(1, 1).first, :ic, args)
+      return *args
+    end
+
+    def ic_format(*args)
+      Ricecream.format(caller_locations(1, 1).first, :ic_format, args)
+    end
+
+    private :ic, :ic_format
+  end
+end

data/lib/ricecream/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ricecream
+  VERSION = "0.1.0"
+end

data/ricecream.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/ricecream/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ricecream"
+  spec.version       = Ricecream::VERSION
+  spec.authors       = ["nodai2hITC"]
+  spec.email         = ["nodai2h.itc@gmail.com"]
+
+  spec.summary       = "More useful debugging libraries than puts / p"
+  spec.description   = "Never use puts/p to debug again! More useful debugging libraries than puts / p. (A Ruby port of Python's IceCream.)"
+  spec.homepage      = "https://github.com/nodai2hITC/ricecream"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+#  spec.metadata["changelog_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: ricecream
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nodai2hITC
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-28 00:00:00.000000000 Z
+dependencies: []
+description: Never use puts/p to debug again! More useful debugging libraries than
+  puts / p. (A Ruby port of Python's IceCream.)
+email:
+- nodai2h.itc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ricecream.rb
+- lib/ricecream/analyzer.rb
+- lib/ricecream/colorize.rb
+- lib/ricecream/config.rb
+- lib/ricecream/ic.rb
+- lib/ricecream/ic_method.rb
+- lib/ricecream/refine.rb
+- lib/ricecream/version.rb
+- ricecream.gemspec
+homepage: https://github.com/nodai2hITC/ricecream
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nodai2hITC/ricecream
+  source_code_uri: https://github.com/nodai2hITC/ricecream
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: More useful debugging libraries than puts / p
+test_files: []