etcd-completion 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a87f71c302cc1f90fee1a9f4af10aea41bf8e93
-  data.tar.gz: 6946203d8229f18ce245e916595c5f54e32ade02
+  metadata.gz: 838c65b812cf27f31626684e15e71e7459c6d896
+  data.tar.gz: cee0dab9d704ae70f10f7ca1b0939381cd011579
 SHA512:
-  metadata.gz: d5c4e02e5c5b05f2e10c872c2bcff83be5f0382c059eedb9ac0cd343bb7633038ca1056ee296bd0f13bbeae6fc9e178580100fcaba9eca072e5b0fd840ad9e84
-  data.tar.gz: ce738743248867950118a71fa1d79d22ddc1932aee8816e03e8aa6e0d713c2db94931d47b0477c7111fb9d0dc61140baf97fed83037b49ecd5673ebdb52ab884
+  metadata.gz: a63fa945007f5c6b161801993ae49cddd31c0c4200d1df1d44945725a6bb1813a81d655a7880947dd63721e6b9f40ff6e8700034deb440601ebb3627d8ea2e0b
+  data.tar.gz: 38860b79acf047643e36aafd5b00b49cae64731c7dcbef7e0c409b8006c206cfd139477e5b031c4dc28cae6ec24996f21d4e4558606f93428acc58fa0825b832

data/README.md

@@ -1,29 +1,57 @@
 # Etcd::Completion
-
-TODO: Write a gem description
+Rubygem. Provides a CLI for performing etcd autocompletion.
 
 ## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'etcd-completion'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install etcd-completion
+```bash
+gem install etcd-completion
+```
 
 ## Usage
+```bash
+etcd-completion <operation> <prefix>
+```
+Operation must an etcd operation - ie: 
+* mkdir
+* get
+* ls
+* set
+* etcetera
+
+Prefix must be part of a path or a key.
+
+## Examples
+Given this directory structure:
+```
+/
+|--dir1
+|   |--k/
+|   |--key
+|   |--key2
+|--dir2
+```
+
+```
+etcd-completion ls /d
+--> /dir1/ /dir2/
+
+etcd-completion ls /dir1
+--> /dir1/key1 /dir1/key2
+
+etcd-completion ls /dir1/k
+--> /dir1/k/
+
+etcd-completion get /dir1/k
+--> /dir1/k/ /dir1/key /dir1/key2
+```
+
+## Limitations
+* Currently, etcd-completion does not recurse into subdirectories to prune  
+invalid directories. In the above examples, the ```get /dir1/k``` example should
+prune the "dir/k" directory, because there are no keys to "get" in that 
+directory, so get cannot possibly operate on a path starting with it. I plan
+to address this problem in a future pull request.
+* Currently, this gem is just a bin file, with no library, so it is useful 
+only from the commandline and not from ruby programs. I plan to rectify this
+as well.
 
-TODO: Write usage instructions here
-
-## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/etcd-completion/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/bin/etcd-completion

@@ -13,14 +13,7 @@ def filter(prefix, key)
   key.start_with?(prefix)
 end
 
-def log msg
-  open('/tmp/temp.txt', 'a') do |f|
-    f << msg << "\n"
-  end
-end
-
 def completions(op, prefix)
-  log "op: #{op}, prefix:#{prefix}" 
   prefix = '' if prefix.nil?
   if node_ops.include? op
     type = 'node'

data/lib/etcd/completion/version.rb

@@ -1,5 +1,5 @@
 module Etcd
   module Completion
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: etcd-completion
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Shea