wordexp 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb71655c4037612389f450fa4b30e11e74de3f3341bc21c1f9e383ef004032cc
+  data.tar.gz: 2d44f45f8059ef90230f0f1838925c2ed93346877797dd91eea8d06ed85522f9
+SHA512:
+  metadata.gz: e75fa85c1e12d4941b25590e298b5f7ef07bb6a580e206865db691aeb2a96577a553afeeeb2d680acba9112b4d31c4973f3cc68380bc15f7bedd5cf4c57f44aa
+  data.tar.gz: b7f2852a1f45ad3323eaa1cc50351ad6cec485a941000f73823cc5bea048e502eb22d88c9669ec9f576c5b647a1fb9d7b16ae8c06c65c808a45b238efe1d35b3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Sami Samhuri
+
+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,52 @@
+# wordexp
+
+[![Gem Version](https://badge.fury.io/rb/wordexp.svg)](https://rubygems.org/gems/wordexp)
+[![Circle](https://circleci.com/gh/samsonjs/wordexp/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/samsonjs/wordexp?branch=main)
+[![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/21cc24badf15d19b5cec/maintainability)](https://codeclimate.com/github/samsonjs/wordexp/maintainability)
+
+A Ruby gem for performing shell word expansion using [wordexp][]. It's like [Shellwords][] turned up to 11. Not only does it split taking quotes into account, but it also expands environment variables and tildes, and runs subcommands in \``backticks`\` or `$(dollar parentheses)`.
+
+[wordexp]: https://man7.org/linux/man-pages/man3/wordexp.3.html
+[Shellwords]: https://ruby-doc.org/stdlib-3.1.0/libdoc/shellwords/rdoc/Shellwords.html
+
+---
+
+- [Quick start](#quick-start)
+- [Support](#support)
+- [License](#license)
+- [Code of conduct](#code-of-conduct)
+- [Contribution guide](#contribution-guide)
+
+## Quick start
+
+```
+$ gem install wordexp
+```
+
+```ruby
+require 'wordexp'
+
+cmd = Wordexp.expand("echo 'roof cats' $HOME ~/bin $(date +%F)")
+# => ["echo", "roof cats", "/home/queso", "/home/queso/bin", "2022-01-16"]
+
+fork { exec(*cmd) }
+# roof cats /home/queso /home/queso/bin 2022-01-16
+```
+
+With that you're half way to a [fairly usable shell in Ruby](https://github.com/samsonjs/csc360-a1-shell).
+
+## Support
+
+If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/samsonjs/wordexp/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of conduct
+
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Contribution guide
+
+Pull requests are welcome! Make sure that new code is reasonably well tested and all the checks pass. I'm happy to provide a bit of direction and guidance if you're unsure how to proceed with any of these things.

data/exe/wordexp

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby -w
+
+require 'wordexp'
+
+string = ARGV.first
+if string.nil? || string.strip.empty?
+  warn 'Usage: wordexp <string>'
+  exit 1
+end
+
+Wordexp::CLI.new.call(string)

data/ext/wordexp_ext/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+
+create_makefile 'wordexp_ext/wordexp_ext'

data/lib/wordexp/cli.rb

@@ -0,0 +1,7 @@
+module Wordexp
+  class CLI
+    def call(string)
+      puts Wordexp.expand(string).inspect
+    end
+  end
+end

data/lib/wordexp/version.rb

@@ -0,0 +1,3 @@
+module Wordexp
+  VERSION = '0.1.1'.freeze
+end

data/lib/wordexp.rb

@@ -0,0 +1,53 @@
+require 'wordexp/wordexp_ext'
+
+module Wordexp
+  autoload :CLI, 'wordexp/cli'
+  autoload :VERSION, 'wordexp/version'
+
+  # Illegal occurrence of newline or one of |, &, ;, <, >, (, ), {, }.
+  class BadCharacterError < StandardError; end
+
+  # An undefined shell variable was referenced, and the WRDE_UNDEF flag told us to consider this an error.
+  class BadValueError < StandardError; end
+
+  # Command substitution requested, but the WRDE_NOCMD flag told us to consider this an error.
+  class CommandSubstitutionError < StandardError; end
+
+  # Out of memory.
+  class NoSpaceError < StandardError; end
+
+  # Shell syntax error, such as unbalanced parentheses or unmatched quotes.
+  class SyntaxError < StandardError; end
+
+  # An undocumented error occurred.
+  class UndocumentedError < StandardError; end
+
+  class << self
+    def expand(string)
+      result = Ext.wordexp(string)
+      return result if result.is_a?(Array)
+
+      case result
+      when :wrde_badchar
+        # FIXME: useful message that includes the position of the character
+        raise BadCharacterError, 'Bad character'
+
+      when :wrde_badval
+        raise BadValueError, 'Bad value'
+
+      when :wrde_cmdsub
+        raise CommandSubstitutionError, 'Command substitution is disabled'
+
+      when :wrde_nospace
+        raise NoSpaceError, 'Out of memory'
+
+      when :wrde_syntax
+        raise SyntaxError, 'Bad value'
+
+      else
+        warn "wordexp returned an unexpected result: #{result.inspect}"
+        raise UndocumentedError, 'An unknown error occurred'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: wordexp
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sami Samhuri
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-17 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- sami@samhuri.net
+executables:
+- wordexp
+extensions:
+- ext/wordexp_ext/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/wordexp
+- ext/wordexp_ext/extconf.rb
+- lib/wordexp.rb
+- lib/wordexp/cli.rb
+- lib/wordexp/version.rb
+- lib/wordexp/wordexp_ext.bundle
+homepage: https://github.com/samsonjs/wordexp
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/samsonjs/wordexp/issues
+  changelog_uri: https://github.com/samsonjs/wordexp/releases
+  source_code_uri: https://github.com/samsonjs/wordexp
+  homepage_uri: https://github.com/samsonjs/wordexp
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- ext
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: A Ruby gem for performing shell word expansion using wordexp
+test_files: []