zxc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8a6facbb820de32db32cb8a5c71221e959deffcc78ce3583be2fd45dfd01bbe
-  data.tar.gz: 8332a68e6627a9bba769116b4e0b4a52f47f1f24a7afb33e552032536a21b2f6
+  metadata.gz: f773e74ecf369e69253cdf0d61a98d05c88eea29dfe0e143830795ce687bae31
+  data.tar.gz: d273a757deb2e8a15cf8c2a1c8bca8a78b4d625d0ece31fb36466be0b92d943e
 SHA512:
-  metadata.gz: 88bb3a737aff502363e517723d1b74b957dfaa81fb94ac0eafcbb92bf8962d3225aab4819c166fb7de9f6dcce02e9a2657900af6e00ebc08c72d030afdef9d88
-  data.tar.gz: 1529d74ab9d6cc8b5896336dc5d514ad8aa2217ef41289cc4f76df0e6cfc2a29aed8a030e20fd065e1264d75f2d310bf2a4d29872ea5fef98808ac49de627203
+  metadata.gz: 0c760b9ecc6652389fdb27643bee1664e7668124d8934546ed63bf2744dc2555906737f0ac6f5afc748284a72a1ba62055a8ebe338bc9b5d4df9a295eda60f87
+  data.tar.gz: 9c99fc06e8404f667b0eda2bac11306a33826b976cc5e04aa0dc48f79574822af4d5171957d82360838d254e1311bb10682721975ed8a155e84eb4458dd00059

data/README.md

@@ -1,38 +1,48 @@
 # Zxc
 
-TODO: Delete this and the text below, and describe your gem
+**zxc** allows you to quickly perform a few common opperations on STDIN, for example:
 
-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/zxc`. To experiment with that code, run `bin/console` for an interactive prompt.
+```bash
+echo $PATH | zxc split : split / present print
+```
 
-## Installation
+The command chain above will
+1. get the list of directories in your `$PATH`,
+2. split it into a list, using ":" as a delimiter,
+3. split each element of said list into a sublist, using "/" as a delimiter,
+4. remove empty elements,
+5. print every element of every sublist.
+
+This works by generating a tree, where each node contains text, and exposing "steps" to the user, which are procedures over said tree, In the example above, "split", "present" and "print" are steps, the first one taking arguments.
+
+Use `zxc -H` to read a manual listing available steps.
 
-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.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add zxc
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install zxc
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+zxc [OPTIONS] [STEP [ARG]...]...
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+**zxc** reads text from STDIN, converts it into the root node of a tree, and applies operations (steps) onto said tree.
 
-## Contributing
+### Options
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zxc.
+- **-h , --help**: Displays a short help message and exits
+- **-H ", --Help**: Displays this page and exits
 
 ## License
 

data/bin/zxc

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require_relative "../lib/zxc"
+
+MAN_PAGE = File.join(__dir__,'..','man','zxc.1')
+
+if %w[-h --help].include? ARGV[0]
+  puts <<~EOT.chomp
+    usage: zxc [options] [step [arg...]...]
+    \t-h,\t--help\t\tShow this help message
+    \t-H,\t--Help\t\tDisplay detailed help page
+  EOT
+  exit
+elsif %w[-H --Help].include? ARGV[0]
+  system("man", MAN_PAGE)
+  exit
+end
+
+begin
+  Zxc::Zxc.new.run
+rescue Zxc::UnknownStepError => e
+  STDERR.puts "Unknown step '#{e.meta[:step]}'."
+rescue Zxc::WrongArgumentNumberError => e
+  STDERR.puts "At step '#{e.meta[:step]}': " \
+    "expected #{e.meta[:expected]} argument(s), " \
+    "but got #{e.meta[:actual]}."
+end

data/lib/zxc/version.rb

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

metadata

@@ -1,41 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: zxc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - tiago-macedo
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2025-07-10 00:00:00.000000000 Z
 dependencies: []
-description: |-
-  `zxc` allows you to quickly perform a few common opperations on STDIN, for example:
-  ```
-  $ echo $PATH | zxc split : split / present print
-  ```
-  The command chain above will
-  1. get the list of directories in your `$PATH`,
-  2. split it into a list, using ":" as a delimiter,
-  3. split each element of said list into a sublist, using "/" as a delimiter,
-  4. remove empty elements,
-  5. print every element of every sublist.
-
-  This works by generating a tree, where each node contains text, and exposing
-  "steps" to the user, which are procedures over said tree, In the example above,
-  "split", "present" and "print" are steps, the first one taking arguments.
-
-  Use `zxc -H` to read a manual listing available steps.
+description: "`zxc` is a command line program that takes in text, turns it into a
+  tree, and exposes procedures to manipulate this tree."
 email:
 - tiagomacedo@ufrj.br
-executables: []
+executables:
+- zxc
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/zxc
 - lib/zxc.rb
 - lib/zxc/error.rb
 - lib/zxc/errors/unknown_step_error.rb