prysless 0.0.1 → 0.0.2

data/README.md

@@ -6,7 +6,9 @@
 [![Inline docs](http://inch-ci.org/github/yazgoo/prysless.png?branch=master)](http://inch-ci.org/github/yazgoo/prysless)
 [![Gem Version](https://badge.fury.io/rb/prysless.svg)](http://badge.fury.io/rb/prysless)
 
-TODO: Write a gem description
+prysless aims to integrate ruby programs in terminal sessions with lowest harm.
+
+It is based on pry REPL, hence the name.
 
 ## Installation
 
@@ -22,9 +24,64 @@ Or install it yourself as:
 
     $ gem install prysless
 
-## Usage
+## Configuring
+
+All the configuring is done via environment variables,
+so to me it adds up to editing my bashrc
+
+*  PRYSLESS\_LIBRARY\_PATH: path to load additional libraries, ":"-separated
+*  PRYSLESS\_REQUIRE: variable definitions
+*  PRYSLESS\_ALIASES: shell command aliases
+
+For example:
+
+    export PRYSLESS_ALIASES='l=ls:c=cd'
+    export PRYSLESS_LIBRARY_PATH="$HOME/dev/ec2l/lib"
+    export PRYSLESS_REQUIRE="e=ec2l/Ec2l/Client.new:a=pry/[]"
+
+PRYSLESS\_REQUIRE tells prysless what objects to preload and how to name them.
+
+So, for example:
+
+    e=ec2l/Ec2l/Client.new
+
+Will load into the variable named e Ec2l::Client.new after requiring 'ec2l'.
+
+Because I use the development version of ec2l and not the gem directly,
+I added my ec2l development library directory to PRYSLESS\_LIBRARY\_PATH.
+
+Also, I like to add an alias to prysless\_store command:
+
+    alias p=prysless_store
+
+## Using
+
+Just run
+    
+    prysless
+
+Once in pry shell, you'll be able to access the variables you defined:
+
+```ruby
+[1] pry(<Prysless::Shell>)> e
+=> <Ec2l::Client:0x000000022f5e70
+...
+[2] pry(<Prysless::Shell>)> cd e
+
+[4] pry(<Ec2l::Client>):1> show-doc ins
+```
+
+Lets say you need to share data between your session and an external program:
+
+```ruby
+[8] pry(#<Prysless::Shell>)> s.blah = 'test'
+=> "test"
+```
+
+Now on your shell, provided 'p' is an alias to prysless\_store:
 
-TODO: Write usage instructions here
+    $ echo I need to $(p blah) some more
+    I need to test some more
 
 ## Contributing
 

data/bin/prysless_store

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'prysless'
+store = Prysless::Store.new
+if ARGV.size > 1
+    store[ARGV[0]] = ARGV[1]
+else
+    puts store[ARGV[0]]
+end

data/lib/prysless.rb

@@ -1,14 +1,84 @@
 require "prysless/version"
 require 'pry'
+require 'pstore'
+require 'fileutils'
 # Public: Utilities to make ruby object accessible via pry
 #
 # Examples
 #
 #   Prysless::Shell.new
 module Prysless
+    # Public: Pry store allowing to pass and persist data between sessions
+    #   Data can be accessed either via hash notation or metheod notation
+    #   This is a core functionality of prysless since we want to be able
+    #   to share states with other processes (namely: the shell) without
+    #   copy/paste.
+    #
+    # Examples
+    #
+    #   Store.new['lol'] = 'test'
+    #   Store.new['lol]
+    #       => 'test'
+    #   Store.new.lil = 'blah'
+    #   Store.new.lil
+    #       => 'blah'
+    class Store
+        def initialize
+            configuration_directory = "#{ENV['HOME']}/.config"
+            FileUtils.mkdir_p configuration_directory
+            @store = PStore.new("#{configuration_directory}/prysless.pstore")
+        end
+        # Public: saves data to the store
+        #
+        # key   - the name of the key to store
+        # value - the value associated with the key
+        #
+        # Examples
+        #
+        #   []= 'lol', 'test'
+        #       => 'test'
+        #  
+        # Returns the data that was saved
+        def []= key, value
+            @store.transaction { @store[key] = value }
+        end
+        # Public: reads data from the store
+        #
+        # key - the value of the key to retrieve
+        #
+        # Examples
+        #
+        #   []= 'lol'
+        #       => 'test'
+        #  
+        # Returns the data to read
+        def [] key
+            @store.transaction { @store[key] }
+        end
+private
+# Internal: either writes or read data to/from the store
+#
+# Examples
+#
+#   method_missing :blah=, ['test'] # writes data
+#       => 'test'
+#   method_missing :blah # reads data
+#       => 'test'
+#  
+# Return the data that was saved or read
+def method_missing method, *params, &block
+    method = method.to_s
+    if method[-1..-1] == '='
+        self[method[0..-2]] = params[0]
+    else
+        self[method]
+    end
+end
+    end
     # Public: Pry shell allowing to use user defined objects, based on two variables:
     #   * PRYSLESS_LIBRARY_PATH: path to load additional libraries, ":"-separated
     #   * PRYSLESS_REQUIRE: variable definitions
+    #   * PRYSLESS_ALIASES: shell command aliases
     #
     # Examples
     #
@@ -21,22 +91,25 @@ module Prysless
             load_objects
             shell
         end
-private
+        private
         def shell() binding.pry end
         def var name
-            value = ENV[name]
+            value = ENV["PRYSLESS_#{name}"]
             value = if value == nil then [] else value.split(":") end
             value.each { |p| yield p }
         end
         def load_objects
             @a = {}
-            var('PRYSLESS_LIBRARY_PATH') { |p| $LOAD_PATH << p }
-            var('PRYSLESS_REQUIRE') do |p|
+            @aliases = {}
+            var('ALIASES') { |a| k, v = a.split('=', 2); @aliases[k] = v }
+            var('LIBRARY_PATH') { |p| $LOAD_PATH << p }
+            var('REQUIRE') do |p|
                 name , value = p.split("=", 2)
                 gem, object = value.split("/", 2)
                 require gem
                 @a[name] = eval(object.gsub("/", "::"))
             end
+            @a['s'] = Store.new
         end
         # Internal: try and find user defined variable named with the method
         #   if its result is nil, super
@@ -52,10 +125,11 @@ private
         #    
         # Return the declared variable from PRYSLESS_REQUIRE or calls super
         def method_missing method, *params, &block
-            if @a[method.to_s]
-                @a[method.to_s]
+            meth = method.to_s
+            if @a[meth] then @a[meth]
             else
-                super
+                meth = @aliases[meth] if @aliases[meth]
+                `#{([meth] + params).join " "}`.split("\n")
             end
         end
     end

data/lib/prysless/version.rb

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

data/test/test_prysless.rb

@@ -16,7 +16,17 @@ class PryslessTest < Test::Unit::TestCase
         rescue Exception => e
             x = e
         end
-        assert_not_nil e
+    end
+    def test_store
+        Dir.mktmpdir do |dir|
+            ENV['HOME'] = dir
+            s = Prysless::Store.new
+            s['lol'] = 'lil'
+            assert s['lol'] == 'lil'
+            s.test = 'blah'
+            assert s.test == 'blah'
+            assert s.test == s['test']
+        end
     end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prysless
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-20 00:00:00.000000000 Z
+date: 2014-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ email:
 - yazgoo@github.com
 executables:
 - prysless
+- prysless_store
 extensions: []
 extra_rdoc_files: []
 files:
@@ -74,6 +75,7 @@ files:
 - README.md
 - Rakefile
 - bin/prysless
+- bin/prysless_store
 - lib/prysless.rb
 - lib/prysless/version.rb
 - prysless.gemspec
@@ -93,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4030277097249573203
+      hash: -2956483254067792842
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -102,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4030277097249573203
+      hash: -2956483254067792842
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23