zxc 0.1.0

checksums.yaml

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 tiago-macedo
+
+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,39 @@
+# Zxc
+
+TODO: Delete this and the text below, and describe your gem
+
+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.
+
+## 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:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+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
+```
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zxc.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/zxc/error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Zxc
+  class Error < StandardError
+    attr_reader :meta
+  end
+end

data/lib/zxc/errors/unknown_step_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Zxc
+  class UnknownStepError < Error
+    def initialize(*args, step:)
+      @meta = {step: step.to_s}
+      super(*args)
+    end
+  end
+end

data/lib/zxc/errors/wrong_argument_number_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Zxc
+  class WrongArgumentNumberError < Error
+    def initialize(*args, step:, expected:, actual:)
+      @meta = {step: step.to_s, expected: expected, actual: actual}
+      super(*args)
+    end
+  end
+end

data/lib/zxc/node.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Zxc
+  class Node
+    attr_accessor :text, :subnodes, :parent, :til_root, :til_leaf
+  
+    def initialize(text, parent)
+      @text = text
+      @parent = parent
+      @subnodes = []
+      if parent.nil?
+        @til_root = 0
+      else
+        @til_root = parent.til_root + 1
+      end
+      @til_leaf = 0
+    end
+
+    def for_subtree(&block)
+      yield self
+      subnodes.each { |subnode| subnode.for_subtree(&block) }
+    end
+
+    def at_depth(n)
+      if n >= 0
+        return [self] if @til_root == n
+      else
+        return [self] if @til_leaf == -1-n
+      end
+  
+      list = []
+      subnodes.each do |subnode|
+        list += subnode.at_depth(n)
+      end
+  
+      list
+    end
+    
+    def leaves
+      at_depth(-1)
+    end
+  
+    def short(n)
+      return text if text.size <= n
+  
+      text[...(n-3)] + "..."
+    end
+  end
+end

data/lib/zxc/step.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Zxc
+  class Step
+    Kind = {}
+  
+    def initialize(args)
+      @args = args
+    end
+  
+    def run(root)
+      raise NotImplementeError
+    end
+
+    def depth_increased(root)
+      root.for_subtree { |node| node.til_leaf += 1 unless node.subnodes.empty? }
+    end
+
+    def depth_decreased(root)
+      root.for_subtree { |node| node.til_leaf -= 1 }
+    end
+  end
+end

data/lib/zxc/steps/first.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "../step"
+
+module Zxc
+  class First < Step
+    # Register this class as a step
+    superclass::Kind[:first] = [self, 0]
+    superclass::Kind[:"1st"] = [self, 0]
+
+    def run(root)
+      root.at_depth(-2).each do |node|
+        node.subnodes = [node.subnodes.first]
+      end
+    end
+  end
+end

data/lib/zxc/steps/last.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "../step"
+
+module Zxc
+  class Last < Step
+    # Register this class as a step
+    superclass::Kind[:last] = [self, 0]
+    superclass::Kind[:lst] = [self, 0]
+
+    def run(root)
+      root.at_depth(-2).each do |node|
+        node.subnodes = [node.subnodes.last]
+      end
+    end
+  end
+end

data/lib/zxc/steps/match.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../step"
+
+module Zxc
+  class Match < Step
+    # Register this class as a step
+    superclass::Kind[:match] = [self, 1]
+    superclass::Kind[:mtc] = [self, 1]
+  
+    def run(root)
+      root.leaves.each { |l| run_leaf(l) }
+    end
+  
+    def run_leaf(node)
+      unless node.text.include?(@args[0])
+        node.parent.subnodes.reject! { |sub| sub == node }
+        node = nil
+      end
+    end
+  end
+end

data/lib/zxc/steps/match_regexp.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../step"
+
+module Zxc
+  class MatchRegexp < Step
+    # Register this class as a step
+    superclass::Kind[:match_regexp] = [self, 1]
+    superclass::Kind[:mrg] = [self, 1]
+  
+    def initialize(...)
+      super(...)
+      @rgxp = Regexp.new(@args[0])
+    end
+
+    def run(root)
+      root.leaves.each { |l| run_leaf(l) }
+    end
+  
+    def run_leaf(node)
+      unless node.text =~ @rgxp
+        node.parent.subnodes.reject! { |sub| sub == node }
+        node = nil
+      end
+    end
+  end
+end

data/lib/zxc/steps/present.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "../step"
+
+module Zxc
+  class Present < Step
+    # Register this class as a step
+    superclass::Kind[:present] = [self, 0]
+    superclass::Kind[:press] = [self, 0]
+    superclass::Kind[:prs] = [self, 0]
+  
+    def run(root)
+      root.leaves.each { |l| run_leaf(l) }
+    end
+  
+    def run_leaf(node)
+      if node.text == nil or node.text.empty?
+        node.parent.subnodes.reject! { |sub| sub == node }
+        node = nil
+      end
+    end
+  end
+end

data/lib/zxc/steps/print.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "../step"
+
+module Zxc
+  class Print < Step
+    # Register this class as a step
+    superclass::Kind[:print] = [self, 0]
+    superclass::Kind[:prl] = [self, 0]
+  
+    def run(root)
+      root.leaves.each { |l| puts l.text }
+    end
+  end
+end

data/lib/zxc/steps/print_tree.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "../step"
+
+module Zxc
+  class PrintTree < Step
+    # Register this class as a step
+    superclass::Kind[:print_tree] = [self, 0]
+    superclass::Kind[:prt] = [self, 0]
+  
+    def run(root)
+      print_node(root, 80)
+    end
+  
+    def print_node(node, len)
+      if node.subnodes.empty?
+        puts "#{"│" * node.til_root}─ #{node.short(len)} (#{node.til_root}|#{node.til_leaf})"
+      else
+        puts "#{"│" * node.til_root}┌ #{node.short(len)} (#{node.til_root}|#{node.til_leaf})"
+      end
+      node.subnodes.each_with_index do |sub, idx|
+        if idx+1 < node.subnodes.size
+          print_node(sub, len-1)
+        else
+          print_node(sub, len-1)
+        end
+      end
+      puts "#{"│" * node.til_root}└" if not node.subnodes.empty?
+    end
+  end
+end

data/lib/zxc/steps/split.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "../step"
+
+module Zxc
+  class Split < Step
+    # Register this class as a step
+    superclass::Kind[:split] = [self, 1]
+    superclass::Kind[:spl] = [self, 1]
+  
+    def run(root)
+      root.leaves.each { |l| run_leaf(l) }
+      depth_increased(root)
+    end
+  
+    def run_leaf(node)
+      splitted = node.text.split(@args[0])
+      splitted.each do |t|
+        node.subnodes << Node.new(t, node)
+      end
+    end
+  end
+end

data/lib/zxc/steps/split_regexp.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "../step"
+
+module Zxc
+  class SplitRegexp < Step
+    # Register this class as a step
+    superclass::Kind[:split_regexp] = [self, 1]
+    superclass::Kind[:srg] = [self, 1]
+  
+    def run(root)
+      root.leaves.each { |l| run_leaf(l) }
+      depth_increased(root)
+    end
+  
+    def run_leaf(node)
+      splitted = node.text.split(Regexp.new(@args[0]))
+      splitted.each do |t|
+        node.subnodes << Node.new(t, node)
+      end
+    end
+  end
+end

data/lib/zxc/version.rb

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

data/lib/zxc.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "zxc/version"
+require_relative "./zxc/node.rb"
+require_relative "./zxc/step.rb"
+Dir[__dir__ + "/zxc/steps/*.rb"].each { |f| require_relative f }
+require_relative "./zxc/error.rb"
+Dir[__dir__ + "/zxc/errors/*.rb"].each { |f| require_relative f }
+
+module Zxc
+  class Zxc
+    def initialize
+      @steps = self.class.parse_steps(ARGV)
+      @root = Node.new(STDIN.read, nil)
+    end
+
+    def run
+      @steps.each { |s| s.run(@root) }
+    end
+
+    def self.parse_steps(cmd_args)
+      steps = []
+
+      while cmd_args.size > 0
+        inst = cmd_args.shift.to_sym
+        step_class, n_args = Step::Kind[inst]
+        
+        raise UnknownStepError.new(step: inst) unless step_class
+
+        args = cmd_args[...n_args]
+
+        raise WrongArgumentNumberError.new(
+          step: inst,
+          expected: n_args,
+          actual: args.size
+        ) unless n_args == args.size
+
+        n_args.times.each { cmd_args.shift }
+
+        steps << step_class.new(args)
+      end
+
+      steps
+    end
+  end
+end

data/man/zxc.1

@@ -0,0 +1,78 @@
+.TH zxc 1
+.SH NAME
+zxc \- manipulate text using a tree
+
+.SH SYNOPSIS
+
+.B zxc
+[OPTIONS]
+[STEP [ARG]...]...
+
+.SH DESCRIPTION
+
+zxc reads text from STDIN, converts it into the root node of a tree, and applies operations (steps) onto said tree.
+
+.SH OPTIONS
+
+.IP
+.BR \-h ",
+.BR \-\-help
+	Displays a short help message and exits
+.br
+.BR \-H ",
+.BR \-\-Help
+	Displays this page and exits
+.PP
+
+.SH STEPS
+
+Unless otherwise specified, a step will not increase or decrease the depth of the tree.
+
+.SS print, prl
+Prints all leaves, each leaf in a separate line.
+.br
+
+.SS print_tree, prt
+Prints a representation of the whole tree.
+.br
+
+.SS match, mtc ARG
+Deleting the leaves which do not contain the substring ARG.
+
+.SS match_regexp, mrg ARG
+Deletes the leveaves which do not match the regular expression ARG.
+.br
+Regular expressions are use Ruby conventions.
+
+.SS split, spl ARG
+Performs the following operation on each leaf:
+.IP
+.B 1.
+splits the node's text into substrings, using ARG as the separator,
+.br
+.B 2.
+creates a new node for each of the generated substrings, setting the original leaf as their parent node.
+.PP
+This step increases the depth od the tree by 1.
+
+.SS split_regexp, srg ARG
+Works as 
+.BR split ",
+but splits the original string where it matches the regular expression given by ARG.
+
+.SS present, press, prs
+Deletes all leaves whose text is an empty string.
+
+.SS first, 1st
+On all nodes which are parents of leaves (that is, nodes at the penultimate level pf tree depth), deletes all child nodes except the first one.
+.br
+For example, if you have performed a split, breaking strings into substrings, this step will leave only the first substrings for each string the step acted on.
+
+..SS last, lst
+Works as
+.BR first ",
+but leaves the last leaf intact instead of the first.
+
+.SH AUTHORS
+
+Tiago Macedo <tiagomacedo@ufrj.br>

data/sig/zxc.rbs

@@ -0,0 +1,4 @@
+module Zxc
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: zxc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tiago-macedo
+autorequire: 
+bindir: exe
+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.
+email:
+- tiagomacedo@ufrj.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zxc.rb
+- lib/zxc/error.rb
+- lib/zxc/errors/unknown_step_error.rb
+- lib/zxc/errors/wrong_argument_number_error.rb
+- lib/zxc/node.rb
+- lib/zxc/step.rb
+- lib/zxc/steps/first.rb
+- lib/zxc/steps/last.rb
+- lib/zxc/steps/match.rb
+- lib/zxc/steps/match_regexp.rb
+- lib/zxc/steps/present.rb
+- lib/zxc/steps/print.rb
+- lib/zxc/steps/print_tree.rb
+- lib/zxc/steps/split.rb
+- lib/zxc/steps/split_regexp.rb
+- lib/zxc/version.rb
+- man/zxc.1
+- sig/zxc.rbs
+homepage: https://github.com/tiago-macedo/zxc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tiago-macedo/zxc
+  source_code_uri: https://github.com/tiago-macedo/zxc
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: A little ruby program to quickly manipulate STDIN on the command line
+test_files: []