journeyviz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 00ee3821859c87a8c2a049d1ff60258ad6a5dfcd82e24ce3a8dd71dba9c1eead
+  data.tar.gz: ab015af88e3d0fb7de33f0f6a9a2b427f1a87ddc8ab034dfce18438a1d0a8298
+SHA512:
+  metadata.gz: fb8ac7208e4bddc29cf4b7567d74e5abb2a5bfa33e13421c5eac58bedee9637a600eecfec1eae7229ded8a7530eb0a84a7fed14146c53f6d686eb9eb07a50e90
+  data.tar.gz: ee35eadfa9a2ab5f8e94f454661beda75972b1c95b809e412d776402b8103debb3f11026975e0bf780c3531e44127e1dea295083b241160d6c18a483a2789054

data/.github/workflows/gem-push.yml

@@ -0,0 +1,30 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/tests.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  main:
+    name: >-
+      ${{ matrix.os }} ${{ matrix.ruby }}
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu, macos, windows ]
+        ruby: [ 2.4, 2.5, 2.6, 2.7, head ]
+        include:
+          - { os: windows, ruby: mingw }
+        exclude:
+          - { os: windows, ruby: head  }
+
+    steps:
+      - name: windows misc
+        if: matrix.os == 'windows'
+        run: |
+          # set TMPDIR, git core.autocrlf
+          echo "::set-env name=TMPDIR::$env:RUNNER_TEMP"
+          git config --system core.autocrlf false
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: install dependencies
+        run:  bundle install --jobs 3 --retry 3
+      - name: spec
+        run:  bundle exec rspec
+      - name: linter
+        run:  bundle exec rubocop

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,35 @@
+Layout/LineLength:
+  Max: 120
+
+# TODO: Enable documentation
+Style/Documentation:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/AsciiComments:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+
+Layout/EndOfLine:
+  EnforcedStyle: lf

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in journeyviz.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    journeyviz (0.1.0)
+      rack-app
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.1.3)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.1.0)
+      ast (~> 2.4.0)
+    rack (2.2.3)
+    rack-app (7.6.4)
+      rack
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.81.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  journeyviz!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.81.0)
+  simplecov
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Gabriel Teles
+
+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,99 @@
+# Journeyviz
+
+Journeyviz is a journey visualization gem. It defines journey as code so it can be versioned together with changes.
+
+When defined, you can view your journey through a [rack](https://github.com/rack/rack) application.
+
+Supports Ruby 2.6.x officially.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'journeyviz'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install journeyviz
+
+## Usage
+
+
+### Defining the journey
+
+Start by defining a journey. It is consisted of for elements: blocks, screens, actions and transitions.
+
+Let's start from screens:
+
+```ruby
+# This is the journey definition block
+Journeyviz.configure do |journey|
+  # Here we're defining a screen called landing page
+  journey.screen :landing_page
+end
+```
+
+Now supose our landing page has a share button and we'd like to include it into our journey. We should define an action to represent it.
+
+```ruby
+Journeyviz.configure do |journey|
+  journey.screen :landing_page do |landing|
+    # Landing has an action called :share
+    landing.action :share
+  end
+end
+```
+
+Imagine that the landing page also has an login form that sends the user to a logged-in area, into a dashboard page. Now we're going to use blocks and transitions.
+
+```ruby
+Journeyviz.configure do |journey|
+  journey.screen :landing_page do |landing|
+    landing.action :share
+    # Define an action `login` that transitions the user to dashboard page
+    # %i[logged dashboard] is the path to that screen. It includes every
+    # block and finally the screen name.
+    landing.action :login, transition: %i[logged dashboard]
+  end
+
+  # Defining the logged area
+  journey.block :logged do |logged_area|
+    # Dashboard inside logged area
+    logged_area.screen :dashboard
+
+    # Blocks can have blocks, you can call `logged_area.block :sublock` how many
+    # times you want.
+  end
+end
+```
+
+### Visualizing journey
+
+With journey definition loaded, you just have to mount the journeyviz server into your
+rack application with `mount` command:
+
+```ruby
+mount Journeyviz::Server => '/journeyviz'
+```
+
+No just go to `/journeyviz` path on your application!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gabteles/journeyviz.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'journeyviz'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/journeyviz.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'journeyviz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'journeyviz'
+  spec.version       = Journeyviz::VERSION
+  spec.authors       = ['Gabriel Teles']
+  spec.email         = ['gabz.teles@gmail.com']
+
+  spec.summary       = 'Journey visualization made easy'
+  spec.description   = 'Define your user journey as code and track it historically and in realtime'
+  spec.homepage      = 'https://github.com/gabteles/journeyviz'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.81.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_dependency 'rack-app'
+end

data/lib/journeyviz.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'journeyviz/version'
+require 'journeyviz/server'
+require 'journeyviz/journey'
+
+module Journeyviz
+  class Error < StandardError; end
+  class InvalidNameError < Error; end
+  class DuplicatedDefinition < Error; end
+  class InvalidTransition < Error; end
+
+  class << self
+    def configure(&block)
+      @journey = Journey.new
+      block.call(journey)
+      journey.validate!
+    end
+
+    def identify(user_id)
+      context[:user_id] = user_id
+    end
+
+    def visit(screen)
+      # TODO
+      # screen/day/:day/visits ++
+      # screen/week/:week/visits ++
+      # screen/month/:month/visits ++
+      # screen/quarter/:quarter/visits ++
+    end
+
+    def act(action)
+      # TODO
+      # :action/day/:day ++
+      # :action/week/:week ++
+      # :action/month/:month ++
+      # :action/quarter/:quarter ++
+    end
+
+    def context
+      Thread.current[:journeyviz_context] ||= {}
+    end
+
+    def journey
+      @journey ||= Journey.new
+    end
+  end
+end

data/lib/journeyviz/action.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'journeyviz/normalized_name'
+
+module Journeyviz
+  class Action
+    include NormalizedName
+    attr_reader :screen
+
+    def initialize(name, screen, transition: nil)
+      assign_normalize_name(name)
+      @screen = screen
+      @transition = transition
+    end
+
+    def transition
+      case @transition
+      when Symbol then find_screen_by_name(@transition)
+      when Array then find_screen_by_full_qualifier(@transition)
+      end
+    end
+
+    def raw_transition
+      @transition
+    end
+
+    private
+
+    def find_screen_by_name(screen_name)
+      qualifier = screen.full_qualifier
+
+      (qualifier.size - 1).downto(0) do |len|
+        found_screen = find_screen_by_full_qualifier(qualifier[0, len] + [screen_name])
+        return found_screen if found_screen
+      end
+
+      nil
+    end
+
+    def find_screen_by_full_qualifier(qualifier)
+      screen.root_scope.find_screen(qualifier)
+    end
+  end
+end

data/lib/journeyviz/block.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'journeyviz/normalized_name'
+require 'journeyviz/node_group'
+require 'journeyviz/graphable'
+require 'journeyviz/scopable'
+
+module Journeyviz
+  class Block
+    include NormalizedName
+    include NodeGroup
+    include Graphable
+    include Scopable[:name]
+
+    def initialize(name, scope = nil)
+      assign_normalize_name(name)
+      assign_scope(scope)
+    end
+  end
+end

data/lib/journeyviz/graphable.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'journeyviz/graphable/externals'
+require 'journeyviz/graphable/transitions'
+
+module Journeyviz
+  module Graphable
+    include Externals
+    include Transitions
+
+    def graph
+      defs = [
+        *graph_screens,
+        *graph_blocks,
+        *graph_inputs,
+        *graph_outputs,
+        *graph_transitions,
+        *graph_styles
+      ].join("\n")
+
+      "graph LR\n#{defs}"
+    end
+
+    private
+
+    def graph_screens
+      (@screens || []).map { |screen| "#{graph_id(screen)}[#{screen.name}]:::screen" }
+    end
+
+    def graph_blocks
+      (@blocks || []).map { |block| "#{graph_id(block)}[#{block.name}]:::block" }
+    end
+
+    def graph_styles
+      [
+        'classDef screen fill:#373496,stroke:#373496,stroke-width:2px,color:#fff',
+        'classDef transition fill:#fff,stroke:#373496,stroke-width:2px,color:#373496,stroke-dasharray: 5, 5',
+        'classDef block fill:#963734,color:#fff'
+      ]
+    end
+
+    def graph_id(node)
+      case node
+      when Journeyviz::Screen then screen_id(node)
+      when Journeyviz::Block then block_id(node)
+      when Journeyviz::Action then action_id(node)
+      end
+    end
+
+    def screen_id(node)
+      "screen_#{node.full_qualifier.join('_')}"
+    end
+
+    def block_id(node)
+      "block_#{node.full_qualifier.join('_')}"
+    end
+
+    def action_id(node)
+      from_id = graph_id(node.screen)
+      to_id = graph_target(node)
+      "transition_#{from_id}_#{node.name}_#{to_id}"
+    end
+  end
+end

data/lib/journeyviz/graphable/externals.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Journeyviz
+  module Graphable
+    module Externals
+      private
+
+      def graph_inputs
+        return '' unless defined?(root_scope)
+
+        inputs = self.inputs.map { |screen| screen.full_scope + [screen] }
+
+        return '' if inputs.empty?
+
+        <<~INPUTS
+          subgraph inputs
+          #{graph_external_chain(inputs, 'input')}
+          end
+        INPUTS
+      end
+
+      def graph_outputs
+        outputs = self.outputs.map { |screen| screen.full_scope + [screen] }
+        return '' if outputs.empty?
+
+        <<~OUTPUTS
+          subgraph outputs
+          #{graph_external_chain(outputs, 'output')}
+          end
+        OUTPUTS
+      end
+
+      def graph_external_chain(nodes, sufix)
+        nodes
+          .group_by(&:first)
+          .flat_map { |parent, chain| graph_external_chain_node(parent, chain, sufix) }
+          .join("\n")
+      end
+
+      def graph_external_chain_node(parent, chain, sufix)
+        chain_without_parent = chain.map { |subchain| subchain[1..-1] }
+
+        if parent.is_a?(Journeyviz::Screen)
+          [graph_external_screen(parent, sufix)] + graph_external_transitions(parent)
+        else
+          graph_external_block(parent, chain_without_parent, sufix)
+        end
+      end
+
+      def graph_external_screen(screen, sufix)
+        "#{sufix}_#{graph_id(screen)}[#{screen.name}]:::external_screen"
+      end
+
+      def graph_external_transitions(screen)
+        screen
+          .actions
+          .select { |action| screens.include?(action.transition) }
+          .map { |action| "#{graph_id(action)}(#{action.name}):::transition" }
+      end
+
+      def graph_external_block(block, chain, sufix)
+        definition = graph_external_chain(chain, sufix)
+        return definition if block.is_a?(Journeyviz::Journey)
+
+        <<~SUBGRAPH
+          subgraph #{sufix}_#{graph_id(block)}[#{block.name}]
+          #{definition}
+          end
+        SUBGRAPH
+      end
+    end
+  end
+end

data/lib/journeyviz/graphable/transitions.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Journeyviz
+  module Graphable
+    module Transitions
+      private
+
+      def graph_transitions
+        [
+          *graph_screen_transitions,
+          *graph_block_transitions,
+          *graph_external_inputs
+        ]
+      end
+
+      def graph_transition_node(action)
+        from_id = graph_id(action.screen)
+        to_id = graph_target(action)
+        "transition_#{from_id}_#{action.name}_#{to_id}(#{action.name}):::transition"
+      end
+
+      def graph_screen_transitions
+        @screens
+          .flat_map(&:actions)
+          .select(&:transition)
+          .flat_map do |action|
+            [graph_transition_node(action), graph_screen_transition(action)]
+          end
+      end
+
+      def graph_screen_transition(action)
+        "#{graph_id(action.screen)} --- #{graph_id(action)} --> #{graph_target(action)}"
+      end
+
+      def graph_target(action)
+        target = action.transition
+
+        return "output_#{graph_id(target)}" if outputs.include?(target)
+
+        direct_children = (@blocks || []) + (@screens || [])
+        target = target.scope until direct_children.include?(target)
+        graph_id(target)
+      end
+
+      def graph_external_inputs
+        inputs
+          .flat_map(&:actions)
+          .select { |action| screens.include?(action.transition) }
+          .map { |action| "input_#{graph_screen_transition(action)}" }
+      end
+
+      def graph_block_transitions
+        @blocks.flat_map do |block|
+          targets = block.outputs
+          screen_targets = @screens & targets
+          block_targets = @blocks.select do |target_block|
+            targets.any? { |target| target_block.screens.include?(target) }
+          end
+
+          (screen_targets + block_targets).map do |target|
+            "#{graph_id(block)} --> #{graph_id(target)}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/journeyviz/journey.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'journeyviz/node_group'
+require 'journeyviz/graphable'
+require 'journeyviz/block'
+
+module Journeyviz
+  class Journey
+    include NodeGroup
+    include Graphable
+
+    def initialize
+      @blocks = []
+    end
+
+    def validate!
+      screens.each do |screen|
+        screen.actions.each { |action| validate_action(action) }
+      end
+    end
+
+    private
+
+    def validate_action(action)
+      return if action.transition || !action.raw_transition
+
+      message = "Action #{action.name.inspect} "
+      message += "on screen #{action.screen.full_qualifier.inspect} "
+      message += "has invalid transition: #{action.raw_transition.inspect}"
+      raise(Journeyviz::InvalidTransition, message)
+    end
+  end
+end

data/lib/journeyviz/node_group.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'journeyviz/screen'
+
+module Journeyviz
+  autoload :Block, 'journeyviz/block'
+
+  module NodeGroup
+    def block(name, &definition)
+      block = Block.new(name, self)
+
+      @blocks ||= []
+      if @blocks.any? { |defined_block| block.name == defined_block.name }
+        raise DuplicatedDefinition, "Duplicated block name: #{name}"
+      end
+
+      @blocks.push(block)
+      definition.call(block)
+      block
+    end
+
+    def blocks(include_children: false)
+      @blocks ||= []
+
+      if include_children
+        @blocks.flat_map { |block| [block] + block.blocks(include_children: true) }
+      else
+        @blocks
+      end
+    end
+
+    def screen(name)
+      @screens ||= []
+      screen = Screen.new(name, self)
+
+      if @screens.any? { |defined_screen| screen.name == defined_screen.name }
+        raise DuplicatedDefinition, "Duplicated screen name: #{name}"
+      end
+
+      @screens.push(screen)
+      yield screen if block_given?
+      screen
+    end
+
+    def screens
+      @screens ||= []
+      @screens + blocks.flat_map(&:screens)
+    end
+
+    def find_screen(qualifier)
+      screens.find { |screen| screen.full_qualifier == qualifier }
+    end
+
+    def inputs
+      options = defined?(root_scope) && root_scope ? root_scope.screens : []
+      external_screens = options - screens
+      self_screens = screens
+      external_screens.select do |screen|
+        screen.actions.any? do |action|
+          self_screens.include?(action.transition)
+        end
+      end
+    end
+
+    def outputs
+      screens
+        .flat_map(&:actions)
+        .map(&:transition)
+        .compact
+        .reject { |screen| screens.include?(screen) }
+    end
+  end
+end

data/lib/journeyviz/normalized_name.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Journeyviz
+  module NormalizedName
+    attr_reader :name
+
+    private
+
+    def assign_normalize_name(name)
+      if !name.is_a?(String) && !name.is_a?(Symbol) || name.size <= 0
+        raise InvalidNameError, "Invalid name given: #{name.inspect}"
+      end
+
+      @name = name.to_sym
+    end
+  end
+end

data/lib/journeyviz/scopable.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Journeyviz
+  Scopable = proc do |qualified_by|
+    Module.new do
+      attr_reader :scope
+
+      def assign_scope(scope)
+        @scope = scope
+      end
+
+      def root_scope
+        current_scope = self
+        current_scope = current_scope.scope until !current_scope.respond_to?(:scope) || current_scope.scope.nil?
+        current_scope
+      end
+
+      def full_scope
+        current_scope = scope
+        chain = [current_scope]
+
+        until current_scope.nil? || !current_scope.respond_to?(:scope)
+          current_scope = current_scope.scope
+          chain.unshift(current_scope)
+        end
+
+        chain
+      end
+
+      define_method(:full_qualifier) do
+        base_qualifier = scope&.respond_to?(:full_qualifier) ? scope.full_qualifier : []
+        [*base_qualifier, send(qualified_by)].compact
+      end
+    end
+  end
+end

data/lib/journeyviz/screen.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'journeyviz/action'
+require 'journeyviz/normalized_name'
+require 'journeyviz/scopable'
+
+module Journeyviz
+  class Screen
+    include NormalizedName
+    include Scopable[:name]
+    attr_reader :actions, :scope
+
+    def initialize(name, scope = nil)
+      assign_normalize_name(name)
+      @actions = []
+      assign_scope(scope)
+    end
+
+    def action(name, **params)
+      action = Action.new(name, self, **params)
+
+      if actions.any? { |defined_action| action.name == defined_action.name }
+        raise DuplicatedDefinition, "Duplicated action name: #{name}"
+      end
+
+      @actions << action
+    end
+  end
+end

data/lib/journeyviz/server.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rack/app'
+
+module Journeyviz
+  class Server < Rack::App
+    get '/' do
+      block_path = params['block'] || ''
+      @block = block_path.split('_').reduce(Journeyviz.journey) do |current, step|
+        current.blocks.find { |block| block.name == step.to_sym }
+      end
+
+      path = File.expand_path('server/index.html.erb', __dir__)
+      ERB.new(File.read(path)).result(binding)
+    end
+  end
+end

data/lib/journeyviz/server/index.html.erb

@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+    <title>Journeyviz</title>
+    <link rel="icon" type="image/png" href="data:image/png;base64,iVBORw0KGgo=">
+    <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
+    <link rel="stylesheet" href="https://code.getmdl.io/1.3.0/material.indigo-pink.min.css">
+    <style>
+.mermaid {
+  margin: 2em auto;
+  display: none;
+  max-width: 100%;
+  overflow: auto;
+  border-radius: 5px;
+  background: #ddd;
+}
+
+.mermaid[data-processed] {
+  display: block;
+}
+
+.demo-drawer {
+  border: none;
+}
+/* iOS Safari specific workaround */
+.demo-drawer .mdl-menu__container {
+  z-index: -1;
+}
+.demo-drawer .demo-navigation {
+  z-index: -2;
+}
+.demo-navigation {
+  flex-grow: 1;
+}
+.demo-layout .mdl-layout__header .mdl-layout__drawer-button {
+  color: rgba(0, 0, 0, 0.54);
+}
+.demo-layout .demo-navigation .mdl-navigation__link {
+  display: flex !important;
+  flex-direction: row;
+  align-items: center;
+  color: rgba(255, 255, 255, 0.56);
+  font-weight: 500;
+}
+.demo-layout .demo-navigation .mdl-navigation__link:hover {
+  background-color: #00BCD4;
+  color: #37474F;
+}
+.demo-navigation hr {
+  border-color: rgba(0,0,0,0.34);
+}
+.demo-navigation .mdl-navigation__link .material-icons {
+  font-size: 24px;
+  color: rgba(255, 255, 255, 0.56);
+  margin-right: 32px;
+}
+    </style>
+  </head>
+
+  <body>
+    <div class="demo-layout mdl-layout mdl-js-layout mdl-layout--fixed-drawer mdl-layout--fixed-header">
+      <header class="demo-header mdl-layout__header mdl-color--grey-100 mdl-color-text--grey-600">
+        <div class="mdl-layout__header-row">
+          <span class="mdl-layout-title">
+            <%= @block.respond_to?(:name) ? "#{@block.name.to_s.split('_').collect(&:capitalize).join(' ')} / Journeyviz" : 'Journeyviz' %>
+          </span>
+        </div>
+      </header>
+
+      <div class="demo-drawer mdl-layout__drawer mdl-color--blue-grey-900 mdl-color-text--blue-grey-50">
+        <nav class="demo-navigation mdl-navigation mdl-color--blue-grey-800">
+          <a class="mdl-navigation__link" href="?">
+            <i class="mdl-color-text--blue-grey-400 material-icons" role="presentation">home</i>
+            <span>Journey</span>
+          </a>
+          <hr/>
+          <% @block.blocks.each do |block| %>
+            <a class="mdl-navigation__link" href="?block=<%= block.full_qualifier.join('_') %>">
+              <i class="mdl-color-text--blue-grey-400 material-icons" role="presentation">layers</i>
+              <span><%= block.name.to_s.split('_').collect(&:capitalize).join(' ') %></span>
+            </a>
+          <% end %>
+        </nav>
+      </div>
+
+      <main class="mdl-layout__content mdl-color--grey-100">
+        <div class="mdl-grid demo-content">
+          <div class="mermaid"><%= @block.graph %></div>
+        </div>
+      </main>
+    </div>
+
+    <script defer src="https://code.getmdl.io/1.3.0/material.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/mermaid/8.4.8/mermaid.min.js"></script>
+    <script>mermaid.initialize({ startOnLoad: true });</script>
+  </body>
+</html>

data/lib/journeyviz/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Journeyviz
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: journeyviz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabriel Teles
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.81.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.81.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-app
+  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: Define your user journey as code and track it historically and in realtime
+email:
+- gabz.teles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- journeyviz.gemspec
+- lib/journeyviz.rb
+- lib/journeyviz/action.rb
+- lib/journeyviz/block.rb
+- lib/journeyviz/graphable.rb
+- lib/journeyviz/graphable/externals.rb
+- lib/journeyviz/graphable/transitions.rb
+- lib/journeyviz/journey.rb
+- lib/journeyviz/node_group.rb
+- lib/journeyviz/normalized_name.rb
+- lib/journeyviz/scopable.rb
+- lib/journeyviz/screen.rb
+- lib/journeyviz/server.rb
+- lib/journeyviz/server/index.html.erb
+- lib/journeyviz/version.rb
+homepage: https://github.com/gabteles/journeyviz
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gabteles/journeyviz
+  source_code_uri: https://github.com/gabteles/journeyviz
+  changelog_uri: https://github.com/gabteles/journeyviz/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Journey visualization made easy
+test_files: []