ruby-gr 0.0.20 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29a78c0f4c5e3ab3afdc4245ab4dd6d9ce7d6c4f38638901a93487e366c219c6
-  data.tar.gz: 72f3fb64d9508c28338214583b185c041362f3e8b31a138ab9990cba4669b27a
+  metadata.gz: 20591722440c58b4cea29effed6bd13debcdc2c0383b40163d5b2fbc3f517f3e
+  data.tar.gz: 635fa83b40177e1c80936ca7fd949e2f2880c50710565db24e6e049f168d18ea
 SHA512:
-  metadata.gz: e0b0766224a375477115ff004467b4b5196689bff28846efabd31f078bd7f36d00a5f736e088f0a8333327d9eb6f8d80e398365e79d26e99f6303e2975b66c1c
-  data.tar.gz: 69dbc6bc3859bad4e3d67c2d2131b48c41c659e79c2f9b8b0f3250fb15cb94a3c29cc0b10c217fd1b354784ac969f2d82d9be256f59e5f0224d4d597b94ea131
+  metadata.gz: b30985a6bc12803fd2aabc590ffaccf4a4b931a5d00bb1c8c443fec90fd60f799560edbe3454532650871a578222c3aafb6d949204fb74b4efc22b3ddc5b197e
+  data.tar.gz: 61e34d2541e1821f739d5c12be8524b9fbc7e0332223c2c89cda40b0f38fc2eaa3ad695e5dca2fd5c955ee1bc04f07d0c235a7ce6a59f11b093ea7707f68e31f

data/README.md

@@ -6,27 +6,27 @@
 [![Gitter Chat](https://badges.gitter.im/red-data-tools/en.svg)](https://gitter.im/red-data-tools/en)
 [![Docs Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://rubydoc.info/gems/ruby-gr)
 
-![rdatasets-1](https://i.imgur.com/XEQ6wKs.png)
-![stem](https://i.imgur.com/3w0Ejrm.png)
-![histogram](https://i.imgur.com/xUdoA2s.png)
-![barplot](https://i.imgur.com/52bOFKE.png)
-![scatter3](https://i.imgur.com/yTTVetQ.png)
-![volume](https://i.imgur.com/CuRN6oC.png)
-![griddata](https://i.imgur.com/58HdYDo.png)
-![2darray](https://i.imgur.com/aKR2FJG.png)
-![2dpolararray](https://i.imgur.com/cmSrxvS.png)
-![hexbin](https://i.imgur.com/unWhQHr.png)
-![rdatasets-2](https://i.imgur.com/ZPit2F5.png)
-![rdatasets-3](https://i.imgur.com/TbNoxwy.png)
-![surface](https://i.imgur.com/sWdaHme.png)
-![face](https://i.imgur.com/uLCKi2r.png)
-![shade](https://i.imgur.com/VJmS3EQ.png)
+[![rdatasets-1](https://i.imgur.com/XEQ6wKs.png)](examples/rdatasets.rb)
+[![stem](https://i.imgur.com/3w0Ejrm.png)](examples/fast_plots.rb)
+[![histogram](https://i.imgur.com/xUdoA2s.png)](examples/fast_plots.rb)
+[![barplot](https://i.imgur.com/52bOFKE.png)](examples/fast_plots.rb)
+[![scatter3](https://i.imgur.com/yTTVetQ.png)](examples/fast_plots.rb)
+[![volume](https://i.imgur.com/CuRN6oC.png)](examples/fast_plots.rb)
+[![griddata](https://i.imgur.com/58HdYDo.png)](examples/griddata.rb)
+[![2darray](https://i.imgur.com/aKR2FJG.png)](examples/2darray.rb)
+[![2dpolararray](https://i.imgur.com/cmSrxvS.png)](examples/2dpolararray.rb)
+[![hexbin](https://i.imgur.com/unWhQHr.png)](examples/hexbin.rb)
+[![rdatasets-2](https://i.imgur.com/ZPit2F5.png)](examples/rdatasets.rb)
+[![rdatasets-3](https://i.imgur.com/TbNoxwy.png)](examples/rdatasets.rb)
+[![surface](https://i.imgur.com/sWdaHme.png)](examples/kws2.rb)
+[![face](https://i.imgur.com/uLCKi2r.png)](examples/face.rb)
+[![shade](https://i.imgur.com/VJmS3EQ.png)](examples/shade_ex.rb)
 
 :bar_chart:  [GR framework](https://github.com/sciapp/gr) - powerful visualization library - for Ruby
 
 ## Installation
 
-GR.rb supports Ruby 2.4+.
+GR.rb supports Ruby 2.5+.
 
 First, [install GR](#gr-installation). Next, set environment variable `GRDIR`. 
 
@@ -83,7 +83,7 @@ GR.savefig("figure.png")
 
 ## API Overview
 
-There are two different approaches to plotting with GR.rb. One way is to call Matlab-like APIs. The other is to call GR/GR3 native functions. We are planning to prepare a more object-oriented interface based on [GRUtils.jl](https://github.com/heliosdrm/GRUtils.jl) in the future.
+There are two different approaches to plotting with GR.rb. One way is to call Matlab-like APIs. The other is to call GR/GR3 native functions. We are planning to prepare a [more object-oriented interface](https://github.com/kojix2/GRUtils.rb) based on [GRUtils.jl](https://github.com/heliosdrm/GRUtils.jl) in the future.
 
 #### GR::Plot - A simple, matlab-style API. 
 

data/lib/gr.rb

@@ -52,27 +52,20 @@ module GR
     attr_accessor :ffi_lib
   end
 
+  require_relative 'gr_commons/gr_commons'
+  extend GRCommons::SearchSharedLibrary
+
   # Platforms |  path
   # Windows   |  bin/libgr.dll
   # MacOSX    |  lib/libGR.so (NOT .dylib)
   # Ubuntu    |  lib/libGR.so
-  if Object.const_defined?(:RubyInstaller)
-    ENV['GRDIR'] ||= [
-      RubyInstaller::Runtime.msys2_installation.msys_path,
-      RubyInstaller::Runtime.msys2_installation.mingwarch
-    ].join(File::ALT_SEPARATOR)
-    self.ffi_lib = File.expand_path('bin/libgr.dll', ENV['GRDIR'])
-    RubyInstaller::Runtime.add_dll_directory(File.dirname(ffi_lib))
-  else
-    raise Error, 'Please set env variable GRDIR' unless ENV['GRDIR']
-
-    self.ffi_lib = File.expand_path('lib/libGR.so', ENV['GRDIR'])
-  end
-
-  # Change the default encoding to UTF-8.
-  ENV['GKS_ENCODING'] ||= 'utf8'
+  self.ffi_lib = case RbConfig::CONFIG['host_os']
+                 when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                   search_shared_library('libgr.dll')
+                 else
+                   search_shared_library('libGR.so')
+                 end
 
-  require_relative 'gr_commons/gr_commons'
   require_relative 'gr/version'
   require_relative 'gr/ffi'
   require_relative 'gr/grbase'
@@ -509,6 +502,8 @@ module GR
     #  * 129 : FONT_PALATINO_BOLDITALIC
     #  * 130 : FONT_ZAPFCHANCERY_MEDIUMITALIC
     #  * 131 : FONT_ZAPFDINGBATS
+    #  * 232 : FONT_COMPUTERMODERN
+    #  * 233 : FONT_DEJAVUSANS
     # @param precision [Integer] Text precision
     #  * 0 : TEXT_PRECISION_STRING
     #    *   String precision (higher quality)
@@ -516,6 +511,8 @@ module GR
     #    *   Character precision (medium quality)
     #  * 2 : TEXT_PRECISION_STROKE
     #    *   Stroke precision (lower quality)
+    #  * 3 : TEXT_PRECISION_OUTLINE
+    #    *   Outline precision (highest quality)
     # The appearance of a font depends on the text precision value specified.
     # STRING, CHARACTER or STROKE precision allows for a greater or lesser
     # realization of the text primitives, for efficiency. STRING is the default
@@ -561,6 +558,14 @@ module GR
       super
     end
 
+    # Gets the current character height.
+    # This function gets the height of text output primitives. Text height is
+    # defined as a percentage of the default window. GR uses the default text
+    # height of 0.027 (2.7% of the height of the default window).
+    def inqcharheight
+      inquiry_double { |pt| super(pt) }
+    end
+
     # Set the current character text angle up vector.
     # @param ux [Numeric] Text up vector
     # @param uy [Numeric] Text up vector

data/lib/gr/plot.rb

@@ -62,7 +62,7 @@ module GR
       # label(singular form) is a original keyword arg which GR.jl does not have.
       kvs[:labels] ||= [kvs[:label]] if kvs.has_key? :label
 
-      # Don't use || because we need to tell `false` from `nil`
+      # Don't use ||= here, because we need to tell `false` from `nil`
       kvs[:size]    = [600, 450]   unless kvs.has_key? :size
       kvs[:ax]      = false        unless kvs.has_key? :ax
       kvs[:subplot] = [0, 1, 0, 1] unless kvs.has_key? :subplot
@@ -185,8 +185,12 @@ module GR
         minmax
       end
 
-      major_count = %i[wireframe surface plot3 scatter3 polar polarhist
-                       polarheatmap trisurf volume].include?(kind) ? 2 : 5
+      major_count = if %i[wireframe surface plot3 scatter3 polar polarhist
+                          polarheatmap trisurf volume].include?(kind)
+                      2
+                    else
+                      5
+                    end
 
       kvs[:xticks] = [kvs[:xticks], major_count] if kvs[:xticks].is_a? Numeric
       kvs[:yticks] = [kvs[:yticks], major_count] if kvs[:yticks].is_a? Numeric
@@ -573,7 +577,9 @@ module GR
         # Not yet.
       end
 
-      GR.settextfontprec(232, 3)
+      # The following fonts are the default in GR.jl
+      # Japanese, Chinese, Korean, etc. cannot be displayed.
+      # GR.settextfontprec(232, 3) # CM Serif Roman
 
       set_viewport(kind, kvs[:subplot])
       unless kvs[:ax]
@@ -641,8 +647,7 @@ module GR
           if z || c
             if c
               cmin, cmax = kvs[:crange]
-              c = c.to_a if narray?(c)
-              c.map! { |i| normalize_color(i, cmin, cmax) }
+              c = c.map { |i| normalize_color(i, cmin, cmax) }
               cind = c.map { |i| (1000 + i * 255).round }
             end
             x.length.times do |i|
@@ -834,7 +839,7 @@ module GR
           GR.setmarkertype(GR::MARKERTYPE_SOLID_CIRCLE)
           if c
             cmin, cmax = kvs[:crange]
-            c = c.map { |i| normalize_color(i, cmin, cmax) } # NArray -> Array
+            c = c.map { |i| normalize_color(i, cmin, cmax) }
             cind = c.map { |i| (1000 + i * 255).round }
             x.length.times do |i|
               GR.setmarkercolorind(cind[i])
@@ -1040,7 +1045,9 @@ module GR
 
     # Normalize a color c with the range [cmin, cmax]
     #   0 <= normalize_color(c, cmin, cmax) <= 1
+    # Note: narray.map{|i| normalize_color(i)} There's room for speedup.
     def normalize_color(c, cmin, cmax)
+      c = c.to_f # if c is Integer
       c = c.clamp(cmin, cmax) - cmin
       c /= (cmax - cmin) if cmin != cmax
       c

data/lib/gr3.rb

@@ -60,27 +60,20 @@ module GR3
     attr_accessor :ffi_lib
   end
 
+  require_relative 'gr_commons/gr_commons'
+  extend GRCommons::SearchSharedLibrary
+
   # Platforms |  path
   # Windows   |  bin/libGR3.dll
   # MacOSX    |  lib/libGR3.so (NOT .dylib)
   # Ubuntu    |  lib/libGR3.so
-  if Object.const_defined?(:RubyInstaller)
-    ENV['GRDIR'] ||= [
-      RubyInstaller::Runtime.msys2_installation.msys_path,
-      RubyInstaller::Runtime.msys2_installation.mingwarch
-    ].join(File::ALT_SEPARATOR)
-    self.ffi_lib = File.expand_path('bin/libGR3.dll', ENV['GRDIR'])
-    RubyInstaller::Runtime.add_dll_directory(File.dirname(ffi_lib))
-  else
-    raise Error, 'Please set env variable GRDIR' unless ENV['GRDIR']
-
-    self.ffi_lib = File.expand_path('lib/libGR3.so', ENV['GRDIR'])
-  end
+  self.ffi_lib = case RbConfig::CONFIG['host_os']
+                 when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                   search_shared_library('libGR3.dll')
+                 else
+                   search_shared_library('libGR3.so')
+                 end
 
-  # change the default encoding to UTF-8.
-  ENV['GKS_ENCODING'] ||= 'utf8'
-
-  require_relative 'gr_commons/gr_commons'
   require_relative 'gr3/version'
   require_relative 'gr3/ffi'
   require_relative 'gr3/gr3base'

data/lib/gr_commons/fiddley.rb

@@ -13,7 +13,7 @@ module GRCommons
   # NOTE: This module is only part of the original code.
   # kojix2 adds, deletes, and modifies several methods.
   module Fiddley
-    # NOTE: GR.rb supports 2.4 +. Unpack 1 does not work under 2.3.
+    # NOTE: GR.rb supports 2.5 +. Unpack 1 does not work under 2.3.
 
     module Utils
       # assumes short = 16bit, int = 32bit, long long = 64bit

data/lib/gr_commons/gr_commons.rb

@@ -4,6 +4,10 @@
 module GRCommons
 end
 
+# Change the default encoding to UTF-8.
+ENV['GKS_ENCODING'] ||= 'utf8'
+
+require_relative 'search_shared_library'
 require_relative 'extern'
 require_relative 'define_methods'
 require_relative 'gr_common_utils'

data/lib/gr_commons/search_shared_library.rb

@@ -0,0 +1,31 @@
+module GRCommons
+  module SearchSharedLibrary
+    def search_shared_library(gr_lib_name)
+      if Object.const_defined?(:RubyInstaller)
+        ENV['GRDIR'] ||= [
+          RubyInstaller::Runtime.msys2_installation.msys_path,
+          RubyInstaller::Runtime.msys2_installation.mingwarch
+        ].join(File::ALT_SEPARATOR)
+        recursive_search(gr_lib_name, ENV['GRDIR']).tap do |path|
+          RubyInstaller::Runtime.add_dll_directory(File.dirname(path))
+        end
+      else
+        unless ENV['GRDIR']
+          warn 'Please set environment variable GRDIR'
+          exit 1
+        end
+        recursive_search(gr_lib_name, ENV['GRDIR'])
+      end
+    end
+
+    def recursive_search(name, base_dir)
+      Dir.chdir(base_dir) do
+        if path = Dir["**/#{name}"].first
+          File.expand_path(path)
+        else
+          raise StandardError '#{name} not found in #{base_dir}'
+        end
+      end
+    end
+  end
+end

data/lib/gr_commons/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GRCommons
-  VERSION = '0.0.20'
+  VERSION = '0.0.21'
 end

data/lib/grm.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+# Check Fiddle version.
+require 'fiddle'
+
+# Check if fiddle supports variadic arguments.
+# Fiddle is a standard Gem and may not have VERSION constant.
+if !Fiddle.const_defined?(:VERSION) ||
+   (Gem::Version.new(Fiddle::VERSION) <= Gem::Version.new('1.0.0'))
+  raise LoadError, <<~MSG
+    Failed to load GRM module
+    Fiddle 1.0.1 or higher is required to run GRM.
+    See https://github.com/ruby/fiddle
+  MSG
+end
+
 module GRM
   class Error < StandardError; end
 
@@ -7,27 +21,20 @@ module GRM
     attr_accessor :ffi_lib
   end
 
+  require_relative 'gr_commons/gr_commons'
+  extend GRCommons::SearchSharedLibrary
+
   # Platforms |  path
   # Windows   |  bin/libGRM.dll
   # MacOSX    |  lib/libGRM.so (NOT .dylib)
   # Ubuntu    |  lib/libGRM.so
-  if Object.const_defined?(:RubyInstaller)
-    ENV['GRDIR'] ||= [
-      RubyInstaller::Runtime.msys2_installation.msys_path,
-      RubyInstaller::Runtime.msys2_installation.mingwarch
-    ].join(File::ALT_SEPARATOR)
-    self.ffi_lib = File.expand_path('bin/libGRM.dll', ENV['GRDIR'])
-    RubyInstaller::Runtime.add_dll_directory(File.dirname(ffi_lib))
-  else
-    raise Error, 'Please set env variable GRDIR' unless ENV['GRDIR']
-
-    self.ffi_lib = File.expand_path('lib/libGRM.so', ENV['GRDIR'])
-  end
-
-  # change the default encoding to UTF-8.
-  ENV['GKS_ENCODING'] ||= 'utf8'
+  self.ffi_lib = case RbConfig::CONFIG['host_os']
+                 when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                   search_shared_library('libGRM.dll')
+                 else
+                   search_shared_library('libGRM.so')
+                 end
 
-  require_relative 'gr_commons/gr_commons'
   require_relative 'grm/version'
   require_relative 'grm/ffi'
   require_relative 'grm/grmbase'

data/lib/grm/ffi.rb

@@ -21,15 +21,14 @@ module GRM
     # header files.
 
     # https://github.com/sciapp/gr/blob/master/lib/grm/args.h
-
     try_extern 'grm_args_t *grm_args_new(void)'
     try_extern 'void grm_args_delete(grm_args_t *args)'
-    # Fiddle does not currently support variable-length arguments in C.
     try_extern 'int grm_args_push(grm_args_t *args, const char *key, const char *value_format, ...)'
     try_extern 'int grm_args_push_buf(grm_args_t *args, const char *key, const char *value_format, const void *buffer, int apply_padding)'
     try_extern 'int grm_args_contains(const grm_args_t *args, const char *keyword)'
     try_extern 'void grm_args_clear(grm_args_t *args)'
     try_extern 'void grm_args_remove(grm_args_t *args, const char *key)'
+    try_extern 'grm_args_ptr_t grm_length(double value, const char *unit)'
 
     # https://github.com/sciapp/gr/blob/master/lib/grm/dump.h
     try_extern 'void grm_dump(const grm_args_t *args, FILE *f)'
@@ -37,27 +36,38 @@ module GRM
     try_extern 'char *grm_dump_json_str(void)'
 
     # https://github.com/sciapp/gr/blob/master/lib/grm/event.h
-    # grm_event_type_t is an enum.
-    # In the original fiddley, there is code for an enum.
-    # But GR's fiddley doesn't have it.
-    # try_extern 'int grm_register(grm_event_type_t type, grm_event_callback_t callback)'
-    # try_extern 'int grm_unregister(grm_event_type_t type)'
+    try_extern 'int grm_register(grm_event_type_t type, grm_event_callback_t callback)'
+    try_extern 'int grm_unregister(grm_event_type_t type)'
 
     # https://github.com/sciapp/gr/blob/master/lib/grm/interaction.h
     try_extern 'int grm_input(const grm_args_t *input_args)'
-    # try_extern 'int grm_get_box(const int x1, const int y1, const int x2, const int y2, const int keep_aspect_ratio, int *x, int *y, int *w, int *h)'
-    # try_extern 'grm_tooltip_info_t *grm_get_tooltip(const int, const int)'
+    try_extern 'int grm_get_box(const int x1, const int y1, const int x2, const int y2, const int keep_aspect_ratio, int *x, int *y, int *w, int *h)'
+    try_extern 'grm_input(const grm_args_t *input_args)'
+    try_extern 'grm_tooltip_info_t *grm_get_tooltip(const int, const int)'
 
     # https://github.com/sciapp/gr/blob/master/lib/grm/net.h
-    # try_extern 'void *grm_open(int is_receiver, const char *name, unsigned int id,
-    #                            const char *(*custom_recv)(const char *, unsigned int),
-    #                            int (*custom_send)(const char *, unsigned int, const char *))
+    try_extern 'void *grm_open(int is_receiver, const char *name, unsigned int id,
+                               const char *(*custom_recv)(const char *, unsigned int),
+                               int (*custom_send)(const char *, unsigned int, const char *))'
     try_extern 'grm_args_t *grm_recv(const void *p, grm_args_t *args)'
-    # Fiddle does not currently support variable-length arguments in C.
     try_extern 'int grm_send(const void *p, const char *data_desc, ...)'
     try_extern 'int grm_send_buf(const void *p, const char *data_desc, const void *buffer, int apply_padding)'
     try_extern 'int grm_send_ref(const void *p, const char *key, char format, const void *ref, int len)'
     try_extern 'int grm_send_args(const void *p, const grm_args_t *args)'
     try_extern 'void grm_close(const void *p)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/plot.h
+    try_extern 'void grm_finalize(void)'
+    try_extern 'int grm_clear(void)'
+    try_extern 'unsigned int grm_max_plotid(void)'
+    try_extern 'int grm_merge(const grm_args_t *args)'
+    try_extern 'int grm_merge_extended(const grm_args_t *args, int hold, const char *identificator)'
+    try_extern 'int grm_merge_hold(const grm_args_t *args)'
+    try_extern 'int grm_merge_named(const grm_args_t *args, const char *identificator)'
+    try_extern 'int grm_plot(const grm_args_t *args)'
+    try_extern 'int grm_switch(unsigned int id)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/util.h
+    try_extern 'FILE *grm_get_stdout(void)'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.21
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-21 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: histogram
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fiddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +160,7 @@ files:
 - lib/gr_commons/gr_common_utils.rb
 - lib/gr_commons/gr_commons.rb
 - lib/gr_commons/jupyter_support.rb
+- lib/gr_commons/search_shared_library.rb
 - lib/gr_commons/version.rb
 - lib/grm.rb
 - lib/grm/ffi.rb
@@ -164,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="