leash 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70dfef3206b5f17287ffec1c8914523fac664d527dc48422cf17abe6d14ddb7d
-  data.tar.gz: 15b4d012fbfe5a78d07f9479a0ba5b2d51975a13c650d902d7d00d632b4f7c66
+  metadata.gz: 23d644149171f515659cf6fd3fd2064c604a728f8a12e26827f5aff426b09bdb
+  data.tar.gz: 74c824993b871142f333e756183617faa0db57dd3a1fa73c66c5caea4e13bf45
 SHA512:
-  metadata.gz: 8bf0c864c2a75813c7b4b4e890edc8eab3c84ca81fe3ea9423d9953818d33e499c5324c81fd0eaadb1ec867fc0843019aaee30e0e35f01bceb6bbf585e146c88
-  data.tar.gz: a4c6005a18dd629fb89e0668648218181cc15180a0662f94d7436bdff31dcd63b2a89b641f534ed6e77d649c99e04e38123a09d7e8776bc8e768d814383406f9
+  metadata.gz: 7ab8f0f2e5b613a76e152ed374e16b0af2bbffa6635e5ea51bd11a0762f713961dd13e5bb5e2c8369ca4d5b35c409c9b1af33d5e26d1a48b2361709ff9732e29
+  data.tar.gz: 3f2b562575ad4737989dff02c8dc35d47f0411d1bfe488579ce7d7fcf7c72a793f8b437d7beb526c1a3d6b8e094a23bdf98f01ab779a25e059af2610661eb72c

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "files.associations": {
+    "*.gemfile": "ruby"
+  }
+}

data/README.md

@@ -1,5 +1,8 @@
 # Leash
 
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/TonyCTHsu/leash/test.yml?style=for-the-badge&logo=github)
+![Gem Version](https://img.shields.io/gem/v/leash?style=for-the-badge&logo=rubygems&logoColor=orange&color=orange)
+
 `Leash` provides a lightweight framework to implement "Do Nothing Scripting" with Ruby.
 
 A "do nothing script" is a script that encodes instructions of a manual procedure and encapsulating each step in a function. Making it easier to start small and gradually increase the level of automation.
@@ -60,7 +63,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/TonyCTHsu/leash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/TonyCTHsu/leash/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/TonyCTHsu/leash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](docs/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -68,4 +71,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Leash project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/TonyCTHsu/leash/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Leash project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](docs/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,10 +1,6 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# load rake tasks from tasks directory
+Dir.glob(File.join(__dir__ || Dir.pwd, "tasks", "**", "*.rake")) { |f| import f }
 
-RSpec::Core::RakeTask.new(:spec)
-
-require "standard/rake"
-
-task default: %i[standard spec]
+task default: %i[spec]

data/Steepfile

@@ -0,0 +1,27 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+
+  check "lib"                       # Directory name
+  # ignore "lib/templates/*.rb"
+
+  # library "pathname"              # Standard libraries
+  # library "strong_json"           # Gems
+
+  # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+  # configure_code_diagnostics do |hash|             # You can setup everything yourself
+  #   hash[D::Ruby::NoMethod] = :information
+  # end
+end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname"              # Standard libraries
+# end

data/docs/CODEOWNERS

@@ -0,0 +1 @@
+* @TonyCTHsu

data/docs/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# How to contribute
+
+I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.
+
+## Testing
+
+Most of our testbed consists of RSpec examples. Please write RSpec examples for new code you create.
+
+## Submitting changes
+
+Please send a [Pull Request](https://github.com/TonyCTHsu/leash/pull/new/master) with a clear list of what you've done. When you send a pull request, we will love you forever if you include RSpec examples. We can always use more test coverage.
+
+Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
+
+    $ git commit -m "A brief summary of the commit
+    >
+    > A paragraph describing what changed and its impact."
+
+## Coding conventions
+
+Start reading our code and you'll get the hang of it. To avoid bikeshedding, we use `standard` for linting. Run `bundle exec standardrb` and everything be fine.
+
+This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
+
+Thanks

data/docs/SECURITY.md

@@ -0,0 +1,7 @@
+# Reporting Security Issues
+
+The team and community take security bugs seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
+
+To report a security issue, please use the GitHub Security Advisory ["New draft security advisory"](https://github.com/TonyCTHsu/leash/security/advisories/new) button.
+
+The team will send a response indicating the next steps in handling your report. After the initial reply to your report, the team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.

data/gemfiles/ruby-2.7.gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rake", "~> 13.0"
+
+group :test do
+  gem "rspec", "~> 3.0", require: false
+  gem "datadog-ci", "~> 1.0.0.beta5", require: false
+end

data/gemfiles/ruby-3.0.gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rake", "~> 13.0"
+
+group :test do
+  gem "rspec", "~> 3.0", require: false
+  gem "datadog-ci", "~> 1.0.0.beta5", require: false
+end

data/gemfiles/ruby-3.1.gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rake", "~> 13.0"
+
+group :test do
+  gem "rspec", "~> 3.0", require: false
+  gem "datadog-ci", "~> 1.0.0.beta5", require: false
+end

data/gemfiles/ruby-3.2.gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rake", "~> 13.0"
+
+group :test do
+  gem "rspec", "~> 3.0", require: false
+  gem "datadog-ci", "~> 1.0.0.beta5", require: false
+end

data/gemfiles/ruby-3.3.gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rake", "~> 13.0"
+
+group :test do
+  gem "rspec", "~> 3.0", require: false
+  gem "datadog-ci", "~> 1.0.0.beta5", require: false
+end
+
+group :check do
+  gem "standard", "~> 1.0", require: false
+  gem "steep", "~> 1.6", require: false
+end

data/lib/leash/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Leash
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/sig/leash/procedure.rbs

@@ -0,0 +1,25 @@
+module Leash
+  class Procedure
+    @title: String
+
+    @options: Hash[untyped, untyped]
+
+    @steps: Array[Step]
+
+    attr_reader title: String
+
+    attr_reader options: Hash[untyped, untyped]
+
+    attr_reader steps: Array[Step]
+
+    def initialize: (String title, ?Hash[untyped, untyped] options) ?{ (self)[self: self] -> void } -> void
+
+    def step: (String description, ?untyped? action) { () -> untyped } -> untyped
+
+    def run: () -> void
+
+    def render: () -> String
+
+    def length: () -> Integer
+  end
+end

data/sig/leash/step.rbs

@@ -0,0 +1,15 @@
+module Leash
+  class Step
+    @description: String
+
+    @action: untyped
+
+    attr_reader description: String
+
+    attr_reader action: untyped
+
+    def initialize: (description: String, action: untyped) -> void
+
+    def run: () -> void
+  end
+end

data/sig/leash.rbs

@@ -1,4 +1,7 @@
 module Leash
   VERSION: String
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  class Error < StandardError
+  end
 end

data/tasks/bundler.rake

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/tasks/rspec.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)

data/tasks/standard.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require "standard/rake"
+rescue LoadError
+  warn "'standard' gem not loaded: skipping tasks..."
+  return
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leash
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Tony Hsu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-06 00:00:00.000000000 Z
+date: 2024-05-27 00:00:00.000000000 Z
 dependencies: []
 description: |2
       Leash provides a lightweight framework to implement "Do Nothing Scripting" with Ruby.
@@ -22,18 +22,34 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".ruby-version"
 - ".standard.yml"
+- ".vscode/settings.json"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
+- docs/CODEOWNERS
+- docs/CODE_OF_CONDUCT.md
+- docs/CONTRIBUTING.md
+- docs/SECURITY.md
+- gemfiles/ruby-2.7.gemfile
+- gemfiles/ruby-3.0.gemfile
+- gemfiles/ruby-3.1.gemfile
+- gemfiles/ruby-3.2.gemfile
+- gemfiles/ruby-3.3.gemfile
 - lib/leash.rb
 - lib/leash/procedure.rb
 - lib/leash/step.rb
 - lib/leash/version.rb
 - sig/leash.rbs
+- sig/leash/procedure.rbs
+- sig/leash/step.rbs
+- tasks/bundler.rake
+- tasks/rspec.rake
+- tasks/standard.rake
+- tmp/.keep
 homepage: https://github.com/TonyCTHsu/leash
 licenses:
 - MIT
@@ -56,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Do Nothing Scripting with Ruby

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Tony Hsu
-
-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.