ruby-gr 0.0.20 → 0.0.25

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/define_methods.rb

@@ -5,8 +5,8 @@ module GRCommons
   module DefineMethods
     private
 
-    def define_ffi_methods(ffi_class, prefix: '', default_type: :double)
-      ffi_class.ffi_methods.each do |method|
+    def define_ffi_methods(ffi_module, prefix: '', default_type: :double)
+      ffi_module.ffi_methods.each do |method|
         # Use delete_prefix (Ruby >= 2.5)
         method_name = method.to_s.sub(/^#{prefix}/, '')
 
@@ -16,14 +16,14 @@ module GRCommons
           args.map! do |arg|
             case arg
             when Array
-              GRCommons::GRCommonUtils.send(default_type, arg)
+              GRCommons::GRCommonUtils.public_send(default_type, arg)
             when ->(x) { defined?(Numo::NArray) && x.is_a?(Numo::NArray) }
-              GRCommons::GRCommonUtils.send(default_type, arg)
+              GRCommons::GRCommonUtils.public_send(default_type, arg)
             else
               arg
             end
           end
-          ffi_class.send(method, *args)
+          ffi_module.public_send(method, *args)
         end
       end
     end

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
@@ -210,7 +210,7 @@ module GRCommons
         end
 
         define_method("put_array_of_int#{bits}") do |offset, ary|
-          put_bytes(offset, ary.pack(form + '*'))
+          put_bytes(offset, ary.pack("#{form}*"))
         end
 
         define_method("write_array_of_int#{bits}") do |ary|
@@ -226,7 +226,7 @@ module GRCommons
         end
 
         define_method("get_array_of_int#{bits}") do |offset, num|
-          @ptr[offset, bytes * num].unpack(form + '*')
+          @ptr[offset, bytes * num].unpack("#{form}*")
         end
 
         define_method("read_array_of_int#{bits}") do |num|
@@ -244,7 +244,7 @@ module GRCommons
         end
 
         define_method("put_array_of_uint#{bits}") do |offset, ary|
-          put_bytes(offset, ary.pack(form2 + '*'))
+          put_bytes(offset, ary.pack("#{form2}*"))
         end
 
         define_method("write_array_of_uint#{bits}") do |ary|
@@ -260,7 +260,7 @@ module GRCommons
         end
 
         define_method("get_array_of_uint#{bits}") do |offset, num|
-          @ptr[offset, bytes * num].unpack(form2 + '*')
+          @ptr[offset, bytes * num].unpack("#{form2}*")
         end
 
         define_method("read_array_of_uint#{bits}") do |num|
@@ -330,12 +330,12 @@ module GRCommons
 
       # added
       define_method('get_array_of_double') do |offset, num|
-        @ptr[offset, 8 * num].unpack('d' + '*')
+        @ptr[offset, 8 * num].unpack('d*')
       end
 
       # added
       define_method('get_array_of_float') do |offset, num|
-        @ptr[offset, 4 * num].unpack('f' + '*')
+        @ptr[offset, 4 * num].unpack('f*')
       end
 
       # added

data/lib/gr_commons/gr_common_utils.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'gr_commons/fiddley'
+require_relative 'fiddley'
 
 module GRCommons
   # This module provides functionality common to GR and GR3.
@@ -52,7 +52,7 @@ module GRCommons
       if narray?(data)
         Numo::UInt32.cast(data).to_binary
       else
-        Fiddley::Utils.array2str(:uint, data.to_a.flatten)
+        Fiddley::Utils.array2str(:uint32, data.to_a.flatten)
       end
     end
 
@@ -117,9 +117,9 @@ module GRCommons
       when Hash
         typ = type.keys[0]
         len = type.values[0]
-        pt.send("read_array_of_#{typ}", len)
+        pt.public_send("read_array_of_#{typ}", len)
       else
-        pt.send("read_#{type}")
+        pt.public_send("read_#{type}")
       end
     end
 

data/lib/gr_commons/gr_commons.rb

@@ -4,7 +4,11 @@
 module GRCommons
 end
 
-require_relative 'extern'
+# Change the default encoding to UTF-8.
+ENV['GKS_ENCODING'] ||= 'utf8'
+
+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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# This script was created primarily for debugging purposes.
+# Note: This script should be isolated.
+# It should not be loaded when gr_commons/gr_commons is loaded.
+
+require 'logger'
+require 'rainbow'
+require 'awesome_print'
+
+module GRCommons
+  class << self
+    # Create a new GRLogger
+    # @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.
+  #
+  # = 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
+  #
+  # @example
+  #   require 'gr_commons/gr_logger'
+  #   GRCommons.gr_log("log.txt")
+  class GRLogger < Logger
+    # Return the last created GRLogger
+    def self.logger
+      @@logger ||= GRCommons::GRLogger.new
+    end
+
+    def initialize(out = $stderr)
+      super(out, level: :info)
+      @@logger ||= self
+    end
+  end
+end
+
+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"
+            super(*args)
+          end
+        end
+      end
+      class << self
+        prepend Inspector
+      end
+    end
+  end
+end
+
+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"
+            super(*args)
+          end
+        end
+      end
+      class << self
+        prepend Inspector
+      end
+    end
+  end
+end
+
+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"
+            super(*args)
+          end
+        end
+      end
+      class << self
+        prepend Inspector
+      end
+    end
+  end
+end

data/lib/gr_commons/jupyter_support.rb

@@ -19,16 +19,16 @@ module GRCommons
         type = ENV['GKSwstype']
         case type
         when 'svg'
-          data = File.read(ENV['GKS_FILEPATH'] + '.svg')
+          data = File.read("#{ENV['GKS_FILEPATH']}.svg")
           IRuby.display(data, mime: 'image/svg+xml') if display
         when 'png', '322', '140'
-          data = File.read(ENV['GKS_FILEPATH'] + '.png')
+          data = File.read("#{ENV['GKS_FILEPATH']}.png")
           IRuby.display(data, mime: 'image/png') if display
         when 'jpg', '321', '144'
-          data = File.read(ENV['GKS_FILEPATH'] + '.jpg')
+          data = File.read("#{ENV['GKS_FILEPATH']}.jpg")
           IRuby.display(data, mime: 'image/jpeg') if display
         when 'gif', '130'
-          data = File.read(ENV['GKS_FILEPATH'] + '.gif')
+          data = File.read("#{ENV['GKS_FILEPATH']}.gif")
           IRuby.display(data, mime: 'image/gif') if display
         when 'webm', 'ogg', 'mp4', 'mov'
           require 'base64'
@@ -37,7 +37,7 @@ module GRCommons
                      else
                        "video/#{type}"
                      end
-          data = File.binread(ENV['GKS_FILEPATH'] + '.' + type)
+          data = File.binread("#{ENV['GKS_FILEPATH']}.#{type}")
           if display
             IRuby.display(
               "<video autoplay controls><source type=\"#{mimespec}\" " \

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.20'
+  VERSION = '0.0.25'
 end

data/lib/grm.rb

@@ -1,33 +1,50 @@
 # 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
 
+  class NotFoundError < Error; end
+
   class << self
     attr_accessor :ffi_lib
   end
 
+  require_relative 'gr_commons/gr_commons'
+
   # Platforms |  path
   # Windows   |  bin/libGRM.dll
-  # MacOSX    |  lib/libGRM.so (NOT .dylib)
+  # MacOSX    |  lib/libGRM.dylib (v0.53.0 .so)
   # 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
+  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
 
-  # change the default encoding to UTF-8.
-  ENV['GKS_ENCODING'] ||= 'utf8'
-
-  require_relative 'gr_commons/gr_commons'
   require_relative 'grm/version'
   require_relative 'grm/ffi'
   require_relative 'grm/grmbase'