rspeed 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f8fbbef694a5ee56e51580e9969e9e8372d4d93d0e5562f4efbad08fb8df854
-  data.tar.gz: b9cefcd95a86536bcd139ef8df7f47674ad0f4205ecfb0c7bc7dd2b5c33b4efd
+  metadata.gz: c2d2d14366ee70f0cf449f6fbf6bc6c7cedd57edc8497b646721afa4b098720a
+  data.tar.gz: 0ac5789e67ba474055620780a0311525bbe29c801b2c09344218888b33de55ac
 SHA512:
-  metadata.gz: 66a0fba65b3130c9454abad42a8a0e4554fd49711194a74cf7d5d77d37274469500e29f0d6210c53d92f33aa529799d416281c5556f193b9a9c0a96d3b7babbd
-  data.tar.gz: 59399ef9100cc2353a7dc93b53a152289b79aaac9a5c2ace44925a50c517a94196193ebe25ae5a4148861ace0317dfdd2def59b332ab9c717b6d073dad5df0c0
+  metadata.gz: 00adb24277015b707cfbd1d5ea0f2cd9b220701344654a107471ab6683ea4876830a34cb34262a42b425078a5dab85efaee16cb2252da1027b807a3409eb22ac
+  data.tar.gz: aa4932a206cd9a5ab93e4b4217099ebad1a110b8ee9d48c6c0dd9addaf9073d561249480cfe1f74137f484c27a649b05afc4720fde679abb825ef43ba59feb4a

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## master
+
+- None;
+
+## 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,22 @@ rake rspeed:install
 
 ## Usage
 
-- `RSPEED`: Enables RSpeed
-- `RSPEED_PIPES`: Quantity of pipes
+- `RSPEED_NAME`: You app name to avoid data override
 - `RSPEED_PIPE`: Current pipe
+- `RSPEED_PIPES`: Quantity of pipes
+- `RSPEED_RESULT_KEY`: The key that keeps the final result of all pipes
+- `RSPEED_TMP_KEY`: The temporary key that keeps the partial result of the pipes
+- `RSPEED`: Enables RSpeed
 
 ```sh
-RSPEED=true RSPEED_PIPES=3 RSPEED_PIPE=1 bundle exec rake rspeed:run
+RSPEED=true RSPEED_NAME=authorizy 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

@@ -2,10 +2,12 @@
 
 module RSpeed
   require 'csv'
-  require 'redis'
-end
 
-require 'rspeed/extension'
-require 'rspeed/observer'
-require 'rspeed/runner'
-require 'rspeed/splitter'
+  require 'rspeed/env'
+  require 'rspeed/extension'
+  require 'rspeed/observer'
+  require 'rspeed/redis'
+  require 'rspeed/runner'
+  require 'rspeed/splitter'
+  require 'rspeed/variable'
+end

data/lib/rspeed/env.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RSpeed
+  module Env
+    module_function
+
+    def db
+      ENV['RSPEED_DB']&.to_i
+    end
+
+    def host
+      ENV['RSPEED_HOST']
+    end
+
+    def name
+      ENV['RSPEED_NAME']
+    end
+
+    def pipe
+      ENV.fetch('RSPEED_PIPE', 1).to_i
+    end
+
+    def pipes
+      RSpeed::Redis.result? ? ENV.fetch('RSPEED_PIPES', 1).to_i : 1
+    end
+
+    def port
+      ENV['RSPEED_PORT']&.to_i
+    end
+
+    def result_key
+      ENV.fetch('RESPEED_RESULT_KEY', RSpeed::Variable.result)
+    end
+
+    def rspeed
+      ENV['RSPEED'] == 'true'
+    end
+
+    def tmp_key
+      ENV.fetch('RESPEED_TMP_KEY', RSpeed::Variable.tmp)
+    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/observer.rb

@@ -9,21 +9,35 @@ 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"
+      File.open(RSpeed::Variable::CSV, 'a') do |file|
+        file.write("#{spent_time},#{file_path}:#{line_number}\n")
       end
     end
 
+    def after_suite(splitter = ::RSpeed::Splitter.new)
+      RSpeed::Redis.set(RSpeed::Variable.pipe_name, true)
+
+      splitter.append
+
+      return unless RSpeed::Redis.specs_finished?
+
+      splitter.rename
+
+      RSpeed::Redis.clean_pipes_flag
+    end
+
     def before(example)
       example.update_inherited_metadata(start_at: example.clock.now)
     end
 
     def before_suite
       truncate_csv_file
+
+      RSpeed::Redis.destroy(RSpeed::Variable.tmp) unless RSpeed::Redis.specs_initiated?
     end
 
     def truncate_csv_file
-      File.open('rspeed.csv', 'w') { |file| file.truncate(0) }
+      File.open(RSpeed::Variable::CSV, 'w') { |file| file.truncate(0) }
     end
   end
 end

data/lib/rspeed/redis.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RSpeed
+  module Redis
+    require 'redis'
+
+    module_function
+
+    def clean_pipes_flag
+      destroy(RSpeed::Variable::PIPES_PATTERN)
+    end
+
+    def client
+      @client ||= ::Redis.new(db: RSpeed::Env.db, host: RSpeed::Env.host, port: RSpeed::Env.port)
+    end
+
+    def destroy(pattern = RSpeed::Variable::DEFAULT_PATTERN)
+      keys(pattern).each { |key| client.del(key) }
+    end
+
+    def get(key)
+      client.get(key)
+    end
+
+    def keys(pattern = RSpeed::Variable::DEFAULT_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 result?
+      keys(RSpeed::Env.result_key).any?
+    end
+
+    def set(key, value)
+      client.set(key, value)
+    end
+
+    def specs_finished?
+      RSpeed::Redis.keys(RSpeed::Variable::PIPES_PATTERN).size == RSpeed::Env.pipes
+    end
+
+    def specs_initiated?
+      RSpeed::Redis.keys(RSpeed::Variable::PIPES_PATTERN).any?
+    end
+  end
+end

data/lib/rspeed/runner.rb

@@ -4,25 +4,10 @@ module RSpeed
   module Runner
     module_function
 
-    def run(shell)
-      splitter = ::RSpeed::Splitter.new
+    def run(shell, splitter: ::RSpeed::Splitter.new)
+      return if splitter.redundant_run?
 
-      if splitter.first_pipe?
-        # splitter.destroy "rspeed_*"
-        splitter.destroy 'rspeed_tmp'
-      end
-
-      if splitter.result?
-        splitter.save if splitter.first_pipe?
-
-        files = splitter.get("rspeed_#{splitter.pipe}")[0]['files'].map { |item| item['file'] }.join(' ')
-      end
-
-      shell.call ['bundle exec rspec', files].compact.join(' ')
-
-      splitter.append
-
-      splitter.rename if splitter.last_pipe?
+      shell.call(['bundle exec rspec', splitter.pipe_files].compact.join(' '))
     end
   end
 end

data/lib/rspeed/splitter.rb

@@ -2,7 +2,7 @@
 
 module RSpeed
   class Splitter
-    DEFAULT_PATTERN = 'rspeed_*'
+    require 'json'
 
     def initialize(specs_path: './spec/**/*_spec.rb')
       @specs_path = specs_path
@@ -11,12 +11,12 @@ module RSpeed
     def actual_examples
       @actual_examples ||= begin
         [].tap do |examples|
-          Dir[@specs_path].each do |file|
+          Dir[@specs_path].sort.each do |file|
             data     = File.open(file).read
             lines    = data.split("\n")
 
-            lines&.each.with_index do |item, index|
-              examples << "#{file}:#{index + 1}" if item.gsub(/\s+/, '') =~ /^it/
+            lines&.each&.with_index do |item, index|
+              examples << "#{file}:#{index + 1}" if /^it/.match?(item.gsub(/\s+/, ''))
             end
           end
 
@@ -25,16 +25,12 @@ module RSpeed
       end
     end
 
-    def append(files = CSV.read('rspeed.csv'))
+    def append(files = CSV.read(RSpeed::Variable::CSV))
       files.each do |time, file|
-        redis.lpush('rspeed_tmp', { file: file, time: time.to_f }.to_json)
+        redis.lpush(RSpeed::Env.tmp_key, { file: file, time: time.to_f }.to_json)
       end
     end
 
-    def destroy(pattern = DEFAULT_PATTERN)
-      keys(pattern).each { |key| redis.del key }
-    end
-
     def diff
       actual_data = rspeed_data.select { |item| actual_examples.include?(item[:file]) }
       added_data  = added_examples.map { |item| { file: item, time: 0 } }
@@ -45,68 +41,44 @@ module RSpeed
     end
 
     def first_pipe?
-      pipe == 1
+      RSpeed::Env.pipe == 1
     end
 
     def get(pattern)
       @get ||= begin
-        return redis.lrange(pattern, 0, -1) if %w[rspeed rspeed_tmp].include?(pattern)
+        return redis.lrange(pattern, 0, -1) if [RSpeed::Variable.result, RSpeed::Variable.tmp].include?(pattern)
 
-        keys(pattern).map { |key| JSON.parse(redis.get(key)) }
+        RSpeed::Redis.keys(pattern).map { |key| ::JSON.parse(redis.get(key)) }
       end
     end
 
-    def keys(pattern = DEFAULT_PATTERN)
-      cursor = 0
-      result = []
-
-      loop do
-        cursor, results = redis.scan(cursor, match: pattern)
-        result += results
-
-        break if cursor.to_i.zero?
-      end
-
-      result
-    end
+    def pipe_files
+      return unless RSpeed::Redis.result?
 
-    def last_pipe?
-      pipe == pipes
+      split[RSpeed::Variable.key(RSpeed::Env.pipe)][:files].map { |item| item[:file] }.join(' ')
     end
 
-    def pipe
-      ENV.fetch('RSPEED_PIPE') { 1 }.to_i
-    end
-
-    def pipes
-      result? ? ENV.fetch('RSPEED_PIPES') { 1 }.to_i : 1
+    def redundant_run?
+      !first_pipe? && !exists?(RSpeed::Env.result_key)
     end
 
     def rename
-      redis.rename('rspeed_tmp', 'rspeed')
-    end
-
-    def result?
-      !keys('rspeed').empty?
+      redis.rename(RSpeed::Env.tmp_key, RSpeed::Env.result_key)
     end
 
-    def save(data = diff)
-      split(data).each { |key, value| redis.set(key, value.to_json) }
-    end
-
-    def split(data)
+    def split(data = diff)
       json = {}
 
-      pipes.times do |index|
-        json["rspeed_#{index + 1}".to_sym] ||= []
-        json["rspeed_#{index + 1}".to_sym] = { total: 0, files: [], number: index + 1 }
+      RSpeed::Env.pipes.times do |index|
+        json[RSpeed::Variable.key(index + 1)] ||= []
+        json[RSpeed::Variable.key(index + 1)] = { total: 0, files: [], number: index + 1 }
       end
 
       sorted_data = data.sort_by { |item| item[:time] }.reverse
 
       sorted_data.each do |record|
         selected_pipe_data = json.min_by { |pipe| pipe[1][:total] }
-        selected_pipe      = json["rspeed_#{selected_pipe_data[1][:number]}".to_sym]
+        selected_pipe      = json[RSpeed::Variable.key(selected_pipe_data[1][:number])]
         time               = record[:time].to_f
 
         selected_pipe[:total] += time
@@ -124,8 +96,13 @@ module RSpeed
       end
     end
 
+    # TODO: exists? does not work: undefined method `>' for false:FalseClass
+    def exists?(key)
+      redis.keys.include?(key)
+    end
+
     def redis
-      @redis ||= ::Redis.new(db: ENV['RSPEED_DB'], host: ENV['RSPEED_HOST'], port: ENV.fetch('RSPEED_PORT') { 6379 })
+      @redis ||= ::RSpeed::Redis.client
     end
 
     def removed_examples
@@ -135,11 +112,11 @@ module RSpeed
     end
 
     def removed_time
-      removed_examples.map { |item| item[0].to_f }.sum
+      removed_examples.sum { |item| item[0].to_f }
     end
 
     def rspeed_data
-      @rspeed_data ||= get('rspeed').map { |item| JSON.parse(item, symbolize_names: true) }
+      @rspeed_data ||= get(RSpeed::Env.result_key).map { |item| JSON.parse(item, symbolize_names: true) }
     end
 
     def rspeed_examples
@@ -147,7 +124,7 @@ module RSpeed
     end
 
     def stream(type, data)
-      puts "PIPE: #{pipe} with #{type}: #{data}"
+      puts "PIPE: #{RSpeed::Env.pipe} with #{type}: #{data}"
     end
   end
 end