alt_characters 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 012a91963f053d07e7d35fef6f15a8e3e4da01734f09a6b9e56175d97a8b15a0
-  data.tar.gz: 99dc241e55c9fc9e429092f6c1a99d8e8e6202d85414747a9c44c71e3679a653
+  metadata.gz: 398b7281c3d04fcc95e7f582e6a3d015cf0de9f5005a1b98c25f67f54b1434a1
+  data.tar.gz: ae48022b091825de49fa68895e1a4370bd6741fd82de1370f2ec0d9a38d2678f
 SHA512:
-  metadata.gz: '049cbaa7235713cc261006194aa72d8433053250476aad1c88aed50434c99c603656d9921f7ffd929ebee1eaf36a196c15e03efae899d903465b44b481a4c48d'
-  data.tar.gz: 4965699fa651b349d3d52b91cc7c12cf9697bf39c2d0cacabb7c856f3b31218121a726335adcf915fb0f0cd5d363c548d7012fc40334d5d9c12e3bcafe5bf897
+  metadata.gz: 72b8a389ba131af60ae215e678844a839a81fe5cb9a598a31cde492efcea4a1f1175f1e63699a8bbcf8c91b117129d5ad7de74cf5b3e09cd8be15c0f449a1f73
+  data.tar.gz: 8d96e0351393d54918122fa95220a33fc3ea4c4a4c8dd7df0db00803f1028cd37298402729e9cea96e5ab23211baed0e9f33073cfdc5ef0574b2aeedc8053ad4

data/README.md

@@ -1,8 +1,6 @@
 # AltCharacters
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/alt_characters`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+alt_characters alternate base32 without numeric characters and padding
 
 ## Installation
 
@@ -22,7 +20,44 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Quick start
+
+```ruby
+require 'alt_characters'
+
+encoded_text = AltCharacters.alt32_encode('foo')
+# => "Nmhgw"
+
+AltCharacters.alt32_decode(encoded_text)
+# => "foo"
+```
+
+or
+
+```ruby
+require 'alt_characters'
+
+encoded_text = Alt32.new.encode('foo')
+# => "Nmhgw"
+
+Alt32.new.decode(encoded_text)
+# => "foo"
+```
+
+
+### Modifying encodable characters
+
+```ruby
+require 'alt_characters'
+
+encodable_characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567'
+
+encoded_text = Alt32.new(characters: encodable_characters).encode('foo')
+# => "MZXW6"
+
+Alt32.new(characters: encodable_characters).decode(encoded_text)
+# => "foo"
+```
 
 ## Development
 
@@ -32,7 +67,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/alt_characters. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/booink/alt_characters. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/alt32.rb

@@ -1,30 +1,3 @@
-class Alt32
-  DEFAULT_CHARACTERS = 'ABCDEFGHJKLMNPQRSTWXYfghkmprstwx'.freeze
+require 'alt_characters/alt32'
 
-  class DecodeError < StandardError; end
-
-  def initialize(characters: DEFAULT_CHARACTERS)
-    @characters = characters.split(//) if characters.class == String
-  end
-
-  def encode(text)
-    binary = text.to_s.unpack("B*").first
-    binary.chars.each_slice(5).map do |chunk|
-      chunk << "0" * (5 - chunk.count) if chunk.count < 5
-      i = chunk.join.to_i(2)
-      @characters[i]
-    end.join
-  end
-
-  def decode(encoded_text)
-    binary = ""
-    encoded_text.to_s.chars.each do |character|
-      i = @characters.index(character)
-      raise DecodeError, "character(#{character}) does not exists" if i.nil?
-      binary += format("%05d", i.to_s(2))
-    end
-    string = [binary].pack("B*")
-    # string.encoding # => ASCII-8BIT
-    string.force_encoding("UTF-8").gsub("\x00", "")
-  end
-end
+Alt32 = AltCharacters::Alt32

data/lib/alt_characters/alt32.rb

@@ -0,0 +1,11 @@
+require "alt_characters/alt_base"
+
+module AltCharacters
+  class Alt32 < AltBase
+    DEFAULT_CHARACTERS = 'ABCDEFGHJKLMNPQRSTWXYfghkmprstwx'.freeze
+
+    def initialize(characters: DEFAULT_CHARACTERS)
+      super(32, characters: characters)
+    end
+  end
+end

data/lib/alt_characters/alt_base.rb

@@ -0,0 +1,40 @@
+module AltCharacters
+  class AltBase
+    class DecodeError < StandardError; end
+    class EncodableCharactersError < StandardError; end
+
+    def initialize(length, characters: nil)
+      @length = length
+      @logarithm = Math.log2(length)
+      @characters = characters
+      @characters = characters.split(//) if characters.class == String
+      count = @characters.count
+      if count < length
+        raise EncodableCharactersError, "Not enough characters. #{count} characters specified"
+      elsif count > length
+        warn "[warn] Too many characters specified. The last #{count - length} characters are not used"
+      end
+    end
+
+    def encode(text)
+      binary = text.to_s.unpack("B*").first
+      binary.chars.each_slice(@logarithm).map do |chunk|
+        chunk << "0" * (@logarithm - chunk.count) if chunk.count < @logarithm
+        i = chunk.join.to_i(2)
+        @characters[i]
+      end.join
+    end
+
+    def decode(encoded_text)
+      binary = ""
+      encoded_text.to_s.chars.each do |character|
+        i = @characters.index(character)
+        raise DecodeError, "character(#{character}) does not exists" if i.nil?
+        binary += format("%0#{@logarithm}d", i.to_s(2))
+      end
+      string = [binary].pack("B*")
+      # string.encoding # => ASCII-8BIT
+      string.force_encoding("UTF-8").gsub("\x00", "")
+    end
+  end
+end

data/lib/alt_characters/version.rb

@@ -1,3 +1,3 @@
 module AltCharacters
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alt_characters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - booink
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-16 00:00:00.000000000 Z
+date: 2018-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,8 @@ files:
 - exe/setup
 - lib/alt32.rb
 - lib/alt_characters.rb
+- lib/alt_characters/alt32.rb
+- lib/alt_characters/alt_base.rb
 - lib/alt_characters/version.rb
 homepage: https://github.com/booink/alt_characters
 licenses: