sr 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 061f3869f4efe07024e5a09389787a7b587a27e2
-  data.tar.gz: 36eebe8d7ee9d6db3d6ac9201edc0e802cae62f6
+  metadata.gz: 840b10dde9c75efdffc21996c199a7bfb4dfd3c8
+  data.tar.gz: be910e535a257a2dc572c6709b59c2f5d85b0c3f
 SHA512:
-  metadata.gz: d2b46015eaecf94a3754b5c1a3c60aa64c54657bd552a73ec8f9e7cb13a270536141df2fc10e19e124b8d66fe299d51273b79ea91b79385e310f142b161b657d
-  data.tar.gz: aaa9b5446e9a5f352560f94a6217fb2c18b9d7d39e7f3d9d5ee8befcc6283f69f5411ce02fef041ffddaaec0f4b97b19b7b2363693ec8cbee2d32611ac613433
+  metadata.gz: 3533e3f363322ca51324c7a23239115c0fbf1f2b27711f3259730c20f0ba4b359895f3b4d16ec1324b7567c5b1cbe4136b8843d18b44c81def07fb6900c0232d
+  data.tar.gz: fadced5d39bd00241518406353a3d4930cdd876ee4fc183c8299cfb957ec5a841fa411410646299cefa46040176286f08b1b75c23a3caf540d0bdb09f38e3232

data/README.md

@@ -4,12 +4,29 @@
 
 ## Usage
 
-Simply call `sr` to use `sr` as a Ruby REPL like `irb` or `pry`:
+Simply call `sr` to use `sr` as a Ruby REPL:
 
 ```sh
 $ sr
 ```
 
+You may also set the default `sr` context to any valid object using the '-c' or
+'--context' option:
+
+```sh
+$ sr --context Array.new
+# -- OR --
+$ sr -cArray.new
+```
+
+Any arguments to be passed to Ruby itself may be given via the **$RUBYOPT**
+environment variable. Common options (such as '-I' for manipulating the load
+path or '-r' to require libraries) may be given in this manner:
+
+```sh
+$ RUBYOPT=-ryaml sr -cPsych
+```
+
 `sr` can also be used to include a REPL in your own code (for debugging
 purposes, for example) by requiring 'sr' and calling `SR.repl`:
 
@@ -56,7 +73,7 @@ arguments at any time to completely clear the context stack and reset the
 binding to the default (usually the top level binding).
 
 When given an argument, however, `SR.reset_binding` clears the context stack
-and resets the default binding to the _given object_.
+and resets the default binding to the given object.
 
 ## Configuration
 
@@ -66,6 +83,31 @@ be '/etc/xdg/sr/config.rb' for system-wide configuration and
 '~/.config/sr/config.rb' for user-specific configuration. These files are
 simply Ruby files which are loaded into `sr` via `require`.
 
+You may also tell `sr` to load alternative configuration files (or suppress all
+configuration) with the '-f' option. Given no arguments, this option suppresses
+all configuration loading; given a file, it removes the default configuration
+files and adds the given file to the list of configuration files to load. This
+option may be specified multiple times to load multiple alternative files.
+
+```sh
+$ sr -f        # start with no configuration
+$ sr -f alt.rb # start with alt.rb as configuration
+```
+
+In addition to this, `sr` simply uses `gets` as its default input method; if
+you would prefer to use Readline, simply add the following to your `sr`
+configuration file:
+
+```ruby
+require 'sr/input/readline'
+```
+
+Alternatively, to use Readline temporarily, simply use **$RUBYOPT**:
+
+```sh
+$ RUBYOPT=-rsr/input/readline sr
+```
+
 ## License
 
 `sr` is free and unencumbered software released into the public domain.

data/bin/sr

@@ -1,18 +1,37 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'optparse'
+
 $0.start_with?('/') ? require('sr') : require_relative('../lib/sr')
 
-if ARGV.size > 0
-  valid = %w(-h --help).any? { |a| ARGV.first == a }
-  (valid ? $stdout : $stderr).puts <<-END
-sr #{SR::VERSION}
+module SR
+  options = {}
+  parser = OptionParser.new do |opts|
+    opts.on('-c', '--context=obj', 'set the sr context to obj') do |obj|
+      options[:context] = eval(obj)
+    end
+    opts.on('-f [FILE]', 'suppress configuration (load FILE if given)') do |f|
+      options[:config_files] =
+        f ? (options[:config_files] ||= []).push(File.expand_path(f)) : []
+    end
+    opts.on('-v', '--version', 'display sr version') do
+      puts "sr #{SR::VERSION} [ruby #{RUBY_VERSION} #{RUBY_PLATFORM}]"
+      exit
+    end
+    opts.on('-h', '--help', 'display this message') do
+      puts opts
+      exit
+    end
+  end
 
-sr is a simple, tiny, hackable REPL for Ruby.
+  begin
+    parser.parse!
+  rescue OptionParser::InvalidOption => ex
+    $stderr.puts ex.message
+    $stderr.puts parser.help
+    exit 1
+  end
 
-usage: #{$0} [-h|--help]
-END
-  exit valid ? 0 : 1
+  ARGV.empty? ? repl(options) : ($stderr.puts parser.help ; exit 1)
 end
-
-SR.repl

data/lib/sr/input/readline.rb

@@ -0,0 +1,9 @@
+require 'readline'
+
+module SR
+  @input_handler = ->(more) do
+    input = "#{Readline.readline(call_prompt(more ? :more : :input), true)}\n"
+    input = "#{more}#{input}" if more
+    input
+  end
+end

data/lib/sr/version.rb

@@ -2,5 +2,5 @@
 
 module SR
   # Semantic version of `sr`.
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/sr.rb

@@ -1,6 +1,5 @@
 require_relative 'sr/core_patches'
 require_relative 'sr/version'
-require 'readline'
 require 'sxdg/as_xdg'
 
 # `sr` is a simple, tiny, hackable REPL for Ruby.
@@ -10,7 +9,10 @@ module SR
     attr_reader :context
 
     # @return [Hash{Class=>#call}] the hash of exception handlers
-    attr_reader :handlers
+    attr_reader :exception_handlers
+
+    # @return [#call] the input handler
+    attr_accessor :input_handler
 
     # @return [Hash{Symbol=>#call,#to_s}] the hash of prompts to display; valid
     #   keys are `:error`, `:input`, `:more`, and `:return`; valid values must
@@ -27,7 +29,7 @@ module SR
   # The regular expression used to determine whether or not a syntax error is
   # a valid continuation which should prompt for more user input.
   CONTINUATION_REGEXP =
-    /unterminated (?:regexp|string)|unexpected end-of-input|tIDENTIFIER/
+    /unterminated (?:regexp|string)|unexpected end-of-(?:file|input)|tIDENTIFIER/
 
   @prompt = {
     error:  proc { |e| "!! #{e.class}: #{e.message}" },
@@ -36,7 +38,14 @@ module SR
     return: proc { |v| "-> #{v.inspect}" },
   }
 
-  @handlers = {
+  @input_handler ||= ->(more) do
+    print(call_prompt(more ? :more : :input))
+    input = gets
+    input = "#{more}#{input}" if more
+    input
+  end
+
+  @exception_handlers = {
     SyntaxError => proc do |e, i|
       e.message =~ CONTINUATION_REGEXP ? read_eval_print(i) : report(e)
     end,
@@ -95,22 +104,15 @@ module SR
     $stderr.puts call_prompt(:error, ex) if @prompt[:error]
   end
 
-  # @return [Array<Boolean>] an array representing whether or not each
-  #   configuration file was loaded by `require`
-  private_class_method def self.load_configuration
-    CONFIGURATION_FILES.map(&method(:require))
-  end
-
   # @param more [String] the previous input to be evaluated along with the
   #   given input
   # @return [Object] the return value of the given input
   private_class_method def self.read_eval_print(more = nil)
-    input = "#{Readline.readline(call_prompt(more ? :more : :input), true)}\n"
-    input = "#{more}#{input}" if more
+    input = @input_handler.call(more)
     value = @context.eval("_ = #{input}")
     puts call_prompt(:return, value) if @prompt[:return]
-  rescue *@handlers.keys => ex
-    @handlers.find { |(c,_)| ex.is_a?(c) }[1].call(ex, input, more)
+  rescue *@exception_handlers.keys => ex
+    @exception_handlers.find { |(c,_)| ex.is_a?(c) }[1].call(ex, input, more)
   end
 
   # Loads the configuration for SR, resets the default binding to the given
@@ -118,9 +120,12 @@ module SR
   #
   # @param context [#__binding__] the object providing the default context for
   #   `sr`; defaults to the top level binding if no context given
+  # @param options [Hash] the options for the REPL; valid options are
+  #   `:config_files` (`Array<String>`) and `:context` (`#__binding__`)
   # @return [void]
-  def self.repl(context = nil)
-    load_configuration
+  def self.repl(context = nil, **options)
+    options.fetch(:config_files, CONFIGURATION_FILES).each(&method(:require))
+    context = context || options[:context]
     reset_binding(context) unless context.nil?
     @enabled = true
     read_eval_print while @enabled

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sr
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Robin Owen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-21 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sxdg
@@ -51,6 +51,7 @@ files:
 - bin/sr
 - lib/sr.rb
 - lib/sr/core_patches.rb
+- lib/sr/input/readline.rb
 - lib/sr/version.rb
 - sr.gemspec
 homepage: https://github.com/vthrenody/sr