telepath 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e69b7082bfdff850dd491c0b7afbd3f37eb611d
-  data.tar.gz: 9dcc58cf0842de030bba29f97a399df0a2c54387
+  metadata.gz: b38bc8a0619f00d35224b7e2586a0d193074f7a3
+  data.tar.gz: 81772bf8131f737c3071e2566158559f576edaa7
 SHA512:
-  metadata.gz: c756e27d743378158c557de22d20d2e64f8795bfe7a0013e5cf1eba0a3725b96f9ce7fac9c7d137d7046104147a8298e021387ee49149e5b010f41a21867a34e
-  data.tar.gz: 4a0c542a0f0190460e30125579e24eda0f843b4a8813cbf9c78f2dbc4fab940bf66d5f085f566e6353a7e812b3ba6a6d732988729afe6430c73194b1efac4599
+  metadata.gz: a32bab376cf4b20156be53dceb4c5e567a103f4dc4174664dc16a99d746eabd8582cbb34329266d7eb79444c231205629071b501b1556ebff4a98258b340f07a
+  data.tar.gz: 16b7370de869fc20fb802bdea9ca45516c1ddb0b70dd8d947b9a2ef2fd522c68bca4eb252771afe5096bab41fb08a2d0811ee65ba4e3fb5edc2dab06d28e4ea6

data/README.markdown

@@ -3,6 +3,7 @@ Telepath
 
 Spooky action at a distance.
 
+[![Gem Version](https://badge.fury.io/rb/telepath.png)](http://badge.fury.io/rb/telepath)
 [![Build Status](https://travis-ci.org/acook/telepath.png?branch=master)](https://travis-ci.org/acook/telepath)
 [![Code Climate](https://codeclimate.com/github/acook/telepath.png)](https://codeclimate.com/github/acook/telepath)
 [![Dependency Status](https://gemnasium.com/acook/telepath.png)](https://gemnasium.com/acook/telepath)
@@ -33,6 +34,80 @@ What about shared, persistant, distributed, fully decorated multi-client multi-h
 Yeah thats pretty much what I thought. Now go change your pants, I'll still be here when you get back.
 
 
+Installation & Setup
+--------------------
+
+### Install it!
+
+```sh
+gem install telepath
+```
+
+### Set it up!
+
+Actually, thats pretty much it. Telepath just works.
+
+
+Usage
+-----
+
+Here's the output of `tel --help`:
+
+```sh
+Usage:
+    tel [OPTIONS] SUBCOMMAND [ARG] ...
+
+Parameters:
+    SUBCOMMAND                    subcommand
+    [ARG] ...                     subcommand arguments
+
+Subcommands:
+    +, add                        Add item
+    ?, lookup                     Look up item by pattern
+    $, last                       Get most recent item
+    @, index                      Get item from (reverse) index
+
+Options:
+    -q, --quiet                   Only output when absolutely necessary. (default: $TELEPORT_QUIET, or false)
+    -f, --file FILE               Filename of the Teleport store file. (default: $TELEPORT_FILE, or ".telepath.db")
+    -p, --path PATH               Path where the the Teleport store file is located. (default: $TELEPORT_PATH, or "~")
+    -h, --help                    print help
+```
+
+Example
+-------
+
+Dump data into Telepath from Bash...
+
+```bash
+$ tel + "All the things!"
+```
+
+Use it in Vim...
+
+```viml
+:r ! tel $
+```
+
+Use it again in Zsh...
+
+```zsh
+∴ export which_things=$(tel $)
+```
+
+Manipulate it with `tr` in zsh and add the result back into Telepath...
+
+```zsh
+∴ tel $ | tr '[:lower:]' '[:upper:]' | tel +
+```
+
+And bring it back into Bash to combine it with the previous version...
+
+```bash
+$ echo $(tel $) $(tel @ 1) | tee result.txt | tel +
+```
+
+
 Contributing
 ------------
 
@@ -50,4 +125,6 @@ I'm glad you asked!
 
     Anthony M. Cook 2013
 
+Inspired by this perl script: [oknowton/shstack](https://github.com/oknowton/shstack)
+
 

data/lib/telepath/command.rb

@@ -3,29 +3,51 @@ require 'clamp'
 module Telepath
   class Command < ::Clamp::Command
 
-    option ['-q', '--quiet'], :flag, "Only output when absolutely necessary."
+    option ['-q', '--quiet'], :flag, 'Only output when absolutely necessary.',
+      environment_variable: 'TELEPORT_QUIET', default: false
 
-    subcommand ['+'], 'Add item to Telepath' do
-      parameter 'VALUE', 'value to add'
+    option ['-f', '--file'], 'FILE', 'Filename of the Teleport store file.',
+      environment_variable: 'TELEPORT_FILE', default: Telepath::Storage::DEFAULT_FILE
+
+    option ['-p', '--path'], 'PATH', 'Path where the the Teleport store file is located.',
+      environment_variable: 'TELEPORT_PATH', default: Telepath::Storage::DEFAULT_PATH
+
+    subcommand ['+', 'add'], 'Add item' do
+      parameter '[VALUE] ...', 'value to add', attribute_name: 'values'
 
       def execute
         handler = Telepath::Handler.new self
-        success, name = handler.add value
+        values = self.values || Array.new
+
+        unless $stdin.tty? then
+          buffered = IO.select([$stdin], [], [], 1)
+          values << $stdin.read.strip if buffered && buffered.first && buffered.first.first
+        end
+
+        Out.error self, "No values supplied!" if values.empty?
+
+        results = values.map do |value|
+          handler.add value
+        end
+
+        success = results.all?{|r|r.first}
+        name    = results.first.last
 
         if success then
-          Out.info "Added `#{value}' to `#{name}'!"
+          Out.info "Added [#{values.map(&:inspect).join ', '}] to `#{name}'!"
         else
-          Out.error self, "Could not add `#{value}' to `#{name}'!"
+          failures = values.reject.with_index{|_, i| results[i].first}
+          Out.error self, "Could not add [#{failures.map().join ', '}] to `#{name}'!"
         end
       end
     end
 
-    subcommand ['='], 'Grab item from Telepath' do
+    subcommand ['?', 'lookup'], 'Look up item by pattern' do
       parameter '[PATTERN]', 'pattern to find'
 
       def execute
         handler = Telepath::Handler.new self
-        value = handler.grab pattern
+        value = handler.lookup pattern
 
         if value && !value.empty? then
           Out.data value
@@ -35,6 +57,38 @@ module Telepath
       end
     end
 
+    subcommand ['$', 'last'], 'Get most recent item' do
+      def execute
+        handler = Telepath::Handler.new self
+        value = handler.last
+
+        if value && !value.empty? then
+          Out.data value
+        else
+          Out.error self, "Telepath is empty, is your storage location configured properly?"
+        end
+      end
+    end
+
+    subcommand ['@', 'index'], 'Get item from (reverse) index' do
+      parameter 'INDEX ...', 'index of item, starting from most recent (0)',
+        attribute_name: :indicies do |i|
+          Integer(i)
+        end
+
+      def execute
+        handler = Telepath::Handler.new self
+        index = indicies.first
+        value = handler.index index
+
+        if value && !value.to_s.empty? then
+          Out.data value
+        else
+          Out.error self, "Hmm, couldn't find anything at that index."
+        end
+      end
+    end
+
     def execute
       exit 1
     end

data/lib/telepath/handler.rb

@@ -14,7 +14,13 @@ module Telepath
       [true, name]
     end
 
-    def grab pattern = nil
+    def last
+      with_store 'stack' do |container|
+        container.last
+      end
+    end
+
+    def lookup pattern
       with_store 'stack' do |container|
 
         if pattern && !pattern.empty? then
@@ -32,6 +38,14 @@ module Telepath
       end
     end
 
+    def index *indicies
+      index = indicies.first
+
+      with_store 'stack' do |container|
+        container[-(index.to_i + 1)]
+      end
+    end
+
     def storage
       if @storage && @storage.ready? then
         @storage

data/lib/telepath/version.rb

@@ -1,3 +1,3 @@
 module Telepath
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/exe_spec.rb

@@ -26,7 +26,7 @@ describe 'Telepath Executable' do
     specify { expect(status).to_not be_success }
   end
 
-  describe '+' do
+  describe '+ add' do
     let(:command){ :+ }
 
     context 'without value' do
@@ -39,13 +39,17 @@ describe 'Telepath Executable' do
       specify { expect(status).to be_success }
 
       it 'adds the value to the stack' do
-        expect(stdout).to eq("Added `12' to `stack'!")
+        expect(stdout).to eq("Added [\"12\"] to `stack'!")
+      end
+
+      it 'should have no error output' do
+        expect(exe.stderr).to eq ''
       end
     end
   end
 
-  describe '=' do
-    let(:command){ '=' }
+  describe '? lookup' do
+    let(:command){ '?' }
     let(:handler){ Telepath::Handler.new double(Clamp::Command) }
     let(:value){ '12' }
 

data/spec/handler_spec.rb

@@ -7,6 +7,11 @@ describe Telepath::Handler do
   subject(:handler){ described_class.new double(Clamp::Command) }
 
   let(:storage){ Telepath::Storage.new }
+  let(:value){ 'whatever' }
+
+  before do
+    handler.add value
+  end
 
   it 'exists' do
     expect(described_class).to be
@@ -18,30 +23,60 @@ describe Telepath::Handler do
 
   describe '#add' do
     it 'adds 1 item' do
-      expect{ handler.add 'whatever' }.to change{
+      expect{ handler.add 'something' }.to change{
         storage.store.adapter.backend.sunrise
         storage.stack.length
-      }.from(0).to(1)
+      }.from(1).to(2)
     end
 
     it 'adds the right item' do
-      handler.add 'whatever'
-      expect(storage.stack).to include('whatever')
+      handler.add 'something'
+      expect(storage.stack).to include('something')
+    end
+
+    context 'redirected input' do
+      xit 'reads and stores stdin' do
+      end
     end
   end
 
-  describe '#grab' do
-    let(:value){ 'whatever' }
+  describe '#last' do
+    it 'returns the last value' do
+      expect(handler.last).to eq(value)
+    end
+
+    it 'does not delete the item' do
+      expect{ handler.last }.to change{
+        storage.store.adapter.backend.sunrise
+        storage.stack.length
+      }.by(0)
+    end
+  end
+
+  describe '#index' do
     before do
-      handler.add value
+      handler.add 'blah'
+    end
+
+    it 'returns the item at the specified reverse index (1)' do
+      expect(handler.index 1).to eq(value)
     end
 
-    it 'grabs last value' do
-      expect(handler.grab).to eq(value)
+    it 'returns the item at the specified reverse index (0)' do
+      expect(handler.index 0).to eq('blah')
     end
 
     it 'does not delete the item' do
-      expect{ handler.grab value }.to change{
+      expect{ handler.index value }.to change{
+        storage.store.adapter.backend.sunrise
+        storage.stack.length
+      }.by(0)
+    end
+  end
+
+  describe '#lookup' do
+    it 'does not delete the item' do
+      expect{ handler.lookup value }.to change{
         storage.store.adapter.backend.sunrise
         storage.stack.length
       }.by(0)
@@ -49,14 +84,14 @@ describe Telepath::Handler do
 
     context 'pattern matching' do
       it 'matches substrings of words' do
-        expect(handler.grab('what')).to eq(value)
+        expect(handler.lookup('what')).to eq(value)
       end
 
       context 'numbers' do
         let(:value){ '12' }
 
         it 'matches parts of numbers' do
-          expect(handler.grab('1')).to eq(value)
+          expect(handler.lookup('1')).to eq(value)
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telepath
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Anthony Cook