helium-console 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9dc5199dab8e2122be6f6601ac154b823a0f0c6a89b2fc52d7ce6e97ddb8122
+  data.tar.gz: 9fd7a98d45dd3e4ee441680a35e2f740f2cd44a01e403d4fa86e86f48a21f30a
+SHA512:
+  metadata.gz: 12758df2c4c32118f8416691d4179ccb53d85f8bc22fd4a46907f09c678f4a5d5fec4cee6df0f33e250d7e6ebf2e8624c453bd5c12eb44be376c949e01c48627
+  data.tar.gz: a2d9e9a75f7005aad6044639b783df65f59ad1bf570154829e51e841d1c74b995e31fceba3055fdb7c00614054717126bee99b56111be370a2f672aa34e0fc7b

data/.byebug_history

@@ -0,0 +1,7 @@
+c
+FFaker::Lorem.sentences(rand(4..10)).count
+FFaker::Lorem.sentences(rand(4..10))
+FFaker::Lorem.sentences
+FFaker::Lorem.sentence
+rand(4..10)
+text

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sklajn@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in helium-console.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "ffaker"
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    helium-console (0.1.0)
+      ruby-terminfo
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    ffaker (2.18.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby-terminfo (0.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  ffaker
+  helium-console!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Stanislaw Klajn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Helium::Console
+
+It is really tricky to display data in the console in the readable and consistent way. Many objects needs to display other objects, which might break their own formatting.
+Helium:Console is to make it easier by formatting strings in accordance to current console size.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'helium-console'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install helium-console
+
+## Usage
+
+Helium::Console helps you to format any string in such a way that it displays nicely in the console:
+
+```
+string = "- Hello there!\nGeneral Kenobi"
+Helium::Console.format(string, indent: 2)
+=> "  - Hello there!\n  General Kenobi"
+```
+
+When executed in a non-console environment `format` simply returns the string.
+
+Supported formattign options:
+
+* `indent` - specifies the amount of spaces added to each new line. Also accepts hash `{first:, other:}`. Defaults to 0.
+* `overflow` - specifies how to handle lines longer than console line width.
+  * `:wrap` - splits the long line into few lines and applies the required indent.
+  * `:wrap_words` - similar to wrap, but will try to avoid breaking the words.
+  * `:none` - does not modify long strings.
+* `max-lines` - specifies how many lines to display. Last line will be truncated with `...`. Defaults to `nil`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/helium-console. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/helium-console/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Helium::Console project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/helium-console/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "helium/console"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/helium-console.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/helium/console/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "helium-console"
+  spec.version       = Helium::Console::VERSION
+  spec.authors       = ["Stanislaw Klajn"]
+  spec.email         = ["sklajn@gmail.com"]
+
+  spec.summary       = "Collection of tools for smooth integration with console"
+  spec.homepage      = "https://github.com/helium-rb/console"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/helium-rb/console"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "ruby-terminfo"
+end

data/lib/helium/console.rb

@@ -0,0 +1,26 @@
+require "helium/console/version"
+
+require "helium/console/formatters/indent"
+require "helium/console/formatters/overflow"
+require "helium/console/formatters/max_lines"
+require "terminfo"
+
+module Helium
+  module Console
+    Error = Class.new(StandardError)
+
+    class << self
+      def format(text, overflow: :wrap, indent: 0, max_lines: nil, max_width: TermInfo.screen_width)
+        formatters = [
+          Formatters::Overflow.get(overflow).new(max_width: max_width - indent),
+          Formatters::Indent.new(indent),
+          Formatters::MaxLines.new(max_lines: max_lines, max_width: max_width)
+        ]
+
+        formatters.inject(text) do |text, formatter|
+          formatter.call(text)
+        end
+      end
+    end
+  end
+end

data/lib/helium/console/formatters/indent.rb

@@ -0,0 +1,15 @@
+module Helium
+  module Console
+    module Formatters
+      class Indent
+        def initialize(indent)
+          @indent = indent
+        end
+
+        def call(string)
+          string.lines.map {|line| ' ' * @indent + line }.join
+        end
+      end
+    end
+  end
+end

data/lib/helium/console/formatters/max_lines.rb

@@ -0,0 +1,22 @@
+module Helium
+  module Console
+    module Formatters
+      class MaxLines
+        ELLIPSES = "..."
+        def initialize(max_lines:, max_width:)
+          @max_lines = max_lines
+          @max_width = max_width
+        end
+
+        def call(string)
+          return string if !@max_lines || string.lines.count <= @max_lines
+
+          lines = string.lines.first(@max_lines)
+          last_line = lines.pop
+          lines << last_line.chars.first(@max_width - ELLIPSES.length).join + ELLIPSES
+          lines.join()
+        end
+      end
+    end
+  end
+end

data/lib/helium/console/formatters/overflow.rb

@@ -0,0 +1,15 @@
+
+module Helium
+  module Console
+    module Formatters
+      module Overflow
+        def self.get(type)
+          require "helium/console/formatters/overflow/#{type}"
+          const_get(type.to_s.split('_').map(&:capitalize).join)
+        rescue
+          raise Error.new("Unknown overflow option: #{type}")
+        end
+      end
+    end
+  end
+end

data/lib/helium/console/formatters/overflow/wrap.rb

@@ -0,0 +1,22 @@
+module Helium
+  module Console
+    module Formatters
+      module Overflow
+        class Wrap
+          def initialize(max_width:)
+            @max_width = max_width
+          end
+
+          def call(string)
+            result = string.lines.flat_map do |line|
+              line.chomp.chars.each_slice(@max_width).map(&:join)
+            end
+            result = result.join($/)
+            result += $/ if string.end_with?($/)
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/helium/console/version.rb

@@ -0,0 +1,5 @@
+module Helium
+  module Console
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: helium-console
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stanislaw Klajn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-terminfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- sklajn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- helium-console.gemspec
+- lib/helium/console.rb
+- lib/helium/console/formatters/indent.rb
+- lib/helium/console/formatters/max_lines.rb
+- lib/helium/console/formatters/overflow.rb
+- lib/helium/console/formatters/overflow/wrap.rb
+- lib/helium/console/version.rb
+homepage: https://github.com/helium-rb/console
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/helium-rb/console
+  source_code_uri: https://github.com/helium-rb/console
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Collection of tools for smooth integration with console
+test_files: []