matrixeval-ruby 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff8434fd08a67fa951ee19e922ec6e4b19cfb6237a7f2fc17d993ab259319287
-  data.tar.gz: 1aba3deac866ffd27dbf87afe5af59188871910b1c784a129e39ca449de04350
+  metadata.gz: b38c89479923e7c9b607eff588ef02e9b4af821899b45b3a55a995e5673c9a9f
+  data.tar.gz: d2984e75182192bf0c80fced8062a019754c6d1ef042b757074e014e2851c6bd
 SHA512:
-  metadata.gz: 6599effee10ada71d4ec19eea49b9ae009500626c1b908d168215a9fdfc5f24a3a57cc6f8b9ede3d23ad5f4443e6ec589b48f37fa773f45f46e238d94c75fe99
-  data.tar.gz: b521b93b8b4f0ea4161fa2b26d88b0aee008d1c340ea7ac3d7e4e383592fd28fa56b85f6fa80d87ba091a36c017fc9d69f93324be30b5f282eb073e8d9e8828e
+  metadata.gz: ec71cc460fe724eb580b95da0af5e42e9324a7f789ab951af5082871cf45a8e5906545a3ce60ec31993da95872d76ae8cdae5372ed58b5ecae603e6c4d42ced3
+  data.tar.gz: bf8be870710b0f433319e9be0360e69bdd23625d078661d288ef23b3b5c8cef61535e5baca49eff4013abf88a8769ab6030d7840a77f8f74fda92b452c480d7e

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.4.0] - 2022-02-27
+
+- Refactor this gem as a plugin of matrixeval
+
 ## [0.3.1] - 2022-02-21
 
 - Add `.matrixeval/docker-compose` to `.gitignore`

data/README.md

@@ -1,6 +1,6 @@
 # matrixeval-ruby
 
-Test your ruby code against multiple versions of dependencies like Ruby, Rails, Env ...
+It's a plugin of [matrixeval](https://github.com/MatrixEval/matrixeval-ruby) for Ruby. Test your ruby code against multiple versions of dependencies like Ruby, Rails, Env ...
 
 ![](https://raw.githubusercontent.com/MatrixEval/assets/main/screenshots/summary.png)
 
@@ -31,7 +31,7 @@ Or install it yourself as:
 Initialize
 
 ```bash
-matrixeval init
+matrixeval init -t ruby
 ```
 
 Customize `matrixeval.yml` file and run commands like:
@@ -52,9 +52,9 @@ Run `matrixeval --help` for more details
 Here is the configuration file `matrixeval.yml` which will auto created by `matrixeval init`
 
 ```yaml
-version: 0.3
-project_name: REPLACE_ME
+version: 0.4
 target: ruby
+project_name: REPLACE_ME
 parallel_workers: number_of_processors
 # commands:
 #   - ps
@@ -107,6 +107,21 @@ exclude:
   #   rails: 4.2
   # - ruby: jruby-9.3
   #   rails: 7.0
+
+docker-compose-extend:
+  # services:
+  #   postgres:
+  #     image: postgres:12.8
+  #     volumes:
+  #       - postgres12:/var/lib/postgresql/data
+  #     environment:
+  #       POSTGRES_HOST_AUTH_METHOD: trust
+
+  #   redis:
+  #     image: redis:6.2-alpine
+
+  # volumes:
+  #   postgres12:
 ```
 
 ### Gemfile configuration example

data/lib/matrixeval/ruby/target.rb

@@ -0,0 +1,87 @@
+module Matrixeval
+  module Ruby
+    class Target < Matrixeval::Target
+
+      def version
+        Matrixeval::Ruby::VERSION
+      end
+
+      def matrixeval_yml_template_path
+        Matrixeval::Ruby.root.join("lib/matrixeval/ruby/templates/matrixeval.yml")
+      end
+
+      def vector_key
+        "ruby"
+      end
+
+      def env(context)
+        {
+          "BUNDLE_PATH" => "/bundle",
+          "GEM_HOME" => "/bundle",
+          "BUNDLE_APP_CONFIG" => "/bundle",
+          "BUNDLE_BIN" => "/bundle/bin",
+          "PATH" => "/app/bin:/bundle/bin:$PATH"
+        }
+      end
+
+      def mounts(context)
+        bundle_volume = bundle_volume(context)
+
+        [
+          "#{bundle_volume}:/bundle",
+          "../gemfile_locks/#{context.id}:/app/Gemfile.lock"
+        ]
+      end
+
+      def volumes(context)
+        bundle_volume = bundle_volume(context)
+
+        {
+          bundle_volume => {
+            "name" => bundle_volume
+          }
+        }
+      end
+
+      def gitignore_paths
+        [
+          ".matrixeval/gemfile_locks"
+        ]
+      end
+
+      def support_commands
+        [
+          'ruby', 'rake', 'rails', 'rspec', 'bundle',
+          'bin/rake', 'bin/rails', 'bin/rspec', 'bin/test'
+        ]
+      end
+
+      def cli_example_lines
+        [
+          "",
+          "Example:",
+          "    matrixeval --all bundle install",
+          "    matrixeval --ruby 3.0 rspec a_spec.rb",
+          "    matrixeval --ruby 3.1 --active_model 7.0 rake test",
+          "    matrixeval bash"
+        ]
+      end
+
+      def create_files
+        gemfile_lock_folder = Matrixeval.working_dir.join(".matrixeval/gemfile_locks")
+        FileUtils.mkdir_p gemfile_lock_folder
+
+        Context.all.each do |context|
+          FileUtils.touch gemfile_lock_folder.join(context.id)
+        end
+      end
+
+      private
+
+      def bundle_volume(context)
+        docker_image = context.main_variant.container.image
+        "bundle_#{docker_image.gsub(/[^A-Za-z0-9]/,'_')}"
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
-version: 0.3
-project_name: REPLACE_ME
+version: 0.4
 target: ruby
+project_name: REPLACE_ME
 parallel_workers: number_of_processors
 # commands:
 #   - ps
@@ -53,3 +53,18 @@ exclude:
   #   rails: 4.2
   # - ruby: jruby-9.3
   #   rails: 7.0
+
+docker-compose-extend:
+  # services:
+  #   postgres:
+  #     image: postgres:12.8
+  #     volumes:
+  #       - postgres12:/var/lib/postgresql/data
+  #     environment:
+  #       POSTGRES_HOST_AUTH_METHOD: trust
+
+  #   redis:
+  #     image: redis:6.2-alpine
+
+  # volumes:
+  #   postgres12:

data/lib/matrixeval/ruby/version.rb

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
 module Matrixeval
   module Ruby
-    VERSION = "0.3.1"
+    VERSION = '0.4.0'
   end
 end

data/lib/matrixeval/ruby.rb

@@ -1,30 +1,14 @@
-# frozen_string_literal: true
-
-require_relative "ruby/version"
-require 'rainbow'
-require 'matrixeval/ruby/docker_compose'
-require 'matrixeval/ruby/context'
-require 'matrixeval/ruby/gemfile_locks'
-require 'matrixeval/ruby/extra_mount_files'
-require 'matrixeval/ruby/runner'
-require 'matrixeval/ruby/gitignore'
+require 'matrixeval'
+require_relative 'ruby/version'
+require_relative 'ruby/target'
 
 module Matrixeval
   module Ruby
-    class Error < StandardError; end
-
     module_function
     def root
       Pathname.new("#{__dir__}/../..")
     end
   end
-
-  module_function
-  def start(argv)
-    Ruby::Runner.start(argv)
-  end
-
-  def working_dir
-    Pathname.new(Dir.getwd)
-  end
 end
+
+Matrixeval.register_target(:ruby, Matrixeval::Ruby::Target)

metadata

@@ -1,63 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: matrixeval-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Hopper Gee
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-02-20 00:00:00.000000000 Z
+date: 2022-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: matrixeval
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: terminal-table
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.2
 description: MatrixEval-Ruby
 email:
 - hopper.gee@hey.com
-executables:
-- matrixeval
-- meval
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -70,28 +40,9 @@ files:
 - bin/console
 - bin/setup
 - bin/test
-- exe/matrixeval
-- exe/meval
 - lib/matrixeval/ruby.rb
-- lib/matrixeval/ruby/command_line.rb
-- 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/build_docker_compose_extend.rb
-- lib/matrixeval/ruby/context/find_by_command_options.rb
-- lib/matrixeval/ruby/docker_compose.rb
-- lib/matrixeval/ruby/docker_compose/extend.rb
-- lib/matrixeval/ruby/docker_compose/extend_raw.rb
-- lib/matrixeval/ruby/docker_compose/file.rb
-- lib/matrixeval/ruby/extra_mount_files.rb
-- lib/matrixeval/ruby/gemfile_locks.rb
-- lib/matrixeval/ruby/gitignore.rb
-- lib/matrixeval/ruby/runner.rb
+- lib/matrixeval/ruby/target.rb
 - lib/matrixeval/ruby/templates/matrixeval.yml
-- lib/matrixeval/ruby/variant.rb
-- lib/matrixeval/ruby/vector.rb
 - lib/matrixeval/ruby/version.rb
 homepage: https://github.com/MatrixEval/matrixeval-ruby
 licenses:

data/exe/matrixeval

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

data/exe/meval

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

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

@@ -1,85 +0,0 @@
-module Matrixeval
-  module Ruby
-    class CommandLine
-      class ParseContextArguments
-        class << self
-          def call(context_arguments)
-            new(context_arguments).call
-          end
-        end
-
-        attr_reader :context_arguments, :options
-
-        def initialize(context_arguments)
-          @context_arguments = context_arguments 
-          @options = {}
-        end
-
-        def call
-          parse!
-          options
-        end
-
-        private
-
-        def parse!
-          OptionParser.new do |opts|
-            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|
-              # 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
-
-      end
-    end
-  end
-end

data/lib/matrixeval/ruby/command_line.rb

@@ -1,57 +0,0 @@
-require_relative "./command_line/parse_context_arguments"
-
-module Matrixeval
-  module Ruby
-    COMMANDS = [
-      'ruby', 'rake', 'rails', 'rspec', 'bundle',
-      'bin/rake', 'bin/rails', 'bin/rspec', 'bin/test',
-      'bash', 'dash', 'sh', 'zsh'
-    ]
-
-    class CommandLine
-
-      attr_reader :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?
-        context_options[:all]
-      end
-
-      def context_options
-        @context_options ||= ParseContextArguments.call(context_arguments)
-      end
-
-      def context_arguments
-        arguments = @argv[0...seperator_index]
-        arguments << "-h" if @argv.empty?
-        arguments
-      end
-
-      def rest_arguments
-        @argv[seperator_index..-1]
-      end
-
-      private
-
-      def seperator_index
-        @argv.index do |argument|
-          Config.commands.include?(argument)
-        end
-      end
-
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-module Matrixeval
-  module Ruby
-    class Config
-      class YAML
-
-        class MissingError < StandardError; end
-
-        class << self
-
-          def create
-            return if File.exist?(path)
-
-            FileUtils.cp(template_path, path)
-          end
-
-          def template_path
-            Matrixeval::Ruby.root.join(
-              "lib/matrixeval/ruby/templates/matrixeval.yml"
-            )
-          end
-
-          def path
-            Matrixeval.working_dir.join("matrixeval.yml")
-          end
-
-          def [](key)
-            yaml[key]
-          end
-
-          def yaml
-            raise MissingError unless File.exist?(path)
-
-            ::YAML.load File.read(path)
-          end
-
-        end
-      end
-    end
-  end
-end

data/lib/matrixeval/ruby/config.rb

@@ -1,98 +0,0 @@
-require 'yaml'
-require_relative "./vector"
-require_relative "./config/yaml"
-require_relative "./docker_compose/extend_raw"
-require_relative "./docker_compose/extend"
-
-module Matrixeval
-  module Ruby
-    class Config
-      class << self
-
-        def version
-          YAML["version"]
-        end
-
-        def target
-          YAML["target"]
-        end
-
-        def project_name
-          name = YAML["project_name"]
-
-          if name.nil? || name.strip.empty?
-            raise Error.new('missing project_name')
-          end
-
-          name
-        end
-
-        def vectors
-          @vectors = YAML["matrix"].map do |key, vector_config|
-            Vector.new(key, vector_config)
-          end
-        end
-
-        def main_vector
-          vectors.find(&:main?)
-        end
-
-        def rest_vectors
-          vectors.reject(&:main?)
-        end
-
-        def variant_combinations
-          main_vector_variants.product(*rest_vector_variants_matrix)
-        end
-
-        def main_vector_variants
-          main_vector.variants
-        end
-
-        def rest_vector_variants_matrix
-          rest_vectors.map(&:variants)
-        end
-
-        def exclusions
-          YAML["exclude"] || []
-        end
-
-        def parallel_workers
-          YAML["parallel_workers"] || "number_of_processors"
-        end
-
-        def commands
-          cmds = YAML["commands"] || []
-          COMMANDS + cmds
-        end
-
-        def docker_compose_extend_raw
-          DockerCompose::ExtendRaw.new(
-            YAML["docker-compose-extend"] || {}
-          )
-        end
-
-        def env
-          YAML["env"] || {}
-        end
-
-        def mounts
-          YAML["mounts"] || []
-        end
-
-        def all_mounts
-          mounts + all_variant_mounts
-        end
-
-        private
-
-        def all_variant_mounts
-          Config.vectors
-                .map(&:variants).flatten
-                .map(&:mounts).flatten
-        end
-
-      end
-    end
-  end
-end

data/lib/matrixeval/ruby/container.rb

@@ -1,15 +0,0 @@
-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/context/build_docker_compose_extend.rb

@@ -1,43 +0,0 @@
-require 'erb'
-require 'json'
-
-module Matrixeval
-  module Ruby
-    class Context
-      class BuildDockerComposeExtend
-        class << self
-          def call(context)
-            new(context).call
-          end
-        end
-
-        attr_reader :context
-
-        def initialize(context)
-          @context = context
-        end
-
-        def matrix_combination_id
-          context.id
-        end
-
-        def call
-          DockerCompose::Extend.new(docker_compose_extend)
-        end
-
-        private
-
-        def docker_compose_extend
-          JSON.parse(render_erb)
-        end
-
-        def render_erb
-          ERB.new(
-            Config.docker_compose_extend_raw.content
-          ).result(binding)
-        end
-
-      end
-    end
-  end
-end