seg 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f25f1dea8441edea70194c8fd14b65b87a36b075
-  data.tar.gz: 5dfa12b3f90ee62f6ad0b8967aaedb5c41a573ab
+  metadata.gz: 85e4f67c3472b35609aba2853349c2f7e16ae6ce
+  data.tar.gz: 39190247aa987002047eee99c06951f88b09a387
 SHA512:
-  metadata.gz: 3b8538b53350f6f704306626db309d8c38984ef925c18abc8ac0acc5993ebed908189165f798a05c13ccd20be65b31a8ef2d3a109edc4ddecee03a685f7612f1
-  data.tar.gz: 6ec70617648a4be0a7251cd8534a5a835724dffaa278cbaef0292754521961ab9bb571d66deca7f44dd1c8c29c166d2b718a845ccf1499ff9c18d84b627df771
+  metadata.gz: 779a171e3f11639dd25b2cd2650ebce689c266d0883fadc4112df9d03bd385276c7c0dbf5a966d26c1a75e95216c0f54bd261540422b7bff3dbdabcb83665687
+  data.tar.gz: 3520f9f89f45dae7eb5c80ea2cf095129f578e997e13e1858e38648185d8ced715f3347443870efea1e9973ee65976378678692d847a0ff5caaf2a61a21ccf7b

data/CHANGELOG

@@ -1,3 +1,8 @@
+1.2.0
+
+* Add retract method
+* Add restore method
+
 1.1.0
 
 * Add extract method

data/README.md

@@ -141,6 +141,82 @@ otherwise:
 => ""
 ```
 
+You can also go back by using the methods `retract` and `restore`,
+which are the antidote to `extract` and `consume` respectively.
+
+Let's see how `retract` works:
+
+```ruby
+>> s = Seg.new("/users/42")
+=> #<Seg ...>
+
+>> s.prev
+=> ""
+
+>> s.curr
+=> "/users/42"
+
+>> s.extract
+=> "users"
+
+>> s.prev
+=> "/users"
+
+>> s.curr
+=> "/42"
+
+>> s.retract
+=> "users"
+
+>> s.prev
+=> ""
+
+>> s.curr
+=> "/users/42"
+```
+
+And now `restore`:
+
+```ruby
+>> s = Seg.new("/users/42")
+=> #<Seg ...>
+
+>> s.prev
+=> ""
+
+>> s.curr
+=> "/users/42"
+
+>> s.extract
+=> "users"
+
+>> s.prev
+=> "/users"
+
+>> s.curr
+=> "/42"
+
+>> s.restore("foo")
+=> false
+
+>> s.restore("users")
+=> true
+
+>> s.prev
+=> ""
+
+>> s.curr
+=> "/users/42"
+```
+
+See also
+--------
+
+[Syro][syro] is a routing library that uses `Seg` for matching the
+request path.
+
+[syro]: http://soveran.github.io/syro/
+
 Installation
 ------------
 

data/lib/seg.rb

@@ -24,60 +24,64 @@ class Seg
   SLASH = "/".freeze
 
   def initialize(path)
-    @path = path
-    @size = path.size
-    @pos = 1
+    @path = path || SLASH
+    @size = @path.size
+    @init = 0
+    @pos  = 0
   end
 
   def curr
-    @path[@pos - 1, @size]
+    @path[@pos, @size - @pos]
   end
 
   def prev
-    @path[0, @pos - 1]
+    @path[@init, @pos]
   end
 
-  def find(index)
-    @path[@pos + index]
-  end
-
-  def subs(len)
-    @path[@pos, len]
+  def root?
+    @size <= @pos.succ
   end
 
-  def move(offset)
-    @pos += offset.succ
-  end
-
-  def root?
-    @pos >= @size
+  def init?
+    @init == @pos
   end
 
   def extract
     return nil if root?
 
-    len = (@path.index(SLASH, @pos) || @size) - @pos
-    res = subs(len)
+    offs = @pos.succ
+    @pos = @path.index(SLASH, offs) || @size
+
+    return @path[offs, @pos - offs]
+  end
+
+  def retract
+    return nil if init?
 
-    move(len)
+    offs = @pos.pred
+    @pos = @path.rindex(SLASH, offs)
 
-    res
+    return @path[@pos.succ, offs - @pos]
   end
 
   def consume(str)
-    return false if root?
-
-    len = str.size
-
-    case find(len)
-    when nil, SLASH
-      if subs(len) == str
-        move(len)
-        return true
-      else
-        return false
-      end
+    orig = @pos
+
+    if str == extract
+      return true
+    else
+      @pos = orig
+      return false
+    end
+  end
+
+  def restore(str)
+    orig = @pos
+
+    if str == retract
+      return true
     else
+      @pos = orig
       return false
     end
   end

data/seg.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "seg"
-  s.version = "1.1.0"
+  s.version = "1.2.0"
   s.summary = %{Segment matcher for paths}
   s.description = %Q{Segment matcher for paths.}
   s.authors = ["Michel Martens"]

data/test/all.rb

@@ -1,3 +1,89 @@
+test "nil" do
+  segment = Seg.new(nil)
+
+  assert_equal segment.prev, ""
+  assert_equal segment.curr, "/"
+  assert segment.root?
+end
+
+test "root" do
+  segment = Seg.new("/")
+
+  assert_equal segment.prev, ""
+  assert_equal segment.curr, "/"
+  assert segment.root?
+end
+
+test "init" do
+  segment = Seg.new("/")
+
+  assert segment.init?
+  assert segment.root?
+
+  segment = Seg.new("/foo")
+
+  assert segment.init?
+  assert !segment.root?
+
+  assert_equal segment.extract, "foo"
+
+  assert !segment.init?
+  assert segment.root?
+end
+
+test "extract" do
+  segment = Seg.new("/foo/bar/baz")
+
+  assert_equal segment.extract, "foo"
+  assert_equal segment.prev, "/foo"
+  assert_equal segment.curr, "/bar/baz"
+  assert !segment.root?
+
+  assert_equal segment.extract, "bar"
+  assert_equal segment.prev, "/foo/bar"
+  assert_equal segment.curr, "/baz"
+  assert !segment.root?
+
+  assert_equal segment.extract, "baz"
+  assert_equal segment.prev, "/foo/bar/baz"
+  assert_equal segment.curr, ""
+  assert segment.root?
+
+  assert_equal segment.extract, nil
+  assert_equal segment.prev, "/foo/bar/baz"
+  assert_equal segment.curr, ""
+  assert segment.root?
+end
+
+test "retract" do
+  segment = Seg.new("/foo/bar/baz")
+
+  3.times { segment.extract }
+
+  assert_equal segment.prev, "/foo/bar/baz"
+  assert_equal segment.curr, ""
+
+  assert_equal segment.retract, "baz"
+  assert_equal segment.prev, "/foo/bar"
+  assert_equal segment.curr, "/baz"
+  assert !segment.root?
+
+  assert_equal segment.retract, "bar"
+  assert_equal segment.prev, "/foo"
+  assert_equal segment.curr, "/bar/baz"
+  assert !segment.root?
+
+  assert_equal segment.retract, "foo"
+  assert_equal segment.prev, ""
+  assert_equal segment.curr, "/foo/bar/baz"
+  assert !segment.root?
+
+  assert_equal segment.retract, nil
+  assert_equal segment.prev, ""
+  assert_equal segment.curr, "/foo/bar/baz"
+  assert !segment.root?
+end
+
 test "consume" do
   segment = Seg.new("/foo/bar/baz")
 
@@ -21,7 +107,12 @@ test "consume" do
   assert_equal segment.curr, "/bar/baz"
   assert !segment.root?
 
-  assert_equal segment.consume("bar/baz"), true
+  assert_equal segment.consume("bar"), true
+  assert_equal segment.prev, "/foo/bar"
+  assert_equal segment.curr, "/baz"
+  assert !segment.root?
+
+  assert_equal segment.consume("baz"), true
   assert_equal segment.prev, "/foo/bar/baz"
   assert_equal segment.curr, ""
   assert segment.root?
@@ -32,6 +123,37 @@ test "consume" do
   assert segment.root?
 end
 
+test "restore" do
+  segment = Seg.new("/foo/bar/baz")
+
+  3.times { segment.extract }
+
+  assert_equal segment.restore("foo"), false
+  assert_equal segment.prev, "/foo/bar/baz"
+  assert_equal segment.curr, ""
+  assert segment.root?
+
+  assert_equal segment.restore("baz"), true
+  assert_equal segment.prev, "/foo/bar"
+  assert_equal segment.curr, "/baz"
+  assert !segment.root?
+
+  assert_equal segment.restore("bar"), true
+  assert_equal segment.prev, "/foo"
+  assert_equal segment.curr, "/bar/baz"
+  assert !segment.root?
+
+  assert_equal segment.restore("foo"), true
+  assert_equal segment.prev, ""
+  assert_equal segment.curr, "/foo/bar/baz"
+  assert !segment.root?
+
+  assert_equal segment.restore("foo"), false
+  assert_equal segment.prev, ""
+  assert_equal segment.curr, "/foo/bar/baz"
+  assert !segment.root?
+end
+
 test "capture" do
   segment = Seg.new("/foo/bar/baz")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seg
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-25 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest