type_fusion 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab5cbd551a4587ba748b987afef919d5f6c76e78ebf2ddeebdb42a37f57da3d8
-  data.tar.gz: 637f311b870a08bf9089fa4d254e79a1e72c5a2a0fa8946e7d7e962cf6bb54d3
+  metadata.gz: ce0738a57fd5c0b08679b9ea5fd5fe16ddd786326a8269aa09905acb9b7bb7ac
+  data.tar.gz: c55387825018723f436f302d8ec6f842a9e9a635ca0c779a9a498d32a906ed91
 SHA512:
-  metadata.gz: d0404f787af472e5667ff5b2df86ba6b5bf4dd788f4d7cc92c611fe1042e2ac73a83c6ebb4d2630743cea6d141bb796e4b25979deb988ab806174d2f4073f7c7
-  data.tar.gz: ccbbd9629bc53af4f6a70b5bb2dff059b5b11b7b0732a628a93ea02ff5d3e8eb89e9aa09ce80b9bdc80284730045838f8f8deb29fffb592e63a6af56c4c2a992
+  metadata.gz: 9ba2541d870cd306acf5a5c8a06367117aff283a28502940424d2931641f9405c85a053684ff73e74a163cce14d15409706f00cf69de7d0c22f8caaf30586cd4
+  data.tar.gz: 4b929bacae1bc294fbdde9df386aa4833329252f46a438c8daae53049fb9687fca7296fa0ca3f4e4db9b576bc00241d249c62cf5b500e04561a9dc1ebb50590e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [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/README.md

@@ -16,7 +16,54 @@ gem install type_fusion
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require "type_fusion"
+```
+
+#### Type sample inside a block
+
+```ruby
+TypeFusion::Sampler.instance.with_sampling do
+  # run code you want to type sample here
+end
+```
+
+#### Type sample globally
+
+```ruby
+TypeFusion::Sampler.instance.trace.enable
+
+# run code you want to type sample here
+
+TypeFusion::Sampler.instance.trace.disable
+```
+
+#### Retrieve the samples
+
+```ruby
+TypeFusion::Sampler.instance.trace.samples
+# => [...]
+```
+
+```ruby
+TypeFusion::Sampler.instance.trace.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/sample_call.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+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/sampler.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "singleton"
+require "json"
+
+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 tracepoint.path.start_with?(gem_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)
+
+          samples << SampleCall.new(
+            gem_and_version: gem_and_version,
+            receiver: receiver,
+            method_name: method_name,
+            location: location,
+            parameters: parameters,
+          )
+        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 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.2"
 end

data/lib/type_fusion.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "type_fusion/version"
+require_relative "type_fusion/sample_call"
+require_relative "type_fusion/sampler"
 
 module TypeFusion
 end

data/test.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+require_relative "lib/type_fusion"
+
+TypeFusion::Sampler.instance.with_sampling do
+  Nokogiri.parse("<h1></h1>")
+end
+
+puts TypeFusion::Sampler.instance.samples
+puts TypeFusion::Sampler.instance.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: type_fusion
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Marco Roth
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2023-08-12 00:00:00.000000000 Z
 dependencies: []
 description: Community-contributed sample data for Ruby types
 email:
@@ -26,8 +26,11 @@ files:
 - README.md
 - Rakefile
 - lib/type_fusion.rb
+- lib/type_fusion/sample_call.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: