flakie 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75a64b188fc68b39cab7b3aabff3dfbd63300475f2d0d185a0577b251c91160e
-  data.tar.gz: 2d1df7b06d7bf31d67b97008cf0439de8bf69ef98735d922973430e4a064126f
+  metadata.gz: 9547b581d0d35fd344f0b289bb0c4acd43198fb967d861dd4f934447e5529323
+  data.tar.gz: e21954bf1272f817b56761ca247f17057463c53011916d3c10a4d1701fefe1e2
 SHA512:
-  metadata.gz: 77220c649e9b013180760cee5306b0abd1db9cf047f1c684e92cd85127e06f11dc77f60c52f76b4f6ecd7ea7f54c285e3876b614f2c374e85fe4924d42ca231f
-  data.tar.gz: 5e2314d28ae93bfb3123cd0c49491801756178280bb001caef0f4d96691127b2fc1b7c21552a751fd7750030723e670a48eae766b6f7a94f6f8e52179477a25d
+  metadata.gz: ab3633180ea705c586dcfc3f30a54807c08a4090b97c26771703fe12c7bc6127e721b3fea921e445d1812d1a8cf090dd2fc10a95bcfe01d529aa177aafec539c
+  data.tar.gz: 4d1968ae5fe66c92ebac24f4967a963065010aec5f69e0898478c1c78e4ef7f5ac50fe8bc716dc4b44323b6485f62c5a931d8a9b5f1a4acdb0f5f31e67b5ec3b

data/.rubocop.yml

@@ -25,6 +25,9 @@ Metrics/AbcSize:
 Metrics/MethodLength:
   Enabled: false
 
+RSpec/MultipleExpectations:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-ruby-3.2.2
+ruby-3.3.0

data/lefthook.yml

@@ -10,8 +10,10 @@ pre-commit:
     rspec:
       run: bundle exec rspec
     rubocop:
-      files: git ls-files **/*.rb
-      run: bundle exec rubocop --fail-fast {files}
+      files: "git diff --name-only --staged"
+      glob: "{Gemfile,Rakefile,*.gemspec,*.rb}"
+      run: bundle exec rubocop --parallel {files}
     stree:
-      files: git ls-files **/*.rb
+      files: "git diff --name-only --staged"
+      glob: "{Rakefile,*.gemspec,*.rb}"
       run: bundle exec stree check {files}

data/lib/flakie/cli/options.rb

@@ -3,26 +3,11 @@
 module Flakie
   module CLI
     Options =
-      Struct.new(:count, :env, :format, :output, :help, :version) do
-        def self.default = new(count: 5, env: {}, format: :tictactoe, output: $stdout, help: false, version: false)
+      Struct.new(:count, :format, :output, :help, :version) do
+        def self.default = new(count: 5, format: :tictactoe, output: $stdout, help: false, version: false)
         def self.from(args) = default.tap { |options| Parser.parse!(args, into: options) }
 
-        def []=(key, value)
-          if key == :env
-            add_env(value)
-          else
-            super
-          end
-        end
-
-        def add_env(raw)
-          name, value = raw.split("=")
-          CLI.exit_with_error("Bad env variable format: #{raw}") if name.nil? || value.nil?
-
-          env[name] = value
-        end
-
-        def formatter = Formatters::ALL.fetch(format)
+        def reporter = Reporters::ALL.fetch(format)
 
         def help? = help
         def version? = version

data/lib/flakie/cli/parser.rb

@@ -4,22 +4,20 @@ module Flakie
   module CLI
     Parser =
       OptionParser.new do |opts|
-        opts.banner = "USAGE: #{PROGRAM_NAME} [OPTIONS] COMMAND"
+        opts.banner = "USAGE: #{NAME} [OPTIONS] COMMAND"
         opts.separator ""
 
-        opts.version = "#{PROGRAM_NAME} #{VERSION}"
+        opts.version = "#{NAME} #{VERSION}"
 
         opts.separator "OPTIONS:"
         opts.on("-n", "--count COUNT", Integer, "Number of tries (default: #{Options.default.count})")
 
         opts.on("-f", "--format FORMATTER", "Output format. See FORMATTERS section below.") do |choice|
-          Formatters::ALL.include?(choice.to_sym) ? choice.to_sym : CLI.exit_with_error("Invalid format: #{choice}")
+          Reporters::ALL.include?(choice.to_sym) ? choice.to_sym : CLI.fail("Invalid format: #{choice}")
         end
 
         opts.on("-o", "--output FILE", "File to output result. Defaults to STDOUT.") { |path| File.open(path, "w") }
 
-        opts.on("-e", "--env KEY_VALUE", "Additional environment variables to set. Can be called multiple times.")
-
         opts.on("-v", "--version", "Show the version")
         opts.on("-h", "--help", "Show this help message")
         opts.separator ""
@@ -29,9 +27,11 @@ module Flakie
         opts.separator ""
 
         opts.separator "EXAMPLES:"
-        opts.separator "  #{PROGRAM_NAME} rails t test/foo_test.rb"
-        opts.separator "  #{PROGRAM_NAME} -n10 rails t test/foo_test.rb"
-        opts.separator "  #{PROGRAM_NAME} -count=10 rails t test/foo_test.rb"
+        opts.separator "  #{NAME}                            rails t test/foo_test.rb"
+        opts.separator "  #{NAME} -n10                       rails t test/foo_test.rb"
+        opts.separator "  #{NAME} --count=10                 rails t test/foo_test.rb"
+        opts.separator "  #{NAME} --format=tictactoe         rails t test/foo_test.rb"
+        opts.separator "  #{NAME} -f tictactoe -o result.txt rails t test/foo_test.rb"
       end
   end
 end

data/lib/flakie/cli/runner.rb

@@ -15,18 +15,19 @@ module Flakie
         in version: true
           Parser.version.display
         else
-          Engine.new(
-            args.join(" "),
-            count: options.count,
-            env: options.env,
-            reporter: options.formatter.new(options.output),
-          ).run
+          Engine.new(command, count: options.count, reporter: options.reporter.new(options.output)).run
         end
       end
 
       private
 
       attr_reader :options, :args
+
+      def command
+        CLI.fail("Command is a required argument") if args.empty?
+
+        args.join(" ")
+      end
     end
   end
 end

data/lib/flakie/cli.rb

@@ -2,14 +2,20 @@
 
 module Flakie
   module CLI
-    PROGRAM_NAME = "flakie"
+    extend self
 
-    def self.run(args)
+    def run(args)
       Runner.new(args).call
     end
 
-    def self.exit_with_error(msg)
-      warn(msg)
+    def fail(msg, show_help: true)
+      warn("error: #{msg}")
+
+      if show_help
+        warn("")
+        warn(Parser.help)
+      end
+
       exit 1
     end
   end

data/lib/flakie/engine.rb

@@ -2,18 +2,9 @@
 
 module Flakie
   class Engine
-    Run =
-      Data.define(:status, :duration, :number) do
-        def success? = status == true
-        def failure? = status == true
-      end
-
-    Report = Data.define(:runs) { def last_run = runs.last }
-
-    def initialize(command, count:, env:, reporter:)
+    def initialize(command, count:, reporter:)
       @command = command
       @count = count
-      @env = env
       @reporter = reporter
       @report = Report.new([])
     end
@@ -23,7 +14,7 @@ module Flakie
 
       count.times do |index|
         start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        system(env, command, out: File::NULL, err: File::NULL)
+        system(command, out: File::NULL, err: File::NULL)
         end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
         duration = (end_time - start_time).round
         report.runs.append Run.new(status: $?.success?, duration: duration, number: index + 1)
@@ -35,6 +26,6 @@ module Flakie
 
     private
 
-    attr_reader :command, :count, :env, :reporter, :report
+    attr_reader :command, :count, :reporter, :report
   end
 end

data/lib/flakie/report.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Flakie
+  Report =
+    Data.define(:runs) do
+      def last_run = runs.last
+      def empty? = runs.empty?
+    end
+end

data/lib/flakie/{formatters → reporters}/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Flakie
-  module Formatters
+  module Reporters
     class Base
       def initialize(output)
         @output = output
@@ -16,7 +16,7 @@ module Flakie
       end
 
       def report(_report)
-        raise NotImplementedError, "Base formatter class must implement this method"
+        raise NotImplementedError, "Base class must implement this method"
       end
 
       private

data/lib/flakie/{formatters → reporters}/tic_tac_toe.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Flakie
-  module Formatters
+  module Reporters
     class TicTacToe < Base
       CHARACTER_SUCCESS = "o"
       CHARACTER_FAILURE = "x"

data/lib/flakie/{formatters.rb → reporters.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Flakie
-  module Formatters
+  module Reporters
     ALL = { tictactoe: TicTacToe }.freeze
   end
 end

data/lib/flakie/run.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Flakie
+  Run =
+    Data.define(:status, :duration, :number) do
+      def success? = status == true
+      def failure? = !success?
+    end
+end

data/lib/flakie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Flakie
-  VERSION = "1.0.0"
+  VERSION = "2.0.1"
 end

data/lib/flakie.rb

@@ -9,4 +9,5 @@ Zeitwerk::Loader.for_gem.tap do |loader|
 end
 
 module Flakie
+  NAME = "flakie"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flakie
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Khurram Raza
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-11 00:00:00.000000000 Z
+date: 2024-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -48,9 +48,11 @@ files:
 - lib/flakie/cli/parser.rb
 - lib/flakie/cli/runner.rb
 - lib/flakie/engine.rb
-- lib/flakie/formatters.rb
-- lib/flakie/formatters/base.rb
-- lib/flakie/formatters/tic_tac_toe.rb
+- lib/flakie/report.rb
+- lib/flakie/reporters.rb
+- lib/flakie/reporters/base.rb
+- lib/flakie/reporters/tic_tac_toe.rb
+- lib/flakie/run.rb
 - lib/flakie/version.rb
 homepage: https://github.com/ikhurramraza/flakie.git
 licenses:
@@ -74,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Test flakyness of commands