Ascii85 1.0.2 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dcb6cc7ca3f3ca02c235e5a0d5b908396524e265c9adaaf56c50bc62117c5ee7
+  data.tar.gz: c005e9a67ecc1def46d040f06e91cb7984d0cfd43d9729638d60b2fe19d2ab8c
+SHA512:
+  metadata.gz: c6fef31cebe36d41eee64ff857e87007b176b262fc4c667666f6360714b9d15274afb192572cf5bba31953f13ecde7c1b1ea60697ebf83a43dc80b35f64d94dd
+  data.tar.gz: 2bd0e1367f729cb42d2163e5eeeba540e243138a23cfeb6bf9e2d93d49c80dc12227d65b60bd1db2f6272ab8c9bac19d0aaac37a5e9d48e14dd50d45abb8a749

data/.travis.yml

@@ -0,0 +1,30 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+  - jruby
+  - truffleruby
+env:
+  - RUBYOPT="--enable-frozen-string-literal"
+  - RUBYOPT=""
+matrix:
+  exclude:
+    - rvm: 1.9
+      env: RUBYOPT="--enable-frozen-string-literal"
+    - rvm: 2.0
+      env: RUBYOPT="--enable-frozen-string-literal"
+    - rvm: 2.1
+      env: RUBYOPT="--enable-frozen-string-literal"
+    - rvm: 2.2
+      env: RUBYOPT="--enable-frozen-string-literal"
+    # bundler did not support this back then
+    - rvm: 2.3
+      env: RUBYOPT="--enable-frozen-string-literal"

data/Ascii85.gemspec

@@ -7,14 +7,12 @@ Gem::Specification.new do |s|
   s.version     = Ascii85::VERSION
   s.platform    = Gem::Platform::RUBY
   s.author      = "Johannes Holzfuß"
-  s.email       = "DataWraith@web.de"
+  s.email       = "johannes@holzfuss.name"
   s.license     = 'MIT'
-  s.homepage    = "http://rubyforge.org/projects/ascii85/"
+  s.homepage    = "https://github.com/DataWraith/ascii85gem/"
   s.summary     = %q{Ascii85 encoder/decoder}
   s.description = %q{Ascii85 provides methods to encode/decode Adobe's binary-to-text encoding of the same name.}
 
-  s.rubyforge_project = "Ascii85"
-
   s.add_development_dependency "bundler", ">= 1.0.0"
   s.add_development_dependency "minitest",">= 2.6.0"
   s.add_development_dependency "rake",    ">= 0.9.2"
@@ -23,5 +21,5 @@ Gem::Specification.new do |s|
   s.test_files       = `git ls-files -- spec/*`.split("\n")
   s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths    = ["lib"]
-  s.extra_rdoc_files = ['README.rdoc', 'LICENSE']
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
 end

data/History.txt

@@ -1,3 +1,12 @@
+=== 1.1.0 / 2020-11-11
+
+  * Make use of frozen_string_literal
+  * Update tests to use newer minitest syntax
+
+=== 1.0.3 / 2018-01-25
+
+  * Updated the gem's metadata
+
 === 1.0.2 / 2012-09-16
 
   * Changed test runner from RSpec to MiniSpec

data/README.md

@@ -0,0 +1,69 @@
+**Status**: This project is in maintenance mode. I will not develop new features, but I will address Issues and Pull Requests.
+
+# Ascii85
+
+[![Build Status](https://travis-ci.org/DataWraith/ascii85gem.svg?branch=master)](https://travis-ci.org/DataWraith/ascii85gem)
+
+## Description
+
+Ascii85 is a simple gem that provides methods for encoding/decoding Adobe's
+binary-to-text encoding of the same name.
+
+See http://www.adobe.com/products/postscript/pdfs/PLRM.pdf page 131 and
+http://en.wikipedia.org/wiki/Ascii85 for more information about the format.
+
+
+## Installation
+
+`sudo gem install Ascii85`
+
+
+## Usage
+
+```
+require 'rubygems'
+require 'ascii85'
+
+Ascii85.encode("Ruby")
+=> "<~;KZGo~>"
+
+Ascii85.decode("<~;KZGo~>")
+=> "Ruby"
+```
+
+In addition, Ascii85.encode can take a second parameter that specifies the
+length of the returned lines. The default is 80; use `false` for unlimited.
+
+Ascii85.decode expects the input to be enclosed in <~ and ~> — it
+ignores everything outside of these. The output of Ascii85.decode
+will have the ASCII-8BIT encoding, so in Ruby 1.9 you may have to use
+<tt>String#force_encoding</tt> to correct the encoding.
+
+
+## Command-line utility
+
+This gem includes `ascii85`, a command-line utility modeled after `base64` from
+the GNU coreutils. It can be used to encode/decode Ascii85 directly from the
+command-line:
+
+```
+Usage: ascii85 [OPTIONS] [FILE]
+Encodes or decodes FILE or STDIN using Ascii85 and writes to STDOUT.
+    -w, --wrap COLUMN                Wrap lines at COLUMN. Default is 80, use 0 for no wrapping
+    -d, --decode                     Decode the input
+    -h, --help                       Display this help and exit
+        --version                    Output version information
+```
+
+
+## Contributors
+
+Thank you for your contribution!
+
+* [@aliismayilov](https://github.com/aliismayilov) contributed frozen String handling
+
+
+## License
+
+Ascii85 is distributed under the MIT License. See the accompanying LICENSE file
+for details.

data/bin/ascii85

@@ -51,7 +51,6 @@ ARGV.options do |opts|
   else
     abort "Superfluous operand(s): \"#{remaining_args.join('", "')}\""
   end
-
 end
 
 if @options[:file] == '-'

data/lib/Ascii85/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ascii85
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/ascii85.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 
 #
@@ -9,13 +10,12 @@
 # and http://en.wikipedia.org/wiki/Ascii85 for more information about
 # the format.
 #
-# Author::  Johannes Holzfuß (DataWraith@web.de)
+# Author::  Johannes Holzfuß (johannes@holzfuss.name)
 # License:: Distributed under the MIT License (see LICENSE file)
 #
 
 
 module Ascii85
-
   #
   # Encodes the bytes of the given String as Ascii85.
   #
@@ -37,7 +37,6 @@ module Ascii85
   #
   #
   def self.encode(str, wrap_lines = 80)
-
     to_encode = str.to_s
     return '' if to_encode.empty?
 
@@ -59,7 +58,7 @@ module Ascii85
       if tuple == 0
         'z'
       else
-        tmp = ""
+        tmp = String.new
         5.times do
           tmp << ((tuple % 85) + 33).chr
           tuple /= 85
@@ -82,7 +81,6 @@ module Ascii85
     end
 
     # Otherwise we wrap the lines
-
     line_length = [2, wrap_lines.to_i].max
 
     wrapped = []
@@ -122,7 +120,6 @@ module Ascii85
   # encountered.
   #
   def self.decode(str)
-
     input = str.to_s
 
     opening_delim = '<~'
@@ -134,9 +131,9 @@ module Ascii85
     # errors if an especially exotic input encoding is introduced.
     # As of Ruby 1.9.2 all non-dummy encodings work fine though.
     #
-    if opening_delim.respond_to?(:encode!)
-      opening_delim.encode!(input.encoding)
-      closing_delim.encode!(input.encoding)
+    if opening_delim.respond_to?(:encode)
+      opening_delim = opening_delim.encode(input.encoding)
+      closing_delim = closing_delim.encode(input.encoding)
     end
 
     # Get the positions of the opening/closing delimiters. If there is
@@ -153,7 +150,6 @@ module Ascii85
     result = []
 
     input.each_byte do |c|
-
       case c.chr
       when " ", "\t", "\r", "\n", "\f", "\0"
         # Ignore whitespace
@@ -189,7 +185,6 @@ module Ascii85
         raise(Ascii85::DecodingError,
               "Illegal character inside Ascii85: #{c.chr.dump}")
       end
-
     end
 
     # Convert result into a String
@@ -225,5 +220,4 @@ module Ascii85
   #   at least two characters.
   #
   class DecodingError < StandardError; end
-
 end

data/spec/lib/ascii85_spec.rb

@@ -7,11 +7,9 @@ require 'minitest/autorun'
 require File.expand_path('../../../lib/ascii85', __FILE__)
 
 describe Ascii85 do
-
   UNSUPPORTED_MSG = "This version of Ruby does not support encodings"
 
   TEST_CASES = {
-
     ""          => "",
     " "         => "<~+9~>",
 
@@ -44,9 +42,8 @@ describe Ascii85 do
   }
 
   it "#decode should be the inverse of #encode" do
-
     # Generate a random string
-    test_str = ""
+    test_str = String.new
     (1 + rand(255)).times do
       test_str << rand(256).chr
     end
@@ -54,14 +51,13 @@ describe Ascii85 do
     encoded = Ascii85.encode(test_str)
     decoded = Ascii85.decode(encoded)
 
-    decoded.must_equal test_str
+    assert_equal decoded, test_str
   end
 
   describe "#encode" do
-
     it "should encode all specified test-cases correctly" do
       TEST_CASES.each_pair do |input, encoded|
-        Ascii85.encode(input).must_equal encoded
+        assert_equal Ascii85.encode(input), encoded
       end
     end
 
@@ -73,7 +69,7 @@ describe Ascii85 do
       input_EUC_JP = 'どうもありがとうミスターロボット'.encode('EUC-JP')
       input_binary = input_EUC_JP.force_encoding('ASCII-8BIT')
 
-      Ascii85.encode(input_EUC_JP).must_equal Ascii85.encode(input_binary)
+      assert_equal Ascii85.encode(input_EUC_JP), Ascii85.encode(input_binary)
     end
 
     it "should produce output lines no longer than specified" do
@@ -82,7 +78,7 @@ describe Ascii85 do
       #
       # No wrap
       #
-      Ascii85.encode(test_str, false).count("\n").must_equal 0
+      assert_equal Ascii85.encode(test_str, false).count("\n"), 0
 
       #
       # x characters per line, except for the last one
@@ -107,23 +103,21 @@ describe Ascii85 do
       count_arr.delete_if { |len| len == x }
 
       # Now count_arr should be empty
-      count_arr.must_be_empty
+      assert_empty count_arr
     end
 
     it "should not split the end-marker to achieve correct line length" do
-      Ascii85.encode("\0" * 4, 4).must_equal "<~z\n~>"
+      assert_equal Ascii85.encode("\0" * 4, 4), "<~z\n~>"
     end
-
   end
 
   describe "#decode" do
-
     it "should decode all specified test-cases correctly" do
       TEST_CASES.each_pair do |decoded, input|
         if String.new.respond_to?(:encoding)
-          Ascii85.decode(input).must_equal decoded.dup.force_encoding('ASCII-8BIT')
+          assert_equal Ascii85.decode(input), decoded.dup.force_encoding('ASCII-8BIT')
         else
-          Ascii85.decode(input).must_equal decoded
+          assert_equal Ascii85.decode(input), decoded
         end
       end
     end
@@ -149,7 +143,7 @@ describe Ascii85 do
 
         begin
           to_test = input_ascii85.encode(encoding)
-          Ascii85.decode(to_test).force_encoding('UTF-8').must_equal input
+          assert_equal Ascii85.decode(to_test).force_encoding('UTF-8'), input
         rescue Encoding::ConverterNotFoundError
           # Ignore this encoding
         end
@@ -157,19 +151,19 @@ describe Ascii85 do
     end
 
     it "should only process data within delimiters" do
-      Ascii85.decode("<~~>").must_be_empty
-      Ascii85.decode("Doesn't contain delimiters").must_be_empty
-      Ascii85.decode("Mismatched ~>   delimiters 1").must_be_empty
-      Ascii85.decode("Mismatched <~   delimiters 2").must_be_empty
-      Ascii85.decode("Mismatched ~><~ delimiters 3").must_be_empty
-
-      Ascii85.decode("<~;KZGo~><~z~>").must_equal    "Ruby"
-      Ascii85.decode("FooBar<~z~>BazQux").must_equal "\0\0\0\0"
+      assert_empty Ascii85.decode("<~~>")
+      assert_empty Ascii85.decode("Doesn't contain delimiters")
+      assert_empty Ascii85.decode("Mismatched ~>   delimiters 1")
+      assert_empty Ascii85.decode("Mismatched <~   delimiters 2")
+      assert_empty Ascii85.decode("Mismatched ~><~ delimiters 3")
+
+      assert_equal Ascii85.decode("<~;KZGo~><~z~>"),    "Ruby"
+      assert_equal Ascii85.decode("FooBar<~z~>BazQux"), "\0\0\0\0"
     end
 
     it "should ignore whitespace" do
       decoded = Ascii85.decode("<~6   #LdYA\r\08\n  \n\n- *rF*(i\"Ch[s \t(D.RU,@ <-\'jDJ=0\f/~>")
-      decoded.must_equal 'Antidisestablishmentarianism'
+      assert_equal decoded, 'Antidisestablishmentarianism'
     end
 
     it "should return ASCII-8BIT encoded strings" do
@@ -177,29 +171,25 @@ describe Ascii85 do
         skip(UNSUPPORTED_MSG)
       end
 
-      Ascii85.decode("<~;KZGo~>").encoding.name.must_equal "ASCII-8BIT"
+      assert_equal Ascii85.decode("<~;KZGo~>").encoding.name, "ASCII-8BIT"
     end
 
     describe "Error conditions" do
-
       it "should raise DecodingError if it encounters a word >= 2**32" do
-        lambda { Ascii85.decode('<~s8W-#~>') }.must_raise(Ascii85::DecodingError)
+        assert_raises(Ascii85::DecodingError) { Ascii85.decode('<~s8W-#~>') }
       end
 
       it "should raise DecodingError if it encounters an invalid character" do
-        lambda { Ascii85.decode('<~!!y!!~>') }.must_raise(Ascii85::DecodingError)
+        assert_raises(Ascii85::DecodingError) { Ascii85.decode('<~!!y!!~>') }
       end
 
       it "should raise DecodingError if the last tuple consists of a single character" do
-        lambda { Ascii85.decode('<~!~>') }.must_raise(Ascii85::DecodingError)
+        assert_raises(Ascii85::DecodingError) { Ascii85.decode('<~!~>') }
       end
 
       it "should raise DecodingError if a z is found inside a 5-tuple" do
-        lambda { Ascii85.decode('<~!!z!!~>') }.must_raise Ascii85::DecodingError
+        assert_raises(Ascii85::DecodingError) { Ascii85.decode('<~!!z!!~>') }
       end
-
     end
-
   end
-
 end

metadata

@@ -1,98 +1,100 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: Ascii85
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.0.2
+version: !ruby/object:Gem::Version
+  version: 1.1.0
 platform: ruby
-authors: 
-  - "Johannes Holzfu\xC3\x9F"
+authors:
+- Johannes Holzfuß
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-16 00:00:00 Z
-dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: bundler
-    prerelease: false
-    requirement: &id001 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: 1.0.0
-    type: :development
-    version_requirements: *id001
-  - !ruby/object:Gem::Dependency 
-    name: minitest
-    prerelease: false
-    requirement: &id002 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: 2.6.0
-    type: :development
-    version_requirements: *id002
-  - !ruby/object:Gem::Dependency 
-    name: rake
-    prerelease: false
-    requirement: &id003 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: 0.9.2
-    type: :development
-    version_requirements: *id003
-description: Ascii85 provides methods to encode/decode Adobe's binary-to-text encoding of the same name.
-email: DataWraith@web.de
-executables: 
-  - ascii85
+date: 2020-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Ascii85 provides methods to encode/decode Adobe's binary-to-text encoding
+  of the same name.
+email: johannes@holzfuss.name
+executables:
+- ascii85
 extensions: []
-
-extra_rdoc_files: 
-  - README.rdoc
-  - LICENSE
-files: 
-  - .gemtest
-  - Ascii85.gemspec
-  - Gemfile
-  - History.txt
-  - LICENSE
-  - README.rdoc
-  - Rakefile
-  - bin/ascii85
-  - lib/Ascii85/version.rb
-  - lib/ascii85.rb
-  - spec/lib/ascii85_spec.rb
-homepage: http://rubyforge.org/projects/ascii85/
-licenses: 
-  - MIT
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- ".travis.yml"
+- Ascii85.gemspec
+- Gemfile
+- History.txt
+- LICENSE
+- README.md
+- Rakefile
+- bin/ascii85
+- lib/Ascii85/version.rb
+- lib/ascii85.rb
+- spec/lib/ascii85_spec.rb
+homepage: https://github.com/DataWraith/ascii85gem/
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
-  - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: Ascii85
-rubygems_version: 1.8.24
+rubygems_version: 3.1.4
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ascii85 encoder/decoder
-test_files: 
-  - spec/lib/ascii85_spec.rb
-has_rdoc: 
+test_files:
+- spec/lib/ascii85_spec.rb

data/README.rdoc

@@ -1,57 +0,0 @@
-= Ascii85
-
-* http://rubyforge.org/projects/ascii85
-
-
-== Description
-
-Ascii85 is a simple gem that provides methods for encoding/decoding Adobe's
-binary-to-text encoding of the same name.
-
-See http://www.adobe.com/products/postscript/pdfs/PLRM.pdf page 131 and
-http://en.wikipedia.org/wiki/Ascii85 for more information about the format.
-
-
-== Installation
-
-* sudo gem install Ascii85
-
-
-== Usage
-
-  require 'rubygems'
-  require 'ascii85'
-
-  Ascii85.encode("Ruby")
-  => "<~;KZGo~>"
-
-  Ascii85.decode("<~;KZGo~>")
-  => "Ruby"
-
-In addition, Ascii85.encode can take a second parameter that specifies the
-length of the returned lines. The default is 80; use +false+ for unlimited.
-
-Ascii85.decode expects the input to be enclosed in <~ and ~> — it
-ignores everything outside of these. The output of Ascii85.decode
-will have the ASCII-8BIT encoding, so in Ruby 1.9 you may have to use
-<tt>String#force_encoding</tt> to correct the encoding.
-
-
-== Command-line utility
-
-This gem includes +ascii85+, a command-line utility modeled after +base64+ from
-the GNU coreutils. It can be used to encode/decode Ascii85 directly from the
-command-line:
-
-    Usage: ascii85 [OPTIONS] [FILE]
-    Encodes or decodes FILE or STDIN using Ascii85 and writes to STDOUT.
-        -w, --wrap COLUMN                Wrap lines at COLUMN. Default is 80, use 0 for no wrapping
-        -d, --decode                     Decode the input
-        -h, --help                       Display this help and exit
-            --version                    Output version information
-
-
-== License
-
-Ascii85 is distributed under the MIT License. See the accompanying LICENSE file
-for details.