mathematical 1.6.14 → 1.6.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e13caf97315c9eda31e7634b107955d8e9898e1d19aaa42d12e984cfbfbf697c
-  data.tar.gz: 56b7a17a293b1d3a5c2b4a987697f353d20e977d0b41ff1b160b361ddc77dd85
+  metadata.gz: 273ff66b5f3f1a80c7922a10a6c11797fbf187b589e477fb88ebbe91de66911a
+  data.tar.gz: d8f27438acfc80ae8ece3b1dec8ddcb385b9f6e1f772eb7e7e9c39676c183b8d
 SHA512:
-  metadata.gz: 96bfd310f175d3e43a2ff74e5f7b7a85cc79d605c55e543fc3068188ac33fb26c3bf6e5a0564214c4f09412f12bcbf32d03cdb23642e3bcdc759e6d025e2974b
-  data.tar.gz: e7dec38f067e3351234bf9c6aff5653b5345feff9e7c5d4f5b07a1e819e6be927289240e77a97cc08e05d617f206dfbd2267ffc436b2a5a2753662ec192d9128
+  metadata.gz: a7f0b9973cbeff8512f6fabb11388e7b76b872c1eeb8f951c2c23f4b2bccdd974b6ce92f5cc0b40fdfe372aa7a31ec9153c273df4bb19cfffe144b8cd996c6b6
+  data.tar.gz: b545fb60e6fb60fc5a06210b69c48027bb36cfa149ad1647d1d8d2701a9e54caaf8979628ba41ffec6b27afc218dd9f68034933f437aa14fac3c492cc3b98347

data/README.md

@@ -6,6 +6,12 @@ Quickly convert math equations into beautiful SVGs (or PNGs/MathML).
 
 ![Mathematical](https://i.imgur.com/JC7HT32.gif)
 
+## ⚠️ Maintenance Status ⚠️
+
+SVG and especially PNG generation is currently unmaintained. This library should primarily be used for MathML generation.
+
+Please reach out if you would like to mantain SVG and PNG portions of the library.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -244,7 +250,7 @@ no intermediate binaries. It was, unfortunately, a bit slow: for an arbitrary
 composition of 880 equations, it took about eight seconds to complete. Could I
 do better?
 
-* I came across [Lasem](https://wiki.gnome.org/action/show/Projects/Lasem?action=show&redirect=Lasem),
+* I came across [Lasem](https://github.com/LasemProject/lasem),
 which met every need. It has no external binary dependencies (only library packages),
 can convert directly to SVG, and it's fast. The same arbitrary 880 equations were
 rendered in moments.

data/Rakefile

@@ -1,22 +1,23 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-require 'fileutils'
-require 'tmpdir'
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "fileutils"
+require "tmpdir"
 
-LASEM_DIR = File.expand_path(File.join(File.dirname(__FILE__), 'ext', 'mathematical', 'lasem'))
+LASEM_DIR = File.expand_path(File.join(File.dirname(__FILE__), "ext", "mathematical", "lasem"))
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
 end
 
-require 'rake/extensiontask'
-spec = Gem::Specification.load('mathematical.gemspec')
-Rake::ExtensionTask.new('mathematical', spec) do |ext|
-  ext.lib_dir = File.join('lib', 'mathematical')
+require "rake/extensiontask"
+spec = Gem::Specification.load("mathematical.gemspec")
+Rake::ExtensionTask.new("mathematical", spec) do |ext|
+  ext.lib_dir = File.join("lib", "mathematical")
 end
 
 task default: [:test]
@@ -25,31 +26,40 @@ Gem::PackageTask.new(spec)
 
 Rake::Task[:test].prerequisites
 
-task :build => [:clean]
+task build: [:clean]
 
 Rake::Task[:clean].enhance do
-  Dir.chdir(LASEM_DIR) { puts `git clean -fdx`; }
+  Dir.chdir(LASEM_DIR) { puts %x(git clean -fdx) }
 end
 
-desc 'Copy samples to gh-pages'
+desc "Copy samples to gh-pages"
 task :copy_samples do
   Dir.mktmpdir do |tmp|
     system "cp -r samples #{tmp}"
 
-    system 'git checkout gh-pages'
+    system "git checkout gh-pages"
 
     system "cp -r #{tmp}/samples ."
   end
 end
 
-desc 'Pretty format C code'
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+desc "Pretty format C code"
 task :format do
-  puts `astyle --indent=spaces=2 --style=1tbs --keep-one-line-blocks \
-        $(ack -n -f --type=cpp --type=cc ext/mathematical/)`
+  puts %x(astyle --indent=spaces=2 --style=1tbs --keep-one-line-blocks \
+        $(ack -n -f --type=cpp --type=cc ext/mathematical/))
 end
 
-desc 'Run a benchmark'
+desc "Run a benchmark"
 task :benchmark do
-  $:.unshift 'lib'
-  load 'script/benchmark.rb'
+  $LOAD_PATH.unshift("lib")
+  load "script/benchmark.rb"
 end
+
+GEMSPEC = Bundler.load_gemspec("mathematical.gemspec")
+gem_path = Gem::PackageTask.new(GEMSPEC).define
+desc "Package the ruby gem"
+task "package" => [gem_path]

data/ext/mathematical/extconf.rb

@@ -1,62 +1,66 @@
-ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin|mac os/
-
-require 'mkmf'
-require 'rbconfig'
-
-OS         = case RbConfig::CONFIG['host_os']
-             when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-               :windows
-             when /darwin|mac os/
-               :macos
-             when /linux/
-               :linux
-             when /solaris|bsd/
-               :unix
-             else
-               raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
-             end
-
-LIBDIR     = RbConfig::CONFIG['libdir']
-INCLUDEDIR = RbConfig::CONFIG['includedir']
-SHARED_EXT = OS == :macos ? 'dylib' : 'so'
+# frozen_string_literal: true
+
+# rubocop:disable Style/GlobalVars
+
+ENV["RC_ARCHS"] = "" if RUBY_PLATFORM.match?(/darwin|mac os/)
+
+require "mkmf"
+require "rbconfig"
+
+OS = case RbConfig::CONFIG["host_os"]
+when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+  :windows
+when /darwin|mac os/
+  :macos
+when /linux/
+  :linux
+when /solaris|bsd/
+  :unix
+else
+  raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
+end
+
+LIBDIR     = RbConfig::CONFIG["libdir"]
+INCLUDEDIR = RbConfig::CONFIG["includedir"]
+SHARED_EXT = OS == :macos ? "dylib" : "so"
 # Starting in Catalina, libxml2 was moved elsewhere
-SDKROOT = OS == :macos ? `/usr/bin/xcrun --show-sdk-path`.chomp : ''
-RPATH = OS == :macos ? '-rpath @loader_path/../../ext/mathematical/lib'.chomp : ''
+SDKROOT = OS == :macos ? %x(/usr/bin/xcrun --show-sdk-path).chomp : ""
+RPATH = OS == :macos ? "-rpath @loader_path/../../ext/mathematical/lib".chomp : ""
 
-unless find_executable('cmake')
+unless find_executable("cmake")
   $stderr.puts "\n\n\n[ERROR]: cmake is required and not installed. Get it here: http://www.cmake.org/\n\n"
   exit 1
 end
 
 def using_system_lasem?
-  arg_config('--use-system-lasem', !!ENV['MATHEMATICAL_USE_SYSTEM_LASEM'])
+  arg_config("--use-system-lasem", !!ENV["MATHEMATICAL_USE_SYSTEM_LASEM"])
 end
 
 def using_system_mtex2mml?
-  arg_config('--use-system-mtex2MML', !!ENV['MATHEMATICAL_USE_SYSTEM_MTEX2MML'])
+  arg_config("--use-system-mtex2MML", !!ENV["MATHEMATICAL_USE_SYSTEM_MTEX2MML"])
 end
 
-LASEM_DIR = File.expand_path(File.join(File.dirname(__FILE__), 'lasem'))
-LASEM_BUILD_DIR = File.join(LASEM_DIR, 'build')
-LASEM_SRC_DIR = File.expand_path(File.join(LASEM_DIR, 'src'))
-LASEM_LIB_DIR = File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+LASEM_DIR = File.expand_path(File.join(File.dirname(__FILE__), "lasem"))
+LASEM_BUILD_DIR = File.join(LASEM_DIR, "build")
+LASEM_SRC_DIR = File.expand_path(File.join(LASEM_DIR, "src"))
+LASEM_LIB_DIR = File.expand_path(File.join(File.dirname(__FILE__), "lib"))
 
-MTEX2MML_DIR = File.expand_path(File.join(File.dirname(__FILE__), 'mtex2MML'))
-MTEX2MML_BUILD_DIR = File.join(MTEX2MML_DIR, 'build')
-MTEX2MML_SRC_DIR = File.expand_path(File.join(MTEX2MML_DIR, 'src'))
-MTEX2MML_LIB_DIR = File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+MTEX2MML_DIR = File.expand_path(File.join(File.dirname(__FILE__), "mtex2MML"))
+MTEX2MML_BUILD_DIR = File.join(MTEX2MML_DIR, "build")
+MTEX2MML_SRC_DIR = File.expand_path(File.join(MTEX2MML_DIR, "src"))
+MTEX2MML_LIB_DIR = File.expand_path(File.join(File.dirname(__FILE__), "lib"))
 
 if OS == :macos
-  ENV['PKG_CONFIG_PATH'] = "/opt/X11/lib/pkgconfig:#{ENV['PKG_CONFIG_PATH']}"
+  ENV["PKG_CONFIG_PATH"] = "/opt/X11/lib/pkgconfig:#{ENV["PKG_CONFIG_PATH"]}"
 end
 
 # pre-compile checks
-have_library('xml2')
-have_library('pangocairo-1.0')
-find_header('libxml/tree.h', '/include/libxml2', '/usr/include/libxml2', '/usr/local/include/libxml2', "#{SDKROOT}/usr/include/libxml2")
-find_header('libxml/parser.h', '/include/libxml2', '/usr/include/libxml2', '/usr/local/include/libxml2', "#{SDKROOT}/usr/include/libxml2")
-find_header('libxml/xpath.h', '/include/libxml2', '/usr/include/libxml2', '/usr/local/include/libxml2', "#{SDKROOT}/usr/include/libxml2")
-find_header('libxml/xpathInternals.h', '/include/libxml2', '/usr/include/libxml2', '/usr/local/include/libxml2', "#{SDKROOT}/usr/include/libxml2")
+have_library("xml2")
+have_library("pangocairo-1.0")
+find_header("libxml/tree.h", "/include/libxml2", "/usr/include/libxml2", "/usr/local/include/libxml2", "#{SDKROOT}/usr/include/libxml2")
+find_header("libxml/parser.h", "/include/libxml2", "/usr/include/libxml2", "/usr/local/include/libxml2", "#{SDKROOT}/usr/include/libxml2")
+find_header("libxml/xpath.h", "/include/libxml2", "/usr/include/libxml2", "/usr/local/include/libxml2", "#{SDKROOT}/usr/include/libxml2")
+find_header("libxml/xpathInternals.h", "/include/libxml2", "/usr/include/libxml2", "/usr/local/include/libxml2", "#{SDKROOT}/usr/include/libxml2")
 
 # TODO: we need to clear out the build dir that's erroneously getting packaged
 # this causes problems, as Linux installation is expecting OS X output
@@ -73,55 +77,53 @@ clean_dir(LASEM_BUILD_DIR)
 if !using_system_mtex2mml?
   # build mtex2MML library
   Dir.chdir(MTEX2MML_BUILD_DIR) do
-    system 'cmake ..'
-    system 'make libmtex2MML_static'
+    system "cmake .."
+    system "make libmtex2MML_static"
   end
   FileUtils.mkdir_p(MTEX2MML_LIB_DIR)
-  FileUtils.cp_r(File.join(MTEX2MML_BUILD_DIR, 'libmtex2MML.a'), MTEX2MML_LIB_DIR)
-  $LIBS << ' -lmtex2MML'
+  FileUtils.cp_r(File.join(MTEX2MML_BUILD_DIR, "libmtex2MML.a"), MTEX2MML_LIB_DIR)
+  $LIBS << " -lmtex2MML"
+elsif dir_config("mtex2MML").any? || system("dpkg -s libmtex2MML >/dev/null")
+  $LIBS << " -lmtex2MML"
 else
-  if dir_config('mtex2MML').any? || system('dpkg -s libmtex2MML >/dev/null')
-    $LIBS << ' -lmtex2MML'
-  else
-    # NOTE: pkg_config implicitly adds right -l argument for the linker.
-    pkg_config('libmtex2MML') || pkg_config('mtex2MML')
-  end
+  # NOTE: pkg_config implicitly adds right -l argument for the linker.
+  pkg_config("libmtex2MML") || pkg_config("mtex2MML")
 end
 
 if !using_system_lasem?
   # build Lasem library
   # SHOULD BE DYNAMICALLY LINKED for potential LGPL copyright issues
   Dir.chdir(LASEM_BUILD_DIR) do
-    system 'cmake ../..'
-    system 'make'
+    system "cmake ../.."
+    system "make"
   end
   FileUtils.mkdir_p(LASEM_LIB_DIR)
   FileUtils.cp_r(File.join(LASEM_BUILD_DIR, "liblasem.#{SHARED_EXT}"), LASEM_LIB_DIR)
-  if OS == :linux
-    $LIBS << " -Wl,-rpath,#{LASEM_LIB_DIR} -llasem"
+  $LIBS << if OS == :linux
+    " -Wl,-rpath,#{LASEM_LIB_DIR} -llasem"
   else
-    $LIBS << ' -llasem'
+    " -llasem"
   end
+elsif dir_config("lasem").any? || system("dpkg -s liblasem >/dev/null")
+  $LIBS << " -llasem"
 else
-  if dir_config('lasem').any? || system('dpkg -s liblasem >/dev/null')
-    $LIBS << ' -llasem'
-  else
-    # NOTE: pkg_config implicitly adds right -l argument for the linker.
-    pkg_config('liblasem') || pkg_config('lasem')
-  end
+  # NOTE: pkg_config implicitly adds right -l argument for the linker.
+  pkg_config("liblasem") || pkg_config("lasem")
 end
 
-puts '*** Library work completed ***'
+puts "*** Library work completed ***"
 
 LIB_DIRS = [MTEX2MML_LIB_DIR, LASEM_LIB_DIR]
 HEADER_DIRS = [MTEX2MML_SRC_DIR, LASEM_SRC_DIR]
 
-dir_config('mathematical', HEADER_DIRS, LIB_DIRS)
+dir_config("mathematical", HEADER_DIRS, LIB_DIRS)
+
+find_header("mtex2MML.h", MTEX2MML_SRC_DIR)
 
-find_header('mtex2MML.h', MTEX2MML_SRC_DIR)
+flag = ENV["TRAVIS"] ? "-O0" : "-O2"
+$LDFLAGS << " #{%x(pkg-config --static --libs glib-2.0 gdk-pixbuf-2.0 cairo pango).chomp} #{RPATH}"
+$CFLAGS << " #{flag} #{%x(pkg-config --cflags glib-2.0 gdk-pixbuf-2.0 cairo pango).chomp}"
 
-flag = ENV['TRAVIS'] ? '-O0' : '-O2'
-$LDFLAGS << " #{`pkg-config --static --libs glib-2.0 gdk-pixbuf-2.0 cairo pango`.chomp} #{RPATH}"
-$CFLAGS << " #{flag} #{`pkg-config --cflags glib-2.0 gdk-pixbuf-2.0 cairo pango`.chomp}"
+create_makefile("mathematical/mathematical")
 
-create_makefile('mathematical/mathematical')
+# rubocop:enable Style/GlobalVars