active_interaction_mapper 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d0ed67fcfda4a6fff4d58994183112c5106a9c5c3088e605e085d69142ed5a3
-  data.tar.gz: cbcd25da9413a1a4c300e905282dbd0bdc36e6f93d64d23b0769fd536d7e5343
+  metadata.gz: 04df9c268dba3ec70903f55e79c1c2192ea5b48e56c54efe90151236163ba8ec
+  data.tar.gz: 0b52c77f0a6f2ad1f8fef6d0110c48019e736a80e4e15f528009dc5250f3444d
 SHA512:
-  metadata.gz: 1cc73cb54b61f0298b248629705d967947c4f8441bcbd71b1f071364090e1a1f08060afabb4e2a754b8ebf60d039a061dafe8af9db1dd9fba25c456b95a61fae
-  data.tar.gz: f53aa74b4c31f922f95539af5cbcb8bfbab01fc15875f18ecdb29c1411720d5e8c3e512d7f8b1f821bc863ed4bba5e7c74d6e704fa30914908eb41d264f81733
+  metadata.gz: 1948eb450ee1077ac2ad496d04010dd918ac3061f464258fa535bf103bb28137bc23ac6388d508698ba99095dc8db7590a56541afa135acf93ab72826197dd01
+  data.tar.gz: 4cae1c962e177c00f828a0423f2bc254106d013774750b14a3f380aac925396730b2e9192d5bad0a65e5f293ba1034e329a23cacf79262cf0de9aff90a1f1da9

data/Gemfile

@@ -13,4 +13,4 @@ gem "rubocop", "~> 1.7"
 
 gem "active_interaction", "~> 4.0"
 
-gem 'ruby-graphviz'
+gem 'ruby-graphviz', '~> 1.2.5'

data/README.md

@@ -1,8 +1,9 @@
 # ActiveInteractionMapper
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_interaction_mapper`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem allows the tracking of ActiveInteractions interactions. 
+This is done by tracking the .execute methode that is overridden in each class inheriting from ActiveInteraction. 
+To be able to trace function calls, I used Ruby's TracePoint class and to draw the graphs I used the 'ruby-graphviz' gem. 
+Note that you need to install GraphViz in your environment and have its path in your path environment variable to be able to draw graphs.
 
 ## Installation
 
@@ -20,9 +21,57 @@ Or install it yourself as:
 
     $ gem install active_interaction_mapper
 
+Note: You also need to install the gem : [ruby-graphviz](https://rubygems.org/gems/ruby-graphviz/) and install [graphviz](https://graphviz.org/download/) in your environment.
+
 ## Usage
 
-TODO: Write usage instructions here
+Generating a graph and outputting as text to STDOUT:
+
+```ruby
+ActiveInteractionMapper.trace(output_image: false) do
+  # Code to trace
+end
+```
+
+You can choose to output your result as a png as follows:
+
+```ruby
+ActiveInteractionMapper.trace(output_image: true, folder_name:'', file_name:'') do
+  # Code to trace
+end
+```
+By default, the files are generated in the tmp folder.
+If the folder_name and file_name are left empty, the code will create a directory and a file using the current date and time.
+
+You can also choose where the graph should start by using the start_at argument with the full name of the interaction you want to start at.
+
+```ruby
+ActiveInteractionMapper.trace(output_image: true, folder_name:'', file_name:'', start_at: 'ActiveInteractionA') do
+  # Code to trace
+end
+```
+
+Here's an example of a code I worked on. It runs an interaction in an Rspec test and puts the graph in the directory 'tmp/spec/.../test_file_name' and in a file with the name of the test running and the date it was run at.
+
+```ruby
+require 'active_interaction_mapper'
+
+RSpec.describe Test do
+  
+  around do |example|
+    path = example.metadata[:example_group][:file_path]
+    ActiveInteractionMapper.trace(folder_name: path.split('.')[1], file_name: example.metadata[:description]) do
+      example.call
+    end
+  end
+  it "does something useful" do
+    outcome = Test::ActiveInteractionA.run()
+    expect(outcome.result).to eq(true)
+  end
+end
+```
+
+
 
 ## Development
 

data/active_interaction_mapper.gemspec

@@ -33,7 +33,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'ruby-graphviz', '~> 1.2.5'
+
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/active_interaction_mapper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveInteractionMapper
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction_mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - charbel-elhajj
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-07 00:00:00.000000000 Z
-dependencies: []
+date: 2021-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
 description: |
   This gem allows the tracking of ActiveInteractions interactions.