array_trie 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5ee196913bc37a7c274bc7d36689a40d19838a6
-  data.tar.gz: b4a0dc46652a9964f29db20def6b0d648407c933
+  metadata.gz: 15499f92722e8290a8de0c8c2a17f3bae3d77102
+  data.tar.gz: fc76470fe8932414955e48ab9099ede0548fda50
 SHA512:
-  metadata.gz: 4694fea10a3c317b20e026deb9ff1dd57fe6640b038b6d79622dc8ee8cc9713f87a6b79555627a01cd8c3df104a357826428f01ff45a2b534fee63ec96cd2b8e
-  data.tar.gz: 0258d42deceb72fc9c0df2c97c4b3212b0573291359554040be3775aa48a170a61513d04a62b2f6c42d868c3d75dded782fbe2a35d02e47a51a87aa5c22c6da4
+  metadata.gz: 59ef3cff51b614e7a4928ebae233c7113c5aaf657a0012e9f8063fed6f10f0710bbb1c7ac58815882d9d9d1c7eb563144d18034f161aefe069daf64018d3f072
+  data.tar.gz: 36488d8d2ff5ff712b01944b101f01c0bc12ca6e95cc80f91bc3729763e5d758873e1e56c7def000ef22ced7065fba58359dd40dedae6c28d55638ad376eb9d2

data/README.md

@@ -1,8 +1,11 @@
 # ArrayTrie
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/array_trie`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Ruby gem](https://img.shields.io/gem/v/array_trie.svg)](https://rubygems.org/gems/array_trie)
+[API docs](https://www.rubydoc.info/gems/array_trie)
 
-TODO: Delete this and the text above, and describe your gem
+Trie-like, prefix-tree data structures. First, a prefix-tree based on Arrays, which differs from a traditional trie, which maps strings to values. Second, a more general prefix-tree data structure that works for any type of keys, provided those keys can be transformed to and from an array.
+
+Both of these data structures are implemented in terms of hashes.
 
 ## Installation
 
@@ -22,11 +25,59 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Use the base `ArrayTrie` class if you want to work with an array-keyed trie.
+The more general `ArrayTrie::PrefixTrie` class can be used with any sort of
+ordered key.
+
+```ruby
+require 'array_trie/prefix_trie'
+
+# You can store any sort of ordered key in a PrefixTrie, provided you can
+# convert to and from arrays in a stable way.
+path_to_a = -> (path) { path.split('/') }
+a_to_path = -> (array) { array.join('/') }
+paths = ArrayTrie::PrefixTrie.new(path_to_a, a_to_path)
+
+# Store some keys in the trie
+paths['/usr/local/bin/ruby'] = 'executable'
+paths['/usr/local/etc/nginx/nginx.cfg'] = 'config file'
+paths['/bin/bash'] = 'executable'
+
+# Tries have efficient prefix queries
+paths.include_prefix?('/usr/local') 
+# => true
+paths.count_prefix('/usr/local')
+# => 2
+
+# You can obtain a subtrie to operate on a subsection of your trie
+usr_local = paths.subtrie('/usr/local')
+usr_local['bin/ruby']
+# => 'executable'
+
+usr_local['bin/fish'] = 'executable'
+paths['/usr/local/bin/fish']
+# => executable
+
+# Use #breadth_first and #depth_first to enumarate your keys and values
+paths.breadth_first do |k, v|
+  puts "Path #{k} is of type #{v}"
+end
+# STDOUT: Path /bin/bash is of type executable
+# STDOUT: Path /usr/local/bin/ruby is of type executable
+# STDOUT: Path /usr/local/etc/nginx/nginx.cfg is of type config file
+
+# These methods return Enumerators, so you can use them with #map, etc.
+enum = paths.depth_first
+as_hash = Hash[enum.to_a]
+# => {
+# "/usr/local/bin/ruby"=>"executable",
+# "/usr/local/etc/nginx/nginx.cfg"=>"config file",
+# "/bin/bash"=>"executable"}
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Finally, use `bin/test` to run the tests.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/array_trie.rb

@@ -9,6 +9,8 @@
 # {ArrayTrie::PrefixTrie}, which can map arbitrary keys to values, so long as
 # your keys can be converted to and from arrays.
 class ArrayTrie
+  require 'array_trie/version'
+
   # Just a unique marker value.
   # Using Class.new is better than using Object.new, because it makes sense
   # when inspected.

data/lib/array_trie/prefix_trie.rb

@@ -1,3 +1,5 @@
+require 'array_trie'
+
 class ArrayTrie
   # A trie-like, prefix-tree data structure that maps arbitrary keys to values,
   # provided that the keys may be transformed to and from arrays, as each

data/lib/array_trie/version.rb

@@ -1,3 +1,3 @@
 class ArrayTrie
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: array_trie
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jake Teton-Landis