matrixeval-ruby 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bd932a09eb30fdf342cc0596af3e6cd82496deaa0af2746bdc79a06b1c85911
-  data.tar.gz: b13ef75ed283407d0d3e9ac50f0d0053a81a39dbcab737183e6886b9caf34a99
+  metadata.gz: 21cd041a53b811584d5ba4c44cc7cca0990add95f39251b566425d8e41b8d5c5
+  data.tar.gz: 342cb96612cee61f74683af65a150e3b86a574e835dfb8736e7a600ab86e9dc5
 SHA512:
-  metadata.gz: a8593994584983cde95650942a8ca0479c58412ecdccaddb2ab4aa31f378544f46fead1f05d9e12f33f405b68aeb8d5fdf4017059e39f81c22a8d494d89619e6
-  data.tar.gz: b83de57cc53b6b3a35dd86e0fd4196218a900219af7868b3870feff925db05a0c6fe6c0820cbef94903dac4c186684ac13d897a31ce75a612149d945f5cf31eb
+  metadata.gz: 4c058092c0c3279fc1359f6802d7dbb56cb8a7f2057a7af0b3c3967e5459c36cba7316539722c6577821c147cdaf13fabfaa06f24f4847976787c07f6fa09d47
+  data.tar.gz: faf39d5d47abd8e1af39ab6521c4a719646f10ce016f76c563a516926e7b8554e1ec7646eaac0d6742d58ebada94bbe828ab83fa553486d0aa485e2114315581

data/CHANGELOG.md

@@ -1,8 +1,15 @@
 ## [Unreleased]
 
+## [0.2.0] - 2022-02-10
+
+- Change config format from 0.1 to 0.2
+- CLI description
+- Other errors fix
+
 ## [0.1.1] - 2022-02-09
 
 - Fix a execution report issue
+
 ## [0.1.0] - 2022-02-09
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    matrixeval-ruby (0.1.0)
+    matrixeval-ruby (0.1.1)
       concurrent-ruby
       rainbow (~> 3.1)
       terminal-table

data/README.md

@@ -19,7 +19,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Initialize
+
+```bash
+matrixeval init
+```
+
+Customize `matrixeval.yml` file and run commands like:
+
+```bash
+matrixeval --all bundle install
+matrixeval --all rspec
+matrixeval --ruby 3.0 rspec a_spec.rb
+matrixeval --ruby 3.1 --rails 7.0 rake test
+matrixeval bash
+```
+Run `matrixeval --help` for more details
 
 ## Development
 

data/exe/matrixeval

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
 require 'matrixeval/ruby'
-puts "Hello, MatrixEval!"
+
 Matrixeval.start(ARGV)

data/exe/meval

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
 require 'matrixeval/ruby'
-puts "Hello, MatrixEval!"
+
 Matrixeval.start(ARGV)

data/lib/matrixeval/ruby/command_line/parse_context_arguments.rb

@@ -24,11 +24,58 @@ module Matrixeval
 
         def parse!
           OptionParser.new do |opts|
-            opts.banner = "Usage: meval/matrixeval --[VECTOR_KEY] [VECTOR_CHOICE] [COMMAND] [COMMAND_OPTIONS]"
+            opts.version = Matrixeval::Ruby::VERSION
+            opts.program_name = ""
+            opts.banner = <<~USAGE
+              Usage:
+                  matrixeval(meval) [OPTIONS] COMMAND
+              USAGE
+
+            opts.separator ""
+            opts.separator "Options:"
+
+            opts.on "-a", "--all", "# Run the COMMAND against all matrix combinations"
 
             Config.vectors.each do |vector|
-              opts.on("--#{vector.key} [VERSION]", "Set #{vector.key} version")
+              # short = "-#{vector.short_key}"
+              long = "--#{vector.key} [VERSION]"
+              desc = [
+                "# Run the COMMAND against a specific #{vector.key} version",
+                "# Options: #{vector.variants.map(&:key).join("/")}",
+                "# Default: #{vector.default_variant.key}",
+                "# Customizable"
+              ]
+              opts.separator ""
+              opts.on(long, *desc)
+            end
+
+            opts.separator ""
+            opts.separator "Commands: #{Config.commands.join("/")} (Customizable)"
+
+            opts.separator ""
+            opts.separator "MatrixEval Options:"
+
+            opts.on("-h", "--help", "# Show help") do
+              puts opts.help
+              exit
             end
+
+            opts.on("-v", "--version", "# Show version") do
+              puts opts.version
+              exit
+            end
+
+            opts.separator ""
+            opts.separator "Customizations:"
+            opts.separator "    You can customize all options in matrixeval.yml"
+
+            opts.separator ""
+            opts.separator "Example:"
+            opts.separator "    matrixeval --all bundle install"
+            opts.separator "    matrixeval --ruby 3.0 rspec a_spec.rb"
+            opts.separator "    matrixeval --ruby 3.1 --active_model 7.0 rake test"
+            opts.separator "    matrixeval bash"
+
           end.parse!(context_arguments, into: options)
         end
 

data/lib/matrixeval/ruby/command_line.rb

@@ -2,28 +2,38 @@ require_relative "./command_line/parse_context_arguments"
 
 module Matrixeval
   module Ruby
+    COMMANDS = ['rake', 'rspec', 'bundle', 'bash']
+
     class CommandLine
 
-      attr_reader :argv
+      attr_accessor :argv
 
       def initialize(argv)
         @argv = argv
       end
 
+      def valid?
+        init? ||
+          !context_options.empty? ||
+          !seperator_index.nil?
+      end
+
       def init?
         argv[0] == 'init'
       end
 
       def all?
-        argv[0] == 'all'
+        context_options[:all]
       end
 
       def context_options
-        ParseContextArguments.call(context_arguments)
+        @context_options ||= ParseContextArguments.call(context_arguments)
       end
 
       def context_arguments
-        argv[0...seperator_index]
+        arguments = argv[0...seperator_index]
+        arguments << "-h" if argv.empty?
+        arguments
       end
 
       def rest_arguments
@@ -34,14 +44,10 @@ module Matrixeval
 
       def seperator_index
         argv.index do |argument|
-          seperator_commands.include?(argument)
+          Config.commands.include?(argument)
         end
       end
 
-      def seperator_commands
-        ['rake', 'rspec', 'bundle', 'bash']
-      end
-
     end
   end
 end

data/lib/matrixeval/ruby/config/yaml.rb

@@ -2,6 +2,9 @@ module Matrixeval
   module Ruby
     class Config
       class YAML
+
+        class MissingError < StandardError; end
+
         class << self
 
           def create
@@ -25,6 +28,8 @@ module Matrixeval
           end
 
           def yaml
+            raise MissingError unless File.exist?(path)
+
             ::YAML.load File.read(path)
           end
 

data/lib/matrixeval/ruby/config.rb

@@ -49,6 +49,11 @@ module Matrixeval
           YAML["parallel_workers"] || "number_of_processors"
         end
 
+        def commands
+          cmds = YAML["commands"] || []
+          COMMANDS + cmds
+        end
+
       end
     end
   end

data/lib/matrixeval/ruby/container.rb

@@ -0,0 +1,15 @@
+module Matrixeval
+  module Ruby
+    class Container
+
+      attr_reader :image, :env
+
+      def initialize(options)
+        options ||= {}
+        @image = options["image"]
+        @env = options["env"] || {}
+      end
+
+    end
+  end
+end

data/lib/matrixeval/ruby/docker_compose/yaml.rb

@@ -29,7 +29,7 @@ module Matrixeval
 
             Config.main_vector_variants.map do |variant|
               services[variant.docker_compose_service_name] = {
-                "image" => variant.image,
+                "image" => variant.container.image,
                 "volumes" => mounts(variant),
                 "environment" => {
                   "BUNDLE_PATH" => "/bundle",
@@ -37,7 +37,7 @@ module Matrixeval
                   "BUNDLE_APP_CONFIG" => "/bundle",
                   "BUNDLE_BIN" => "/bundle/bin",
                   "PATH" => "/app/bin:/bundle/bin:$PATH"
-                },
+                }.merge(variant.container.env),
                 "working_dir" => "/app"
               }
             end

data/lib/matrixeval/ruby/runner.rb

@@ -16,13 +16,18 @@ module Matrixeval
       end
 
       attr_reader :argv, :command
+      attr_accessor :threads, :matrixeval_results
 
       def initialize(argv)
         @argv = argv
         @command = CommandLine.new(argv)
+        @threads ||= []
+        @matrixeval_results ||= []
       end
 
       def start
+        validates
+
         if command.init?
           init
         elsif command.all?
@@ -30,12 +35,31 @@ module Matrixeval
         else
           run_a_specific_context
         end
+      rescue OptionParser::InvalidOption => e
+        puts <<~ERROR
+          #{e.message}
+          See 'matrixeval --help'
+          ERROR
+        exit
+      rescue Config::YAML::MissingError
+        puts "Please run 'matrixeval init' first to generate matrixeval.yml"
+        exit
       ensure
         turn_on_stty_opost
       end
 
       private
 
+      def validates
+        return if command.valid?
+
+        puts <<~ERROR
+          matrixeval: '#{argv.join(' ')}' is not a MatrixEval command.
+          See 'matrixeval --help'
+          ERROR
+        exit
+      end
+
       def init
         Config::YAML.create
         Gitignore.update
@@ -47,6 +71,8 @@ module Matrixeval
         GemfileLocks.create
         Gitignore.update
 
+        pull_all_images
+
         if workers_count == 1
           run_all_contexts_sequentially
         else
@@ -69,10 +95,10 @@ module Matrixeval
       end
 
       def run_all_contexts_in_parallel
-        parallel do |contexts|
+        parallel(contexts) do |sub_contexts|
           Thread.current[:matrixeval_results] = []
 
-          contexts.each do |context|
+          sub_contexts.each do |context|
             docker_compose = DockerCompose.new(context)
             success = docker_compose.run(command.rest_arguments)
 
@@ -98,12 +124,25 @@ module Matrixeval
         docker_compose.run(command.rest_arguments)
       end
 
+      def pull_all_images
+        parallel(Config.main_vector_variants) do |sub_variants|
+          sub_variants.each do |variant|
+            puts "Docker image check/pull #{variant.container.image}"
+            image_exists = system %Q{[ -n "$(docker images -q #{variant.container.image})" ]}
+            next if image_exists
+
+            system "docker pull #{variant.container.image}"
+          end
+        end
+      end
+
       def report
         turn_on_stty_opost
 
         table = Terminal::Table.new(title: Rainbow("MatrixEval").blue.bright + " Summary", alignment: :center) do |table|
 
-          table.add_row(Config.vectors.map(&:key) + ['result'])
+          headers = Config.vectors.map(&:key) + ['result']
+          table.add_row headers.map { |value| { value: value, alignment: :center } }
           table.add_separator 
 
           matrixeval_results.each do |context, success|
@@ -120,32 +159,30 @@ module Matrixeval
         puts table
       end
 
-      def parallel
-        contexts = Context.all
+      def parallel(collection)
+        threads = [] unless threads.empty?
+        matrixeval_results = [] unless matrixeval_results.empty?
 
-        contexts.each_slice(contexts.count / workers_count) do |sub_contexts|
+        collection.each_slice(per_worker_contexts_count) do |sub_collection|
           threads << Thread.new do
-            yield sub_contexts
+            yield sub_collection
           end
         end
 
         threads.each(&:join)
 
         threads.each do |thread|
-          self.matrixeval_results += thread[:matrixeval_results]
+          self.matrixeval_results += (thread[:matrixeval_results] || [])
         end
       end
 
-      def threads
-        @threads ||= []
-      end
 
-      def matrixeval_results
-        @matrixeval_results ||= []
+      def per_worker_contexts_count
+        [(contexts.count / workers_count), 1].max
       end
 
-      def matrixeval_results=(results)
-        @matrixeval_results = results
+      def contexts
+        @contexts ||= Context.all
       end
 
       def workers_count

data/lib/matrixeval/ruby/templates/matrixeval.yml

@@ -1,13 +1,52 @@
-version: 0.1
+version: 0.2
 target: ruby
 parallel_workers: number_of_processors
+# commands:
+#   - ps
+#   - top
+#   - an_additional_command
 matrix:
   ruby:
+    # mounts:
+    #   - /a/path/need/to/mount:/a/path/mount/to
     variants:
       - key: 2.7
-        image: ruby:2.7.1
+        container:
+          image: ruby:2.7.1
       - key: 3.0
-        image: ruby:3.0.0
         default: true
+        container:
+          image: ruby:3.0.0
       - key: 3.1
-        image: ruby:3.1.0
+        container:
+          image: ruby:3.1.0
+      # - key: jruby-9.3
+      #   container:
+      #     image: jruby:9.3
+      #     env:
+      #       PATH: "/opt/jruby/bin:/app/bin:/bundle/bin:$PATH"
+
+  # rails:
+  #   variants:
+  #     - key: 6.1
+  #       default: true
+  #       env:
+  #         RAILS_VERSION: "~> 6.1.0"
+  #     - key: 7.0
+  #       env:
+  #         RAILS_VERSION: "~> 7.0.0"
+  # another:
+  #   variants:
+  #     - key: key1
+  #       default: true
+  #       env:
+  #         ENV_KEY: 1
+  #     - key: key2
+  #       env:
+  #         ENV_KEY: 2
+
+exclude:
+  # - ruby: 3.0
+  #   rails: 4.2
+  # - ruby: jruby-9.3
+  #   rails: 7.0

data/lib/matrixeval/ruby/variant.rb

@@ -1,3 +1,5 @@
+require_relative "./container"
+
 module Matrixeval
   module Ruby
     class Variant
@@ -7,14 +9,14 @@ module Matrixeval
         end
       end
 
-      attr_reader :key, :image, :env, :vector, :default
+      attr_reader :key, :env, :vector, :default, :container
 
       def initialize(config = {}, vector)
         raise Error.new("Variant#key is missing") if config["key"].nil?
 
         @vector = vector
         @key = config["key"].to_s
-        @image = config["image"]
+        @container = Container.new(config["container"])
         @env = config["env"] || {}
         @default = config["default"] || false
       end
@@ -24,7 +26,7 @@ module Matrixeval
       end
 
       def bundle_volume_name
-        "bundle_#{image.gsub(/[^A-Za-z0-9]/,'_')}"
+        "bundle_#{container.image.gsub(/[^A-Za-z0-9]/,'_')}"
       end
 
       def id

data/lib/matrixeval/ruby/vector.rb

@@ -30,7 +30,7 @@ module Matrixeval
       def default_variant
         variant = variants.find(&:default?)
         if variant.nil?
-          raise Error.new("Please set a default variant for matrix #{vector.key}")
+          raise Error.new("Please set a default variant for matrix #{key}")
         end
 
         variant

data/lib/matrixeval/ruby/version.rb

@@ -2,6 +2,6 @@
 
 module Matrixeval
   module Ruby
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrixeval-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Hopper Gee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -78,6 +78,7 @@ files:
 - lib/matrixeval/ruby/command_line/parse_context_arguments.rb
 - lib/matrixeval/ruby/config.rb
 - lib/matrixeval/ruby/config/yaml.rb
+- lib/matrixeval/ruby/container.rb
 - lib/matrixeval/ruby/context.rb
 - lib/matrixeval/ruby/context/find_by_command_options.rb
 - lib/matrixeval/ruby/docker_compose.rb