middleman-gnuplot 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d296d148bd098ee2ea558b7d38d9c42206e63ad989b4c62d9c97a726757e1ec9
-  data.tar.gz: b9729966785e245cf29abc49f2bfe7cc09af349775417ae489c81276cf653b3e
+  metadata.gz: 5c17a392a4f1cc289766f0b40a56555db9f5db6da02f1a14a32cbf9034c28a47
+  data.tar.gz: 9ed89c1e1414bbf4a65b22b4c5cc85fcc44464dd964cada51ab9c882b7848eb7
 SHA512:
-  metadata.gz: b2505a038f28b98afa3d9fce1827e5f7e03242bf97e447f206e5217815db9eb2f2ab1f7f28d9f6870416bd0d40932292af179d828bb012d8d98fd0ea5efcc832
-  data.tar.gz: 07dfffddc1fbfd0cb585d07013506857894e68734e5781c7b5dde29b28848f7c81e737b11cfa988306dd2db979273e30e0c1102811d2528703d769af3dc99036
+  metadata.gz: 8f4532fd93a3c31c0173726e2dc38c0cb1eeece4d32671768916ed696841857e78e36fe473a9a69a8e123d12d13b41cd395f0b4ba484f7c1f5606b58ec2e1130
+  data.tar.gz: 03f440a898cb902302433edfa303736cc38769eece7d228cc159ae3494b3757989cccaddc9e198a1e3efc52124dff7c0b707ea9af97788ac31eeafd51b98e088

data/README.md

@@ -1,7 +1,7 @@
-<Copyright (C) 2018 Hermann Detz>
+<!--- Copyright (C) 2018 Hermann Detz --->
 
-<This software may be modified and distributed under the terms>
-<of the MIT license.  See the LICENSE file for details.>
+<!--- This software may be modified and distributed under the terms
+of the MIT license.  See the LICENSE file for details. --->
 
 # middleman-gnuplot
 
@@ -26,6 +26,13 @@ Modify the `config.rb` of your project as follows:
       opts.gp_outdir = 'img' # directory holding plot files with build dir
       opts.gp_format = 'png' # determines output format (currently supports png and pdf)
     end
+
+If not specified, the plots will be generated with random filenames,
+which are 6 characters long. This setting can be overridden in `config.rb`
+to e.g. 8 using the following line:
+
+    set :gp_rndfilelength, 8
+
 ## Usage
 
 All functions return the output filename of the plot, which can be used
@@ -60,6 +67,25 @@ The middleman-gnuplot extension provides the following helper methods:
    image_tag plot_script("path_to_gnuplot_script", "filename", "Plot Title")
    ```
 
+* `plot_data(data, series, filename, title)`: Plots data points from a given array 
+   `data` directly. The data series can be specified as hashes within the array
+   `series`. Allowed fields are `:x`, `:y`, `:title` and `:style` (lines, points, 
+   linespoints, ...). The default style is lines. `filename` defines the output 
+   filename. If nil, a random filename is generated and returned by the function. 
+   The `title` parameter can be used to define a plot title.
+
+   ```ruby
+   image_tag plot_data([[1,2,1],[2,5,3],[3,3,1],[4,1,5]], 
+                       [{:x => 1, 
+                         :y => 2, 
+                         :title => "Series 1"},
+                        {:x => 1, 
+                         :y => 3, 
+                         :title => "Series 2", 
+                         :style => "points"}], 
+                         "filename", "Plot Title"
+   ```
+
 ## Note
 
 The build summary of middleman lists plot files  that were generated in 

data/lib/middleman-gnuplot/extension.rb

@@ -3,6 +3,7 @@ require "middleman-gnuplot/gp_helpers"
 require "middleman-core"
 require "numo/gnuplot"
 require "fileutils"
+require "time"
 
 module Middleman
   class GnuplotExtension < Middleman::Extension
@@ -39,6 +40,9 @@ module Middleman
     end
 
     # Generates a plot via gnuplot using a given expression.
+		#
+		# @deprecated Will be deprecated in the next version in favor of {#plot}.
+		#
     # The function must be provided as hash using the following fields:
     # @param [Array<Hash>] functions function definition hash
     # @option functions [String] expression expression hat can be processed by gnuplot (e.g. sin(x))
@@ -79,12 +83,15 @@ module Middleman
     # Generates a random filename, if the given paramter is nil or empty
     # Returns filename (given or random)
     # @param [String] filename input filename
-    def random_filename_if_nil filename=nil
+		# @param [Int] length length of random filename
+    def random_filename_if_nil filename=nil, length=6
         # stub method to enable documentation in yard
     end
 
     helpers do
       def plot_functions functions=[], filename=nil, title=nil
+				warn "plot_functions will be deprecated in the next version in favor of the new function plot"
+
         filename = random_filename_if_nil(filename)
 
         if title.nil?
@@ -129,6 +136,76 @@ module Middleman
         return outfile
       end
 
+      def plot functions=[], filename=nil, title=nil, options={}
+        filename = random_filename_if_nil(filename)
+
+        if title.nil?
+            title = ""
+        end
+
+        outfile = "#{app.config[:gp_outdir]}/#{filename}.#{app.config[:gp_format]}"
+
+        @@gp.set output:"./#{@@base_dir}/#{outfile}"
+        @@gp.set title:"#{title}"
+
+				if options.nil? == false
+					process_options options
+				end
+
+
+        gp_command = []
+
+        functions.each_with_index do |function,i|
+						if function[:expression].nil? == false
+							gp_command << function[:expression]
+						else
+							if function[:file].nil? == false and
+								function[:colx].nil? == false and
+								function[:coly].nil? == false
+								gp_command << "'#{function[:file]}' using #{function[:colx]}:#{function[:coly]} "
+							end
+						end
+
+            if function[:style].nil? == false
+                gp_command << {w:function[:style]}
+            else
+                gp_command << {w:'lines'}
+            end
+
+						if function[:dashtype].nil? == false
+							gp_command << "dt #{function[:dashtype]}"
+						end
+
+						if function[:width].nil? == false
+							gp_command << "lw #{function[:width]}"
+						end
+
+            if function[:color].nil? == false
+                gp_command << {lc:"rgb '#{function[:color]}'"}
+            end
+
+            if function[:title].nil? == false
+                gp_command << {t:"#{function[:title]}"}
+            else
+                gp_command << {t:''}
+            end
+
+						if function[:ymin].nil? == false
+							gp_command << "y1=#{function[:ymin]}"
+						end
+
+            gp_command << ", "
+        end
+
+        gp_command[-1] = ''
+
+        @@gp.plot gp_command
+
+        register_filename(filename)
+
+        return outfile
+      end
+
       def plot_script script, filename=nil, title=nil
         filename = random_filename_if_nil(filename)
         
@@ -149,85 +226,99 @@ module Middleman
         return outfile
       end
 
-			def plot_data data, series=nil, filename=nil, title=nil
-				unless series.nil?
-					filename = random_filename_if_nil(filename)
+      def plot_data data, series=nil, filename=nil, title=nil
+        unless series.nil?
+          filename = random_filename_if_nil(filename)
 
-					if title.nil?
-							title = ""
-					end
+          if title.nil?
+              title = ""
+          end
 
-					outfile = "#{app.config[:gp_outdir]}/#{filename}.#{app.config[:gp_format]}"
+          outfile = "#{app.config[:gp_outdir]}/#{filename}.#{app.config[:gp_format]}"
 
-					@@gp.set output:"./#{@@base_dir}/#{outfile}"
-					@@gp.set title:"#{title}"
+          @@gp.set output:"./#{@@base_dir}/#{outfile}"
+          @@gp.set title:"#{title}"
 
-					gp_command = []
+          gp_command = []
 
-					series.each do |ser|
-						gp_command << "\"-\" u #{ser[:x]}:#{ser[:y]}"
+          series.each do |ser|
+            gp_command << "\"-\" u #{ser[:x]}:#{ser[:y]}"
 
             if ser[:style].nil? == false
-                gp_command << {w:ser[:style]}
+                gp_command << "w #{ser[:style]}"
             else
-                gp_command << {w:'lines'}
+                gp_command << "w lines"
             end
 
             if ser[:color].nil? == false
-                gp_command << {lc:"rgb '#{ser[:color]}'"}
+              gp_command << {lc:"rgb '#{ser[:color]}'"}
             end
 
             if ser[:title].nil? == false
-                gp_command << {t:"#{ser[:title]}"}
+              gp_command << "t \"#{ser[:title]}\""
             else
-                gp_command << {t:''}
+              gp_command << "notitle"
             end
 
+						if ser[:width].nil? == false
+							gp_command << "lw #{ser[:width]}"
+						end
+
             gp_command << ", "
-					end
+          end
 
-					gp_command[-1] = ''
-					gp_command << "\n"
+          gp_command[-1] = ''
+          gp_command << "\n"
 
-					(1..series.size).each do
-						data.each do |line|
-						tmpstring = ""
+          (1..series.size).each do
+            data.each do |line|
+              tmpstring = ""
 
-						line.each do |col|
-							tmpstring << "#{col}\t"
-						end
+              line.each do |col|
+                tmpstring << "#{col}\t"
+              end
 
-							gp_command << "#{tmpstring}\n"
-						end
+              gp_command << "#{tmpstring}\n"
+            end
 
-						gp_command << "e\n"
-					end
+            gp_command << "e\n"
+          end
 
-					puts "GP cmd: #{gp_command}"
+          gp_command = gp_command.join(" ")
 
-					@@gp.plot gp_command
+          puts "GP cmd: #{gp_command}"
 
+          @@gp.plot gp_command
 
-					register_filename(filename)
 
-					return outfile
-				end
-			end
+          register_filename(filename)
+
+          return outfile
+        end
+      end
 
 
       private
 
-      # Generates a random filename, if the given paramter is nil or empty
+      # Generates a random filename, if the given paramter is nil or empty.
+      # The length of the random string can be overridden by setting
+      # app.config[:gp_rndfilelength] in config.rb of the middleman project.
+      #
       # Returns filename (given or random)
       # Params.
       # +filename+:: input filename
-      def random_filename_if_nil filename=nil
+      # +length+:: length of random filename
+      def random_filename_if_nil filename=nil, length=6
         if filename.nil? or filename == ""
-            loop do
-                filename = ([*('A'..'Z'),*('0'..'9')]).sample(app.config[:gp_rndfilelength]).join
+          length = app.config[:gp_rndfilelength] unless app.config[:gp_rndfilelength].nil?
 
-                break if @@plot_names.include?(filename) == false
-            end
+          puts "Length of random filename: #{length}"
+
+          loop do
+            filename = ([*('A'..'Z'),*('0'..'9')]).sample(length).join
+
+            break if @@plot_names.include?(filename) == false
+          end
         end
         
         return filename
@@ -241,7 +332,7 @@ module Middleman
       # +filename+:: filename to be added to array
       def register_filename filename
         if @@plot_names.include?(filename)
-            message "Warning: Filename #{filename} for plot already in use!", :warning
+          message "Warning: Filename #{filename} for plot already in use!", :warning
         end
 
         @@plot_names.append(filename)
@@ -258,15 +349,127 @@ module Middleman
 
         case type
         when :warning
-            colString = "\033[1;33m"
+          colString = "\033[1;33m"
         when :error
-            colString = "\033[1;31m"
+          colString = "\033[1;31m"
         end
 
         message = "#{colString}#{offset}middleman-gnuplot: #{text}#{colReset}"
 
         puts message
       end
+
+			# Processes a set of options that should be passed to gnuplot.
+			# Params.
+			# @param [array of hashes] an array of hashes that contain the options
+			# @option :datafilesep data file separator (e.g. '\t' or ' ')
+			# @option :timefmt a string indicating the time format that should be used
+			# @option :xtype only required if it should be set to :date
+			# @option :ytype only required if it should be set to :date
+			# @option :xrange a string indicating the x-axis range
+			# @option :yrange a string indicating the y-axis range
+			# @option :xformat a string indicating the x-axis format
+			# @option :yformat a string indicating the y-axis format
+			# @option :key a string to place or modify the key
+			def process_options options={}
+				if options[:term].nil? == false
+					@@gp.set term:"#{options[:term]}"
+				end
+
+				if options[:datafilesep].nil? == false
+					@@gp.set "datafile separator '#{options[:datafilesep]}'"
+				end
+
+				if ((options[:xtype].nil? == false and options[:xtype] == :date) or
+					(options[:ytype].nil? == false and options[:ytype] == :date)) and
+					(options[:timefmt].nil? == false)
+					if options[:xtype] == :date
+						@@gp.set "xdata time"
+					end
+
+					if options[:ytype] == :date
+						@@gp.set "ydata time"
+					end
+
+					@@gp.set "timefmt '#{options[:timefmt]}'"
+				end
+				
+				if options[:xrange].nil? == false
+					if options[:xtype].nil? == false and options[:xtype] == :date
+						@@gp.set "xrange ['#{Time.at(options[:xrange].begin).strftime("%Y-%m-%d %H:%M:%S")}':'#{Time.at(options[:xrange].end).strftime("%Y-%m-%d %H:%M:%S")}']"
+					else
+						@@gp.set "xrange [#{options[:xrange].begin}:#{options[:xrange].end}]"
+					end
+				else
+					@@gp.unset "xrange"
+				end
+
+				if options[:yrange].nil? == false
+					if options[:ytype].nil? == false and options[:ytype] == :date
+						@@gp.set "yrange ['#{Time.at(options[:yrange].begin).strftime("%Y-%m-%d %H:%M:%S")}':'#{Time.at(options[:yrange].end).strftime("%Y-%m-%d %H:%M:%S")}']"
+					else
+						@@gp.set "yrange [#{options[:yrange].begin}:#{options[:yrange].end}]"
+					end
+				else
+					@@gp.unset "yrange"
+				end
+
+				if options[:xtics].nil? == false
+					@@gp.set "xtics #{options[:xtics]}"
+				end
+
+				if options[:ytics].nil? == false
+					@@gp.set "ytics #{options[:ytics]}"
+				end
+
+				if options[:mxtics].nil? == false
+					@@gp.set "mxtics #{options[:mxtics]}"
+				end
+
+				if options[:mytics].nil? == false
+					@@gp.set "mytics #{options[:mytics]}"
+				end
+
+				if options[:logx].nil? == false and options[:logx] == true
+					@@gp.set "log x"
+				else
+					@@gp.unset "log x"
+				end
+
+				if options[:logy].nil? == false and options[:logy] == true
+					@@gp.set "log y"
+				else
+					@@gp.unset "log y"
+				end
+
+				if options[:xformat].nil? == false
+					@@gp.set "format x '#{options[:xformat]}'"
+				end
+
+				if options[:yformat].nil? == false
+					@@gp.set "format y '#{options[:yformat]}'"
+				end
+
+				if options[:xlabel].nil? == false
+					@@gp.set "xlabel '#{options[:xlabel]}'"
+				else
+					@@gp.unset "xlabel"
+				end
+
+				if options[:ylabel].nil? == false
+					@@gp.set "ylabel '#{options[:ylabel]}'"
+				else
+					@@gp.unset "ylabel"
+				end
+
+				if options[:key].nil? == false
+					@@gp.set "key #{options[:key]}"
+				end
+
+				if options[:grid].nil? == false
+					@@gp.set "grid #{options[:grid]}"
+				end
+			end
     end
   end
 end

data/lib/middleman-gnuplot/gp_helpers.rb

@@ -15,6 +15,8 @@ module Middleman
                 term = 'pngcairo'
             when 'pdf'
                 term = 'pdfcairo'
+						when 'svg'
+								term = 'svg'
             else
                 term = 'pngcairo'
             end

data/lib/middleman-gnuplot/version.rb

@@ -5,7 +5,7 @@
 
 module Middleman
   module Gnuplot
-    VERSION = "0.2.0"
+    VERSION = "0.2.2"
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-gnuplot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Hermann Detz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-12 00:00:00.000000000 Z
+date: 2023-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-gnuplot
@@ -63,7 +63,7 @@ homepage: https://github.com/hermanndetz/middleman-gnuplot
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,9 +78,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Middleman extension for gnuplot
 test_files: []