scryglass 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ba13f5c4e89b1e2750fd307557d9093cbc8194fa3696fc314515011322786cf
-  data.tar.gz: 853762f415aada3e416f20beb12b1033620d60747a5ca49c76a1f4ab53af7073
+  metadata.gz: e64cacb2e1c0e588ffa8554c9203f73a5aa11f565454f0e7e190328b18acaaa8
+  data.tar.gz: 4435413405197c4dbf03a80bff4632b29cf09d44b0f53de45894ea426c858091
 SHA512:
-  metadata.gz: c58c3f36b278b03c0ab7105eb7e72eb6ae0db614945623752096ce07e5ca8401b03d3e23761fc79336f335d63d4ee9ef9dc12a3c9ede29121e74cf966124940a
-  data.tar.gz: 1f80a280e9a45cf1407377bf5128c222c4384154b9971992c68b98c8ba02128132d7424c7c12672c4dacf6a22b34616e5630b4ce5b27492580a684e0fb231db8
+  metadata.gz: 2d9081ae5876b542f6c17e792f7a02b12f832a128644e3334c0c6b819dc076fb1a8e60f77e9c02e65032e67e2be52fae38f7ba8b0d38fdfced2bac95469b4ff0
+  data.tar.gz: adbc658b799af3c4167d132de38d3225db3efaba3e95b39251352b0b8360169419db654605fd88314ccbfce80ce3a78d9cb87c02ff55559ce42a483d086848cf

data/.tool-versions

@@ -1 +1 @@
-ruby 2.4.4
+ruby 2.5.3

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2020-09-18
+
+### Added
+
+- add_development_dependency 'io-console'
+- Added table of contents to README
+
+### Changed
+
+- Bumped required_ruby_version from '>= 2.4.4' to '>= 2.5.3'
+- Bumped rake version from '~> 10.0' to '~> 12.0'
+
+## [0.1.0] - 2020-09-17
+
+### Added
+
+- The First Commit!

data/Gemfile

@@ -2,5 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in scryglass.gemspec
 gemspec
-
-gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scryglass (0.1.0)
+    scryglass (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,6 +14,7 @@ GEM
     concurrent-ruby (1.1.7)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
+    io-console (0.5.6)
     minitest (5.14.2)
     rake (12.3.3)
     thread_safe (0.3.6)
@@ -26,6 +27,7 @@ PLATFORMS
 DEPENDENCIES
   activesupport (~> 5.0)
   bundler (~> 2.1)
+  io-console
   rake (~> 12.0)
   scryglass!
 

data/README.md

@@ -1,3 +1,23 @@
+# Table of Contents
+
+[🔮 Scryglass Intro Summary](#-scryglass)
+- [⚡️ tl;dr SUPER Quick Start](#%EF%B8%8F-tldr-super-quick-start)
+- [Installing Scryglass](#installing-scryglass)
+- [Enabling Scryglass](#enabling-scryglass)
+- [Launching a Scry Session](#launching-a-scry-session)
+- [Basic Usage](#basic-usage)
+- [Reading the UI](#reading-the-ui)
+  - [Tree View (default) Row Sample Strings](#tree-view-default-row-sample-strings)
+  - [Known Enumerables](#known-enumerables)
+  - [The Cursor, and Unknown Enumerables](#the-cursor-and-unknown-enumerables)
+  - [Waiting!](#waiting)
+- [In-Depth Control Rundown](#in-depth-control-rundown)
+- [Configuration / Customization (all optional)](#configuration--customization-all-optional)
+  - [A Note on Adding Your Own Lenses](#a-note-on-adding-your-own-lenses)
+  - [Controlling How Some Objects Are Displayed in Tree View / Using Scryglass as the UI for Another Tool](#controlling-how-some-objects-are-displayed-in-tree-view--using-scryglass-as-the-ui-for-another-tool)
+- [Miscellaneous Troubleshooting Notes](#miscellaneous-troubleshooting-notes)
+- [Contributing](#contributing)
+
 # 🔮 Scryglass
 
 Scryglass is a ruby console tool for visualizing and actively exploring objects (large, nested, interrelated, or unfamiliar). You can navigate nested arrays, hashes, instance variables, ActiveRecord
@@ -205,7 +225,7 @@ Here are some explanations of some less obvious configurations:
 
 For properly capturing out*put* methods of various kinds, and for the ability to truncate strings of cosmic scale before they've been *entirely* printed to the invisible IO (can be minutes and trillions of characters), we highly recommend using the `Hexes.capture_io` method with the `char_limit:` keyword argument as seen in the template config file (and Scryglass code). `capture_io` captures console output as a string; `char_limit:` will run the capture in a separate thread which can be truncated before it finishes printing.
 
-## Controlling how some objects are displayed in tree view / Using Scryglass as the UI for another tool
+### Controlling how some objects are displayed in tree view / Using Scryglass as the UI for another tool
 
 Scryglass originally started as a small subtool to be used as the UI for another console project, which, in short, would output a large branching hash which was then to be navigated. To have more control over the tree panel display, you can wrap objects in a Scryglass::ViewWrapper. For example, by default, this array item: `[unsightly_object]` will appear in the tree view in its `inspect`ed form, "#<UnsightlyObject:0x00007f9ac8224e78>". But say you want it to show it's best face to the user, using the sightly return of it's `best_face` method. You can instead hand scryglass the following item:
 ```ruby

data/lib/example_material.rb

@@ -35,7 +35,7 @@ module Scryglass
           "A lambda" => ->(o) { puts o.inspect.upcase.reverse },
           "\n\n\n" => "If you want to know what that lambda does, move your cursor to it, press ENTER, and it will be returned to your console for you to play with!",
           'Allll the coolest stuff' => [
-            Scryglass::ViewWrapper.new('TODO add link', string: '...Is really in the help screens (`?`) and the README. Press spacebar for README link in lens view'),
+            Scryglass::ViewWrapper.new('https://github.com/annkissam/scryglass', string: '...Is really in the help screens (`?`) and the README. Press spacebar for README link in lens view'),
           ],
           :delicious_data => {
             :whoa_now => ([1]*800).map { rand(2) }.insert($stdout.winsize.first, 'Press zero to reset view position, then again to reset cursor there!'),

data/lib/scryglass.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-
 ## Bookkeeping and external tools:
 require "scryglass/version"
 require 'active_support/core_ext/object/blank' # This gives us `.present?` and `.blank?` # https://stackoverflow.com/questions/4648684/how-to-use-present-in-ruby-projects

data/lib/scryglass/version.rb

@@ -1,3 +1,3 @@
 module Scryglass
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/scryglass.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Scryglass::VERSION
   spec.authors       = ["Gavin Myers"]
   spec.email         = ["gavin.myers@annkissam.com"]
+  spec.licenses      = ['MIT']
 
   spec.summary       = 'Scryglass is a ruby console tool for visualizing ' \
     'and actively exploring objects.'
@@ -38,9 +39,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.4.4'
+  spec.required_ruby_version = '>= 2.5.3'
 
   spec.add_development_dependency 'activesupport', '~> 5.0'
+  spec.add_development_dependency 'io-console'
   spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: scryglass
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gavin Myers
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
 date: 2020-09-18 00:00:00.000000000 Z
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: io-console
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 description: |-
   Scryglass is a ruby console tool for visualizing and actively exploring objects (large, nested, interrelated, or unfamiliar). You can navigate nested arrays, hashes, instance variables, ActiveRecord relations, and unknown Enumerable types like anexpandable/collapsable file tree in an intuitive UI.
 
@@ -64,6 +78,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".tool-versions"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -92,10 +107,11 @@ files:
 - lib/scryglass/view_wrapper.rb
 - scryglass.gemspec
 homepage: https://github.com/annkissam/scryglass
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -103,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.4
+      version: 2.5.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -111,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Scryglass is a ruby console tool for visualizing and actively exploring objects.
 test_files: []