alt_characters 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 398b7281c3d04fcc95e7f582e6a3d015cf0de9f5005a1b98c25f67f54b1434a1
-  data.tar.gz: ae48022b091825de49fa68895e1a4370bd6741fd82de1370f2ec0d9a38d2678f
+  metadata.gz: 9e4562fc3e5218bf88704fea4709d2f54df4956a1ece72cc2a225e3e7bf77905
+  data.tar.gz: 64d970ef8e084d106cc2fc20862f689278a11a10807fd9d0dcaabf65cfca8680
 SHA512:
-  metadata.gz: 72b8a389ba131af60ae215e678844a839a81fe5cb9a598a31cde492efcea4a1f1175f1e63699a8bbcf8c91b117129d5ad7de74cf5b3e09cd8be15c0f449a1f73
-  data.tar.gz: 8d96e0351393d54918122fa95220a33fc3ea4c4a4c8dd7df0db00803f1028cd37298402729e9cea96e5ab23211baed0e9f33073cfdc5ef0574b2aeedc8053ad4
+  metadata.gz: 6fa6ba3460c1d5028f7d3973605d0caae772353a722dc79c2d26b5282e30c59b1855eeac7363d19e03daa8d382e06ba465b36a635df2cff757f2f99604f3f5f2
+  data.tar.gz: d915cf82e15365ac3d62fbe4d32f62c5e3bd8b85c68f6d2fc2bb0b83900b7c7ae4fa272614791014c34fc64cf00946416180a9b95cbfaf245c0395c1f3be436b

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Guardfile'
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 120

data/Gemfile

@@ -1,8 +1,11 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in alt_characters.gemspec
 gemspec
 
 gem 'guard-rspec'
+gem 'guard-rubocop'

data/Guardfile

@@ -1,5 +1,7 @@
-guard :rspec, cmd: "bundle exec rspec -fd" do
-  require "guard/rspec/dsl"
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec -fd' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
   # RSpec files
@@ -12,3 +14,8 @@ guard :rspec, cmd: "bundle exec rspec -fd" do
   ruby = dsl.ruby
   dsl.watch_spec_files_for(ruby.lib_files)
 end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/alt_characters.gemspec

@@ -1,36 +1,37 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "alt_characters/version"
+require 'alt_characters/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "alt_characters"
+  spec.name          = 'alt_characters'
   spec.version       = AltCharacters::VERSION
   spec.authors       = ['booink']
   spec.email         = ['booink.work@gmail.com']
 
-  spec.summary       = %q{alt_characters alternate base32 without numeric characters and padding}
+  spec.summary       = 'alt_characters alternate base32 without numeric characters and padding'
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/booink/alt_characters'
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
 
   if spec.respond_to?(:metadata)
-    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata['homepage_uri'] = spec.homepage
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/exe/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "alt_characters"
+require 'bundler/setup'
+require 'alt_characters'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "alt_characters"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/alt32.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'alt_characters/alt32'
 
 Alt32 = AltCharacters::Alt32

data/lib/alt_characters.rb

@@ -1,5 +1,7 @@
-require "alt_characters/version"
-require "alt32"
+# frozen_string_literal: true
+
+require 'alt_characters/version'
+require 'alt32'
 
 module AltCharacters
   class << self

data/lib/alt_characters/alt32.rb

@@ -1,8 +1,10 @@
-require "alt_characters/alt_base"
+# frozen_string_literal: true
+
+require 'alt_characters/alt_base'
 
 module AltCharacters
   class Alt32 < AltBase
-    DEFAULT_CHARACTERS = 'ABCDEFGHJKLMNPQRSTWXYfghkmprstwx'.freeze
+    DEFAULT_CHARACTERS = 'ABCDEFGHJKLMNPQRSTWXYfghkmprstwx'
 
     def initialize(characters: DEFAULT_CHARACTERS)
       super(32, characters: characters)

data/lib/alt_characters/alt_base.rb

@@ -1,40 +1,70 @@
+# frozen_string_literal: true
+
 module AltCharacters
   class AltBase
     class DecodeError < StandardError; end
     class EncodableCharactersError < StandardError; end
 
-    def initialize(length, characters: nil)
+    BYTE = 8 # bit
+
+    def initialize(length, characters: nil, padding_character: '=')
       @length = length
-      @logarithm = Math.log2(length)
+      @padding_character = padding_character
+      @logarithm = Math.log2(length).to_i # 2**n
       @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
+      raise EncodableCharactersError, "Not enough characters. #{count} characters specified" if count < length
+
+      warn "[warn] Too many characters specified. The last #{count - length} characters are not used" if count > length
     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
+    # rubocop:disable Metrics/AbcSize
+    def encode(text, padding: false)
+      binary = text.to_s.unpack1('B*')
+      encoded_characters = 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
+      encoded_characters = add_padding(encoded_characters) if padding && need_padding?(encoded_characters)
+
+      encoded_characters.join
     end
+    # rubocop:enable Metrics/AbcSize
 
-    def decode(encoded_text)
-      binary = ""
+    def decode(encoded_text, padding: false)
+      binary = ''
       encoded_text.to_s.chars.each do |character|
+        break if padding && character == @padding_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 = [binary].pack('B*')
       # string.encoding # => ASCII-8BIT
-      string.force_encoding("UTF-8").gsub("\x00", "")
+      string.force_encoding('UTF-8').delete("\x00")
+    end
+
+    private
+
+    def missing_chunks(characters)
+      number_of_group_characters = @logarithm.lcm(BYTE) / @logarithm
+      modulo = characters.count % number_of_group_characters
+      modulo.zero? ? 0 : number_of_group_characters - modulo
+    end
+
+    def need_padding?(characters)
+      missing_chunks(characters) != 0
+    end
+
+    def add_padding(characters)
+      missing_chunks(characters).times do
+        characters << @padding_character
+      end
+      characters
     end
   end
 end

data/lib/alt_characters/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AltCharacters
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alt_characters
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - booink
@@ -63,6 +63,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile