motion-strscan 0.5.0

data/spec/strscan_spec/concat_spec.rb

@@ -0,0 +1,7 @@
+describe "StringScanner#concat" do
+  it_behaves_like(:strscan_concat, :concat)
+end
+
+describe "StringScanner#concat when passed a Fixnum" do
+  it_behaves_like(:strscan_concat_fixnum, :concat)
+end

data/spec/strscan_spec/dup_spec.rb

@@ -0,0 +1,36 @@
+describe "StringScanner#dup" do
+  before do
+    @string = "this is a test"
+    @orig_s = StringScanner.new(@string)
+  end
+
+  it "copies the passed StringScanner's content to self" do
+    s = @orig_s.dup
+    s.string.should == @string
+  end
+
+  it "copies the passed StringSCanner's position to self" do
+    @orig_s.pos = 5
+    s = @orig_s.dup
+    s.pos.should.equal(5)
+  end
+
+  it "copies previous match state" do
+    @orig_s.scan(/\w+/)
+    @orig_s.scan(/\s/)
+
+    @orig_s.pre_match.should == "this"
+
+    s = @orig_s.dup
+    s.pre_match.should == "this"
+
+    s.unscan
+    s.scan(/\s/).should == " "
+  end
+
+  it "copies the passed StringScanner scan pointer to self" do
+    @orig_s.terminate
+    s = @orig_s.dup
+    s.eos?.should.be_true
+  end
+end

data/spec/strscan_spec/element_reference_spec.rb

@@ -0,0 +1,46 @@
+describe "StringScanner#[]" do
+  before do
+    @s = StringScanner.new("Fri Jun 13 2008 22:43")
+  end
+
+  it "returns nil if there is no current match" do
+    @s[0].should == nil
+  end
+
+  it "returns the n-th subgroup in the most recent match" do
+    @s.scan(/(\w+) (\w+) (\d+) /)
+    @s[0].should == "Fri Jun 13 "
+    @s[1].should == "Fri"
+    @s[2].should == "Jun"
+    @s[3].should == "13"
+    @s[-3].should == "Fri"
+    @s[-2].should == "Jun"
+    @s[-1].should == "13"
+  end
+
+  it "returns nil if index is outside of self" do
+    @s.scan(/(\w+) (\w+) (\d+) /)
+    @s[5].should == nil
+    @s[-5].should == nil
+  end
+
+  it "calls to_int on the given index" do
+    @s.scan(/(\w+) (\w+) (\d+) /)
+    @s[0.5].should == "Fri Jun 13 "
+  end
+
+  it "raises a TypeError if the given index is nil" do
+    @s.scan(/(\w+) (\w+) (\d+) /)
+    lambda { @s[nil]}.should.raise(TypeError)
+  end
+
+  it "raises a TypeError when a String is as argument" do
+    @s.scan(/(\w+) (\w+) (\d+) /)
+    lambda { @s["Fri"]}.should.raise(TypeError)
+  end
+
+  it "raises a TypeError when a Range is as argument" do
+    @s.scan(/(\w+) (\w+) (\d+) /)
+    lambda { @s[0..2]}.should.raise(TypeError)
+  end
+end

data/spec/strscan_spec/empty_spec.rb

@@ -0,0 +1,21 @@
+describe "StringScanner#empty?" do
+  it_behaves_like(:strscan_eos, :empty?)
+
+  # it "warns in verbose mode that the method is obsolete" do
+  #   s = StringScanner.new("abc")
+  #   begin
+  #     old = $VERBOSE
+  #     lambda {
+  #       $VERBOSE = true
+  #       s.empty?
+  #     }.should complain(/empty?.*obsolete.*eos?/)
+  #
+  #     lambda {
+  #       $VERBOSE = false
+  #       s.empty?
+  #     }.should_not complain
+  #   ensure
+  #     $VERBOSE = old
+  #   end
+  # end
+end

data/spec/strscan_spec/eos_spec.rb

@@ -0,0 +1,3 @@
+describe "StringScanner#eos?" do
+  it_behaves_like(:strscan_eos, :eos?)
+end

data/spec/strscan_spec/exist_spec.rb

@@ -0,0 +1,21 @@
+describe "StringScanner#exist?" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns the index of the first occurrence of the given pattern" do
+    @s.exist?(/s/).should == 4
+    @s.scan(/This is/)
+    @s.exist?(/s/).should == 6
+  end
+
+  it "returns 0 if the pattern is empty" do
+    @s.exist?(//).should == 0
+  end
+
+  it "returns nil if the pattern isn't found in the string" do
+    @s.exist?(/S/).should == nil
+    @s.scan(/This is/)
+    @s.exist?(/i/).should == nil
+  end
+end

data/spec/strscan_spec/get_byte_spec.rb

@@ -0,0 +1,3 @@
+describe "StringScanner#get_byte" do
+  it_behaves_like :strscan_get_byte, :get_byte
+end

data/spec/strscan_spec/getbyte_spec.rb

@@ -0,0 +1,23 @@
+describe "StringScanner#getbyte" do
+  it_behaves_like :strscan_get_byte, :getbyte
+
+  # it "warns in verbose mode that the method is obsolete" do
+  #   s = StringScanner.new("abc")
+  #   begin
+  #     old = $VERBOSE
+  #     lambda {
+  #       $VERBOSE = true
+  #       s.getbyte
+  #     }.should complain(/getbyte.*obsolete.*get_byte/)
+  #
+  #     lambda {
+  #       $VERBOSE = false
+  #       s.getbyte
+  #     }.should_not complain
+  #   ensure
+  #     $VERBOSE = old
+  #   end
+  # end
+
+  it_behaves_like :extract_range, :getbyte
+end

data/spec/strscan_spec/getch_spec.rb

@@ -0,0 +1,41 @@
+describe "StringScanner#getch" do
+  before do
+    @kcode = $KCODE
+  end
+
+  after do
+    $KCODE = @kcode
+  end
+
+  it "scans one character and returns it" do
+    s = StringScanner.new('abc')
+    s.getch.should == "a"
+    s.getch.should == "b"
+    s.getch.should == "c"
+  end
+
+  # it "is multi-byte character sensitive" do
+  #   $KCODE = 'EUC'
+  #
+  #   # Japanese hiragana "A" in EUC-JP
+  #   # src = "\244\242".encode("euc-jp")
+  #   src = "\244\242".force_encoding("euc-jp")
+  #
+  #   s = StringScanner.new(src)
+  #   s.getch.should == src
+  # end
+
+  it "returns nil at the end of the string" do
+    # empty string case
+    s = StringScanner.new('')
+    s.getch.should == nil
+    s.getch.should == nil
+
+    # non-empty string case
+    s = StringScanner.new('a')
+    s.getch # skip one
+    s.getch.should == nil
+  end
+
+  it_behaves_like :extract_range, :getch
+end

data/spec/strscan_spec/initialize_spec.rb

@@ -0,0 +1,25 @@
+describe "StringScanner#initialize" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  # it "is a private method" do
+  #   StringScanner.should.be.a.private_instance_method(:initialize)
+  # end
+
+  it "returns an instance of StringScanner" do
+    @s.should.be.kind_of(StringScanner)
+    @s.tainted?.should.be_false
+    @s.eos?.should.be_false
+  end
+
+  # it "converts the argument into a string using #to_str" do
+  #   m = mock(:str)
+  #
+  #   s = "test"
+  #   m.should_receive(:to_str).and_return(s)
+  #
+  #   scan = StringScanner.new(m)
+  #   scan.string.should == s
+  # end
+end

data/spec/strscan_spec/inspect_spec.rb

@@ -0,0 +1,17 @@
+describe "StringScanner#inspect" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns a String object" do
+    @s.inspect.should.be.kind_of(String)
+  end
+
+  it "returns a string that represents the StringScanner object" do
+    @s.inspect.should == "#<StringScanner 0/14 @ \"This ...\">"
+    @s.scan_until /is/
+    @s.inspect.should == "#<StringScanner 4/14 \"This\" @ \" is a...\">"
+    @s.terminate
+    @s.inspect.should == "#<StringScanner fin>"
+  end
+end

data/spec/strscan_spec/match_spec.rb

@@ -0,0 +1,25 @@
+describe "StringScanner#match?" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns the length of the match and the scan pointer is not advanced" do
+    @s.match?(/\w+/).should == 4
+    @s.match?(/\w+/).should == 4
+    @s.pos.should == 0
+  end
+
+  it "returns nil if there's no match" do
+    @s.match?(/\d+/).should == nil
+    @s.match?(/\s+/).should == nil
+  end
+
+  it "effects pre_match" do
+    @s.scan(/\w+/)
+    @s.scan(/\s/)
+
+    @s.pre_match.should == "This"
+    @s.match?(/\w+/)
+    @s.pre_match.should == "This "
+  end
+end

data/spec/strscan_spec/matched_size_spec.rb

@@ -0,0 +1,3 @@
+describe "StringScanner#matched_size" do
+  it_behaves_like(:strscan_matched_size, :matched_size)
+end

data/spec/strscan_spec/matched_spec.rb

@@ -0,0 +1,37 @@
+describe "StringScanner#matched" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns the last matched string" do
+    @s.match?(/\w+/)
+    @s.matched.should == "This"
+    @s.getch
+    @s.matched.should == "T"
+    @s.get_byte
+    @s.matched.should == "h"
+  end
+
+  it "returns nil if there's no match" do
+    @s.match?(/\d+/)
+    @s.matched.should == nil
+  end
+
+  it_behaves_like :extract_range_matched, :matched
+end
+
+describe "StringScanner#matched?" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns true if the last match was successful" do
+    @s.match?(/\w+/)
+    @s.matched?.should.be_true
+  end
+
+  it "returns false if there's no match" do
+    @s.match?(/\d+/)
+    @s.matched?.should.be_false
+  end
+end

data/spec/strscan_spec/matchedsize_spec.rb

@@ -0,0 +1,23 @@
+# ruby_version_is "" ... "1.9" do
+  describe "StringScanner#matchedsize" do
+    it_behaves_like(:strscan_matched_size, :matchedsize)
+
+    # it "warns in verbose mode that the method is obsolete" do
+    #   s = StringScanner.new("abc")
+    #   begin
+    #     old = $VERBOSE
+    #     lambda {
+    #       $VERBOSE = true
+    #       s.matchedsize
+    #     }.should complain(/matchedsize.*obsolete.*matched_size/)
+    #
+    #     lambda {
+    #       $VERBOSE = false
+    #       s.matchedsize
+    #     }.should_not complain
+    #   ensure
+    #     $VERBOSE = old
+    #   end
+    # end
+  end
+# end

data/spec/strscan_spec/must_C_version_spec.rb

@@ -0,0 +1,5 @@
+describe "StringScanner.must_C_version" do
+  it "returns self" do
+     StringScanner.must_C_version.should == StringScanner
+  end
+end

data/spec/strscan_spec/peek_spec.rb

@@ -0,0 +1,4 @@
+describe "StringScanner#peek" do
+  it_behaves_like(:strscan_peek, :peek)
+end
+

data/spec/strscan_spec/peep_spec.rb

@@ -0,0 +1,21 @@
+describe "StringScanner#peep" do
+  it_behaves_like(:strscan_peek, :peep)
+
+  # it "warns in verbose mode that the method is obsolete" do
+  #   s = StringScanner.new("abc")
+  #   begin
+  #     old = $VERBOSE
+  #     lambda {
+  #       $VERBOSE = true
+  #       s.peep(1)
+  #     }.should complain(/peep.*obsolete.*peek/)
+  #
+  #     lambda {
+  #       $VERBOSE = false
+  #       s.peep(1)
+  #     }.should_not complain
+  #   ensure
+  #     $VERBOSE = old
+  #   end
+  # end
+end

data/spec/strscan_spec/pointer_spec.rb

@@ -0,0 +1,7 @@
+describe "StringScanner#pointer" do
+  it_behaves_like(:strscan_pos, :pointer)
+end
+
+describe "StringScanner#pointer=" do
+  it_behaves_like(:strscan_pos_set, :pointer=)
+end

data/spec/strscan_spec/pos_spec.rb

@@ -0,0 +1,7 @@
+describe "StringScanner#pos" do
+  it_behaves_like(:strscan_pos, :pos)
+end
+
+describe "StringScanner#pos=" do
+  it_behaves_like(:strscan_pos_set, :pos=)
+end

data/spec/strscan_spec/post_match_spec.rb

@@ -0,0 +1,24 @@
+describe "StringScanner#post_match" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns the post-match (in the regular expression sense) of the last scan" do
+    @s.post_match.should == nil
+    @s.scan(/\w+\s/)
+    @s.post_match.should == "is a test"
+    @s.getch
+    @s.post_match.should == "s a test"
+    @s.get_byte
+    @s.post_match.should == " a test"
+    @s.get_byte
+    @s.post_match.should == "a test"
+  end
+
+  it "returns nil if there's no match" do
+    @s.scan(/\s+/)
+    @s.post_match.should == nil
+  end
+
+  it_behaves_like :extract_range_matched, :post_match
+end

data/spec/strscan_spec/pre_match_spec.rb

@@ -0,0 +1,37 @@
+describe "StringScanner#pre_match" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns the pre-match (in the regular expression sense) of the last scan" do
+    @s.pre_match.should == nil
+    @s.scan(/\w+\s/)
+    @s.pre_match.should == ""
+    @s.getch
+    @s.pre_match.should == "This "
+    @s.get_byte
+    @s.pre_match.should == "This i"
+    @s.get_byte
+    @s.pre_match.should == "This is"
+  end
+
+  it "returns nil if there's no match" do
+    @s.scan(/\s+/)
+    @s.pre_match.should == nil
+  end
+
+  it "is more than just the data from the last match" do
+    @s.scan(/\w+/)
+    @s.scan_until(/a te/)
+    @s.pre_match.should == "This is "
+  end
+
+  it "is not changed when the scanner's position changes" do
+    @s.scan_until(/\s+/)
+    @s.pre_match.should == "This"
+    @s.pos -= 1
+    @s.pre_match.should == "This"
+  end
+
+  it_behaves_like :extract_range_matched, :pre_match
+end

data/spec/strscan_spec/reset_spec.rb

@@ -0,0 +1,12 @@
+describe "StringScanner#reset" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "reset the scan pointer and clear matching data" do
+    @s.scan(/This/)
+    @s.reset
+    @s.pos.should == 0
+    @s.matched.should == nil
+  end
+end

data/spec/strscan_spec/rest_size_spec.rb

@@ -0,0 +1,3 @@
+describe "StringScanner#rest_size" do
+  it_behaves_like(:strscan_rest_size, :rest_size)
+end

data/spec/strscan_spec/rest_spec.rb

@@ -0,0 +1,44 @@
+describe "StringScanner#rest" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns the rest of the string" do
+    @s.scan(/This\s+/)
+    @s.rest.should == "is a test"
+  end
+
+  it "returns self in the reset position" do
+    @s.reset
+    @s.rest.should == @s.string
+  end
+
+  it "returns an empty string in the terminate position" do
+    @s.terminate
+    @s.rest.should == ""
+  end
+
+  it_behaves_like :extract_range_matched, :rest
+
+end
+
+describe "StringScanner#rest?" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns true if there is more data in the string" do
+    @s.rest?.should.be_true
+    @s.scan(/This/)
+    @s.rest?.should.be_true
+  end
+
+  it "returns false if there is no more data in the string" do
+    @s.terminate
+    @s.rest?.should.be_false
+  end
+
+  it "is the opposite of eos?" do
+    @s.rest?.should.not == @s.eos?
+  end
+end

data/spec/strscan_spec/restsize_spec.rb

@@ -0,0 +1,21 @@
+describe "StringScanner#restsize" do
+  it_behaves_like(:strscan_rest_size, :restsize)
+
+  # it "warns in verbose mode that the method is obsolete" do
+  #   s = StringScanner.new("abc")
+  #   begin
+  #     old = $VERBOSE
+  #     lambda {
+  #       $VERBOSE = true
+  #       s.restsize
+  #     }.should complain(/restsize.*obsolete.*rest_size/)
+  #
+  #     lambda {
+  #       $VERBOSE = false
+  #       s.restsize
+  #     }.should_not complain
+  #   ensure
+  #     $VERBOSE = old
+  #   end
+  # end
+end

data/spec/strscan_spec/scan_full_spec.rb

@@ -0,0 +1,27 @@
+describe "StringScanner#scan_full" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns the number of bytes advanced" do
+    orig_pos = @s.pos
+    @s.scan_full(/This/, false, false).should == 4
+    @s.pos.should == orig_pos
+  end
+
+  it "returns the number of bytes advanced and advances the scan pointer if the second argument is true" do
+    @s.scan_full(/This/, true, false).should == 4
+    @s.pos.should == 4
+  end
+
+  it "returns the matched string if the third argument is true" do
+    orig_pos = @s.pos
+    @s.scan_full(/This/, false, true).should == "This"
+    @s.pos.should == orig_pos
+  end
+
+  it "returns the matched string if the third argument is true and advances the scan pointer if the second argument is true" do
+    @s.scan_full(/This/, true, true).should == "This"
+    @s.pos.should == 4
+  end
+end

data/spec/strscan_spec/scan_spec.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+describe "StringScanner#scan" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns the matched string" do
+    @s.scan(/\w+/).should == "This"
+    @s.scan(/.../).should == " is"
+    @s.scan(//).should == ""
+    @s.scan(/\s+/).should == " "
+  end
+
+  # ruby_version_is "1.9" do
+    it "returns the matched string for a multi byte string" do
+      m = StringScanner.new("Привет!")
+      m.scan(/[А-Яа-я]+/).should == "Привет"
+      m.rest.should == "!"
+    end
+  # end
+
+  it "treats ^ as matching from the beginning of the current position" do
+    @s.scan(/\w+/).should == "This"
+    @s.scan(/^\d/).should == nil
+    @s.scan(/^\s/).should == " "
+  end
+
+  it "returns nil if there's no match" do
+    @s.scan(/\d/).should == nil
+  end
+
+  it "returns nil when there is no more to scan" do
+    @s.scan(/[\w\s]+/).should == "This is a test"
+    @s.scan(/\w+/).should == nil
+  end
+
+  it "returns an empty string when the pattern matches empty" do
+    @s.scan(/.*/).should == "This is a test"
+    @s.scan(/.*/).should == ""
+    @s.scan(/./).should == nil
+  end
+
+  it "raises a TypeError if pattern isn't a Regexp" do
+    lambda { @s.scan("aoeu")    }.should.raise(TypeError)
+    lambda { @s.scan(5)         }.should.raise(TypeError)
+    lambda { @s.scan(:test)     }.should.raise(TypeError)
+    # lambda { @s.scan(mock('x')) }.should.raise(TypeError)
+  end
+end

data/spec/strscan_spec/scan_until_spec.rb

@@ -0,0 +1,20 @@
+describe "StringScanner#scan_until" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns the substring up to and including the end of the match" do
+   @s.scan_until(/a/).should == "This is a"
+   @s.pre_match.should == "This is "
+   @s.post_match.should == " test"
+  end
+
+  it "returns nil if there's no match" do
+    @s.scan_until(/\d/).should == nil
+  end
+
+  it "can match anchors properly" do
+    @s.scan(/T/)
+    @s.scan_until(/^h/).should == "h"
+  end
+end

data/spec/strscan_spec/search_full_spec.rb

@@ -0,0 +1,27 @@
+describe "StringScanner#search_full" do
+  before do
+    @s = StringScanner.new("This is a test")
+  end
+
+  it "returns the number of bytes advanced" do
+    orig_pos = @s.pos
+    @s.search_full(/This/, false, false).should == 4
+    @s.pos.should == orig_pos
+  end
+
+  it "returns the number of bytes advanced and advances the scan pointer if the second argument is true" do
+    @s.search_full(/This/, true, false).should == 4
+    @s.pos.should == 4
+  end
+
+  it "returns the matched string if the third argument is true" do
+    orig_pos = @s.pos
+    @s.search_full(/This/, false, true).should == "This"
+    @s.pos.should == orig_pos
+  end
+
+  it "returns the matched string if the third argument is true and advances the scan pointer if the second argument is true" do
+    @s.search_full(/This/, true, true).should == "This"
+    @s.pos.should == 4
+  end
+end