ruby-gr 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20591722440c58b4cea29effed6bd13debcdc2c0383b40163d5b2fbc3f517f3e
-  data.tar.gz: 635fa83b40177e1c80936ca7fd949e2f2880c50710565db24e6e049f168d18ea
+  metadata.gz: d61176c3d03c6d635adbdc0cec5dd701b2303862405fa63a60815fc03b724054
+  data.tar.gz: 405d76e691b88c53d471b2e552f1af310e0a4d4b377c02ecbeac1827e62f5921
 SHA512:
-  metadata.gz: b30985a6bc12803fd2aabc590ffaccf4a4b931a5d00bb1c8c443fec90fd60f799560edbe3454532650871a578222c3aafb6d949204fb74b4efc22b3ddc5b197e
-  data.tar.gz: 61e34d2541e1821f739d5c12be8524b9fbc7e0332223c2c89cda40b0f38fc2eaa3ad695e5dca2fd5c955ee1bc04f07d0c235a7ce6a59f11b093ea7707f68e31f
+  metadata.gz: 4d23ae259c265dd3e8ed030a31a7f04ca4e358859e807885cda9f53c2c4b0be5839ccb2464bd4a6c2c9cf5d68fd99665d3f32dd74254ddd2eadfe4fe7123e9e3
+  data.tar.gz: 20b3a2dfec804617038a5884e272197d92f6f10069e568b149736d63775054d4d0c29e6f346397338401db44da1a4f3d9d5ba3c3f65a461c38df97ed8d10dc34

data/README.md

@@ -28,16 +28,22 @@
 
 GR.rb supports Ruby 2.5+.
 
-First, [install GR](#gr-installation). Next, set environment variable `GRDIR`. 
+First, [install GR](#gr-installation). Then install `ruby-gr` gem.
 
 ```sh
-export GRDIR="/your/path/to/gr"
+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).
+
+Set environment variable `GRDIR`. 
+
 ```sh
-gem install ruby-gr
+export GRDIR="/your/path/to/gr"
 ```
 
+Note: If you use package managers to install GR, [pkg-config](https://github.com/ruby-gnome/pkg-config) may automatically detect the shared library location without specifying the `GRDIR` environment variable. 
+
 ## Quick Start
 
 <p align="center">
@@ -161,10 +167,11 @@ export GRDIR="your/path/to/gr"
 
 * macOS Catalina and macOS Mojave: See the "How to open an app that hasn’t been notarized or is from an unidentified developer" section of [Safely open apps on your Mac](https://support.apple.com/en-us/HT202491) in the Apple documentation.
 
-### Using your package manager
+### Using package managers
 
 * The third party GR packages for Mac, Linux and Windows are available (for advanced users).
 * If you find any problem, please report the issue [here](https://github.com/red-data-tools/GR.rb/issues).
+* Note: These packages may not have some features, for example, video output.
 
 #### Mac - Homebrew
 
@@ -172,17 +179,11 @@ export GRDIR="your/path/to/gr"
 brew install libgr
 ```
 
-Set environment variable `GRDIR`.
-
-```sh
-export GRDIR=$(brew --prefix libgr)
-```
-
 #### Linux - APT Yum
 
-[packages.red-data-tools.org](https://github.com/red-data-tools/packages.red-data-tools.org) provides `libgr-dev` and `libgr3-dev`.
+[packages.red-data-tools.org](https://github.com/red-data-tools/packages.red-data-tools.org) provides `libgr-dev`, `libgr3-dev` and `libgrm-dev`
 
-#### Windows - MSYS2
+### Windows - MSYS2
 
 If you are using Rubyinstaller, pacman will automatically install [mingw-w64-gr](https://packages.msys2.org/base/mingw-w64-gr) when the gem is installed.
 
@@ -192,13 +193,14 @@ GR.rb will be the default backend for [Charty](https://github.com/red-data-tools
 
 ## Contributing
 
-* Report bugs
-* Fix bugs and submit pull requests
+* [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
 * Suggest or add new features
-* Create visualization library based on GR.rb
+* Update GR packages ( Homebrew, MinGW, red-data-tools )
+* Create visualization tools based on GR.rb
 
 ## Acknowledgements
 
-We would like to thank Josef Heinen, the creator of [GR.jl](https://github.com/jheinen/GR.jl), Florian Rhiem, the creator of  [python-gr](https://github.com/sciapp/python-gr), and [GR](https://github.com/sciapp/gr) developers.
+We would like to thank Josef Heinen, the creator of [GR](https://github.com/sciapp/gr) and [GR.jl](https://github.com/jheinen/GR.jl), Florian Rhiem, the creator of [python-gr](https://github.com/sciapp/python-gr), and all [GR](https://github.com/sciapp/gr) developers.
 

data/lib/gr.rb

@@ -61,9 +61,9 @@ module GR
   # 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')
+                   search_shared_library('libgr.dll', 'gr')
                  else
-                   search_shared_library('libGR.so')
+                   search_shared_library('libGR.so', 'gr')
                  end
 
   require_relative 'gr/version'
@@ -96,7 +96,12 @@ module GR
       super
     end
 
-    # inqdspsize
+    # Get the current display size.
+    # Depending on the current workstation type, the current display might be
+    # the primary screen (e.g. when using gksqt or GKSTerm) or a purely virtual
+    # display (e.g. when using Cairo). When a high DPI screen is used as the
+    # current display, width and height will be in logical pixels.
+    # @return [Array] meter_width, meter_height, width, height
     def inqdspsize
       inquiry %i[double double int int] do |*pts|
         super(*pts)
@@ -108,9 +113,7 @@ module GR
     # @param connection [String] A connection identifier.
     # @param workstation_type [Integer] The desired workstation type.
     #  * 5         : Workstation Independent Segment Storage
-    #  * 7, 8      : Computer Graphics Metafile (CGM binary, clear text)
     #  * 41        : Windows GDI
-    #  * 51        : Mac Quickdraw
     #  * 61 - 64   : PostScript (b/w, color)
     #  * 101, 102  : Portable Document Format (plain, compressed)
     #  * 210 - 213 : X Windows
@@ -131,7 +134,6 @@ module GR
     #  * 410       : Socket driver
     #  * 415       : 0MQ driver
     #  * 420       : OpenGL
-    #  * 430       : HTML5 Canvas
     def openws(*)
       super
     end
@@ -154,6 +156,7 @@ module GR
       super
     end
 
+    # Configure the specified workstation.
     def configurews(*)
       super
     end
@@ -295,6 +298,7 @@ module GR
       super(n, x, y, m, method)
     end
 
+    # Interpolate data from arbitrary points at points on a rectangular grid.
     def gridit(xd, yd, zd, nx, ny)
       nd = equal_length(xd, yd, zd)
       inquiry [{ double: nx }, { double: ny }, { double: nx * ny }] do |px, py, pz|
@@ -356,7 +360,6 @@ module GR
       super
     end
 
-    # inqlinecolorind
     def inqlinecolorind
       inquiry_int { |pt| super(pt) }
     end
@@ -516,7 +519,9 @@ module GR
     # 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
-    # precision for GR and produces the highest quality output.
+    # precision for GR and produces the highest quality output using either
+    # native font rendering or FreeType. OUTLINE uses the GR path rendering
+    # functions to draw individual glyphs and produces the highest quality output.
     def settextfontprec(*)
       super
     end
@@ -627,6 +632,8 @@ module GR
     #    *   Fill the interior of the polygon using the style index as a pattern index
     #  * 3 : HATCH
     #    *   Fill the interior of the polygon using the style index as a cross-hatched style
+    #  * 4 : SOLID_WITH_BORDER
+    #    *   Fill the interior of the polygon using the fill color index and draw the bounding polyline
     # `setfillintstyle` defines the interior style  for subsequent fill area output
     # primitives. The default interior style is HOLLOW.
     def setfillintstyle(*)
@@ -650,6 +657,7 @@ module GR
     end
 
     # Returns the current fill area color index.
+    # This function gets the color index for PATTERN and HATCH fills.
     def inqfillstyle
       inquiry_int { |pt| super(pt) }
     end
@@ -663,6 +671,7 @@ module GR
     end
 
     # Returns the current fill area color index.
+    # This function gets the color of fill area output primitives.
     def inqfillcolorind
       inquiry_int { |pt| super(pt) }
     end
@@ -937,12 +946,40 @@ module GR
     #   coordinate unit. Major tick marks are twice as long as minor tick marks.
     #   A negative value reverses the tick marks on the axes from inward facing
     #   to outward facing (or vice versa).
+    # Tick marks are positioned along each axis so that major tick marks fall on
+    # the axes origin (whether visible or not). Major tick marks are labeled
+    # with the corresponding data values. Axes are drawn according to the scale
+    # of the window. Axes and tick marks are drawn using solid lines; line color
+    # and width can be modified using the gr_setlinetype and gr_setlinewidth
+    # functions. Axes are drawn according to the linear or logarithmic
+    # transformation established by the gr_setscale function.
     def axes(*)
       super
     end
 
     alias axes2d axes
 
+    # Create axes in the current workspace and supply a custom function for
+    # changing the behaviour of the tick labels.
+    # @param x_tick [Numeric] The interval between minor tick marks on the X axis.
+    # @param y_tick [Numeric] The interval between minor tick marks on the Y axis.
+    # @param x_org [Numeric] The world coordinate of the origin (point of intersection) of the X axis.
+    # @param y_org [Numeric] The world coordinate of the origin (point of intersection) of the Y axis.
+    # @param major_x [Integer] Unitless integer value specifying the number of minor tick intervals between major tick marks on the X axis. Values of 0 or 1 imply no minor ticks. Negative values specify no labels will be drawn for the associated axis.
+    # @param major_y [Integer] Unitless integer value specifying the number of minor tick intervals between major tick marks on the Y axis. Values of 0 or 1 imply no minor ticks. Negative values specify no labels will be drawn for the associated axis.
+    # @param tick_size [Numeric] The length of minor tick marks specified in a normalized device coordinate unit. Major tick marks are twice as long as minor tick marks. A negative value reverses the tick marks on the axes from inward facing to outward facing (or vice versa).
+    # @param fpx [Pointer] Function pointer to a function that returns a label for a given tick on the X axis. The callback function should have the following arguments [Numeric]
+    # @param fpy [Pointer] Exactly same as the fpx above, but for the the Y axis.
+    # Similar to gr_axes() but allows more fine-grained control over tick labels
+    # and text positioning by supplying callback functions. Within the callback
+    # function you can use normal GR text primitives for performing any
+    # manipulations on the label text.
+    # See gr_axes() for more details on drawing axes.
+    # * fpx/fpy
+    #   * param x [Numeric] NDC of the label in X direction.
+    #   * param y [Numeric] NDC of the label in Y direction.
+    #   * param svalue [String] Internal string representation of the text drawn by GR at (x,y).
+    #   * param value [Numeric] Floating point representation of the label drawn at (x,y).
     def axeslbl(*)
       super
     end

data/lib/gr3.rb

@@ -69,9 +69,9 @@ module GR3
   # 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')
+                   search_shared_library('libGR3.dll', 'gr3')
                  else
-                   search_shared_library('libGR3.so')
+                   search_shared_library('libGR3.so', 'gr3')
                  end
 
   require_relative 'gr3/version'

data/lib/gr_commons/search_shared_library.rb

@@ -1,6 +1,34 @@
+# 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
-    def search_shared_library(gr_lib_name)
+    # 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,
@@ -9,23 +37,37 @@ module GRCommons
         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
+      # 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
-        recursive_search(gr_lib_name, ENV['GRDIR'])
+      else
+        pkg_config_search(gr_lib_name, pkg_name)
       end
     end
 
     def recursive_search(name, base_dir)
       Dir.chdir(base_dir) do
-        if path = Dir["**/#{name}"].first
+        if path = Dir["**/#{name}"].first # FIXME
           File.expand_path(path)
         else
-          raise StandardError '#{name} not found in #{base_dir}'
+          raise StandardError "#{name} not found in #{base_dir}"
         end
       end
     end
+
+    def pkg_config_search(gr_lib_name, pkg_name)
+      PKGConfig.variable(pkg_name, 'sopath')
+    rescue NotFoundError => e
+      warn "Cannot find #{gr_lib_name}."
+      warn 'Please set environment variable GRDIR.'
+      raise e
+    end
   end
 end

data/lib/gr_commons/version.rb

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

data/lib/grm.rb

@@ -30,9 +30,9 @@ module GRM
   # 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')
+                   search_shared_library('libGRM.dll', 'grm')
                  else
-                   search_shared_library('libGRM.so')
+                   search_shared_library('libGRM.so', 'grm')
                  end
 
   require_relative 'grm/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: histogram
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pkg-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement