sprinkles-opts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa12d8ee5410cdbd3e47d4f1b2e1cec293b9097208dbbaae043d7804da3153cf
+  data.tar.gz: 3ae63c4d2bc388276778ae46809571f4b4e975a90f2618ab7ce73427245fc67b
+SHA512:
+  metadata.gz: fa177fc8e6752839665457657eff697776e12324dfab2ce47b0f59be0c28729346ec246818a4c135cea07ca7b4aefb6b5da2ccb12ca513c72324751751e37ecf
+  data.tar.gz: 63963328fb25de91205f032fc86332b1dc25066b5cc8bf2756e8cf7300e4af330eabe17a4448bd69104fa6bbcea6512cae6494139f9090ff20d93c431845c396

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake
+    - name: Typecheck
+      run: bundle exec srb tc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*~

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tristero@infinitenegativeutility.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sprinkles-defaultdict.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    sprinkles-opts (0.1.0)
+      sorbet-runtime
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    sorbet (0.5.6346)
+      sorbet-static (= 0.5.6346)
+    sorbet-runtime (0.5.6433)
+    sorbet-static (0.5.6346-universal-darwin-14)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rubocop
+  sorbet
+  sprinkles-opts!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Getty Ritter
+
+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,137 @@
+# sprinkles-opts
+
+The `sprinkles-opts` library is a convenient Sorbet-aware way of doing
+argument parsing.
+
+## Basic usage
+
+Create a class that is a subclass of `Spinkles::Opts::GetOpt`. Define fields and their types with `const`, analogously to [how you would with `T::Struct`](), but those fields can have `short:` and `long:` options that map to the flags used to provide them. You'll also have to provide a value for `program_name` by overriding an abstract method:
+
+```ruby
+class MyOptions < Sprinkles::Opts::GetOpt
+  sig {override.returns(String)}
+  def self.program_name; "my-program"; end
+
+  const :input, String, short: 'i', long: 'input'
+  const :num_iterations, Integer, short: 'n', placeholder: 'N'
+  const :verbose, T::Boolean, short: 'v', long: 'verbose', factory: -> {false}
+end
+```
+
+You can then call `MyOptions.parse(ARGV)` in order to get a value of type `MyOptions` with the defined fields initialized.
+
+```ruby
+opts = MyOptions.parse(%w{-i foo -n 8 --verbose})
+assert_equal('foo', opts.input)
+assert_equal(8, opts.num_iterations)
+assert_equal(true, opts.verbose)
+```
+
+The field type will affect the behavior of the option parser. Fields whose type is `T::Boolean` are implicitly treated as flags that do not take more arguments, and a `T::Boolean` field with a long argument name like `--foo` will also automatically get a corresponding `--no-foo` which sets the flag to false. Values with other built-in types like `Symbol` or `Integer` will be converted to the appropriate type.
+
+Fields without a `short:` or `long:` parameter will be understood to be positional arguments. Ordering is important here: positional arguments will be filled in the order that they appear in the definition.
+
+```ruby
+class PosOptions < Sprinkles::Opts::GetOpt
+  sig {override.returns(String)}
+  def self.program_name; "positional-options"; end
+
+  const :source, String
+  const :destination, String
+end
+
+opts = PosOptions.parse(%w{this that})
+assert_equal('this', opts.source)
+assert_equal(that, opts.destination)
+```
+
+Parsing will fail and exit the program with a usage statement if either too many or too few positional parameters are provided.
+
+```ruby
+opts = PosOptions.parse(%w{this})
+# this will exit and print the following:
+# Not enough arguments!
+# Usage: positional-options SOURCE DESTINATION
+#     -h, --help                       Prints this help
+```
+
+## Optional arguments
+
+There are two ways of making arguments optional:
+- A field whose type is marked as `T.nilable` will implicitly be initialized as `nil` if it is not provided.
+- A field can have a `factory:` which should be a lambda that will be called to initialize the field if the argument is not provided.
+
+Fields that are not `T.nilable` and do not have a `factory:` must be provided when parsing arguments.
+
+For _positional_ arguments, there's currently an extra restriction: all mandatory positional arguments _must come first_, and will throw a definition-time error if they appear later. This means that positional parameters are matched in-order as they appear, and once we're out of positional parameters the remaining optional parameters will be initialized to `nil` (for `T.nilable` fields) or their provided defaults (if they have a `factory:` parameter.)
+
+```ruby
+class PosOptions < Sprinkles::Opts::GetOpt
+  sig {override.returns(String)}
+  def self.program_name; "positional-options"; end
+
+  const :a, String
+  const :b, T.nilable(String)
+  const :c, T.nilable(String)
+end
+
+PosOptions.parse(%w{1 2 3})  # a is 1, b is 2, c is 3
+PosOptions.parse(%w{1 2})    # a is 1, b is 2, c is nil
+PosOptions.parse(%w{1})      # a is 1, b is nil, c is nil
+```
+
+It is still an error to pass too few positional parameters (i.e. fewer than there are mandatory positional parameters) or too many (i.e. more than there are total positional parameters, mandatory and optional).
+
+## Repeated arguments
+
+Fields whose types are either `T::Array[...]` or `T::Set[...]` are implicitly treated as repeated fields.
+
+When a positional field has type `T::Array[...]` or `T::Set[...]`, then it is subject to two major restrictions:
+- It must be the last positional field specified, which also implies that it must be the _only_ repeated positional field.
+- None of the other fields can be optional.
+
+The second restriction is because of the ambiguity as to where extra fields go when choosing how to fill in optional fields, but may eventually be lifted in the future.
+
+When a positional field is `T::Array[...]` or `T::Set[...]`, then any trailing arguments will be added to the array contained in that field. For example:
+
+```ruby
+class PosArray < Sprinkles::Opts::GetOpt
+  const :a, Integer
+  const :b, T::Array[String]
+end
+
+PosArray.parse(%w{1})      # a is 1, b is []
+PosArray.parse(%w{1 2})    # a is 1, b is ['2']
+PosArray.parse(%w{1 2 3})  # a is 1, b is ['2', '3']
+```
+
+When a non-positional field is `T::Array[...]` or `T::Set[...]`, then it can be specified multiple times (in any order) to add to that collection. For example:
+
+```ruby
+class OptArray < Sprinkles::Opts::GetOpt
+  const :a, T::Array[Integer]
+end
+
+PosArray.parse(%w{})             # a is []
+PosArray.parse(%w{-a 5})         # a is [5]
+PosArray.parse(%w{-a 22 -a 33})  # a is [22, 33]
+```
+
+## Help text and descriptions
+
+The option names `-h` and `--help` are reserved, and when they are provided the program will print a usage panel and exit:
+
+```
+Usage: my-program --input=VALUE -nN
+    -h, --help                       Print this help
+    -i, --input=VALUE
+    -nN
+    -v, --[no-]verbose
+```
+
+Individual fields can customize their default placeholder text away from the default `VALUE` using the `placeholder:` argument, and can provide more extensive descriptions using the `description:` argument.
+
+
+## Why sprinkles?
+
+Well, because it's a Sorbet topping. I have other unfinished ideas for how to leverage Sorbet to write certain abstractions, and my thought was that it might be nice to put them in a common namespace.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/lib/sprinkles/opts/version.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Sprinkles
+  module Opts
+    VERSION = '0.1.0'
+  end
+end