shell_shock 0.0.4 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a473df32bae252fade36508e5e0f9d3c33d0ddf54ee9c29470458fbb6c04d0e2
+  data.tar.gz: 15050e03f392c29fd8a68c5e06e7f2c55a8338cf71471442a28c3c806df4a088
+SHA512:
+  metadata.gz: a417ea53a0345722e9d095b39632f2e12a5a96553a82e35bbf82aeb9a331d232ff27f16dc866aaa7dcf83e28b15c452bac1722a298c75aa5436122ff32b9c5fb
+  data.tar.gz: 2a827992f1aa325bb18b62f6cc95fc454072e10603b2dd6e53eb0b9662f2f92966f91185811f104a360b41847cd18cefe10f772c28f2360197c1a6e0fe46ecec

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.idea

data/.rubocop.yml

@@ -0,0 +1,48 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.4

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "solargraph"

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    shell_shock (0.0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.3.0)
+    diff-lcs (1.5.1)
+    e2mmap (0.1.0)
+    jaro_winkler (1.6.0)
+    json (2.7.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
+    nokogiri (1.16.6-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.6-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.6-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.6-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.6-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.6-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.25.1)
+    parser (3.3.4.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rbs (2.8.4)
+    regexp_parser (2.9.2)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.3.2)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.65.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.0.3)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    solargraph (0.50.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    strscan (3.1.0)
+    thor (1.3.1)
+    tilt (2.4.0)
+    unicode-display_width (2.5.0)
+    yard (0.9.36)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  rake
+  rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+  shell_shock!
+  solargraph
+
+BUNDLED WITH
+   2.5.11

data/README.rdoc

@@ -14,70 +14,10 @@ A library for creating command line shell application.
 
 == Usage
 
-The basic idea is that you create classes with the ShellShock::Context mixin.  Start a shell by instantiating the class and executing the push method.  Any number of nested shells may be pushed and exit falls back to the previous shell.
+The basic idea is that you create classes and include the ShellShock::Context mixin.  Start a shell by instantiating the class and executing the push method.  Any number of nested shells may be pushed and exit falls back to the previous shell.
 
 These classes represent a shell context with a number of commands registered.  These commands are matched with tab completion.  In addition to registered commands, 'exit', 'quit', 'help' and '?' are always available.
 
 Each command must have an execute method that accepts a string (the remaining content after the command name).  Commands may also implement usage and help methods.  They may also implement a completion method so may have arbitrarily complex completion rules per parameter.
 
-Here's a sample shell application using shell shock.  It has 'cd' and 'cat' commands.  'cd' performs tab completion for directories and execution enters a nested context.  'cat' performs tab completion for files and execution dumps the file content.
-
-  require 'shell_shock/context'
-
-  class CatFileCommand
-    def initialize path
-      @path = path
-    end
-
-    def usage
-      '<file name>'
-    end
-
-    def help
-      'displays the content of a file'
-    end
-
-    def completion text
-      Dir.glob("#{@path}/#{text}*").select {|f| File.file?(f) }
-    end
-
-    def execute path
-      File.open(path) {|f| f.each_with_index {|l,i| puts "#{i+1}: #{l}" } }
-    end
-  end
-
-  class ChangeDirectoryCommand
-    def initialize path
-      @path = path
-    end
-
-    def usage
-      '<directory name>'
-    end
-
-    def help
-      'switches to a new shell context in the specified directory'
-    end
-
-    def completion text
-      Dir.glob("#{@path}/#{text}*").select {|f| File.directory?(f) }
-    end
-
-    def execute text
-      DirectoryContext.new(text).push
-    end
-  end
-
-  class DirectoryContext
-    include ShellShock::Context
-
-    def initialize path
-      @prompt_text = "#{path} > "
-      @commands = {
-        'cd' => ChangeDirectoryCommand.new(path),
-        'cat' => CatFileCommand.new(path)
-      }
-    end
-  end
-
-  DirectoryContext.new('.').push
+Refer to the examples directory for some sample shells.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/example/adventure.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../lib"
+
+require "shell_shock/context"
+
+class MoveCommand
+  attr_reader :usage, :help
+
+  def initialize(room)
+    @room = room
+    @usage = "<direction>"
+    @help = "moves to the adjoining room in the specified direction"
+  end
+
+  def completion(text)
+    @room.connections.keys.grep(/^#{text}/).sort
+  end
+
+  def execute(direction)
+    room = @room.connections[direction]
+    if room
+      AdventureContext.new(room).push
+    else
+      puts "there is no adjoining room to the #{direction}"
+    end
+  end
+end
+
+class AdventureContext
+  include ShellShock::Context
+
+  def initialize(room)
+    puts room.description
+    @prompt = "#{room.name} > "
+    add_command MoveCommand.new(room), "go"
+  end
+end
+
+class Room
+  attr_reader :name, :description, :connections
+
+  def initialize(name, description)
+    @name = name
+    @description = description
+    @connections = {}
+  end
+
+  def add(direction, room)
+    @connections[direction] = room
+  end
+end
+
+START = Room.new "clearing", <<~DESCRIPTION
+  You have entered a clearing.
+
+  A dead goat lies on the ground in front of you
+DESCRIPTION
+
+CAVE_ENTRANCE = Room.new "cave entrance", <<~DESCRIPTION
+  You have arrived at the entrance to a cave.
+
+  A foul smell is emitting from the cave. Some smoke
+  can be seen off off to the east.
+DESCRIPTION
+
+CAMP_SITE = Room.new "camp site", <<~DESCRIPTION
+  You have arrived in a camp site.
+
+  There is a fire that has been recently put out.
+DESCRIPTION
+
+CAVE = Room.new "cave", <<~DESCRIPTION
+  You have entered a dark cave.
+
+  A faint growling sound can be heard.
+DESCRIPTION
+
+START.add "north", CAVE_ENTRANCE
+CAVE_ENTRANCE.add "east", CAMP_SITE
+CAVE_ENTRANCE.add "north", CAVE
+
+AdventureContext.new(START).push

data/example/file_system.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../lib"
+
+require "shell_shock/context"
+require "find"
+require "pathname"
+
+class Finder
+  attr_reader :files
+
+  def initialize(path)
+    @path = path
+  end
+
+  def refresh(pattern)
+    files = []
+    here = Pathname.new(File.expand_path(@path))
+    Find.find(File.expand_path(@path)) do |p|
+      if File.basename(p).start_with?(".")
+        Find.prune
+      else
+        path = Pathname.new(p).relative_path_from(here).to_s
+        files << path if path.start_with?(pattern) && yield(p)
+      end
+    end
+    files
+  end
+end
+
+class CatFileCommand
+  include ShellShock::Logger
+
+  def initialize(path)
+    @finder = Finder.new path
+  end
+
+  def usage
+    "<file name>"
+  end
+
+  def help
+    "displays the content of a file"
+  end
+
+  def completion(text)
+    log { "cat command completing \"#{text}\"" }
+    @finder.refresh(text) { |path| File.file? path }
+  end
+
+  def execute(path = nil)
+    return unless path
+
+    File.open(path) { |f| f.each_with_index { |l, i| puts "#{i + 1}: #{l}" } }
+  end
+end
+
+class ChangeDirectoryCommand
+  include ShellShock::Logger
+
+  def initialize(path)
+    @path = path
+    @finder = Finder.new path
+  end
+
+  def usage
+    "<directory name>"
+  end
+
+  def help
+    "switches to a new shell context in the specified directory"
+  end
+
+  def completion(text)
+    log { "cd command completing \"#{text}\"" }
+    @finder.refresh(text) { |path| path != "." and File.directory? path }
+  end
+
+  def execute(text = nil)
+    return unless text
+
+    log { "pushing new shell in \"#{text}\"" }
+    DirectoryContext.new("#{@path}/#{text}").push
+  end
+end
+
+class DirectoryContext
+  include ShellShock::Context
+
+  def initialize(path)
+    @prompt_text = "#{path} > "
+    @commands = {
+      "cd" => ChangeDirectoryCommand.new(path),
+      "cat" => CatFileCommand.new(path)
+    }
+  end
+end
+
+DirectoryContext.new(".").push

data/lib/shell_shock/command_spec.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module ShellShock
-    module CommandSpec
-      def with_usage text
-        it('should display usage') { @command.usage.should == text }
-      end
+  module CommandSpec
+    def with_usage(text)
+      it("displays usage") { expect(@command.usage).to eq(text) }
+    end
 
-      def with_help text
-        it('should display help') { @command.help.should == text }
-      end
+    def with_help(text)
+      it("displays help") { expect(@command.help).to eq(text) }
     end
-end
+  end
+end

data/lib/shell_shock/context.rb

@@ -1,43 +1,45 @@
-require 'rubygems'
-require 'readline'
-require 'shell_shock/exit_command'
-require 'shell_shock/help_command'
-require 'shell_shock/logger'
+# frozen_string_literal: true
+
+require "rubygems"
+require "readline"
+require "shell_shock/exit_command"
+require "shell_shock/help_command"
+require "shell_shock/logger"
 
 module ShellShock
   module Context
     include Logger
 
-    def head_tail string
+    def head_tail(string)
       if string
         m = /[^ ]+/.match(string.strip)
         return m[0], m.post_match.strip if m
       end
-      return '', ''
+      ["", ""]
     end
 
     def refresh
       refresh_commands if respond_to?(:refresh_commands)
-      Readline.completer_word_break_characters = ''
+      Readline.completer_word_break_characters = ""
       Readline.completion_proc = lambda do |string|
-        log "trying completion for \"#{string}\""
+        log { "trying completion for \"#{string}\"" }
         first, rest = head_tail(string)
-        log "split \"#{first}\" from \"#{rest}\""
+        log { "split \"#{first}\" from \"#{rest}\"" }
         if first
           command = @commands[first]
           if command
-            log "matched #{first} command"
+            log { "matched #{first} command" }
             if command.respond_to?(:completion)
-              completions = command.completion(rest).map {|c| "#{first} #{c}" }
+              completions = command.completion(rest).map { |c| "#{first} #{c}" }
             else
-              log "#{first} has no completion proc"
+              log { "#{first} has no completion proc" }
               completions = []
             end
           end
         end
 
-        completions ||= @commands.keys.grep( /^#{Regexp.escape(first)}/ ).sort
-        log "returning #{completions.inspect} completions"
+        completions ||= @commands.keys.grep(/^#{Regexp.escape(first)}/).sort.map { |c| "#{c} " }
+        log { "returning #{completions.inspect} completions" }
         completions
       end
     end
@@ -52,20 +54,20 @@ module ShellShock
 
     def add_command command, *aliases
       @commands ||= {}
-      aliases.each {|a| @commands[a] = command}
+      aliases.each { |a| @commands[a] = command }
     end
 
     def push
-      @prompt ||= ' > '
-      add_command HelpCommand.new(@commands), '?', 'help'
-      add_command ExitCommand.new(self), 'exit', 'quit'
+      @prompt ||= " > "
+      add_command HelpCommand.new(@commands), "help"
+      add_command ExitCommand.new(self), "exit"
       begin
         until abort?
           refresh
           line = Readline.readline(@prompt, true)
           if line
             first, rest = head_tail(line)
-            log "looking for command \"#{first}\" with parameter \"#{rest}\""
+            log { "looking for command \"#{first}\" with parameter \"#{rest}\"" }
             if @commands[first]
               @commands[first].execute rest
             else
@@ -76,9 +78,9 @@ module ShellShock
           end
           puts
         end
-      rescue Interrupt => e
+      rescue Interrupt
         puts
       end
     end
   end
-end
+end

data/lib/shell_shock/exit_command.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module ShellShock
   class ExitCommand
     attr_reader :help, :usage
 
-    def initialize context
+    def initialize(context)
       @context = context
-      @usage = ''
-      @help = 'exits the current context'
+      @usage = ""
+      @help = "exits the current context"
     end
 
-    def execute ignore
+    def execute(_ignore)
       @context.abort!
     end
-  end  
-end
+  end
+end

data/lib/shell_shock/help_command.rb

@@ -1,28 +1,31 @@
+# frozen_string_literal: true
+
 module ShellShock
   class HelpCommand
     attr_reader :help, :usage
 
-    def initialize commands
+    def initialize(commands)
       @commands = commands
-      @usage = '<command name>'
-      @help = 'displays the help information for a command'
+      @usage = "<command name>"
+      @help = "displays the help information for a command"
     end
 
-    def completion text
+    def completion(text)
       @commands.keys.grep(/^#{Regexp.escape(text)}/).sort
     end
 
-    def execute command
+    def execute(command)
       command.empty? ? display_help_for_commands : display_help_for_command(command)
     end
 
     def display_help_for_commands
       return if @commands.keys.empty?
-      puts 'Available commands:'
+
+      puts "Available commands:"
       @commands.keys.sort.each { |command| puts command }
     end
 
-    def display_help_for_command command_name
+    def display_help_for_command(command_name)
       command = @commands[command_name]
       if command
         puts "Command \"#{command_name}\""
@@ -33,4 +36,4 @@ module ShellShock
       end
     end
   end
-end
+end

data/lib/shell_shock/logger.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module ShellShock
-    module Logger
-    def log message
-      return unless ENV['LOG_PATH']
-      File.open(ENV['LOG_PATH'], 'a') do |file|
-        file.puts message
+  module Logger
+    def log(message = nil)
+      return unless ENV["LOG_PATH"]
+
+      File.open(ENV.fetch("LOG_PATH", nil), "a") do |file|
+        file.puts message if message
+        file.puts yield if block_given?
       end
     end
   end
-end
+end

data/shell_shock.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "shell_shock"
+  spec.version = "0.0.6"
+  spec.summary = "library for creating simple shell applications using readline"
+  spec.description = <<~DESCRIPTION
+    This is just some code extracted from a few command line gems i've created (shh and cardigan).
+
+    I wanted to move the shared functionality (related to creating a shell with readline) to a seperate gem.'
+  DESCRIPTION
+
+  spec.authors << "Mark Ryall"
+  spec.email = "mark@ryall.name"
+  spec.homepage = "http://github.com/markryall/shell_shock"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  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        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,124 +1,62 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: shell_shock
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
+version: !ruby/object:Gem::Version
+  version: 0.0.6
 platform: ruby
-authors: 
+authors:
 - Mark Ryall
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-
-date: 2010-10-24 00:00:00 +10:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 8
-        - 7
-        version: 0.8.7
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: gemesis
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 0
-        - 0
-        - 4
-        version: 0.0.4
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 2
-        - 0
-        - 1
-        version: 2.0.1
-  type: :development
-  version_requirements: *id003
+date: 2024-07-20 00:00:00.000000000 Z
+dependencies: []
 description: |
   This is just some code extracted from a few command line gems i've created (shh and cardigan).
-  
-  I wanted to move the shared functionality (related to creating a shell with readline) to a seperate gem.'
 
+  I wanted to move the shared functionality (related to creating a shell with readline) to a seperate gem.'
 email: mark@ryall.name
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/shell_shock/logger.rb
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- example/adventure.rb
+- example/file_system.rb
+- lib/shell_shock/command_spec.rb
+- lib/shell_shock/context.rb
 - lib/shell_shock/exit_command.rb
 - lib/shell_shock/help_command.rb
-- lib/shell_shock/context.rb
-- lib/shell_shock/command_spec.rb
-- README.rdoc
-- MIT-LICENSE
-has_rdoc: true
+- lib/shell_shock/logger.rb
+- shell_shock.gemspec
 homepage: http://github.com/markryall/shell_shock
 licenses: []
-
-post_install_message: 
+metadata:
+  homepage_uri: http://github.com/markryall/shell_shock
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 3
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
 summary: library for creating simple shell applications using readline
 test_files: []
-