hirber 0.8.0 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6b4c2b50b223ed2bc25c02e75f8da31092cd5aeeadf45170911cccdc360f018
-  data.tar.gz: d0a324052cf7733e17ccdc73c7257f5a5f1ae47ba1e8846e87815e18f67211df
+  metadata.gz: b1ee5c1edfe858985de14a9f502d2676a4cc7fdd6ee3dd3665b1c2640fc669ef
+  data.tar.gz: 151dc6d1a877c5660dce189f215260d074fed5a6f8a11160967180a18d0f51b4
 SHA512:
-  metadata.gz: c2e6e353265c0f0b870a18388b6ea1fb0a5f91f0cd8ae7e48a8410a4cf9daaba718955a426e8edf5b1f324466366b0046dc53f5930add2061aec0354c3201fbb
-  data.tar.gz: 06500e38016b65255cacf7a269d38ca62dc781f85e90f4c5b5ab9cad179a9c48a9eb0ec2a8fd08ae6e81b54e6a84bcfd69dbba2656e42d85cdb83b136512525c
+  metadata.gz: 894680dbe92e74acaf64dba6c9c9d65160e782840c5bd3645dad991c014a659f462960194cbccabb73b72d32bba2dd4fd90cf2b314b47b34bb4f1d68620c1fb3
+  data.tar.gz: 31179b6027cf78c5e8debf04e199aa797154bbac401e5df9dbef4cd557abea0de9a62c40044dde3718dea9a94f287f4edee8e098734763282ab0bf96f1c12f76

data/.gemspec

@@ -1,21 +1,55 @@
 # -*- 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", "Marz Drel"]
+  s.email       = "marzdrel@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 'bacon', '>= 1.1.0'
-  s.add_development_dependency 'mocha', '~> 0.12.1'
-  s.add_development_dependency 'mocha-on-bacon', '~> 0.2.1'
-  s.add_development_dependency 'bacon-bits'
-  s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc,md} ext/**/*.{rb,c}]) + %w{Rakefile .gemspec .travis.yml}
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pry"
+  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,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,18 @@
+== 0.8.5
+* Fix issues with loading Hirber when using Pry
+
+== 0.8.4
+* Fix version number issues
+
+== 0.8.3
+* Add autoloading support for pry-rails
+
+== 0.8.2
+* Rename entry to hirber.rb to make loading easier.
+
+== 0.8.1
+* Add compatiblity with Ruby 3.0.0
+
 == 0.7.3
 * Remove warnings
 

data/README.md

@@ -0,0 +1,232 @@
+![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)
+which appears to be unmaintained since 2015. New release of Ruby (2.7.2)
+introduced a breaking change into one of the methods in IRB module, which made
+this Gem partially unusable. This fork aims to fix incompatibility. Feel free
+to open PRs if you have any ideas to extend the functionality.
+
+## 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](http://tagaholic.me/2010/02/16/two-dimensional-console-menus-with-hirb.html).
+
+## Install
+
+Install the gem with:
+
+    gem install hirber
+
+For people using full-width unicode characters, install
+[hirb-unicode](https://github.com/miaout17/hirb-unicode):
+
+    gem install hirb-unicode
+
+## View Tutorials
+
+* To create and configure views, see Hirb::View or [here if on the web](http://tagaholic.me/hirb/doc/classes/Hirb/View.html).
+* To create dynamic views, see Hirb::DynamicView or [here if on the web](http://tagaholic.me/hirb/doc/classes/Hirb/DynamicView.html).
+
+## Printing Ascii Tables
+
+To print ascii tables from an array of arrays, hashes or any objects:
+
+    puts Hirb::Helpers::AutoTable.render(ARRAY_OF_OBJECTS)
+
+Hirb will intelligently pick up on field names from an array of hashes and
+create properly-aligned fields from an array of arrays. See
+[here](http://tagaholic.me/2009/10/15/boson-and-hirb-interactions.html#hirbs_handy_tables) for examples.
+
+## Rails Example
+
+Let's load and enable the view framework:
+    $ rails console
+    Loading local environment (Rails 3.0.3)
+    >> require 'hirb'
+    => true
+    >> Hirb.enable
+    => nil
+
+The default configuration provides table views for ActiveRecord::Base
+descendants. If a class isn't configured, Hirb reverts to irb's default echo
+mode.
+    >> Hirb::Formatter.dynamic_config['ActiveRecord::Base']
+    => {:class=>Hirb::Helpers::AutoTable, :ancestor=>true}
+
+    # Tag is a model class and descendant of ActiveRecord::Base
+    >> Tag.last
+    +-----+-------------------------+-------------+---------------+-----------+-----------+-------+
+    | id  | created_at              | description | name          | namespace | predicate | value |
+    +-----+-------------------------+-------------+---------------+-----------+-----------+-------+
+    | 907 | 2009-03-06 21:10:41 UTC |             | gem:tags=yaml | gem       | tags      | yaml  |
+    +-----+-------------------------+-------------+---------------+-----------+-----------+-------+
+    1 row in set
+
+    >> Hirb::Formatter.dynamic_config['String']
+    => nil
+    >> 'plain ol irb'
+    => 'plain ol irb'
+    >> Hirb::Formatter.dynamic_config['Symbol']
+    => nil
+    >> :blah
+    => :blah
+
+From above you can see there are no views configured for a String or a Symbol
+so Hirb defaults to irb's echo mode. On the other hand, Tag has a view thanks
+to being a descendant of ActiveRecord::Base and there being an :ancestor
+option.
+
+Having seen hirb display views based on an output object's class, let's see it
+handle an array of objects:
+
+    >> Tag.all :limit=>3, :order=>"id DESC"
+    +-----+-------------------------+-------------+-------------------+-----------+-----------+----------+
+    | id  | created_at              | description | name              | namespace | predicate | value    |
+    +-----+-------------------------+-------------+-------------------+-----------+-----------+----------+
+    | 907 | 2009-03-06 21:10:41 UTC |             | gem:tags=yaml     | gem       | tags      | yaml     |
+    | 906 | 2009-03-06 08:47:04 UTC |             | gem:tags=nomonkey | gem       | tags      | nomonkey |
+    | 905 | 2009-03-04 00:30:10 UTC |             | article:tags=ruby | article   | tags      | ruby     |
+    +-----+-------------------------+-------------+-------------------+-----------+-----------+----------+
+    3 rows in set
+
+At any time you can disable Hirb if you really like irb's lovely echo mode:
+    >> Hirb.disable
+    => nil
+    >> Tag.all :limit=>3, :order=>"id DESC"
+    => [#<Tag id: 907, name: "gem:tags=yaml", description: nil, created_at: "2009-03-06 21:10:41",
+    namespace: "gem", predicate: "tags", value: "yaml">, #<Tag id: 906, name: "gem:tags=nomonkey",
+    description: nil, created_at: "2009-03-06 08:47:04", namespace: "gem", predicate: "tags", value:
+    "nomonkey">, #<Tag id: 905, name: "article:tags=ruby", description: nil, created_at: "2009-03-04
+    00:30:10", namespace: "article", predicate: "tags", value: "ruby">]
+
+## Views: Anytime, Anywhere
+
+While preconfigured tables are great for database records, sometimes you just
+want to create tables/views for any output object:
+
+    #These examples don't need to have Hirb::View enabled.
+    >> Hirb.disable
+    => nil
+
+    # Imports table() and view()
+    >> extend Hirb::Console
+    => main
+
+    # Create a unicode table
+    >> table [[:a, :b, :c]], :unicode => true
+    ┌───┬───┬───┐
+    │ 0 │ 1 │ 2 │
+    ├───┼───┼───┤
+    │ a ╎ b ╎ c │
+    └───┴───┴───┘
+    1 row in set
+
+    # Creates github-markdown
+    >> table [[:a, :b, :c]], :markdown => true
+    | 0 | 1 | 2 |
+    |---|---|---|
+    | a | b | c |
+
+    # Create a table of Dates comparing them with different formats.
+    >> table [Date.today, Date.today.next_month], :fields=>[:to_s, :ld, :ajd, :amjd, :asctime]
+    +------------+--------+-----------+-------+--------------------------+
+    | to_s       | ld     | ajd       | amjd  | asctime                  |
+    +------------+--------+-----------+-------+--------------------------+
+    | 2009-03-11 | 155742 | 4909803/2 | 54901 | Wed Mar 11 00:00:00 2009 |
+    | 2009-04-11 | 155773 | 4909865/2 | 54932 | Sat Apr 11 00:00:00 2009 |
+    +------------+--------+-----------+-------+--------------------------+
+    2 rows in set
+
+    # Same table as the previous method. However view() will be able to call any helper.
+    >> view [Date.today, Date.today.next_month], :class=>:object_table,
+      :fields=>[:to_s, :ld, :ajd, :amjd, :asctime]
+
+If these console methods weren't convenient enough, try:
+
+    # Imports view() to all objects.
+    >> require 'hirb/import_object'
+    => true
+    # Yields same table as above examples.
+    >> [Date.today, Date.today.next_month].view :class=>:object_table,
+      :fields=>[:to_s, :ld, :ajd, :amjd, :asctime]
+
+Although views by default are printed to STDOUT, they can be easily modified
+to write anywhere:
+    # Setup views to write to file 'console.log'.
+    >> Hirb::View.render_method = lambda {|output| File.open("console.log", 'w') {|f| f.write(output) } }
+
+    # Writes to file with same table output as above example.
+    >> view [Date.today, Date.today.next_month], :class=>:object_table,
+      :fields=>[:to_s, :ld, :ajd, :amjd, :asctime]
+
+    # Doesn't write to file because Symbol doesn't have a view and thus defaults to irb's echo mode.
+    >> :blah
+    => :blah
+
+    # Go back to printing Hirb views to STDOUT.
+    >> Hirb::View.reset_render_method
+
+## Pager
+
+Hirb has both pager and formatter functionality enabled by default. Note - if
+you copy and paste into your ruby console and think that one of your lines
+will kick off the pager, be aware that subsequent characters will go to your
+pager and could cause side effects like saving a file.
+
+If you want to turn off the functionality of either pager or formatter, pass
+that in at startup:
+
+    Hirb.enable :pager=>false
+    Hirb.enable :formatter=>false
+
+or toggle their state at runtime:
+
+    Hirb::View.toggle_pager
+    Hirb::View.toggle_formatter
+
+## Sharing Helpers and Views
+
+If you have tested helpers you'd like to share, fork Hirb and put them under
+lib/hirb/helpers. To share views for certain classes, put them under
+lib/hirb/views. Please submit views for gems that have a nontrivial number of
+users.
+
+## Limitations
+
+If using Wirble and irb, you should call Hirb after it since they both
+override irb's default output.
+
+## Motivation
+
+Table code from http://gist.github.com/72234 and [my console app's needs](http://github.com/cldwalker/tag-tree).
+
+## Credits
+*   Chrononaut for vertical table helper.
+*   janlelis for unicode table helper.
+*   technogeeky and FND for markdown table helper.
+*   hsume2, crafterm, spastorino, xaviershay, bogdan, asanghi, vwall,
+    maxmeyer, jimjh, ddoherty03, rochefort and joshua for patches.
+
+
+## Bugs/Issues
+
+Please report them [on github](http://github.com/cldwalker/hirb/issues).
+
+## Contributing
+[See here](http://tagaholic.me/contributing.html)
+
+## Links
+*   http://tagaholic.me/2009/03/13/hirb-irb-on-the-good-stuff.html
+*   http://tagaholic.me/2009/03/18/ruby-class-trees-rails-plugin-trees-with-hirb.html
+*   http://tagaholic.me/2009/06/19/page-irb-output-and-improve-ri-with-hirb.html
+

data/README.rdoc

@@ -1,4 +1,10 @@
-To read a linked version of this README, {click here}[http://tagaholic.me/hirb/doc/].
+== Preface
+
+This gem is a direct fork of {Hirb}[https://github.com/cldwalker/hirb]
+(0.7.3) which appears to be unmaintained since 2015. New release of Ruby
+(2.7.2) introduced a breaking change into one of the methods in IRB module,
+which made this Gem partially unusable. This fork aims to fix incompatibility.
+Feel free to open PRs if you have any ideas to extend the functionality.
 
 == Description
 

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