range_tree 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d1823bf3fb8b7ad048e704508d6a753a05a8456
-  data.tar.gz: 707cff2d18006ca2991a63622641b84274311474
+  metadata.gz: 552e16f04941f365c8d797abeecadf997bc3236b
+  data.tar.gz: 988458a90161548d0315f71ae4a1a792b32ee3b7
 SHA512:
-  metadata.gz: ebb2ce6159ca59749afd5242d7b0fc0106a12fa95f6d2a662e9406dccdf091ef176c2d65d123a90576ced40906b997d672795d3e6b1eca83b393ca6dc761efe4
-  data.tar.gz: afa957ed7156481bed9bb21d8f44c5bb6a08accd74d90214612e4bbd2945a603f5728b8528923aaf634ec53e04f819291444100ee82253b14c2d68d393bc49eb
+  metadata.gz: e5046afdd74928607ad7d5aeab0ee19def4b1c4e9c521213af524e5175919073446f76b1e67c6aa6c1f27306d2c115c376b8bff2365234ad4175f4cb31313777
+  data.tar.gz: a162d96f995118d6ca4902cbacd9cae3ef1f717d1719453fbda7b56d4cfd99c12c71c4da30d4abd120e3657e5cdbdaabc4e65219ad67092f050af61265f7cf98

data/README.md

@@ -14,7 +14,7 @@ For small trees you can use the default settings
 which rebuild the tree every time you add a value.
 
 If you need to build a very large tree with 1000's of values
-you need to pass ```rebuild_on_add: false``` to the tree.
+you need to pass a first argument of (rebuild_on_add) ```false``` to the tree.
 Then add everything to your tree and only once it is complete
 you must call ```tree.rebuild``` to build your index.
 
@@ -36,61 +36,76 @@ Or install it yourself as:
 
 ## Usage
 
-    # Below is an example using integers (formatted as dates) as keys. You can just as easily use dates, times
-    # floats or other comparable types.
-
-    require 'range_tree'
-
-    staff_holidays = RangeTree::Tree.new
-
-    staff_holidays[2000_01_01, 2000_01_15] = "John"
-    staff_holidays[2000_01_15, 2000_01_31] = "Greig"
-    staff_holidays[2000_01_20, 2000_02_05] = "Eve"
-    staff_holidays[2000_01_03, 2000_01_08] = "Alice"
-    staff_holidays[2000_01_18, 2000_01_20] = "Bob"
-
-    # Check who is on holiday on certain dates
-    staff_holidays[2000_01_04]
-    => ["Alice", "John"]
-
-    # Check all staff members on holiday within a certain period by passing a range
-    staff_holidays[2000_01_12..2011_01_19]
-    => ["John", "Bob", "Greig", "Eve"]
-
-
-    # Iterate through all periods where the system state changes
-    staff_holidays.distinct.each do |date, staff|
-      puts "From #{date} #{staff} will be on holiday"
-    end
-
-    =>
-    From 20000101 ["John"] will be on holiday
-    From 20000103 ["John", "Alice"] will be on holiday
-    From 20000109 ["John"] will be on holiday
-    From 20000115 ["John", "Greig"] will be on holiday
-    From 20000116 ["Greig"] will be on holiday
-    From 20000118 ["Greig", "Bob"] will be on holiday
-    From 20000120 ["Greig", "Bob", "Eve"] will be on holiday
-    From 20000121 ["Greig", "Eve"] will be on holiday
-    From 20000132 ["Eve"] will be on holiday
-    From 20000206 [] will be on holiday
-
-    # Iterate though all periods in the tree.
-    staff_holidays.all.each do |date, staff|
-      puts "#{staff} is on holiday on #{date}"
-    end
-
-    =>
-    ["John"] is on holiday on 20000101
-    ["John"] is on holiday on 20000102
-    ["John", "Alice"] is on holiday on 20000103
-    ["John", "Alice"] is on holiday on 20000104
-    ["John", "Alice"] is on holiday on 20000105
-    ["John", "Alice"] is on holiday on 20000106
-    ["John", "Alice"] is on holiday on 20000107
-    ["John", "Alice"] is on holiday on 20000108
-    ["John"] is on holiday on 20000109
-    ["John"] is on holiday on 20000110
-    ["John"] is on holiday on 20000111
-    ...
 
+```ruby
+# Below is an example using integers (formatted as dates) as keys. You can just as easily use dates, times
+# floats or other comparable types.
+
+require 'range_tree'
+
+staff_holidays = RangeTree::Tree.new
+
+staff_holidays[2000_01_01, 2000_01_15] = "John"
+staff_holidays[2000_01_15, 2000_01_31] = "Greig"
+staff_holidays[2000_01_20, 2000_02_05] = "Eve"
+staff_holidays[2000_01_03, 2000_01_08] = "Alice"
+staff_holidays[2000_01_18, 2000_01_20] = "Bob"
+
+# Check who is on holiday on certain dates
+staff_holidays[2000_01_04]
+=> ["Alice", "John"]
+
+# Check all staff members on holiday within a certain period by passing a range
+staff_holidays[2000_01_12..2011_01_19]
+=> ["John", "Bob", "Greig", "Eve"]
+
+
+# Iterate through all periods where the system state changes
+staff_holidays.distinct.each do |date, staff|
+  puts "From #{date} #{staff} will be on holiday"
+end
+
+=>
+From 20000101 ["John"] will be on holiday
+From 20000103 ["John", "Alice"] will be on holiday
+From 20000109 ["John"] will be on holiday
+From 20000115 ["John", "Greig"] will be on holiday
+From 20000116 ["Greig"] will be on holiday
+From 20000118 ["Greig", "Bob"] will be on holiday
+From 20000120 ["Greig", "Bob", "Eve"] will be on holiday
+From 20000121 ["Greig", "Eve"] will be on holiday
+From 20000132 ["Eve"] will be on holiday
+From 20000206 [] will be on holiday
+
+# Iterate though all periods in the tree.
+staff_holidays.all.each do |date, staff|
+  puts "#{staff} is on holiday on #{date}"
+end
+
+=>
+["John"] is on holiday on 20000101
+["John"] is on holiday on 20000102
+["John", "Alice"] is on holiday on 20000103
+["John", "Alice"] is on holiday on 20000104
+["John", "Alice"] is on holiday on 20000105
+["John", "Alice"] is on holiday on 20000106
+["John", "Alice"] is on holiday on 20000107
+["John", "Alice"] is on holiday on 20000108
+["John"] is on holiday on 20000109
+["John"] is on holiday on 20000110
+["John"] is on holiday on 20000111
+...
+
+# Remove values from tree
+
+staff_holidays >> "John"
+# or
+staff_holidays.remove "John"
+
+# Get smallest or largest keys in tree
+staff_holidays.max
+=> 2000_02_05
+
+staff_holidays.min
+=> 2000_01_01
+```

data/lib/range_tree.rb

@@ -5,9 +5,7 @@ module RangeTree
     require 'set'
     attr_accessor :children, :root, :starts, :ends, :rebuild_on_add
 
-    MAX_REBUILD_SIZE = 500
-
-    def initialize(rebuild_on_add: true)
+    def initialize(rebuild_on_add=true)
       self.children = []
       self.rebuild_on_add = rebuild_on_add
       self.starts   = Hash.new{|h,k| h[k] = []}
@@ -30,6 +28,14 @@ module RangeTree
       remove(value)
     end
 
+    def min
+      self.root && self.root.min
+    end
+
+    def max
+      self.root && self.root.max
+    end
+
     def remove(value)
       return unless node_to_remove = self.children.find{|child| child.value == value}
       self.children.delete(node_to_remove)
@@ -68,6 +74,18 @@ module RangeTree
       end
     end
 
+    def to_s
+      if self.root
+        "RangeTree[#{root.min}..#{root.max}]"
+      else
+        "RangeTree[empty]"
+      end
+    end
+
+    def inspect
+      "#{self}"
+    end
+
     private
     def iterate(range)
       return [] unless self.root

data/lib/range_tree/version.rb

@@ -1,3 +1,3 @@
 module RangeTree
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: range_tree
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Wouter Coppieters