ruby-gr 0.0.24 → 0.61.0.0

data/lib/gr_commons/gr_logger.rb

@@ -5,41 +5,47 @@
 # It should not be loaded when gr_commons/gr_commons is loaded.
 
 require 'logger'
-require 'rainbow'
-require 'awesome_print'
+require 'pp'
 
 module GRCommons
+  # Convenience class methods
+
   class << self
     # Create a new GRLogger
-    # @params out [String]
+    # @param out [String]
     # @return [GRLogger]
     # @example
     #   require 'gr_commons/gr_logger'
     #   GRCommons.gr_log("log.txt")
+
     def gr_log(out = $stderr)
       GRCommons::GRLogger.new(out)
     end
 
     # Return the last created GRLogger
     # @return [GRLogger]
+
     def gr_logger
       GRCommons::GRLogger.logger
     end
   end
 
-  # Outputs function calls to GR Framework to a log file.
-  # Mainly used for debugging.
-  # @note This module is for those who want to see low-level function calls in GR.
+  # If GR.rb call native functions of the GR framework,
+  # it will be recorded in the log file.
+  #
+  # @note Mainly used by developers for debugging.
   #
   # = How it works　
-  # prepend a module named Inspector to the singular class
-  # of the FFI module. It will inspects the GR function call of the FFI module
+  # It prepend a module named Inspector to the singular class of the FFI module.
+  # It will inspects the GR function call of the FFI module
   #
   # @example
   #   require 'gr_commons/gr_logger'
-  #   GRCommons.gr_log("log.txt")
+  #   GRCommons::GRLogger.new("log.txt")
+
   class GRLogger < Logger
     # Return the last created GRLogger
+
     def self.logger
       @@logger ||= GRCommons::GRLogger.new
     end
@@ -51,13 +57,15 @@ module GRCommons
   end
 end
 
+# GR
+
 if Object.const_defined?(:GR)
   module GR
     module FFI
       module Inspector
         GR::FFI.ffi_methods.each do |s|
           define_method(s) do |*args|
-            GRCommons.gr_logger.info "GR::FFI.#{s}\n" + args.ai + "\n"
+            GRCommons.gr_logger.info "GR::FFI.#{s}\n#{args.pretty_inspect}\n"
             super(*args)
           end
         end
@@ -69,13 +77,15 @@ if Object.const_defined?(:GR)
   end
 end
 
+# GR3
+
 if Object.const_defined?(:GR3)
   module GR3
     module FFI
       module Inspector
         GR3::FFI.ffi_methods.each do |s|
           define_method(s) do |*args|
-            GRCommons.gr_logger.info "GR3::FFI.#{s}\n" + args.ai + "\n"
+            GRCommons.gr_logger.info "GR3::FFI.#{s}\n#{args.pretty_inspect}\n"
             super(*args)
           end
         end
@@ -87,13 +97,15 @@ if Object.const_defined?(:GR3)
   end
 end
 
+# GRM
+
 if Object.const_defined?(:GRM)
   module GRM
     module FFI
       module Inspector
         GRM::FFI.ffi_methods.each do |s|
           define_method(s) do |*args|
-            GRCommons.gr_logger.info "GRM::FFI.#{s}\n" + args.ai + "\n"
+            GRCommons.gr_logger.info "GRM::FFI.#{s}\n#{args.pretty_inspect}\n"
             super(*args)
           end
         end

data/lib/gr_commons/jupyter_support.rb

@@ -8,7 +8,7 @@ module GRCommons
       # Sets the environment variable when the module is extended.
       def self.extended(_obj)
         require 'tmpdir'
-        ENV['GKSwstype'] = 'svg'
+        ENV['GKS_WSTYPE'] = 'svg'
         ENV['GKS_FILEPATH'] = Dir::Tmpname.create('plot-') {}
       end
 
@@ -16,7 +16,7 @@ module GRCommons
       def show(display = true)
         emergencyclosegks
         sleep 0.5
-        type = ENV['GKSwstype']
+        type = ENV['GKS_WSTYPE']
         case type
         when 'svg'
           data = File.read("#{ENV['GKS_FILEPATH']}.svg")

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.61.0.0'
 end

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,

data/lib/grm.rb

@@ -17,23 +17,37 @@ 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/
+      ENV['GKSwstype'] ||= 'gksqt'
+      [['libGRM.dylib', 'libGRM.so'], 'grm']
+    else
+      [['libGRM.so'], 'grm']
+    end
+
+  # On Windows + RubyInstaller,
+  # the environment variable GKS_FONTPATH will be set.
+  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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 0.61.0.0
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: histogram
@@ -52,90 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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
-    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: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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: simplecov
-  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: test-unit
-  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'
 description: GR framework - the graphics library for visualisation - for Ruby
 email: 2xijok@gmail.com
 executables: []
@@ -154,13 +70,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 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.26
 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