rspeed 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f8fbbef694a5ee56e51580e9969e9e8372d4d93d0e5562f4efbad08fb8df854
-  data.tar.gz: b9cefcd95a86536bcd139ef8df7f47674ad0f4205ecfb0c7bc7dd2b5c33b4efd
+  metadata.gz: 121d5558331de345c2147e1b1ee8b6679c09ac8cb83b33af4ad5673d3e534806
+  data.tar.gz: b739938586f9ce82c94c9fe74f79583153ad268e5443c54602f32650482595dd
 SHA512:
-  metadata.gz: 66a0fba65b3130c9454abad42a8a0e4554fd49711194a74cf7d5d77d37274469500e29f0d6210c53d92f33aa529799d416281c5556f193b9a9c0a96d3b7babbd
-  data.tar.gz: 59399ef9100cc2353a7dc93b53a152289b79aaac9a5c2ace44925a50c517a94196193ebe25ae5a4148861ace0317dfdd2def59b332ab9c717b6d073dad5df0c0
+  metadata.gz: 4109a7ca7ccc74e43c09eafd0aabf5fba559f9dbc5350a8439cbfc47cd400c03de3d862405059e60adb6ee11b83592985a89b877982c3094bcecbf3f69c363df
+  data.tar.gz: 6f706fe116da661fe858fc85979e5ee718ec4fe4da19cb13cd06ee6bbabad4688e6182f8504db93215a549fa9efe18991314faf97d8ca8e0f55125771b2de772

data/CHANGELOG.md

@@ -1,3 +1,57 @@
+## master
+
+- None;
+
+## v0.7.0
+
+#### News
+
+- Prints pipe info into a table on the console;
+- The previous result is keeped alive for further checks;
+- Adds final report show actual, added and removed;
+
+## v0.6.0
+
+#### Break Change
+
+- Drops `RSPEED_RESULT_KEY` key in favor of `RSPEED_NAME`;
+- Renames env `RSPEED_NAME` to `RSPEED_APP`;
+
+#### News
+
+- Adds env `RSPEED_SPEC_PATH` to indicate the spec folders path;
+- Saves pipes and profiles with a zero at the beginning;
+- Makes sure examples is unique;
+
+## v0.5.2
+
+#### Fix
+
+- Avoid duplicate entries in the consolidated result;
+
+#### Update
+
+- CSV dependency dropped;
+- Drops tmp key in favor of profile keys fetch;
+
+## v0.5.1
+
+#### Fix
+
+- Only pipe number 1 will warm up avoiding duplicated spec entries;
+
+## v0.5.0
+
+#### Fix
+
+- Add env `RSPEED_NAME` to specify the application name and avoid result conflicts between multiple runs;
+- No more depends on pipe sequence to generate ou aggregate the resul;
+- rake `rspeed:install`;
+
+#### Update
+
+- The result of the pipes are no more saved on Redis. It's now calculated based on result key `rspeed`;
+
 ## v0.4.0
 
 - Now we make diff to discover removed and added examples;

data/README.md

@@ -1,9 +1,10 @@
 # RSpeed
 
-[![Build Status](https://github.com/wbotelhos/rspeed/workflows/CI/badge.svg)](https://github.com/wbotelhos/rspeed/actions)
+[![CI](https://github.com/wbotelhos/rspeed/workflows/CI/badge.svg)](https://github.com/wbotelhos/rspeed/actions)
 [![Gem Version](https://badge.fury.io/rb/rspeed.svg)](https://badge.fury.io/rb/rspeed)
-[![Maintainability](https://api.codeclimate.com/v1/badges/cc5efe8b06bc1d5e9e8a/maintainability)](https://codeclimate.com/github/wbotelhos/rspeed/maintainability)
-[![Patreon](https://img.shields.io/badge/donate-%3C3-brightgreen.svg)](https://www.patreon.com/wbotelhos)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f312587b4f126bb13e85/maintainability)](https://codeclimate.com/github/wbotelhos/rspeed/maintainability)
+[![Coverage](https://codecov.io/gh/wbotelhos/rspeed/branch/main/graph/badge.svg)](https://codecov.io/gh/wbotelhos/rspeed)
+[![Sponsor](https://img.shields.io/badge/sponsor-%3C3-green)](https://www.patreon.com/wbotelhos)
 
 RSpeed splits your specs to you run parallels tests.
 
@@ -25,19 +26,21 @@ rake rspeed:install
 
 ## Usage
 
-- `RSPEED`: Enables RSpeed
-- `RSPEED_PIPES`: Quantity of pipes
+- `RSPEED_APP`: You app name to avoid data override
 - `RSPEED_PIPE`: Current pipe
+- `RSPEED_PIPES`: Quantity of pipes
+- `RSPEED_SPEC_PATH`: The specs folders path
+- `RSPEED`: Enables RSpeed
 
 ```sh
-RSPEED=true RSPEED_PIPES=3 RSPEED_PIPE=1 bundle exec rake rspeed:run
+RSPEED=true RSPEED_APP=blog RSPEED_PIPE=1 RSPEED_PIPES=3 bundle exec rake rspeed:run
 ```
 
 ## How it Works
 
 ### First run
 
-1. Since we has no statistics on the first time, we run all specs and collect it;
+1. Since we have no statistics on the first time, we run all specs and collect it;
 
 ```json
 { "file": "./spec/models/1_spec.rb", "time": 0.01 }

data/lib/generators/rspeed/install_generator.rb

@@ -6,7 +6,7 @@ module RSpeed
 
     desc 'Creates RSpeed task'
 
-    def copy_initializer
+    def create_initializer
       copy_file 'lib/tasks/rspeed.rake', 'lib/tasks/rspeed.rake'
     end
   end

data/lib/rspeed.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 module RSpeed
-  require 'csv'
-  require 'redis'
+  require 'rspeed/database'
+  require 'rspeed/env'
+  require 'rspeed/extension'
+  require 'rspeed/logger'
+  require 'rspeed/observer'
+  require 'rspeed/redis'
+  require 'rspeed/reporter'
+  require 'rspeed/runner'
+  require 'rspeed/splitter'
+  require 'rspeed/variable'
 end
-
-require 'rspeed/extension'
-require 'rspeed/observer'
-require 'rspeed/runner'
-require 'rspeed/splitter'

data/lib/rspeed/database.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RSpeed
+  module Database
+    module_function
+
+    def previous_result
+      list(RSpeed::Variable.previous_result)
+    end
+
+    def result
+      list(RSpeed::Variable.result)
+    end
+
+    def list(key)
+      RSpeed::Redis.list(key).map { |item| JSON.parse(item, symbolize_names: true) }
+    end
+  end
+end

data/lib/rspeed/differ.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RSpeed
+  module Differ
+    module_function
+
+    def actual_files(spec_path: RSpeed::Env.spec_path)
+      [].tap do |data|
+        Dir[spec_path].sort.each do |file|
+          lines = File.open(file).read.split("\n")
+
+          lines&.each&.with_index do |item, index|
+            data << "#{file}:#{index + 1}" if /^it/.match?(item.gsub(/\s+/, ''))
+          end
+        end
+      end
+    end
+
+    def actual_data(files:, result:)
+      result.select { |item| files.include?(item[:file]) }
+    end
+
+    def added_data(files:, result:)
+      (files - result.map { |item| item[:file] }).map { |file| { file: file, time: nil } }
+    end
+
+    def diff(from: actual_files, to: RSpeed::Database.result)
+      to      = to.uniq { |item| item[:file] }
+      added   = added_data(files: from, result: to)
+      actual  = actual_data(files: from, result: to) + added_data(files: from, result: to)
+      removed = removed_data(files: from, result: to)
+
+      {
+        actual_files:  actual,
+        actual_time:   sum_time(data: actual),
+        added_files:   added,
+        added_time:    sum_time(data: added),
+        removed_files: removed,
+        removed_time:  sum_time(data: removed),
+      }
+    end
+
+    def final_diff(from: RSpeed::Database.previous_result, to: RSpeed::Database.result)
+      from           = from.uniq { |item| item[:file] }
+      to             = to.uniq { |item| item[:file] }
+      previous_files = from.map { |item| item[:file] }
+      actual_files   = to.map { |item| item[:file] }
+      added          = to.reject { |item| previous_files.include?(item[:file]) }
+      removed        = from.reject { |item| actual_files.include?(item[:file]) }
+
+      {
+        actual_files:  to,
+        actual_time:   sum_time(data: to),
+        added_files:   added,
+        added_time:    sum_time(data: added),
+        removed_files: removed,
+        removed_time:  sum_time(data: removed),
+      }
+    end
+
+    def removed_data(files:, result:)
+      result.reject { |item| files.include?(item[:file]) }
+    end
+
+    def sum_time(data:)
+      return '?' if data.all? { |item| item[:time].nil? }
+
+      data.sum { |item| item[:time].to_f }
+    end
+  end
+end

data/lib/rspeed/env.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RSpeed
+  module Env
+    module_function
+
+    def app
+      ENV['RSPEED_APP']
+    end
+
+    def db
+      ENV['RSPEED_DB']&.to_i
+    end
+
+    def host
+      ENV['RSPEED_HOST']
+    end
+
+    def pipe
+      ENV.fetch('RSPEED_PIPE', 1).to_i
+    end
+
+    def pipes
+      ENV.fetch('RSPEED_PIPES', 1).to_i
+    end
+
+    def port
+      ENV['RSPEED_PORT']&.to_i
+    end
+
+    def rspeed
+      ENV['RSPEED'] == 'true'
+    end
+
+    def spec_path
+      ENV.fetch('RSPEED_SPEC_PATH', './spec/**/*spec.rb')
+    end
+  end
+end

data/lib/rspeed/extension.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-if ENV['RSPEED'] == 'true'
-  require 'rspec/rails'
+if RSpeed::Env.rspeed
+  require 'rspec'
 
   RSpec.configure do |config|
     config.before(:suite) { RSpeed::Observer.before_suite }
     config.before { |example| RSpeed::Observer.before(example) }
     config.after { |example| RSpeed::Observer.after(example) }
+    config.after(:suite) { RSpeed::Observer.after_suite }
   end
 end

data/lib/rspeed/logger.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RSpeed
+  module Logger
+    module_function
+
+    def log(context, method, message)
+      clazz = context.ancestors.join('::')
+
+      puts("[#{clazz}##{method}.#{RSpeed::Env.pipe}] #{message}")
+    end
+  end
+end

data/lib/rspeed/observer.rb

@@ -9,9 +9,22 @@ module RSpeed
       line_number = example.metadata[:line_number]
       spent_time  = example.clock.now - example.metadata[:start_at]
 
-      File.open('rspeed.csv', 'a') do |file|
-        file.write "#{spent_time},#{file_path}:#{line_number}\n"
-      end
+      json = { file: "#{file_path}:#{line_number}", time: spent_time }.to_json
+
+      RSpeed::Redis.client.rpush(RSpeed::Variable.profile, json)
+    end
+
+    def after_suite
+      RSpeed::Redis.set(RSpeed::Variable.pipe, true)
+
+      return unless RSpeed::Redis.specs_finished?
+
+      RSpeed::Redis.version_the_result if RSpeed::Redis.result?
+      RSpeed::Splitter.consolidate
+      RSpeed::Reporter.call
+      RSpeed::Redis.clean
+
+      RSpeed::Logger.log(self, __method__, 'RSpeed finished.')
     end
 
     def before(example)
@@ -19,11 +32,10 @@ module RSpeed
     end
 
     def before_suite
-      truncate_csv_file
-    end
+      RSpeed::Logger.log(self, __method__, 'Cleanning current flag and profile.')
 
-    def truncate_csv_file
-      File.open('rspeed.csv', 'w') { |file| file.truncate(0) }
+      RSpeed::Redis.destroy(pattern: RSpeed::Variable.pipe)
+      RSpeed::Redis.destroy(pattern: RSpeed::Variable.profile)
     end
   end
 end

data/lib/rspeed/redis.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RSpeed
+  module Redis
+    require 'redis'
+
+    module_function
+
+    def clean
+      RSpeed::Logger.log(self, __method__, 'Cleaning pipes and profiles.')
+
+      destroy(pattern: RSpeed::Variable::PIPES_PATTERN)
+      destroy(pattern: RSpeed::Variable::PROFILE_PATTERN)
+    end
+
+    def client
+      @client ||= ::Redis.new(db: RSpeed::Env.db, host: RSpeed::Env.host, port: RSpeed::Env.port)
+    end
+
+    def destroy(pattern:)
+      RSpeed::Logger.log(self, __method__, %(Destroying pattern "#{pattern}".))
+
+      keys(pattern: pattern).each { |key| client.del(key) }
+    end
+
+    def get(key)
+      client.get(key)
+    end
+
+    def keys(pattern:)
+      cursor = 0
+      result = []
+
+      loop do
+        cursor, results = client.scan(cursor, match: pattern)
+        result += results
+
+        break if cursor.to_i.zero?
+      end
+
+      result
+    end
+
+    def list(key)
+      client.lrange(key, 0, -1)
+    end
+
+    def profiles_content(pattern: 'rspeed:profile_*')
+      client.keys(pattern).map { |key| list(key) }.flatten
+    end
+
+    def result?
+      keys(pattern: RSpeed::Variable.result).any?
+    end
+
+    def set(key, value)
+      client.set(key, value)
+    end
+
+    def specs_finished?
+      (RSpeed::Redis.keys(pattern: RSpeed::Variable::PIPES_PATTERN).size == RSpeed::Env.pipes).tap do |boo|
+        RSpeed::Logger.log(self, __method__, "Specs #{boo ? 'finished.' : 'not fineshed yet.'}")
+      end
+    end
+
+    def specs_initiated?
+      RSpeed::Redis.keys(pattern: RSpeed::Variable::PIPES_PATTERN).any?.tap do |boo|
+        RSpeed::Logger.log(self, __method__, "Specs #{boo ? 'initialized.' : 'not initialized yet.'}")
+      end
+    end
+
+    def version_the_result
+      RSpeed::Logger.log(self, __method__, 'Versioning the result.')
+
+      client.rename(RSpeed::Variable.result, RSpeed::Variable.previous_result)
+    end
+  end
+end

data/lib/rspeed/reporter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RSpeed
+  module Reporter
+    module_function
+
+    require 'terminal-table'
+
+    def call
+      diff = RSpeed::Differ.final_diff
+
+      print_table(
+        headings: %w[Global Value],
+
+        rows: [
+          ['Actual Time', diff[:actual_time]],
+          ['Removed Time', diff[:removed_time]],
+          ['Added Time', diff[:added_time]],
+        ]
+      )
+    end
+
+    def print_files(items)
+      total_specs = items.size
+      headings    = ["#{total_specs} specs", "Pipe #{RSpeed::Env.pipe}/#{RSpeed::Env.pipes}", 'Last Time']
+
+      rows = items.map.with_index do |item, index|
+        [format('%02d', index + 1), item[:file], item[:time].to_s]
+      end
+
+      print_table(headings: headings, rows: rows)
+    end
+
+    def print_table(headings:, rows:)
+      puts(Terminal::Table.new(headings: headings, rows: rows, title: 'RSpeed'))
+    end
+  end
+end