tty-box 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9daceddbaca9658a170dde1ce447aebc05af9972015cc71aa003de5e120b2c8
-  data.tar.gz: d9ba3ea634b244a7b6044d1060a1cb38a2164646a6ff7bc9c716000bd49e78cd
+  metadata.gz: 5b0c9524c939271bcc5168d3cc467b790657109218f53284a6328db8173225b8
+  data.tar.gz: cfe75b8c4b2f3567e03bd511ecd5a914fcda3180ab4339fb82412255cfd24206
 SHA512:
-  metadata.gz: b7d43320b77c1edb2164684e90f5a2431e58f48f31838170b20b16349f2d0074c4274fe92348457546bafd2ad29874ca5b889c9c7a40c7271721fa599a0ae2cf
-  data.tar.gz: 422d8dc8a0b7eaa183e2f7db40a3e2c0d89dae5bdfde98181919109bdc86555de82a957f3855fe73338f285d40df118fdf82a2622a87831dc50899ad3e9fcea2
+  metadata.gz: 0c5988a4893aa1c2411429c40d88445ad51a3a3306ecde927125868aa2741686835eabbebe538ea8338639981cf0985318d48e27f586057eb73b492b7797996d
+  data.tar.gz: ce051a4e7751ecd3a8caaa50ff626fb4d7929bdb348025c41ed2324c74cd5b055225112d85bb2ffdb90420d05c36b8308131e4756f652eefb4755781e7bd94bc

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## [v0.2.1] - 2018-09-10
+
+### Fixed
+* Fix content alignment by @DannyBen
+
 ## [v0.2.0] - 2018-07-31
 
 ### Changed
@@ -10,5 +15,6 @@
 
 * Initial implementation and release
 
+[v0.2.1]: https://github.com/piotrmurach/tty-box/compare/v0.2.0...v0.2.1
 [v0.2.0]: https://github.com/piotrmurach/tty-box/compare/v0.1.0...v0.2.0
 [v0.1.0]: https://github.com/piotrmurach/tty-box/compare/v0.1.0

data/README.md

@@ -1,3 +1,7 @@
+<div align="center">
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+</div>
+
 # TTY::Box [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://badge.fury.io/rb/tty-box.svg)][gem]

data/lib/tty/box/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module Box
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end # Box
 end # TTY

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+if ENV['COVERAGE'] || ENV['TRAVIS']
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
+require "bundler/setup"
+require "tty/box"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/unit/align_spec.rb

@@ -0,0 +1,27 @@
+RSpec.describe TTY::Box, ':align option' do
+  it "aligns content without positioning" do
+    box = TTY::Box.frame(width: 26, height: 4, align: :center) do
+      "Drawing a box in terminal emulator"
+    end
+
+    expect(box).to eq([
+      "┌────────────────────────┐\n",
+      "│   Drawing a box in     │\n",
+      "│   terminal emulator    │\n",
+      "└────────────────────────┘\n"
+    ].join)
+  end
+
+  it "aligns content with the option" do
+    box = TTY::Box.frame(top: 0, left: 0, width: 26, height: 4, align: :center) do
+      "Drawing a box in terminal emulator"
+    end
+
+    expect(box).to eq([
+      "\e[1;1H┌────────────────────────┐",
+      "\e[2;1H│   Drawing a box in     \e[2;26H│",
+      "\e[3;1H│   terminal emulator    \e[3;26H│",
+      "\e[4;1H└────────────────────────┘"
+    ].join)
+  end
+end

data/spec/unit/border_spec.rb

@@ -0,0 +1,70 @@
+RSpec.describe TTY::Box, ':border option' do
+  it "creates frame with double lines and no position" do
+    box = TTY::Box.frame(
+      width: 35, height: 4,
+      border: :thick
+    )
+
+    expect(box).to eq([
+      "╔═════════════════════════════════╗\n",
+      "║                                 ║\n",
+      "║                                 ║\n",
+      "╚═════════════════════════════════╝\n"
+    ].join)
+  end
+
+  it "creates frame with double lines" do
+    box = TTY::Box.frame(
+      top: 0, left: 0,
+      width: 35, height: 4,
+      border: :thick
+    )
+
+    expect(box).to eq([
+      "\e[1;1H╔═════════════════════════════════╗",
+      "\e[2;1H║\e[2;35H║",
+      "\e[3;1H║\e[3;35H║",
+      "\e[4;1H╚═════════════════════════════════╝"
+    ].join)
+  end
+
+  it "creates frame with without top & bottom borders" do
+    box = TTY::Box.frame(
+      top: 0, left: 0,
+      width: 35, height: 4,
+      border: {
+        type: :thick,
+        top: false,
+        bottom: false
+      }
+    ) { "Hello Piotr!" }
+
+    expect(box).to eq([
+      "\e[2;1H║Hello Piotr!                     \e[2;35H║",
+      "\e[3;1H║\e[3;35H║",
+    ].join)
+  end
+
+  it "creates frame without left & right borders" do
+    box = TTY::Box.frame(
+      top: 0, left: 0,
+      width: 35, height: 4,
+      border: {
+        left: false,
+        right: false
+      }
+    ) { "Hello Piotr!" }
+
+    expect(box).to eq([
+      "\e[1;1H┌─────────────────────────────────┐",
+      "Hello Piotr!                     ",
+      "\e[4;1H└─────────────────────────────────┘"
+    ].join)
+  end
+
+  it "fails to recognise border option" do
+    expect {
+     TTY::Box.frame(width: 35, height: 4, border: [:unknown])
+    }.to raise_error(ArgumentError, "Wrong value `[:unknown]` for :border configuration option")
+  end
+end

data/spec/unit/frame_spec.rb

@@ -0,0 +1,49 @@
+RSpec.describe TTY::Box, '#frame' do
+  it "creates frame with only  width & height values" do
+    output = TTY::Box.frame(width: 35, height: 4)
+
+    expect(output).to eq([
+      "┌─────────────────────────────────┐\n",
+      "│                                 │\n",
+      "│                                 │\n",
+      "└─────────────────────────────────┘\n"
+    ].join)
+  end
+
+  it "creates frame at a position with direct width & height values" do
+    output = TTY::Box.frame(top: 0, left: 0, width: 35, height: 4)
+
+    expect(output).to eq([
+      "\e[1;1H┌─────────────────────────────────┐",
+      "\e[2;1H│\e[2;35H│",
+      "\e[3;1H│\e[3;35H│",
+      "\e[4;1H└─────────────────────────────────┘"
+    ].join)
+  end
+
+  it "displays content when block provided" do
+    output = TTY::Box.frame(top: 0, left: 0, width: 35, height: 4) do
+      "Hello world!"
+    end
+
+    expect(output).to eq([
+      "\e[1;1H┌─────────────────────────────────┐",
+      "\e[2;1H│Hello world!                     \e[2;35H│",
+      "\e[3;1H│\e[3;35H│",
+      "\e[4;1H└─────────────────────────────────┘"
+    ].join)
+  end
+
+  it "wraps content when exceeding width" do
+    box = TTY::Box.frame(top: 0, left: 0, width: 20, height: 4) do
+      "Drawing a box in terminal emulator"
+    end
+
+    expect(box).to eq([
+      "\e[1;1H┌──────────────────┐",
+      "\e[2;1H│Drawing a box in  \e[2;20H│",
+      "\e[3;1H│terminal emulator \e[3;20H│",
+      "\e[4;1H└──────────────────┘"
+    ].join)
+  end
+end

data/spec/unit/padding_spec.rb

@@ -0,0 +1,46 @@
+RSpec.describe TTY::Box, ':padding option' do
+  it "padds internal content without position arguments" do
+    box = TTY::Box.frame(width: 30, height: 6, padding: 1) do
+      "Drawing a box in terminal emulator"
+    end
+
+    expect(box).to eq([
+      "┌────────────────────────────┐\n",
+      "│                            │\n",
+      "│ Drawing a box in terminal  │\n",
+      "│ emulator                   │\n",
+      "│                            │\n",
+      "└────────────────────────────┘\n"
+    ].join)
+  end
+
+  it "padds internal content with with padding as integer" do
+    box = TTY::Box.frame(top: 0, left: 0, width: 30, height: 6, padding: 1) do
+      "Drawing a box in terminal emulator"
+    end
+
+    expect(box).to eq([
+      "\e[1;1H┌────────────────────────────┐",
+      "\e[2;1H│                            \e[2;30H│",
+      "\e[3;1H│ Drawing a box in terminal  \e[3;30H│",
+      "\e[4;1H│ emulator                   \e[4;30H│",
+      "\e[5;1H│                            \e[5;30H│",
+      "\e[6;1H└────────────────────────────┘"
+    ].join)
+  end
+
+  it "padds internal content with padding as array" do
+    box = TTY::Box.frame(top: 0, left: 0, width: 30, height: 6, padding: [1,3,1,3]) do
+      "Drawing a box in terminal emulator"
+    end
+
+    expect(box).to eq([
+      "\e[1;1H┌────────────────────────────┐",
+      "\e[2;1H│                            \e[2;30H│",
+      "\e[3;1H│   Drawing a box in         \e[3;30H│",
+      "\e[4;1H│   terminal emulator        \e[4;30H│",
+      "\e[5;1H│                            \e[5;30H│",
+      "\e[6;1H└────────────────────────────┘"
+    ].join)
+  end
+end

data/spec/unit/position_spec.rb

@@ -0,0 +1,23 @@
+RSpec.describe TTY::Box, ':top, :left options' do
+  it "skips positioning when no top & left values provided" do
+    output = TTY::Box.frame(width: 35, height: 4)
+
+    expect(output).to eq([
+      "┌─────────────────────────────────┐\n",
+      "│                                 │\n",
+      "│                                 │\n",
+      "└─────────────────────────────────┘\n"
+    ].join)
+  end
+
+  it "allows to absolutely position within the terminal window" do
+    output = TTY::Box.frame(top: 10, left: 40, width: 35, height: 4)
+
+    expect(output).to eq([
+      "\e[11;41H┌─────────────────────────────────┐",
+      "\e[12;41H│\e[12;75H│",
+      "\e[13;41H│\e[13;75H│",
+      "\e[14;41H└─────────────────────────────────┘"
+    ].join)
+  end
+end

data/spec/unit/style_spec.rb

@@ -0,0 +1,31 @@
+RSpec.describe TTY::Box, ":style option" do
+  it "applies styling to content and border" do
+    box = TTY::Box.frame(
+      top: 0,
+      left: 0,
+      width: 30,
+      height: 4,
+      border: :thick,
+      title: {
+        top_left: ' file1 '
+      },
+      style: {
+        fg: :bright_yellow,
+        bg: :blue,
+        border: {
+          fg: :bright_yellow,
+          bg: :blue
+        }
+      }
+    ) do
+      "Midnight Commander\nis the best"
+    end
+
+    expect(box).to eq([
+      "\e[1;1H\e[44m\e[93m╔\e[0m\e[0m\e[44m file1 \e[0m\e[44m\e[93m══════════\e[0m\e[0m\e[44m\e[93m═══════════\e[0m\e[0m\e[44m\e[93m╗\e[0m\e[0m",
+      "\e[2;1H\e[44m\e[93m║\e[0m\e[0m\e[44m\e[93mMidnight Commander          \e[0m\e[0m\e[2;30H\e[44m\e[93m║\e[0m\e[0m",
+      "\e[3;1H\e[44m\e[93m║\e[0m\e[0m\e[44m\e[93mis the best                 \e[0m\e[0m\e[3;30H\e[44m\e[93m║\e[0m\e[0m",
+      "\e[4;1H\e[44m\e[93m╚\e[0m\e[0m\e[44m\e[93m══════════════\e[0m\e[0m\e[44m\e[93m══════════════\e[0m\e[0m\e[44m\e[93m╝\e[0m\e[0m"
+    ].join)
+  end
+end

data/spec/unit/title_spec.rb

@@ -0,0 +1,35 @@
+RSpec.describe TTY::Box, ':title option' do
+  it "allows to specify top border titles"  do
+    output = TTY::Box.frame(
+      top: 0, left: 0,
+      width: 35, height: 4,
+      title: {
+        top_left: 'left',
+        top_right: 'right',
+        top_center: 'center'
+      })
+
+    expect(output).to eq([
+      "\e[1;1H┌left─────────center─────────right┐",
+      "\e[2;1H│\e[2;35H│\e[3;1H│\e[3;35H│",
+      "\e[4;1H└─────────────────────────────────┘"
+    ].join)
+  end
+
+  it "allows to specify bottom border titles"  do
+    output = TTY::Box.frame(
+      top: 0, left: 0,
+      width: 35, height: 4,
+      title: {
+        bottom_left: 'left',
+        bottom_right: 'right',
+        bottom_center: 'center'
+      })
+
+    expect(output).to eq([
+      "\e[1;1H┌─────────────────────────────────┐",
+      "\e[2;1H│\e[2;35H│\e[3;1H│\e[3;35H│",
+      "\e[4;1H└left─────────center─────────right┘"
+    ].join)
+  end
+end

data/tty-box.gemspec

@@ -13,18 +13,15 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://piotrmurach.github.io/tty"
   spec.license       = "MIT"
 
-  spec.files  = Dir.glob('lib/**/*.rb') + Dir.glob('bin/*')
-  spec.files += Dir.glob('examples/*.rb') + Dir.glob('tasks/*.rake')
-  spec.files += Dir.glob('[A-Z]*') + Dir.glob('[a-z]*\.*')
-  spec.files.reject! { |f| f.match(%r{.lock$}) }
-
-  spec.bindir        = "exe"
+  spec.files         = Dir['{lib,spec,examples}/**/*.rb']
+  spec.files        += Dir['{bin,tasks}/*', 'tty-box.gemspec']
+  spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt', 'Rakefile']
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'pastel', '~> 0.7.2'
   spec.add_dependency 'tty-cursor', '~> 0.6.0'
-  spec.add_dependency 'strings', '~> 0.1.1'
+  spec.add_dependency 'strings', '~> 0.1.4'
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-box
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -102,12 +102,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- appveyor.yml
 - bin/console
 - bin/setup
 - examples/commander.rb
@@ -115,6 +112,14 @@ files:
 - lib/tty/box.rb
 - lib/tty/box/border.rb
 - lib/tty/box/version.rb
+- spec/spec_helper.rb
+- spec/unit/align_spec.rb
+- spec/unit/border_spec.rb
+- spec/unit/frame_spec.rb
+- spec/unit/padding_spec.rb
+- spec/unit/position_spec.rb
+- spec/unit/style_spec.rb
+- spec/unit/title_spec.rb
 - tasks/console.rake
 - tasks/coverage.rake
 - tasks/spec.rake

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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 [email]. 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 [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,16 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-gemspec
-
-group :test do
-  gem 'benchmark-ips', '~> 2.7.2'
-  gem 'simplecov', '~> 0.14.1'
-  gem 'coveralls', '~> 0.8.21'
-end
-
-group :metrics do
-  gem 'yard',      '~> 0.9.14'
-  gem 'yardstick', '~> 0.9.9'
-end

data/appveyor.yml

@@ -1,23 +0,0 @@
----
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - ruby --version
-  - gem --version
-  - bundle install
-build: off
-test_script:
-  - bundle exec rake ci
-environment:
-  matrix:
-    - ruby_version: "200"
-    - ruby_version: "200-x64"
-    - ruby_version: "21"
-    - ruby_version: "21-x64"
-    - ruby_version: "22"
-    - ruby_version: "22-x64"
-    - ruby_version: "23"
-    - ruby_version: "23-x64"
-    - ruby_version: "24"
-    - ruby_version: "24-x64"
-    - ruby_version: "25"
-    - ruby_version: "25-x64"