ripl-shell_commands 0.1.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,2 @@
+doc/
+pkg/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "ripl-shell_commands Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,12 @@
+### 0.1.0 / 2012-12-02
+
+* Initial release
+  * Extracted from [ronin](https://github.com/ronin-ruby/ronin).
+  * Use `Ripl.shell.binding` instead of `Ripl.config[:binding]`, which is not
+    set when running the `ripl` executable.
+  * No longer use `singleton_class.method_defined?` (Ruby 1.9 only) in
+    {Ripl::ShellCommands#loop_eval}.
+  * No longer use `Shellwords.shelljoin` in {Ripl::ShellCommands.exec},
+    which was re-escaping all arguments.
+  * Added specs.
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Hal Brodigan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# ripl-shell_commands
+
+* [Homepage](https://github.com/postmodern/ripl-shell_commands#readme)
+* [Issues](https://github.com/postmodern/ripl-shell_commands/issues)
+* [Documentation](http://rubydoc.info/gems/ripl-shell_commands/frames)
+* [Email](mailto:postmodern.mod3 at gmail.com)
+
+## Description
+
+A [ripl] plugin that allows inline shell commands.
+
+## Features
+
+## Examples
+
+    >> require 'ripl/shell_commands'
+    => true
+    >> !date
+    Sat Dec  1 21:47:55 PST 2012
+    => true
+    >> !cd /etc/
+    => true
+    >> @path = '/etc/profile.d/'
+    => "/etc/profile.d/"
+    >> !ls #{@path}
+    bash_completion.sh  colorls.csh  less.sh                qt.sh
+    chgems.sh           colorls.sh   PackageKit.sh          vim.csh
+    chruby.sh           lang.csh     qt.csh                 vim.sh
+    colorgrep.csh       lang.sh      qt-graphicssystem.csh  which2.csh
+    colorgrep.sh        less.csh     qt-graphicssystem.sh   which2.sh
+    >> true
+
+## Requirements
+
+* [ripl] ~> 0.3
+
+## Install
+
+    $ gem install ripl-shell_commands
+
+## Copyright
+
+Copyright (c) 2012 Hal Brodigan
+
+See {file:LICENSE.txt} for details.
+
+[ripl]: https://github.com/cldwalker/ripl#readme

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'rubygems-tasks', '~> 0.2'
+  require 'rubygems/tasks'
+
+  Gem::Tasks.new
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install Gem::Tasks."
+end
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test    => :spec
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.8'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end
+task :doc => :yard

data/gemspec.yml

@@ -0,0 +1,16 @@
+name: ripl-shell_commands
+version: 0.1.0
+summary: Ripl plugin that allows inline shell commands
+description: A ripl plugin that allows inline shell commands in the Ripl Shell.
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: https://github.com/postmodern/ripl-shell_commands#readme
+
+dependencies:
+  ripl: ~> 0.3
+
+development_dependencies:
+  rspec: ~> 2.4
+  rubygems-tasks: ~> 0.2
+  yard: ~> 0.8

data/lib/ripl/completions/shell_commands.rb

@@ -0,0 +1,21 @@
+complete(:on => Ripl::ShellCommands::PATTERN) do |cmd|
+  name   = cmd[1..-1]
+  glob   = "#{name}*"
+  paths  = Set[]
+
+  # search through $PATH for similar program names
+  Ripl::ShellCommands::PATHS.each do |dir|
+    Dir.glob(File.join(dir,glob)) do |path|
+      if (File.file?(path) && File.executable?(path))
+        paths << "!#{File.basename(path)}"
+      end
+    end
+  end
+
+  # add the black-listed keywords last
+  Ripl::ShellCommands::BLACKLIST.each do |keyword|
+    paths << "!#{keyword}" if keyword.start_with?(name)
+  end
+
+  paths
+end

data/lib/ripl/shell_commands.rb

@@ -0,0 +1,159 @@
+require 'set'
+require 'shellwords'
+require 'ripl'
+
+module Ripl
+  #
+  # Allows for executing shell commands prefixed by a `!`.
+  #
+  module ShellCommands
+    # The directories of `$PATH`.
+    PATHS = ENV['PATH'].split(File::PATH_SEPARATOR)
+
+    # Names and statuses of executables.
+    EXECUTABLES = Hash.new do |hash,key|
+      hash[key] = executable?(key) || PATHS.any? do |dir|
+        executable?(File.join(dir,key))
+      end
+    end
+
+    # Builtin commands
+    BUILTIN = Set['cd', 'export']
+
+    # Blacklist of known commands that conflict with Ruby keywords.
+    BLACKLIST = Set[
+      '[', 'ap', 'begin', 'case', 'class', 'def', 'fail', 'false',
+      'for', 'if', 'lambda', 'load', 'loop', 'module', 'p', 'pp',
+      'print', 'proc', 'puts', 'raise', 'require', 'true', 'undef',
+      'unless', 'until', 'warn', 'while'
+    ]
+
+    # Regexp to recognize `!commands`.
+    PATTERN = /^![a-zA-Z][a-zA-Z0-9\._-]*/
+
+    #
+    # Dynamically execute shell commands, instead of Ruby.
+    #
+    # @param [String] input
+    #   The input from the console.
+    #
+    def loop_eval(input)
+      if (@buffer.nil? && input =~ PATTERN)
+        command = input[1..-1]
+        name, arguments = ShellCommands.parse(command)
+
+        unless BLACKLIST.include?(name)
+          if BUILTIN.include?(name)
+            arguments ||= []
+
+            return ShellCommands.send(name,*arguments)
+          elsif EXECUTABLES[name]
+            return ShellCommands.exec(name,*arguments)
+          end
+        end
+      end
+
+      super(input)
+    end
+
+    #
+    # Parses a Console command.
+    #
+    # @param [String] command
+    #   The Console command to parse.
+    #
+    # @return [String, Array<String>]
+    #   The command name and additional arguments.
+    #
+    def self.parse(command)
+      # evaluate embedded Ruby expressions
+      command = command.gsub(/\#\{[^\}]*\}/) do |expression|
+        eval(expression[2..-2],Ripl.shell.binding).to_s.dump
+      end
+
+      arguments = Shellwords.shellsplit(command)
+      name      = arguments.shift
+
+      return name, arguments
+    end
+
+    #
+    # Determines if an executable exists on the system.
+    #
+    # @param [String] path
+    #   The program path.
+    #
+    # @return [Boolean]
+    #   Specifies whether the executable exists.
+    #
+    def self.executable?(path)
+      File.file?(path) && File.executable?(path)
+    end
+
+    #
+    # Default command which executes a command in the shell.
+    #
+    # @param [Array<String>] arguments
+    #   The arguments of the command.
+    #
+    # @return [Boolean]
+    #   Specifies whether the command exited successfully.
+    #
+    def self.exec(*arguments)
+      system(arguments.join(' '))
+    end
+
+    #
+    # Equivalent of the `cd` command, using `Dir.chdir`.
+    #
+    # @param [Array<String>] arguments
+    #   The arguments of the command.
+    #
+    # @return [Boolean]
+    #   Specifies whether the directory change was successful.
+    #
+    def self.cd(*arguments)
+      old_pwd = Dir.pwd
+
+      new_cwd = if arguments.empty?
+                  unless ENV['HOME']
+                    warn "cd: HOME not set"
+                    return false
+                  end
+
+                  ENV['HOME']
+                elsif arguments.first == '-'
+                  unless ENV['OLDPWD']
+                    warn 'cd: OLDPWD not set'
+                    return false
+                  end
+
+                  ENV['OLDPWD']
+                else
+                  arguments.first
+                end
+
+      Dir.chdir(new_cwd)
+      ENV['OLDPWD'] = old_pwd
+      return true
+    end
+
+    #
+    # Equivalent of the `export` or `set` commands.
+    #
+    # @param [Array<String>] arguments
+    #   The arguments of the command.
+    #
+    # @return [true]
+    #
+    def self.export(*arguments)
+      arguments.each do |pair|
+        name, value = pair.split('=',2)
+
+        ENV[name] = value
+      end
+    end
+  end
+end
+
+Ripl::Shell.send :include, Ripl::ShellCommands

data/ripl-shell_commands.gemspec

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'ripl/shell_commands/version'
+                  Ripl::ShellCommands::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/spec/shell_commands_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+require 'ripl/shell_commands'
+
+describe Ripl::ShellCommands do
+  describe "PATHS" do
+    subject { described_class::PATHS }
+
+    it "should parse ENV['PATH']" do
+      subject.join(File::PATH_SEPARATOR).should == ENV['PATH']
+    end
+  end
+
+  describe "EXECUTABLES" do
+    subject { described_class::EXECUTABLES }
+
+    it "should determine if an executable exists in PATHS" do
+      subject['dir'].should be_true
+    end
+
+    it "should ignore non-executable files" do
+      subject['brltty-config'].should be_false
+    end
+
+    it "should ignore aliases" do
+      subject['cd'].should be_false
+    end
+  end
+
+  describe "PATTERN" do
+    subject { described_class::PATTERN }
+
+    it "should match !commands" do
+      subject.should =~ "!ls"
+    end
+
+    it "should not match leading whitespace" do
+      subject.should_not =~ "  !ls"
+    end
+
+    it "should not match commands beginning with decimals" do
+      subject.should_not =~ "!10"
+    end
+
+    it "should not match commands beginning with punctuation" do
+      subject.should_not =~ "!["
+    end
+  end
+
+  describe "parse" do
+    it "should commands into the command name and additional arguments" do
+      subject.parse("echo foo").should == ['echo', ['foo']]
+    end
+
+    it "should respect single quoted Strings" do
+      subject.parse("echo 'foo bar'").should == ['echo', ['foo bar']]
+    end
+
+    it "should respect double quoted Strings" do
+      subject.parse("echo \"foo bar\"").should == ['echo', ['foo bar']]
+    end
+
+    it "should respect escaped characters" do
+      subject.parse("echo foo\\ bar").should == ['echo', ['foo bar']]
+    end
+
+    context "when \#{ } is present" do
+      let(:variable) { 'x'  }
+      let(:value)    { '42' }
+      before(:all) do
+        eval("#{variable} = #{value}",Ripl.shell.binding)
+      end
+
+      it "should evaluate each embedded expression in the Ripl shell" do
+        subject.parse("echo \#{x}").should == ['echo', [value]]
+      end
+    end
+  end
+
+  describe "executable?" do
+    let(:path) { `which dir`.chomp }
+
+    it "should not be true for regular files" do
+      subject.executable?('README.md').should be_false
+    end
+
+    it "should not be true for directories" do
+      subject.executable?('.').should be_false
+    end
+
+    it "should be true for executables" do
+      subject.executable?(path).should be_true
+    end
+  end
+
+  describe "exec" do
+    it "should execute commands" do
+      subject.exec('true').should be_true
+    end
+
+    it "should allow redirecting output" do
+      subject.exec('echo foo >/dev/null').should be_true
+    end
+
+    it "should return the exit status" do
+      subject.exec('false').should be_false
+    end
+  end
+
+  describe "cd" do
+    let(:old)    { Dir.pwd }
+    let(:dir)    { ENV['HOME'] }
+
+    before(:all) { subject.cd(dir) }
+    after(:all)  { Dir.chdir(old)  }
+
+    it "should change the current working directory" do
+      Dir.pwd.should == dir
+    end
+
+    it "should update ENV['OLDPWD']" do
+      ENV['OLDPWD'].should_not == old
+    end
+
+    context "when given no arguments" do
+      before(:all) { subject.cd }
+
+      it "should switch back to the current working directory" do
+        Dir.pwd.should == ENV['HOME']
+      end
+    end
+
+    context "when given -" do
+      before(:all) { subject.cd('-') }
+
+      it "should switch back to the current working directory" do
+        Dir.pwd.should == old
+      end
+    end
+  end
+
+  describe "export" do
+    context "when given NAME=VALUE pairs" do
+      let(:name)  { 'FOO' }
+      let(:value) { '1' }
+
+      before(:all) { subject.export("#{name}=#{value}") }
+
+      it "should set ENV[NAME] to VALUE" do
+        ENV[name].should == value
+      end
+    end
+
+    context "when given NAME= pairs" do
+      let(:name)  { 'BAR' }
+
+      before(:all) { subject.export("#{name}=") }
+
+      it "should set ENV[NAME] to ''" do
+        ENV[name].should == ''
+      end
+    end
+  end
+
+  describe "#loop_eval" do
+    subject { Ripl.shell }
+
+    it "should eval normal Ruby input" do
+      subject.eval_input('1 + 1').should == 2
+    end
+
+    it "should execut !commands" do
+      subject.eval_input('!dir >/dev/null').should be_true
+    end
+
+    it "should not execute blacklisted !commands" do
+      subject.eval_input('!true').should be_false
+    end
+
+    it "should not execut !commands within multi-line input" do
+      lines = [
+        '1 + 1',
+        '!true',
+        '2 + 2'
+      ]
+
+      subject.eval_input(lines.join($/)).should == 4
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+gem 'rspec', '~> 2.4'
+require 'rspec'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: ripl-shell_commands
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ripl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: A ripl plugin that allows inline shell commands in the Ripl Shell.
+email: postmodern.mod3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .gitignore
+- .rspec
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/ripl/completions/shell_commands.rb
+- lib/ripl/shell_commands.rb
+- ripl-shell_commands.gemspec
+- spec/shell_commands_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/postmodern/ripl-shell_commands#readme
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ripl plugin that allows inline shell commands
+test_files: []