mushy 0.18.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88a3578100f93b47791d83299597e4b6a1d1ccabfaa8628eb5172617facf9b95
-  data.tar.gz: fa722d8dd776c1e311bea24ad94303785fd93ccc16eeebcd93783f9d25c3e0f5
+  metadata.gz: cfd4d2f868fa9bd4c147f4cd9c7af24cea6ad38934d2e2bec53a6c8c9e396345
+  data.tar.gz: bf919c0d4f927dbc8ef6705b183fea9aa8d2fa73f61354603e83d2c8d01e3842
 SHA512:
-  metadata.gz: 4eafe788eccb281c1e15bdc0cfae4dca68f1146894a7d28569347673f28ef265b5b8aa90f7fb6c21245e1ba15fceac2f2677420cc643dd535c8cd54062c7642d
-  data.tar.gz: 2568f50f7cdf5569605d89fe7e088036d48f106d10f2b45c2b29a25038f145d29bb2566f9d7271f642b11307cb5e9259e72ac4fb1f1b3826178e977532e7c8b3
+  metadata.gz: 9de7dae32eb11e0ae5448c0990e6a4be38483f3f38552e4bf519e6bdec047de6694c86734e57f2b3fe002a1ca263f9b0ed7232b1b42cc5290a2e99ee3d34745f
+  data.tar.gz: da103a79f76baa1cadc52d6a0f5100cfdb848212c9e6e1ac3b9dcb79fa14a527a8f1e7af8a4dc0d91e0e5d7ff77a142f8258308ecba819bfcf517a5772b03b68

data/lib/mushy/builder/index.rb

@@ -62,7 +62,9 @@ module Mushy
                     </header>
                     <section class="modal-card-body">
                         <div class="content">
-                            <div v-for="(fluxType, id) in fluxTypes">
+                            <div v-for="(fluxGroup) in fluxGroups">
+                            <h2 style="font-style:italic">{{fluxGroup.name}}</h2>
+                            <div v-for="(fluxType, id) in fluxGroup.fluxs">
                                 <div class="level">
                                   <div class="level-left"><h2>{{fluxType.title || fluxType.name}}</h2></div>
                                   <div class="level-right">
@@ -87,6 +89,7 @@ module Mushy
                                   <div v-for="(a, b) in fluxType.documentation" v-if="fluxType['detailsTab'] == b" v-html="a"></div>
                                 </div>
                             </div>
+                            </div>
                         </div>
                     </section>
                     <footer class="modal-card-foot">
@@ -236,7 +239,7 @@ module Mushy
                };
            },
            props: ['label', 'value', 'options', 'description', 'shrink'],
-           template: '<div><div class="level"><div class="level-left"><div class="level-item"><mip-label :id="id" :label="label" :description="description" :hide_description="shrink && !value"></mip-label></div><div class="level-item"> <a href="#" v-on:click.prevent.stop="shrink=false" v-show="shrink && !value">[^]</a></div></div></div> <span v-for="option in options" v-if="value && value.includes(option.id)">{{option.name}} <a href="#" v-on:click.prevent.stop="remove(option.id, value);$emit(\\'update:value\\', value)">[X]</a> </span> <a href="#" v-on:click.prevent.stop="doit(selectedValue, value);$emit(\\'update:value\\', value)">ADD</a> <div class="control"><select :name="id" v-if="value || !shrink" v-on:input="selectedValue=$event.target.value;" class="select"><option v-for="option in options" v-bind:value="option.id">{{option.name}}</option></select></div></div>'
+           template: '<div><div class="level"><div class="level-left"><div class="level-item"><mip-label :id="id" :label="label" :description="description" :hide_description="shrink && !value"></mip-label></div><div class="level-item"> <a href="#" v-on:click.prevent.stop="shrink=false" v-show="shrink && !value">[^]</a></div></div></div> <span v-for="option in options" v-if="value && value.includes(option.id)">{{option.name}} <a href="#" v-on:click.prevent.stop="remove(option.id, value);$emit(\\'update:value\\', value)">[X]</a> </span> <div class="control"><select :name="id" v-if="value || !shrink" v-on:input="selectedValue=$event.target.value;" class="select" v-on:change.prevent.stop="doit(selectedValue, value);$emit(\\'update:value\\', value);$event.target.value=\\'\\';"><option v-for="option in options" v-bind:value="option.id">{{option.name}}</option></select></div></div>'
        },
        boolean: {
            props: ['label', 'value', 'options', 'description', 'shrink'],
@@ -324,7 +327,7 @@ module Mushy
        });
    }
 
-   var thingTemplate = '<div v-bind:class="{ \\\'ml-3\\\': data.foghat==\\\'free\\\', \\\'column\\\': data.foghat!=\\\'free\\\', \\\'is-full\\\': data.foghat!=\\\'half\\\' && data.foghat!=\\\'free\\\', \\\'is-half\\\': data.foghat==\\\'half\\\' }">';
+   var thingTemplate = '<div v-show="data.hide != true" v-bind:class="{ \\\'ml-3\\\': data.foghat==\\\'free\\\', \\\'column\\\': data.foghat!=\\\'free\\\', \\\'is-full\\\': data.foghat!=\\\'half\\\' && data.foghat!=\\\'free\\\', \\\'is-half\\\': data.foghat==\\\'half\\\' }">';
    for (var property in components)
        thingTemplate = thingTemplate + '<mip-' + property + ' v-if="data.type == \\'' + property + '\\'" :id="id" ' + components[property].props.map(function(x){ return ':' + x + '.sync="data.' + x + '"';}).join(' ') + '></mip-' + property + '>'
    thingTemplate = thingTemplate + '</div>';
@@ -335,7 +338,7 @@ module Mushy
                       console: console,
                   }
         },
-        props: ['data', 'value', 'id', 'model', 'foghat'],
+        props: ['data', 'value', 'id', 'model', 'foghat', 'hide'],
         template: thingTemplate
     });
 
@@ -385,6 +388,16 @@ module Mushy
                  x['detailsTab'] = Object.getOwnPropertyNames(x.documentation)[0];
              } );
 
+             fluxGroups = []
+             fluxdata.fluxs.map(function(x) {
+                 if (x.fluxGroup) {} else { x.fluxGroup = { name: 'Others', position: 999999 } };
+                 rowboat = fluxGroups.filter(function(y) { return y.name == x.fluxGroup.name })[0];
+                 if (rowboat) {} else { fluxGroups.push(x.fluxGroup); x.fluxGroup.fluxs = [] }
+                 rowboat = fluxGroups.filter(function(y) { return y.name == x.fluxGroup.name })[0];
+                 rowboat.fluxs.push(x);
+             } );
+             fluxGroups = fluxGroups.sort(function(x, y) { return (x.position || 1000) - (y.position || 1000); })
+
              var configs = {};
              fluxdata.fluxs.map(function(x){
                  configs[x.name] = x.config;
@@ -446,7 +459,7 @@ module Mushy
                    },
                    id: { type: 'hide', value: '' },
                    name: { type: 'text', value: '' },
-                   flux: { type: 'select', value: fluxdata.fluxs[0].name, options: options},
+                   flux: { type: 'select', value: fluxdata.fluxs[0].name, options: options, hide: true },
                    open_flux: { type: 'button', name: 'Select a Flux', foghat: 'free', medium: 'hey', color: 'is-primary',
                                 click: function() {
                                            Vue.set(app.setup.fluxTypeSelect, 'is-active', true);
@@ -566,6 +579,7 @@ module Mushy
                      },
                      configs: configs,
                      fluxTypes: fluxTypesWithDetails,
+                     fluxGroups: fluxGroups,
                      setup: setup,
                      flux_name_for: function(ids, fluxes) {
                          var fluxs = fluxes.filter(function(x){ return ids.includes(x.id) });

data/lib/mushy/fluxs/bash.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'Bash',
+        title: 'Execute a command via bash',
         description: 'Run a bash command.',
+        fluxGroup: { name: 'Execute' },
         config: {
           command: {
                      description: 'The command to run in bash.',

data/lib/mushy/fluxs/browser.rb

@@ -7,6 +7,8 @@ module Mushy
     def self.details
       {
         name: 'Browser',
+        title: 'Use a browser',
+        fluxGroup: { name: 'Web' },
         description: 'Visit a page in a browser.',
         config: {
           url: {

data/lib/mushy/fluxs/build_csv.rb

@@ -9,6 +9,7 @@ module Mushy
         name: 'BuildCsv',
         title: "Build CSV",
         description: 'Build a CSV.',
+        fluxGroup: { name: 'CSV' },
         config: {
           input_path: {
                         description: 'The path to the set of records to include in the CSV.',

data/lib/mushy/fluxs/cli.rb

@@ -5,7 +5,8 @@ module Mushy
     def self.details
       {
         name: 'Cli',
-        title: 'Command Line Interface',
+        title: 'Start a flow via command line',
+        fluxGroup: { name: 'Starters', position: 0 },
         description: 'Accept CLI arguments from the run command.',
         config: {
         },

data/lib/mushy/fluxs/collection.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'Collection',
-        description: 'Collects events.',
+        title: 'Collect and retrieve events',
+        description: 'Collect and retrieve events for the flow.',
+        fluxGroup: { name: 'Flows' },
         config: {
           id: {
                 description: 'The path to the unique id in the body of the element.',

data/lib/mushy/fluxs/document.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'Document',
+        title: 'Make a multi-line liquid value',
         description: 'Create a multi-line document.',
+        fluxGroup: { name: 'Flows' },
         config: {
           document: {
                       description: 'The multi-line document you wish to create.',

data/lib/mushy/fluxs/environment.rb

@@ -5,8 +5,9 @@ module Mushy
     def self.details
       {
         name: 'Environment',
-        title: 'Environment Variables',
+        title: 'Pull environment variables',
         description: 'Pull environment variables.',
+        fluxGroup: { name: 'Environment' },
         config: {
           variables: {
                        description: 'Map the environment variables to a new event.',

data/lib/mushy/fluxs/file_watch.rb

@@ -7,7 +7,8 @@ module Mushy
     def self.details
       {
         name: 'FileWatch',
-        title: 'File Watcher',
+        title: 'Start a flow when files change',
+        fluxGroup: { name: 'Starters', position: 0 },
         description: 'Watch for file changes.',
         config: {
           directory: {
@@ -16,6 +17,12 @@ module Mushy
                        shrink:      true,
                        value:       '',
                      },
+          include_all_file_details: {
+                       description: 'If true, returns all details for the file. If false, just path & name are returned',
+                       type:        'boolean',
+                       shrink:      true,
+                       value:       '',
+                     }
         },
         examples: {
           "Files Added" => {
@@ -46,15 +53,14 @@ module Mushy
       }
     end
 
-    def loop &block
-
+    def loop(&block)
       directory = config[:directory].to_s != '' ? config[:directory] : Dir.pwd
 
       listener = Listen.to(directory) do |modified, added, removed|
         the_event = {
-                      modified: modified,
-                      added: added,
-                      removed: removed,
+                      modified: modified.map { |f| get_the_details_for(f) },
+                      added: added.map { |f| get_the_details_for(f) },
+                      removed: removed.map { |f| get_the_details_for(f) }
                     }
         block.call the_event
       end
@@ -69,6 +75,17 @@ module Mushy
       event
     end
 
+    def get_the_details_for(file)
+      if config[:include_all_file_details].to_s == 'true'
+        Mushy::Ls.new.process({}, { path: file })[0]
+      else
+        {
+          path: file,
+          name: file.split("\/").pop
+        }
+      end
+    end
+
   end
 
 end

data/lib/mushy/fluxs/filter.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'Filter',
+        title: 'Filter events',
         description: 'Filters events based on criteria.',
+        fluxGroup: { name: 'Flows' },
         config: {
           equal: {
                  description: 'Provide key/value pairs that must match in the event.',

data/lib/mushy/fluxs/format.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'Format',
+        title: 'Alter the format of an event',
         description: 'Return the event passed to it. This opens the opportunity to use the common fluxing to alter the event.',
+        fluxGroup: { name: 'Flows' },
         config: {},
         examples: {
           "Simplest Example" => {

data/lib/mushy/fluxs/git_log.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'GitLog',
+        title: 'Get git logs',
         description: 'Return git logs.',
+        fluxGroup: { name: 'Git' },
         config: {
           directory: {
                        description: 'The working directory in which the command will be run.',

data/lib/mushy/fluxs/global_variables.rb

@@ -7,7 +7,8 @@ module Mushy
     def self.details
       {
         name: 'GlobalVariables',
-        title: 'Global Variables',
+        title: 'Set global variables',
+        fluxGroup: { name: 'Flows' },
         description: 'Add global variables to use in any future flux. Returns what was passed to it.',
         config: {
           values: {

data/lib/mushy/fluxs/interval.rb

@@ -17,6 +17,8 @@ module Mushy
     def self.details
       {
         name: 'Interval',
+        title: 'Start a flow on a regular interval',
+        fluxGroup: { name: 'Starters', position: 0 },
         description: 'Fire an event every X minutes.',
         config: {},
       }.tap do |c|

data/lib/mushy/fluxs/ls.rb

@@ -2,10 +2,30 @@ module Mushy
 
   class Ls < Bash
 
+    def self.the_ls_command
+      @the_ls_command ||= find_the_right_ls_command_to_use
+    end
+
+    def self.find_the_right_ls_command_to_use
+      commands = [
+        'ls', # the normal method used to pull file information
+        'gls' # BSD users don't get the version of ls this needs,
+              # so we might need to use gls after the user runs (brew install coreutils)
+      ]
+
+      the_command_to_use = nil
+      while the_command_to_use.nil? && (command = commands.shift) # keep trying till we find one that works
+        the_command_to_use = command if Mushy::Bash.new.process({}, { command: "#{command} --full-time" })[:success]
+      end
+      the_command_to_use || -1
+    end
+
     def self.details
       {
         name: 'Ls',
+        title: 'List Files',
         description: 'Run the "ls" command.',
+        fluxGroup: { name: 'Files' },
         config: Mushy::Bash.details[:config].tap { |c| c.delete :command },
       }.tap do |c|
         c[:config][:recursive] = {
@@ -132,6 +152,8 @@ module Mushy
     end
 
     def process event, config
+      raise 'ls is not available' if self.class.the_ls_command == -1
+
       arguments = build_the_arguments_from config
 
       config[:command] = build_the_command_from arguments
@@ -142,7 +164,8 @@ module Mushy
     end
 
     def build_the_command_from arguments
-      "ls #{arguments.join(' ')}"
+      command = self.class.the_ls_command
+      "#{command} #{arguments.join(' ')}"
     end
 
     def build_the_arguments_from config
@@ -230,6 +253,10 @@ module Mushy
 
       result[:date] = Mushy::DateParts.parse result[:date]
 
+      if File.exist?(result[:name]) && result[:name].start_with?(directory)
+        result[:name] = result[:name].split("\/")[-1]
+      end
+
       result[:directory] = directory
 
       if result[:type] == 'd' && result[:directory] == result[:name]

data/lib/mushy/fluxs/parse_html.rb

@@ -8,6 +8,7 @@ module Mushy
       {
         name: 'ParseHtml',
         title: 'Parse HTML',
+        fluxGroup: { name: 'Web' },
         description: 'Extract data from HTML.',
         config: {
           path: {

data/lib/mushy/fluxs/pdf.rb

@@ -90,6 +90,7 @@ module Mushy
                                         }
                                },
         }
+        config[:fluxGroup] = { name: 'Export' }
       end
     end
 

data/lib/mushy/fluxs/pwd.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'Pwd',
+        title: 'Get the working directory',
         description: 'Run the "pwd" command.',
+        fluxGroup: { name: 'Environment' },
         config: Mushy::Bash.details[:config].tap { |c| c.delete :command },
       }.tap do |c|
         c[:examples] = {

data/lib/mushy/fluxs/read_csv.rb

@@ -8,6 +8,7 @@ module Mushy
       {
         name: 'ReadCsv',
         title: 'Read CSV',
+        fluxGroup: { name: 'CSV' },
         description: 'Read CSV content into events.',
         config: {
           data: {

data/lib/mushy/fluxs/read_file.rb

@@ -6,6 +6,7 @@ module Mushy
       {
         name: 'ReadFile',
         title: 'Read File',
+        fluxGroup: { name: 'Files' },
         description: 'Read a file.',
         config: {
           file: {

data/lib/mushy/fluxs/read_json.rb

@@ -8,6 +8,7 @@ module Mushy
       {
         name: 'ReadJson',
         title: 'Deserialize JSON',
+        fluxGroup: { name: 'JSON' },
         description: 'Read JSON and output it as an event.',
         config: {
           key: {

data/lib/mushy/fluxs/regex_matches.rb

@@ -0,0 +1,64 @@
+module Mushy
+  class RegexMatches < Flux
+    def self.details
+      {
+        name: 'RegexMatches',
+        title: 'Find regex matches',
+        description: 'Use a regex to search content.',
+        fluxGroup: { name: 'Regex' },
+        config: {
+          regex: { description: 'The regular expression to use.',
+                   type: 'text',
+                   value: '(\w+)' },
+          value: { description: 'The value against which to use the regular expression.',
+                   type: 'text',
+                   value: '{{value}}' }
+        },
+        examples: {
+          'Simple Example' => {
+                                description: 'The simplest regex.',
+                                input: { text: 'apple orange' },
+                                config: {
+                                  regex: '(\w+)',
+                                  value: 'apple orange'
+                                },
+                                result: [ { match1: 'apple' }, { match2: 'orange' } ]
+                              },
+          'Named Parameters' => {
+                         description: 'Named Parameters.',
+                         input: {
+                                  text: 'apple 1 orange 2'
+                                },
+                         config: {
+                                   regex: '(?&lt;name&gt;\w+) (?&lt;count&gt;\d+)',
+                                   value: '{{text}}'
+                                 },
+                         result: [ { name: 'apple', count: '1' }, { name: 'orange', count: '2' } ]
+                       },
+                  }
+    }
+    end
+
+    def process(_, config)
+      return [] unless config[:value]
+      return [] if (config[:regex] || '').strip == ''
+
+      keys = config[:regex].scan(/\?<(\w+)>/).flatten
+
+      regex = Regexp.new config[:regex]
+
+      config[:value].scan(regex).map do |match|
+        convert_the_match_to_a_hash match, keys
+      end
+    end
+
+    def convert_the_match_to_a_hash(match, keys)
+      {}.tap do |hash|
+        match.each_with_index do |item, index|
+          key = (keys[index] || "match#{index + 1}").to_sym
+          hash[key] = item
+        end
+      end
+    end
+  end
+end

data/lib/mushy/fluxs/screenshot.rb

@@ -92,6 +92,7 @@ module Mushy
                                         }
                                },
         }
+        config[:fluxGroup] = { name: 'Export' }
       end
     end
 

data/lib/mushy/fluxs/sense_hat_environmental_sensors.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'SenseHatEnvironmentalSensors',
+        title: 'Read Environmental Sensors',
         description: 'Pull values from the Sense HAT environmental sensors.',
+        fluxGroup: { name: 'SenseHAT' },
         config: Mushy::SimplePythonProgram.default_config,
       }.tap do |c|
         measurements

data/lib/mushy/fluxs/sense_hat_led_matrix.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'SenseHatLedMatrix',
+        title: 'Use LED Matrix',
         description: 'Interface with the LED Matrix.',
+        fluxGroup: { name: 'SenseHAT' },
         config: Mushy::SimplePythonProgram.default_config.tap do |config|
           config[:get_pixels] = {
                                   description: 'Specify the pixels you want returned as events. Use "all" to return all 64, 3,3 to return x:3 y:3, or "none" to return none.',

data/lib/mushy/fluxs/simple_python_program.rb

@@ -6,6 +6,7 @@ module Mushy
       Mushy::Bash.details[:config].tap do |config|
         config.delete :command
         config.delete :directory
+        config[:fluxGroup] = { name: 'Execute' }
       end
     end
 

data/lib/mushy/fluxs/smtp.rb

@@ -48,8 +48,9 @@ module Mushy
 
     def self.details
       {
-        name: 'Smtp',
+        name: 'Send Email Using SMTP',
         description: 'Send email through SMTP.',
+        fluxGroup: { name: 'Email' },
         config: {
           from: {
                   description: 'From whom the email will be sent.',

data/lib/mushy/fluxs/stdout.rb

@@ -5,7 +5,8 @@ module Mushy
     def self.details
       {
         name: 'Stdout',
-        title: 'Stdout / Print',
+        title: 'Export text to stdout',
+        fluxGroup: { name: 'Environment' },
         description: 'Standard Out',
         config: {
           message: {

data/lib/mushy/fluxs/times.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'Times',
+        title: 'Repeat an event X times',
         description: 'Return the event passed to it, X times.',
+        fluxGroup: { name: 'Flows' },
         config: {
           times: {
                    description: 'The number of times this event should be returned.',

data/lib/mushy/fluxs/twilio_message.rb

@@ -5,7 +5,8 @@ module Mushy
     def self.details
       {
         name: 'TwilioMessage',
-        title: 'Twilio Message',
+        title: 'Send SMS',
+        fluxGroup: { name: 'Twilio' },
         description: 'Send a Twilio Message.',
         config: {
           account_sid: {

data/lib/mushy/fluxs/write_file.rb

@@ -7,6 +7,7 @@ module Mushy
         name: 'WriteFile',
         title: 'Write File',
         description: 'Write a file.',
+        fluxGroup: { name: 'Files' },
         config: file_saving_config.merge({
                   data: {
                           description: 'The text to write. You can use Liquid templating here to pull data from the event, or write hardcoded data.',

data/lib/mushy/fluxs/write_json.rb

@@ -9,6 +9,7 @@ module Mushy
         name: 'WriteJson',
         title: 'Serialize as JSON',
         description: 'Write the incoming event as JSON.',
+        fluxGroup: { name: 'JSON' },
         config: {
           key: {
                 description: 'The key of the outgoing field that will contain the JSON.',

data/mushy.gemspec

@@ -4,7 +4,7 @@ require 'mushy/version'
 
 Gem::Specification.new do |s|
   s.name           = 'mushy'
-  s.version        = '0.18.0'
+  s.version        = '0.21.0'
   s.date           = '2020-11-23'
   s.summary        = 'Process streams of work using common modules.'
   s.description    = 'This tool assists in the creation and processing of workflows.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mushy
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Darren Cauthon
@@ -205,6 +205,7 @@ files:
 - lib/mushy/fluxs/read_csv.rb
 - lib/mushy/fluxs/read_file.rb
 - lib/mushy/fluxs/read_json.rb
+- lib/mushy/fluxs/regex_matches.rb
 - lib/mushy/fluxs/screenshot.rb
 - lib/mushy/fluxs/sense_hat_environmental_sensors.rb
 - lib/mushy/fluxs/sense_hat_led_matrix.rb