chars 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b408bb91d6c66422ccb57e66af6cdeceeb97d50c610628a9b99780319f4af57
-  data.tar.gz: '039bef18f59a8ea05fd2a259839432e9ad2eee15c692969bf611d11b15255b75'
+  metadata.gz: 56d15d9a339ad8d7a1106fcf031445010e73eca3c86184baf9d793d7c1765ce2
+  data.tar.gz: 75f7ce1ecfba11f41bcc64d26900d5da05a0cf30a0fcca4100cf6e3b6967f1e8
 SHA512:
-  metadata.gz: 803264ba7bafc4546df334bd2a508389f525c9814ab0452ef7b2b7c9b75cc0fb952c729f0b5b093cbede36d60be5badeb29ada0e29ee5b12ae3d681878aeb163
-  data.tar.gz: 2e9f1c229d9987e5cb1dfc0caada8c71582e0c72e8c03e7b39313c4bc1e9e447bdbdfcf641009174de47b4e0e94384296dc26cf8a136f72881bfd664fa311720
+  metadata.gz: ac159bcca8f06abaf6962a1d0c7b693fea39202bcce3426cd72baea4cbba4650cabbbf0cdc0147031ba71752f359c8659def748b3462454ac8fe992150b0de83
+  data.tar.gz: f8b148a08e9dd8b2f8b087b3cb88896e66c138460a317a591f9c3088e02129945b0a836f3f37c0894e86ad6f064a7cf747807efcc54df9712e51e5a034069d5e

data/.github/workflows/ruby.yml

@@ -9,15 +9,15 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - '2.6'
-          - '2.7'
           - '3.0'
           - '3.1'
+          - '3.2'
+          - '3.3'
           - jruby
           - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.yardopts

@@ -1 +1 @@
---markup markdown --title 'Chars Documentation' --protected --quiet
+--markup markdown --title 'Chars Documentation' --protected

data/ChangeLog.md

@@ -1,3 +1,15 @@
+### 0.3.3 / 2024-01-23
+
+* Switch to using `require_relative` to improve load-times.
+
+### 0.3.2 / 2022-12-02
+
+* Ensure all character Strings within the {Chars} character sets are encoded as
+  ASCII-8bit. This prevents transcoding issues when calling
+  `Chars::ASCII.random_string(length)`.
+* Changed {Chars::CharSet#initialize} to encode bytes greater than 256 as UTF-8.
+  Otherwise, bytes less than 256 will be encoded as ASCII-8bit.
+
 ### 0.3.1 / 2022-12-01
 
 * Removed the space character from {Chars::PUNCTUATION}, as spaces are not
@@ -42,8 +54,8 @@
 
 * Added {Chars::CharSet.[]}
 * Added {Chars::CharSet#<<}.
-* Added {Chars::CharSet#byte_to_char}.
-* Added {Chars::CharSet#char_to_byte}.
+* Added `Chars::CharSet#byte_to_char`.
+* Added `Chars::CharSet#char_to_byte`.
 * Added a cache of characters of the bytes within {Chars::CharSet}.
 * Use `String#each_char` to distinguish Unicode from ASCII.
 
@@ -57,10 +69,10 @@
 * Require `hoe` >= 2.3.3.
 * Require `yard` >= 0.2.3.5.
 * Require `rspec` >= 1.2.8.
-* Added {Chars.visibile} and {Chars::VISIBLE} (thanks flatline).
+* Added {Chars.visible} and {Chars::VISIBLE} (thanks flatline).
 * Added {Chars::CharSet#random_distinct_bytes},
-  {Chars::CharSet#random_distinct_chars}, and {CharSet#random_distinct_string}
-  (thanks flatline).
+  {Chars::CharSet#random_distinct_chars}, and
+  {Chars::CharSet#random_distinct_string} (thanks flatline).
 * Use `hoe/signing` for signed RubyGems.
 * Moved to YARD based documentation.
 * All specs now pass on JRuby 1.3.1.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2009-2021 Hal Brodigan
+Copyright (c) 2009-2024 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,5 +1,3 @@
-require 'rubygems'
-
 require 'rubygems/tasks'
 Gem::Tasks.new
 

data/chars.gemspec

@@ -7,10 +7,7 @@ Gem::Specification.new do |gem|
 
   gem.name    = gemspec.fetch('name')
   gem.version = gemspec.fetch('version') do
-                  lib_dir = File.join(File.dirname(__FILE__),'lib')
-                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
-
-                  require 'chars/version'
+                  require_relative 'lib/chars/version'
                   Chars::VERSION
                 end
 

data/lib/chars/char_set.rb

@@ -1,4 +1,4 @@
-require 'chars/string_enumerator'
+require_relative 'string_enumerator'
 
 require 'set'
 
@@ -17,7 +17,13 @@ module Chars
     def initialize(*arguments)
       super()
 
-      @chars = Hash.new { |hash,key| hash[key] = key.chr(Encoding::UTF_8) }
+      @chars = Hash.new do |hash,key|
+        hash[key] = if key > 0xff
+                      key.chr(Encoding::UTF_8)
+                    else
+                      key.chr(Encoding::ASCII_8BIT)
+                    end
+      end
 
       arguments.each do |subset|
         case subset
@@ -574,7 +580,7 @@ module Chars
     #   If no block is given, an Array or Hash of sub-strings is returned.
     #
     # @deprecated
-    #   Use {#each_substring_with_index}, {#substrings_with_index},
+    #   Use {#each_substring_with_index}, {#substrings_with_indexes},
     #   {#each_substring}, or {#substrings} instead.
     #
     def strings_in(data,options={},&block)
@@ -607,7 +613,7 @@ module Chars
     #   The given block will be passed each sequential string.
     #
     # @yieldparam [String] string
-    #   A string belonging to {#char_set} and `length` long.
+    #   A string belonging to the {CharSet} and of `length` long.
     #
     # @return [Enumerator]
     #   If no block is given, an Enumerator will be returned.
@@ -629,7 +635,7 @@ module Chars
 
     #
     # Returns an Enumerator that enumerates through every possible string
-    # belonging to the {CharSEt} and of the given length.
+    # belonging to the {CharSet} and of the given length.
     #
     # @param [Range, Array, Integer] length
     #   The desired length(s) of each string.
@@ -650,7 +656,7 @@ module Chars
     #   The other {CharSet} to union with.
     #
     # @return [CharSet]
-    #   The unioned {ChraSet}.
+    #   The unioned {CharSet}.
     #
     def |(set)
       set = CharSet.new(set) unless set.kind_of?(CharSet)

data/lib/chars/chars.rb

@@ -1,6 +1,7 @@
+# encoding: ASCII-8BIT
 # frozen_string_literal: true
 
-require 'chars/char_set'
+require_relative 'char_set'
 
 module Chars
   # The numeric decimal character set

data/lib/chars/extensions/integer.rb

@@ -1,4 +1,4 @@
-require 'chars/chars'
+require_relative '../chars'
 
 class Integer
 

data/lib/chars/extensions/string.rb

@@ -1,4 +1,4 @@
-require 'chars/chars'
+require_relative '../chars'
 
 class String
 

data/lib/chars/extensions.rb

@@ -1,2 +1,2 @@
-require 'chars/extensions/integer'
-require 'chars/extensions/string'
+require_relative 'extensions/integer'
+require_relative 'extensions/string'

data/lib/chars/version.rb

@@ -1,4 +1,4 @@
 module Chars
   # chars version
-  VERSION = '0.3.1'
+  VERSION = '0.3.3'
 end

data/lib/chars.rb

@@ -1,4 +1,4 @@
-require 'chars/char_set'
-require 'chars/chars'
-require 'chars/extensions'
-require 'chars/version'
+require_relative 'chars/char_set'
+require_relative 'chars/chars'
+require_relative 'chars/extensions'
+require_relative 'chars/version'

data/spec/char_set_spec.rb

@@ -42,6 +42,18 @@ describe Chars::CharSet do
       it "must populate the char set using the Integers as bytes" do
         expect(integers.all? { |i| subject.include?(i) }).to be(true)
       end
+
+      it "must encode them as ASCII 8bit Strings" do
+        expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+      end
+
+      context "when one of the Integers is greater than 0xff" do
+        let(:integers) { [0x100, 0xffff] }
+
+        it "must encode the Integer as a UTF-8 String" do
+          expect(subject.chars.map(&:encoding)).to all(be(Encoding::UTF_8))
+        end
+      end
     end
 
     context "when given an Array of Integers" do
@@ -50,6 +62,18 @@ describe Chars::CharSet do
       it "must populate the char set using the Integers as bytes" do
         expect(integers.all? { |i| subject.include?(i) }).to be(true)
       end
+
+      it "must encode them as ASCII 8bit Strings" do
+        expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+      end
+
+      context "when one of the Integers is greater than 0xff" do
+        let(:integers) { [0x100, 0xffff] }
+
+        it "must encode the Integer as a UTF-8 String" do
+          expect(subject.chars.map(&:encoding)).to all(be(Encoding::UTF_8))
+        end
+      end
     end
 
     context "when given a Range of Integers" do
@@ -58,6 +82,18 @@ describe Chars::CharSet do
       it "must populate the char set by enumerating over the Integer's bytes" do
         expect(integers.all? { |i| subject.include?(i) }).to be(true)
       end
+
+      it "must encode them as ASCII 8bit Strings" do
+        expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+      end
+
+      context "when one of the Integers is greater than 0xff" do
+        let(:integer_range) { (0x100..0x200) }
+
+        it "must encode the Integer as a UTF-8 String" do
+          expect(subject.chars.map(&:encoding)).to all(be(Encoding::UTF_8))
+        end
+      end
     end
   end
 

data/spec/chars_spec.rb

@@ -10,6 +10,10 @@ describe Chars do
     it "must contain numeric characters" do
       expect(subject.chars).to match_array(numeric_chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   describe "DIGITS" do
@@ -18,6 +22,10 @@ describe Chars do
     it "must equal NUMERIC" do
       expect(subject).to be(described_class::NUMERIC)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   describe "OCTAL" do
@@ -26,6 +34,10 @@ describe Chars do
     it "must contain all octal characters" do
       expect(subject.chars).to match_array("01234567".chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   let(:uppercase_hex_chars) { "0123456789ABCDEF".chars }
@@ -36,6 +48,10 @@ describe Chars do
     it "must contain all upper-case hexadecimal characters" do
       expect(subject.chars).to match_array(uppercase_hex_chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   let(:lowercase_hex_chars) { "0123456789abcdef".chars }
@@ -46,6 +62,10 @@ describe Chars do
     it "must contain all lower-case hexadecimal characters" do
       expect(subject.chars).to match_array(lowercase_hex_chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   describe "HEXADECIMAL" do
@@ -54,6 +74,10 @@ describe Chars do
     it "must contain both upper-case and lower-case hexadecimal characters" do
       expect(subject.chars).to match_array(uppercase_hex_chars | lowercase_hex_chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   let(:uppercase_alpha_chars) { "ABCDEFGHIJKLMNOPQRSTUVWXYZ".chars }
@@ -64,6 +88,10 @@ describe Chars do
     it "must contain all upper-case alpha characters" do
       expect(subject.chars).to match_array(uppercase_alpha_chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   let(:lowercase_alpha_chars) { "abcdefghijklmnopqrstuvwxyz".chars }
@@ -74,6 +102,10 @@ describe Chars do
     it "must contain all lower-case alpha characters" do
       expect(subject.chars).to match_array(lowercase_alpha_chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   let(:alpha_chars) { uppercase_alpha_chars | lowercase_alpha_chars }
@@ -84,6 +116,10 @@ describe Chars do
     it "must contain all alpha characters" do
       expect(subject.chars).to match_array(alpha_chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   let(:alpha_numeric_chars) { alpha_chars | numeric_chars }
@@ -94,6 +130,10 @@ describe Chars do
     it "must contain all alpha-numeric characters" do
       expect(subject.chars).to match_array(alpha_numeric_chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   let(:punctuation_chars) { "!\"'(),-.:;?[]`{}~".chars }
@@ -104,6 +144,10 @@ describe Chars do
     it "must contain all punctuation characters" do
       expect(subject.chars).to match_array(punctuation_chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   let(:symbolic_chars) { "!\"\#$%&'()*+,-./:;<=>?@[\\]^_`{|}~".chars }
@@ -114,6 +158,10 @@ describe Chars do
     it "must contain all symbolic characters" do
       expect(subject.chars).to match_array(symbolic_chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   let(:whitespace_chars) { "\t\n\v\f\r ".chars }
@@ -124,6 +172,10 @@ describe Chars do
     it "must contain all white-space characters" do
       expect(subject.chars).to match_array(whitespace_chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   describe "SPACE" do
@@ -132,6 +184,10 @@ describe Chars do
     it "must equal WHITESPACE" do
       expect(subject).to be(described_class::WHITESPACE)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   describe "VISIBLE" do
@@ -140,6 +196,10 @@ describe Chars do
     it "must contain all all alpha-numeric, symbols, and some punctuation" do
       expect(subject.chars).to match_array(alpha_numeric_chars | "!\"\#$%&'()*+,-./:;<=>?@[\\]^_`{|}~".chars)
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   describe "PRINTABLE" do
@@ -153,6 +213,10 @@ describe Chars do
         [' ']
       )
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   describe "CONTROL" do
@@ -161,6 +225,10 @@ describe Chars do
     it "must contain ASCII bytes 0x00 - 0x1f and 0x7f" do
       expect(subject.bytes).to eq([*0x00..0x1f, 0x7f])
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   describe "SIGNED_ASCII" do
@@ -169,6 +237,10 @@ describe Chars do
     it "must contain ASCII bytes 0x00 - 0x7f" do
       expect(subject.bytes).to eq([*0x00..0x7f])
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   describe "ASCII" do
@@ -177,6 +249,10 @@ describe Chars do
     it "must contain ASCII bytes 0x00 - 0xff" do
       expect(subject.bytes).to eq([*0x00..0xff])
     end
+
+    it "must only contain ASCII-8bit encoded characters" do
+      expect(subject.chars.map(&:encoding)).to all(be(Encoding::ASCII_8BIT))
+    end
   end
 
   {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chars
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A Ruby library for working with various character sets