telepath 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e34c44c95862221a4d1cfb6bdf316d68ee622b2e
-  data.tar.gz: 3754468fd1ecdfcc09f2fd4b3c3ddb817386b26e
+  metadata.gz: 7e69b7082bfdff850dd491c0b7afbd3f37eb611d
+  data.tar.gz: 9dcc58cf0842de030bba29f97a399df0a2c54387
 SHA512:
-  metadata.gz: 0526648fba0e0336350967b4bf1d33c062c934efe718658698c6f9c6c3a1fccd83474fde450d5d90e78ea9626ee966291f060ab74fc06c9001f6274202eb88aa
-  data.tar.gz: b613d99f4e5096bc84f1d6f703c50d9e54175dabc2548f01f0150f9d3030a492b1bb9c5080371bc649abe99323995433ff1a96e5330a55d6c0a9301009d21863
+  metadata.gz: c756e27d743378158c557de22d20d2e64f8795bfe7a0013e5cf1eba0a3725b96f9ce7fac9c7d137d7046104147a8298e021387ee49149e5b010f41a21867a34e
+  data.tar.gz: 4a0c542a0f0190460e30125579e24eda0f843b4a8813cbf9c78f2dbc4fab940bf66d5f085f566e6353a7e812b3ba6a6d732988729afe6430c73194b1efac4599

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+*.db
 .bundle
 .config
 .yardoc

data/bin/tel

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/telepath'
+
+Telepath::Command.run
+

data/lib/telepath/command.rb

@@ -0,0 +1,43 @@
+require 'clamp'
+
+module Telepath
+  class Command < ::Clamp::Command
+
+    option ['-q', '--quiet'], :flag, "Only output when absolutely necessary."
+
+    subcommand ['+'], 'Add item to Telepath' do
+      parameter 'VALUE', 'value to add'
+
+      def execute
+        handler = Telepath::Handler.new self
+        success, name = handler.add value
+
+        if success then
+          Out.info "Added `#{value}' to `#{name}'!"
+        else
+          Out.error self, "Could not add `#{value}' to `#{name}'!"
+        end
+      end
+    end
+
+    subcommand ['='], 'Grab item from Telepath' do
+      parameter '[PATTERN]', 'pattern to find'
+
+      def execute
+        handler = Telepath::Handler.new self
+        value = handler.grab pattern
+
+        if value && !value.empty? then
+          Out.data value
+        else
+          Out.error self, "Pattern `#{pattern}' not matched."
+        end
+      end
+    end
+
+    def execute
+      exit 1
+    end
+
+  end
+end

data/lib/telepath/handler.rb

@@ -0,0 +1,56 @@
+module Telepath
+  class Handler
+    def initialize command
+      @command = command
+    end
+
+    def add value
+      name = 'stack'
+
+      with_store name do |container|
+        container << value
+      end
+
+      [true, name]
+    end
+
+    def grab pattern = nil
+      with_store 'stack' do |container|
+
+        if pattern && !pattern.empty? then
+          if container.include? pattern.to_s then
+            pattern.to_s
+          else
+            container.find do |element|
+              /#{pattern}/ =~ element.to_s
+            end
+          end
+        else
+          container.last
+        end
+
+      end
+    end
+
+    def storage
+      if @storage && @storage.ready? then
+        @storage
+      else
+        @storage = Telepath::Storage.new
+      end
+    end
+
+    protected
+
+    def with_store name = 'stack'
+      container = storage.store[name] || Array.new
+
+      result = yield container
+
+      storage.store[name] = container
+      result
+    ensure
+      storage.store.close
+    end
+  end
+end

data/lib/telepath/out.rb

@@ -0,0 +1,18 @@
+module Telepath
+  module Out
+    module_function
+
+    def info *messages
+      puts messages.flatten.join ' '
+    end
+
+    def data *messages
+      puts messages.flatten
+    end
+
+    def error command, *messages
+      raise Clamp::UsageError.new(messages.flatten.join("\n"), command)
+    end
+
+  end
+end

data/lib/telepath/storage.rb

@@ -0,0 +1,64 @@
+require 'moneta'
+require 'daybreak'
+
+module Telepath
+  class Storage
+
+    DEFAULT_PATH = '~'
+    DEFAULT_FILE = '.telepath.db'
+    DEFAULT_TYPE = :Daybreak
+
+    def store
+      @store ||= create_store
+    end
+
+    def stack
+      store['stack'] || Array.new
+    end
+
+    def ready?
+      !store.adapter.backend.closed?
+    end
+
+    ### -----
+
+    def location
+      if path.exist? then
+        path.join file
+      else
+        raise <<-ERRMSG
+            Create or change the storage path for Telepath.
+            Current: `#{path}'
+            Environment Variable Name: `#{PATH_VAR}'
+        ERRMSG
+      end
+    end
+
+    def path
+      @path ||= Pathname.new(get :path).expand_path
+    end
+
+    def file
+      @file ||= get :file
+    end
+
+    def type
+      @type ||= get :type
+    end
+
+    protected
+
+    def create_store
+      Moneta.new type, file: location
+    end
+
+    def get name
+      env_name   = "TELEPATH_#{name.to_s.upcase}"
+      const_name = "DEFAULT_#{name.to_s.upcase}"
+      value      = ENV[env_name]
+
+      value && !value.empty? && value || self.class.const_get(const_name)
+    end
+
+  end
+end

data/lib/telepath/version.rb

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

data/lib/telepath.rb

@@ -3,7 +3,10 @@ require 'pathname'
 require 'bundler/setup'
 
 require 'telepath/version'
-require 'telepath/store'
+require 'telepath/out'
+require 'telepath/storage'
+require 'telepath/handler'
+require 'telepath/command'
 
 module Telepath
   def self.root

data/spec/exe_spec.rb

@@ -0,0 +1,71 @@
+require_relative 'spec_helper'
+
+describe 'Telepath Executable' do
+  let(:exe){ run "./bin/tel #{command} #{args.join ' '}" }
+  let(:status){ exe.status }
+  let(:stdout){ exe.stdout.strip }
+
+  # override these in context
+  let(:command){ '' }
+  let(:args){ [] }
+
+  before do
+    pre_test_setup
+  end
+
+  after do
+    post_test_teardown
+  end
+
+  it 'runs' do
+    expect(status).to be_success
+  end
+
+  context 'invalid arguments' do
+    let(:args){ ['invalid_argument'] }
+    specify { expect(status).to_not be_success }
+  end
+
+  describe '+' do
+    let(:command){ :+ }
+
+    context 'without value' do
+      specify { expect(status).to_not be_success }
+    end
+
+    context 'with value' do
+      let(:args){ ['12'] }
+
+      specify { expect(status).to be_success }
+
+      it 'adds the value to the stack' do
+        expect(stdout).to eq("Added `12' to `stack'!")
+      end
+    end
+  end
+
+  describe '=' do
+    let(:command){ '=' }
+    let(:handler){ Telepath::Handler.new double(Clamp::Command) }
+    let(:value){ '12' }
+
+    before do
+      handler.add value
+    end
+
+    context 'without parameters' do
+      context 'with values in telepath' do
+
+        specify { expect(status).to be_success }
+        specify { expect(stdout).to eq value }
+      end
+    end
+
+    context 'with parameters' do
+      let(:args){ ['1'] }
+
+      specify { expect(status).to be_success }
+      specify { expect(stdout).to eq value }
+    end
+  end
+end

data/spec/handler_spec.rb

@@ -0,0 +1,64 @@
+require_relative 'spec_helper'
+
+describe Telepath::Handler do
+  before { pre_test_setup }
+  after  { post_test_teardown }
+
+  subject(:handler){ described_class.new double(Clamp::Command) }
+
+  let(:storage){ Telepath::Storage.new }
+
+  it 'exists' do
+    expect(described_class).to be
+  end
+
+  after do
+    storage.store.close unless storage.store.adapter.backend.closed?
+  end
+
+  describe '#add' do
+    it 'adds 1 item' do
+      expect{ handler.add 'whatever' }.to change{
+        storage.store.adapter.backend.sunrise
+        storage.stack.length
+      }.from(0).to(1)
+    end
+
+    it 'adds the right item' do
+      handler.add 'whatever'
+      expect(storage.stack).to include('whatever')
+    end
+  end
+
+  describe '#grab' do
+    let(:value){ 'whatever' }
+    before do
+      handler.add value
+    end
+
+    it 'grabs last value' do
+      expect(handler.grab).to eq(value)
+    end
+
+    it 'does not delete the item' do
+      expect{ handler.grab value }.to change{
+        storage.store.adapter.backend.sunrise
+        storage.stack.length
+      }.by(0)
+    end
+
+    context 'pattern matching' do
+      it 'matches substrings of words' do
+        expect(handler.grab('what')).to eq(value)
+      end
+
+      context 'numbers' do
+        let(:value){ '12' }
+
+        it 'matches parts of numbers' do
+          expect(handler.grab('1')).to eq(value)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,35 @@
 require_relative '../lib/telepath'
 
 require 'rspec'
+require 'open4'
 require 'pry' unless ENV['CI'] == 'true'
 
 Dir.chdir Telepath.root
 
+module SpecHelpers
+  def run *args
+    result_class = Struct.new :pid, :stdout, :stderr, :commandline, :status
+    command = args.join ' '
+
+    result = nil
+    status = Open4.open4(command) do |pid, stdin, stdout, stderr|
+      result = result_class.new pid, stdout.read, stderr.read, command
+    end
+
+    result.status = status
+    result
+  end
+
+  def path_env_var; 'TELEPATH_PATH'; end
+  def test_path; Telepath.root.join 'tmp'; end
+  def test_file; test_path.join Telepath::Storage.new.file; end
+  def cleanup_db; test_file.delete if test_file.exist?; end
+  def assign_test_path; ENV[path_env_var] = test_path.to_s; end
+  def unassign_test_path; ENV[path_env_var] = nil; end
+  def pre_test_setup; assign_test_path; cleanup_db; end
+  def post_test_teardown; unassign_test_path; cleanup_db; end
+end
+
+RSpec.configure do |c|
+  c.include SpecHelpers
+end

data/spec/storage_spec.rb

@@ -0,0 +1,73 @@
+require_relative 'spec_helper'
+
+describe Telepath::Storage do
+  subject(:storage){ described_class.new }
+  let(:default_file){ '.telepath.db' }
+  let(:default_path){ File.expand_path '~' }
+  let(:default_location){ "#{default_path}/#{default_file}" }
+
+  it 'exists' do
+    expect(described_class).to be
+  end
+
+  context 'with default location' do
+    describe '#file' do
+      subject(:file){ storage.file }
+
+      it 'matches defaults' do
+        expect(file.to_s).to eq default_file
+      end
+    end
+
+    describe '#path' do
+      subject(:path){ storage.path }
+
+      it 'defaults to home directory' do
+        expect(path.to_s).to eq default_path
+      end
+    end
+
+    describe '#location' do
+      subject(:path){ storage.location }
+
+      it 'defaults to a combination of the path and file' do
+        expect(path.to_s).to eq default_location
+      end
+
+      context 'invalid path' do
+        before do
+          ENV[path_env_var] = '/this/path/doesnt/exist/hopefully'
+        end
+
+        after do
+          ENV[path_env_var] = nil
+        end
+
+        specify { expect{path}.to raise_exception }
+      end
+    end
+  end
+
+  context 'with test location' do
+
+    before :all do
+      ENV[path_env_var] = test_path.to_s
+      test_file.delete if test_file.exist?
+    end
+
+    after :all do
+      ENV[path_env_var] = nil
+      test_file.delete if test_file.exist?
+    end
+
+    describe '.new' do
+      before do
+        Moneta.stub(:new) { 'test object' }
+      end
+
+      it 'creates a store object using Moneta' do
+        expect(storage.store).to eq 'test object'
+      end
+    end
+  end
+end

data/telepath.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'daybreak'
 
   # commandline
-  #spec.add_dependency 'clamp'
+  spec.add_dependency 'clamp'
   #spec.add_dependency 'highline'
 
   # development
@@ -34,6 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-theme'
   # testing
   spec.add_development_dependency 'rspec', '~> 2'
-  #spec.add_development_dependency 'bogus'
+  spec.add_development_dependency 'open4'
   #spec.add_development_dependency 'ffaker'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telepath
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Anthony Cook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-31 00:00:00.000000000 Z
+date: 2013-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: moneta
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,10 +122,25 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: open4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Sorta like IPC for people to GTD.
 email:
 - anthonymichaelcook@gmail.com
-executables: []
+executables:
+- tel
 extensions: []
 extra_rdoc_files: []
 files:
@@ -123,14 +152,20 @@ files:
 - LICENSE.txt
 - README.markdown
 - Rakefile
+- bin/tel
 - lib/telepath.rb
-- lib/telepath/store.rb
+- lib/telepath/command.rb
+- lib/telepath/handler.rb
+- lib/telepath/out.rb
+- lib/telepath/storage.rb
 - lib/telepath/version.rb
+- spec/exe_spec.rb
+- spec/handler_spec.rb
 - spec/spec_helper.rb
-- spec/store_spec.rb
+- spec/storage_spec.rb
 - spec/telepath_spec.rb
 - telepath.gemspec
-- test.db
+- tmp/.gitkeep
 homepage: http://github.com/acook/telepath#readme
 licenses:
 - MIT
@@ -156,6 +191,8 @@ signing_key:
 specification_version: 4
 summary: Spooky action at a distance.
 test_files:
+- spec/exe_spec.rb
+- spec/handler_spec.rb
 - spec/spec_helper.rb
-- spec/store_spec.rb
+- spec/storage_spec.rb
 - spec/telepath_spec.rb

data/lib/telepath/store.rb

@@ -1,35 +0,0 @@
-require 'moneta'
-require 'daybreak'
-
-module Telepath
-  class Store
-
-    class << self
-      def path
-        Pathname.new('~/').expand_path
-      end
-
-      def file
-        '.telepath.db'
-      end
-
-      def location
-        path.join file
-      end
-
-
-      def create
-        new Moneta.new :Daybreak, file: location
-      end
-    end
-
-    def initialize store
-      @store = store
-    end
-
-    protected
-
-    attr_accessor :store
-
-  end
-end

data/spec/store_spec.rb

@@ -1,46 +0,0 @@
-require_relative 'spec_helper'
-
-describe Telepath::Store do
-  it 'exists' do
-    expect(Telepath::Store).to be
-  end
-
-  let(:default_file){ '.telepath.db' }
-  let(:default_path){ File.expand_path '~' }
-  let(:default_location){ "#{default_path}/#{default_file}" }
-
-  describe '.file' do
-    subject(:file){ described_class.file }
-
-    it 'matches defaults' do
-      expect(file.to_s).to eq default_file
-    end
-  end
-
-  describe '.path' do
-    subject(:path){ described_class.path }
-
-    it 'defaults to home directory' do
-      expect(path.to_s).to eq default_path
-    end
-  end
-
-  describe '.location' do
-    subject(:path){ described_class.location }
-
-    it 'defaults to a combination of the path and file' do
-      expect(path.to_s).to eq default_location
-    end
-  end
-
-  describe '.create' do
-    it 'relays the new data store to new' do
-      expect(described_class).to receive(:new).with anything
-      described_class.create
-    end
-
-    it 'assigns the store object' do
-      expect(described_class.create.send(:store)).to be
-    end
-  end
-end