yarr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5657e3c5f0e9c629f627e6c37f10e6e0ff334ccc
+  data.tar.gz: 887dd52989ca44d9f747f1548324e85e08b16c3e
+SHA512:
+  metadata.gz: 34d485e0a8bc83d9b36aba6d9f536baf611c28bc354ca515bc8ef7e2f37e174aa939383ca57e984fb30ce88383278784f44352186e9e75cbf0e7f119cbe6b43b
+  data.tar.gz: fac01dd98db4aafa1891aff063490e9a13e21a0a5c6175582538bc5fe001b8a62a4bf62e580d9f580228b18786a8cf83a4916546c9415f3b8ea6e0f6adc44b77

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Arturo Herrero, http://arturoherrero.com/
+
+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,185 @@
+# YARR
+
+[![Code Climate](https://codeclimate.com/github/arturoherrero/yarr/badges/gpa.svg)](https://codeclimate.com/github/arturoherrero/yarr)
+[![Build Status](https://travis-ci.org/arturoherrero/yarr.svg)](https://travis-ci.org/arturoherrero/yarr)
+
+**YARR (Yet Another Ruby REPL)** is a Ruby REPL (just a hobby, won't be big and
+professional like [Pry][1]). YARR was inspired by groovysh, IRB, Pry, Bash and Vim.
+
+## Installation
+
+Install the gem:
+
+```
+$ gem install yarr
+```
+
+## Features
+
+An interactive shell for evaluating Ruby code from the command-line. YARR is a
+command-line application which allows easy access to evaluate Ruby expressions,
+define classes and run simple experiments. It also features command history.
+
+![yarr](yarr.png)
+
+### Evaluating Expressions
+
+#### Simple Expressions
+
+```
+ruby:001> puts "Hello"
+Hello
+===> nil
+ruby:002> [1,2,3].max
+===> 3
+```
+
+#### Multi-line Expressions
+
+Multi-line/complex expressions (like closure or class definitions) may be
+defined over several lines. When the shell detects that it has a complete
+expression it will evaluate it.
+
+```
+ruby:001> class Foo
+ruby:001*   def bar
+ruby:001*     lambda do
+ruby:001*       1
+ruby:001*     end
+ruby:001*   end
+ruby:001* end
+===> :bar
+ruby:002> Foo.new.bar.call
+===> 1
+```
+
+#### Variables
+
+Set a shell variable for later use.
+
+```
+ruby:001> foo = "bar"
+===> bar
+```
+
+#### Functions
+
+Functions can be defined in the shell, and will be saved for later use.
+
+Defining a function is easy:
+
+```
+ruby:001> def hello(name)
+ruby:001*   puts "Hello #{name}"
+ruby:001* end
+===> :hello
+```
+
+And then using it is as one might expect:
+
+```
+ruby:002> hello("Arturo")
+Hello Arturo
+===> nil
+```
+
+Variables and functions share the same namespace, be careful:
+
+```
+ruby:001> foo = 10
+===> 10
+ruby:002> def foo
+ruby:002*   5
+ruby:002* end
+===> :foo
+ruby:003> foo
+===> 10
+```
+
+### Commands
+
+The shell has a number of different commands, which provide access to the shell’s
+environment.
+
+#### `:exit` or `:quit`
+
+Exit the shell.
+
+This is the **only** way to exit the shell. No `Ctrl-c`, sorry.
+
+```
+ruby:001> :exit
+```
+
+#### `:help`
+
+Display the list of commands (and aliases).
+
+```
+ruby:001> :help
+
+Available commands:
+  :exit    Exit the shell
+  :help    Display this help message
+  :hist    Display edit-line history
+  :quit    Alias to :exit
+  :number  Execute a specific expression from history
+  :! cmd   Execute a shell command à la Vim
+
+```
+
+#### `:hist`
+
+Display the shell history.
+
+```
+ruby:001> def foo
+ruby:001*   "bar"
+ruby:001* end
+===> :foo
+ruby:002> var = 10
+===> 10
+ruby:003> :! echo "Yay"
+Yay
+ruby:004> :hist
+  001  def foo
+         "bar"
+       end
+  002  var = 10
+  003  :! echo "Yay"
+  004  :hist
+```
+
+#### `:number`
+
+Execute a specific expression from history, e.g. `:1` or `:001`.
+
+```
+ruby:001> var = 10
+===> 10
+ruby:002> var = 5
+===> 5
+ruby:003> var = 8
+===> 8
+ruby:004> :2
+===> 5
+```
+
+#### `:! cmd`
+
+Execute a shell command à la Vim.
+
+```
+ruby:001> :! cal
+   February 2015
+Su Mo Tu We Th Fr Sa
+ 1  2  3  4  5  6  7
+ 8  9 10 11 12 13 14
+15 16 17 18 19 20 21
+22 23 24 25 26 27 28
+
+
+```
+
+
+[1]: http://pryrepl.org/

data/bin/yarr

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path("../../lib/yarr", __FILE__)
+
+YARR.new.call

data/lib/formatter.rb

@@ -0,0 +1,9 @@
+module Formatter
+  def bold(text)
+    "\033[1m#{text}\e[0m"
+  end
+
+  def red(text)
+    "\e[1;31m#{text}\e[0m"
+  end
+end

data/lib/interpreter.rb

@@ -0,0 +1,111 @@
+require "readline"
+require "stringio"
+require_relative "formatter"
+
+class Interpreter
+  include Formatter
+
+  def initialize
+    Readline.completion_append_character = nil
+    Readline.completion_proc = lambda do |input|
+      commands.grep(/^#{Regexp.escape(input)}/)
+    end
+  end
+
+  def call
+    separator = ">"
+    expression = ""
+    begin
+      expression += Readline.readline(prompt(separator), false)
+      Readline::HISTORY << expression
+      capture_stdout { eval(expression, TOPLEVEL_BINDING) }
+    rescue SyntaxError => e
+      if e.message =~ /syntax error, unexpected end-of-input/
+        Readline::HISTORY.pop
+        expression += "\n       "
+        separator = "*"
+        retry
+      end
+    rescue Exception => e
+    end
+    process(expression)
+  end
+
+  private
+
+  def prompt(separator)
+    "#{bold("ruby")}:#{"%03d" % (Readline::HISTORY.size + 1)}#{bold(separator)} "
+  end
+
+  def process(expression)
+    if expression.chr == ":"
+      command(expression)
+    else
+      evaluate(expression)
+    end
+  end
+
+  def command(expression)
+    command, arguments = expression.split(" ", 2)
+    self.send(command[1..-1], arguments)
+  rescue
+    "#{red("ERROR")} #{command} command is not available"
+  end
+
+  def exit(args)
+    exit!
+  end
+  alias_method :quit, :exit
+
+  def help(args)
+    <<-END.gsub(/^\s+\|/, '')
+    |
+    |Available commands:
+    |  #{bold(":exit")}    Exit the shell
+    |  #{bold(":help")}    Display this help message
+    |  #{bold(":hist")}    Display edit-line history
+    |  #{bold(":quit")}    Alias to #{bold(":exit")}
+    |  #{bold(":")}number  Execute a specific expression from history
+    |  #{bold(":!")} cmd   Execute a shell command à la Vim
+    |
+    END
+  end
+
+  def hist(args)
+    "".tap do |history|
+      Readline::HISTORY.to_a.each.with_index(1) do |command, index|
+        history << "  #{bold("%03d" % index)}  #{command}\n"
+      end
+    end
+  end
+
+  define_method("!") do |args|
+    `#{args}`
+  end
+
+  def method_missing(name, *args)
+    index = (name.to_s[1..-1].to_i - 1).tap { |index| raise StandardError if index == -1 }
+    expression = Readline::HISTORY[index]
+    Readline::HISTORY.pop
+    Readline::HISTORY << expression
+    process(expression)
+  end
+
+  def evaluate(expression)
+    "#{bold("===>")} #{eval(expression, TOPLEVEL_BINDING)}"
+  rescue Exception => e
+    "#{red("ERROR")} #{e.message}"
+  end
+
+  def commands
+    %w(:exit :help :hist :quit :!)
+  end
+
+  def capture_stdout(&block)
+    stdout = $stdout
+    $stdout = StringIO.new
+    block.call
+  ensure
+    $stdout = stdout
+  end
+end

data/lib/yarr.rb

@@ -0,0 +1,41 @@
+require "io/console"
+require_relative "formatter"
+require_relative "interpreter"
+
+class YARR
+  include Formatter
+
+  def initialize(args = {})
+    $stdout.sync = true
+    @interpreter = args.fetch(:interpreter) { Interpreter.new }
+  end
+
+  def call
+    banner
+    loop do
+      puts interpreter.call
+    end
+  end
+
+  private
+
+  attr_reader :interpreter
+
+  def banner
+    puts bold("YARR | Ruby #{RUBY_VERSION}")
+    puts "Type '#{bold(":help")}' for help."
+    puts bold("-" * IO.console.winsize.last)
+  end
+end
+
+class NilClass
+  def to_s
+    "nil"
+  end
+end
+
+class Symbol
+  def to_s
+    ":#{id2name}"
+  end
+end

data/spec/lib/interpreter_spec.rb

@@ -0,0 +1,114 @@
+require "interpreter"
+
+RSpec.describe Interpreter do
+  subject(:interpreter) { described_class.new }
+
+  it "executes simple expression" do
+    given("1")
+    expect(interpreter.call).to eq("\e[1m===>\e[0m 1")
+  end
+
+  it "executes one line expression" do
+    given("1 + 1")
+    expect(interpreter.call).to eq("\e[1m===>\e[0m 2")
+  end
+
+  it "executes multiline line declaration" do
+    result = RUBY_VERSION[0..2] >= "2.1" ? "foo" : ""
+    given("def foo", "1", "end")
+    expect(interpreter.call).to eq("\e[1m===>\e[0m #{result}")
+  end
+
+  it "executes multiline line declaration and invocation" do
+    setup("def foo", "1", "end")
+    given("foo")
+    expect(interpreter.call).to eq("\e[1m===>\e[0m 1")
+  end
+
+  describe ":hist" do
+    it "shows the history" do
+      setup("5")
+      setup("def foo", "1", "end")
+      setup("foo")
+      given(":hist")
+      expect(interpreter.call).to eq(<<-END.gsub(/^\s+\||$/, '')
+        |  \e[1m001\e[0m  5
+        |  \e[1m002\e[0m  def foo
+        |       1
+        |       end
+        |  \e[1m003\e[0m  foo
+        |  \e[1m004\e[0m  :hist
+        END
+      )
+    end
+  end
+
+  describe ":number" do
+    it "executes an expression from history" do
+      setup("var = 5")
+      setup("var = 0")
+      given(":001")
+      expect(interpreter.call).to eq("\e[1m===>\e[0m 5")
+    end
+
+    it "adds the command to the history" do
+      setup("var = 5")
+      setup("var = 0")
+      setup(":001")
+      given(":hist")
+      expect(interpreter.call).to eq(<<-END.gsub(/^\s+\||$/, '')
+        |  \e[1m001\e[0m  var = 5
+        |  \e[1m002\e[0m  var = 0
+        |  \e[1m003\e[0m  var = 5
+        |  \e[1m004\e[0m  :hist
+        END
+      )
+    end
+  end
+
+  describe ":! cmd" do
+    let(:output) { "-rw-r--r--  1 arturo  staff    39 16 Feb 21:11 spec.rb" }
+    before do
+      allow(interpreter).to receive(:'`').with("ls -l").and_return(output)
+    end
+
+    it "executes an external shell command" do
+      given(":! ls -l")
+      expect(interpreter.call).to eq(output)
+    end
+  end
+
+  context "invalid expression" do
+    it "returns a syntax error" do
+      given("1 + &")
+      expect(interpreter.call).to eq(<<-END.gsub(/^\s+\||\n$/, '')
+        |\e[1;31mERROR\e[0m <main>: syntax error, unexpected &
+        |1 + &
+        |     ^
+        END
+      )
+    end
+  end
+
+  context "invalid command" do
+    it "returns a command error" do
+      given(":invalid")
+      expect(interpreter.call).to eq("\e[1;31mERROR\e[0m :invalid command is not available")
+    end
+  end
+
+  private
+
+  def setup(*input)
+    given(*input)
+    interpreter.call
+  end
+
+  def given(*input)
+    allow(Readline).to receive(:readline).and_return(*input)
+  end
+
+  after(:each) do
+    Readline::HISTORY.clear
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: yarr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arturo Herrero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: YARR. Yet Another Ruby REPL. A Ruby REPL (just a hobby, won't be big
+  and professional like pry)
+email: arturo.herrero@gmail.com
+executables:
+- yarr
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/yarr
+- lib/formatter.rb
+- lib/interpreter.rb
+- lib/yarr.rb
+- spec/lib/interpreter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/arturoherrero/yarr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: YARR. Yet Another Ruby REPL
+test_files:
+- spec/lib/interpreter_spec.rb
+- spec/spec_helper.rb