chars 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a22fd4d88e24c4f378880de5e324ac4acc4ff197c541baa1b840a8852d420afa
-  data.tar.gz: ad9c7a38b080490366aaf4142eb642224d551da165ddeedfb4fc1fd0e6bf0728
+  metadata.gz: 6257e8d2fa2f62cc364fc2e0ba901d777963476968264dd7747bc4407e5ff54c
+  data.tar.gz: 16f5ecc2f44e8265869aac4946a64cacda2ae8dcdae3b669081a48d34f034f4e
 SHA512:
-  metadata.gz: 5886283079f3bfcf060facf0b0520a51f75066b0301a87750d262e1e4326fad164e541c9580aad1a3f86810430732b2e1933b2ccee26eda6667d0da2aaf2bf00
-  data.tar.gz: 0313dcedc0872cc15f84804bdea985bf726040b48d48018084800c8e07f4224267b5802df4da9d68c5ce79ff0239e4af7138db522fa8523647251524d51e6ba1
+  metadata.gz: ebaf16c18de6b000b6219bf4afe7142926e24293b6b1e62214f937c51c5bdf7f5ffa7f46eecb151e1da044f7b49e1479b7d2cc947a6e20fa2a586f28b4a8a525
+  data.tar.gz: 4c9c98dcbab77b201b86fc32a628575e4b0ebc03608c50c7591b51a70821127778ced5122f57de846c7c863440fa0e9555fe7bfd2940a913e494a929c74a513e

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.2.4 / 2021-10-22
+
+* Require [ruby] >= 2.0.0.
+* Added {Chars::CharSet#initialize_copy} to prevent leaking characters
+  between copied {Chars::CharSet} objects.
+
 ### 0.2.3 / 2020-12-25
 
 * Change {Chars::CharSet} to inherit from `Set`, instead of `SortedSet`.
@@ -66,3 +72,4 @@
   belongs to a certain character set.
 * Supports random text generation using specific character sets.
 
+[ruby]: https://www.ruby-lang.org/

data/Gemfile

@@ -8,4 +8,5 @@ group :development do
   gem 'rspec',          '~> 3.0'
   gem 'kramdown'
   gem 'yard',           '~> 0.9'
+  gem 'yard-spellcheck', require: false
 end

data/LICENSE.txt

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

data/README.md

@@ -1,9 +1,10 @@
 # Chars
 
-* [Source](https://github.com/postmodern/chars#readme)
-* [Issues](https://github.com/postmodern/chars/issues)
-* [Documentation](http://rubydoc.info/gems/chars)
-* [Email](mailto:postmodern.mod3 at gmail.com)
+[![CI](https://github.com/postmodern/chars.rb/actions/workflows/ruby.yml/badge.svg)](https://github.com/postmodern/chars.rb/actions/workflows/ruby.yml)
+
+* [Source](https://github.com/postmodern/chars.rb#readme)
+* [Issues](https://github.com/postmodern/chars.rb/issues)
+* [Documentation](https://rubydoc.info/gems/chars)
 
 ## Description
 
@@ -13,84 +14,111 @@ recognizing text and generating random text from specific character sets.
 ## Features
 
 * Provides character sets for:
-  * Numeric ('0' - '9')
-  * Octal ('0' - '7')
-  * Uppercase Hexadecimal ('0' - '9', 'A' - 'F')
-  * Lowercase Hexadecimal ('0' - '9', 'a' - 'f')
-  * Hexadecimal ('0' - '9', 'a' - 'f', 'A' - 'F')
-  * Uppercase Alpha ('A' - 'Z')
-  * Lowercase Alpha ('a' - 'z')
-  * Alpha ('a' - 'z', 'A' - 'Z')
-  * Alpha-numeric ('0' - '9', 'a' - 'z', 'A' - 'Z')
-  * Punctuation (' ', '\'', '"', '`', ',', ';', ':', '~', '-', '(', ')',
-    '[', ']', '{', '}', '.', '?', '!')
-  * Symbols (' ', '\'', '"', '`', ',', ';', ':', '~', '-', '(', ')',
-    '[', ']', '{', '}', '.', '?', '!', '@', '#', '$', '%', '^', '&', '*',
-    '_', '+', '=', '|', '\\', '<', '>', '/')
-  * Space (' ', '\f', '\n', '\r', '\t', '\v')
-  * Visible ('0' - '9', 'a' - 'z', 'A' - 'Z', '\'', '"', '`', ',',
-    ';', ':', '~', '-', '(', ')', '[', ']', '{', '}', '.', '?', '!', '@',
-    '#', '$', '%', '^', '&', '*', '_', '+', '=', '|', '\\', '<', '>', '/',)
-  * Printable ('0' - '9', 'a' - 'z', 'A' - 'Z', ' ', '\'', '"', '`', ',',
-    ';', ':', '~', '-', '(', ')', '[', ']', '{', '}', '.', '?', '!', '@',
-    '#', '$', '%', '^', '&', '*', '_', '+', '=', '|', '\\', '<', '>', '/',
-    '\f', '\n', '\r', '\t', '\v')
-  * Control ('\x00' - '\x1f', '\x7f')
-  * Signed ASCII ('\x00' - '\x7f')
-  * ASCII ('\x00' - '\xff')
+  * Numeric: `0` - `9`
+  * Octal: `0` - `7`
+  * Uppercase Hexadecimal: `0` - `9`, `A` - `F`
+  * Lowercase Hexadecimal: `0` - `9`, `a` - `f`
+  * Hexadecimal: `0` - `9`, `a` - `f`, `A` - `F`
+  * Uppercase Alpha: `A` - `Z`
+  * Lowercase Alpha: `a` - `z`
+  * Alpha: `a` - `z`, `A` - `Z`
+  * Alpha-numeric: `0` - `9`, `a` - `z`, `A` - `Z`
+  * 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`
+  * Control: `\x00` - `\x1f`, `\x7f`
+  * Signed ASCII: `\x00` - `\x7f`
+  * ASCII: `\x00` - `\xff`
 
 ## Examples
 
 Determine whether a byte belongs to a character set:
 
-    0x41.alpha?
-    # => true
+```ruby
+0x41.alpha?
+# => true
+```
 
 Determine whether a String belongs to a character set:
 
-    "22e1c0".hex?
-    # => true
+```ruby
+"22e1c0".hex?
+# => true
+```
 
 Find all sub-strings that belong to a character set within a String:
 
-    ls = File.read('/bin/ls')
-    Chars.printable.strings_in(ls)
-    # => ["/lib64/ld-linux-x86-64.so.2", "KIq/", "5J~!", "%L~!", ...]
+```ruby
+ls = File.read('/bin/ls')
+Chars.printable.strings_in(ls)
+# => ["/lib64/ld-linux-x86-64.so.2", "KIq/", "5J~!", "%L~!", ...]
+```
 
 Return a random character from the set of all characters:
 
-    Chars.all.random_char
-    # => "\x94"
+```ruby
+Chars.all.random_char
+# => "\x94"
+```
 
 Return a random Array of characters from the alpha-numeric character set:
 
-    Chars.alpha_numeric.random_chars(10)
-    # => ["Q", "N", "S", "4", "x", "z", "3", "M", "F", "F"]
+```ruby
+Chars.alpha_numeric.random_chars(10)
+# => ["Q", "N", "S", "4", "x", "z", "3", "M", "F", "F"]
+```
 
 Return a random Array of a random length of unique characters from the
 visible character set:
 
-    Chars.visible.random_distinct_chars(1..10)
-    # => ["S", "l", "o", "8", "'", "q"]
+```ruby
+Chars.visible.random_distinct_chars(1..10)
+# => ["S", "l", "o", "8", "'", "q"]
+```
 
 Return a random String from the set of all characters:
 
-    Chars.all.random_string(10)
-    # => "\xc2h\xad\xccm7\x1e6J\x13"
+```ruby
+Chars.all.random_string(10)
+# => "\xc2h\xad\xccm7\x1e6J\x13"
+```
 
 Return a random String with a random length between 5 and 10, from the
 set of space characters:
 
-    Chars.space.random_string(5..10)
-    # => "\r\v\n\t\n\f"
+```ruby
+Chars.space.random_string(5..10)
+# => "\r\v\n\t\n\f"
+```
 
 ## Requirements
 
-* [ruby](http://www.ruby-lang.org/) >= 1.8.7
+* [ruby](https://www.ruby-lang.org/) >= 2.0.0
 
 ## Install
 
-    $ sudo gem install chars
+    $ gem install chars
+
+### gemspec
+
+```ruby
+gem.add_dependency 'chars', '~> 0.2'
+```
+
+### Gemfile
+
+```ruby
+gem 'chars', '~> 0.2'
+```
+
+## Crystal
+
+[chars.cr] is a [Crystal] port of this library.
+
+[chars.cr]: https://github.com/postmodern/chars.cr
+[Crystal]: https://crystal-lang.org/
 
 ## License
 

data/Rakefile

@@ -9,4 +9,4 @@ task :test => :spec
 task :default => :spec
 
 require 'yard'
-YARD::Rake::YardocTask.new  
+YARD::Rake::YardocTask.new

data/chars.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.authors     = Array(gemspec['authors'])
   gem.email       = gemspec['email']
   gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
 
   glob = lambda { |patterns| gem.files & Dir[*patterns] }
 

data/gemspec.yml

@@ -5,12 +5,18 @@ description:
   recognizing text and generating random text from specific character sets.
 
 license: MIT
-homepage: https://github.com/postmodern/chars#readme
+homepage: https://github.com/postmodern/chars.rb#readme
 authors: Postmodern
 email: postmodern.mod3@gmail.com
 has_yard: true
 
-required_ruby_version: ">= 1.8.7"
+metadata:
+  documentation_uri: https://rubydoc.info/gems/chars
+  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
+
+required_ruby_version: ">= 2.0.0"
 
 development_dependencies:
   bundler: ~> 2.0

data/lib/chars/char_set.rb

@@ -15,7 +15,7 @@ module Chars
     def initialize(*arguments)
       super()
 
-      @chars = Hash.new { |hash,key| hash[key] = byte_to_char(key) }
+      @chars = Hash.new { |hash,key| hash[key] = key.chr(Encoding::UTF_8) }
 
       arguments.each do |subset|
         case subset
@@ -28,9 +28,19 @@ module Chars
         end
       end
     end
-    
+
+    #
+    # Initializes the copy of another {CharSet} object.
+    #
+    # @param [CharSet] other
+    #   The other {CharSet} object.
     #
-    # Creates a new character set.
+    def initialize_copy(other)
+      @chars = other.instance_variable_get('@chars').dup
+    end
+
+    #
+    # Creates a new {CharSet}.
     #
     # @see #initialize
     #
@@ -58,7 +68,7 @@ module Chars
       case other
       when String
         other.each_char do |char|
-          byte = char_to_byte(char)
+          byte = char.ord
 
           @chars[byte] = char
           super(byte)
@@ -79,42 +89,42 @@ module Chars
     alias map_bytes map
 
     #
-    # Determines if a character is contained within the character set.
+    # Determines if a character is contained within the {CharSet}.
     #
     # @param [String] char
     #   The character to search for.
     #
     # @return [Boolean]
     #   Specifies whether the character is contained within the
-    #   character set.
+    #   {CharSet}.
     #
     def include_char?(char)
       unless char.empty?
-        @chars.has_value?(char) || include_byte?(char_to_byte(char))
+        @chars.has_value?(char) || include_byte?(char.ord)
       else
         false
       end
     end
 
     #
-    # The characters within the character set.
+    # The characters within the {CharSet}.
     #
     # @return [Array<String>]
-    #   All the characters within the character set.
+    #   All the characters within the {CharSet}.
     #
     def chars
       map { |byte| @chars[byte] }
     end
 
     #
-    # Iterates over every character within the character set.
+    # Iterates over every character within the {CharSet}.
     #
     # @yield [char]
     #   If a block is given, it will be passed each character in the
-    #   character set.
+    #   {CharSet}.
     #
     # @yieldparam [String] char
-    #   Each character in the character set.
+    #   Each character in the {CharSet}.
     #
     # @return [Enumerator]
     #   If no block is given, an enumerator object will be returned.
@@ -126,50 +136,54 @@ module Chars
     end
 
     #
-    # Selects characters from the character set.
+    # Selects characters from the {CharSet}.
     #
     # @yield [char]
     #   If a block is given, it will be used to select the characters
-    #   from the character set.
+    #   from the {CharSet}.
     #
     # @yieldparam [String] char
     #   The character to select or reject.
     #
     # @return [Array<String>]
-    #   The selected characters from the character set.
+    #   The selected characters from the {CharSet}.
     #
     def select_chars(&block)
       each_char.select(&block)
     end
 
     #
-    # Maps the characters of the character set.
+    # Maps the characters of the {CharSet}.
     #
     # @yield [char]
     #   The given block will be used to transform the characters within
-    #   the character set.
+    #   the {CharSet}.
     #
     # @yieldparam [String] char
-    #   Each character in the character set.
+    #   Each character in the {CharSet}.
     #
     # @return [Array<String>]
-    #   The mapped characters of the character set.
+    #   The mapped characters of the {CharSet}.
     #
     def map_chars(&block)
       each_char.map(&block)
     end
 
+    #
+    # Returns a random byte from the {CharSet}.
     #
     # @return [Integer]
-    #   A random byte from the character set.
+    #   A random byte value.
     #
     def random_byte
       self.entries[rand(self.length)]
     end
 
+    #
+    # Returns a random character from the {CharSet}.
     #
     # @return [String]
-    #   A random char from the character set.
+    #   A random char value.
     #
     def random_char
       @chars[random_byte]
@@ -185,7 +199,7 @@ module Chars
     #   The block will receive the random bytes.
     #
     # @yieldparam [Integer] byte
-    #   The random byte from the character set.
+    #   The random byte from the {CharSet}.
     #
     # @return [Enumerator]
     #   If no block is given, an enumerator object will be returned.
@@ -207,7 +221,7 @@ module Chars
     #   The block will receive the random characters.
     #
     # @yieldparam [String] char
-    #   The random character from the character set.
+    #   The random character from the {CharSet}.
     #
     # @return [Enumerator]
     #   If no block is given, an enumerator object will be returned.
@@ -219,7 +233,7 @@ module Chars
     end
 
     #
-    # Creates an Array of random bytes from the character set.
+    # Creates an Array of random bytes from the {CharSet}.
     #
     # @param [Integer, Array, Range] length
     #   The length of the Array of random bytes.
@@ -228,15 +242,18 @@ module Chars
     #   The randomly selected bytes.
     #
     def random_bytes(length)
-      if (length.kind_of?(Array) || length.kind_of?(Range))
-        Array.new(length.sort_by { rand }.first) { random_byte }
+      case length
+      when Array
+        Array.new(length.sample) { random_byte }
+      when Range
+        Array.new(rand(length)) { random_byte }
       else
         Array.new(length) { random_byte }
       end
     end
 
     #
-    # Creates an Array of random non-repeating bytes from the character set.
+    # Creates an Array of random non-repeating bytes from the {CharSet}.
     #
     # @param [Integer, Array, Range] length
     #   The length of the Array of random non-repeating bytes.
@@ -245,15 +262,20 @@ module Chars
     #   The randomly selected non-repeating bytes.
     #
     def random_distinct_bytes(length)
-      if (length.kind_of?(Array) || length.kind_of?(Range))
-        self.entries.sort_by { rand }.slice(0...(length.sort_by { rand }.first))
+      shuffled_bytes = bytes.shuffle
+
+      case length
+      when Array
+        shuffled_bytes[0,length.sample]
+      when Range
+        shuffled_bytes[0,rand(length)]
       else
-        self.entries.sort_by { rand }.slice(0...length) 
+        shuffled_bytes[0,length]
       end
     end
 
     #
-    # Creates an Array of random characters from the character set.
+    # Creates an Array of random characters from the {CharSet}.
     #
     # @param [Integer, Array, Range] length
     #   The length of the Array of random characters.
@@ -267,7 +289,7 @@ module Chars
 
     #
     # Creates a String containing randomly selected characters from the
-    # character set.
+    # {CharSet}.
     #
     # @param [Integer, Array, Range] length
     #   The length of the String of random characters.
@@ -283,7 +305,7 @@ module Chars
 
     #
     # Creates an Array of random non-repeating characters from the
-    # character set.
+    # {CharSet}.
     #
     # @param [Integer, Array, Range] length
     #   The length of the Array of random non-repeating characters.
@@ -297,7 +319,7 @@ module Chars
 
     #
     # Creates a String containing randomly selected non-repeating
-    # characters from the character set.
+    # characters from the {CharSet}.
     #
     # @param [Integer, Array, Range] length
     #   The length of the String of random non-repeating characters.
@@ -313,7 +335,7 @@ module Chars
 
     #
     # Finds sub-strings within given data that are made of characters within
-    # the character set.
+    # the {CharSet}.
     #
     # @param [String] data
     #   The data to find sub-strings within.
@@ -334,7 +356,7 @@ module Chars
     #   optional index.
     #
     # @yield [String] match
-    #   A sub-string containing the characters from the character set.
+    #   A sub-string containing the characters from the {CharSet}.
     #
     # @yield [Integer] index
     #   The index the sub-string was found at.
@@ -386,14 +408,14 @@ module Chars
     end
 
     #
-    # Creates a new CharSet object by unioning the character set with
-    # another character set.
+    # Creates a new CharSet object by unioning the {CharSet} with another
+    # {CharSet}.
     #
     # @param [CharSet, Array, Range] set
-    #   The other character set to union with.
+    #   The other {CharSet} to union with.
     #
     # @return [CharSet]
-    #   The unioned character sets.
+    #   The unioned {ChraSet}.
     #
     def |(set)
       set = CharSet.new(set) unless set.kind_of?(CharSet)
@@ -405,14 +427,14 @@ module Chars
 
     #
     # Compares the bytes within a given string with the bytes of the
-    # character set.
+    # {CharSet}.
     #
     # @param [String, Enumerable] other
-    #   The string to compare with the character set.
+    #   The string to compare with the {CharSet}.
     #
     # @return [Boolean]
     #   Specifies whether all of the bytes within the given string are
-    #   included in the character set.
+    #   included in the {CharSet}.
     #
     # @example
     #   Chars.alpha === "hello"
@@ -439,10 +461,10 @@ module Chars
     alias =~ ===
 
     #
-    # Inspects the character set.
+    # Inspects the {CharSet}.
     #
     # @return [String]
-    #   The inspected character set.
+    #   The inspected {CharSet}.
     #
     def inspect
       "#<#{self.class.name}: {" + map { |byte|
@@ -454,74 +476,10 @@ module Chars
           # to us C programmers
           '"\0"'
         else
-          "0x%02x" % byte
+          sprintf("0x%02x",byte)
         end
       }.join(', ') + "}>"
     end
 
-    protected
-
-    if RUBY_VERSION > '1.9.'
-      #
-      # Converts a byte to a character.
-      #
-      # @param [Integer] byte
-      #   The byte to convert.
-      #
-      # @return [String]
-      #   The character.
-      #
-      # @since 0.2.1
-      #
-      def byte_to_char(byte)
-        byte.chr(Encoding::UTF_8)
-      end
-
-      #
-      # Converts a character to a byte.
-      #
-      # @param [String] char
-      #   The character to convert.
-      #
-      # @return [Integer]
-      #   The byte.
-      #
-      # @since 0.2.1
-      #
-      def char_to_byte(char)
-        char.ord
-      end
-    else
-      #
-      # Converts a byte to a character.
-      #
-      # @param [Integer] byte
-      #   The byte to convert.
-      #
-      # @return [String]
-      #   The character.
-      #
-      # @since 0.2.1
-      #
-      def byte_to_char(byte)
-        byte.chr
-      end
-
-      #
-      # Converts a character to a byte.
-      #
-      # @param [String] char
-      #   The character to convert.
-      #
-      # @return [Integer]
-      #   The byte.
-      #
-      # @since 0.2.1
-      #
-      def char_to_byte(char)
-        char[0]
-      end
-    end
-
   end
 end