chars 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 744e39b682dc29231aafe96056415cc38c65e032df5c2a3aff6a5a846b38f67b
-  data.tar.gz: 47e309f42894f6d94ec2d15568d5d33df8a97600c1c227eb2366eb8fb8d56eb4
+  metadata.gz: 33adb9b0d02cf5d9c694e80e824bb4835b1503769e00d7f62ab901b35a46df64
+  data.tar.gz: ab56f3ae9533e9e5903aee56c491f6b40760694e4adc3d6ec364725182ccaeed
 SHA512:
-  metadata.gz: 20755db9457fda76ceed274d18919a43dbf3c850d0aaad6a38f077b0e89fcf15d7c0a79b3ac95fe158d5abef8db4e68bd0ccc6971f8989e0b4f7c918b9a282b8
-  data.tar.gz: 54bc4adfd93752f68454c475b57a1705428231f8decab3be8b8710d6c344c60715af7c466b21b7c398e7b2cc30801ff5fe77a4924e1ac34b4fa724c3f1a3adec
+  metadata.gz: de94222563f4de2c9c68660d95af2d6d0cdc54ee53ac61b726022c02f064fbe493ec3a208937ec2dcb52593560ea4bf6e7935ad0e4ac8b7f7ecfa22afd55f3f4
+  data.tar.gz: 172429354850160c92ac11d563effa5c8379d062c8fd1615a9db567abf7f1548528847af12f084ce20b16e7e654854ddcd857e0082ea677f41356fcf2c33bb5d

data/.github/workflows/ruby.yml

@@ -9,12 +9,12 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 2.4
-          - 2.5
-          - 2.6
-          - 2.7
-          - 3.0
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
           - jruby
+          - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2

data/ChangeLog.md

@@ -1,3 +1,19 @@
+### 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
+  technically a punctuation character.
+* Removed `\f`, `\n`, `\r`, `\t`, and `\v` from {Chars::PRINTABLE}, as other
+  whitespace characters besides space (`' '`) are not considered printable
+  characters.
+
 ### 0.3.0 / 2021-10-23
 
 * Added {Chars::WHITESPACE}.
@@ -22,7 +38,7 @@
 
 ### 0.2.2 / 2012-05-28
 
-* {Chars::CharSet#initialize} now raises a TypeError when given arguments
+* {Chars::CharSet#initialize} now raises a `TypeError` when given arguments
   that were neither a `String`, `Integer` or `Enumerable`.
 * Allow {Chars::CharSet#strings_in} to yield results as they are found.
 * Improved the performance of {Chars::CharSet#strings_in} when operating on
@@ -46,20 +62,21 @@
 
 ### 0.1.2 / 2009-09-21
 
-* 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 CharSet#random_distinct_bytes, CharSet#random_distinct_chars,
-  and CharSet#random_distinct_string (thanks flatline).
-* Use 'hoe/signing' for signed RubyGems.
+* 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::CharSet#random_distinct_bytes},
+  {Chars::CharSet#random_distinct_chars}, and {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.
 
 ### 0.1.1 / 2009-04-01
 
-* Renamed CharSet#=~ to CharSet#===.
-* Added an alias from CharSet#=~ to CharSet#===.
+* Renamed {Chars::CharSet#=~} to {Chars::CharSet#===}.
+* Added an alias from `Chars::CharSet#=~` to {Chars::CharSet#===}.
 
 ### 0.1.0 / 2009-03-16
 
@@ -80,7 +97,7 @@
   * Printable
   * Control
   * ASCII
-* Provides convenience methods for testing wether a String or Integer
+* Provides convenience methods for testing whether a `String` or `Integer`
   belongs to a certain character set.
 * Supports random text generation using specific character sets.
 

data/Gemfile

@@ -6,7 +6,9 @@ group :development do
   gem 'rake'
   gem 'rubygems-tasks', '~> 0.2'
   gem 'rspec',          '~> 3.0'
+
   gem 'kramdown'
+  gem 'redcarpet',       platform: :mri
   gem 'yard',           '~> 0.9'
   gem 'yard-spellcheck', require: false
 end

data/README.md

@@ -23,11 +23,11 @@ recognizing text and generating random text from specific character sets.
   * Lowercase Alpha: `a` - `z`
   * Alpha: `a` - `z`, `A` - `Z`
   * Alpha-numeric: `0` - `9`, `a` - `z`, `A` - `Z`
-  * Punctuation: `' '`, `'`, `"`, `` ` ``, `,`, `;`, `:`, `~`, `-`, `(`, `)`, `[`, `]`, `{`, `}`, `.`, `?`, `!`
-  * Symbols: `' '`, `'`, `"`, `` ` ``, `,`, `;`, `:`, `~`, `-`, `(`, `)`, `[`, `]`, `{`, `}`, `.`, `?`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `_`, `+`, `=`, `|`, `\`, `<`, `>`, `/`
+  * Punctuation: `'`, `"`, `` ` ``, `,`, `;`, `:`, `~`, `-`, `(`, `)`, `[`, `]`, `{`, `}`, `.`, `?`, `!`
+  * Symbols: `'`, `"`, `` ` ``, `,`, `;`, `:`, `~`, `-`, `(`, `)`, `[`, `]`, `{`, `}`, `.`, `?`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `_`, `+`, `=`, `|`, `\`, `<`, `>`, `/`
   * Space: `' '`, `\f`, `\n`, `\r`, `\t`, `\v`
   * Visible: `0` - `9`, `a` - `z`, `A` - `Z`, `'`, `"`, `` ` ``, `,`, `;`, `:`, `~`, `-`, `(`, `)`, `[`, `]`, `{`, `}`, `.`, `?`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `_`, `+`, `=`, `|`, `\`, `<`, `>`, `/`
-  * Printable: `0` - `9`, `a` - `z`, `A` - `Z`, `' '`, `'`, `"`, `` ` ``, `,`, `;`, `:`, `~`, `-`, `(`, `)`, `[`, `]`, `{`, `}`, `.`, `?`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, <code>*</code>, <code>_</code>, `+`, `=`, `|`, `\`, `<`, `>`, `/`, `\f`, `\n`, `\r`, `\t`, `\v`
+  * Printable: `0` - `9`, `a` - `z`, `A` - `Z`, `' '`, `'`, `"`, `` ` ``, `,`, `;`, `:`, `~`, `-`, `(`, `)`, `[`, `]`, `{`, `}`, `.`, `?`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, <code>*</code>, <code>_</code>, `+`, `=`, `|`, `\`, `<`, `>`, `/`
   * Control: `\x00` - `\x1f`, `\x7f`
   * Signed ASCII: `\x00` - `\x7f`
   * ASCII: `\x00` - `\xff`

data/gemspec.yml

@@ -15,6 +15,7 @@ metadata:
   source_code_uri:   https://github.com/postmodern/chars.rb
   bug_tracker_uri:   https://github.com/postmodern/chars.rb/issues
   changelog_uri:     https://github.com/postmodern/chars.rb/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
 
 required_ruby_version: ">= 2.0.0"
 

data/lib/chars/char_set.rb

@@ -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
@@ -44,6 +50,12 @@ module Chars
     #
     # Creates a new {CharSet}.
     #
+    # @param [Array<String, Integer, Enumerable>] arguments
+    #   The chars for the CharSet.
+    #
+    # @return [CharSet]
+    #   The new character set.
+    #
     # @see #initialize
     #
     # @since 0.2.1

data/lib/chars/chars.rb

@@ -1,3 +1,4 @@
+# encoding: ASCII-8BIT
 # frozen_string_literal: true
 
 require 'chars/char_set'
@@ -36,7 +37,7 @@ module Chars
   ALPHA_NUMERIC = ALPHA | NUMERIC
 
   # The punctuation character set
-  PUNCTUATION = CharSet[' ', '\'', '"', '`', ',', ';', ':', '~', '-',
+  PUNCTUATION = CharSet['\'', '"', '`', ',', ';', ':', '~', '-',
                         '(', ')', '[', ']', '{', '}', '.', '?', '!']
 
   # The symbolic character set
@@ -60,7 +61,7 @@ module Chars
   ]
   
   # The set of printable characters (including spaces)
-  PRINTABLE = ALPHA_NUMERIC | PUNCTUATION | SYMBOLS | SPACE
+  PRINTABLE = ALPHA_NUMERIC | PUNCTUATION | SYMBOLS | CharSet[' ']
 
   # The control-char character set
   CONTROL = CharSet[0..0x1f, 0x7f]
@@ -83,6 +84,11 @@ module Chars
     NUMERIC
   end
 
+  #
+  # Alias for {numeric}.
+  #
+  # @return [CharSet]
+  #   The decimal-digit character set.
   #
   # @see numeric
   #
@@ -229,6 +235,8 @@ module Chars
   #
   # The whitespace character set.
   #
+  # @return [CharSet]
+  #
   # @see #whitespace
   #
   def self.space

data/lib/chars/version.rb

@@ -1,4 +1,4 @@
 module Chars
   # chars version
-  VERSION = '0.3.0'
+  VERSION = '0.3.2'
 end

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,9 +130,13 @@ 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 }
+  let(:punctuation_chars) { "!\"'(),-.:;?[]`{}~".chars }
 
   describe "PUNCTUATION" do
     subject { described_class::PUNCTUATION }
@@ -104,9 +144,13 @@ 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 }
+  let(:symbolic_chars) { "!\"\#$%&'()*+,-./:;<=>?@[\\]^_`{|}~".chars }
 
   describe "SYMBOLS" do
     subject { described_class::SYMBOLS }
@@ -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,19 +196,27 @@ 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
     subject { described_class::PRINTABLE }
 
-    it "must contain all alpha-numeric, punctuation, symbols, and whitespace characters" do
+    it "must contain all alpha-numeric, punctuation, symbols, and space characters" do
       expect(subject.chars).to match_array(
         alpha_numeric_chars |
         punctuation_chars |
         symbolic_chars |
-        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 "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
 
   {

data/spec/extensions/string_spec.rb

@@ -58,7 +58,7 @@ describe String do
   end
 
   it "should recognize printable strings" do
-    expect("abc, [123]\nDEF").to be_printable
+    expect("abc, [123] DEF").to be_printable
   end
 
   it "should recognize control strings" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chars
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-23 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ metadata:
   source_code_uri: https://github.com/postmodern/chars.rb
   bug_tracker_uri: https://github.com/postmodern/chars.rb/issues
   changelog_uri: https://github.com/postmodern/chars.rb/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -86,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A Ruby library for working with various character sets