Merge 764fb977f3 into 1c80af2b2f

As a first step toward adopting rbs for this project, added type a definition for a simple method.
More type definitions will be added incrementally.

.github/FUNDING.yml

@@ -1,2 +0,0 @@
-github: kojix2
-ko_fi: kojix2

.github/workflows/ci.yml

@@ -1,15 +1,15 @@
 name: test
-on: [push, pull_request]
+on: [push, pull_request, workflow_dispatch]
 jobs:
   build:
     name: ${{ matrix.os }} Ruby ${{ matrix.ruby }}
     runs-on: ${{ matrix.os }}-latest
     strategy:
       matrix:
-        os:   [ 'ubuntu', 'macos' ]
+        os: ["ubuntu", "macos"]
-        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2' ]
+        ruby: ["2.6", "2.7", "3.0", "3.1", "3.2", "3.3", "3.4", "head"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

.github/workflows/doc.yml

@@ -10,14 +10,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ruby
       - name: Generate document
         run: gem install -N yard && yard doc
       - name: Publish Documentation on GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./doc

Gemfile

@@ -5,6 +5,13 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in youplot.gemspec
 gemspec
 
+group :development do
+  if RUBY_VERSION >= '3.0'
+    gem 'steep', require: false
+    gem 'typeprof'
+  end
+end
+
 group :test do
   gem 'rake'
   gem 'simplecov'

LICENSE.txt

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2020 kojix2
+Copyright (c) 2025 Red Data Tools
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,7 +1,7 @@
 <div align="center">
   <img src="logo.svg">
   <hr>
-  <img alt="Build Status" src="https://github.com/red-data-tools/YouPlot/workflows/test/badge.svg">
+  <a href="https://github.com/red-data-tools/YouPlot/actions/workflows/ci.yml"><img alt="Build Status" src="https://github.com/red-data-tools/YouPlot/workflows/test/badge.svg"></a>
   <a href="https://rubygems.org/gems/youplot/"><img alt="Gem Version" src="https://badge.fury.io/rb/youplot.svg"></a>
   <a href="https://zenodo.org/badge/latestdoi/283230219"><img alt="DOI" src="https://zenodo.org/badge/283230219.svg"></a>
   <a href="https://rubydoc.info/gems/youplot/"><img alt="Docs Stable" src="https://img.shields.io/badge/docs-stable-blue.svg"></a>
@@ -15,6 +15,24 @@
 ## Installation
 
 ```
+brew install youplot
+```
+
+```
+gem install youplot
+```
+
+```
+nix shell nixpkgs#youplot
+```
+
+```
+guix install youplot
+```
+
+```
+conda install -c conda-forge ruby
+conda install -c conda-forge compilers
 gem install youplot
 ```
 
@@ -37,13 +55,20 @@ curl -sL https://git.io/ISLANDScsv \
   <img alt="barplot" src="https://user-images.githubusercontent.com/5798442/101999903-d36a2d00-3d24-11eb-9361-b89116f44122.png">
 </p>
 
+
+
+```sh
+# For offline user: Sorts files in a directory by size and shows a bar graph.
+ls -l | awk '{print $9, $5}' | sort -nk 2 | uplot bar -d ' '
+```
+
 ### histogram
 
 ```sh
 echo -e "from numpy import random;" \
         "n = random.randn(10000);"  \
         "print('\\\n'.join(str(i) for i in n))" \
-| python \
+| python3 \
 | uplot hist --nbins 20
 ```
 
@@ -63,6 +88,14 @@ curl -sL https://git.io/AirPassengers \
   <img alt="lineplot" src="https://user-images.githubusercontent.com/5798442/101999825-24c5ec80-3d24-11eb-99f4-c642e8d221bc.png">
 </p>
 
+```sh
+# For offline users: Calculates sin values (0-2*pi) and plots a sine wave.
+python3 -c '
+from math import sin, pi
+data = "\n".join(f"{i*pi/50}\t{sin(i*pi/50)}" for i in range(101))
+print(data)' | uplot line
+```
+
 ### scatter
 
 ```sh
@@ -75,6 +108,12 @@ curl -sL https://git.io/IRIStsv \
   <img alt="scatter" src="https://user-images.githubusercontent.com/5798442/101999827-27284680-3d24-11eb-9903-551857eaa69c.png">
 </p>
 
+
+```sh
+# For offline users
+cat test/fixtures/iris.csv | cut -f1-4 -d, | uplot scatter -H -d, -t IRIS
+```
+
 ### density
 
 ```sh
@@ -87,6 +126,11 @@ curl -sL https://git.io/IRIStsv \
   <img alt="density" src="https://user-images.githubusercontent.com/5798442/101999828-2abbcd80-3d24-11eb-902c-2f44266fa6ae.png">
 </p>
 
+```sh
+# For offline users
+cat test/fixtures/iris.csv | cut -f1-4 -d, | uplot density -H -d, -t IRIS
+```
+
 ### boxplot
 
 ```sh
@@ -99,8 +143,21 @@ curl -sL https://git.io/IRIStsv \
   <img alt="boxplot" src="https://user-images.githubusercontent.com/5798442/101999830-2e4f5480-3d24-11eb-8891-728c18bf5b35.png">
 </p>
 
+```sh
+# For offline users
+cat test/fixtures/iris.csv | cut -f1-4 -d, | uplot boxplot -H -d, -t IRIS
+```
+
 ### count
 
+Count processes by user ID.
+
+```sh
+ps aux | awk '{print $1}' | uplot count
+```
+
+Count the number of chromosomes where genes are located. 
+
 ```sh
 cat gencode.v35.annotation.gff3 \
 | grep -v '#' | grep 'gene' | cut -f1 \
@@ -111,7 +168,6 @@ cat gencode.v35.annotation.gff3 \
   <img alt="count" src="https://user-images.githubusercontent.com/5798442/101999832-30b1ae80-3d24-11eb-96fe-e5000bed1f5c.png">
 </p>
 
-In this example, YouPlot counts the number of chromosomes where genes are located. 
 * [GENCODE - Human Release](https://www.gencodegenes.org/human/)
 
 Note: `count` is not very fast because it runs in a Ruby script.
@@ -157,7 +213,7 @@ The following sub-commands are available.
 
 * `-o`
   * By default, the plot is output to **standard error output**.
-  * If you want to output to standard input, Use hyphen ` -o -` or no argument `uplot s -o | `.
+  * If you want to output to standard output, Use hyphen ` -o -` or no argument `uplot s -o | `.
 
 ### Output the input data
 
@@ -255,7 +311,7 @@ bundle exec exe/uplot      # Run youplot (Try out the edited code)
 
 ### Acknowledgements
 
-* [sampo grafiikka](https://jypg.net/sampo_grafiikka) - Project logo creation
+* [sampo grafiikka](https://lepo.sampo-grafiikka.com/) - Project logo creation
 * [yutaas](https://github.com/yutaas) - English proofreading
 
 ## License

Steepfile

@@ -0,0 +1,8 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  check "lib" # Directory name to check
+
+  configure_code_diagnostics(D::Ruby.silent) # `silent` diagnostics setting
+end

lib/youplot/parser.rb

@@ -189,7 +189,7 @@ module YouPlot
               scatter    s             draw a scatter plot
               density    d             draw a density plot
               boxplot    box           draw a horizontal boxplot
-              count      c             draw a baplot based on the number of
+              count      c             draw a barplot based on the number of
                                        occurrences (slow)
               colors     color         show the list of available colors
 

lib/youplot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YouPlot
-  VERSION = '0.4.5'
+  VERSION = '0.4.6'
 end

sig/youplot/backends/processing.rbs

@@ -0,0 +1,7 @@
+module YouPlot
+  module Backends
+    module Processing
+      def count_values: ([], ?tally: true, ?reverse: false) -> Array[Array[untyped]]
+    end
+  end
+end

youplot.gemspec

@@ -12,12 +12,13 @@ Gem::Specification.new do |spec|
   spec.description   = 'A command line tool for Unicode Plotting'
   spec.homepage      = 'https://github.com/red-data-tools/YouPlot'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.files         = Dir['*.{md,txt}', '{lib,exe}/**/*']
   spec.bindir        = 'exe'
   spec.executables   = %w[uplot youplot]
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'csv'
   spec.add_dependency 'unicode_plot', '>= 0.0.5'
 end