Ascii85 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcb6cc7ca3f3ca02c235e5a0d5b908396524e265c9adaaf56c50bc62117c5ee7
-  data.tar.gz: c005e9a67ecc1def46d040f06e91cb7984d0cfd43d9729638d60b2fe19d2ab8c
+  metadata.gz: e134217a95580db89dd446ac40511345e8c0a317be617b9b04e2ac8ca5db9670
+  data.tar.gz: bcc1f3f71f2f5748958825602ef58c7365ef52f7fe3265a9409fd1b84b5c8d4f
 SHA512:
-  metadata.gz: c6fef31cebe36d41eee64ff857e87007b176b262fc4c667666f6360714b9d15274afb192572cf5bba31953f13ecde7c1b1ea60697ebf83a43dc80b35f64d94dd
-  data.tar.gz: 2bd0e1367f729cb42d2163e5eeeba540e243138a23cfeb6bf9e2d93d49c80dc12227d65b60bd1db2f6272ab8c9bac19d0aaac37a5e9d48e14dd50d45abb8a749
+  metadata.gz: 4c15434410e46485ada5dcc04929092f77da1533861d22ffe65ab0e2f1e8300a821b16524fbeb5ad137cc6a139232a5684dfe6fd34c5ad33e19d68a95d3f604e
+  data.tar.gz: a397048e6009d3adf0c2582cfe9dbd913f6b8888c19fbf48939b1a7ab48de704fa7fb76253d5d3a05d105215fb9e9f2da299d91c12cf5e6c2a3cb2636a2b6f8a

data/Ascii85.gemspec

@@ -1,25 +1,26 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "Ascii85/version"
+# frozen_string_literal: true
+
+require_relative 'lib/Ascii85/version'
 
 Gem::Specification.new do |s|
-  s.name        = "Ascii85"
+  s.name        = 'Ascii85'
   s.version     = Ascii85::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.author      = "Johannes Holzfuß"
-  s.email       = "johannes@holzfuss.name"
+  s.author      = 'Johannes Holzfuß'
+  s.email       = 'johannes@holzfuss.name'
   s.license     = 'MIT'
-  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.homepage    = 'https://github.com/DataWraith/ascii85gem/'
+  s.summary     = 'Ascii85 encoder/decoder'
+  s.description = "Ascii85 provides methods to encode/decode Adobe's binary-to-text encoding of the same name."
+
+  s.required_ruby_version = '>= 2.7.0'
 
-  s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "minitest",">= 2.6.0"
-  s.add_development_dependency "rake",    ">= 0.9.2"
+  s.add_development_dependency 'minitest', '~> 5', '>= 5.12.0'
+  s.add_development_dependency 'rake', '~> 13'
 
-  s.files            = `git ls-files`.split("\n") - ['.gitignore']
+  s.files            = `git ls-files`.split("\n") - ['.gitignore', '.github/workflows/ruby.yml']
   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.executables      = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths    = ['lib']
   s.extra_rdoc_files = ['README.md', 'LICENSE']
 end

data/CHANGELOG.md

@@ -0,0 +1,64 @@
+# Ascii85 Changelog
+
+## [2.0.0] - 2024-08-20
+
+### BREAKING CHANGES
+
+- The minimum required Ruby version has been raised to 2.7.0.
+
+### Added
+
+- `Ascii85.decode_raw` method that doesn't expect the input to be wrapped in `<~` and `~>` delimiters.
+- `Ascii85.extract` method to extract encoded text from between `<~` and `~>` for feeding to `#decode_raw`.
+- Option to pass an IO-object as input to `#encode` and `#decode_raw` instead of a String.
+- Option to pass an IO-object to `#encode` and `#decode_raw` for output. Output is written to the object instead of being returned as a String.
+- Streaming capability for `#encode` and `#decode_raw` when both input and output are IO objects, using constant memory.
+
+## [1.1.1] - 2024-05-09
+
+### Fixed
+
+- Make `bin/ascii85` Ruby 3.2-compatible (thanks @tylerwillingham)
+- Slightly improved error handling of `bin/ascii85`
+
+## [1.1.0] - 2020-11-11
+
+### Added
+
+- Make use of frozen_string_literal (thanks @aliismayilov)
+
+### Changed
+
+- Updated tests to use newer minitest syntax
+
+## [1.0.3] - 2018-01-25
+
+### Changed
+
+- Updated the gem's metadata
+
+## [1.0.2] - 2012-09-16
+
+### Changed
+
+- Changed test runner from RSpec to MiniSpec
+- Added support for rubygems-test
+- Minor changes to make packaging easier
+
+## [1.0.1] - 2011-05-05
+
+### Changed
+
+- Removed `hoe` dependency in favor of `bundler`
+- Minor corrections in the documentation
+
+## [1.0.0] - 2009-12-25
+
+### Added
+
+- Ruby 1.9 compatibility
+- Command-line en- and decoder
+
+## [0.9.0] - 2009-02-17
+
+- Initial release

data/Gemfile

@@ -1,4 +1,6 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in Ascii85.gemspec
 gemspec

data/README.md

@@ -1,27 +1,30 @@
-**Status**: This project is in maintenance mode. I will not develop new features, but I will address Issues and Pull Requests.
+**Status**: This project is feature-complete. With the exception of fixes to reported bugs, no further development will take place.
 
 # 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
+Ascii85 is a Ruby 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.
+See the Adobe PostScript Language Reference ([archived version][PLRM]) page 131
+and [Wikipedia](https://en.wikipedia.org/wiki/Ascii85) for more information
+about the format.
+
+[PLRM]: https://web.archive.org/web/20161222092741/https://www.adobe.com/products/postscript/pdfs/PLRM.pdf
 
 
 ## Installation
 
-`sudo gem install Ascii85`
+`$ gem install Ascii85`
+
+> [!IMPORTANT]
+> Note that the gem name is capitalized.
 
 
 ## Usage
 
-```
-require 'rubygems'
+```ruby
 require 'ascii85'
 
 Ascii85.encode("Ruby")
@@ -29,15 +32,28 @@ Ascii85.encode("Ruby")
 
 Ascii85.decode("<~;KZGo~>")
 => "Ruby"
+
+Ascii85.extract("Foo<~;KZGo~>Bar")
+=> ";KZGo"
+
+Ascii85.decode_raw(";KZGo")
+=> "Ruby"
 ```
 
-In addition, Ascii85.encode can take a second parameter that specifies the
+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.
+`Ascii85.decode` expects the input to be enclosed in `<~` and `~>` — it
+ignores everything outside of these, while `Ascii85.decode_raw` assumes that
+the entire String passed in is encoded in Ascii85. If you need to, you can use
+`Ascii85.extract` to find and extract the first substring of the input that is
+enclosed by the `<~` and `~>` delimiters.
+
+The output of `Ascii85.decode` and `Ascii85.decode_raw` will be a String that
+has the `ASCII-8BIT` encoding, so you may have to use `String#force_encoding` to
+convert it to the desired encoding.
+
+For further options, see the [Documentation](https://www.rubydoc.info/gems/Ascii85/).
 
 
 ## Command-line utility
@@ -52,17 +68,10 @@ 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
+    -V, --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

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
@@ -7,6 +9,6 @@ Rake::TestTask.new do |t|
   t.test_files = FileList['spec/**/*_spec.rb']
 end
 
-task :specs   => :test
-task :tests   => :test
-task :default => :test
+task specs: :test
+task tests: :test
+task default: :test

data/bin/ascii85

@@ -1,80 +1,112 @@
 #!/usr/bin/env ruby
-# encoding: utf-8
+# frozen_string_literal: true
 
 #
 # A simple command-line tool to de- and encode Ascii85, modeled after `base64`
 # from the GNU Coreutils.
 #
 
-
-require "optparse"
+require 'optparse'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'ascii85')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'Ascii85', 'version')
 
-@options = {
-  :wrap   => 80,
-  :decode => false
-}
-
-ARGV.options do |opts|
-  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [OPTIONS] [FILE]\n" +
-                "Encodes or decodes FILE or STDIN using Ascii85 and writes to STDOUT."
+class CLI
+  attr_reader :options
 
+  def initialize(argv, stdin: $stdin, stdout: $stdout)
+    @in = stdin
+    @out = stdout
 
-  opts.on( "-w", "--wrap COLUMN", Integer,
-          "Wrap lines at COLUMN. Default is 80, use 0 for no wrapping") do |opt|
+    @options = {
+      wrap: 80,
+      action: :encode
+    }
 
-    @options[:wrap] = opt.abs
-    @options[:wrap] = false if opt.zero?
+    parse_options(argv)
   end
 
-  opts.on( "-d", "--decode", "Decode the input") do
-    @options[:decode] = true
+  def parse_options(argv)
+    @parser = OptionParser.new do |opts|
+      opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [OPTIONS] [FILE]\n" \
+                    'Encodes or decodes FILE or STDIN using Ascii85 and writes to STDOUT.'
+
+      opts.on('-w', '--wrap COLUMN', Integer,
+              'Wrap lines at COLUMN. Default is 80, use 0 for no wrapping') do |opt|
+        @options[:wrap] = opt.abs
+        @options[:wrap] = false if opt.zero?
+      end
+
+      opts.on('-d', '--decode', 'Decode the input') do
+        @options[:action] = :decode
+      end
+
+      opts.on('-h', '--help', 'Display this help and exit') do
+        @options[:action] = :help
+      end
+
+      opts.on('-V', '--version', 'Output version information') do |_opt|
+        @options[:action] = :version
+      end
+
+    end
+
+    remaining_args = @parser.parse!(argv)
+
+    case remaining_args.size
+    when 0
+      @options[:file] = '-'
+    when 1
+      @options[:file] = remaining_args.first
+    else
+      raise(OptionParser::ParseError, "Superfluous operand(s): \"#{remaining_args[1..].join('", "')}\"")
+    end
   end
+  
+  def input
+    fn = @options[:file]
 
-  opts.on( "-h", "--help", "Display this help and exit") do
-    puts opts
-    exit
-  end
+    return @in.binmode if fn == '-'
 
-  opts.on( "--version", "Output version information") do |opt|
-    puts "Ascii85 v#{Ascii85::VERSION},\nwritten by Johannes Holzfuß"
-    exit
+    raise(StandardError, "File not found: \"#{fn}\"") unless File.exist?(fn)
+    raise(StandardError, "File is not readable: \"#{fn}\"") unless File.readable_real?(fn)
+
+    File.new(fn, 'rb')
   end
 
-  remaining_args = opts.parse!
+  def decode
+    Ascii85.decode(input.read, out: @out)
+  end
 
-  case remaining_args.size
-  when 0
-    @options[:file] = '-'
-  when 1
-    @options[:file] = remaining_args.first
-  else
-    abort "Superfluous operand(s): \"#{remaining_args.join('", "')}\""
+  def encode
+    Ascii85.encode(input, @options[:wrap], out: @out)
   end
-end
 
-if @options[:file] == '-'
-  @input = $stdin.binmode.read
-else
-  unless File.exists?(@options[:file])
-    abort "File not found: \"#{@options[:file]}\""
+  def version 
+    "Ascii85 v#{Ascii85::VERSION},\nwritten by Johannes Holzfuß"
   end
 
-  unless File.readable_real?(@options[:file])
-    abort "File is not readable: \"#{@options[:file]}\""
+  def help
+    @parser
   end
 
-  File.open(@options[:file], 'rb') do |f|
-    @input = f.read
+  def call
+    case @options[:action]
+    when :help then @out.puts help
+    when :version then @out.puts version
+    when :encode then encode
+    when :decode then decode
+    end
   end
 end
 
-if @options[:decode]
+if File.basename($PROGRAM_NAME) == "ascii85"
   begin
-    print Ascii85.decode(@input)
-  rescue Ascii85::DecodingError => error
-    abort "Decoding Error: #{error.message.to_s}"
+    CLI.new(ARGV).call
+  rescue OptionParser::ParseError => e
+    abort e.message
+  rescue Ascii85::DecodingError => e
+    abort "Decoding Error: #{e.message}"
+  rescue StandardError => e
+    abort "Error: #{e.message}"
   end
-else
-  print Ascii85.encode(@input, @options[:wrap])
 end

data/lib/Ascii85/version.rb

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