galaaz 0.4.1 → 0.4.2

data/lib/gknit/ruby_engine.rb

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2018 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+# Ruby engine for processing Ruby chunks
+eng_ruby = Proc.new do |options|
+
+  begin
+    # read the chunk code
+    code = R.paste(options.code, collapse: "\n") << 0
+    
+    # process the chunk options
+    KnitrEngine.process_options(options)
+
+    tmp_fig = R.tempfile()
+     
+    # opens a device for the current chunk for plot recording. Knitr provides
+    # method chunck_device for that, but it is a non-exported method.  Galaaz
+    # does not yet provide a way to accessing non-exported methods, so, the ck_dv
+    # local method was developed that just calls chunk_device.
+    if (R._ck_dv(options.fig__width[1], options.fig__height[1], options.dev,
+                 options.dev__args, options.dpi, options, tmp_fig, record: true) << 0)
+
+      # chunk requires library 'showtext'.  Install and loads if not present
+      # FIXME: library showtext is giving error when trying to execute showtext beginning
+      if (!options[['fig.showtext']].is__null << 0) &&
+         options[['fig.showtext']] << 0
+        R.install_and_loads('showtext')
+        R.showtext
+      end
+      
+      dv = R.dev__cur
+    end
+    
+    # executes the code
+    res = GalaazUtil.exec_ruby(code)
+    
+    # formats and outputs the code and results
+    R.engine_output(options, options.code, res)
+
+  ensure
+    R.dev__off(dv)
+    # tmp_fig.unlink
+    # if (keep.pars) opts_knit$set(global.pars = par(no.readonly = TRUE))
+  end
+  
+end
+
+ruby_engine = KnitrEngine.new
+ruby_engine.add(ruby: eng_ruby)
+

data/lib/gknit/ruby_engine.rb~

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2018 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+# Ruby engine for processing Ruby chunks
+eng_ruby = Proc.new do |options|
+
+  begin
+    # read the chunk code
+    code = R.paste(options.code, collapse: "\n") << 0
+    
+    # process the chunk options
+    KnitrEngine.process_options(options)
+    
+    # opens a device for the current chunk for plot recording. Knitr provides
+    # method chunck_device for that, but it is a non-exported method.  Galaaz
+    # does not yet provide a way to accessing non-exported methods, so, the ck_dv
+    # local method was developed that just calls chunk_device.
+    if (R._ck_dv(options.fig__width[1], options.fig__height[1], options.dev,
+                 options.dev__args, options.dpi, options, record: true) << 0)
+
+      puts "===================================="
+      puts "fig.showtext is element?"
+      puts R.is__element('fig.showtext', options)
+      puts options['fig.showtext']
+      puts "===================================="
+      
+      if (R.is__element('fig.showtext', options) << 0)
+        puts "==============================="
+        puts options.fig__showtext
+        puts options.fig__showtext << 0
+      end
+      
+      R.showtext if (R.is__element('fig.showtext', options) << 0) &&
+                    (options.fig__showtext << 0) == true
+      dv = R.dev__cur
+    end
+    
+    # executes the code
+    res = GalaazUtil.exec_ruby(code)
+    
+    # formats and outputs the code and results
+    R.engine_output(options, options.code, res)
+
+  ensure
+    R.dev__off(dv)
+  end
+  
+end
+
+ruby_engine = KnitrEngine.new
+ruby_engine.add(ruby: eng_ruby)
+

data/lib/util/exec_ruby.rb

@@ -23,22 +23,23 @@
 
 require 'stringio'
 
+class RubyChunk
+
+end
+
 module GalaazUtil
   
   def self.exec_ruby(code)
-    # Set up standard output as a StringIO object.
-    foo = StringIO.new
-    $stdout = foo
-    
-    eval code
     
+    # Set up standard output as a StringIO object.
+    $stdout = StringIO.new
+    RubyChunk.instance_eval(code)
     out = $stdout.string
-    
     # return $stdout to standard output
     $stdout = STDOUT
-    
     # return everything that was outputed
     out
+    
   end
 
 end

data/lib/util/inline_file.rb

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2018 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+module GalaazUtil
+
+  #========================================================================================
+  # Opens the given filename for reading and returns the file content so that it can be
+  # printed as a code chunk in rmarkdown
+  # @param filename [String] the name of the file to be found.  If the file has no
+  #    extension then '.rb' is assumed
+  # @param relative [String] containing either 'require_relative ' or 'require '.  In the
+  #    first case looks on the current directory, on the latter, searches the $LOAD_PATH
+  # @param pwd [String] Directory to look at when 'require_relative ', by default, its
+  #    the pwd directory
+  #========================================================================================
+  
+  def self.inline_file(filename, relative, pwd = Dir.pwd)
+
+    filename << ".rb" if File.extname(filename) == ""
+    file = "#{pwd}/#{filename}"
+    
+    if (relative == 'require ')
+      $LOAD_PATH.each do |path|
+        begin
+          files = Dir.entries(path)
+        rescue Errno::ENOENT
+          next
+        end
+
+        if files != nil && files.include?("bigdecimal.rb")
+          file = "#{path}/#{filename}"
+          break
+        end
+      end
+    end
+
+    if File.exist?(file)
+      code = ""
+      File.open(file, "r") do |fileObj|
+        while (line = fileObj.gets)
+          code << line
+        end
+      end
+      code
+    else
+      raise Errno::ENOENT, "file #{filename} not found"
+    end
+  end
+  
+end

data/lib/util/inline_file.rb~

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2018 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+

data/r_requires/ggplot.rb

@@ -21,11 +21,4 @@
 # OR MODIFICATIONS.
 ##########################################################################################
 
-# check if packages are already installed and if not intall them
-R.install_rlibs('ggplot2', 'grid', 'gridExtra', 'ggplotify')
-
-# Load plotting libraries
-R.library('ggplot2')
-R.library('grid')
-R.library('gridExtra')
-R.library('ggplotify')
+R.install_and_loads('ggplot2', 'grid', 'gridExtra')

data/r_requires/knitr.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2018 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+# Require knitr, required package that provides needed functions
+# to capture plots and generating images in diverse formats such
+# as 'png', 'pdf', etc. 
+R.install_and_loads('knitr')

data/r_requires/knitr.rb~

@@ -0,0 +1,4 @@
+# Require knitr, required package that provides needed functions
+# to capture plots and generating images in diverse formats such
+# as 'png', 'pdf', etc. 
+R.install_and_loads('knitr')

data/specs/r_language.spec.rb

@@ -101,11 +101,33 @@ describe R::Language do
 
   #========================================================================================
   context "When working with Formulas" do
+    # When working with formulas, Ruby symbols such be preceded by the '+' function.
+    # If you want to make a formula such as 'a ~ b' in R, then this should be written
+    # as '+:a =~ +:b'.  When, in an binary operation, the Ruby symbol will be converted
+    # to an R symbol.  The formula '+:a =~ +:b', can also be written as '+:a =~ :b'.  Be
+    # careful, however, when using the Ruby symbol without the '+' since in a more complex
+    # formula, Ruby's precedence rules might not result in what is expected.  As an example
+    # '+:a =~ :b * +:c' crashes with the error 'b' not found, since '*' has precedence over
+    # '=~' and this is equivalent to '+:a =~ (:b * +:c)' and there is no sense in
+    # multiplying a Ruby symbol. The recomendation is to always use the '+' function
+    # before the Ruby symbol.
     
     it "should create a RSymbol from a Ruby Symbol using +" do
       sym = +:sym
       expect sym.to_s == "sym"
     end
+
+    it "should create a formula with '.' by using the ':all' keyword" do
+      # this formula is interpreted as 'supp ~ .'
+      formula = +:supp =~ :all
+      expect formula.rclass == "formula"
+    end
+
+    it "should create a formula with '.' by using the ':all' keyword in the lhs" do
+      # this formula is interpreted as '. ~ supp'
+      formula = +:all =~ +:supp
+      expect formula.rclass == "formula"
+    end
     
 =begin
     

data/specs/r_plots.spec.rb

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2018 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+require 'galaaz'
+
+describe R::Plots do
+
+  #----------------------------------------------------------------------------------------
+  context "Create a Plot" do
+
+    it "should create a bar plot" do
+      dev = R::Device.new('png', width: 5, height: 7, dpi: 300, record: true)
+
+      # opens de device
+      dev.open
+      # generate the bar plot
+      b = R.ggplot(:mpg, E.aes(:fl))
+      # prints the plot
+      print b + R.geom_bar
+
+      snap = dev.plot_snapshot
+      dev.save_plot(snap, 'snapshot', 'png', 5, 7, 'png', 300)
+      
+      R.grid__newpage(recording: true)
+        
+      # print a second bar chart
+      print b + R.geom_bar(fill: "steelblue", color: "steelblue") +
+            R.theme_minimal
+      
+      # closes the device
+      dev.close
+    end
+
+    it "should create a bar plot passing a block to the device" do
+      # creates the device and pass the plot spec in a block.  No need to
+      # worry about opening and closing the device
+      dev = R::Device.new('svg', width: 5, height: 7, dpi: 300, record: true) {
+        b = R.ggplot(:mpg, E.aes(:fl))
+        print b + R.geom_bar
+
+        R.grid__newpage(recording: true)
+        
+        # print a second bar chart
+        print b + R.geom_bar(fill: "steelblue", color: "steelblue") +
+              R.theme_minimal
+        
+      }
+    end
+
+  end
+
+end

data/specs/r_plots.spec.rb~

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2018 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+require 'galaaz'
+
+describe R::Plots do
+
+  #----------------------------------------------------------------------------------------
+  context "Create a Plot" do
+
+    it "should create a plot with ggplot" do
+
+    end
+
+  end
+
+end