rasskey 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+*.swp

data/Gemfile

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

data/README.md

@@ -0,0 +1,90 @@
+# RassKey: R(uby) ASCII library
+
+RassKey provides a few simple ASCII helpers for Ruby. Since this is the first release, the current functionality is fairly limited:
+
+ * RassKey::Box
+ * String.to\_box helper
+
+## RassKey::Box
+
+RassKey::Box is a pretty basic ASCII box creator. It was designed to draw a box around a string. The primary use case was simple ASCII Visio-style charts.
+
+Currently RassKey accepts two options describing the box:
+
+ * padding
+ * glyph
+
+These can either be set via an options hash passed to the _draw_ method or as setters:
+
+	>> require 'rasskey'
+	=> true
+	>> mybox = RassKey::Box.new :padding => 10, :glyph => "#"
+	=> #<RassKey::Box:0x7eff41e181f0 @padding=10, @glyph="#">
+	>> puts mybox.draw("This is a sample text")
+	###########################################
+	#                                         #
+	#                                         #
+	#                                         #
+	#                                         #
+	#                                         #
+	#          This is a sample text          #
+	#                                         #
+	#                                         #
+	#                                         #
+	#                                         #
+	#                                         #
+	###########################################
+	>> mybox.padding = 5
+	=> 5
+	>> mybox.glyph = "*"
+	=> "*"
+	>> puts mybox.draw("This is a sample text again")
+	***************************************
+	*                                     *
+	*                                     *
+	*     This is a sample text again     *
+	*                                     *
+	*                                     *
+	***************************************
+
+## String.to\_box
+
+You can also use it as a String method:
+
+	>> require 'rasskey'
+	=> true
+	>> mystr = "foobarbaz"
+	=> "foobarbaz"
+	>> puts mystr.to_box
+	*************
+	* foobarbaz *
+	*************
+	=> nil
+	>> puts mystr.to_box :padding => 12, :glyph => "%"
+	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+	%                                 %
+	%                                 %
+	%                                 %
+	%                                 %
+	%                                 %
+	%                                 %
+	%            foobarbaz            %
+	%                                 %
+	%                                 %
+	%                                 %
+	%                                 %
+	%                                 %
+	%                                 %
+	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+# TODO
+
+ * Tests
+ * Get attr\_accessors working for String helper
+ * Get LICENSE headers and rdoc in place
+ * Work on allowing multi-char glyphs
+ * Word-wrapping for text
+ * Other "shapes"
+ * Custom elements (like say captions)
+ * Draw links between shapes
+ * Some type of canvas and auto-positioning

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/rasskey/box.rb

@@ -0,0 +1,45 @@
+module RassKey
+  class Box
+    class << self
+      attr_accessor :default_padding
+      attr_accessor :default_glyph
+
+    end
+
+    @default_padding = 1
+    @default_glyph = '*'
+
+    attr_accessor :padding
+    attr_accessor :glyph
+
+    def initialize(options = {})
+      options = {
+        :padding => RassKey::Box.default_padding,
+        :glyph => RassKey::Box.default_glyph
+      }.merge(options)
+
+      self.padding = options[:padding]
+      self.glyph = options[:glyph]
+
+      super()
+    end
+
+    def draw(data)
+      @glyph.length == 1 ? (@glyph = @glyph) : (@glyph = @glyph[0,1])
+      whitespace = " " * ( data.length + (@padding * 2) )
+      spacing = " " * @padding || " "
+      content_line = "#{@glyph}#{spacing}#{data}#{spacing}#{@glyph}"
+      top = @glyph * content_line.length
+      side = @glyph 
+      bottom = @glyph * content_line.length
+      box = []
+      box << top
+      (@padding/2).times { box << "#{@glyph}#{whitespace}#{@glyph}" }
+      box << "#{content_line}"
+      (@padding/2).times { box << "#{@glyph}#{whitespace}#{@glyph}" }
+      box << bottom
+      box.join("\n")
+    end
+
+  end
+end

data/lib/rasskey/extensions/string.rb

@@ -0,0 +1,18 @@
+module RassKey #:nodoc:
+  module String #:nodoc:
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :padding
+        attr_accessor :glyph
+      end
+    end
+
+    def to_box(options = {})
+      RassKey::Box.new(options).draw(self)
+    end
+  end
+end
+
+::String.class_eval do
+  include RassKey::String
+end

data/lib/rasskey/version.rb

@@ -0,0 +1,3 @@
+module Rasskey
+  VERSION = "0.0.2"
+end

data/lib/rasskey.rb

@@ -0,0 +1,2 @@
+require 'lib/rasskey/extensions/string'
+require 'lib/rasskey/box'

data/rasskey.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rasskey/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rasskey"
+  s.version     = Rasskey::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["lusis"]
+  s.email       = ["lusis.org+rubygems.org@gmail.com"]
+  s.homepage    = "http://github.com/lusis/rasskey"
+  s.summary     = %q{Small Ruby Library for ASCII drawing}
+  s.description = %q{Small Ruby Library for ASCII drawing}
+
+  s.rubyforge_project = "rasskey"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: rasskey
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- lusis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-27 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Small Ruby Library for ASCII drawing
+email: 
+- lusis.org+rubygems.org@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/rasskey.rb
+- lib/rasskey/box.rb
+- lib/rasskey/extensions/string.rb
+- lib/rasskey/version.rb
+- rasskey.gemspec
+has_rdoc: true
+homepage: http://github.com/lusis/rasskey
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rasskey
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Small Ruby Library for ASCII drawing
+test_files: []
+