nineteen-eighty-two 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23550cc3b6c5889f1a37f56cc1c24770083ee75a
-  data.tar.gz: d13ee480608b109d220ee6fcd281748c041c2f80
+  metadata.gz: c8adb225e0b27b75def30e8cbcf6cfaf4d93ec5b
+  data.tar.gz: 437eb48a19094395b0a30193727bbd36784d3ac2
 SHA512:
-  metadata.gz: b57bb53b971aba3b8f5884726943b0df031e7914752e9cce65de97d28918808ab939e80465f2f118ff21aeb2caeb742e6677326b42b311d55e585fc5135a48ec
-  data.tar.gz: 430b491bb1a20d84eff6c36b478c1a0d13af4f15bf370b33cfd2851674f4844ad6447df760a2ac9041ff5807e792ccc074f8d8b6ee1788fc55f6a01f4911ed27
+  metadata.gz: 1853d80dc42dfec864e4e9fde5803aebcd90842d027ec8d7ecb84eb44d8744b236422b0666255e0ee0053f5972f4986c14650bc962fc55e65f1f475a22c588a7
+  data.tar.gz: d319135567cc68edb911f1ce80a9e68afb329e41d8b2887b389f7087077c29cbee9a6098c7196e711f2ca504ddaa7b3ed9696946dd23d91160a0f39c1f142506

data/README.md

@@ -5,8 +5,190 @@
 [![Gem Version](http://img.shields.io/gem/v/nineteen-eighty-two.svg?style=flat-square)](https://rubygems.org/gems/nineteen-eighty-two)
 [![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://pikesley.mit-license.org)
 
-#1982
+# 1982
 
-##Sinclair Spectrum font as a Rubygem
+## Sinclair Spectrum font as a Rubygem
 
-See it in action [here](https://uncle-clive.herokuapp.com)
+A massively over-engineered solution to a problem that I'm almost 100% certain does not exist - rendering text in the 1982 Sinclair Spectrum character set, in a variety of formats
+
+    git clone https://github.com/pikesley/nineteen-eighty-two
+    cd nineteen-eighty-two
+    bundle
+    rake
+
+Or just
+
+    gem install nineteen-eighty-two
+
+## API
+
+From the [specs](https://github.com/pikesley/nineteen-eighty-two/tree/master/spec/nineteen/eighty/two):
+
+### Just the data
+
+#### Transform a string into an array-of-arrays of bits
+
+    require 'nineteen/eighty/two'
+
+    module Nineteen::Eighty::Two
+      describe Spectrum do
+        it 'returns an array of arrays' do
+          expect(described_class['ab']).to eq [
+            [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
+            [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0],
+            [0, 0, 1, 1, 1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0],
+            [0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0],
+            [0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 1, 0],
+            [0, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 1, 0],
+            [0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0],
+            [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+          ]
+        end
+      end
+    end
+
+### Specific output formats
+
+#### HTML table
+
+    require 'nineteen/eighty/two'
+
+    module Nineteen::Eighty::Two
+      module Formats
+        describe HTMLTable do
+        it 'makes a table' do
+          expect(described_class.format 'a').to eq (
+            """<!-- a -->
+            <table class='sinclair'>
+            <tr><td class='off'> </td><td class='off'> </td><td class='off'> </td><td class='off'> </td><td class='off'> </td><td class='off'> </td><td class='off'> </td><td class='off'> </td></tr>
+            <tr><td class='off' colspan='8'> </td></tr>
+            <tr><td class='off' colspan='8'> </td></tr>
+            <tr><td class='off' colspan='2'> </td><td class='on' colspan='3'> </td><td class='off' colspan='3'> </td></tr>
+            <tr><td class='off' colspan='5'> </td><td class='on'> </td><td class='off' colspan='2'> </td></tr>
+            <tr><td class='off' colspan='2'> </td><td class='on' colspan='4'> </td><td class='off' colspan='2'> </td></tr>
+            <tr><td class='off'> </td><td class='on'> </td><td class='off' colspan='3'> </td><td class='on'> </td><td class='off' colspan='2'> </td></tr>
+            <tr><td class='off' colspan='2'> </td><td class='on' colspan='4'> </td><td class='off' colspan='2'> </td></tr>
+            <tr><td class='off' colspan='8'> </td></tr>
+            </table>"""
+          )
+        end
+      end
+    end
+
+#### JSON
+
+    require 'nineteen/eighty/two'
+
+    module Nineteen::Eighty::Two
+      module Formats
+        describe JSON do
+          expect(described_class.format 'ab').to eq ({
+            :id   => 'ab',
+            :data => [
+              [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
+              [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0],
+              [0, 0, 1, 1, 1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0],
+              [0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0],
+              [0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 1, 0],
+              [0, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 1, 0],
+              [0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0],
+              [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+            ]
+          }.to_json)
+        end
+      end
+    end
+
+#### SVG
+
+    require 'nineteen/eighty/two'
+
+    module Nineteen::Eighty::Two
+      module Formats
+        describe SVG do
+          it 'returns an SVG' do
+            expect(described_class.format '/').to eq (
+              """<svg viewBox='0 0 8 8' xmlns='http://www.w3.org/2000/svg'>
+              <style type='text/css'>
+                <![CDATA[
+                  rect.on {
+                    fill: #000000;
+                  }
+                ]]>
+              </style>
+              <g>
+          <rect x='6' y='2' width='1' height='1' class='on' />
+          <rect x='5' y='3' width='1' height='1' class='on' />
+          <rect x='4' y='4' width='1' height='1' class='on' />
+          <rect x='3' y='5' width='1' height='1' class='on' />
+          <rect x='2' y='6' width='1' height='1' class='on' />
+              </g>
+            </svg>
+          """)
+          end
+
+          it 'sets the colour' do
+                expect(described_class.format '/', {colour: '#fa8100'}).to match /fill: #fa8100;/
+          end
+        end
+      end
+    end
+
+#### Text
+
+    require 'nineteen/eighty/two'
+
+    module Nineteen::Eighty::Two
+      module Formats
+        describe Text do
+        it 'gives the correct string' do
+          expect(described_class.format 'ab').to eq (
+            """
+            0000000000000000
+            0000000000100000
+            0011100000100000
+            0000010000111100
+            0011110000100010
+            0100010000100010
+            0011110000111100
+            0000000000000000
+            """
+          ).strip
+        end
+
+        it 'returns characters other than zeroes and ones' do
+          expect(described_class.format 'Sam', {on: 'X', off: '.'}).to eq (
+            """
+            ........................
+            ..XXXX..................
+            .X........XXX....XX.X...
+            ..XXXX.......X...X.X.X..
+            ......X...XXXX...X.X.X..
+            .X....X..X...X...X.X.X..
+            ..XXXX....XXXX...X.X.X..
+            ........................
+            """
+            ).strip
+        end
+      end
+    end
+
+## FAQ
+
+Your questions, answered
+
+### Why the stupid module structure?
+
+I realise that `Nineteen::Eighty::Two::Formats::HTMLTable.format` is a ludicrously long method name, but it turns out if you do `bundle gem nineteen-eighty-two`, this module hierarchy is what you're presented with, and I actually kind of like it (I did try to call it `1982` but apparently that's not a kosher Gem name)
+
+### Why doesn't it output in _${other_format}_
+
+If you can think of another format I could support, let me know and I'll have a go. I am also [open to PRs](https://github.com/pikesley/nineteen-eighty-two/pulls), of course
+
+### Where can I play with this?
+
+I've wrapped this Gem in a RESTful API [over here](http://uncleclive.herokuapp.com/)
+
+### Why have you done this?
+
+Have you met me? Also, because I'm [moderately obsessed with this font](https://www.youtube.com/watch?v=Qt_J0jNqtZg)

data/lib/nineteen/eighty/two/formatters/html_table_formatter.rb

@@ -6,7 +6,7 @@ module Nineteen
           def self.format text
             lines = Spectrum[text]
 
-            t = File.read File.open File.join templates_dir, 'table.eruby'
+            t = File.read File.open File.join Nineteen::Eighty::Two.templates_dir, 'html', 'table', 'table.eruby'
             context = {
               title: text,
               blanks: blanks(lines.first),
@@ -16,7 +16,7 @@ module Nineteen
           end
 
           def self.blanks lines
-            t = File.read File.open File.join templates_dir, 'row.eruby'
+            t = File.read File.open File.join Nineteen::Eighty::Two.templates_dir, 'html', 'table', 'row.eruby'
             context = {
               cells: lines.map { |b| cell Span.new(0, 1) }.join
             }
@@ -24,7 +24,7 @@ module Nineteen
           end
 
           def self.cell span
-            t = File.read File.open File.join templates_dir, 'cell.eruby'
+            t = File.read File.open File.join Nineteen::Eighty::Two.templates_dir, 'html', 'table', 'cell.eruby'
             context = {
               style: span.type == 1 ? 'on' : 'off',
             }
@@ -33,16 +33,12 @@ module Nineteen
           end
 
           def self.row list
-            t = File.read File.open File.join templates_dir, 'row.eruby'
+            t = File.read File.open File.join Nineteen::Eighty::Two.templates_dir, 'html', 'table', 'row.eruby'
             context = {
               cells: Decorators::RunLengthEncoder.encode(list).map { |i| cell i }.join
             }
             Erubis::Eruby.new(t).evaluate(context).strip
           end
-
-          def self.templates_dir
-            File.join File.dirname(__FILE__),'..', 'templates', 'html', 'table'
-          end
         end
       end
     end

data/lib/nineteen/eighty/two/formatters/svg_formatter.rb

@@ -4,10 +4,12 @@ module Nineteen
       module Formats
         class SVG
           def self.format text, options = {}
-            t = File.read File.open File.join templates_dir, 'document.eruby'
+            text = [text] unless text.is_a? Array
+
+            t = File.read File.open File.join Nineteen::Eighty::Two.templates_dir, 'svg', 'document.eruby'
             context = {
-              width: text.length * 8,
-              height: 8,
+              width: text.longest * 8,
+              height: text.count * 8,
               fill_colour: options.fetch(:colour, '#000000'),
               body: body(text)
             }
@@ -15,11 +17,16 @@ module Nineteen
           end
 
           def self.body text
-            rows = []
-            Spectrum[text].each_with_index do |line, index|
-              rows.push row(line, index)
+            s = ''
+            text.each_with_index do |line, count|
+              rows = []
+              Spectrum[line].each_with_index do |line, index|
+                rows.push row(line, index + (count * 8))
+              end
+              s << rows.join("\n")
             end
-            rows.join("\n").strip
+
+            s.strip
           end
 
           def self.row list, index = 0
@@ -27,7 +34,7 @@ module Nineteen
             cells = []
             Decorators::RunLengthEncoder.encode(list).each do |item|
               if item.type == 1
-                t = File.read File.open File.join templates_dir, 'cell.eruby'
+                t = File.read File.open File.join Nineteen::Eighty::Two.templates_dir, 'svg', 'cell.eruby'
                 context = {
                   x: x,
                   y: index,
@@ -43,8 +50,8 @@ module Nineteen
             cells.join("\n").strip
           end
 
-          def self.templates_dir
-            File.join File.dirname(__FILE__),'..', 'templates', 'svg'
+          def self.longest list
+            list.map { |i| i.length }.max
           end
         end
       end

data/lib/nineteen/eighty/two/version.rb

@@ -1,7 +1,7 @@
 module Nineteen
   module Eighty
     module Two
-      VERSION = "0.1.2"
+      VERSION = "0.1.3"
     end
   end
 end

data/lib/nineteen/eighty/two.rb

@@ -12,16 +12,32 @@ require 'nineteen/eighty/two/formatters/json_formatter'
 require 'nineteen/eighty/two/formatters/html_table_formatter'
 require 'nineteen/eighty/two/formatters/svg_formatter'
 
-class Span < Hash
-  def initialize type, width
-    self[type] = width
-  end
+module Nineteen
+  module Eighty
+    module Two
+      class Span < Hash
+        def initialize type, width
+          self[type] = width
+        end
+
+        def type
+          self.keys.first
+        end
 
-  def type
-    self.keys.first
+        def width
+          self.values.first
+        end
+      end
+
+      def self.templates_dir
+        File.join File.dirname(__FILE__), 'two', 'templates'
+      end
+    end
   end
+end
 
-  def width
-    self.values.first
+class Array
+  def longest
+    self.map { |i| i.length }.max
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nineteen-eighty-two
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - pikesley