leash 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 738ec446001ff3512a56306c5b8bda0d80ce8ed2f4577c14b5c30399b9dab060
-  data.tar.gz: 59b1fb3153aaacedc5828e862e921a600d2d6569e30ed5c21d668da93bf05aab
+  metadata.gz: 0f093dc6257e4b29e10bc90174aa9246859cc65dbf7f3c6cd22b997a13bda38a
+  data.tar.gz: 9b5baa0d3f5da30dd18abf5e0258687399a05037f4a975676af575f1190cf10f
 SHA512:
-  metadata.gz: f2a5cf55d057f423a04ef84f4858c5cb7e2e673551706a9bcdff0d865379bd5d5c7970d0f9fa93094c152f4113bc86f35a8fb585f24484c1f1a34d7b66f11223
-  data.tar.gz: 784840956677ea4b126e0cc2b429d418933901fcdfac312411f290d0fe420ec8d0a48c89c0a7847f436314ff7284ebed7d27436b8e19dccca1ce0b0d31309d33
+  metadata.gz: 9bb1e1e32786217df1406a991ce8abb884b9fac6c4bda783ebf016ce563c8590680d710c62d87f6e8664caa98c67529e8b2a7fd48fd253ac83cc92cd604ca94f
+  data.tar.gz: 82520de80c2f69353814514b44e31c99d430eb22361d2e20742b994a66ee741558518ac3e473bb7013225b92c33c4268321babec782d76b6c6d9dd629d9b5b14

data/README.md

@@ -1,24 +1,56 @@
 # Leash
 
-TODO: Delete this and the text below, and describe your gem
+`Leash` provides a lightweight framework to implement "Do Nothing Scripting" with Ruby.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/leash`. To experiment with that code, run `bin/console` for an interactive prompt.
+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.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add leash
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install leash
 
 ## Usage
 
-TODO: Write usage instructions here
+Define steps for your procedure by `Leash::Procedure#step`.
+
+```ruby
+require 'leash'
+
+procedure = Leash::Procedure.new("My Procedure") do
+  step "Creates a manual step, which only contains a description."
+
+  step "Creates an automated step by providing a block, run: `bundle install`" do
+    system("bundle install")
+  end
+
+  step "Or by passing a callable object as the second argument, run: `echo Hello!`", -> { system("echo Hello!") }
+end
+
+```
+
+Execute the defined procedure by `Leash::Procedure#run`.
+
+```ruby
+# Executes each step by pressing `Enter`.
+procedure.run
+```
+
+Render a text report by `Leash::Procedure#render`.
+
+```ruby
+# Renders a text report for the procedure
+puts procedure.render
+
+# > My Procedure
+# > (1/3): Creates a manual step, which only contains a description.
+# > (2/3): Creates an automated step by providing a block, run: `bundle install`
+# > (3/3): Or by passing a callable object as the second argument, run: `echo Hello!`
+```
 
 ## Development
 
@@ -28,7 +60,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/[USERNAME]/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/[USERNAME]/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](https://github.com/TonyCTHsu/leash/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +68,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/[USERNAME]/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](https://github.com/TonyCTHsu/leash/blob/master/CODE_OF_CONDUCT.md).

data/lib/leash/version.rb

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

metadata

@@ -1,16 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: leash
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tony Hsu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-02 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies: []
-description: Do Nothing Scripting for Ruby
+description: |2
+      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 encapsulates each step in a function.
+      Making it easier to start small and gradually increase the level of automation.
 email:
 - tonyc.t.hsu@gmail.com
 executables: []
@@ -30,11 +34,13 @@ files:
 - lib/leash/step.rb
 - lib/leash/version.rb
 - sig/leash.rbs
-homepage: 
+homepage: https://github.com/TonyCTHsu/leash
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/TonyCTHsu/leash
+  source_code_uri: https://github.com/TonyCTHsu/leash
 post_install_message: 
 rdoc_options: []
 require_paths: