middleman-gnuplot 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 071fc96ea7edf03919474b030367b44a9af58abe
-  data.tar.gz: 48713824fe62f43d7e8936b674ca4be7a5cb5bc7
+  metadata.gz: 15fda679ea252f213b2952d616710ff9e8967f93
+  data.tar.gz: bb5c0a442a12bda847cd88406b7ff5b65855a487
 SHA512:
-  metadata.gz: b67ca783f3617ae2ed436abade4f0d5c4bfac922300a1a6f2ca93f8d8ed92d5f02ab83b4a26bcdd009ccb47d479d248b7f79569378d156104d94b7c2b6dcd2c8
-  data.tar.gz: 15c1526067544731bcc1726f853efc1d1867892d8151d2167a958ce3e1249c91562ef33473a85471611f7d1091866d9460f255ff43323e7c1698dfeb0413b0b3
+  metadata.gz: fd2373b58e1837f009f77c8399eeaec32d85f7d7419f4e37ace228cdeab6c5531c0e082055a74c7993abcbfb0c0fcc6fe8500bf44291e2427bddbdd8f264e69c
+  data.tar.gz: f725dd22211886fa0accd53bac00c9d5f8076167697e735e7ce4dd96f02a09a7b3cff10251f3415ba967f7dd9011bc622db2d879e9c305233d8abad20e0345d4

data/.gitignore

@@ -0,0 +1,5 @@
+doc
+Gemfile.lock
+.yardoc
+.rspec
+*.gem

data/.yardopts

@@ -0,0 +1 @@
+lib/**/*.rb

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-gnuplot.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-html-matchers'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Hermann Detz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+<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.>
+
+# middleman-gnuplot
+
+This extension to the [Middleman](http://middlemanapp.com/) framework
+provides helper functions to generate plots using gnuplot.
+
+## Setup
+
+Add the gem to your Gemfile:
+
+    gem 'middleman-gnuplot', :path => "path-to/middleman-gnuplot"
+
+Update your gem list:
+
+    $ bundle install
+
+
+Modify the `config.rb` of your project as follows:
+
+    activate :gnulot do |opts|
+      opts.gp_tmpdir = 'tmp' # path, where plots are stored before copied to build dir
+      opts.gp_outdir = 'img' # directory holding plot files with build dir
+      opts.gp_format = 'png' # determines output format (currently supports png and pdf)
+    end
+## Usage
+
+All functions return the output filename of the plot, which can be used
+as argument for the `image_tag` helper function.
+
+The middleman-gnuplot extension provides the following helper methods:
+
+* `plot_functions ([{:expression, :style, :color}], filename, plot title)`:
+   Plot simple expressions, which can be defined as single hash or array thereof.
+   The function returns a filename, which can be used as argument for the
+   `image_tag` helper. `expression` can hold terms that can be interpreted by
+   gnuplot, e.g. sin(x) or similar. `style`: lines, points, etc. `color` takes
+   an RGB color definition in hex format. `filename`defines the output filename.
+   If nil, a random filename is generated and returned by the function.
+
+    ```ruby
+   image_tag plot_functions([{:expression => "sin(x)",
+                              :style => "lines",
+                              :color => "#4575B4"},
+                             {:expression => "tan(x)",
+                              :color => "#D73027"}],
+                              "filename",
+                              "Plot Title")
+   ```
+
+* `plot_script(script, filename, title)`: This helper can be used to
+   generate a plot with a gnuplot script. `script` should contain the
+   path to the gnuplot script. `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_script("path_to_gnuplot_script", "filename", "Plot Title")
+   ```
+
+## Note
+
+The build summary of middleman lists plot files  that were generated in 
+previous runs as being _removed_ from the build directory. Nevertheless,
+the plots generated in the current run are moved to the build directory
+_after_ the middleman sitemap is evaluated and therefore do not show up
+in this list.
+
+Feel free to contact me, if you have a better solution for this issue!
+
+## Feedback & Contributions
+
+1. Fork it ( http://github.com/hermanndetz/middleman-gnuplot/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/middleman-gnuplot/extension.rb

@@ -0,0 +1,192 @@
+require "middleman-gnuplot/version"
+require "middleman-gnuplot/gp_helpers"
+require "middleman-core"
+require "numo/gnuplot"
+require "fileutils"
+
+module Middleman
+  class GnuplotExtension < Middleman::Extension
+
+    option :gp_outdir, nil,         'Output path for generated plots'
+    option :gp_tmpdir, nil,         'Path where gnuplot files are stored before being merged into build'
+    option :gp_format, 'png',       'Output file format'
+    option :gp_rndfilelength, 8,    'Length of randomly generated filenames'
+
+    @@base_dir = ""
+    @@plot_names = []
+
+    # Initializes the middleman-gnuplot extension.
+    def initialize(app, options_hash={}, &block)
+      super
+      app.config[:gp_outdir] = options.gp_outdir
+      app.config[:gp_tmpdir] = options.gp_tmpdir
+      app.config[:gp_format] = options.gp_format
+
+      @@base_dir = "./#{app.config[:gp_tmpdir]}/#{app.config[:images_dir]}/"
+
+      FileUtils.mkdir_p "#{@@base_dir}/#{app.config[:gp_outdir]}/"
+      
+      term = Middleman::Gnuplot::get_gnuplot_term(options.gp_format)
+
+      @@gp = Numo::Gnuplot.new
+      @@gp.debug_on
+      @@gp.set term:"#{term}"
+
+      app.after_build do |builder|
+        # Move generated plots to build dir
+        FileUtils.cp_r @@base_dir, app.config[:build_dir]
+      end
+    end
+
+    # Generates a plot via gnuplot using a given expression.
+    # 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))
+    # @option functions [String] style _lines_ or _points_
+    # @option functions [String] color RGB colro definition in hex format
+    # @option functions [String] title name of trace
+    # @param [String] filename base filename for output file
+    # @param [String] title plot title
+    def plot_functions (functions=[], filename=nil, title=nil)
+        # stub method to enable documentation in yard
+    end
+
+    # Generates a plot directly from an existing gnuplot script
+    # Params:
+    # @param [String] script path to the gnuplot script
+    # @param [String] filename for output file (can be overridden in script)
+    # @param [String] title plot title (can be overridden in script)
+    def plot_script (script, filename=nil, title=nil)
+        # stub method to enable documentation in yard
+    end
+
+    # Generates a random filename, if the given paramter is nil or empty
+    # Returns filename (given or random)
+    # Params.
+    # +filename+:: input filename
+    def random_filename_if_nil (filename=nil)
+        # stub method to enable documentation in yard
+    end
+
+    helpers do
+      def plot_functions (functions=[], filename=nil, title=nil)
+        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}"
+
+        gp_command = []
+
+        functions.each_with_index do |function,i|
+            gp_command << function[:expression]
+
+            if function[:style].nil? == false
+                gp_command << {w:function[:style]}
+            else
+                gp_command << {w:'lines'}
+            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
+
+            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)
+        
+        outfile = "#{app.config[:gp_outdir]}/#{filename}.#{app.config[:gp_format]}"
+
+        Numo.gnuplot do
+            set output: "./#{@@base_dir}/#{outfile}"
+
+            unless title.nil? 
+                set title: title
+            end
+
+            load script
+        end
+
+        register_filename(filename)
+        
+        return outfile
+      end
+
+
+      private
+
+      # Generates a random filename, if the given paramter is nil or empty
+      # Returns filename (given or random)
+      # Params.
+      # +filename+:: input filename
+      def random_filename_if_nil (filename=nil)
+        if filename.nil? or filename == ""
+            loop do
+                filename = ([*('A'..'Z'),*('0'..'9')]).sample(app.config[:gp_rndfilelength]).join
+
+                break if @@plot_names.include?(filename) == false
+            end
+        end
+        
+        return filename
+      end
+
+      # Adds a generated or given filename to the log array to ensure
+      # unique plot names, if no filename is given.
+      # Note: In case a given filename already exists - e.g. because a 
+      # user adds the same filename twice - a warning is issued.
+      # Params.
+      # +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
+        end
+
+        @@plot_names.append(filename)
+      end
+
+      # Prints a colored text message to terminal.
+      # Params.
+      # +text+:: the message body to be printed
+      # +type+:: :warning (yellow) or :error (red)
+      def message (text, type=:warning)
+        colString = ''
+        colReset = "\033[0m"
+        offset = "\033[14C"
+
+        case type
+        when :warning
+            colString = "\033[1;33m"
+        when :error
+            colString = "\033[1;31m"
+        end
+
+        message = "#{colString}#{offset}middleman-gnuplot: #{text}#{colReset}"
+
+        puts message
+      end
+    end
+  end
+end

data/lib/middleman-gnuplot/gp_helpers.rb

@@ -0,0 +1,25 @@
+# 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.
+
+module Middleman
+    module Gnuplot
+
+    module_function
+        def get_gnuplot_term (extension)
+            term = ''
+
+            case extension
+            when 'png'
+                term = 'pngcairo'
+            when 'pdf'
+                term = 'pdfcairo'
+            else
+                term = 'pngcairo'
+            end
+
+            return term
+        end
+    end
+end

data/lib/middleman-gnuplot/version.rb

@@ -0,0 +1,11 @@
+# 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.
+
+module Middleman
+  module Gnuplot
+    VERSION = "0.1.1"
+  end
+end
+

data/lib/middleman-gnuplot.rb

@@ -0,0 +1,10 @@
+# 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.
+
+::Middleman::Extensions.register :gnuplot do
+    require_relative 'middleman-gnuplot/extension'
+    Middleman::GnuplotExtension
+end
+

data/lib/middleman_extension.rb

@@ -0,0 +1,6 @@
+# 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.
+
+require 'middleman-gnuplot'

data/middleman-gnuplot.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-gnuplot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-gnuplot"
+  spec.version       = Middleman::Gnuplot::VERSION
+  spec.authors       = ["Hermann Detz"]
+  spec.email         = ["hermann.detz@gmail.com"]
+  spec.description   = <<-EOF 
+                       This middleman extension provides helper functions,
+                       which allow to create plots using gnuplot and
+                       integrate them easily with middleman pages.
+                       EOF
+  spec.summary       = %q{Middleman extension for gnuplot}
+  spec.homepage      = "https://github.com/hermanndetz/middleman-gnuplot"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "numo-gnuplot", ["~> 0.2.4"]
+  spec.add_runtime_dependency "middleman-core", ["~> 4.0"]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-gnuplot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Hermann Detz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-gnuplot
@@ -47,7 +47,18 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".yardopts"
+- Gemfile
+- LICENSE
+- README.md
+- lib/middleman-gnuplot.rb
+- lib/middleman-gnuplot/extension.rb
+- lib/middleman-gnuplot/gp_helpers.rb
+- lib/middleman-gnuplot/version.rb
+- lib/middleman_extension.rb
+- middleman-gnuplot.gemspec
 homepage: https://github.com/hermanndetz/middleman-gnuplot
 licenses:
 - MIT