hirber 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c748a794d48fe70eaa22e397f0c3dd472b463fc6fa5338fed4704574641c57d4
-  data.tar.gz: b77192021456b45baa5d0c38aa303399030ad65c8ddfa57e2f5c6d67746b3513
+  metadata.gz: f82bfadd2b8b049d1c15f89b451b52ca891af4bff93b81c218f970bf741e5253
+  data.tar.gz: df5d9ac56a1026c4c54e4d50cec1a912459d9a646e1810444575727c04654d98
 SHA512:
-  metadata.gz: df29c0e669504c2ad444a6257802c14591cc82974a48ae9dedb7956a240d7e9dd88fe1bb4857eacee8313c0d8fd6f53e49cd5d94af6ff2d99ecbb620b170f316
-  data.tar.gz: 8f0cfcdd63cfc95e6b844de5fe7320ca1c66ecb85ead1a31c85e33679678b71dc2fa11b279a0d60d9ddd856512c384984d718df0ce84ea7f4e87f33c2babf681
+  metadata.gz: 71b44ebf48bf2a7198daba593cdca90582a3ba50f1d0f3b907000a798e7c7caa7d062c1fa09346d5d4c93451ff97ce7e4ef3a0774add562be7819a66bc4a6533
+  data.tar.gz: 84f974edc8579002d547eb3c0025faa9285a9fe9c31d730da0294273b12dd5c4e53f0c72162a75489a9ab5da37b1cf8c9d0112f0a5ade8420f8c3e73edfdd500

data/.gemspec

@@ -11,10 +11,12 @@ Gem::Specification.new do |s|
   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.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.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.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
   s.license = 'MIT'

data/README.md

@@ -0,0 +1,230 @@
+## 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 hirb
+
+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/lib/hirb/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hirber
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Gabriel Horner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2021-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bacon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: bacon-bits
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 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
@@ -88,10 +88,10 @@ files:
 - CHANGELOG.rdoc
 - CONTRIBUTING.md
 - LICENSE.txt
+- README.md
 - README.rdoc
 - Rakefile
 - lib/bond/completions/hirb.rb
-- lib/hirb.rb
 - lib/hirb/console.rb
 - lib/hirb/dynamic_view.rb
 - lib/hirb/formatter.rb
@@ -120,6 +120,7 @@ files:
 - lib/hirb/views/mongo_db.rb
 - lib/hirb/views/orm.rb
 - lib/hirb/views/rails.rb
+- lib/hirber.rb
 - lib/ripl/hirb.rb
 - test/auto_table_test.rb
 - test/console_test.rb
@@ -156,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A mini view framework for console/irb that's easy to use, even while under