jrf 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f0245d91775670ab95a99001709aacb8f216f3a5a2ed245a551eeafa7df5e70
-  data.tar.gz: b535e57a4bb22c37388353282ef7f2bb748251b153abf53e878062b7cc64694b
+  metadata.gz: 2776f201f13bf8be05ec4615510f0810ceeff9115dd11ef4d54ed873c9c90030
+  data.tar.gz: 0b996f561536a47067d262122c3b1093fd9adfb499fc0fab7011226cee75f043
 SHA512:
-  metadata.gz: c9c9f7f3b0739d6037ceafabe8f1e1766b051686ab2c5c3fac51573944326b7356138fb6ae3eb9c719631ebc5947ca451a15cfebb9b4233668cc02cd0f78bda0
-  data.tar.gz: 2f1e4fd6fc91596adbf5f4221c8a5adf1b443d547b1019032e3961e1424ac9c05826c2db838ab2ed9b09ac4c980291110319ab23938be868850e6afa24d7b277
+  metadata.gz: bde0a34fdeb324132084a7621bc2a37767a506261dbafadfdebbeb7fc060a2e8a142c44132ed5228a2604a5dba767871d39303eb3aa941510ba0d3f2694d5e7e
+  data.tar.gz: 725b4611d5659ce994df183950676a7c8ff2582df7b02cbc0bf7ef47682ca2bf2f55507df10c6e907a1032c6b4dcd17625b4db807f28d304a331f0caf4c8a1cd

data/Rakefile

@@ -8,3 +8,8 @@ Rake::TestTask.new do |t|
 end
 
 task default: :test
+
+desc "Build man/jrf.1 from README.md"
+task :man do
+  ruby "script/build_man_from_readme.rb"
+end

data/jrf.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = ["n/a@example.com"]
 
   spec.summary = "JSON filter with the power and speed of Ruby"
-  spec.description = "A JSON filter for NDJSON that uses Ruby expressions for transforms, selection, and aggregation."
+  spec.description = "jrf is a JSON filter with the power and speed of Ruby. It lets you write transforms as Ruby expressions, so you can use arbitrary Ruby logic. It supports extraction, filtering, flattening, sorting, and aggregation in stage pipelines."
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0"
 

data/lib/jrf/cli.rb

@@ -4,23 +4,53 @@ require_relative "runner"
 
 module Jrf
   class CLI
+    USAGE = "usage: jrf [-v] [--help] 'STAGE >> STAGE >> ...'"
+
+    HELP_TEXT = <<~'TEXT'
+      usage: jrf [-v] [--help] 'STAGE >> STAGE >> ...'
+
+      JSON filter with the power and speed of Ruby.
+
+      Options:
+        -v, --verbose  print compiled stage Ruby expressions
+        -h, --help     show this help and exit
+
+      Pipeline:
+        Connect stages with top-level >>.
+        The current value in each stage is available as _.
+
+      Examples:
+        jrf '_["foo"]'
+        jrf 'select(_["x"] > 10) >> _["foo"]'
+        jrf '_["items"] >> flat'
+        jrf 'sort(_["at"]) >> _["id"]'
+        jrf '_["msg"] >> reduce(nil) { |acc, v| acc ? "#{acc} #{v}" : v }'
+
+      See Also:
+        README.md
+        man jrf
+    TEXT
+
     def self.run(argv = ARGV, input: ARGF, out: $stdout, err: $stderr)
       verbose = false
 
       while argv.first&.start_with?("-")
         case argv.first
-        when "-v"
+        when "-v", "--verbose"
           verbose = true
           argv.shift
+        when "-h", "--help"
+          out.puts HELP_TEXT
+          return 0
         else
           err.puts "unknown option: #{argv.first}"
-          err.puts "usage: jrf [-v] 'EXPR'"
+          err.puts USAGE
           return 1
         end
       end
 
       if argv.empty?
-        err.puts "usage: jrf [-v] 'EXPR'"
+        err.puts USAGE
         return 1
       end
 

data/lib/jrf/version.rb

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

data/test/jrf_test.rb

@@ -93,6 +93,23 @@ assert_includes(stderr, "stage[1] kind=extract")
 assert_includes(stderr, 'original: _["hello"]')
 assert_includes(stderr, 'ruby: _["hello"]')
 
+stdout, stderr, status = Open3.capture3("./exe/jrf", "--help")
+assert_success(status, stderr, "help option")
+assert_includes(stdout, "usage: jrf [-v] [--help] 'STAGE >> STAGE >> ...'")
+assert_includes(stdout, "JSON filter with the power and speed of Ruby.")
+assert_includes(stdout, "Pipeline:")
+assert_includes(stdout, "Connect stages with top-level >>.")
+assert_includes(stdout, "The current value in each stage is available as _.")
+assert_includes(stdout, "See Also:")
+assert_includes(stdout, "README.md")
+assert_includes(stdout, "man jrf")
+assert_equal([], lines(stderr), "help stderr output")
+
+stdout, stderr, status = run_jrf('select(_["hello"] == 123) >> _["hello"]', input_hello, "--verbose")
+assert_success(status, stderr, "dump stages verbose alias")
+assert_equal(%w[123], lines(stdout), "dump stages verbose alias output")
+assert_includes(stderr, "stage[0] kind=select")
+
 input_regex = <<~NDJSON
   {"foo":{"bar":"ok"},"x":50}
   {"foo":{"bar":"ng"},"x":70}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jrf
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - kazuho
@@ -9,8 +9,9 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: A JSON filter for NDJSON that uses Ruby expressions for transforms, selection,
-  and aggregation.
+description: jrf is a JSON filter with the power and speed of Ruby. It lets you write
+  transforms as Ruby expressions, so you can use arbitrary Ruby logic. It supports
+  extraction, filtering, flattening, sorting, and aggregation in stage pipelines.
 email:
 - n/a@example.com
 executables: