rspec-interactive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9cc41d7480a29852c93f700e92b70314e0b6e8fc70f73089ca419eae750f32bc
+  data.tar.gz: b7b3357dbf44d8dc21beef28a684950f148eac98aa40b4de53e2eb7faa9eb2e9
+SHA512:
+  metadata.gz: f6413fa767a8c4dd85e6f63129d35b9b341a264ae82183696d5c160f63cada92fe96b17972913246bea85b9fb5217b19d0bfd72c4dc1a0a3152a38861cb011de
+  data.tar.gz: 9a42fc226690f04ea027d5cf42403164cbd0cd7f3dae80a9eec4383ef1d3c5f36d40e4f9291432366f449e0651b19b91d1b54c88b6b455cd906b73ae2bad2c08

data/.gitignore

@@ -0,0 +1 @@
+rspec-interactive-*.gem

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rspec-core'

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    rspec-console (0.1.0)
+      listen
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ffi (1.15.0)
+    listen (3.5.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  rspec-console!
+  rspec-core
+
+BUNDLED WITH
+   2.2.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+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/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "repo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec-interactive

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rspec-interactive.rb'
+
+RSpecInteractive::Console.new(ARGV).start()

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/repo.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "repo/version"
+
+module Repo
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/rspec-interactive.rb

@@ -0,0 +1,205 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require 'listen'
+require 'readline'
+require 'rspec/core'
+require 'shellwords'
+
+require_relative 'rspec-interactive/runner.rb'
+
+module RSpecInteractive
+  class Console
+
+    HISTORY_FILE = '.rspec_interactive_history'.freeze
+    CONFIG_FILE = '.rspec_interactive_config'.freeze
+    MAX_HISTORY_ITEMS = 100
+    COMMANDS = ['help', 'rspec']
+
+    def initialize(args)
+      if args.size > 1
+        STDERR.puts "expected 0 or 1 argument, got: #{args.join(', ')}"
+        exit!(1)
+      end
+
+      @stty_save = %x`stty -g`.chomp
+      @mutex = Mutex.new
+      @runner = nil
+      load_config(args[0])
+    end
+
+    def start()
+      start_file_watcher
+      load_history
+      configure_auto_complete
+      trap_interrupt
+      start_console
+    end
+
+    private
+
+    def load_config(name = nil)
+      @config = get_config(name)
+      load @config["init_script"]
+    end
+
+    def get_config(name = nil)
+      if !File.exists? CONFIG_FILE
+        STDERR.puts "file not found: #{CONFIG_FILE}"
+        exit!(1)
+      end
+
+      configs = JSON.parse(File.read(CONFIG_FILE))["configs"]
+      if configs.empty?
+        STDERR.puts "no configs found in: #{CONFIG_FILE}"
+        exit!(1)
+      end
+
+      # If a specific config was specified, use it.
+      if name
+        config = configs.find { |e| e["name"] == name }
+        return config if config
+        STDERR.puts "invalid config: #{name}"
+        exit!(1)
+      end
+
+      # If there is only one, use it.
+      if configs.size == 1
+        return configs[0]
+      end
+
+      # Ask the user which to use.
+      loop do
+        names = configs.map { |e| e["name"] }
+        names[0] = "#{names[0]} (default)"
+        print "Multiple simultaneous configs not yet supported. Please choose a config. #{names.join(', ')}: "
+        answer = STDIN.gets.chomp
+        if answer.strip.empty?
+          return configs[0]
+        end
+        config = configs.find { |e| e["name"] == answer }
+        return config if config
+        STDERR.puts "invalid config: #{answer}"
+      end
+    end
+
+    def trap_interrupt
+      trap('INT') do
+        @mutex.synchronize do
+          if @runner
+            @runner.quit
+          else
+            puts
+            system "stty", @stty_save
+            exit!(0)
+          end
+        end
+      end
+    end
+
+    def start_file_watcher
+      # Only polling seems to work in Docker.
+      listener = Listen.to(*@config["watch_dirs"], only: /\.rb$/, force_polling: true) do |modified, added, removed|
+        (added + modified).each { |filename| load filename } 
+      end
+    end
+
+    def load_history
+      if File.exists? HISTORY_FILE
+        lines = File.readlines(HISTORY_FILE)
+        lines.each do |line|
+          Readline::HISTORY << line.strip
+        end
+      end
+    end
+
+    def configure_auto_complete
+      Readline.completion_append_character = ""
+    end
+
+    def start_console
+      loop do
+        buffer = Readline.readline('> ', true)&.strip
+
+        # Exit on ctrl-D.
+        if !buffer
+          puts
+          system "stty", @stty_save
+          exit!(0)
+        end
+
+        # Ignore blank lines.
+        if buffer.empty?
+          Readline::HISTORY.pop
+          next
+        end
+
+        # Write history to file.
+        if Readline::HISTORY.size > 0
+          file = File.open(HISTORY_FILE, 'w')
+          lines = Readline::HISTORY.to_a
+          lines[-[MAX_HISTORY_ITEMS, lines.size].min..-1].each do |line|
+            file.write(line.strip + "\n")
+          end
+          file.close
+        end
+
+        # Handle quoting, etc.
+        args = Shellwords.shellsplit(buffer)
+        next if args.empty?
+
+        command = args[0].strip
+        if COMMANDS.include?(command)
+          send command.to_sym, args[1..-1]
+        else
+          STDERR.puts "command not found: #{args[0]}"
+        end
+      end
+    end
+
+    def help(args)
+      if !args.empty?
+        STDERR.puts "invalid argument(s): #{args}"
+        return
+      end
+
+      print "commands:\n\n"
+      print "help  - print this message\n"
+      print "rspec - execute the specified spec file(s), wildcards allowed\n"
+    end
+
+    def rspec(args)
+      if args.empty?
+        STDERR.puts "you must specify one or more spec files"
+        return
+      end
+
+      # Allow wildcards.
+      filenames = args.flat_map { |filename| Dir.glob(filename) }
+
+      # Store formatters, if any, set by the init script. They will be cleared by RSpec below.
+      formatters = RSpec.configuration.formatters || []
+
+      # Initialize the runner. Also accessed by the signal handler above.
+      # RSpecInteractive::Runner sets RSpec.world.wants_to_quit to false. The signal
+      # handler sets it to true. 
+      @mutex.synchronize { @runner = RSpecInteractive::Runner.new(filenames) }
+
+      # Run the specs.
+      @runner.run
+
+      # Clear the runner.
+      @mutex.synchronize { @runner = nil }
+
+      # Clear data from previous run.
+      RSpec.clear_examples
+
+      # Formatters get cleared by clear_examples. I don't understand why but the actual run
+      # also modifies the list of formatters. Reset them to whatever the init script set.
+      if !RSpec.configuration.formatters.empty?
+        raise "internal error. expected formatters to be cleared."
+      end
+      formatters.each { |f| RSpec.configuration.add_formatter(f) }
+    end
+  end
+end

data/lib/rspec-interactive/runner.rb

@@ -0,0 +1,46 @@
+require 'rspec/core'
+
+module RSpecInteractive
+  class Runner
+    def initialize(args)
+      RSpec.world.wants_to_quit = false
+      @options = RSpec::Core::ConfigurationOptions.new(args)
+    end
+
+    def run()
+      begin
+        @options.configure(RSpec.configuration)
+        return if RSpec.world.wants_to_quit
+
+        RSpec.configuration.load_spec_files
+      ensure
+        RSpec.world.announce_filters
+      end
+
+      return RSpec.configuration.reporter.exit_early(RSpec.configuration.failure_exit_code) if RSpec.world.wants_to_quit
+
+      example_groups = RSpec.world.ordered_example_groups
+      examples_count = RSpec.world.example_count(example_groups)
+
+      success = RSpec.configuration.reporter.report(examples_count) do |reporter|
+        RSpec.configuration.with_suite_hooks do
+          if examples_count == 0 && RSpec.configuration.fail_if_no_examples
+            return RSpec.configuration.failure_exit_code
+          end
+
+          result = example_groups.map do |example_group|
+            example_group.run(reporter)
+          end
+
+          result.all?
+        end
+      end
+
+      success && !RSpec.world.non_example_failure ? 0 : RSpec.configuration.failure_exit_code
+    end
+
+    def quit
+      RSpec.world.wants_to_quit = true
+    end
+  end
+end

data/lib/rspec-interactive/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RSpecInteractive
+  VERSION = "0.1.0"
+end

data/rspec-interactive.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/rspec-interactive/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-interactive"
+  spec.version       = RSpecInteractive::VERSION
+  spec.authors       = ["Nick Dower"]
+  spec.email         = ["nicholasdower@gmail.com"]
+
+  spec.summary       = "An interactive console for running specs."
+  spec.description   = "An interactive console for running specs."
+  spec.homepage      = "https://github.com/nicholasdower/rspec-interactive"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nicholasdower/rspec-interactive"
+  spec.metadata["changelog_uri"] = "https://github.com/nicholasdower/rspec-interactive"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   << 'rspec-interactive'
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "listen"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rspec-interactive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Dower
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An interactive console for running specs.
+email:
+- nicholasdower@gmail.com
+executables:
+- rspec-interactive
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Rakefile
+- bin/console
+- bin/rspec-interactive
+- bin/setup
+- lib/repo.rb
+- lib/rspec-interactive.rb
+- lib/rspec-interactive/runner.rb
+- lib/rspec-interactive/version.rb
+- rspec-console-0.1.0.gem
+- rspec-interactive.gemspec
+homepage: https://github.com/nicholasdower/rspec-interactive
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nicholasdower/rspec-interactive
+  source_code_uri: https://github.com/nicholasdower/rspec-interactive
+  changelog_uri: https://github.com/nicholasdower/rspec-interactive
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: An interactive console for running specs.
+test_files: []