gotero 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b603c0e3c2cd0a4f324336df9a100281e55a0a4
+  data.tar.gz: 288ebeb2aace424e4a2835a22766f3b7dced3d88
+SHA512:
+  metadata.gz: d25c28f7d68eb8ef81947c68c2f3d771b8b41fa908599195c814a08840bea002d724bf3021b5695c7d320824f3f1a410cdc74faddb72f6a21320d0dd779a0bed
+  data.tar.gz: 202e9f79f54f152906d69c3ed7241c464ff3664fb980c596a6f53861cce20e3025086b5d902c98ad4a02da6a48f356026a4da70f642d16138891834c8ddd41a7

data/lib/gotero.rb

@@ -0,0 +1,78 @@
+# La principal funcion de gotero es ofrecer al usuario comprensión sobre los
+# llamados realizados por la aplicación para ententer la interacción entre los
+# objetos.
+#
+# Para hacerlo la idea es ejecutar un bloque de código con un gotero, el cual
+# pone luego a disposición un diagrama de secuencias.
+# 
+# Entonces lo primero va a ser definir una clase Gotero
+
+class Gotero
+  
+  # Por el momento, vamos a guardar el resultado como un string y lo vamos a
+  # hacer accesible, después vamos a ver como podemos guardar esta información
+  # de una forma más adaptada a nuestras necesidades.
+  attr_accessor :output
+
+  # Inicialmente la secuencia va a estar vacía y nuestro primer objeto va a ser
+  # un sujeto `:t` (ya que se me ocurre que esto lo estamos corriendo como un
+  # test)
+  def initialize
+    @output = ''
+    @emiters = [:t]
+  end
+
+  # La interface publica de gotero simplemente recibe un bloque y lo ejecuta con
+  # el gotero habilitado
+  def trace &block
+    tracer.enable &block
+  end
+
+  # Más allá de esa interface pública, el resto es privado
+  private
+
+  # Para hacer el seguimiento, lo que vamos a usar es `TracePoint` al cual, si
+  # le pasamos un bloque ejecuta el bloque cada vez que un evento del tipo
+  # indicado se realiza.
+  #
+  # Los eventos que nos interesan son `call` y `return`, o sea llamados a
+  # métodos y retornos de métodos.
+  def tracer
+    TracePoint.new(:call, :return) do |tp|
+      case tp.event
+      when :call then on_call(tp)
+      when :return then on_return(tp)
+      end
+    end
+  end
+
+  # Cuando se hace un llamado a un método necesitamos saber quien lo llamó y
+  # quien es el receptor, para guardamos la pila de emisores, el receptor de un
+  # mensaje siempre es el emisor del siguiente mensaje, excepto en el caso en
+  # que un mensaje vuelva.
+  #
+  # Además de emisor y receptor, necesitamos saber el método que estamos
+  # llamando y, ya que estamos, los argumentos con los que se llama al método.
+  def on_call tracepoint
+    current_emiter = @emiters.last
+    receiver = tracepoint.defined_class
+    subject = receiver.name.downcase
+    method = tracepoint.method_id
+    detached_method = receiver.instance_method(method)
+    arguments = detached_method.parameters.map do |param|
+      tracepoint.binding.local_variable_get param[1]
+    end.join(', ')
+    message_details = " #{ method } (#{ arguments })"
+    self.output << "#{ current_emiter }->#{ subject }:#{ message_details }\n"
+    @emiters << subject.to_sym
+  end
+
+  # En el caso del return el receptor es el que está pen-último en la pila, así
+  # que lo que hacemos es sacar el último de la pila (y dejarlo como emisor) y
+  # tomar como receptor al que queda último.
+  def on_return tracepoint
+    emiter = @emiters.pop
+    receiver = @emiters.last
+    self.output << "#{ emiter }->#{ receiver }:\n"
+  end
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: gotero
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RubyLit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-04 00:00:00.000000000 Z
+dependencies: []
+description: Use a tracer to build a sequence diagram of a block of code.
+email: rubylitar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gotero.rb
+homepage: https://github.com/rubylit/gotero
+licenses:
+- AGPL-3.0+
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Sequence diagrams from runtime.
+test_files: []