type_fusion 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eaa132f18093b5b57b9db4e49130adb2f9ff41ae03559848e1334ee4f863bfe
-  data.tar.gz: 4bc9dcc31808f3f39707516436f28a3e73de19054f80c2d143da66dc365ae106
+  metadata.gz: b9c5749c381eccd5f84c5d824fce4d634cde7bda503638dfef9c9737b61c7cb0
+  data.tar.gz: 6fc4cb00bf6ddb01f0832962df93add41020668d2de5ca3933c3619039bbda96
 SHA512:
-  metadata.gz: '086356eb24932d3fbce347967869de8ba31672ebde52eaed096a640713ca8cb69e151ebe2a6dd71ebdb596a07cd6ea971bcf7f0147887059a344901d08e2be90'
-  data.tar.gz: 35dbb641e2ffc414aa0c42af6f2a61538f3a24f37e5bd35daf623bc7824b853fe8963711c10fd741e2e6155be6b73cf26fd7718f530b36e238c912f2ce372f7b
+  metadata.gz: 1b1c116b16c6f56234a1718af703c0c8e64527230e9cb74f4efae26727a467e30ac63b233f0f075f8494b1fc40096d3bf113b03bd0ab409f3088e7332c09a04f
+  data.tar.gz: a687bce21925739f806d3cb458a08e301723db19d755dcc04f3de47098fbe4236ccb30a84fa6e2845be6553cad92f1a1145464fe16483a0416ed0650cf8a969a

data/CHANGELOG.md

@@ -1,4 +1,18 @@
-## [Unreleased]
+## [0.0.6] - 2023-08-25
+
+- Add support for running TypeFusion in the test environment with RSpec
+- Update Struct syntax for Ruby 3.2/3.1 compatibility
+- Show how many threads are processing samples
+- Rename `TypeFusion::Processor#enqueued_samples` to `#enqueued_jobs`
+- Move `TypeFusion::Processor` signal trap to `#process!` so it doesn't interfere with the Rails server
+- Keep track of started state of `TypeFusion::Processor` so we only need to start the processing once
+
+## [0.0.5] - 2023-08-25
+
+- Introduce `TypeFusion::Processor` for processing samples
+- Add support for running TypeFusion in the test environment with Minitest
+- Rescue and log when job failed to enqueue
+- Add Rake task for manually processing enqueued jobs
 
 ## [0.0.4] - 2023-08-16
 

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    type_fusion (0.0.4)
+    type_fusion (0.0.6)
       lhc (~> 15.2)
       litejob (~> 0.2.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.7)
+    activesupport (7.0.7.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -54,7 +54,7 @@ GEM
     rake (13.0.6)
     regexp_parser (2.8.1)
     rexml (3.2.6)
-    rubocop (1.56.0)
+    rubocop (1.56.1)
       base64 (~> 0.1.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)

data/README.md

@@ -14,6 +14,44 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install type_fusion
 ```
 
+### Running TypeFusion in the `test` environment
+
+Setup TypeFusion if you only want to run TypeFusion as part of your test suite.
+
+#### Minitest
+
+You can require `type_fusion/minitest` in your `test_helper.rb`:
+
+```diff
+# test/test_helper.rb
+
+ENV["RAILS_ENV"] ||= "test"
+require_relative "../config/environment"
+require "rails/test_help"
+
++require "type_fusion/minitest"
+
+class ActiveSupport::TestCase
+  # ...
+end
+```
+
+#### RSpec
+
+You can require `type_fusion/rspec` in your `spec_helper.rb`:
+
+```diff
+# spec/spec_helper.rb
+
++require "type_fusion/rspec"
+
+RSpec.configure do |config|
+  # ...
+end
+```
+
+### Running TypeFusion in `development` or `production`
+
 #### Rack
 
 ```ruby
@@ -27,6 +65,7 @@ use TypeFusion::Middleware
 Adding the gem to your applications Gemfile will automatically setup `type_fusion`.
 
 
+
 ## Configuration
 
 Setup `TypeFusion` in an initializer
@@ -134,19 +173,20 @@ TypeFusion::Sampler.instance.samples
 TypeFusion::Sampler.instance.samples.first
 
 # => #<struct TypeFusion::SampleCall
-#      gem_and_version="nokogiri-1.15.4-x86_64-darwin",
+#      gem_name="nokogiri"
+#      gem_version="1.15.4-x86_64-darwin",
 #      receiver="Nokogiri",
 #      method_name=:parse,
-#      location=[
-#        "/Users/marcoroth/.anyenv/envs/rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/nokogiri-1.15.4-x86_64-darwin/lib/nokogiri.rb",
-#        43
-#      ],
+#      application_name="TypeFusion",
+#      location="/Users/marcoroth/.anyenv/envs/rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/nokogiri-1.15.4-x86_64-darwin/lib/nokogiri.rb:43",
+#      type_fusion_version="0.0.4",
 #      parameters=[
 #        [:string, :req, String],
 #        [:url, :opt, NilClass],
 #        [:encoding, :opt, NilClass],
 #        [:options, :opt, NilClass]
-#      ]
+#      ],
+#      return_value="Nokogiri::XML::Document"
 #     >
 ```
 

data/lib/tasks/type_fusion.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :type_fusion do
+  desc "Process enqueued type samples"
+  task :process do
+    TypeFusion.processor.process!
+  end
+end

data/lib/type_fusion/config.rb

@@ -23,7 +23,7 @@ module TypeFusion
       @type_sample_call_rate = 0.001
       @type_sample_request = ->(_env) { [true, false, false, false].sample }
       @type_sample_tracepoint_path = ->(_tracepoint_path) { true }
-      @endpoint = "http://localhost:3000/api/v1/types/samples"
+      @endpoint = "https://gem.sh/api/v1/types/samples"
       @application_name = "TypeFusion"
     end
 

data/lib/type_fusion/litejob.rb

@@ -5,3 +5,10 @@ require "litejob"
 # Litequeue.configure do |config|
 #   config.path = "db/type_fusion/queue.sqlite3"
 # end
+
+Litejob.configure do |config|
+  config.logger = Class.new do
+    def self.info(*args)
+    end
+  end
+end

data/lib/type_fusion/minitest.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "../type_fusion"
+
+TypeFusion.start
+
+Minitest.after_run do
+  TypeFusion.stop
+  TypeFusion.processor.process!
+end

data/lib/type_fusion/processor.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module TypeFusion
+  class Processor
+    def initialize(amount = 4)
+      @amount = amount
+      @servers = []
+      @started = false
+    end
+
+    def should_run?
+      enqueued_jobs.positive?
+    end
+
+    def started?
+      @started
+    end
+
+    def enqueued_jobs
+      Litequeue.instance.count
+    end
+
+    def stop!
+      @servers.each do |server|
+        server.instance_variable_get(:@scheduler).context.kill
+      end
+      @servers = []
+      @started = false
+    end
+
+    def start!
+      @amount.times do
+        @servers << Litejob::Server.new
+      end
+      @started = true
+    end
+
+    def process!
+      puts "[TypeFusion] Start processing of #{enqueued_jobs} samples using #{@amount} threads..."
+
+      Signal.trap("INT") do
+        puts "\n[TypeFusion] Stop processing of TypeFusion samples..."
+        stop!
+      end
+
+      start!
+
+      while should_run?
+        puts "[TypeFusion] Remaining samples: #{Litequeue.instance.count}"
+        sleep 1
+      end
+
+      puts "[TypeFusion] Finished!"
+
+      puts "[TypeFusion] Congratulations! You just contributed samples to the following gems and helped making the Ruby ecosystem better for the whole community! Thank you!\n"
+      puts "- #{gems.join("\n- ")}"
+
+      stop!
+    end
+
+    private
+
+    def gems
+      TypeFusion::Sampler.instance.samples.map(&:gem_name).uniq.sort
+    end
+  end
+end

data/lib/type_fusion/rack/middleware.rb

@@ -16,6 +16,8 @@ module TypeFusion
 
       @app.call(env)
     ensure
+      TypeFusion.start_processing unless TypeFusion.processor.started?
+
       TypeFusion.stop
     end
   end

data/lib/type_fusion/rspec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "../type_fusion"
+
+TypeFusion.start
+
+RSpec.configure do |config|
+  config.after(:suite) do
+    TypeFusion.stop
+    TypeFusion.processor.process!
+  end
+end

data/lib/type_fusion/sampler.rb

@@ -10,7 +10,6 @@ module TypeFusion
 
     def initialize
       @samples = []
-      @litejob_server ||= Litejob::Server.new([["default", 1]])
     end
 
     def with_sampling
@@ -38,20 +37,27 @@ module TypeFusion
           parameters = extract_parameters(args, tracepoint.binding)
           return_value = type_for_object(tracepoint.return_value)
 
-          sample = SampleCall.new(
+          sample_values = {
             gem_name: gem,
             gem_version: version,
             receiver: receiver,
             method_name: method_name,
+            application_name: TypeFusion.config.application_name,
             location: location,
             type_fusion_version: VERSION,
             parameters: parameters,
-            application_name: TypeFusion.config.application_name,
             return_value: return_value,
-          )
+          }
+
+          sample = SampleCall.new(*sample_values.values)
 
           samples << sample
-          SampleJob.perform_async(sample)
+
+          begin
+            SampleJob.perform_async(sample)
+          rescue StandardError => e
+            puts "[TypeFusion] Couldn't enqueue sample: #{e.inspect}"
+          end
         end
       end.tap(&:disable)
     end

data/lib/type_fusion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TypeFusion
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/lib/type_fusion.rb

@@ -6,6 +6,7 @@ require_relative "type_fusion/litejob"
 require_relative "type_fusion/sample_call"
 require_relative "type_fusion/sample_job"
 require_relative "type_fusion/sampler"
+require_relative "type_fusion/processor"
 
 module TypeFusion
   class << self
@@ -23,6 +24,16 @@ module TypeFusion
       Sampler.instance.trace.disable
     end
 
+    def start_processing
+      puts "[TypeFusion] Start processing..."
+      processor.start!
+    end
+
+    def stop_processing
+      puts "[TypeFusion] Stop processing..."
+      processor.stop!
+    end
+
     def with_sampling
       start
 
@@ -30,6 +41,10 @@ module TypeFusion
 
       stop
     end
+
+    def processor
+      @processor ||= TypeFusion::Processor.new(4)
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: type_fusion
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Marco Roth
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -53,11 +53,15 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- lib/tasks/type_fusion.rake
 - lib/type_fusion.rb
 - lib/type_fusion/config.rb
 - lib/type_fusion/litejob.rb
+- lib/type_fusion/minitest.rb
+- lib/type_fusion/processor.rb
 - lib/type_fusion/rack/middleware.rb
 - lib/type_fusion/rails/railtie.rb
+- lib/type_fusion/rspec.rb
 - lib/type_fusion/sample_call.rb
 - lib/type_fusion/sample_job.rb
 - lib/type_fusion/sampler.rb
@@ -86,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Community-contributed sample data for Ruby types