termichunk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ad131750d4441fca0c07991e20172f31c4e8913
+  data.tar.gz: a8483fbdd3bb0ac4e1b4d1ee82831b012cf7ae6c
+SHA512:
+  metadata.gz: 9b169c877a4180c690d16dc661d710cf8362b4abecbbb9db47da9ccd4c24d83c64ddae769e97435e07f1811865b11ce5055bfe6d9bbfe36dc3e1cae71115b3bb
+  data.tar.gz: 59b24ace38179967425d6e0415b3741b102f342bcea9ed4f54315e3d4e7b515c974348293f145f69bd7b8607f6da1e5b746f8d90afc5f239db8b8f2b382f2513

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: kevinstuffandthings
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add code/outputs to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: kevinstuffandthings
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+Gemfile.lock
+.bundle
+.yardoc
+doc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+- 2.4
+- 2.5
+- 2.6
+script:
+- bundle exec rspec
+deploy:
+  provider: rubygems
+  api_key:
+    secure: jUWa2Jx0HRVv7Dl0zYPTskHQ+RJGy2TUcBWOjyFbBUbeDKiRh8J/NnbMuCOvmL94htSaFk5lcs6k74Itu6jW12+KyT98OAnOardFPFuI0cHHhIMEhF6ms8EhyOCZ0vvR9zav11gfNzyF716qO09DQSDuoKWWNdhrYj8a5paLdbHuRqQiw3YUmnjVQ/v9SPYaZ7ziXC4X4tBxQhK2ujNsNfztSVrpYb6pnsXnt+hFQOnskzi0+er4854iymykeyNVgB71KgivrE3T55ZTXPPglshsZQE7M7FlYA5L3bwzR7SlA202yFYHB3hUN3obwO3BjO4OiAdKQnSosBHaXI13ZvCOz02AfEJhwoxkBXw1/2CvSQ12QQPVgqkpxWY03h+URk+gGHCV+JaqZPCV9excmVWg/IOQou0IJ6h84VFViyVc2aFVN2AIdoaG3NsppbV3j4VuLG6J2VVpNmUzN3pGgi5YSjVq9Hp+huXZFfWpnUgAxc680hKgcFajE3JNANG+NbNEeoDmITvZyV5kvJklgUKPsl2wNk+wY/GGrSBgNOVlyXqTWLZb/8Z/cSrN5DEc6D5BIS/SG95wlCRT8jUqbyEPjT+H77TH2ySfwWZzblLqbIxaLiZr3hX16oMdUx7Cya5LKLFgQBpU6cFUxvZX7SqHwjk1vnuG592Kxd9GkX4=
+  gem: termichunk
+  on:
+    tags: true
+    repo: kevinstuffandthings/termichunk
+  skip_cleanup: 'true'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 kevinstuffandthings@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://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kevin McDonald
+
+MIT License
+
+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,61 @@
+# TermiChunk [![Build Status](https://travis-ci.com/kevinstuffandthings/termichunk.svg?branch=master)](https://travis-ci.com/kevinstuffandthings/termichunk) [![Gem Version](https://badge.fury.io/rb/termichunk.svg)](https://badge.fury.io/rb/termichunk)
+
+Take large chunks of text that might otherwise run together, and organize them neatly within your terminal output.
+
+Originally developed for [Simulmedia](https://simulmedia.com).
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+# update with the version of your choice
+gem 'termichunk'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install termichunk
+```
+
+## Usage
+Create reports. Nest them within each other. Bring sanity to your outputs.
+
+```ruby
+report = TermiChunk::Report.new(title: 'My Report')
+report << 'Line one goes in here'
+report << 'Another line here!'
+puts report
+
+┌─[ My Report ]──────────
+│ Line one goes in here
+│ Another line here!
+└─[ My Report ]──────────
+
+puts(TermiChunk::Report.new(title: 'AMAZING', padding: 1) do |parent|
+  parent << 'I can write some stuff here'
+  parent << report
+end)
+
+┌─[ AMAZING ]────────────────────
+│
+│  I can write some stuff here
+│
+│  ┌─[ My Report ]──────────
+│  │ Line one goes in here
+│  │ Another line here!
+│  └─[ My Report ]──────────
+│
+│
+└─[ AMAZING ]────────────────────
+```
+
+# Problems?
+Please submit an [issue](https://github.com/kevinstuffandthings/termichunk/issues).
+We'll figure out how to get you up and running with TermiChunk as smoothly as possible.

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+Dir.glob('lib/tasks/*.rake').each { |r| load r }

data/lib/termichunk.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require "termichunk/version"
+require "termichunk/report"
+
+# TermiChunk
+module TermiChunk
+end

data/lib/termichunk/report.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+module TermiChunk
+  class Report
+    X = '─'
+    Y = '│'
+    TL = '┌'
+    BL = '└'
+
+    attr_reader :title, :padding, :rows
+
+    def initialize(title:, padding: nil)
+      @title = title
+      @padding = padding || 0
+      @rows = []
+      yield self if block_given?
+    end
+
+    def <<(item)
+      lines = item.to_s.lines
+      if item.is_a?(self.class) && padding.nonzero?
+        buffer = padding.times.map { "\n" }
+        lines = [*buffer, *lines, *buffer]
+      end
+      lines.each { |l| rows << l }
+    end
+
+    def to_s
+      y = padding.times.map { Y }
+      [titlebar(TL), *y, body, *y, titlebar(BL)].compact.join("\n")
+    end
+
+    private
+
+    def body
+      rows.map { |l| "#{Y} #{' ' * padding}#{l.chomp}" }.join("\n")
+    end
+
+    def titlebar(corner)
+      heading = "#{corner}#{X}[ #{title} ]"
+      heading += (X * (width + 2 + (padding * 2) - heading.length))
+      heading
+    end
+
+    def width
+      [rows.map(&:length).max + 2, title.length + 6].max
+    end
+  end
+end

data/lib/termichunk/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module TermiChunk
+  VERSION = "0.0.1"
+end

data/spec/report_spec.rb

@@ -0,0 +1,106 @@
+module TermiChunk
+  describe Report do
+    let(:subject) { described_class.new(title: 'Some Report') }
+    let(:result) { subject.to_s + "\n" }
+
+    it 'can make a narrow report' do
+      subject << 'Line 1'
+      subject << 'Line 2'
+      expect(result).to eq <<~EOF
+        ┌─[ Some Report ]──
+        │ Line 1
+        │ Line 2
+        └─[ Some Report ]──
+      EOF
+    end
+
+    it 'can make a wide report' do
+      subject << 'Line 1 has a whole lot of stuff in it'
+      subject << 'Line 2 has a pretty good amount, too'
+      expect(result).to eq <<~EOF
+        ┌─[ Some Report ]────────────────────────
+        │ Line 1 has a whole lot of stuff in it
+        │ Line 2 has a pretty good amount, too
+        └─[ Some Report ]────────────────────────
+      EOF
+    end
+
+    it 'can make a report that has a report' do
+      subject << "Line 1a\nLine 1b\n"
+      subject << described_class.new(title: 'Sub-report') { |r| r << "Whoa!\nThis is down in there" }
+      expect(result).to eq <<~EOF
+        ┌─[ Some Report ]─────────────
+        │ Line 1a
+        │ Line 1b
+        │ ┌─[ Sub-report ]─────────
+        │ │ Whoa!
+        │ │ This is down in there
+        │ └─[ Sub-report ]─────────
+        └─[ Some Report ]─────────────
+      EOF
+    end
+
+    context 'padding' do
+      let(:contents) { "Line 1 has some stuff in it\nLine 2 has less" }
+      let(:subject) { described_class.new(title: 'Some Report', padding: padding) { |r| r << contents } }
+
+      context '1' do
+        let(:padding) { 1 }
+
+        it 'can make a report with some padding' do
+          expect(result).to eq <<~EOF
+            ┌─[ Some Report ]─────────────────
+            │
+            │  Line 1 has some stuff in it
+            │  Line 2 has less
+            │
+            └─[ Some Report ]─────────────────
+          EOF
+        end
+
+        it 'will vertically pad around a sub-report' do
+          subject << described_class.new(title: 'Sub-report', padding: 2) { |r| r << "Whoa!\nThis is down in there" }
+          subject << 'Yeah'
+          expect(result).to eq <<~EOF
+            ┌─[ Some Report ]───────────────────
+            │
+            │  Line 1 has some stuff in it
+            │  Line 2 has less
+            │  
+            │  ┌─[ Sub-report ]─────────────
+            │  │
+            │  │
+            │  │   Whoa!
+            │  │   This is down in there
+            │  │
+            │  │
+            │  └─[ Sub-report ]─────────────
+            │  
+            │  Yeah
+            │
+            └─[ Some Report ]───────────────────
+          EOF
+        end
+      end
+
+      context '3' do
+        let(:padding) { 3 }
+
+        it 'can make a report with some padding' do
+          expect(result).to eq <<~EOF
+            ┌─[ Some Report ]─────────────────────
+            │
+            │
+            │
+            │    Line 1 has some stuff in it
+            │    Line 2 has less
+            │
+            │
+            │
+            └─[ Some Report ]─────────────────────
+          EOF
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'termichunk'
+
+RSpec.configure do |config|
+  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
+end

data/termichunk.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'termichunk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "termichunk"
+  spec.version       = TermiChunk::VERSION
+  spec.authors       = ["Kevin McDonald"]
+  spec.email         = ["kevinstuffandthings@gmail.com"]
+  spec.summary       = %q{Organize chunks of text within terminals}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/kevinstuffandthings/termichunk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: termichunk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin McDonald
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: pry
+  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: pry-byebug
+  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: rack-test
+  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: rake
+  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: rspec
+  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'
+description: Organize chunks of text within terminals
+email:
+- kevinstuffandthings@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/termichunk.rb
+- lib/termichunk/report.rb
+- lib/termichunk/version.rb
+- spec/report_spec.rb
+- spec/spec_helper.rb
+- termichunk.gemspec
+homepage: https://github.com/kevinstuffandthings/termichunk
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.14
+signing_key:
+specification_version: 4
+summary: Organize chunks of text within terminals
+test_files:
+- spec/report_spec.rb
+- spec/spec_helper.rb