middleman-gnuplot 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d296d148bd098ee2ea558b7d38d9c42206e63ad989b4c62d9c97a726757e1ec9
-  data.tar.gz: b9729966785e245cf29abc49f2bfe7cc09af349775417ae489c81276cf653b3e
+  metadata.gz: 76c651dec2492e3bb75494cb89e3e31478fd7676d3a56964afef202716e7e233
+  data.tar.gz: 77ff5468d77b178341d2981ffb1bc7fc810440423835173a8d6af5fa24d567b0
 SHA512:
-  metadata.gz: b2505a038f28b98afa3d9fce1827e5f7e03242bf97e447f206e5217815db9eb2f2ab1f7f28d9f6870416bd0d40932292af179d828bb012d8d98fd0ea5efcc832
-  data.tar.gz: 07dfffddc1fbfd0cb585d07013506857894e68734e5781c7b5dde29b28848f7c81e737b11cfa988306dd2db979273e30e0c1102811d2528703d769af3dc99036
+  metadata.gz: cba0f5baeb6e693bdda4d44cd3686a2e6cc79372cf4fc8e687cf86aa139f7d2acf1606b0c02cbe98cdc12a559c801276977c416acc99d04e274635e4e2ce7952
+  data.tar.gz: e135f54970b188f1c0b97bcafc90a8b03df34414042c65c78ab0a3731116a661f5f8352cd0fb89badb91f784329393cc707db3237db1711f5ce055519c79c497

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

@@ -79,7 +79,8 @@ 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
 
@@ -168,9 +169,9 @@ module Middleman
 						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
@@ -178,9 +179,9 @@ module Middleman
             end
 
             if ser[:title].nil? == false
-                gp_command << {t:"#{ser[:title]}"}
+                gp_command << "t \"#{ser[:title]}\""
             else
-                gp_command << {t:''}
+                gp_command << "notitle"
             end
 
             gp_command << ", "
@@ -203,6 +204,8 @@ module Middleman
 						gp_command << "e\n"
 					end
 
+					gp_command = gp_command.join(" ")
+
 					puts "GP cmd: #{gp_command}"
 
 					@@gp.plot gp_command
@@ -217,14 +220,23 @@ module Middleman
 
       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 == ""
+
+						length = app.config[:gp_rndfilelength] unless app.config[:gp_rndfilelength].nil?
+
+						puts "Length of random filename: #{length}"
+
             loop do
-                filename = ([*('A'..'Z'),*('0'..'9')]).sample(app.config[:gp_rndfilelength]).join
+                filename = ([*('A'..'Z'),*('0'..'9')]).sample(length).join
 
                 break if @@plot_names.include?(filename) == false
             end

data/lib/middleman-gnuplot/version.rb

@@ -5,7 +5,7 @@
 
 module Middleman
   module Gnuplot
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   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.1
 platform: ruby
 authors:
 - Hermann Detz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-12 00:00:00.000000000 Z
+date: 2018-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-gnuplot