hirber 0.8.0 → 0.8.5

data/lib/hirb/helpers/unicode_table.rb

@@ -1,12 +1,35 @@
 # -*- encoding : utf-8 -*-
 class Hirb::Helpers::UnicodeTable < Hirb::Helpers::Table
   CHARS = {
-    :top => {:left => '┌', :center => '┬', :right => '┐', :horizontal => '─',
-      :vertical => {:outside => '│', :inside => '│'} },
-    :middle => {:left => '├', :center => '┼', :right => '┤', :horizontal => '─'},
-    :bottom => {:left => '└', :center => '┴', :right => '┘', :horizontal => '─',
-      :vertical => {:outside => '│', :inside => '╎'} }
-  }
+    :top => {
+      :left => "┌",
+      :center => "┬",
+      :right => "┐",
+      :horizontal => "─",
+      :vertical => {
+        :outside => "│",
+        :inside => "│",
+      },
+    },
+
+    :middle => {
+      :left => "├",
+      :center => "┼",
+      :right => "┤",
+      :horizontal => "─",
+    },
+
+    :bottom => {
+      :left => "└",
+      :center => "┴",
+      :right => "┘",
+      :horizontal => "─",
+      :vertical => {
+        :outside => "│",
+        :inside => "╎",
+      },
+    },
+  }.freeze
 
   # Renders a unicode table
   def self.render(rows, options={})

data/lib/hirb/version.rb

@@ -1,3 +1,3 @@
 module Hirb
-  VERSION = "0.8.0"
+  VERSION = "0.8.5"
 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,20 +187,51 @@ 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
+        end
+
+        if 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
+        end
+
+        if defined?(IRB::Irb)
           @output_method = true
+
           ::IRB::Irb.class_eval do
             alias_method :non_hirb_view_output, :output_value
-            def output_value #:nodoc:
-              Hirb::View.view_or_page_output(@context.last_value) || non_hirb_view_output
+
+            def output_value(omit = false) #:nodoc:
+              Hirb::View.view_or_page_output(@context.last_value) ||
+                original_output_value(omit)
+            end
+
+            # Do not pass the value if the default is given to keep backwards
+            # compatiblity for Ruby =< 2.7.1
+
+            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
         end
       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,63 @@
+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
+
+require "pry"
+
+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,288 @@
+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 "sets up configuration for IRB and Pry if they're both defined" do
+      Hirb.disable
+      expect(Pry.config).to receive(:print=)
+      expect {
+        Hirb.enable
+      }.to change {
+        ::IRB::Irb.instance_method(:output_value) == ::IRB::Irb.instance_method(:non_hirb_view_output)
+      }.from(true).to(false)
+    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
+
+      capture_stderr do
+        expect(Hirb::View.view_output("")).to eq(false)
+      end
+
+      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