picture_frame 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*~
+*.bak
+*.orig
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+.rake_t_cache
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in picture_frame.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Schuerig
+
+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,123 @@
+# PictureFrame
+
+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
+
+
+    > 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
+

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose    = true
+end

data/lib/picture_frame/canvas.rb

@@ -0,0 +1,68 @@
+require 'picture_frame/raster'
+
+module PictureFrame
+  class Canvas < Raster
+    def initialize(*dimensions)
+      rows, cols = 0, 0
+      dimensions.each do |r, c|
+        rows += r
+        cols += c
+      end
+
+      raster = (1..rows).inject([]) { |r| r << ' ' * cols }
+      super(raster)
+    end
+
+    def print_at(pos, raster, start = nil, length = nil)
+      case pos
+      when Array
+        overwrite(pos[0], pos[1], raster)
+
+      when :t, :top
+        overwrite(0, make_range(start, length), raster)
+      when :r, :right
+        overwrite(make_range(start, length), width - raster.width, raster)
+      when :b, :bottom
+        overwrite(height - raster.height, make_range(start, length), raster)
+      when :l, :left
+        overwrite(make_range(start, length), 0, raster)
+
+      when :tl, :top_left
+        overwrite(0, 0, raster)
+      when :tr, :top_right
+        overwrite(0, width - raster.width, raster)
+      when :br, :bottom_right
+        overwrite(height - raster.height, width - raster.width, raster)
+      when :bl, :bottom_left
+        overwrite(height - raster.height, 0, raster)
+      end
+    end
+
+    private
+
+    def overwrite(row_pos, col_pos, raster)
+      if row_pos.is_a?(Range)
+        row_pos.each do |r|
+          overwrite(r, col_pos, raster)
+        end
+      elsif col_pos.is_a?(Range)
+        col_pos.each do |c|
+          overwrite(row_pos, c, raster)
+        end
+      else
+        overwrite1(row_pos, col_pos, raster)
+      end
+    end
+
+    def overwrite1(row_pos, col_pos, raster)
+      cols = raster.width
+      raster.each_with_index do |row, r|
+        @raster[row_pos + r][col_pos, cols] = row
+      end
+    end
+
+    def make_range(start, length)
+      start..(start + length - 1)
+    end
+  end
+end

data/lib/picture_frame/frame.rb

@@ -0,0 +1,42 @@
+require 'picture_frame/canvas'
+require 'picture_frame/image'
+require 'picture_frame/stencil'
+
+module PictureFrame
+  class Frame
+    def initialize(template_string, options = {})
+      @template    = Stencil.new(template_string)
+      @placeholder = options[:placeholder] || '@'
+    end
+
+    def frame(text)
+      image = Image.new(text)
+
+      Canvas.new(@template.bottom_right, image.dimensions).tap do |canvas|
+        pp = placeholder_position
+        return '' if pp.empty?
+
+        r1, c1 = pp
+        rn, cm = image.dimensions
+
+        canvas.print_at(:tl, @template.slice_from(pp, :tl))
+        canvas.print_at(:tr, @template.slice_from(pp, :tr))
+        canvas.print_at(:br, @template.slice_from(pp, :br))
+        canvas.print_at(:bl, @template.slice_from(pp, :bl))
+
+        canvas.print_at(:t, @template.slice_from(pp, :t), c1, cm)
+        canvas.print_at(:b, @template.slice_from(pp, :b), c1, cm)
+        canvas.print_at(:l, @template.slice_from(pp, :l), r1, rn)
+        canvas.print_at(:r, @template.slice_from(pp, :r), r1, rn)
+
+        canvas.print_at(pp, image)
+      end.to_s
+    end
+
+    private
+
+    def placeholder_position
+      @placeholder_position ||= @template.position(@placeholder)
+    end
+  end
+end

data/lib/picture_frame/image.rb

@@ -0,0 +1,7 @@
+require 'picture_frame/raster'
+
+module PictureFrame
+  class Image < Raster
+
+  end
+end

data/lib/picture_frame/predefined.rb

@@ -0,0 +1,73 @@
+#encoding: utf-8
+
+module PictureFrame
+  module Predefined
+
+    class << self
+      include Enumerable
+
+      def default
+        TEMPLATES[:default]
+      end
+
+      def named(name)
+        TEMPLATES[name]
+      end
+
+      def random
+        templates = TEMPLATES.values
+        templates[rand(templates.size)]
+      end
+
+      def each(&block)
+        TEMPLATES.keys.each(&block)
+      end
+    end
+
+    TEMPLATES = {
+      :default   => %q{
++---+
+| @ |
++---+
+},
+      :stars     => %q{
+*****
+* @ *
+*****
+},
+      :slashes   => %q{
+///////
+// @ //
+///////
+},
+      :hashes    => %q{
+#####
+# @ #
+#####
+},
+      # FIXME there might be a problem with multibyte chars
+      :ornate    => %q{
+%=---=%
+∥    ∥
+|  @  |
+∥    ∥
+%=---=%
+},
+      :ephemeral => %q{
+⌜   ⌝
+  @
+⌞   ⌟
+},
+      :box       => %q{
+  +-----+
+ /     /|
++-----+ |
+|     | |
+|  @  | |
+|     | +
+|     |/
++-----+
+}
+    }.freeze
+  end
+end

data/lib/picture_frame/raster.rb

@@ -0,0 +1,84 @@
+module PictureFrame
+  class Raster
+    include Enumerable
+
+    def initialize(string_or_rows)
+      @raster = string_or_rows.is_a?(String) ? string_or_rows.split("\n") : string_or_rows
+
+      trim_around!
+      pad_short_rows!
+    end
+
+    def ==(other)
+      return unless other.is_a?(Raster)
+      @raster == other.raster
+    end
+
+    def dimensions
+      @dimensions ||= [@raster.size, (@raster.map { |r| r.length }.max || 0)]
+    end
+
+    def top_left
+      [0, 0]
+    end
+
+    def bottom_right
+      [dimensions[0] - 1, dimensions[1] - 1]
+    end
+
+    def height
+      dimensions[0]
+    end
+
+    def width
+      dimensions[1]
+    end
+
+    def at(row, col)
+      @raster[row][col]
+    end
+
+    alias [] at
+
+    def slice(top_left, bottom_right)
+      top_bottom = (top_left[0]..bottom_right[0])
+      left_right = (top_left[1]..bottom_right[1])
+
+      array = top_bottom.inject([]) do |rows, ri|
+        rows << @raster[ri].slice(left_right)
+      end
+
+      self.class.new(array)
+    end
+
+    def each(&block)
+      @raster.each(&block)
+    end
+
+    def each_with_index(&block)
+      @raster.each_with_index(&block)
+    end
+
+    def to_s
+      @raster.join("\n")
+    end
+
+    protected
+
+    attr_reader :raster
+
+    private
+
+    def trim_around!
+      # trim; extract and add side-trimming
+      @raster.shift while @raster.first && @raster.first.empty?
+      @raster.pop   while @raster.last  && @raster.last.empty?
+    end
+
+    def pad_short_rows!
+      @raster.each do |r|
+        r << ' ' * (width - r.length)
+      end
+    end
+  end
+end

data/lib/picture_frame/stencil.rb

@@ -0,0 +1,43 @@
+  require 'picture_frame/raster'
+
+module PictureFrame
+  class Stencil < Raster
+    def initialize(*)
+      super
+    end
+
+    def position(char)
+      @raster.each_with_index do |row, ri|
+        row.chars.with_index do |cell, ci|
+          return ri, ci if cell == char
+        end
+      end
+      []
+    end
+
+    def slice_from(pos, to)
+      r, c = pos
+      n, m = bottom_right
+
+      case to
+      when :t, :top
+        slice([0, c], [r - 1, c])
+      when :r, :right
+        slice([r, c + 1], [r, m])
+      when :b, :bottom
+        slice([r + 1, c], [n, c])
+      when :l, :left
+        slice([r, 0], [r, c - 1])
+
+      when :tl, :top_left
+        slice([0, 0], [r - 1, c - 1])
+      when :tr, :top_right
+        slice([0, c + 1], [r - 1, m])
+      when :br, :bottom_right
+        slice([r + 1, c + 1], [n, m])
+      when :bl, :bottom_left
+        slice([r + 1, 0], [n, c - 1])
+      end
+    end
+  end
+end

data/lib/picture_frame/version.rb

@@ -0,0 +1,3 @@
+module PictureFrame
+  VERSION = "0.0.1"
+end

data/lib/picture_frame.rb

@@ -0,0 +1,32 @@
+require 'picture_frame/version'
+require 'picture_frame/frame'
+require 'picture_frame/predefined'
+
+module PictureFrame
+  class << self
+
+    def create(frame_spec = nil)
+      case frame_spec
+      when String
+        template = frame_spec
+      when :random
+        template = Predefined.random
+      when Symbol
+        template = Predefined.named(frame_spec)
+      when nil
+        template = Predefined.default
+      end
+      raise ArgumentError, "No such template: #{frame_spec.inspect}" unless template
+      Frame.new(template)
+    end
+
+    def showcase(text)
+      Predefined.each do |name|
+        puts name.inspect
+        puts create(name).frame(text)
+        puts
+      end
+    end
+
+  end
+end

data/picture_frame.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/picture_frame/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael Schuerig"]
+  gem.email         = ["michael@schuerig.de"]
+  gem.description   = %q{Draw pretty frames around text.}
+  gem.summary       = %q{Draw predefined or custom frames around text.}
+  gem.homepage      = "https://github.com/mschuerig/picture_frame"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "picture_frame"
+  gem.require_paths = ["lib"]
+  gem.version       = PictureFrame::VERSION
+end

data/test/canvas_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+require 'picture_frame/canvas'
+
+class CanvasTest < Test::Unit::TestCase
+  def setup
+    @canvas = PictureFrame::Canvas.new([3, 4])
+
+    @corner_stencil     = PictureFrame::Stencil.new("12\nab")
+    @top_bottom_stencil = PictureFrame::Stencil.new("1\na")
+    @left_right_stencil = PictureFrame::Stencil.new("12")
+  end
+
+  def test_dimensions
+    assert_equal [3, 4], @canvas.dimensions
+  end
+
+  def test_print_at_tl
+    @canvas.print_at(:tl, @corner_stencil)
+    assert_equal "12  \nab  \n    ", @canvas.to_s
+  end
+
+  def test_print_at_tr
+    @canvas.print_at(:tr, @corner_stencil)
+    assert_equal "  12\n  ab\n    ", @canvas.to_s
+  end
+
+  def test_print_at_br
+    @canvas.print_at(:br, @corner_stencil)
+    assert_equal "    \n  12\n  ab", @canvas.to_s
+  end
+
+  def test_print_at_bl
+    @canvas.print_at(:bl, @corner_stencil)
+    assert_equal "    \n12  \nab  ", @canvas.to_s
+  end
+
+  def test_print_at_t
+    @canvas.print_at(:t, @top_bottom_stencil, 1, 2)
+    assert_equal " 11 \n aa \n    ", @canvas.to_s
+  end
+
+  def test_print_at_r
+    @canvas.print_at(:r, @left_right_stencil, 1, 1)
+    assert_equal "    \n  12\n    ", @canvas.to_s
+  end
+
+  def test_print_at_b
+    @canvas.print_at(:b, @top_bottom_stencil, 1, 2)
+    assert_equal "    \n 11 \n aa ", @canvas.to_s
+  end
+
+  def test_print_at_l
+    @canvas.print_at(:l, @left_right_stencil, 1, 1)
+    assert_equal "    \n12  \n    ", @canvas.to_s
+  end
+end

data/test/default_frame_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+require 'picture_frame'
+
+class DefaultFrameTest < Test::Unit::TestCase
+  def setup
+    @frame = PictureFrame.create
+  end
+
+  def test_frame
+    expected =<<-FRAMED
++---------------+
+| Hello, World! |
++---------------+
+    FRAMED
+    assert_equal expected.strip, @frame.frame('Hello, World!')
+  end
+
+  def test_multiline
+    expected =<<-FRAMED
++--------+
+| Hello  |
+| World! |
++--------+
+    FRAMED
+    assert_equal expected.strip, @frame.frame("Hello\nWorld!")
+  end
+end

data/test/picture_frame_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class PictureFrameTest < Test::Unit::TestCase
+  def test_empty_template
+    frame = PictureFrame.create('')
+    assert_equal '', frame.frame('Hello, World!')
+  end
+
+  def test_simplistic_template
+    frame = PictureFrame.create('@')
+    assert_equal 'Hello, World!', frame.frame('Hello, World!')
+  end
+
+  def test_horizontal_template
+    frame = PictureFrame.create('- @ -')
+    assert_equal '- Hello, World! -', frame.frame('Hello, World!')
+  end
+
+  def test_vertical_template
+    frame = PictureFrame.create %q{
+^
+@
+v
+}
+    expected = %q{
+^^^^^^^^^^^^^
+Hello, World!
+vvvvvvvvvvvvv
+}
+    assert_equal expected.strip, frame.frame('Hello, World!')
+  end
+end

data/test/raster_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+require 'picture_frame/raster'
+
+class RasterTest < Test::Unit::TestCase
+  def setup
+    @raster = PictureFrame::Raster.new(
+      "abcde\n" +
+      "12345\n" +
+      "vwxyz\n"
+    )
+  end
+
+  def test_dimensions
+    assert_equal [3, 5], @raster.dimensions
+  end
+
+  def test_bottom_right
+    assert_equal [2, 4], @raster.bottom_right
+  end
+
+  def test_at
+    assert_equal '4', @raster[1, 3]
+  end
+
+  def test_slice
+    expected = PictureFrame::Raster.new("bc\n23")
+    assert_equal expected, @raster.slice([0, 1], [1, 2])
+  end
+
+end

data/test/stencil_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+require 'picture_frame/stencil'
+
+class StencilTest < Test::Unit::TestCase
+  def setup
+    @corner_stencil = PictureFrame::Stencil.new(
+      "abcde\n" +
+      "12@45\n" +
+      "qrstu\n" +
+      "vwxyz\n"
+    )
+  end
+
+  def test_position
+    assert_equal [1, 2], @corner_stencil.position('@')
+  end
+
+  def test_slice_from
+    pp = [1, 2]
+
+    assert_slice_equal ['c'],         @corner_stencil.slice_from(pp, :t)
+    assert_slice_equal ['45'],        @corner_stencil.slice_from(pp, :r)
+    assert_slice_equal ['s', 'x'],    @corner_stencil.slice_from(pp, :b)
+    assert_slice_equal ['12'],        @corner_stencil.slice_from(pp, :l)
+
+    assert_slice_equal ['de'],        @corner_stencil.slice_from(pp, :tr)
+    assert_slice_equal ['tu', 'yz'],  @corner_stencil.slice_from(pp, :br)
+    assert_slice_equal ['qr', 'vw'],  @corner_stencil.slice_from(pp, :bl)
+    assert_slice_equal ['ab'],        @corner_stencil.slice_from(pp, :tl)
+  end
+
+  def assert_slice_equal(expected, actual_slice)
+    assert_equal expected, actual_slice.send(:raster)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1 @@
+require 'test/unit'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: picture_frame
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Schuerig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-07 00:00:00.000000000 Z
+dependencies: []
+description: Draw pretty frames around text.
+email:
+- michael@schuerig.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/picture_frame.rb
+- lib/picture_frame/canvas.rb
+- lib/picture_frame/frame.rb
+- lib/picture_frame/image.rb
+- lib/picture_frame/predefined.rb
+- lib/picture_frame/raster.rb
+- lib/picture_frame/stencil.rb
+- lib/picture_frame/version.rb
+- picture_frame.gemspec
+- test/canvas_test.rb
+- test/default_frame_test.rb
+- test/picture_frame_test.rb
+- test/raster_test.rb
+- test/stencil_test.rb
+- test/test_helper.rb
+homepage: https://github.com/mschuerig/picture_frame
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Draw predefined or custom frames around text.
+test_files:
+- test/canvas_test.rb
+- test/default_frame_test.rb
+- test/picture_frame_test.rb
+- test/raster_test.rb
+- test/stencil_test.rb
+- test/test_helper.rb