tty-box 0.2.1 → 0.6.0

data/lib/tty/box/border.rb

@@ -1,40 +1,80 @@
+# frozen_string_literal: true
+
 module TTY
   module Box
     # A class reponsible for retrieving border options
     #
     # @api private
     class Border
+      BORDER_VALUES = [
+        :corner_bottom_right,
+        :corner_top_right,
+        :corner_top_left,
+        :corner_bottom_left,
+        :divider_left,
+        :divider_up,
+        :divider_down,
+        :divider_right,
+        :line,
+        :pipe,
+        :cross
+      ].freeze
+
       def self.parse(border)
         case border
         when Hash
-          new(border.fetch(:type, :light),
-              border.fetch(:top, true),
-              border.fetch(:left, true),
-              border.fetch(:right, true),
-              border.fetch(:bottom, true))
+          new(**border)
         when *TTY::Box::BOX_CHARS.keys
-          new(border, true, true, true, true)
+          new(type: border)
         else
           raise ArgumentError,
                 "Wrong value `#{border}` for :border configuration option"
         end
       end
 
-      attr_reader :type, :top, :left, :right, :bottom
+      attr_reader :type, :top, :top_left, :top_right, :left, :right,
+                  :bottom, :bottom_left, :bottom_right
 
       alias top? top
       alias left? left
       alias right? right
       alias bottom? bottom
+      alias top_left? top_left
+      alias top_right? top_right
+      alias bottom_left? bottom_left
+      alias bottom_right? bottom_right
+
+      def initialize(type: :light,
+                     top: :line,
+                     top_left: :corner_top_left,
+                     top_right: :corner_top_right,
+                     left: :pipe,
+                     right: :pipe,
+                     bottom: :line,
+                     bottom_left: :corner_bottom_left,
+                     bottom_right: :corner_bottom_right)
+
+        @type         = type
+        @top          = check_name(:top, top)
+        @top_left     = check_name(:top_left, top_left)
+        @top_right    = check_name(:top_right, top_right)
+        @left         = check_name(:left, left)
+        @right        = check_name(:right, right)
+        @bottom       = check_name(:bottom, bottom)
+        @bottom_left  = check_name(:bottom_left, bottom_left)
+        @bottom_right = check_name(:bottom_right, bottom_right)
+      end
+
+      private
 
-      def initialize(type, top, left, right, bottom)
-        @type = type
-        @top = top
-        @left = left
-        @right = right
-        @bottom = bottom
+      # Check if border values name is allowed
+      # @api private
+      def check_name(key, value)
+        unless (BORDER_VALUES.include?(:"#{value}") || [true, false].include?(value))
+          raise ArgumentError, "Invalid border value: '#{value}' for #{key.inspect}"
+        end
+        value
       end
     end # Border
   end # Box
 end # TTY
-

data/lib/tty/box/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-box
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -16,118 +16,97 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: tty-cursor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: strings
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Draw various frames and boxes in your terminal interface.
+description: Draw various frames and boxes in the terminal window.
 email:
-- ''
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- examples/commander.rb
 - lib/tty-box.rb
 - 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
-- tty-box.gemspec
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-box/issues
+  changelog_uri: https://github.com/piotrmurach/tty-box/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-box
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/tty-box
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -136,16 +115,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Draw various frames and boxes in your terminal interface.
+summary: Draw various frames and boxes in the terminal window.
 test_files: []

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-desc 'Run all specs'
-task ci: %w[ spec ]
-
-task default: :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "tty/box"
-
-# 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

@@ -1,8 +0,0 @@
-#!/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/examples/commander.rb

@@ -1,52 +0,0 @@
-require 'tty-box'
-
-print TTY::Cursor.clear_screen
-
-box_1 = TTY::Box.frame(
-  top: 2,
-  left: 10,
-  width: 30,
-  height: 10,
-  border: :thick,
-  align: :center,
-  padding: 3,
-  title: {
-    top_left: ' file1 '
-  },
-  style: {
-    fg: :bright_yellow,
-    bg: :blue,
-    border: {
-      fg: :bright_yellow,
-      bg: :blue
-    }
-  }
-) do
-  "Drawing a box in terminal emulator"
-end
-
-box_2 = TTY::Box.frame(
-  top: 8,
-  left: 34,
-  width: 30,
-  height: 10,
-  border: :thick,
-  align: :center,
-  padding: 3,
-  title: {
-    top_left: ' file2 '
-  },
-  style: {
-    fg: :bright_yellow,
-    bg: :blue,
-    border: {
-      fg: :bright_yellow,
-      bg: :blue
-    }
-  }
-) do
-  "Drawing a box in terminal emulator"
-end
-
-puts box_1 + box_2
-print "\n" * 5

data/spec/spec_helper.rb

@@ -1,29 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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

@@ -1,70 +0,0 @@
-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