ruby-gr 0.0.24 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54882caa13673ab79c5589d9ba8fcd02d3fef5adb0b2ad820e4aa75dc6894273
-  data.tar.gz: 5d57cc79475d98ac75c4fef19d3af024085774ca835978b79d878fb49873e267
+  metadata.gz: 684689c3494cbf841d908396c562fb418796d25afabd0a5d9c58497a8dca6a32
+  data.tar.gz: 3274ea957c350ddc0ec0abd5c260e54e933ab80930dba7bf5252d807bc47c770
 SHA512:
-  metadata.gz: 5b22d5d24b5fba2fa5f806543cc513e4a4d12f7d416f7aa94b3378b7deccef5974dcaf0454afd6e0bfcb6a07322ea6fce71067c9da4eb3b7188f680e0affbf3d
-  data.tar.gz: 4fef6ebc51e3ff253e59017c85c8d8d9ac2a56c8000a628944603c4e3645365283a403e09dbec0a7fe654353cd8f418bcfa8fbf9e5f3cd37de11eaee2b900d3a
+  metadata.gz: 00b957ba8bf7f2f63b67cba456fd0016a8cc18503bbee605e3f02001e61ee377d02d7800eaacfe3077878a3cb92b8ecd9987378a40acae018ddc2428f699f2c4
+  data.tar.gz: ed6aaaf3a5ca30ecdf5695623b36036afe00610c720bef330ae25922fce12ad7c76a42ff8801066c3dccf4d973a77d83861651998b7da960c4b5bea7d236fa47

data/LICENSE.txt

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 kojix2
-Copyright (c) 2019 Red Data Tools
+Copyright (c) 2019 - present kojix2
+Copyright (c) 2019 - present 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

data/README.md

@@ -1,6 +1,7 @@
 # GR.rb
 
-[![Gem Version](https://badge.fury.io/rb/ruby-gr.svg)](https://badge.fury.io/rb/ruby-gr)
+[![Gem Version](https://img.shields.io/gem/v/ruby-gr?color=brightgreen)](https://rubygems.org/gems/ruby-gr)
+[![CI](https://github.com/red-data-tools/GR.rb/workflows/CI/badge.svg)](https://github.com/red-data-tools/GR.rb/actions)
 [![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)
 
@@ -31,8 +32,7 @@ First, [install GR](#gr-installation). Then install `ruby-gr` gem.
 ```sh
 gem install ruby-gr
 ```
-
-Note: If you are using Rubyinstaller(Windows), pacman will automatically install [mingw-w64-gr](https://packages.msys2.org/base/mingw-w64-gr).
+Note: If you are using [RubyInstaller](https://rubyinstaller.org/) (Windows), pacman will automatically install [mingw-w64-gr](https://packages.msys2.org/base/mingw-w64-gr).
 
 Set environment variable `GRDIR`. 
 
@@ -196,6 +196,9 @@ GR.rb will be the default backend for [Charty](https://github.com/red-data-tools
 
 ## Contributing
 
+GR.rb is a library under development, so even small improvements like typofix are welcome!
+Please feel free to send us your PR.
+
 * [Report bugs](https://github.com/red-data-tools/GR.rb/issues)
 * Fix bugs and [submit pull requests](https://github.com/red-data-tools/GR.rb/pulls)
 * Write, clarify, or fix documentation

data/lib/gr.rb

@@ -48,23 +48,33 @@
 module GR
   class Error < StandardError; end
 
+  class NotFoundError < Error; end
+
   class << self
     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)
+  # MacOSX    |  lib/libGR.so (v0.53.0 .so)
   # Ubuntu    |  lib/libGR.so
-  self.ffi_lib = case RbConfig::CONFIG['host_os']
-                 when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-                   search_shared_library('libgr.dll', 'gr')
-                 else
-                   search_shared_library('libGR.so', 'gr')
-                 end
+  platform = RbConfig::CONFIG['host_os']
+  lib_names, pkg_name = \
+    case platform
+    when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+      [['libGR.dll'], 'gr']
+    when /darwin|mac os/
+      [['libGR.dylib', 'libGR.so'], 'gr']
+    else
+      [['libGR.so'], 'gr']
+    end
+  lib_path = GRCommons::GRLib.search(lib_names, pkg_name)
+
+  raise NotFoundError, "#{lib_names} not found" if lib_path.nil?
+
+  self.ffi_lib = lib_path
 
   require_relative 'gr/version'
   require_relative 'gr/ffi'
@@ -777,7 +787,7 @@ module GR
 
     # Set the clipping indicator.
     #
-    # @params indicator [Integer] An indicator specifying whether clipping is on
+    # @param indicator [Integer] An indicator specifying whether clipping is on
     #                             or off.
     # * 0 : Clipping is off. Data outside of the window will be drawn.
     # * 1 : Clipping is on. Data outside of the window will not be drawn.
@@ -1829,7 +1839,8 @@ module GR
     #  * 3 : INTERP2_CUBIC   - Cubic interpolation
     # @param extrapval [Numeric] The extrapolation value
     #
-    def interp2(x, y, z, xq, yq, method, extrapval) # flatten
+    # flatten
+    def interp2(x, y, z, xq, yq, method, extrapval)
       nx = x.length
       ny = y.length
       # nz = z.length

data/lib/gr/ffi.rb

@@ -15,7 +15,7 @@ module GR
       raise LoadError, 'Could not find GR Framework'
     end
 
-    extend GRCommons::Extern
+    extend GRCommons::TryExtern
 
     # https://github.com/sciapp/gr/blob/master/lib/gr/gr.h
     # keep same order
@@ -41,6 +41,8 @@ module GR
                'int, int, int, int, int, int, int *)'
     try_extern 'void gr_polarcellarray(double, double, double, double, double, double, ' \
                'int, int, int, int, int, int, int *)'
+    try_extern 'void gr_nonuniformpolarcellarray(double, double, double *, double *, ' \
+               'int, int, int, int, int, int, int *);'
     try_extern 'void gr_gdp(int, double *, double *, int, int, int *)'
     try_extern 'void gr_spline(int, double *, double *, int, int)'
     try_extern 'void gr_gridit(int, double *, double *, double *, int, int, ' \

data/lib/gr/plot.rb

@@ -239,10 +239,10 @@ module GR
         xmax += 0.5
       end
       xtick, majorx = if (scale & GR::OPTION_X_LOG) == 0
-                        unless %i[heatmap polarheatmap].include?(kind)
-                          unless kvs.has_key?(:xlim)
-                            xmin, xmax = GR.adjustlimits(xmin, xmax) unless kvs[:panzoom]
-                          end
+                        if !%i[heatmap polarheatmap].include?(kind) &&
+                           !kvs.has_key?(:xlim) &&
+                           !kvs[:panzoom]
+                          xmin, xmax = GR.adjustlimits(xmin, xmax)
                         end
                         if kvs.has_key?(:xticks)
                           kvs[:xticks]
@@ -268,10 +268,10 @@ module GR
         end
       end
       ytick, majory = if (scale & GR::OPTION_Y_LOG) == 0
-                        unless %i[heatmap polarheatmap].include?(kind)
-                          unless kvs.has_key?(:ylim)
-                            ymin, ymax = GR.adjustlimits(ymin, ymax) unless kvs[:panzoom]
-                          end
+                        if !%i[heatmap polarheatmap].include?(kind) &&
+                           !kvs.has_key?(:ylim) &&
+                           !kvs[:panzoom]
+                          ymin, ymax = GR.adjustlimits(ymin, ymax)
                         end
                         if kvs.has_key?(:yticks)
                           kvs[:yticks]
@@ -617,7 +617,7 @@ module GR
       if kvs.has_key?(:font)
         name = kvs[:font]
         # 'Cmuserif-Math' => :cmuserif_math
-        sym_name = name.to_s.gsub('-','_').downcase.to_sym 
+        sym_name = name.to_s.gsub('-', '_').downcase.to_sym
         if FONTS.include?(sym_name)
           font = FONTS[sym_name]
           GR.settextfontprec(font, font > 200 ? 3 : 0)

data/lib/gr3.rb

@@ -58,23 +58,33 @@
 module GR3
   class Error < StandardError; end
 
+  class NotFoundError < Error; end
+
   class << self
     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)
+  # MacOSX    |  lib/libGR3.dylib (v0.53.0 .so)
   # Ubuntu    |  lib/libGR3.so
-  self.ffi_lib = case RbConfig::CONFIG['host_os']
-                 when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-                   search_shared_library('libGR3.dll', 'gr3')
-                 else
-                   search_shared_library('libGR3.so', 'gr3')
-                 end
+  platform = RbConfig::CONFIG['host_os']
+  lib_names, pkg_name = \
+    case platform
+    when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+      [['libGR3.dll'], 'gr3']
+    when /darwin|mac os/
+      [['libGR3.dylib', 'libGR3.so'], 'gr3']
+    else
+      [['libGR3.so'], 'gr3']
+    end
+  lib_path = GRCommons::GRLib.search(lib_names, pkg_name)
+
+  raise NotFoundError, "#{lib_names} not found" if lib_path.nil?
+
+  self.ffi_lib = lib_path
 
   require_relative 'gr3/version'
   require_relative 'gr3/ffi'

data/lib/gr3/ffi.rb

@@ -15,7 +15,7 @@ module GR3
       raise LoadError, 'Could not find GR Framework'
     end
 
-    extend GRCommons::Extern
+    extend GRCommons::TryExtern
 
     # https://github.com/sciapp/gr/blob/master/lib/gr3/gr3.h
     # keep same order

data/lib/gr_commons/gr_common_utils.rb

@@ -43,7 +43,7 @@ module GRCommons
       if narray?(data)
         Numo::Int32.cast(data).to_binary
       else
-        Fiddley::Utils.array2str(:int32, data.to_a.flatten) # TODO
+        Fiddley::Utils.array2str(:int32, data.to_a.flatten)
       end
     end
 
@@ -52,7 +52,7 @@ module GRCommons
       if narray?(data)
         Numo::UInt32.cast(data).to_binary
       else
-        Fiddley::Utils.array2str(:uint, data.to_a.flatten) # TODO
+        Fiddley::Utils.array2str(:uint32, data.to_a.flatten)
       end
     end
 

data/lib/gr_commons/gr_commons.rb

@@ -7,8 +7,8 @@ end
 # Change the default encoding to UTF-8.
 ENV['GKS_ENCODING'] ||= 'utf8'
 
-require_relative 'search_shared_library'
-require_relative 'extern'
+require_relative 'gr_lib'
+require_relative 'try_extern'
 require_relative 'define_methods'
 require_relative 'gr_common_utils'
 require_relative 'jupyter_support'

data/lib/gr_commons/gr_lib.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'pkg-config'
+
+module GRCommons
+  # This module helps GR, GR and GRM to search the shared library.
+  #
+  # The order of priority:
+  # 1. RubyInstaller ( for Windows only )
+  # 2. Environment variable GRDIR
+  # 3. pkg-config : https://github.com/ruby-gnome/pkg-config
+  # The following packages (should) support pkg-config.
+  # - Linux
+  #   - Red Data Tools https://github.com/red-data-tools/packages.red-data-tools.org
+  #     - libgr-dev
+  #     - libgr3-dev
+  #     - libgrm-dev
+  # - Mac
+  #   - Homebrew https://github.com/Homebrew/homebrew-core
+  #     - libgr
+  # - Windows
+  #   - MinGW https://github.com/msys2/MINGW-packages
+  #     - mingw-w64-gr
+  module GRLib
+    class << self
+      # Search the shared library.
+      # @note This method does not detect the Operating System.
+      #
+      # @param lib_names [Array] The actual file name of the shared library.
+      # @param pkg_name [String] The package name to be used when searching with pkg-configg
+      def search(lib_names, pkg_name)
+        def lib_names.map_find(&block)
+          lazy.map(&block).find { |path| path }
+        end
+        # Windows + RubyInstaller
+        if Object.const_defined?(:RubyInstaller)
+          dir = ENV['GRDIR'] || [
+            RubyInstaller::Runtime.msys2_installation.msys_path,
+            RubyInstaller::Runtime.msys2_installation.mingwarch
+          ].join(File::ALT_SEPARATOR)
+          lib_names.lazy.map do |lib_name|
+            recursive_search(lib_name, dir)
+          end.find { |i| i }.tap do |path|
+            RubyInstaller::Runtime.add_dll_directory(File.dirname(path)) if path
+          end
+        # ENV['GRDIR'] (Linux, Mac, Windows)
+        elsif ENV['GRDIR']
+          # Search for XXX.dylib and then XXX.so on macOS
+          lib_names.map_find do |lib_name|
+            recursive_search(lib_name, ENV['GRDIR'])
+          end || lib_names.map_find do |lib_name|
+            pkg_config_search(lib_name, pkg_name)
+          end
+        else
+          lib_names.map_find do |lib_name|
+            pkg_config_search(lib_name, pkg_name)
+          end
+        end
+      end
+
+      # Recursive file search in directories
+      # @param name [String] File to search for
+      # @param base_dir [String] Directory to search
+      # @retrun path [String, NilClass] Returns the first path found.
+      #                                 If not found, nil is returned.
+      def recursive_search(name, base_dir)
+        Dir.chdir(base_dir) do
+          paths = Dir["**/#{name}"].sort
+          warn "More than one file found: #{paths}" if paths.size > 1
+          path = paths.first
+          File.expand_path(path) if path
+        end
+      end
+
+      # Use pkg-config to search for shared libraries
+      def pkg_config_search(lib_name, pkg_name)
+        PKGConfig.variable(pkg_name, 'sopath')
+      rescue PackageConfig::NotFoundError => e
+        warn "#{e.message} Cannot find #{lib_name}. "
+      end
+    end
+  end
+end

data/lib/gr_commons/gr_logger.rb

@@ -11,7 +11,7 @@ require 'awesome_print'
 module GRCommons
   class << self
     # Create a new GRLogger
-    # @params out [String]
+    # @param out [String]
     # @return [GRLogger]
     # @example
     #   require 'gr_commons/gr_logger'

data/lib/gr_commons/{extern.rb → try_extern.rb}

@@ -2,7 +2,7 @@
 
 module GRCommons
   # This module records the names of the methods defined by Fiddle::Importer.
-  module Extern
+  module TryExtern
     attr_reader :ffi_methods
 
     # Improved extern method.

data/lib/gr_commons/version.rb

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

data/lib/grm.rb

@@ -17,23 +17,33 @@ end
 module GRM
   class Error < StandardError; end
 
+  class NotFoundError < Error; end
+
   class << self
     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)
+  # MacOSX    |  lib/libGRM.dylib (v0.53.0 .so)
   # Ubuntu    |  lib/libGRM.so
-  self.ffi_lib = case RbConfig::CONFIG['host_os']
-                 when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-                   search_shared_library('libGRM.dll', 'grm')
-                 else
-                   search_shared_library('libGRM.so', 'grm')
-                 end
+  platform = RbConfig::CONFIG['host_os']
+  lib_names, pkg_name = \
+    case platform
+    when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+      [['libGRM.dll'], 'grm']
+    when /darwin|mac os/
+      [['libGRM.dylib', 'libGRM.so'], 'grm']
+    else
+      [['libGRM.so'], 'grm']
+    end
+  lib_path = GRCommons::GRLib.search(lib_names, pkg_name)
+
+  raise NotFoundError, "#{lib_names} not found" if lib_path.nil?
+
+  self.ffi_lib = lib_path
 
   require_relative 'grm/version'
   require_relative 'grm/ffi'

data/lib/grm/ffi.rb

@@ -15,7 +15,7 @@ module GRM
       raise LoadError, 'Could not find GR Framework'
     end
 
-    extend GRCommons::Extern
+    extend GRCommons::TryExtern
 
     # Currently, the declarations of GRM functions are distributed in several
     # header files.
@@ -28,6 +28,7 @@ module GRM
     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)'
+    typealias 'grm_args_ptr_t', 'void*'
     try_extern 'grm_args_ptr_t grm_length(double value, const char *unit)'
 
     # https://github.com/sciapp/gr/blob/master/lib/grm/dump.h
@@ -36,13 +37,17 @@ module GRM
     try_extern 'char *grm_dump_json_str(void)'
 
     # https://github.com/sciapp/gr/blob/master/lib/grm/event.h
+    typealias 'grm_event_type_t', 'int' # enum
+    typealias 'grm_event_callback_t', 'void*'
     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
+    # FIXME: https://github.com/ruby/fiddle/issues/68
+    typealias 'const_int', 'int' # FIXME
     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)' # FIXME
+    try_extern 'grm_tooltip_info_t *grm_get_tooltip(const_int, const_int)' # FIXME
 
     # 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,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 0.0.25
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: histogram
@@ -154,13 +154,13 @@ files:
 - lib/gr3/gr3base.rb
 - lib/gr3/version.rb
 - lib/gr_commons/define_methods.rb
-- lib/gr_commons/extern.rb
 - lib/gr_commons/fiddley.rb
 - lib/gr_commons/gr_common_utils.rb
 - lib/gr_commons/gr_commons.rb
+- lib/gr_commons/gr_lib.rb
 - lib/gr_commons/gr_logger.rb
 - lib/gr_commons/jupyter_support.rb
-- lib/gr_commons/search_shared_library.rb
+- lib/gr_commons/try_extern.rb
 - lib/gr_commons/version.rb
 - lib/grm.rb
 - lib/grm/ffi.rb
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: GR for Ruby

data/lib/gr_commons/search_shared_library.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require 'pkg-config'
-
-module GRCommons
-  # This module helps GR, GR and GRM to search the shared library.
-  #
-  # The order of priority:
-  # 1. RubyInstaller ( for Windows only )
-  # 2. Environment variable GRDIR
-  # 3. pkg-config : https://github.com/ruby-gnome/pkg-config
-  # The following packages (should) support pkg-config.
-  # - Linux
-  #   - Red Data Tools https://github.com/red-data-tools/packages.red-data-tools.org
-  #     - libgr-dev
-  #     - libgr3-dev
-  #     - libgrm-dev
-  # - Mac
-  #   - Homebrew https://github.com/Homebrew/homebrew-core
-  #     - libgr
-  # - Windows
-  #   - MinGW https://github.com/msys2/MINGW-packages
-  #     - mingw-w64-gr
-  module SearchSharedLibrary
-    # Search the shared library.
-    # @note This method does not detect the Operating System.
-    #
-    # @param gr_lib_name [String] The actual file name of the shared library.
-    # @param pkg_name [String] The package name to be used when searching with pkg-configg
-    def search_shared_library(gr_lib_name, pkg_name)
-      # Windows + RubyInstaller
-      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
-      # ENV['GRDIR'] (Linux, Mac, Windows)
-      elsif ENV['GRDIR']
-        begin
-          recursive_search(gr_lib_name, ENV['GRDIR'])
-        rescue StandardError => e
-          warn "\nWhile searching for #{gr_lib_name} in the directory specified " \
-               "in the GRDIR environment variable, ENV['GRDIR']=#{ENV['GRDIR']}, " \
-               "the following error occurred : #{e.message}"
-          pkg_config_search(gr_lib_name, pkg_name)
-        end
-      else
-        pkg_config_search(gr_lib_name, pkg_name)
-      end
-    end
-
-    def recursive_search(name, base_dir)
-      Dir.chdir(base_dir) do
-        path = Dir["**/#{name}"].first # FIXME
-        if path
-          File.expand_path(path)
-        else
-          raise "#{name} not found in #{base_dir}"
-        end
-      end
-    end
-
-    def pkg_config_search(gr_lib_name, pkg_name)
-      PKGConfig.variable(pkg_name, 'sopath')
-    rescue PackageConfig::NotFoundError => e
-      raise "#{e.message} Cannot find #{gr_lib_name}. " \
-            "Please Make sure that GR is installed and the environment ” \
-            ”variable GRDIR is set correctly."
-    end
-  end
-end