chars 0.2.4 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6257e8d2fa2f62cc364fc2e0ba901d777963476968264dd7747bc4407e5ff54c
-  data.tar.gz: 16f5ecc2f44e8265869aac4946a64cacda2ae8dcdae3b669081a48d34f034f4e
+  metadata.gz: 1b408bb91d6c66422ccb57e66af6cdeceeb97d50c610628a9b99780319f4af57
+  data.tar.gz: '039bef18f59a8ea05fd2a259839432e9ad2eee15c692969bf611d11b15255b75'
 SHA512:
-  metadata.gz: ebaf16c18de6b000b6219bf4afe7142926e24293b6b1e62214f937c51c5bdf7f5ffa7f46eecb151e1da044f7b49e1479b7d2cc947a6e20fa2a586f28b4a8a525
-  data.tar.gz: 4c9c98dcbab77b201b86fc32a628575e4b0ebc03608c50c7591b51a70821127778ced5122f57de846c7c863440fa0e9555fe7bfd2940a913e494a929c74a513e
+  metadata.gz: 803264ba7bafc4546df334bd2a508389f525c9814ab0452ef7b2b7c9b75cc0fb952c729f0b5b093cbede36d60be5badeb29ada0e29ee5b12ae3d681878aeb163
+  data.tar.gz: 2e9f1c229d9987e5cb1dfc0caada8c71582e0c72e8c03e7b39313c4bc1e9e447bdbdfcf641009174de47b4e0e94384296dc26cf8a136f72881bfd664fa311720

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,23 @@
+### 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}.
+* Added {Chars::DIGITS}.
+* Added {Chars::CharSet#each_substring_with_index}.
+* Added {Chars::CharSet#substrings_with_indexes}.
+* Added {Chars::CharSet#each_substring}.
+* Added {Chars::CharSet#substrings}.
+* Added {Chars::CharSet#each_string_of_length}.
+* Added {Chars::CharSet#strings_of_length}.
+* Added {Chars::StringEnumerator}.
+
 ### 0.2.4 / 2021-10-22
 
 * Require [ruby] >= 2.0.0.
@@ -10,7 +30,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
@@ -34,20 +54,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
 
@@ -68,7 +89,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`
@@ -48,14 +48,6 @@ Determine whether a String belongs to a character set:
 # => true
 ```
 
-Find all sub-strings that belong to a character set within a String:
-
-```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:
 
 ```ruby
@@ -85,6 +77,14 @@ Chars.all.random_string(10)
 # => "\xc2h\xad\xccm7\x1e6J\x13"
 ```
 
+Generate a secure password:
+
+```ruby
+require 'securerandom'
+Chars.visible.random_string(10..14, random: SecureRandom)
+# => ".*$X=D*XK2h8gC"
+```
+
 Return a random String with a random length between 5 and 10, from the
 set of space characters:
 
@@ -93,6 +93,57 @@ Chars.space.random_string(5..10)
 # => "\r\v\n\t\n\f"
 ```
 
+Find all sub-strings that belong to a character set within a String:
+
+```ruby
+ls = File.binread('/bin/ls')
+Chars.printable.substrings(ls)
+# => 
+# ["/lib64/ld-linux-x86-64.so.2",
+#  "_ITM_deregisterTMCloneTable",
+#  "__gmon_start__",
+#  "_ITM_registerTMCloneTable",
+#  ...
+# ]
+```
+
+Find all sub-strings that belong to a character set within a String, with
+indexes:
+
+```ruby
+ls = File.binread('/bin/ls')
+Chars.printable.substrings_with_indexes(ls)
+# =>
+# [["/lib64/ld-linux-x86-64.so.2", 792],
+#  ["_ITM_deregisterTMCloneTable", 4009],
+#  ["__gmon_start__", 4037],
+#  ["_ITM_registerTMCloneTable", 4052],
+#  ...
+# ]
+```
+
+Enumerate over all strings from a character set of a given length:
+
+```ruby
+passwords = Chars.visible.strings_of_length(6)
+passwords.each { |password| puts password }
+# AAAAAA
+# AAAAAB
+# AAAAAC
+# ...
+```
+
+Enumerate over all strings from a character set of lengths between 4 and 8:
+
+```ruby
+passwords = Chars.visible.strings_of_length(4..8)
+passwords.each { |password| puts password }
+# AAAA
+# AAAB
+# AAAC
+# ...
+```
+
 ## Requirements
 
 * [ruby](https://www.ruby-lang.org/) >= 2.0.0
@@ -104,13 +155,13 @@ Chars.space.random_string(5..10)
 ### gemspec
 
 ```ruby
-gem.add_dependency 'chars', '~> 0.2'
+gem.add_dependency 'chars', '~> 0.3'
 ```
 
 ### Gemfile
 
 ```ruby
-gem 'chars', '~> 0.2'
+gem 'chars', '~> 0.3'
 ```
 
 ## Crystal

data/benchmarks/compare.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+$LOAD_PATH.unshift(File.expand_path(File.join(__dir__,'..','lib')))
 
 require 'chars'
 require 'benchmark'

data/benchmarks/substrings.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.join(__dir__,'..','lib')))
+
+require 'chars'
+require 'benchmark'
+
+CHARSET = Chars::ALPHA_NUMERIC
+STRING  = File.binread('/usr/bin/openssl')
+
+Benchmark.bm(41) do |b|
+  b.report('Chars::CharSet#each_substring_with_index') do
+    CHARSET.each_substring_with_index(STRING) { |string,index| }
+  end
+
+  b.report('Chars::CharSet#each_substring') do
+    CHARSET.each_substring(STRING) { |string| }
+  end
+
+  (5..20).step(5) do |n|
+    b.report("Chars::CharSet#each_substring (length=#{n})") do
+      CHARSET.strings_in(STRING, :length => n) { |offset,string| }
+    end
+  end
+end

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"