type_fusion 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab5cbd551a4587ba748b987afef919d5f6c76e78ebf2ddeebdb42a37f57da3d8
-  data.tar.gz: 637f311b870a08bf9089fa4d254e79a1e72c5a2a0fa8946e7d7e962cf6bb54d3
+  metadata.gz: 7fd6c97b4b4bb6eeecea4ff23e108c24a7564ac3d85e2231352824cd27bf160e
+  data.tar.gz: a438ca7330e335d8d1922c967a24ef46a23403d6825e0e7a4740aafa6e93dcf6
 SHA512:
-  metadata.gz: d0404f787af472e5667ff5b2df86ba6b5bf4dd788f4d7cc92c611fe1042e2ac73a83c6ebb4d2630743cea6d141bb796e4b25979deb988ab806174d2f4073f7c7
-  data.tar.gz: ccbbd9629bc53af4f6a70b5bb2dff059b5b11b7b0732a628a93ea02ff5d3e8eb89e9aa09ce80b9bdc80284730045838f8f8deb29fffb592e63a6af56c4c2a992
+  metadata.gz: 48d5ea9c6b6c52e8fe44bd8b1ea295f96ff5e48e737985b7c75d21b5c8379d2934b8dfe6e0fa41acfc85aa4104427a7e86354ebed07823d81e37c85a5060d7e3
+  data.tar.gz: 54d0eae75e1b154a249ddf5eecf6facf7694d3fc43d0ea3e3c022e7225a0510f7e2d58758fbbba885f6b45c16f35236653054e3e1d9ea199b6dfb16696b88fa3

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.0.3] - 2023-08-13
+
+- Introduce `TypeFusion::Middleware` to allow type-sampling in Rack-powered apps
+- Introduce `TypeFusion::Railtie` to automatically setup type-sampling in Rails apps
+- Introduce `TypeFusion::Config` to control sampling
+  - Add `config.type_sample_call_rate` config
+  - Add `config.type_sample_request` config
+  - Add `config.type_sample_tracepoint_path` config
+
+## [0.0.2] - 2023-08-12
+
+- Initial Proof-of-Concept release
+- Implementation of the `TypeFusion::Sampler` class
+
 ## [0.0.1] - 2023-08-11
 
 - Initial release

data/Gemfile

@@ -7,3 +7,5 @@ gemspec
 gem "minitest", "~> 5.0"
 gem "rake", "~> 13.0"
 gem "rubocop", "~> 1.21"
+
+gem "litestack", github: "marcoroth/litestack"

data/Gemfile.lock

@@ -1,19 +1,42 @@
+GIT
+  remote: https://github.com/marcoroth/litestack.git
+  revision: 1911d5ef35f474425fb4e17a11a7d40deb4008a8
+  specs:
+    litestack (0.2.6)
+      erubi
+      hanami-router
+      oj
+      rack
+      sqlite3
+      tilt
+
 PATH
   remote: .
   specs:
-    type_fusion (0.0.1)
+    type_fusion (0.0.3)
+      litestack
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    erubi (1.12.0)
+    hanami-router (0.6.2)
+      hanami-utils (~> 0.7)
+      http_router (~> 0.11)
+    hanami-utils (0.9.2)
+    http_router (0.11.2)
+      rack (>= 1.0.0)
+      url_mount (~> 0.2.1)
     json (2.6.3)
     minitest (5.19.0)
+    oj (3.15.1)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
     racc (1.7.1)
+    rack (3.0.8)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.1)
@@ -31,13 +54,19 @@ GEM
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
+    sqlite3 (1.6.3-x86_64-darwin)
+    sqlite3 (1.6.3-x86_64-linux)
+    tilt (2.2.0)
     unicode-display_width (2.4.2)
+    url_mount (0.2.1)
+      rack
 
 PLATFORMS
   x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
+  litestack!
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)

data/README.md

@@ -14,9 +14,117 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install type_fusion
 ```
 
+#### Rack
+
+```ruby
+require "type_fusion/rack/middleware"
+
+use TypeFusion::Middleware
+```
+
+#### Rails
+
+Adding the gem to your applications Gemfile will automatically setup `type_fusion`.
+
+
+## Configuration
+
+Setup `TypeFusion` in an initializer
+
+```ruby
+# config/initializers/type_fusion.rb
+
+require "type_fusion"
+
+TypeFusion.config do |config|
+
+  # === type_sample_request
+  #
+  # Set type_sample_request to a lambda which resolves to true/false
+  # to set if type sampling should be enabled for the whole rack request.
+  #
+  # Default: ->(rack_env) { [true, false, false, false].sample }
+  #
+  # config.type_sample_request = ->(rack_env) { [true, false, false, false].sample }
+
+
+  # === type_sample_tracepoint_path
+  #
+  # Set type_sample_tracepoint_path to a lambda which resolves
+  # to true/false to check if a tracepoint_path should be sampled
+  # or not.
+  #
+  # This can be useful when you only want to sample method calls for
+  # certain gems or want to exclude a gem from being sampled.
+  #
+  # Example:
+  # config.type_sample_tracepoint_path = ->(tracepoint_path) {
+  #   # only sample calls for the Nokogiri gem
+  #   tracepoint_path.include?("nokogiri")
+  # }
+  #
+  # Default: ->(tracepoint_path) { true }
+  #
+  # config.type_sample_tracepoint_path = ->(tracepoint_path) { true }
+
+
+  # === type_sample_call_rate
+  #
+  # Set type_sample_call_rate to 1.0 to capture 100% of method calls
+  # within a rack request.
+  #
+  # Default: 0.001
+  #
+  # config.type_sample_call_rate = 0.001
+end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+#### Type sample inside a block
+
+```ruby
+TypeFusion.with_sampling do
+  # run code you want to type sample here
+end
+```
+
+#### Type sample globally
+
+```ruby
+TypeFusion.start
+
+# run code you want to type sample here
+
+TypeFusion.stop
+```
+
+#### Retrieve the samples
+
+```ruby
+TypeFusion::Sampler.instance.samples
+# => [...]
+```
+
+```ruby
+TypeFusion::Sampler.instance.samples.first
+
+# => #<struct TypeFusion::SampleCall
+#      gem_and_version="nokogiri-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
+#      ],
+#      parameters=[
+#        [:string, :req, String],
+#        [:url, :opt, NilClass],
+#        [:encoding, :opt, NilClass],
+#        [:options, :opt, NilClass]
+#      ]
+#     >
+```
 
 ## Development
 

data/lib/type_fusion/config.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module TypeFusion
+  class << self
+    def config
+      @config ||= Config.instance
+
+      yield @config if block_given?
+
+      @config
+    end
+  end
+
+  class Config
+    include Singleton
+
+    attr_accessor :type_sample_call_rate, :type_sample_request, :type_sample_tracepoint_path
+
+    def initialize
+      @type_sample_call_rate = 0.001
+      @type_sample_request = ->(_env) { [true, false, false, false].sample }
+      @type_sample_tracepoint_path = ->(_tracepoint_path) { true }
+    end
+
+    def type_sample_request?(env)
+      type_sample_request&.call(env)
+    end
+
+    def type_sample_tracepoint_path?(env)
+      type_sample_tracepoint_path&.call(env)
+    end
+
+    def type_sample_call?
+      type_sample_call_rate > rand
+    end
+  end
+end

data/lib/type_fusion/rack/middleware.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "type_fusion/sampler"
+
+module TypeFusion
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if TypeFusion.config.type_sample_request?(env)
+        puts "[TypeFusion] Type-sampling this request"
+        TypeFusion.start
+      end
+
+      @app.call(env)
+    ensure
+      TypeFusion.stop
+    end
+  end
+end

data/lib/type_fusion/rails/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TypeFusion
+  class Railtie < ::Rails::Railtie
+    initializer "type_fusion.middleware" do |app|
+      require "type_fusion/rack/middleware"
+
+      app.config.middleware.use TypeFusion::Middleware
+    end
+  end
+end

data/lib/type_fusion/sample_call.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "json"
+
+module TypeFusion
+  SampleCall = Struct.new(:gem_and_version, :receiver, :method_name, :location, :parameters) do
+    def to_s
+      JSON.pretty_generate(to_h)
+    end
+  end
+end

data/lib/type_fusion/sample_job.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "litestack"
+
+module TypeFusion
+  class SampleJob
+    include Litejob
+
+    self.queue = :default
+
+    def perform(sample)
+      puts sample.inspect
+    end
+  end
+end

data/lib/type_fusion/sampler.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module TypeFusion
+  class Sampler
+    include Singleton
+
+    attr_accessor :samples
+
+    def initialize
+      @samples = []
+    end
+
+    def with_sampling
+      trace.enable
+
+      yield if block_given?
+
+      trace.disable
+    end
+
+    def trace
+      @trace ||= TracePoint.trace(:call) do |tracepoint|
+        if sample?(tracepoint.path)
+          receiver = begin
+            tracepoint.binding.receiver.name
+          rescue StandardError
+            tracepoint.binding.receiver.class.name
+          end
+
+          method_name = tracepoint.method_id
+          location = tracepoint.binding.source_location
+          gem_and_version = location.first.gsub(gem_path, "").split("/").first
+          args = tracepoint.parameters.map(&:reverse).to_h
+          parameters = extract_parameters(args, tracepoint.binding)
+
+          sample = SampleCall.new(
+            gem_and_version: gem_and_version,
+            receiver: receiver,
+            method_name: method_name,
+            location: location,
+            parameters: parameters,
+          )
+
+          samples << sample
+          SampleJob.perform_async(sample)
+        end
+      end.tap(&:disable)
+    end
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "#<TypeFusion::Sampler sample_count=#{@samples.count}>"
+    end
+
+    def reset!
+      @samples = []
+      @trace = nil
+    end
+
+    private
+
+    def sample?(tracepoint_path)
+      TypeFusion.config.type_sample_call? &&
+        TypeFusion.config.type_sample_tracepoint_path?(tracepoint_path) &&
+        tracepoint_path.start_with?(gem_path)
+    end
+
+    def type_for_object(object)
+      case object
+      when Hash
+        ["Hash", object.map { |key, value| [key, type_for_object(value)] }]
+      when Array
+        ["Array", object.map { |value| type_for_object(value) }]
+      else
+        object.class
+      end
+    end
+
+    def extract_parameters(args, binding)
+      args.map do |name, kind|
+        variable = name.to_s.gsub("*", "").gsub("&", "").to_sym
+
+        type = if binding.local_variables.include?(variable)
+                 type_for_object(binding.local_variable_get(variable))
+               else
+                 # *, ** or &
+                 "unused"
+               end
+
+        [name, kind, type]
+      end
+    end
+
+    def gem_path
+      "#{Gem.default_path.last}/gems/"
+    end
+  end
+end

data/lib/type_fusion/version.rb

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

data/lib/type_fusion.rb

@@ -1,6 +1,35 @@
 # frozen_string_literal: true
 
 require_relative "type_fusion/version"
+require_relative "type_fusion/config"
+require_relative "type_fusion/sample_call"
+require_relative "type_fusion/sample_job"
+require_relative "type_fusion/sampler"
 
 module TypeFusion
+  class << self
+    def start
+      return if Sampler.instance.trace.enabled?
+
+      puts "[TypeFusion] Starting Sampler..."
+      Sampler.instance.trace.enable
+    end
+
+    def stop
+      return unless Sampler.instance.trace.enabled?
+
+      puts "[TypeFusion] Stopping Sampler..."
+      Sampler.instance.trace.disable
+    end
+
+    def with_sampling
+      start
+
+      yield if block_given?
+
+      stop
+    end
+  end
 end
+
+require_relative "type_fusion/rails/railtie" if defined?(Rails::Railtie)

data/test.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+require_relative "lib/type_fusion"
+
+TypeFusion.config do |config|
+  config.type_sample_call_rate = 1.0
+
+  config.type_sample_tracepoint_path = lambda do |tracepoint_path|
+    tracepoint_path.include?("nokogiri")
+  end
+end
+
+TypeFusion.with_sampling do
+  Nokogiri.parse("<h1></h1>")
+end
+
+puts TypeFusion::Sampler.instance.samples
+puts TypeFusion::Sampler.instance.to_s

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: type_fusion
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Marco Roth
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
-dependencies: []
+date: 2023-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: litestack
+  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'
 description: Community-contributed sample data for Ruby types
 email:
 - marco.roth@intergga.ch
@@ -26,8 +40,15 @@ files:
 - README.md
 - Rakefile
 - lib/type_fusion.rb
+- lib/type_fusion/config.rb
+- lib/type_fusion/rack/middleware.rb
+- lib/type_fusion/rails/railtie.rb
+- lib/type_fusion/sample_call.rb
+- lib/type_fusion/sample_job.rb
+- lib/type_fusion/sampler.rb
 - lib/type_fusion/version.rb
 - sig/type_fusion.rbs
+- test.rb
 homepage: https://github.com/marcoroth/type_fusion
 licenses: []
 metadata: