0.0
No commit activity in last 3 years
No release in over 3 years
Draw pretty frames around text.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

 Project Readme

PictureFrame

Build Status Gem Version Coverage Status

Draw predefined or custom frames around text.

Installation

Add this line to your application's Gemfile:

gem 'picture_frame'

And then execute:

$ bundle

Or install it yourself as:

$ gem install picture_frame

Usage

> f = PictureFrame.create
> puts f.frame('Hello, World!')
+---------------+
| Hello, World! |
+---------------+

> f = PictureFrame.create(:stars)
> puts f.frame('Hello, World!')
*****************
* Hello, World! *
*****************

puts PictureFrame.create(:random).frame('Surprise!')
⌜           ⌝
  Surprise!
⌞           ⌟

> f = PictureFrame.create("-- * --", :placeholder => '*')
> puts f.frame('Just a line')
-- Just a line --

Showcase

> PictureFrame.showcase("Hello, World!")
:default
+---------------+
| Hello, World! |
+---------------+

:stars
*****************
* Hello, World! *
*****************

:slashes
///////////////////
// Hello, World! //
///////////////////

:hashes
#################
# Hello, World! #
#################

:ornate
%=---------------=%
∥                 ∥
|  Hello, World!  |
∥                 ∥
%=---------------=%

:ephemeral
⌜               ⌝
  Hello, World!
⌞               ⌟

:box
  +-----------------+
 /                 /|
+-----------------+ |
|                 | |
|  Hello, World!  | |
|                 | +
|                 |/
+-----------------+

> PictureFrame.showcase("Hello\nWorld")
:default
+-------+
| Hello |
| World |
+-------+

:stars
*********
* Hello *
* World *
*********

:slashes
///////////
// Hello //
// World //
///////////

:hashes
#########
# Hello #
# World #
#########

:ornate
%=-------=%
∥         ∥
|  Hello  |
|  World  |
∥         ∥
%=-------=%

:ephemeral
⌜       ⌝
  Hello
  World
⌞       ⌟

:box
  +---------+
 /         /|
+---------+ |
|         | |
|  Hello  | |
|  World  | |
|         | +
|         |/
+---------+

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

TODO

  • Ensure that multibyte characters work properly
  • Support ANSI colors.