vop 0.3.1 → 0.3.4

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: vop
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.4
 platform: ruby
 authors:
 - Philipp T.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2018-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: terminal-table
+  name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: net-ssh
+  name: net-scp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: net-scp
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: docopt
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -100,30 +100,44 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,11 +150,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Automated processes fail more consistently, that''s why I wrote a tool
-  to make scripts that will do things that we won''t have to do ourselves then. (see
-  xkcd #1629)'
+description: Automation framework with a plugin/command architecture, entities, contributions,
+  filters and asynchronous workers. Shell included, web interface in a separate project.
 email:
-- philipp@virtualop.org
+- philipp@hitchhackers.net
 executables:
 - vop
 extensions: []
@@ -151,54 +164,73 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- bin/vop.rb
+- bin/console
+- bin/setup
 - bin/vop.sh
 - exe/vop
+- lib/boot.rb
+- lib/core/meta/commands/new_command.rb
+- lib/core/meta/commands/new_plugin.rb
+- lib/core/meta/commands/search_gems_for_plugins.rb
+- lib/core/meta/commands/search_path.rb
+- lib/core/meta/commands/set.rb
+- lib/core/meta/commands/show.rb
+- lib/core/meta/commands/show_config.rb
+- lib/core/meta/commands/who_provides.rb
+- lib/core/meta/meta.plugin
+- lib/core/shell/commands/change_loglevel.rb
+- lib/core/shell/commands/clear_context.rb
+- lib/core/shell/commands/edit.rb
+- lib/core/shell/commands/help.rb
+- lib/core/shell/commands/reset.rb
+- lib/core/shell/commands/show_context.rb
+- lib/core/shell/commands/source.rb
+- lib/core/shell/shell.plugin
+- lib/core/structure/commands/collect_contributions.rb
+- lib/core/structure/commands/disable_contributor.rb
+- lib/core/structure/commands/generate_entity_commands.rb
+- lib/core/structure/commands/generate_invalidation_commands.rb
+- lib/core/structure/commands/list_commands.rb
+- lib/core/structure/commands/list_contributors.rb
+- lib/core/structure/commands/list_entities.rb
+- lib/core/structure/commands/list_plugins.rb
+- lib/core/structure/commands/register_contributor.rb
+- lib/core/structure/structure.plugin
 - lib/vop.rb
-- lib/vop/command.rb
-- lib/vop/command_loader.rb
-- lib/vop/entity.rb
-- lib/vop/loader.rb
-- lib/vop/plugin.rb
-- lib/vop/plugin_loader.rb
-- lib/vop/plugins/core/commands/clear_context.rb
-- lib/vop/plugins/core/commands/collect_contributions.rb
-- lib/vop/plugins/core/commands/edit.rb
-- lib/vop/plugins/core/commands/help.rb
-- lib/vop/plugins/core/commands/identity.rb
-- lib/vop/plugins/core/commands/list_contributors.rb
-- lib/vop/plugins/core/commands/list_entities.rb
-- lib/vop/plugins/core/commands/pry.rb
-- lib/vop/plugins/core/commands/reset.rb
-- lib/vop/plugins/core/commands/show_context.rb
-- lib/vop/plugins/core/commands/source.rb
-- lib/vop/plugins/core/commands/system_call.rb
-- lib/vop/plugins/core/core.plugin
-- lib/vop/plugins/core/helpers/command_loader/command_syntax.rb
-- lib/vop/plugins/core/helpers/command_loader/contributions.rb
-- lib/vop/plugins/core/helpers/command_loader/entities.rb
-- lib/vop/plugins/core/helpers/helper.rb
-- lib/vop/plugins/core/helpers/plugin_loader/plugin_syntax.rb
-- lib/vop/plugins/meta/commands/add_search_path.rb
-- lib/vop/plugins/meta/commands/delete_plugin.rb
-- lib/vop/plugins/meta/commands/list_commands.rb
-- lib/vop/plugins/meta/commands/list_plugins.rb
-- lib/vop/plugins/meta/commands/new_command.rb
-- lib/vop/plugins/meta/commands/new_plugin.rb
-- lib/vop/plugins/meta/commands/show_search_path.rb
-- lib/vop/plugins/meta/commands/who_provides.rb
-- lib/vop/plugins/meta/meta.plugin
-- lib/vop/plugins/ssh/commands/scp.rb
-- lib/vop/plugins/ssh/commands/ssh.rb
-- lib/vop/plugins/ssh/ssh.plugin
-- lib/vop/shell.rb
-- lib/vop/shell/backend.rb
-- lib/vop/shell/base_shell.rb
-- lib/vop/shell/formatter.rb
-- lib/vop/shell/vop_shell_backend.rb
+- lib/vop/objects/chain.rb
+- lib/vop/objects/command.rb
+- lib/vop/objects/command_param.rb
+- lib/vop/objects/entities.rb
+- lib/vop/objects/entity.rb
+- lib/vop/objects/entity_definition.rb
+- lib/vop/objects/filter.rb
+- lib/vop/objects/plugin.rb
+- lib/vop/objects/request.rb
+- lib/vop/objects/response.rb
+- lib/vop/objects/thing_with_params.rb
+- lib/vop/parts/command_loader.rb
+- lib/vop/parts/dependency_resolver.rb
+- lib/vop/parts/entity_loader.rb
+- lib/vop/parts/executor.rb
+- lib/vop/parts/filter_loader.rb
+- lib/vop/parts/plugin_finder.rb
+- lib/vop/parts/plugin_loader.rb
+- lib/vop/shell/shell.rb
+- lib/vop/shell/shell_formatter.rb
+- lib/vop/shell/shell_input.rb
+- lib/vop/shell/shell_input_readline.rb
+- lib/vop/shell/shell_input_testable.rb
+- lib/vop/syntax/command_syntax.rb
+- lib/vop/syntax/entity_syntax.rb
+- lib/vop/syntax/filter_syntax.rb
+- lib/vop/syntax/plugin_syntax.rb
+- lib/vop/util/errors.rb
+- lib/vop/util/pluralizer.rb
+- lib/vop/util/worker.rb
 - lib/vop/version.rb
+- lib/vop/vop.rb
 - vop.gemspec
-homepage: http://www.virtualop.org
+homepage: http://virtualop.org
 licenses: []
 metadata: {}
 post_install_message: 
@@ -217,8 +249,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
-summary: The virtualop is a tool for automating things.
+summary: The vop is a scripting framework.
 test_files: []

data/bin/vop.rb

@@ -1,28 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'pathname'
-
-$: << File.join(Pathname.new(File.join(File.dirname(__FILE__), '..')).realpath, 'lib')
-
-require 'vop/shell'
-require 'docopt'
-require 'pp'
-
-begin
-  shell = Vop::Shell::setup()
-  if shell.options["--execute"]
-    last_response = shell.execute(shell.options["--execute"])
-  else
-    last_response = shell.run_cli
-  end
-
-  # TODO exit_status = last_response && last_response.status == Vop.Status::OK ? 0 : 1
-  exit 0
-rescue => detail
-  if detail.is_a? Docopt::Exit
-    puts detail.message
-  else
-    $stderr.puts "error : #{detail.message}\n#{detail.backtrace[0..9].join("\n")}"
-    exit 42
-  end
-end

data/lib/vop/command.rb

@@ -1,168 +0,0 @@
-module Vop
-
-  class Command
-
-    attr_reader :name
-    attr_reader :plugin
-
-    attr_accessor :block
-    attr_accessor :description
-    attr_accessor :show_options
-
-    attr_reader :params
-
-    def initialize(plugin, name)
-      @plugin = plugin
-      @name = name
-      @block = lambda { |params| $logger.warn "#{name} not yet implemented!" }
-      @params = []
-      @show_options = {}
-    end
-
-    def inspect
-      "Vop::Command #{@name}"
-    end
-
-    def source
-      @plugin.command_source(name)
-    end
-
-    def short_name
-      name.split(".").last
-    end
-
-    def param(name)
-      params.select { |param| param[:name] == name }.first || nil
-    end
-
-    # the default param is the one used when a command is called with a single "scalar" param only, like
-    #   @op.foo("zaphod")
-    # if a parameter is marked as default, it will be assigned the value "zaphod" in this case.
-    # if there's only a single param, it's the default param by default (ha!)
-    def default_param
-      if params.size == 1
-        params.first
-      else
-        params.select { |param| param[:default_param] == true }.first || nil
-      end
-    end
-
-    def mandatory_params
-      params.select do |p|
-        p[:mandatory]
-      end
-    end
-
-    def lookup(param_name, params)
-      p = param(param_name)
-      raise "no such param : #{param_name} in command #{name}" unless p
-
-      if p.has_key? :lookup
-        p[:lookup].call(params)
-      else
-        $logger.debug "no lookups for #{param_name}"
-        []
-      end
-    end
-
-    # accepts arguments as handed in by :define_method and prepares them
-    # into the +params+ structure expected by command blocks
-    def prepare_params(ruby_args, extra = {})
-      result = {}
-      if ruby_args
-        if ruby_args.is_a? Hash
-          result = ruby_args
-          ruby_args.each do |k,v|
-            p = param(k)
-            if p
-              # values are auto-boxed into an array if the param expects multiple values
-              if p[:multi] && ! v.is_a?(Array) then
-                $logger.debug("autoboxing for #{p[:name]}")
-                v = [ v ]
-              # array values are auto-unboxed if the param doesn't want multi
-              elsif ! p[:multi] && v.is_a?(Array) && v.length == 1
-                $logger.debug("autounboxing for #{p[:name]}")
-                v = v.first
-              end
-            end
-            result[k] = v
-          end
-        else
-          # if there's a default param, it can be passed as "scalar" param
-          # (as opposed to the usual hash) to execute, but will be converted
-          # into a "normal" named param
-          dp = default_param
-          if dp
-            result = {dp[:name] => ruby_args}
-          end
-        end
-      end
-
-      if extra.keys.size > 0
-        result.merge! extra
-      end
-
-      # add in defaults (for all params that have not been specified)
-      params.each do |p|
-        unless result.has_key? p[:name]
-          if p[:default]
-            result[p[:name]] = p[:default]
-          end
-        end
-      end
-
-      result
-    end
-
-    def execute(param_values, extra = {})
-      prepared = prepare_params(param_values, extra)
-
-      block_param_names = self.block.parameters.map { |x| x.last }
-
-      #puts "executing #{self.name} : prepared : #{prepared.inspect}"
-
-      payload = []
-      context = {} # TODO should this be initialized?
-
-      block_param_names.each do |name|
-        param = nil
-
-        case name.to_s
-        when 'params'
-          param = prepared
-        when 'plugin'
-          param = self.plugin
-        when 'context'
-          param = context
-        when 'shell'
-          raise "shell not supported" unless extra.has_key? 'shell'
-          param = extra['shell']
-        else
-          if prepared.has_key? name.to_s
-            param = prepared[name.to_s]
-          elsif prepared.has_key? name
-            param = prepared[name]
-          else
-            raise "unknown block param name : >>#{name}<<"
-          end
-        end
-
-        # from the black magick department: block parameters with the
-        # same name as an entity get auto-inflated
-        if param
-          entity_names = @plugin.op.core.state[:entities].map { |entity| entity[:name] }
-          if entity_names.include? name.to_s
-            resolved = @plugin.op.send(name, param)
-            param = resolved
-          end
-          payload << param
-        end
-      end
-
-      result = self.block.call(*payload)
-      [result, context]
-    end
-
-  end
-
-end

data/lib/vop/entity.rb

@@ -1,61 +0,0 @@
-module Vop
-
-  # An entity is something that is identifiable through a key, e.g. a name.
-  # Also, it groups commands that accept the same parameter: When a command
-  # is called on an entity, the parameter with the same name is filled, so
-  #   @op.machine("localhost").processes()
-  # is equivalent to
-  #   @op.processes(machine: "localhost")
-  class Entity
-
-    def initialize(op, name, key, hash)
-      @op = op
-      @name = name
-      @key = key
-      @data = {}
-      hash.each do |k,v|
-        @data[k.to_s] = v
-      end
-
-      make_methods_for_hash_keys
-      make_methods_for_commands
-    end
-
-    def inspect
-      "Vop::Entity #{@name} (#{@command_count} commands)"
-    end
-
-    def make_methods_for_hash_keys
-      @data.keys.each do |key|
-        #next if ['name', 'key'].include? key.to_s
-        next if ['key'].include? key.to_s
-        self.class.send(:define_method, key) do |*args|
-          ruby_args = args.length > 0 ? args[0] : {}
-          @data[key]
-        end
-      end
-    end
-
-    def entity_commands
-      result = @op.commands.values.select do |command|
-        command.params.select do |param|
-          param[:name] == @name
-        end.count > 0
-      end
-      @command_count = result.count
-      result
-    end
-
-    def make_methods_for_commands
-      entity_commands.each do |command|
-        value = @data[@key]
-        self.class.send(:define_method, command.short_name) do |*args|
-          ruby_args = args.length > 0 ? args[0] : {}
-          @op.execute(command.short_name, ruby_args, { @name => value })
-        end
-      end
-    end
-
-  end
-
-end

data/lib/vop/loader.rb

@@ -1,35 +0,0 @@
-class Loader
-
-  attr_reader :loaded
-
-  def initialize(op, plugin)
-    @op = op
-    @plugin = plugin
-    @loaded = []
-
-    # TODO plugin.load_helper_classes(self) unless plugin == nil
-  end
-
-  def from_scratch(name)
-    fresh = { "name" => name }
-    @loaded << fresh
-  end
-
-  def self.read(op, plugin, name, source, file_name = nil)
-    loader = new(op, plugin)
-
-    loader.from_scratch(name)
-    begin
-      if file_name
-        loader.instance_eval source, file_name
-      else
-        loader.instance_eval source
-      end
-    rescue => detail
-      raise "could not read '#{name}' : #{detail.message}\n#{detail.backtrace[0..9].join("\n")}"
-    end
-
-    loader
-  end
-
-end

data/lib/vop/plugin.rb

@@ -1,141 +0,0 @@
-require 'vop/command_loader'
-
-module Vop
-
-  class Plugin
-
-    attr_reader :op
-    attr_reader :name
-    attr_reader :path
-
-    attr_reader :commands
-    attr_reader :config
-    attr_reader :dependencies
-
-    attr_reader :state
-
-    def initialize(op, plugin_name, plugin_path)
-      @op = op
-      @name = plugin_name
-      @path = plugin_path
-      @config = {}
-      @dependencies = []
-
-      # all plugins depend on 'core' (unless they are core or some murky dummy)
-      independents = %w|core __root__|
-      @dependencies << 'core' unless independents.include? plugin_name
-
-      @state = {}
-      @hooks = {}
-
-      @sources = Hash.new { |h, k| h[k] = {} }
-    end
-
-    def inspect
-      "Vop::Plugin #{@name}"
-    end
-
-    def hook(name, &block)
-      @hooks[name.to_sym] = block
-    end
-
-    def call_hook(name, *args)
-      if @hooks.has_key? name
-        $logger.debug "plugin #{self.name} calling hook #{name}"
-        @hooks[name].call(self, *args)
-      end
-    end
-
-    def init
-      $logger.debug "plugin init #{@name}"
-      call_hook :preload
-      load_helpers
-      load_config
-      # TODO we might want to activate/register only plugins with enough config
-      call_hook :init
-      load_commands
-      call_hook :activate
-    end
-
-    def plugin_dir(name)
-      @path + '/' + name.to_s
-    end
-
-    def load_code_from_dir(type_name)
-      dir = plugin_dir type_name
-      if File.exists?(dir)
-        Dir.glob(File.join(dir, '*.rb')).each do |file_name|
-          name_from_file = /#{dir}\/(.+).rb$/.match(file_name).captures.first
-          full_name = @name + '.' + name_from_file
-          $logger.debug("  #{type_name} << #{full_name}")
-
-          code = File.read(file_name)
-          @sources[type_name][full_name] = {
-            :file_name => file_name,
-            :code => code
-          }
-        end
-      else
-        #$logger.debug "no #{type_name} dir found - checked for #{dir}"
-      end
-    end
-
-    def load_helpers
-      load_code_from_dir 'helpers'
-      load_code_from_dir 'helpers/command_loader'
-      load_code_from_dir 'helpers/plugin_loader'
-    end
-
-    def helper_sources(type_name = 'helpers')
-      @sources[type_name].map do |name, source|
-        source[:code]
-      end
-    end
-
-    def command_source(command_name)
-      @sources[:commands][command_name]
-    end
-
-    def inject_helpers(target, sub_type_name = nil)
-      type_name = 'helpers'
-      if sub_type_name
-        type_name += '/' + sub_type_name
-      end
-
-      plugins_to_load_helpers_from = [ self ]
-
-      self.dependencies.each do |name|
-        other = @op.plugins[name]
-        raise "can not resolve plugin dependency #{name}" unless other
-        plugins_to_load_helpers_from << other
-      end
-
-      plugins_to_load_helpers_from.each do |other_plugin|
-        next if other_plugin.helper_sources(type_name).size == 0
-        #$logger.debug "loading helper from #{other_plugin.name} into #{target} : #{other_plugin.helper_sources.size}"
-
-        helper_module = Module.new()
-        other_plugin.helper_sources(type_name).each do |source|
-          helper_module.class_eval source
-        end
-        target.extend helper_module
-      end
-    end
-
-    def load_commands
-      load_code_from_dir :commands
-
-      loader = CommandLoader.new(self)
-      @commands = loader.read_sources @sources[:commands]
-      @commands.each do |name, command|
-        # TODO might want to warn/debug about overrides here
-        @op.eat(command)
-      end
-    end
-
-    def load_config
-    end
-
-  end
-
-end