squarecoder 0.0.0 → 0.0.1

data/README.rdoc

@@ -1,6 +1,17 @@
 = squarecoder
 
-Squarecoder encapsulates a Transcoder singleton that encodes and decodes a string using the {square code}[link:http://users.csc.calpoly.edu/~jdalbey/103/Projects/ProgrammingPractice.html] method. You will also find two new String methods: String.square_encode and String.square_decode.
+Squarecoder encapsulates a Squarecoder::Transcoder singleton that encodes and decodes a string using the {square code}[link:http://users.csc.calpoly.edu/~jdalbey/103/Projects/ProgrammingPractice.html] method. You will also find two new String methods: String.square_encode and String.square_decode.
+
+== Installation
+
+  $ gem install squarecoder
+  
+Or
+
+  # in Gemfile
+  gem 'squarecoder'
+	
+  $ bundle install
 
 == Examples
 

data/lib/squarecoder/core_ext/string.rb

@@ -1,5 +1,16 @@
 class String
   
+  # Convert a String to a Grouped array of Characters of a specific length
+  # 
+  # Example:
+  # 
+  #   "abcdefgh".in_character_arrays_of_length(3) # => [["a","b","c"],["d","e","f"],["g","h"]]
+  # 
+  # Returns an Array.
+  def in_character_arrays_of_length( length )
+    scan( /./ ).each_slice( length ).to_a
+  end
+  
   # Encode a String
   def square_encode
     dup.square_encode!

data/lib/squarecoder/errors.rb

@@ -1,4 +1,7 @@
 module Squarecoder
-  class InputTooLongError < StandardError # :nodoc:
+  class InputTooLong < StandardError # :nodoc:
+  end
+  
+  class NoWhitespace < StandardError # :nodoc:
   end
 end

data/lib/squarecoder/transcoder.rb

@@ -2,6 +2,8 @@ module Squarecoder
   
   # A Transcoder is a Singleton used to encode and decode strings.
   # 
+  # Examples
+  # 
   #   Squarecoder::Transcoder.encode("haveaniceday") # => "hae and via ecy"
   #   Squarecoder::Transcoder.decode("hae and via ecy") # => "haveaniceday"
   #   "haveaniceday".square_encode # => "hae and via ecy"
@@ -11,20 +13,24 @@ module Squarecoder
     include Singleton
     
     # Encode a String in square code
-    def self.encode a_string
-      this_string = a_string
-      raise Squarecoder::InputTooLongError if this_string.length > 81
-      len = ( this_string.length ** ( 0.5 ) ).ceil
-      arry = this_string.scan( /./ ).each_slice( len ).to_a
+    def self.encode a_string, ignore_whitespace = false, ignore_max_length = false
+      if !ignore_max_length && a_string.length > MAX_LEN
+        raise Squarecoder::InputTooLong
+      end
+      if !ignore_whitespace && a_string.include?(' ')
+        raise Squarecoder::NoWhitespace
+      end
+      len = ( a_string.length ** ( 0.5 ) ).ceil
+      arry = a_string.in_character_arrays_of_length( len )
       if arry.last.length != len
-        arry.last.fill( ' ', arry.last.length..( len - 1 ) )
+				( len - arry.last.length ).times { arry.last << ' ' } # a tiny bit faster than arry.fill
       end
       arry.transpose.collect { |line| line.join }.join(' ').rstrip
     end
     
     # Decode a String from square code
     def self.decode a_string
-      encode( a_string ).gsub(' ', '')
+      encode( a_string, true, true ).gsub(/ +/, '')
     end
     
   end

data/lib/squarecoder.rb

@@ -2,6 +2,8 @@ require 'rubygems'
 require 'singleton'
 
 module Squarecoder
+	# Maximum length of an input string
+	MAX_LEN = 81
   require 'squarecoder/core_ext/string'
   require 'squarecoder/errors'
   require 'squarecoder/transcoder'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: squarecoder
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-25 00:00:00.000000000Z
+date: 2011-11-28 00:00:00.000000000Z
 dependencies: []
 description: A library to encode and decode strings using the square code encryption
   method.
@@ -20,43 +20,6 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - README.rdoc
-- lib/doc/created.rid
-- lib/doc/images/add.png
-- lib/doc/images/brick.png
-- lib/doc/images/brick_link.png
-- lib/doc/images/bug.png
-- lib/doc/images/bullet_black.png
-- lib/doc/images/bullet_toggle_minus.png
-- lib/doc/images/bullet_toggle_plus.png
-- lib/doc/images/date.png
-- lib/doc/images/delete.png
-- lib/doc/images/find.png
-- lib/doc/images/loadingAnimation.gif
-- lib/doc/images/macFFBgHack.png
-- lib/doc/images/package.png
-- lib/doc/images/page_green.png
-- lib/doc/images/page_white_text.png
-- lib/doc/images/page_white_width.png
-- lib/doc/images/plugin.png
-- lib/doc/images/ruby.png
-- lib/doc/images/tag_blue.png
-- lib/doc/images/tag_green.png
-- lib/doc/images/transparent.png
-- lib/doc/images/wrench.png
-- lib/doc/images/wrench_orange.png
-- lib/doc/images/zoom.png
-- lib/doc/index.html
-- lib/doc/js/darkfish.js
-- lib/doc/js/jquery.js
-- lib/doc/js/navigation.js
-- lib/doc/js/search.js
-- lib/doc/js/search_index.js
-- lib/doc/js/searcher.js
-- lib/doc/rdoc.css
-- lib/doc/Squarecoder/Transcoder.html
-- lib/doc/Squarecoder.html
-- lib/doc/String.html
-- lib/doc/table_of_contents.html
 - lib/squarecoder/core_ext/string.rb
 - lib/squarecoder/errors.rb
 - lib/squarecoder/transcoder.rb

data/lib/doc/Squarecoder/Transcoder.html

@@ -1,236 +0,0 @@
-<!DOCTYPE html>
-
-<html>
-<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
-
-<title>Class: Squarecoder::Transcoder</title>
-
-<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
-
-<script type="text/javascript">
-  var rdoc_rel_prefix = "../";
-</script>
-
-<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
-
-
-<body id="top" class="class">
-<nav id="metadata">
-  <nav id="home-section" class="section">
-  <h3 class="section-header">
-    <a href="../index.html">Home</a>
-    <a href="../table_of_contents.html#classes">Classes</a>
-    <a href="../table_of_contents.html#methods">Methods</a>
-  </h3>
-</nav>
-
-
-  <nav id="search-section" class="section project-section" class="initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <h3 class="section-header">
-      <input type="text" name="search" placeholder="Search" id="search-field"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </h3>
-  </form>
-
-  <ul id="search-results" class="initially-hidden"></ul>
-</nav>
-
-
-  <div id="file-metadata">
-    <nav id="file-list-section" class="section">
-  <h3 class="section-header">Defined In</h3>
-  <ul>
-    <li>squarecoder/transcoder.rb
-  </ul>
-</nav>
-
-    
-  </div>
-
-  <div id="class-metadata">
-    
-    <nav id="parent-class-section" class="section">
-  <h3 class="section-header">Parent</h3>
-  
-  <p class="link">Object
-  
-</nav>
-
-    <!-- Included Modules -->
-<nav id="includes-section" class="section">
-  <h3 class="section-header">Included Modules</h3>
-
-  <ul class="link-list">
-  
-  
-    <li><span class="include">Singleton</span>
-  
-  
-  </ul>
-</nav>
-
-    <!-- Method Quickref -->
-<nav id="method-list-section" class="section">
-  <h3 class="section-header">Methods</h3>
-
-  <ul class="link-list">
-    
-    <li><a href="#method-c-decode">::decode</a>
-    
-    <li><a href="#method-c-encode">::encode</a>
-    
-  </ul>
-</nav>
-
-  </div>
-
-  <div id="project-metadata">
-    
-    <nav id="classindex-section" class="section project-section">
-  <h3 class="section-header">Class and Module Index</h3>
-
-  <ul class="link-list">
-  
-    <li><a href="../Squarecoder.html">Squarecoder</a>
-  
-    <li><a href="../Squarecoder/Transcoder.html">Squarecoder::Transcoder</a>
-  
-    <li><a href="../String.html">String</a>
-  
-  </ul>
-</nav>
-
-  </div>
-</nav>
-
-<div id="documentation">
-  <h1 class="class">class Squarecoder::Transcoder</h1>
-
-  <div id="description" class="description">
-    
-<p>A <a href="Transcoder.html">Transcoder</a> is a Singleton used to encode
-and decode strings.</p>
-
-<pre class="ruby"><span class="ruby-constant">Squarecoder</span><span class="ruby-operator">::</span><span class="ruby-constant">Transcoder</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-string">&quot;haveaniceday&quot;</span>) <span class="ruby-comment"># =&gt; &quot;hae and via ecy&quot;</span>
-<span class="ruby-constant">Squarecoder</span><span class="ruby-operator">::</span><span class="ruby-constant">Transcoder</span>.<span class="ruby-identifier">decode</span>(<span class="ruby-string">&quot;hae and via ecy&quot;</span>) <span class="ruby-comment"># =&gt; &quot;haveaniceday&quot;</span>
-<span class="ruby-string">&quot;haveaniceday&quot;</span>.<span class="ruby-identifier">square_encode</span> <span class="ruby-comment"># =&gt; &quot;hae and via ecy&quot;</span>
-<span class="ruby-string">&quot;hae and via ecy&quot;</span>.<span class="ruby-identifier">square_decode</span> <span class="ruby-comment"># =&gt; &quot;haveaniceday&quot;</span>
-</pre>
-
-  </div><!-- description -->
-
-  
-  
-  
-  <section id="5Buntitled-5D" class="documentation-section">
-    
-
-    
-
-    
-
-    
-
-    <!-- Methods -->
-    
-     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
-      <h3 class="section-header">Public Class Methods</h3>
-
-    
-      <div id="method-c-decode" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">decode</span><span
-            class="method-args">(a_string, force = false)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Decode a <a href="../String.html">String</a></p>
-
-<pre>+a_string+ is the String to decode
-+force+ is a Boolean that tells the decoder to skip a cached value (unsupported)</pre>
-
-<p>Returns a <a href="../String.html">String</a></p>
-          
-
-          
-          <div class="method-source-code" id="decode-source">
-            <pre><span class="ruby-comment"># File squarecoder/transcoder.rb, line 34</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">decode</span> <span class="ruby-identifier">a_string</span>, <span class="ruby-identifier">force</span> = <span class="ruby-keyword">false</span>
-  <span class="ruby-identifier">encode</span>( <span class="ruby-identifier">a_string</span> ).<span class="ruby-identifier">gsub</span>(<span class="ruby-string">' '</span>, <span class="ruby-string">''</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div><!-- decode-source -->
-          
-        </div>
-
-        
-
-        
-      </div><!-- decode-method -->
-
-    
-      <div id="method-c-encode" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">encode</span><span
-            class="method-args">(a_string, force = false)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Encode a <a href="../String.html">String</a></p>
-
-<pre>+a_string+ is the String to encode and must be less than 81 characters
-+force+ is a Boolean that tells the encoder to skip a cached value (unsupported)</pre>
-
-<p>Returns a <a href="../String.html">String</a></p>
-          
-
-          
-          <div class="method-source-code" id="encode-source">
-            <pre><span class="ruby-comment"># File squarecoder/transcoder.rb, line 18</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">encode</span> <span class="ruby-identifier">a_string</span>, <span class="ruby-identifier">force</span> = <span class="ruby-keyword">false</span>
-  <span class="ruby-identifier">this_string</span> = <span class="ruby-identifier">a_string</span>
-  <span class="ruby-identifier">raise</span> <span class="ruby-constant">Squarecoder</span><span class="ruby-operator">::</span><span class="ruby-constant">TooLongError</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">this_string</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">81</span>
-  <span class="ruby-identifier">len</span> = ( <span class="ruby-identifier">this_string</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">**</span> ( <span class="ruby-value">0.5</span> ) ).<span class="ruby-identifier">ceil</span>
-  <span class="ruby-identifier">arry</span> = <span class="ruby-identifier">this_string</span>.<span class="ruby-identifier">scan</span>( <span class="ruby-regexp">/./</span> ).<span class="ruby-identifier">each_slice</span>( <span class="ruby-identifier">len</span> ).<span class="ruby-identifier">to_a</span>
-  <span class="ruby-keyword">if</span> <span class="ruby-identifier">arry</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">len</span>
-    <span class="ruby-identifier">arry</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">fill</span>( <span class="ruby-string">' '</span>, <span class="ruby-identifier">arry</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">length</span><span class="ruby-operator">..</span>( <span class="ruby-identifier">len</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span> ) )
-  <span class="ruby-keyword">end</span>
-  <span class="ruby-identifier">arry</span>.<span class="ruby-identifier">transpose</span>.<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">join</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-string">' '</span>).<span class="ruby-identifier">rstrip</span>
-<span class="ruby-keyword">end</span></pre>
-          </div><!-- encode-source -->
-          
-        </div>
-
-        
-
-        
-      </div><!-- encode-method -->
-
-    
-    </section><!-- public-class-method-details -->
-  
-  </section><!-- 5Buntitled-5D -->
-
-</div><!-- documentation -->
-
-
-<footer id="validator-badges">
-  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
-  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
-  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
-</footer>
-

data/lib/doc/Squarecoder.html

@@ -1,116 +0,0 @@
-<!DOCTYPE html>
-
-<html>
-<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
-
-<title>Module: Squarecoder</title>
-
-<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
-
-<script type="text/javascript">
-  var rdoc_rel_prefix = "./";
-</script>
-
-<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
-
-
-<body id="top" class="module">
-<nav id="metadata">
-  <nav id="home-section" class="section">
-  <h3 class="section-header">
-    <a href="./index.html">Home</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </h3>
-</nav>
-
-
-  <nav id="search-section" class="section project-section" class="initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <h3 class="section-header">
-      <input type="text" name="search" placeholder="Search" id="search-field"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </h3>
-  </form>
-
-  <ul id="search-results" class="initially-hidden"></ul>
-</nav>
-
-
-  <div id="file-metadata">
-    <nav id="file-list-section" class="section">
-  <h3 class="section-header">Defined In</h3>
-  <ul>
-    <li>squarecoder/errors.rb
-    <li>squarecoder/transcoder.rb
-    <li>squarecoder.rb
-  </ul>
-</nav>
-
-    
-  </div>
-
-  <div id="class-metadata">
-    
-    
-    
-    
-  </div>
-
-  <div id="project-metadata">
-    
-    <nav id="classindex-section" class="section project-section">
-  <h3 class="section-header">Class and Module Index</h3>
-
-  <ul class="link-list">
-  
-    <li><a href="./Squarecoder.html">Squarecoder</a>
-  
-    <li><a href="./Squarecoder/Transcoder.html">Squarecoder::Transcoder</a>
-  
-    <li><a href="./String.html">String</a>
-  
-  </ul>
-</nav>
-
-  </div>
-</nav>
-
-<div id="documentation">
-  <h1 class="module">module Squarecoder</h1>
-
-  <div id="description" class="description">
-    
-  </div><!-- description -->
-
-  
-  
-  
-  <section id="5Buntitled-5D" class="documentation-section">
-    
-
-    
-
-    
-
-    
-
-    <!-- Methods -->
-    
-  </section><!-- 5Buntitled-5D -->
-
-</div><!-- documentation -->
-
-
-<footer id="validator-badges">
-  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
-  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
-  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
-</footer>
-