wisper-visualize 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7f18c7b6067cdf60a78ab594b64b7403883fdeb
+  data.tar.gz: 7625eb20cd5f4b9804e4790fd87f9dee086d028d
+SHA512:
+  metadata.gz: a29965090d23ecfe01814dacad8e69e50c2c356f44f99e7cd2e20b89b478d49016d903bad0aa40d6a1c8e8e320e78cc1f5ccaa2ad337ab1c069585785d48163e
+  data.tar.gz: 020d16484de852eae21bd81e541c00934e540052f783f174dacd9193e482fc2ba82a573224c148c5025966e26c3938a1eb92854cd5f6a27a4942d6adb879b7cc

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# gem 'wisper', path: '~/dev/wisper'
+
+gem 'bundler'
+gem 'rake'
+gem 'rspec'
+gem 'pry-byebug'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kris Leech
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Wisper::Visualize
+
+Provides a graph of published [Wisper](https://github.com/krisleech/wisper) events as a PNG or PDF
+
+![example output](https://raw.githubusercontent.com/krisleech/wisper-visualize/master/output_example.png)
+
+## Installation
+
+```ruby
+gem 'wisper-visualize'
+```
+
+## Usage
+
+```ruby
+report = Wisper::Visualize.report
+
+# broadcast some events...
+
+report.to_pdf('/tmp/events-graph.pdf')
+report.to_png('/tmp/events-graph.png')
+```
+
+You can also get a collection of all events published:
+
+```ruby
+report.events # => [...]
+```
+
+Each event has the following attributes:
+
+```ruby
+event.name
+event.publisher_name
+event.subscriber_name
+event.arg_names
+event.created_at
+event.frequency
+```
+
+## Rspec
+
+```ruby
+around(:each) do |example|
+  report = Wisper::Visualize.report
+  example.call
+  report.to_pdf("/tmp/events-graph-#{example.metadata[:full_description]}.pdf")
+end
+```
+
+## Contributing
+
+Yes, please.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/wisper/visualize.rb

@@ -0,0 +1,14 @@
+require 'wisper'
+require 'graphviz'
+
+require 'wisper/visualize/recording_broadcaster'
+require 'wisper/visualize/report'
+require 'wisper/visualize/version'
+
+module Wisper
+  module Visualize
+    def self.report
+      Report.new
+    end
+  end
+end

data/lib/wisper/visualize/recording_broadcaster.rb

@@ -0,0 +1,80 @@
+module Wisper
+  module Visualize
+    class RecordingBroadcaster
+      def initialize(broadcaster)
+        @events      = []
+        @broadcaster = broadcaster
+      end
+
+      def broadcast(subscriber, publisher, event, args)
+        @broadcaster.broadcast(subscriber, publisher, event, args)
+        @events.push(Event.new(subscriber, publisher, event, args))
+      end
+
+      def events
+        @events.dup
+      end
+
+      # de-duplicates events and increments frequency for each duplicate
+      # FIXME: ugly...
+      def flattened_events
+        _result = []
+        _events = events
+
+        while event = _events.pop do
+          match = _events.find { |e| e == event }
+          if match.nil?
+            _result << event
+          else
+            match.increment_frequency
+          end
+        end
+
+        _result
+      end
+
+      class Event
+        attr_reader :subscriber_name, :publisher_name, :name, :arg_names,
+                    :frequency, :created_at
+
+        def initialize(subscriber, publisher, name, args)
+          @subscriber_name = label(subscriber)
+          @publisher_name  = label(publisher)
+          @name            = name
+          @arg_names       = arg_labels(args)
+          @frequency       = 1
+          @created_at      = Time.now
+        end
+
+        def frequency_label
+          frequency == 1 ? '' : "#{frequency}x "
+        end
+
+        def increment_frequency
+          @frequency += 1
+        end
+
+        def ==(other)
+          name == other.name &&
+          # arg_names == other.arg_names &&
+          subscriber_name == other.subscriber_name &&
+          publisher_name == other.publisher_name
+        end
+
+        private
+
+        def label(object)
+          id_method  = %w(id uuid key object_id).find { |id_method| object.respond_to?(id_method) }
+          id         = object.send(id_method)
+          class_name = object.class == Class ? object.name : object.class.name
+          "#{class_name}##{id}"
+        end
+
+        def arg_labels(args)
+          return 'no arguments' if args.empty?
+          args.map { |arg| label(arg) }.join(', ')
+        end
+      end
+    end
+  end
+end

data/lib/wisper/visualize/report.rb

@@ -0,0 +1,45 @@
+module Wisper
+  module Visualize
+    class Report
+
+      def initialize
+        Wisper.configure do |config|
+          config.broadcaster :default, RecordingBroadcaster.new(config.broadcasters[:default])
+        end
+      end
+
+      def events
+        Wisper.configuration.broadcasters[:default].flattened_events
+      end
+
+      def to_pdf(path)
+        graph.output(pdf: path)
+      end
+
+      def to_png(path)
+        graph.output(png: path)
+      end
+
+      private
+
+      def graph
+        GraphViz.new(:G, type: :digraph, size: '500,500', ratio: 'auto').tap do |g|
+          events.each do |event|
+            sub_node = g.add_nodes(event.subscriber_name)
+            pub_node = g.add_nodes(event.publisher_name)
+
+            sub_node.shape = 'rect'
+            sub_node.color = 'steelblue'
+
+            pub_node.shape = 'rect'
+            pub_node.color = 'royalblue'
+
+            edge = g.add_edges(pub_node, sub_node, color: 'red')
+            edge[:label] = "#{event.frequency_label}#{event.name}"
+            # edge[:label] = "#{event.frequency_label}#{event.name}(#{event.arg_names})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wisper/visualize/version.rb

@@ -0,0 +1,5 @@
+module Wisper
+  module Visualize
+    VERSION = "0.0.1"
+  end
+end

data/spec/recording_broadcaster_spec.rb

@@ -0,0 +1,24 @@
+module Wisper::Visualize
+  describe RecordingBroadcaster do
+
+    subject(:broadcaster) { RecordingBroadcaster.new(another_broadcaster) }
+
+    let(:another_broadcaster) { double.as_null_object }
+
+    let(:publisher)  { double }
+    let(:subscriber) { double }
+    let(:event)      { 'foobar' }
+    let(:args)       { [1,2,3] }
+
+    before { allow(subscriber).to receive(:foobar) }
+
+    it 'delegates broadcasting on to given broadcaster' do
+      expect(another_broadcaster).to receive(:broadcast).with(subscriber, publisher, event, args)
+      broadcaster.broadcast(subscriber, publisher, event, args)
+    end
+
+    it 'stores all events' do
+      expect { broadcaster.broadcast(subscriber, publisher, event, args) }.to change { broadcaster.events.size }.from(0).to(1)
+    end
+  end
+end

data/spec/report_spec.rb

@@ -0,0 +1,43 @@
+module Wisper
+  module Visualize
+    describe Report do
+      let(:path) { '/tmp/visualization.pdf' }
+
+      let(:publisher_class) { Class.new { include Wisper::Publisher; public :broadcast } }
+
+      before do
+        File.delete(path) if File.exist?(path)
+        allow(publisher_class).to receive(:name).and_return('MyPublisher')
+      end
+
+      subject!(:report) { Report.new }
+
+      it '.to_pdf creates a file' do
+        publishers = 20.times.map { publisher_class.new }
+        subscribers = 20.times.map { double.as_null_object }
+        events = %w(user_created order_canceled order_created login_failed)
+
+        40.times do
+          p = publishers.sample
+          s = subscribers.sample
+          p.subscribe(s)
+          p.broadcast(events.sample)
+        end
+
+        report.to_pdf(path)
+
+        expect(File.exist?(path)).to be_truthy
+      end
+
+      it '.events returns de-duplicated events' do
+        publisher = publisher_class.new
+        listener  = double
+
+        allow(listener).to receive(:foobar)
+        publisher.subscribe(listener)
+
+        expect { 10.times { publisher.broadcast(:foobar) } }.to change { report.events.size }.from(0).to(1)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'wisper/visualize'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/visualize_spec.rb

@@ -0,0 +1,7 @@
+module Wisper
+  describe Visualize do
+    it '.report return Report class' do
+      expect(Visualize.report).to be_an_instance_of(Visualize::Report)
+    end
+  end
+end

data/wisper-visualize.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wisper/visualize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wisper-visualize"
+  spec.version       = Wisper::Visualize::VERSION
+  spec.authors       = ["Kris Leech"]
+  spec.email         = ["kris.leech@gmail.com"]
+  spec.summary       = 'Visualizations for Wisper events'
+  spec.description   = 'Visualizations for Wisper events'
+  spec.homepage      = "https://github.com/krisleech/wisper-visualize"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'wisper'
+  spec.add_dependency 'ruby-graphviz'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: wisper-visualize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kris Leech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wisper
+  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'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  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: Visualizations for Wisper events
+email:
+- kris.leech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wisper/visualize.rb
+- lib/wisper/visualize/recording_broadcaster.rb
+- lib/wisper/visualize/report.rb
+- lib/wisper/visualize/version.rb
+- output_example.png
+- spec/recording_broadcaster_spec.rb
+- spec/report_spec.rb
+- spec/spec_helper.rb
+- spec/visualize_spec.rb
+- wisper-visualize.gemspec
+homepage: https://github.com/krisleech/wisper-visualize
+licenses:
+- MIT
+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: Visualizations for Wisper events
+test_files:
+- spec/recording_broadcaster_spec.rb
+- spec/report_spec.rb
+- spec/spec_helper.rb
+- spec/visualize_spec.rb