blab 0.0.1.pre.alpha → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0f2fa8c029f19b494bc57a4fddf76cb8c5b5265e208c7630e1d56cdaf52cb1d
-  data.tar.gz: 16b98eb6a98c16491e650169e4b0bfeea0c6b43b31cfdff9741a2a97443c0c33
+  metadata.gz: 91cbcb0ecff4366f95c0039e94952f5e364d538ecc588060bf33c40262dd4ad4
+  data.tar.gz: e47c8a122f138859de18c66c095d62caf326a613ac1c4bcfd3c5fc5e2358ec8e
 SHA512:
-  metadata.gz: 5b0ce5055f845ad8eeb3cc1daf1c93532cb927e471830413baba7b2b75565d0b91cd6bcdf0d340c352a3e8c2a6fe95bac3e531d74c6ac61a80c462953e1590c5
-  data.tar.gz: da14317d5e95869fbadd1c57d809a8878341dcd6dd6c9c65216c2f8c0d3757cba593b8681ef284f333f85d46aa7bb72c57be440284271f8996f515bd0aa4a334
+  metadata.gz: 9af0cfe4d8f881ba10d4d7297a6fe280d871bdedae5302e27e6b824db9ccd460d264d77a9c3c8d23ca4f3aefb97e8d31ace9b85cfbc21bb2b2b5c7ac3f207925
+  data.tar.gz: 308c1b8edee335be6cd588c8aa59f2266a18a529db07c188a6b89ab1f707d288d50294762c011f6d714aa75077a1fd48f26d2b97cc679eaec4e8bca1d8bf9c73

data/README.md

@@ -3,7 +3,8 @@
 
 A debugging tool.
 
-The gem allows to trace local variables and memory usage for a specific Ruby code. It's rather experemental and is intended for use in a development environment only. \
+The gem allows to trace local variables and memory usage for Ruby code (MRI 2.6+). \
+It's extremely experemental and is intended for use in a development environment only. \
 Blab is inspired by [PySnooper](https://github.com/cool-RR/PySnooper).
 
 
@@ -23,14 +24,12 @@ bundle install
 
 ## Usage
 
-Include `Blab` module and the destionation class and use the `blab` decorator in front of a method defenition.
+Use the `blab` decorator in front of a method defenition.
 
 ```ruby
 require "blab"
 
 class Test
-  include Blab
-
   blab def longest_rep(str)
     max = str.chars.chunk(&:itself).map(&:last).max_by(&:size)
     max ? [max[0], max.size] : ["", 0]
@@ -59,8 +58,6 @@ The gem allows to wrap only a piece of code in a block:
 
 ```ruby
 class Test
-  include Blab
-
   def shuffle(arr)
     for n in 0...arr.size
       targ = n + rand(arr.size - n)
@@ -151,6 +148,11 @@ Blab::Config.output_order = output_order
 ```
 By default it doesn't show current class name and method name. You can adjust the width, change the order, skip/add the desired output info.
 
+## Contribution
+
+Fork & Pull Request. \
+Run the tests via `rake`.
+
 ## License
 
 MIT

data/lib/blab/formatter.rb

@@ -1,18 +1,22 @@
 # frozen_string_literal: true
 
 module Blab
-  module Formatter
-    extend self
-
+  class Formatter
     ELLIPSIS = "..."
-    MAX_LENGTH = 100
+    DEFAULT_MAX_LENGTH = 100
+
+    attr_reader :max_length
+
+    def initialize(max_length = DEFAULT_MAX_LENGTH)
+      @max_length = max_length
+    end
 
     def format(object)
       formatted = prepare_for_inspection(object).inspect
-      return formatted if formatted.length < MAX_LENGTH
+      return formatted if formatted.length < max_length
 
-      beginning = truncate(formatted, 0, MAX_LENGTH / 2)
-      ending = truncate(formatted, -MAX_LENGTH / 2, -1)
+      beginning = truncate(formatted, 0, max_length / 2)
+      ending = truncate(formatted, -max_length / 2, -1)
       "#{beginning}#{ELLIPSIS}#{ending}"
     end
 

data/lib/blab/printer.rb

@@ -1,83 +1,85 @@
 # frozen_string_literal: true
 
-class Printer
-  DEFAULT_CLASS_NAME_WIDTH = 5
-  DEFAULT_CODE_LINES_WIDTH = 120
-  DEFAULT_EVENT_WIDTH = 6
-  DEFAULT_FILE_LINES_WIDTH = 60
-  DEFAULT_RU_MAXSS_WIDTH = 50
-  DEFAULT_METHOD_NAME_WIDTH = 10
-  DEFAULT_TIME_WIDTH = 12
+module Blab
+  class Printer
+    DEFAULT_CLASS_NAME_WIDTH = 5
+    DEFAULT_CODE_LINES_WIDTH = 120
+    DEFAULT_EVENT_WIDTH = 6
+    DEFAULT_FILE_LINES_WIDTH = 60
+    DEFAULT_RU_MAXSS_WIDTH = 50
+    DEFAULT_METHOD_NAME_WIDTH = 10
+    DEFAULT_TIME_WIDTH = 12
 
-  PRINT_FIELDS = [
-    :class_name,
-    :event,
-    :method_name,
-    :time,
-    :ru_maxss
-  ].freeze
+    PRINT_FIELDS = [
+      :class_name,
+      :event,
+      :method_name,
+      :time,
+      :ru_maxss
+    ].freeze
 
-  attr_reader :config, :logger
+    attr_reader :config, :logger
 
-  def initialize(config, logger)
-    @config = config
-    @logger = logger
-  end
-
-  def print(options = {})
-    strings = config.map do |(type, width)|
-      send(type, options.merge(width: width))
+    def initialize(config, logger)
+      @config = config
+      @logger = logger
     end
 
-    config_length = config.length
-    final = strings.map { |e| e.first.length }.max.times.map do |i|
-      config_length.times.map do |j|
-        str =  strings[j][0][i] || ""
-        # TODO: do not ljust the last element
-        config_length == (j + 1) ? str : str.ljust(strings[j][1])
-      end.join(" ")
+    def print(options = {})
+      strings = config.map do |(type, width)|
+        send(type, options.merge(width: width))
+      end
+
+      config_length = config.length
+      final = strings.map { |e| e.first.length }.max.times.map do |i|
+        config_length.times.map do |j|
+          str =  strings[j][0][i] || ""
+          # TODO: do not ljust the last element
+          config_length == (j + 1) ? str : str.ljust(strings[j][1])
+        end.join(" ")
+      end
+      logger.info(final.join("\n"))
     end
-    logger.info(final.join("\n"))
-  end
 
-  def file_lines(options = {})
-    file  = options[:file]
-    line  = options[:line]
-    width = options[:width] || DEFAULT_FILE_LINES_WIDTH
-    ["#{file}:#{line}".scan(/.{#{width}}|.+/), width]
-  end
+    def file_lines(options = {})
+      file  = options[:file]
+      line  = options[:line]
+      width = options[:width] || DEFAULT_FILE_LINES_WIDTH
+      ["#{file}:#{line}".scan(/.{#{width}}|.+/), width]
+    end
 
-  def code_lines(options= {})
-    file  = options[:file]
-    line  = options[:line]
-    width = options[:width] || DEFAULT_CODE_LINES_WIDTH
-    [source_line(file, line).scan(/.{#{width}}|.+/), width]
-  end
+    def code_lines(options= {})
+      file  = options[:file]
+      line  = options[:line]
+      width = options[:width] || DEFAULT_CODE_LINES_WIDTH
+      [source_line(file, line).scan(/.{#{width}}|.+/), width]
+    end
 
-  PRINT_FIELDS.each do |name|
-    define_method(name) do |options = {}|
-      val   = options[name]
-      width = options[:width] || const_get("DEFAULT_#{name.upcase}_WIDTH")
-      [val.scan(/.{#{width}}|.+/), width]
+    PRINT_FIELDS.each do |name|
+      define_method(name) do |options = {}|
+        val   = options[name]
+        width = options[:width] || self.class.const_get("DEFAULT_#{name.upcase}_WIDTH")
+        [val.scan(/.{#{width}}|.+/), width]
+      end
     end
-  end
 
-  def reset_files
-    @files_map && @files_map.keys.each { |key| @files_map.delete(key) }
-  end
+    def reset_files
+      @files_map && @files_map.keys.each { |key| @files_map.delete(key) }
+    end
 
-  def files_map
-    @files_map ||= Hash.new do |h, f|
-      h[f] = File.readlines(f)
+    def files_map
+      @files_map ||= Hash.new do |h, f|
+        h[f] = File.readlines(f)
+      end
     end
-  end
 
-  # TODO: show all relevant file-lines
-  def source_line(file, line)
-    begin
-      files_map[file][line - 1]
-    rescue
-      "source is unavailable"
+    # TODO: show all relevant file-lines
+    def source_line(file, line)
+      begin
+        files_map[file][line - 1]
+      rescue
+        "source is unavailable"
+      end
     end
   end
 end

data/lib/blab/tracer.rb

@@ -58,7 +58,11 @@ module Blab
     end
 
     def formatted_output(key, val)
-      logger.info("Var......... #{key}=#{Blab::Formatter.format(val)}")
+      logger.info("Var......... #{key}=#{formatter.format(val)}")
+    end
+
+    def formatter
+      @formatter ||= Blab::Formatter.new
     end
 
     def defined_vars

data/lib/blab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Blab
-  VERSION = "0.0.1-alpha"
+  VERSION = "0.0.1"
 end

data/lib/blab.rb

@@ -5,11 +5,12 @@ require_relative "blab/config"
 require_relative "blab/formatter"
 require_relative "blab/printer"
 require_relative "blab/tracer"
+require_relative "blab/version"
 
 module Blab
   def self.included(base)
     base.define_singleton_method(:blab) do |name|
-      old_m = base.instance_method(name)
+      old_m = self.instance_method(name)
 
       base.send(:define_method, name) do |*args|
         begin
@@ -33,3 +34,5 @@ module Blab
     end
   end
 end
+
+BasicObject.include(Blab)

data/test/support/test.rb

@@ -3,8 +3,6 @@ require_relative "../../lib/blab"
 require "set"
 
 class Y
-  include Blab
-
   blab def x(name, &block)
     a = 15
     b = 30
@@ -40,8 +38,6 @@ end
 # Blab::Config.original_scope_only = true
 
 class Test
-  include Blab
-
   def shuffle(arr)
     for n in 0...arr.size
       targ = n + rand(arr.size - n)
@@ -57,7 +53,6 @@ class Test
     b.each { |x| shuffle(a); a.each { |y| print y, " ", x, ".\n" } }
   end
 end
-Blab::Config.log_output = "blab.log"
 
 Test.new.pairs(["Bored", "Curious"], ["cat", "frog"])
 

data/test/test_formatter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "blab"
+
+class TestFormatter < Minitest::Test
+  def setup
+    @formatter = Blab::Formatter.new(15)
+  end
+
+  def test_array_formet
+    arr1 = Array.new(3, 5)
+    arr2 = Array.new(100, 10)
+
+    assert_equal @formatter.format(arr1), "[5, 5, 5]"
+    assert_equal @formatter.format(arr2), "[10, 10,... 10, 10]"
+  end
+
+  def test_string_format
+    str1 = "test"
+    str2 = str1 * 50
+
+    assert_equal @formatter.format(str1), "\"test\""
+    assert_equal @formatter.format(str2), "\"testtes...esttest\""
+  end
+
+  def test_hash_format
+    hsh1 = { a: :b }
+    hsh2 = { aaa: :bbbbb, dddd: :ccccccccccc, e: :f }
+
+    assert_equal @formatter.format(hsh1), "{:a=>:b}"
+    assert_equal @formatter.format(hsh2), "{:aaa=>:... :e=>:f}"
+  end
+
+  def test_struct_format
+    person = Struct.new(:name, :age).new("Hanna", 30)
+
+    assert_equal @formatter.format(person), "#<struct... age=30>"
+  end
+end

data/test/test_printer.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "blab"
+
+class TestPrinter < Minitest::Test
+  def setup
+    @logger = Blab::Config.logger
+    @config = [
+      [:time, 12],
+      [:event, 6],
+      [:file_lines, 50],
+      [:class_name, 12],
+      [:method_name, 12],
+      [:ru_maxss, 12],
+      [:code_lines, 120]
+    ]
+    @printer = Blab::Printer.new(@config, @logger)
+  end
+
+  def test_file_lines
+    options = {
+      file: "/test/file.rb",
+      line: 10
+    }
+    expected = [["/test/file.rb:10"], Blab::Printer::DEFAULT_FILE_LINES_WIDTH]
+    assert_equal @printer.file_lines(options), expected
+  end
+
+  def test_extra_file_lines
+    options = {
+      file: "/some/pretty/long/path/to/test/file.rb",
+      line: 10,
+      width: 5
+    }
+    expected = [
+      ["/some", "/pret", "ty/lo", "ng/pa", "th/to", "/test", "/file", ".rb:1", "0"],
+      options[:width]
+    ]
+    assert_equal @printer.file_lines(options), expected
+  end
+
+  def test_method_name
+    options = {
+      method_name: "secret",
+      width: 15
+    }
+    expected = [[options[:method_name]], options[:width]]
+    assert_equal @printer.method_name(options), expected
+  end
+
+  def test_event
+    options = { event: "line" }
+    expected = [[options[:event]], Blab::Printer::DEFAULT_EVENT_WIDTH]
+    assert_equal @printer.event(options), expected
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blab
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.alpha
+  version: 0.0.1
 platform: ruby
 authors:
 - Yulia Oletskaya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-12 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase-ruby_core_source
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
 description: A debugging tool
 email: yulia.oletskaya@gmail.com
 executables: []
@@ -47,6 +61,8 @@ files:
 - lib/blab/tracer.rb
 - lib/blab/version.rb
 - test/support/test.rb
+- test/test_formatter.rb
+- test/test_printer.rb
 homepage: http://rubygems.org/gems/blab
 licenses:
 - MIT
@@ -62,13 +78,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Blab
 test_files:
+- test/test_formatter.rb
+- test/test_printer.rb
 - test/support/test.rb