the_dude 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+script: 'bundle exec rspec'
+rvm:
+  - 1.9.3
+gemfile:
+  - Gemfile
+notifications:
+  recipients:
+    - adam@29ways.co.uk

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    the_dude (0.0.3)
+    the_dude (0.0.4)
       colored
       hirb
       nokogiri

data/README.md

@@ -1,6 +1,7 @@
 # The Dude
 
 [![Code Climate](https://codeclimate.com/github/adamphillips/the_dude.png)](https://codeclimate.com/github/adamphillips/the\_dude)
+[![Build Status](https://travis-ci.org/adamphillips/the_dude.png?branch=master)](https://travis-ci.org/adamphillips/the\_dude)
 
 The Dude is here to make your terminal life more chilled.
 
@@ -9,9 +10,11 @@ Alternatively, The Dude already knows how to do a bunch of stuff for you.
 
 For example:
 
-    $ dude fetch google.co.uk # opens a google.co.uk in lynx
-    $ dude show me pictures of cool stuff # opens a browser with a google images search for 'cool stuff'
-    $ dude wassup # starts top
+```shell
+$ dude fetch google.co.uk # opens a google.co.uk in lynx
+$ dude show me pictures of cool stuff # opens a browser with a google images search for 'cool stuff'
+$ dude wassup # starts top
+```
 
 How can this be useful?
 - a single dude command can trigger a bunch of other commands.  Sure you
@@ -19,22 +22,39 @@ How can this be useful?
   you're happy writing shell scripts.
 - for the command-line phobic, dude provides a friendly interface to the
   command line.
-- for those who are at on the command line, there can still be a benefit
+- for those who are at home on the command line, there can still be a benefit
   in reducing the cognitive overhead required to run scripts.
-- Commands can be bundled and shared using gems meaning that command line savvy
+- commands can be bundled and shared using gems meaning that command line savvy
   devs can set up simpler commands for other team members to use.
 
 ## Talking to The Dude
 
-The Dude is still very young and not on rubygems quite yet. For the mean
-time, you will need to checkout the repo and build the gem.
+You can install TheDude using
+
+```shell
+$ gem install the_dude
+```
 
 The Dude comes with a 'dude' binary so you can use this to run commands
 
-    dude why? # will output 'because'
+```shell
+$ dude why? # will output 'because'
+```
 
-Alternatively, you can start the dude inteactively with
+Alternatively, you can start the dude interactively with
 
-    dude -i
+```shell
+$ dude -i
+```
 
 Then you get a dude prompt you can enter commands straight into.
+
+## Installing plugins
+
+You can install plugins for TheDude that contain additional commands or add additional functionality. Plugins are bundled as gems. For example to install the trello plugin simply use
+
+```shell
+$ gem install the_dude-trello
+```
+
+You will now be able to use the commands defined in the Trello plugin.

data/bin/dude

@@ -1,10 +1,7 @@
 #!/usr/bin/env ruby
 require 'the_dude'
 
-#include TheDude::Dsl
-
 DUDERC_PATH = "#{ENV['HOME']}/.duderc"
-#load DUDERC_PATH if File.exists? DUDERC_PATH
 TheDude::Dsl.from_file DUDERC_PATH
 
 # Setup rlwrap for readline support

data/lib/the_dude/dsl.rb

@@ -15,13 +15,32 @@ module TheDude
       TheDude.say *args
     end
 
+    # Creates and registers a new variable
+    def var *args
+      TheDude::Variable.new(*args).register
+    end
+
     # Class methods
     class << self
+      # Runs the specified code inside an instance of the DSL. Code can be
+      # passed as a string or block. If both are given, the string is
+      # ignored.
+      #
+      # @param [String] text Code to run
+      # @param [Block]  code Code to run
+      def run text=nil, &code
+        if block_given?
+          new.instance_exec &code
+        else
+          new.instance_eval text
+        end
+      end
+
       # Reads in a file and processes it using The Dude Dsl
       #
       # @param [String] path Path to the file to read
       def from_file path
-        new.instance_eval File.read(path) if File.exists? path
+        run File.read(path) if File.exists? path
       end
     end
   end

data/lib/the_dude/expression.rb

@@ -25,8 +25,8 @@ module TheDude
       return @regexp unless @regexp.nil?
 
       # If we have a string, escape it turn it into a regex and send it back
-      @regexp = /^#{Regexp.quote @expression}$/ and return @regexp if @expression.kind_of? String
-      @regexp = @expression
+      @regexp = /^#{Regexp.quote @expression}$/ if @expression.kind_of? String
+      @regexp ||= @expression
 
       substitute_all_variables
       check_for_undefined_variables
@@ -55,7 +55,7 @@ module TheDude
     # [Regexp] Substitues the specified variable for its pattern and converts
     # the result back to a regex
     def substitute_variable var
-      subbed = @regexp.source.gsub(/\:#{var.name}(\s|$)/, "(#{var.pattern.source}) ")
+      subbed = @regexp.source.gsub(/\:#{var.name}(\s*)/, "(#{var.pattern.source})\\1")
       subbed.strip! if subbed
       Regexp.new subbed
     end

data/lib/the_dude/setup.rb

@@ -19,5 +19,29 @@ TheDude::Command.new /^show me pictures of (.*)/, ->(query){ `open "https://www.
 TheDude::Command.new /source for :url/, ->(url){ `curl #{url} | highlight --syntax html -O xterm256`  }
 TheDude::Command.new /headers for :url/, ->(url){ `curl -I #{url}`  }
 
+TheDude::Command.new 'list vars' do
+  extend Hirb::Console
+  say 'Defined variables'
+  say table(TheDude.variables.map {|k, v| {var: v.name, regex: v.pattern}})
+end
+
+TheDude::Command.new 'list commands' do
+  extend Hirb::Console
+  say 'Defined commands'
+  say table(TheDude.commands.map {|k, v| {expr: v.expression.expression, regex: v.expression.to_regexp}})
+end
+
+TheDude::Command.new 'list plugins' do
+  extend Hirb::Console
+  say 'Loaded plugins'
+  say table(TheDude::Plugin.all.map {|v| {name: v.name, gem_name: v.gem_name}})
+end
+
+TheDude::Command.new 'what you got' do
+  ask 'list vars'
+  ask 'list commands'
+  ask 'list plugins'
+end
+
 # Load plugins
 TheDude::Plugin.all.each {|r| require r.gem_name}

data/lib/the_dude/version.rb

@@ -1,3 +1,3 @@
 module TheDude
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/the_dude/command_spec.rb

@@ -53,7 +53,18 @@ describe TheDude::Command do
       end
     end
 
-    context 'when passed an expression question containing a defined variable' do
+    context 'when passed an string question containing a defined variable' do
+      before :each do
+        TheDude::Variable.new(:server, /\S+/).register
+        @command = TheDude::Command.new 'connect to :server', ->(server) {'connecting to #{server}'}
+      end
+
+      it 'should convert the expression to a normal regex adding start and end flags' do
+        @command.expression.to_regexp.should == /^connect\ to\ (\S+)$/
+      end
+    end
+
+    context 'when passed a regex question containing a defined variable' do
       before :each do
         TheDude::Variable.new(:server, /\S+/).register
         @command = TheDude::Command.new /connect to :server/, ->(server) {'connecting to #{server}'}

data/spec/the_dude/dsl_spec.rb

@@ -1,18 +1,14 @@
 require 'spec_helper'
 
 describe TheDude::Dsl do
-  class Anony
-    include TheDude::Dsl
-  end
-
   describe '#ask' do
     context 'when asked' do
       context 'and the command exists' do
         before :each do
-          Anony.new.command 'hey', 'what'
+          TheDude::Dsl.new.command 'hey', 'what'
         end
         it 'should perform the requested command' do
-          Anony.new.ask('hey').should == 'what'
+          TheDude::Dsl.new.ask('hey').should == 'what'
         end
       end
     end
@@ -26,7 +22,7 @@ describe TheDude::Dsl do
 
       context 'and a string answer' do
         it 'should register a new dude command' do
-          Anony.new.command @question, 'what'
+          TheDude::Dsl.new.command @question, 'what'
           TheDude.commands.length.should == 1
           TheDude.commands[/^hey$/].ask.should == 'what'
         end
@@ -34,7 +30,7 @@ describe TheDude::Dsl do
 
       context 'and a proc answer' do
         it 'should register a new dude command' do
-          Anony.new.command @question, ->{'what'}
+          TheDude::Dsl.new.command @question, ->{'what'}
           TheDude.commands.length.should == 1
           TheDude.commands[/^hey$/].ask.should == 'what'
         end
@@ -42,7 +38,7 @@ describe TheDude::Dsl do
 
       context 'and a block answer' do
         it 'should register a new dude command' do
-          Anony.new.command @question do
+          TheDude::Dsl.new.command @question do
             'what'
           end
           TheDude.commands.length.should == 1
@@ -51,4 +47,53 @@ describe TheDude::Dsl do
       end
     end
   end
+
+  describe '#var' do
+    context 'when passed a variable name and regex' do
+      it 'should register the variable with TheDude' do
+        TheDude::Dsl.new.var :something, /cool/
+        TheDude.variables.length.should == 1
+        TheDude.variables[:something].pattern.should == /cool/
+      end
+    end
+  end
+
+  describe '.run' do
+    context 'when passed a string' do
+      before :each do
+        TheDude::Dsl.run 'var :server, /\S+/'
+      end
+
+      it 'should execute the string' do
+        TheDude.variables.length.should == 1
+        TheDude.variables[:server].should be_kind_of TheDude::Variable
+      end
+    end
+
+    context 'when passed a block' do
+      before :each do
+        TheDude::Dsl.run do
+          var :server, /\S+/
+        end
+      end
+
+      it 'should execute the block' do
+        TheDude.variables.length.should == 1
+        TheDude.variables[:server].should be_kind_of TheDude::Variable
+      end
+    end
+
+    context 'when passed a string and a block' do
+      before :each do
+        TheDude::Dsl.run do
+          var :server, /\S+/
+        end
+      end
+
+      it 'should execute the block' do
+        TheDude.variables.length.should == 1
+        TheDude.variables[:server].should be_kind_of TheDude::Variable
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_dude
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-16 00:00:00.000000000 Z
+date: 2013-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -149,6 +149,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -196,7 +197,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4224877102825340562
+      hash: 1990469814655058138
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -205,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4224877102825340562
+      hash: 1990469814655058138
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25