inkplot 0.1.0

data/lib/inkplot/version.rb

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

data/lib/inkplot.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "inkplot/version"
+require_relative "inkplot/core"
+require_relative "inkplot/renderers/svg"
+
+module Inkplot
+  class Error < StandardError; end
+
+  class Config
+    attr_accessor :font
+  end
+
+  Series = Struct.new(:type, :points, :label, :color, :options, keyword_init: true)
+  Scene = Struct.new(:width, :height, :background, :clip, :marks, :elements, keyword_init: true)
+
+  class << self
+    def config = @config ||= Config.new
+
+    def plot(width: 640, height: 360, theme: :light, **)
+      builder = Builder.new(width: width, height: height, theme: theme, **)
+      yield builder if block_given?
+      Chart.new(builder)
+    end
+
+    def line(data, values = nil, x: nil, y: nil, color: nil, title: nil, x_label: nil, y_label: nil, **)
+      quick(:line, data, values, x:, y:, color:, title:, x_label:, y_label:, **)
+    end
+
+    def scatter(data, values = nil, x: nil, y: nil, size: nil, color: nil, title: nil, x_label: nil, y_label: nil, **)
+      quick(:scatter, data, values, x:, y:, size:, color:, title:, x_label:, y_label:, **)
+    end
+
+    def bar(data, horizontal: false, title: nil, x_label: nil, y_label: nil, **options)
+      chart_options, mark_options = options.partition { |key, _| %i[width height theme].include?(key) }.map(&:to_h)
+      builder = Builder.new(**chart_options, title:, x_label:, y_label:)
+      if horizontal
+        builder.bar(data, horizontal: true, **mark_options)
+      else
+        builder.bar(data, **mark_options)
+      end
+      Chart.new(builder)
+    end
+
+    def sparkline(values)
+      values = values.filter_map { |value| Data.number(value) }
+      return "" if values.empty?
+
+      low, high = values.minmax
+      glyphs = "▁▂▃▄▅▆▇█"
+      return glyphs[3] * values.length if low == high
+
+      values.map { |value| glyphs[((value - low) / (high - low) * 7).round] }.join
+    end
+
+    private
+
+    def quick(type, data, values = nil, x:, y:, size: nil, color: nil, title: nil, x_label: nil, y_label: nil, **options)
+      chart_options, mark_options = options.partition { |key, _| %i[width height theme].include?(key) }.map(&:to_h)
+      builder = Builder.new(**chart_options, title:, x_label:, y_label:)
+      if color && Data.records?(data)
+        Data.rows(data, x:, y:, size:, group: color).group_by { |point| point[:group] }.each do |group, points|
+          builder.add(type, points, label: group.to_s, **mark_options)
+        end
+      else
+        builder.add(type, Data.points(data, values, x:, y:, size:), **mark_options)
+      end
+      Chart.new(builder)
+    end
+  end
+end

data/sig/inkplot.rbs

@@ -0,0 +1,36 @@
+module Inkplot
+  VERSION: String
+
+  class Config
+    attr_accessor font: String?
+  end
+
+  class Builder
+    def title: (String value) -> String
+    def x_axis: (?label: String?, ?type: Symbol?, ?scale: Symbol?, ?min: untyped, ?max: untyped, ?order: Array[untyped]?) -> Hash[Symbol, untyped]
+    def y_axis: (?label: String?, ?type: Symbol?, ?scale: Symbol?, ?min: untyped, ?max: untyped) -> Hash[Symbol, untyped]
+    def legend: (?position: Symbol) -> Hash[Symbol, Symbol]
+    def line: (untyped x, ?untyped y, ?label: String?, ?color: String?, ?dash: bool, ?gaps: Symbol, **untyped options) -> Builder
+    def scatter: (untyped x, ?untyped y, ?label: String?, ?color: String?, ?size: untyped, **untyped options) -> Builder
+    def area: (untyped x, ?untyped y, ?label: String?, ?color: String?, **untyped options) -> Builder
+    def step: (untyped x, ?untyped y, ?label: String?, ?color: String?, **untyped options) -> Builder
+    def bar: (untyped categories, ?untyped values, ?label: String?, ?color: String?, ?horizontal: bool, ?stacked: bool, **untyped options) -> Builder
+    def hline: (Numeric value, ?label: String?, ?color: String?, ?dash: bool) -> Array[Hash[Symbol, untyped]]
+    def vline: (untyped value, ?label: String?, ?color: String?, ?dash: bool) -> Array[Hash[Symbol, untyped]]
+  end
+
+  class Chart
+    attr_reader builder: Builder
+    attr_reader width: Integer
+    attr_reader height: Integer
+    def to_svg: (?width: Integer, ?height: Integer) -> String
+    def save: (String | _Path path, ?width: Integer, ?height: Integer) -> String | _Path
+  end
+
+  def self.config: () -> Config
+  def self.plot: (?width: Integer, ?height: Integer, ?theme: Symbol, **untyped options) { (Builder) -> void } -> Chart
+  def self.line: (untyped data, ?untyped values, ?x: untyped, ?y: untyped, ?color: untyped, ?title: String?, ?x_label: String?, ?y_label: String?, **untyped options) -> Chart
+  def self.scatter: (untyped data, ?untyped values, ?x: untyped, ?y: untyped, ?size: untyped, ?color: untyped, ?title: String?, ?x_label: String?, ?y_label: String?, **untyped options) -> Chart
+  def self.bar: (untyped data, ?horizontal: bool, ?title: String?, ?x_label: String?, ?y_label: String?, **untyped options) -> Chart
+  def self.sparkline: (Array[untyped] values) -> String
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: inkplot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yudai Takada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Build line, bar, scatter, and other charts as standalone SVG.
+email:
+- t.yudai92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bench/inkplot.rb
+- examples/gallery.rb
+- examples/gallery/01-line.svg
+- examples/gallery/02-line-gaps.svg
+- examples/gallery/03-series.svg
+- examples/gallery/04-scatter.svg
+- examples/gallery/05-bars.svg
+- examples/gallery/06-horizontal-bars.svg
+- examples/gallery/07-grouped-bars.svg
+- examples/gallery/08-stacked-bars.svg
+- examples/gallery/10-area.svg
+- examples/gallery/11-step.svg
+- examples/gallery/README.md
+- lib/inkplot.rb
+- lib/inkplot/core.rb
+- lib/inkplot/renderers/svg.rb
+- lib/inkplot/version.rb
+- sig/inkplot.rbs
+homepage: https://github.com/rbgfx/inkplot
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rbgfx/inkplot
+  source_code_uri: https://github.com/rbgfx/inkplot/tree/main
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: SVG charts for Ruby
+test_files: []