hirber 0.8.2 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f82bfadd2b8b049d1c15f89b451b52ca891af4bff93b81c218f970bf741e5253
-  data.tar.gz: df5d9ac56a1026c4c54e4d50cec1a912459d9a646e1810444575727c04654d98
+  metadata.gz: 0bb901afec50ad8300985c7f84d2a2296c9b8a6478287cbbb4d37fcfa3189a6d
+  data.tar.gz: 1de8e4cb4045f3ceea7bdab47b577d6dd001fe5228ada5bb899893b56a03b5f5
 SHA512:
-  metadata.gz: 71b44ebf48bf2a7198daba593cdca90582a3ba50f1d0f3b907000a798e7c7caa7d062c1fa09346d5d4c93451ff97ce7e4ef3a0774add562be7819a66bc4a6533
-  data.tar.gz: 84f974edc8579002d547eb3c0025faa9285a9fe9c31d730da0294273b12dd5c4e53f0c72162a75489a9ab5da37b1cf8c9d0112f0a5ade8420f8c3e73edfdd500
+  metadata.gz: 3a6d83f529532ed0aed83ab8304a11abb729c667f706fc5b519e8cd0c5d83cc748ead769f9ca3e95fd0a7a6d08b659335e4de36c0f2ea1e4cb8105e5844edc6d
+  data.tar.gz: ed949ee1a4de44b2cf34f47104526516987e88fb5a0d05cde04496c9dcd39063d1a881e0953fe9f7fd9aea44289dc11eac11a90e3eac9c555e0bf9fe7f415b9e

data/.gemspec

@@ -1,23 +1,54 @@
 # -*- encoding: utf-8 -*-
-require 'rubygems' unless Object.const_defined?(:Gem)
+require "rubygems" unless Object.const_defined?(:Gem)
 require File.dirname(__FILE__) + "/lib/hirb/version"
 
 Gem::Specification.new do |s|
   s.name        = "hirber"
   s.version     = Hirb::VERSION
-  s.authors     = ["Gabriel Horner"]
-  s.email       = "gabriel.horner@gmail.com"
+
+  s.authors     = ["Gabriel Horner", "Aleksander Długopolski"]
+  s.email       = "ad@dotpro.org"
   s.homepage    = "http://tagaholic.me/hirb/"
-  s.summary     = "A mini view framework for console/irb that's easy to use, even while under its influence."
-  s.description = "Hirb provides a mini view framework for console applications and uses it to improve ripl(irb)'s default inspect output. Given an object or array of objects, hirb renders a view based on the object's class and/or ancestry. Hirb offers reusable views in the form of helper classes. The two main helpers, Hirb::Helpers::Table and Hirb::Helpers::Tree, provide several options for generating ascii tables and trees. Using Hirb::Helpers::AutoTable, hirb has useful default views for at least ten popular database gems i.e. Rails' ActiveRecord::Base. Other than views, hirb offers a smart pager and a console menu. The smart pager only pages when the output exceeds the current screen size. The menu is used in conjunction with tables to offer two dimensional menus."
+
+  s.summary     = <<~TXT.gsub(/[[:space:]]+/, " ").strip
+    A mini view framework for console/irb that's easy to use, even while under
+    its influence.
+  TXT
+
+  s.description = <<~TXT.gsub(/[[:space:]]+/, " ").strip
+    Hirb provides a mini view framework for console applications and uses
+    it to improve ripl(irb)'s default inspect output. Given an object or
+    array of objects, hirb renders a view based on the object's class and/or
+    ancestry. Hirb offers reusable views in the form of helper classes. The
+    two main helpers, Hirb::Helpers::Table and Hirb::Helpers::Tree,
+    provide several options for generating ascii tables and trees. Using
+    Hirb::Helpers::AutoTable, hirb has useful default views for at least ten
+    popular database gems i.e. Rails' ActiveRecord::Base. Other than views,
+    hirb offers a smart pager and a console menu. The smart pager only pages
+    when the output exceeds the current screen size. The menu is used in
+    conjunction with tables to offer two dimensional menus.
+  TXT
+
   s.required_rubygems_version = ">= 1.3.5"
 
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", ">= 3.9"
   s.add_development_dependency "bacon", "~> 1.1"
   s.add_development_dependency "mocha", "~> 0.12.1"
   s.add_development_dependency "mocha-on-bacon", "~> 0.2.1"
   s.add_development_dependency "bacon-bits", "~> 0.1"
 
-  s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc,md} ext/**/*.{rb,c}]) + %w{Rakefile .gemspec .travis.yml}
+  s.files =
+    Dir.glob %w[
+      {lib,test,spec}/**/*.rb
+      bin/*
+      [A-Z]*.{txt,rdoc,md}
+      ext/**/*.{rb,c}
+      Rakefile
+      .gemspec
+      .travis.yml
+    ]
+
   s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
-  s.license = 'MIT'
+  s.license = "MIT"
 end

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+== 0.8.4
+* Fix version number issues
+
+== 0.8.3
+* Add autoloading support for pry-rails
+
+== 0.8.1
+* Add compatiblity with Ruby 3.0.0
+
 == 0.7.3
 * Remove warnings
 

data/README.md

@@ -1,3 +1,5 @@
+![build passing](https://circleci.com/gh/hirber/hirber.svg?style=svg)
+
 ## Preface
 
 This gem is a direct fork of [Hirb](https://github.com/cldwalker/hirb) (0.7.3)
@@ -23,7 +25,7 @@ size. The menu is used in conjunction with tables to offer [two dimensional menu
 
 Install the gem with:
 
-    gem install hirb
+    gem install hirber
 
 For people using full-width unicode characters, install
 [hirb-unicode](https://github.com/miaout17/hirb-unicode):

data/Rakefile

@@ -1,15 +1,16 @@
-require 'rake'
-require 'fileutils'
+require "rake"
+require "fileutils"
 
 def gemspec
-  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+  @gemspec ||= eval(File.read(".gemspec"), binding, ".gemspec")
 end
 
 desc "Build the gem"
-task :gem=>:gemspec do
+task :gem => :gemspec do
   sh "gem build .gemspec"
-  FileUtils.mkdir_p 'pkg'
-  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
 end
 
 desc "Install the gem locally"
@@ -27,9 +28,14 @@ task :gemspec do
   gemspec.validate
 end
 
-desc 'Run tests'
+desc "Run spec"
+task :spec do
+  sh "rspec"
+end
+
+desc "Run tests"
 task :test do |t|
-  sh 'bacon -q -Ilib -I. test/*_test.rb'
+  sh "bacon -q -Ilib -I. test/*_test.rb"
 end
 
 task :default => :test

data/lib/hirb/version.rb

@@ -1,3 +1,3 @@
 module Hirb
-  VERSION = "0.8.2"
+  VERSION = "0.8.4"
 end

data/lib/hirb/view.rb

@@ -108,17 +108,25 @@ module Hirb
         config[:formatter] = !config[:formatter]
       end
 
-      # Resizes the console width and height for use with the table and pager i.e. after having resized the console window. *nix users
-      # should only have to call this method. Non-*nix users should call this method with explicit width and height. If you don't know
-      # your width and height, in irb play with "a"* width to find width and puts "a\n" * height to find height.
+      # Resizes the console width and height for use with the table and pager
+      # i.e. after having resized the console window. *nix users should only
+      # have to call this method. Non-*nix users should call this method with
+      # explicit width and height. If you don't know your width and height, in
+      # irb play with "a"* width to find width and puts "a\n" * height to find
+      # height.
+
       def resize(width=nil, height=nil)
         config[:width], config[:height] = determine_terminal_size(width, height)
         pager.resize(config[:width], config[:height])
       end
 
-      # This is the main method of this class. When view is enabled, this method searches for a formatter it can use for the output and if
-      # successful renders it using render_method(). The options this method takes are helper config hashes as described in
-      # Hirb::Formatter.format_output(). Returns true if successful and false if no formatting is done or if not enabled.
+      # This is the main method of this class. When view is enabled,
+      # this method searches for a formatter it can use for the output
+      # and if successful renders it using render_method(). The options
+      # this method takes are helper config hashes as described in
+      # Hirb::Formatter.format_output(). Returns true if successful and false
+      # if no formatting is done or if not enabled.
+
       def view_output(output, options={})
         enabled? && config[:formatter] && render_output(output, options)
       rescue Exception=>e
@@ -179,8 +187,18 @@ module Hirb
         if defined?(Ripl) && Ripl.respond_to?(:started?) && Ripl.started?
           @output_method = true
           require 'ripl/hirb' unless defined? Ripl::Hirb
-        elsif defined? IRB::Irb
+
+        elsif defined? Pry
+          original_print = Pry.config.print
+
+          Pry.config.print = proc do |output, result, pry_instance|
+            Hirb::View.view_or_page_output(result) ||
+              original_print.call(output, result, pry_instance)
+          end
+
+        elsif defined?(IRB::Irb)
           @output_method = true
+
           ::IRB::Irb.class_eval do
             alias_method :non_hirb_view_output, :output_value
 
@@ -191,11 +209,14 @@ module Hirb
 
             # Do not pass the value if the default is given to keep backwards
             # compatiblity for Ruby =< 2.7.1
-            def original_output_value(omit)
-              if omit
-                non_hirb_view_output(omit)
-              else
-                non_hirb_view_output
+
+            if !instance_methods(false).include?(:original_output_value)
+              def original_output_value(omit)
+                if omit
+                  non_hirb_view_output(omit)
+                else
+                  non_hirb_view_output
+                end
               end
             end
           end
@@ -203,8 +224,12 @@ module Hirb
       end
 
       def disable_output_method
-        if defined?(IRB::Irb) && !defined? Ripl
-          ::IRB::Irb.send :alias_method, :output_value, :non_hirb_view_output
+        if defined?(IRB::Irb) && !defined?(Ripl)
+          ::IRB::Irb.class_eval do
+            undef output_value
+
+            alias_method :output_value, :non_hirb_view_output
+          end
         end
         @output_method = nil
       end

data/spec/spec_helper.rb

@@ -0,0 +1,61 @@
+module RSpec::Helpers
+  ENV["LINES"] = ENV["COLUMNS"] = "20"
+
+  def reset_config
+    Hirb::View.instance_eval do
+      @config = nil
+    end
+  end
+
+  def capture_stderr(&block)
+    original_stderr = $stderr
+    $stderr = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stderr = original_stderr
+    end
+    fake.string
+  end
+
+  def reset_terminal_size
+    ENV["LINES"] = ENV["COLUMNS"] = "20"
+  end
+end
+
+module ::IRB
+  class Irb
+    def initialize(context)
+      @context = context
+    end
+
+    def output_value; end
+  end
+end
+
+RSpec.configure do |config|
+  include RSpec::Helpers
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.example_status_persistence_file_path = "spec/examples.txt"
+  config.disable_monkey_patching!
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = "doc"
+  end
+
+  config.profile_examples = 5
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/view_spec.rb

@@ -0,0 +1,276 @@
+require "hirber"
+require "spec_helper"
+
+RSpec.describe "Hirb::View" do
+  it "page_output pages when view is enabled" do
+    reset_config
+
+    Hirb.enable
+
+    allow(Hirb::View.pager).to receive_messages(activated_by?: true)
+    expect(Hirb::View.pager).to receive(:page)
+    expect(Hirb::View.page_output("blah")).to be(true)
+
+    Hirb.disable
+  end
+
+  it "page_output doesn't page when view is disabled" do
+    Hirb.enable
+    Hirb.disable
+
+    allow(Hirb::View.pager).to receive_messages(activated_by?: true)
+
+    expect(Hirb::View.pager).not_to receive(:page)
+    expect(Hirb::View.page_output("blah")).to be(false)
+  end
+
+  it "view_output catches unexpected errors and prints them" do
+    reset_config
+
+    Hirb.enable
+
+    allow(::Hirb::View).to receive(:render_output).and_raise("error")
+
+    expect(capture_stderr { Hirb::View.view_output([1,2,3]) })
+      .to match(/Hirb Error: error/)
+
+    Hirb.disable
+  end
+
+  describe "enable" do
+    before { reset_config }
+
+    after { Hirb.disable }
+
+    it "redefines irb output_value" do
+      expect(Hirb::View).to receive(:render_output)
+
+      Hirb.enable
+
+      context_stub = double(last_value: "")
+
+      ::IRB::Irb.new(context_stub).output_value
+    end
+
+    it "is enabled?" do
+      reset_config
+
+      Hirb.enable
+
+      expect(Hirb::View).to be_enabled
+    end
+
+    def output_class_config(klass)
+      { :output=>{klass=>{:class=>:auto_table}} }
+    end
+
+    it "sets formatter config" do
+      class_hash = {"Something::Base"=>{:class=>"BlahBlah"}}
+
+      Hirb.enable :output => class_hash
+
+      expect(Hirb::View.formatter_config["Something::Base"])
+        .to eq class_hash["Something::Base"]
+    end
+
+    it "when called multiple times merges configs" do
+      Hirb.config = nil
+      # default config + config_file
+
+      allow(Hirb)
+        .to receive_messages(
+          read_config_file: output_class_config("Regexp"),
+        )
+
+      Hirb.enable output_class_config("String")
+
+      # add config file and explicit config
+      [{:config_file=>"ok"}, output_class_config("Struct")].each do |config|
+        expect(Hirb)
+          .to receive(:read_config_file)
+          .and_return(
+            output_class_config('ActiveRecord::Base'),
+            output_class_config('Array'),
+          )
+
+        Hirb.enable config
+      end
+
+      expect(Hirb.config_files.include?("ok")).to eq(true)
+
+      output_keys = %w{ActiveRecord::Base Array Regexp String Struct}
+
+      expect(Hirb::View.config[:output].keys.sort).to eq output_keys
+    end
+
+    xit "when called multiple times without config doesn't affect config" do
+      # FIXME: 2021-02-14 - This flapping, spec is order dependant
+
+      Hirb.enable
+
+      old_config = Hirb::View.config
+
+      expect(Hirb).not_to receive(:read_config_file)
+      expect(Hirb::View).not_to receive(:load_config)
+
+      # Hirb.expects(:read_config_file).never
+      # Hirb::View.expects(:load_config).never
+
+      Hirb.enable
+
+      expect(Hirb::View.config).to eq old_config
+    end
+
+    xit "works without irb" do
+      # FIXME: 2021-02-14 - This flapping, spec is order dependant
+
+      allow(Object)
+        .to receive(:const_defined?)
+        .with(:IRB)
+        .and_return(false)
+
+      Hirb.enable
+
+      expect(Hirb::View.formatter.config.size).to be > 1
+    end
+
+    it "with config_file option adds to config_file" do
+      Hirb.enable :config_file => "test_file"
+
+      expect(Hirb.config_files.include?("test_file")).to be(true)
+    end
+
+    it "with ignore_errors enable option" do
+      Hirb.enable :ignore_errors => true
+
+      expect(Hirb::View)
+        .to receive(:render_output)
+        .and_raise(Exception, "Ex mesg")
+        .twice
+
+      expect(Hirb::View.view_output("")).to eq(false)
+
+      expect(capture_stderr { Hirb::View.view_output("") })
+        .to match(/Error: Ex mesg/)
+    end
+  end
+
+  describe "resize" do
+    def pager; Hirb::View.pager; end
+
+    before do
+      Hirb::View.pager = nil
+      reset_config
+      Hirb.enable
+    end
+
+    after { Hirb.disable }
+
+    it "changes width and height with stty" do
+      if RUBY_PLATFORM[/java/]
+        allow(Hirb::Util)
+          .to receive(:command_exists?)
+          .with("tput")
+          .and_returns(false)
+      end
+
+      allow(STDIN)
+        .to receive(:tty?)
+        .and_return(true)
+
+      allow(Hirb::Util)
+        .to receive(:command_exists?)
+        .with("stty")
+        .and_return(true)
+
+      ENV["COLUMNS"] = ENV["LINES"] = nil # bypasses env usage
+
+      capture_stderr { Hirb::View.resize }
+
+      expect(pager.width).not_to eq 10
+      expect(pager.height).not_to eq 10
+
+      reset_terminal_size
+    end
+
+    it "changes width and height with ENV" do
+      ENV["COLUMNS"] = ENV["LINES"] = "10" # simulates resizing
+
+      Hirb::View.resize
+
+      expect(pager.width).to eq 10
+      expect(pager.height).to eq 10
+    end
+
+    it "with no environment or stty still has valid width and height" do
+      Hirb::View.config[:width] = Hirb::View.config[:height] = nil
+
+      unless RUBY_PLATFORM[/java/]
+        allow(Hirb::Util)
+          .to receive(:command_exists?)
+          .with("stty")
+          .and_return(false)
+      end
+
+      ENV["COLUMNS"] = ENV["LINES"] = nil
+
+      Hirb::View.resize
+
+      expect(pager.width.is_a?(Integer)).to eq(true)
+      expect(pager.height.is_a?(Integer)).to eq(true)
+
+      reset_terminal_size
+    end
+  end
+
+  it "disable points output_value back to original output_value" do
+    expect(Hirb::View).not_to receive(:render_output)
+
+    Hirb.enable
+    Hirb.disable
+
+    context_stub = double(:last_value=>"")
+
+    ::IRB::Irb.new(context_stub).output_value
+  end
+
+  it "disable works without irb defined" do
+    # Object.stubs(:const_defined?).with(:IRB).returns(false)
+    allow(Object).to receive(:const_defined?).with(:IRB).and_return(false)
+
+    Hirb.enable
+    Hirb.disable
+
+    expect(Hirb::View.enabled?).to eq(false)
+  end
+
+  it "capture_and_render" do
+    string = "no waaaay"
+
+    # Hirb::View.render_method.expects(:call).with(string)
+    allow(Hirb::View.render_method).to receive(:call).with(string)
+    Hirb::View.capture_and_render { print string }
+  end
+
+  xit "state is toggled by toggle_pager" do
+    # FIXME: 2021-02-14 - This causes other specs to fail
+
+    previous_state = Hirb::View.config[:pager]
+
+    Hirb::View.toggle_pager
+
+    expect(Hirb::View.config[:pager]).not_to eq(previous_state)
+  end
+
+  xit "state is toggled by toggle_formatter" do
+    # FIXME: 2021-02-14 - This causes other specs to fail
+
+    Hirb.enable
+
+    previous_state = Hirb::View.config[:formatter]
+
+    Hirb::View.toggle_formatter
+
+    expect(Hirb::View.config[:formatter]).not_to eq(previous_state)
+  end
+end

data/spec/views_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+require "hirber"
+
+RSpec.describe "activerecord table" do
+  before do
+    Hirb.enable
+  end
+
+  after do
+    Hirb.disable
+  end
+
+  context "with no select" do
+    let(:pet) do
+      double(
+        name: "rufus",
+        age: 7,
+        attributes: { "name" => "rufus", "age" => 7 },
+        class: double(column_names: %w{age name}),
+      )
+    end
+
+    it "gets default options" do
+      expect(Hirb::Helpers::AutoTable.active_record__base_view(pet))
+        .to eq(fields: [:age, :name])
+    end
+  end
+
+  context "with select" do
+    let(:pet) do
+      double(
+        name: "rufus",
+        age: 7,
+        attributes: { "name" => "rufus" },
+        class: double(column_names: %w{age name}),
+      )
+    end
+
+    it "gets default options" do
+      expect(Hirb::Helpers::AutoTable.active_record__base_view(pet))
+        .to eq(fields: [:name])
+    end
+  end
+end
+
+RSpec.describe "mongoid table" do
+  let(:mongoid_stub) { double(class: double(fields: fields)) }
+  let(:fields) { {"_id" => "x0f0x", "name" => "blah"} }
+
+  it "only has one _id" do
+    expect(Hirb::Helpers::AutoTable.mongoid__document_view(mongoid_stub))
+      .to eq(fields: fields.keys.sort)
+  end
+end

data/test/test_helper.rb

@@ -1,12 +1,16 @@
-require 'bacon'
-require 'bacon/bits'
-require 'mocha-on-bacon'
-require 'hirb'
+require "bacon"
+require "bacon/bits"
+require "mocha-on-bacon"
+require "hirber"
+
 include Hirb
 
 module TestHelpers
-  # set these to avoid invoking stty multiple times which doubles test suite running time
+  # set these to avoid invoking stty multiple times which doubles
+  # test suite running time
+
   ENV["LINES"] = ENV["COLUMNS"] = "20"
+
   def reset_terminal_size
     ENV["LINES"] = ENV["COLUMNS"] = "20"
   end

metadata

@@ -1,15 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: hirber
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.4
 platform: ruby
 authors:
 - Gabriel Horner
+- Aleksander Długopolski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-06 00:00:00.000000000 Z
+date: 2021-02-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: bacon
   requirement: !ruby/object:Gem::Requirement
@@ -76,7 +105,7 @@ description: Hirb provides a mini view framework for console applications and us
   offers a smart pager and a console menu. The smart pager only pages when the output
   exceeds the current screen size. The menu is used in conjunction with tables to
   offer two dimensional menus.
-email: gabriel.horner@gmail.com
+email: ad@dotpro.org
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -122,6 +151,9 @@ files:
 - lib/hirb/views/rails.rb
 - lib/hirber.rb
 - lib/ripl/hirb.rb
+- spec/spec_helper.rb
+- spec/view_spec.rb
+- spec/views_spec.rb
 - test/auto_table_test.rb
 - test/console_test.rb
 - test/dynamic_view_test.rb