rubyplots 0.0.1

data/lib/rubyplots/orchestrator.rb

@@ -0,0 +1,96 @@
+#-------------------------------------------------
+# Copyright (c) 2014 Matthew Pate
+# This program is licensed under the MIT License
+# Please see the file 'copying.txt' in the source
+# distribution of this software for license terms.
+# ------------------------------------------------
+
+require_relative './scatterplot'
+require 'fileutils'
+
+
+class Orchestrator
+
+  @latexPath = nil
+  @tempLatexDirectory = nil
+
+  def initialize(tempLatexDirectory)
+    validateLatexPackages
+    @tempLatexDirectory = tempLatexDirectory
+    @latexFile = File.join(@tempLatexDirectory, 'RubyPlotsLatexFile.tex')
+    writeOpeningTo @latexFile
+  end
+
+  def addLatexFor(dataFile)
+    ScatterPlot.new( dataFile, @latexFile )
+  end
+
+  def generatePlots
+    writeClosingTo @latexFile
+    compile @latexFile
+  end
+
+  def savePlotsAndCleanup(latexDir)
+    parentDir = File.dirname(latexDir)
+    plotsToKeep = Dir.glob(latexDir + File::SEPARATOR + "rubyplots-*.pdf")
+    plotsToKeep.each do |plot|
+      FileUtils.move(plot, parentDir, {:force => true})  
+    end
+    # Todo: Review options for this remove - this is unsecure right now.
+    FileUtils.rm_rf @tempLatexDirectory
+  end
+
+
+  private
+
+  def compile(pathToLatex)
+    latexDir = File.split(pathToLatex)[0]
+    file = File.split(pathToLatex)[1]
+
+    FileUtils.cd latexDir 
+    enableLatexSystemCallsFor file
+    system "pdflatex #{file} > /dev/null"
+  end
+
+  # A requirement of generating individual PDF's
+  # Todo: Figure out why you get 2 errors here that don't seem to effect compilation...
+  def enableLatexSystemCallsFor(latex)
+    system "pdflatex -shell-escape #{File.basename(latex, ".tex")} > /dev/null"
+  end
+
+  # Validates that latex, tikz, and pgfplots are installed
+  def validateLatexPackages
+    if which("pdflatex").nil? || !(system "kpsewhich tikz > /dev/null") || !(system "kpsewhich pgfplots > /dev/null")
+      raise "Missing required latex packages."
+    end
+  end
+
+  def which(cmd)
+    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+      exts.each { |ext|
+        exe = File.join(path, "#{cmd}#{ext}")
+        return exe if File.executable? exe
+      }
+    end
+    return nil
+  end
+
+  def writeOpeningTo(file)
+    File.open(file, "a") do |f|
+      f << '\\documentclass{article}' + "\n"
+      f << '\\usepackage{pgfplots}' + "\n"
+      f << '\\pgfplotsset{compat = newest}' + "\n"
+      f << '\\usepgfplotslibrary{external}' + "\n"
+      f << '\\tikzexternalize' + "{#{File.basename(file, ".tex")}}\n" 
+      f << '\\begin{document}' + "\n"
+    end
+  end
+
+  def writeClosingTo(file)
+    File.open(file, "a") do |f|
+      f << '\\end{document}'
+    end
+  end
+
+end

data/lib/rubyplots/scatterplot.rb

@@ -0,0 +1,54 @@
+#-------------------------------------------------
+# Copyright (c) 2014 Matthew Pate
+# This program is licensed under the MIT License
+# Please see the file 'copying.txt' in the source
+# distribution of this software for license terms.
+# ------------------------------------------------
+
+require 'csv'
+
+
+class ScatterPlot
+
+  def initialize(dataFile, latexFile)
+    writeScatterPlot(dataFile, latexFile)
+  end
+
+  private
+
+  # This reads the datafile in a way that requires a certain format.
+  # The title of this scatterplot becomes the name of the pdf file (minus the extension).
+  # The first line of the file must be the names of the x and y columns.
+  # Multiple words for an x or y column must be enclosed in brackets (see validateColumnNames)
+  def writeScatterPlot(dataFile, latexFile)
+   
+    # Raising a custom error here because CSV.open will throw this automatically as expected and prefered, but
+    # File.open will simply create a file if it doesn't exist, which we don't want, so we're just going to perform
+    # the error handling here (rather than letting CSV throw and us manually throwing for File).
+    if !(File.exists?(dataFile) && File.exists?(latexFile))
+      raise SystemCallError, "One of '#{dataFile}' or '#{latexFile}' do not exist."
+    end
+
+    CSV.open(dataFile, "r", {:col_sep => "\t"}) do |data|
+      colNames = data.readline
+      validateColumnNames(colNames[0], colNames[1])
+
+      File.open(latexFile, "a") do |file|
+        fileBasename = File.basename(dataFile, ".scatterplot")
+        file << '\\tikzsetnextfilename' + "{rubyplots-#{fileBasename}}\n" 
+        file << '\\begin{tikzpicture}' + "\n"
+        file << '\\begin{axis}' + "[title=#{fileBasename}, xlabel=#{colNames[0]}, ylabel=#{colNames[1]}]\n"
+        file << '\\addplot table [only marks, ' + "x=#{colNames[0]}, y=#{colNames[1]}] {#{dataFile}};\n"
+        file << '\\end{axis}' + "\n"
+        file << '\\end{tikzpicture}' + "\n"
+      end
+    end
+  end
+
+  def validateColumnNames(x, y)
+    if ( (x.split.count > 1 && (x[0] != "{" || x[-1] != "}")) || (y.split.count > 1 && (y[0] != "{" || y[1] != "}")) )
+      raise "Columns with multiple words dectected in data file and no enclosing brackets found. One of: '#{x}' or '#{y}'"
+    end
+  end
+
+end

data/lib/rubyplots.rb

@@ -0,0 +1,65 @@
+#-------------------------------------------------
+# Copyright (c) 2014 Matthew Pate
+# This program is licensed under the MIT License
+# Please see the file 'copying.txt' in the source
+# distribution of this software for license terms.
+# ------------------------------------------------
+
+require_relative './rubyplots/orchestrator'
+
+
+class RubyPlots
+
+  @orchestrator = nil
+
+  def initialize
+  end
+
+  # data can be a file or directory
+  def generatePlotsFor(data)
+    dataPath = File.expand_path(data)
+    tempLatexDir = createTempDirectoryFor dataPath
+    @orchestrator = Orchestrator.new(tempLatexDir)
+
+    if File.directory? dataPath
+      checkTypeAndGenerateForDir dataPath
+    else
+      checkTypeAndGenerateForFile dataPath
+    end
+
+    @orchestrator.generatePlots
+    @orchestrator.savePlotsAndCleanup tempLatexDir
+  end
+
+
+  private
+
+  def createTempDirectoryFor(fileOrDir)
+    newDir = nil
+    if File.directory? fileOrDir
+      newDir = File.join(fileOrDir, 'RubyPlotsWorkingDir')
+    else
+      newDir = File.join(File.dirname(fileOrDir), 'RubyPlotsWorkingDir')
+    end
+    Dir.mkdir(newDir)
+    return newDir
+  end
+
+  def checkTypeAndGenerateForFile(file)
+    if isRightType?(file)
+      @orchestrator.addLatexFor(file)
+    end
+  end
+
+  def checkTypeAndGenerateForDir(dir)
+    Dir.entries(dir).each do |file|
+      # We loose the full path on .entries, so rejoin.
+      checkTypeAndGenerateForFile File.join(dir, file)
+    end
+  end
+
+  def isRightType?(file)
+    return File.extname(file) == ".scatterplot"
+  end
+
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: rubyplots
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Pate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-06 00:00:00.000000000 Z
+dependencies: []
+description: RubyPlots can be set loose on a directory of datafiles or a singluar
+  datafile.  It uses the file extension to determine a datafile of interest and, using
+  the Latex PgfPlots library, creates a single pdf plot for each data file.  See the
+  Homepage for questions.  Enjoy!
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rubyplots.rb
+- lib/rubyplots/scatterplot.rb
+- lib/rubyplots/orchestrator.rb
+homepage: http://mcpate.github.io/RubyPlots/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: RubyPlots - An open source plotting utility for Ruby!
+test_files: []