ripl-fresh 0.1.0

data/.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless defined?(::Gem)
+require File.dirname(__FILE__) + "/lib/ripl/fresh"
+ 
+Gem::Specification.new do |s|
+  s.name        = "ripl-fresh"
+  s.version     = Ripl::Fresh::VERSION
+  s.authors     = ["Jan Lelis"]
+  s.email       = "mail@janlelis.de"
+  s.homepage    = "http://github.com/janlelis/fresh"
+  s.summary     = "Fresh Ruby Enhanced SHell"
+  s.description = "Fresh Ruby Enhanced SHell automatically detects, if your current command should be Ruby or a system command."
+  s.required_rubygems_version = ">= 1.3.6"
+  s.executables = ['ripl-fresh', 'fresh']
+  s.add_dependency 'ripl', '>= 0.2.5'
+  s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c} **/deps.rip]) + %w{Rakefile .gemspec}
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
+  s.license = 'MIT'
+end

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+== 0.1.0
+* Initial release

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2010 Jan Lelis
+
+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.rdoc

@@ -0,0 +1,76 @@
+= Fresh Ruby Enhanced SHell
+
+We love Ruby. We love the command line. So... the shell needs to be rubyfied ;).
+
+== How does it work?
+
+Basically, fresh is a Ruby console like irb: Enter a Ruby expression and it gets evaluated. But not everything is interpreted as Ruby: The input is thrown against a regular expression to determine if it is meant to be a Ruby or a system command.
+
+May sound like voodoo, but works surprisingly well in practice ;).
+
+== Get fresh
+
+Install the gem with:
+
+  gem install ripl-fresh
+
+Start it with:
+
+  ripl fresh
+
+(or just <tt>fresh</tt>)
+
+== Usage & configuration options
+
+The main regexp to determine if the command should be interpreted as system command is similar to this one: <tt>/^[a-z_-]+\s+.*/i</tt> (match a single word followed by at least one space). It can be adjusted in <tt>Ripl.config[:fresh_system_regexp]</tt>.
+
+Of course, there are also exceptions that should still get interpreted as Ruby (e.g. <tt>def </tt>). These can be found and modified in the <tt>Ripl.config[:fresh_ruby_words]</tt> array.
+
+Single words get interpreted as Ruby by default. You can set your "single system words" in <tt>Ripl.config[:fresh_system_words]</tt> (e.g. <tt>ls</tt>).
+
+There is also a third kind of command mode (besides <tt>:ruby</tt> and <tt>:system</tt>): <tt>:mixed</tt>. They look and feel like system commands, but redirect to the Ruby method described by the first word. You can register them in <tt> Ripl.config[:fresh_mixed_words]</tt> (e.g. +cd+).
+
+Of course, there is a way to explicitly set your command mode: You can prefix your input with a space to force Ruby mode as well as you can prefix it with <tt>^</tt> to force system mode. The strings used for this can be customized in <tt>Ripl.config[:fresh_system_prefix]</tt> and <tt>Ripl.config[:fresh_ruby_prefix]</tt>.
+
+You need to take a look at <tt>get_input</tt> method in the source file to 100% understand the command mode detection way.
+
+=== Defaults
+
+  # prefixes
+  Ripl.config[:fresh_system_prefix] = %w[^]
+  Ripl.config[:fresh_ruby_prefix]   = [' ']
+  # single words
+  Ripl.config[:fresh_system_words]  = %w[top ls] 
+  Ripl.config[:fresh_ruby_words]    = %w[begin case class def for if module undef unless until while puts warn print p pp ap raise fail loop require load lambda proc system]
+  # catch mix words
+  Ripl.config[:fresh_mixed_words]   = %w[cd] 
+  # main regexp
+  Ripl.config[:fresh_system_regexp] = /^([a-z_-]+)\s+(?!(?:[=%*]|!=|\+=|-=|\/=))/i
+
+== Customization
+
+Besides customizing your fresh with the configuration options, you can further enhance it with Ruby plugins, because it's based on {ripl}[https://github.com/cldwalker/ripl]. Just install the <tt>ripl-plugin_name</tt> and add it to your <tt>.riplrc</tt> file:
+
+  require 'ripl/plugin_name'
+
+Currently, most {plugins}[http://github.com/cldwalker/ripl-color_error] {enable}[http://github.com/janlelis/ripl-color_result] {colors}[http://github.com/janlelis/ripl-color_streams] and {IRB}[http://github.com/janlelis/ripl-multi_line] -{like}[http://github.com/cldwalker/ripl-commands] {features}[http://github.com/cldwalker/ripl-irb].
+
+== TODO
+
+There are lots of things which can get better:
+
+* Improve auto-completion
+* More cool (and colorful?) <tt>:mixed</tt> Ruby commands
+* Improve interaction between system and ruby commands
+  * <tt>ripl-multi_line</tt> for system commands
+  * Result of system commands should be available for ruby, not only printed to stdout
+* Improve default configuration
+* Fresh ideas
+
+Feel free to fork in your improvements ;)
+
+== Copyright
+
+Copyright (c) 2010 Jan Lelis <http://code-needs-smileys.com> released under the MIT license.
+
+J-_-L

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake'
+require 'fileutils'
+
+def gemspec
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+end
+
+desc "Build the gem"
+task :gem=>:gemspec do
+  sh "gem build .gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end

data/bin/fresh

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+exec File.expand_path( 'ripl-fresh', File.dirname(__FILE__) )

data/bin/ripl-fresh

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'ripl'
+require 'ripl/fresh'
+Ripl.start

data/deps.rip

@@ -0,0 +1 @@
+ripl >=0.2.5

data/lib/bond/completions/ripl-fresh.rb

@@ -0,0 +1,17 @@
+# no advanced auto completion, yet
+# only do some file completion - because it's the most important completion ;)
+
+require 'readline'
+
+file_completion = proc{ |input|
+  ::Readline::FILENAME_COMPLETION_PROC.call(input) || []
+}
+
+complete :on => Ripl.config[:fresh_system_regexp],
+         :search=>false,
+          &file_completion
+
+# TODO fires only when space after ^
+complete :on => Ripl::Fresh.option_array_to_regexp( Ripl.config[:fresh_system_prefix] ),
+         :search=>false,
+          &file_completion

data/lib/ripl/fresh.rb

@@ -0,0 +1,156 @@
+require 'ripl'
+require 'fileutils'
+
+module Ripl
+  module Fresh
+    VERSION = '0.1.0'
+
+    class << self
+      # helper to parse options
+      def option_array_to_regexp(option)
+        case option
+        when Regexp # note: some options still _have_ to be arrays
+          option
+        when Array, Set
+          /^(#{
+            option.map{ |char|
+              Regexp.escape char.to_s
+            }*'|'
+          })/
+        else
+          option.to_s
+        end
+      end
+    end
+
+    module Shell
+      # setup Fresh
+      def before_loop
+        @command_mode = :ruby
+        super
+        # register bond completion
+        Ripl.config[:completion][:gems] ||= []
+        Ripl.config[:completion][:gems] << 'ripl-fresh'
+        # load :mixed commands
+        require File.dirname(__FILE__) + '/fresh/commands'
+      end
+
+      # determine @command_mode
+      def get_input
+        input = super
+
+        return input  if @buffer # ripl-multi_line
+
+        @command_mode = case input
+        # force system with a single ^
+        when Ripl::Fresh.option_array_to_regexp( Ripl.config[:fresh_system_prefix] )
+          input = input[$1.size..-1] # TODO refactor, too hacky?
+          :system
+        # force ruby with a space
+        when Ripl::Fresh.option_array_to_regexp( Ripl.config[:fresh_ruby_prefix] )
+          input = input[$1.size..-1]
+          :ruby
+        # single words
+        when /^\w+$/i
+          if Ripl.config[:fresh_ruby_words].include?($&)
+            :ruby
+          elsif Ripl.config[:fresh_mixed_words].include?($&)
+            :mixed
+          elsif Ripl.config[:fresh_system_words].include?($&)
+            :system
+          else
+            :ruby
+          end
+        # set of commands that call the ruby method but have command line style calling (args without "")
+        when Ripl::Fresh.option_array_to_regexp( Ripl.config[:fresh_mixed_words] )
+          :mixed
+        # here is the important magical regex for shell commands
+        when Ripl.config[:fresh_system_regexp]
+          if Ripl.config[:fresh_ruby_words].include? $1
+            :ruby
+          else
+            :system
+          end
+        # default is still ruby ;)
+        else
+          :ruby
+        end
+
+        input
+      end
+
+      # get result (depending on @command_mode)
+      def loop_eval(input)
+        if input == ''
+          @command_mode = :system and return
+        end
+
+        case @command_mode
+        when :system # execute command
+          ret = system input
+          case ret
+          when false
+            warn '[non-nil exit status]' # too verbose?
+          when nil
+            warn "[command error #{$?.exitstatus}]" # add message?
+          end
+          ret
+
+        when :mixed # call the ruby method, but with shell style arguments
+          m, *args = *input.split
+          super "#{m}(*#{args.to_s})"
+
+        else # good old :ruby
+          super
+        end
+      end
+
+
+      # system commands don't have output values and Ruby is displayed normally
+      def print_result(result)
+        if @error_raised ||
+             @command_mode == :system ||
+             @command_mode == :mixed && (!result || result == '')
+          # don't display anything
+        else
+          super # puts(format_result(result))
+        end
+      end
+
+      # catch ctrl+c
+      def loop_once(*args)
+        super
+      rescue Interrupt
+        @buffer = @error_raised = nil
+        puts '[C]'
+        retry
+      end
+    end
+  end
+end
+
+# hook in (and work around readline loading behaviour)
+Ripl.config[:readline] = false
+require 'ripl/readline'
+Ripl::Shell.send :include, Ripl::Fresh::Shell
+
+## fresh config ###
+
+# prefixes
+Ripl.config[:fresh_system_prefix]  = %w[^]
+Ripl.config[:fresh_ruby_prefix]    = [' ']
+# single words
+Ripl.config[:fresh_system_words]  = %w[top ls] 
+Ripl.config[:fresh_ruby_words]    = %w[begin case class def for if module undef unless until while puts warn print p pp ap raise fail loop require load lambda proc system]
+# catch mix words
+Ripl.config[:fresh_mixed_words]   = %w[cd] 
+# main regexp
+Ripl.config[:fresh_system_regexp]  = /^([a-z_-]+)\s+(?!(?:[=%*]|!=|\+=|-=|\/=))/i
+# configure directory prompt
+Ripl.config[:prompt] = proc{
+  path = FileUtils.pwd
+  path.gsub! /#{ File.expand_path('~') }/, '~'
+  path + '> '
+}
+
+# J-_-L

data/lib/ripl/fresh/commands.rb

@@ -0,0 +1,32 @@
+require 'ripl'
+require 'fileutils'
+
+module Ripl
+  module Fresh
+    module Commands
+=begin
+      def ls(path='.')
+        Dir[ File.join( path, '*' )].map{|res| res =~ /^#{path}\/?/; $' }
+      end
+      alias dir ls
+=end
+
+      def cd( path = File.expand_path('~') )
+        new_last_path = FileUtils.pwd
+        if path == '-'
+          if @last_path
+            path = @last_path
+          else
+            warn 'Sorry, there is no previous directory.'
+            return
+          end
+        end
+        FileUtils.cd path
+        @last_path = new_last_path
+        nil
+      end
+    end
+  end
+end
+
+Ripl::Commands.send :include, Ripl::Fresh::Commands if defined? Ripl::Commands

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: ripl-fresh
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ripl
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 5
+        version: 0.2.5
+  type: :runtime
+  version_requirements: *id001
+description: Fresh Ruby Enhanced SHell automatically detects, if your current command should be Ruby or a system command.
+email: mail@janlelis.de
+executables: 
+- ripl-fresh
+- fresh
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- lib/ripl/fresh/commands.rb
+- lib/ripl/fresh.rb
+- lib/ripl-fresh/bond_workaround.rb
+- lib/bond/completions/ripl-fresh.rb
+- bin/fresh
+- bin/ripl-fresh
+- README.rdoc
+- CHANGELOG.rdoc
+- deps.rip
+- Rakefile
+- .gemspec
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/janlelis/fresh
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Fresh Ruby Enhanced SHell
+test_files: []
+