chars 0.2.4 → 0.3.0

data/spec/chars_spec.rb

@@ -2,55 +2,211 @@ require 'spec_helper'
 require 'chars/chars'
 
 describe Chars do
-  it "should provide a numeric CharSet" do
-    expect(described_class::NUMERIC).to be =~ '0123456789'
+  let(:numeric_chars) { '0123456789'.chars }
+
+  describe "NUMERIC" do
+    subject { described_class::NUMERIC }
+
+    it "must contain numeric characters" do
+      expect(subject.chars).to match_array(numeric_chars)
+    end
+  end
+
+  describe "DIGITS" do
+    subject { described_class::DIGITS }
+
+    it "must equal NUMERIC" do
+      expect(subject).to be(described_class::NUMERIC)
+    end
+  end
+
+  describe "OCTAL" do
+    subject { described_class::OCTAL }
+
+    it "must contain all octal characters" do
+      expect(subject.chars).to match_array("01234567".chars)
+    end
+  end
+
+  let(:uppercase_hex_chars) { "0123456789ABCDEF".chars }
+
+  describe "UPPERCASE_HEXADECIMAL" do
+    subject { described_class::UPPERCASE_HEXADECIMAL }
+
+    it "must contain all upper-case hexadecimal characters" do
+      expect(subject.chars).to match_array(uppercase_hex_chars)
+    end
+  end
+
+  let(:lowercase_hex_chars) { "0123456789abcdef".chars }
+
+  describe "LOWERCASE_HEXADECIMAL" do
+    subject { described_class::LOWERCASE_HEXADECIMAL }
+
+    it "must contain all lower-case hexadecimal characters" do
+      expect(subject.chars).to match_array(lowercase_hex_chars)
+    end
+  end
+
+  describe "HEXADECIMAL" do
+    subject { described_class::HEXADECIMAL }
+
+    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
+  end
+
+  let(:uppercase_alpha_chars) { "ABCDEFGHIJKLMNOPQRSTUVWXYZ".chars }
+
+  describe "UPPERCASE_ALPHA" do
+    subject { described_class::UPPERCASE_ALPHA }
+
+    it "must contain all upper-case alpha characters" do
+      expect(subject.chars).to match_array(uppercase_alpha_chars)
+    end
+  end
+
+  let(:lowercase_alpha_chars) { "abcdefghijklmnopqrstuvwxyz".chars }
+
+  describe "LOWERCASE_ALPHA" do
+    subject { described_class::LOWERCASE_ALPHA }
+
+    it "must contain all lower-case alpha characters" do
+      expect(subject.chars).to match_array(lowercase_alpha_chars)
+    end
   end
 
-  it "should provide an octal CharSet" do
-    expect(described_class::OCTAL).to be =~ "01234567"
+  let(:alpha_chars) { uppercase_alpha_chars | lowercase_alpha_chars }
+
+  describe "ALPHA" do
+    subject { described_class::ALPHA }
+
+    it "must contain all alpha characters" do
+      expect(subject.chars).to match_array(alpha_chars)
+    end
   end
 
-  it "should provide an upper-case hexadecimal CharSet" do
-    expect(described_class::UPPERCASE_HEXADECIMAL).to be =~ "0123456789ABCDEF"
+  let(:alpha_numeric_chars) { alpha_chars | numeric_chars }
+
+  describe "ALPHA_NUMERIC" do
+    subject { described_class::ALPHA_NUMERIC }
+
+    it "must contain all alpha-numeric characters" do
+      expect(subject.chars).to match_array(alpha_numeric_chars)
+    end
   end
 
-  it "should provide a lower-case hexadecimal CharSet" do
-    expect(described_class::LOWERCASE_HEXADECIMAL).to be =~ "0123456789abcdef"
+  let(:punctuation_chars) { " !\"'(),-.:;?[]`{}~".chars }
+
+  describe "PUNCTUATION" do
+    subject { described_class::PUNCTUATION }
+
+    it "must contain all punctuation characters" do
+      expect(subject.chars).to match_array(punctuation_chars)
+    end
   end
 
-  it "should provide a hexadecimal CharSet" do
-    expect(described_class::HEXADECIMAL).to be =~ "0123456789ABCDEFabcdef"
+  let(:symbolic_chars) { " !\"\#$%&'()*+,-./:;<=>?@[\\]^_`{|}~".chars }
+
+  describe "SYMBOLS" do
+    subject { described_class::SYMBOLS }
+
+    it "must contain all symbolic characters" do
+      expect(subject.chars).to match_array(symbolic_chars)
+    end
   end
 
-  it "should provide an upper-case alpha CharSet" do
-    expect(described_class::UPPERCASE_ALPHA).to be =~ "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+  let(:whitespace_chars) { "\t\n\v\f\r ".chars }
+
+  describe "WHITESPACE" do
+    subject { described_class::WHITESPACE }
+
+    it "must contain all white-space characters" do
+      expect(subject.chars).to match_array(whitespace_chars)
+    end
   end
 
-  it "should provide a lower-case alpha CharSet" do
-    expect(described_class::LOWERCASE_ALPHA).to be =~ "abcdefghijklmnopqrstuvwxyz"
+  describe "SPACE" do
+    subject { described_class::SPACE }
+
+    it "must equal WHITESPACE" do
+      expect(subject).to be(described_class::WHITESPACE)
+    end
   end
 
-  it "should provide an alpha CharSet" do
-    expect(described_class::ALPHA).to be =~ "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
+  describe "VISIBLE" do
+    subject { described_class::VISIBLE }
+
+    it "must contain all all alpha-numeric, symbols, and some punctuation" do
+      expect(subject.chars).to match_array(alpha_numeric_chars | "!\"\#$%&'()*+,-./:;<=>?@[\\]^_`{|}~".chars)
+    end
   end
 
-  it "should provide an alpha-numeric CharSet" do
-    expect(described_class::ALPHA_NUMERIC).to be =~ "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
+  describe "PRINTABLE" do
+    subject { described_class::PRINTABLE }
+
+    it "must contain all alpha-numeric, punctuation, symbols, and whitespace characters" do
+      expect(subject.chars).to match_array(
+        alpha_numeric_chars |
+        punctuation_chars |
+        symbolic_chars |
+        whitespace_chars
+      )
+    end
   end
-  
-  it "should provide a visible CharSet" do
-    expect(described_class::VISIBLE).to be =~ "!\"\#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
+
+  describe "CONTROL" do
+    subject { described_class::CONTROL }
+
+    it "must contain ASCII bytes 0x00 - 0x1f and 0x7f" do
+      expect(subject.bytes).to eq([*0x00..0x1f, 0x7f])
+    end
   end
 
-  it "should provide a space CharSet" do
-    expect(described_class::SPACE).to be =~ "\t\n\v\f\r "
+  describe "SIGNED_ASCII" do
+    subject { described_class::SIGNED_ASCII }
+
+    it "must contain ASCII bytes 0x00 - 0x7f" do
+      expect(subject.bytes).to eq([*0x00..0x7f])
+    end
   end
 
-  it "should provide a punctuation CharSet" do
-    expect(described_class::PUNCTUATION).to be =~ " !\"'(),-.:;?[]`{}~"
+  describe "ASCII" do
+    subject { described_class::ASCII }
+
+    it "must contain ASCII bytes 0x00 - 0xff" do
+      expect(subject.bytes).to eq([*0x00..0xff])
+    end
   end
 
-  it "should provide a symbols CharSet" do
-    expect(described_class::SYMBOLS).to be =~ " !\"\#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
+  {
+    :numeric => :NUMERIC,
+    :digits  => :DIGITS,
+    :octal   => :OCTAL,
+
+    :uppercase_hexadecimal => :UPPERCASE_HEXADECIMAL,
+    :lowercase_hexadecimal => :LOWERCASE_HEXADECIMAL,
+    :hexadecimal => :HEXADECIMAL,
+
+    :uppercase_alpha => :UPPERCASE_ALPHA,
+    :lowercase_alpha => :LOWERCASE_ALPHA,
+    :alpha => :ALPHA,
+
+    :punctuation => :PUNCTUATION,
+    :symbols     => :SYMBOLS,
+    :whitespace  => :WHITESPACE,
+    :space       => :SPACE,
+    :visible     => :VISIBLE,
+    :printable   => :PRINTABLE,
+    :control     => :CONTROL,
+
+    :signed_ascii => :SIGNED_ASCII,
+    :ascii        => :ASCII
+  }.each do |method,constant|
+    describe ".#{method}" do
+      it "must return #{constant}" do
+        expect(subject.send(method)).to be(described_class.const_get(constant))
+      end
+    end
   end
 end

data/spec/string_enumerator_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'chars/char_set'
+require 'chars/string_enumerator'
+
+describe Chars::StringEnumerator do
+  let(:char_set) { Chars::CharSet['a', 'b', 'c'] }
+  let(:length)   { 3 }
+
+  subject { described_class.new(char_set,length) }
+
+  describe "#initialize" do
+    it "must set #char_set" do
+      expect(subject.char_set).to eq(char_set)
+    end
+
+    it "must set #length" do
+      expect(subject.length).to eq(length)
+    end
+  end
+
+  describe "#each" do
+    let(:expected_strings) do
+      %w[
+        aaa
+        aab
+        aac
+        aba
+        abb
+        abc
+        aca
+        acb
+        acc
+        baa
+        bab
+        bac
+        bba
+        bbb
+        bbc
+        bca
+        bcb
+        bcc
+        caa
+        cab
+        cac
+        cba
+        cbb
+        cbc
+        cca
+        ccb
+        ccc
+      ]
+    end
+
+    context "when a block is given" do
+      it "must enumerate through each sequential string in the char-set and of the desired length" do
+        expect { |b|
+          subject.each(&b)
+        }.to yield_successive_args(*expected_strings)
+      end
+
+      context "when the length is 1" do
+        let(:length) { 1 }
+
+        it "must enumerate over each individual character" do
+          expect { |b|
+            subject.each(&b)
+          }.to yield_successive_args(*char_set.chars)
+        end
+      end
+
+      context "when the length is 0" do
+        let(:length) { 0 }
+
+        it "must yield an empty String" do
+          expect { |b|
+            subject.each(&b)
+          }.to yield_successive_args("")
+        end
+      end
+
+      context "when #char_set is empty" do
+        let(:char_set) { Chars::CharSet.new }
+
+        it "must yield an empty String" do
+          expect { |b|
+            subject.each(&b)
+          }.to_not yield_control
+        end
+      end
+    end
+
+    context "when no block is given" do
+      it "must return an Enumerator object" do
+        expect(subject.each).to be_kind_of(Enumerator)
+        expect(subject.each.to_a).to eq(expected_strings)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chars
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Postmodern
@@ -46,7 +46,7 @@ files:
 - README.md
 - Rakefile
 - benchmarks/compare.rb
-- benchmarks/strings_in.rb
+- benchmarks/substrings.rb
 - chars.gemspec
 - gemspec.yml
 - lib/chars.rb
@@ -55,12 +55,14 @@ files:
 - lib/chars/extensions.rb
 - lib/chars/extensions/integer.rb
 - lib/chars/extensions/string.rb
+- lib/chars/string_enumerator.rb
 - lib/chars/version.rb
 - spec/char_set_spec.rb
 - spec/chars_spec.rb
 - spec/extensions/integer_spec.rb
 - spec/extensions/string_spec.rb
 - spec/spec_helper.rb
+- spec/string_enumerator_spec.rb
 homepage: https://github.com/postmodern/chars.rb#readme
 licenses:
 - MIT

data/benchmarks/strings_in.rb

@@ -1,23 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
-
-require 'chars'
-require 'benchmark'
-
-CHARSET = Chars::ALPHA_NUMERIC
-STRING  = File.open('/usr/bin/openssl','rb') do |file|
-            file.read
-          end
-
-Benchmark.bm(24) do |b|
-  b.report('strings_in') do
-    CHARSET.strings_in(STRING) { |offset,string| }
-  end
-
-  (5..20).step(5) do |n|
-    b.report("strings_in (length=#{n})") do
-      CHARSET.strings_in(STRING, :length => n) { |offset,string| }
-    end
-  end
-end