caravaggio 0.0.12

data/app/controllers/caravaggio/application_controller.rb

@@ -0,0 +1,5 @@
+module Caravaggio
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/caravaggio/c.txt

@@ -0,0 +1,2 @@
+class CanvasController < Caravaggio::ApplicationController
+end

data/app/controllers/caravaggio/canvas_controller.rb

@@ -0,0 +1,14 @@
+require 'caravaggio/canvas'
+
+module Caravaggio
+  class CanvasController < Caravaggio::ApplicationController
+    protect_from_forgery with: :exception
+    
+    def index
+      @canvas = Canvas.new
+      @models = @canvas.models
+      @figures = @canvas.figures
+      @associations = @canvas.associations
+    end
+  end
+end

data/app/helpers/caravaggio/application_helper.rb

@@ -0,0 +1,4 @@
+module Caravaggio
+  module ApplicationHelper
+  end
+end

data/app/views/caravaggio/canvas/_association.html.erb

@@ -0,0 +1,13 @@
+<div class="association hidden detailed-content" id="association-<%= association[:index] %>" >
+  <h2><%= association[:source] %>#<%= association[:name] %></h2>
+  
+  <ul>
+    <li><%= association[:name] %></li>
+    <li><%= association[:association_type] %></li>
+    <li>From: <%= association[:source] %></li>
+    <li>To: <%= association[:target] %></li>
+    <% association[:options].each do |option, value| %>
+      <li><%= option %> : <%= value %></li>
+    <% end %>
+  </ul>
+</div>

data/app/views/caravaggio/canvas/_figure.html.erb

@@ -0,0 +1,24 @@
+<div class="figure hidden detailed-content" id="figure-<%= figure.friendly_name %>" >
+  <h2><%= figure.name %></h2>
+  <h3>Columns</h3>
+  <ul>
+    <% figure.columns.each do |column| %>
+      <li><%= column.name %> : <%= column.sql_type %></li>
+    <% end %>
+  </ul>
+  <h3>Associations</h3>
+  <ul>
+    <% figure.associations.each do |association| %>
+      <li>
+        <%= association[:association_type] %> <%= association[:name] %>
+        <% if association[:options].present? %>
+          <ul>
+            <% association[:options].each do |option, value| %>
+              <li><%= option %> : <%= value %></li>
+            <% end %>
+          </ul>
+        <% end %>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/app/views/caravaggio/canvas/index.html.erb

@@ -0,0 +1,54 @@
+<script>
+  var models = <%= @models.to_json.html_safe %>;
+  var associations = <%= @associations.to_json.html_safe %>;
+</script>
+
+<div id="header">
+  <h1>Welcome to Caravaggio!</h1>
+</div>
+      
+<div id="container">
+  <div class="sidebar left-sidebar">
+    <div class="color-key">
+      <h3>Key</h3>
+      <ul>
+        <li><span class="belongs_to">Belongs To</span></li>
+        <li><span class="has_many">Has Many</span></li>
+        <li><span class="has_one">Has One</span></li>
+        <li><span class="has_and_belongs_to_many">HABTM</span></li>
+        <li><input type="checkbox" name="links_from" id="links_from" onclick="displayModels()" checked/>Links from</li>
+        <li><input type="checkbox" name="links_to" id="links_to" onclick="displayModels()" />Links to</li>
+        <li><input type="checkbox" name="only_checked" id="only_checked" onclick="displayModels()" />Checked only</li>
+      </ul>
+    </div>
+    <div>
+      <h3>Classes</h3>
+      <ul>
+        <li><%= check_box_tag "ALL", "ALL", false, class: "all-model-checkbox", onclick: "setAllModels(this)" %>ALL</li>
+        <% @models.each do |model| %>
+          <li><%= check_box_tag model[:friendly_name], model[:friendly_name], false, data: {class_name: model[:id]}, class: "model-checkbox", onclick: "setModel(this)" %> <%= model[:short_name] %></li>
+        <% end %>
+      </ul>
+    </div>
+  </div>
+  <div id="canvas">
+    <svg id="model-diagram" width="1000" height="1000" />
+  </div>
+  <div id="exhibit" class="sidebar right-sidebar">
+    <div class="detailed-content">
+      <h2>Instructions</h2>
+      <p>
+        Select a class from the left sidebar.
+      </p>
+      <p>
+        Click on a link or a dot to get more detail.
+      </p>
+    </div>
+    <% @figures.each do |figure| %>
+      <%= render "figure", figure: figure %>
+    <% end %>
+    <% @associations.each do |association| %>
+      <%= render "association", association: association %>
+    <% end %>
+  </div>
+</div>

data/app/views/layouts/caravaggio/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Caravaggio</title>
+  <%= stylesheet_link_tag    "caravaggio/application", media: "all" %>
+  <%= javascript_include_tag "caravaggio/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body onload="initializeCaravaggio()">
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/assets.rb

@@ -0,0 +1,4 @@
+Rails.application.config.assets.precompile += %w[ 
+  caravaggio/application.css
+  caravaggio/application.js
+]

data/config/routes.rb

@@ -0,0 +1,3 @@
+Caravaggio::Engine.routes.draw do
+  root to: "canvas#index"
+end

data/lib/caravaggio/canvas.rb

@@ -0,0 +1,35 @@
+require "caravaggio/figure"
+
+# A Canvas is an entire picture of a system.  It contains many figures.  (Get it?)
+module Caravaggio
+  class Canvas
+    attr_reader :figures
+    
+    def initialize
+      Rails.application.eager_load!
+      @figures = []
+      ActiveRecord::Base.descendants.reject{|c| c.abstract_class}.sort{|s1, s2| s1.name <=> s2.name}.each do |model|
+        begin
+          figure = Figure.new(model)
+          @figures << figure
+        rescue => e
+          Rails.logger.error "Failed to load #{model.name} with error #{e}"
+        end
+      end
+    end
+    
+    def models
+      @figures.map{|figure| figure.model}
+    end
+    
+    def associations
+      if @associations.nil?
+        @associations = @figures.map{|figure| figure.associations}.flatten
+        @associations.each_with_index do |association, index|
+          association[:index] = index
+        end
+      end
+      @associations
+    end
+  end
+end

data/lib/caravaggio/engine.rb

@@ -0,0 +1,5 @@
+module Caravaggio
+  class Engine < ::Rails::Engine
+    isolate_namespace Caravaggio
+  end
+end

data/lib/caravaggio/figure.rb

@@ -0,0 +1,104 @@
+# a Figure is a representation of a model.  (Get it?)
+module Caravaggio
+  class Figure
+    def initialize(source_model)
+      @source_model = source_model
+      
+      # make sure the model works - it won/t for some weird situations involving not loading all gems as expected.
+      model
+    end
+    
+    def name
+      @name ||= clean_name(@source_model.name)
+    end
+    
+    def columns
+      @columns ||= @source_model.columns.sort{|c1, c2| c1.name <=> c2.name}
+    end
+    
+    def friendly_name
+      @friendly_name ||= name.gsub(/::/, '_')
+    end
+    
+    def short_name
+      @short_name ||= (name.length > 20 ? "..." : "") + name.chars.last(20).join
+    end
+    
+    def to_s
+      "Figure for #{@source_model.name}"
+    end
+    
+    def to_json
+      @to_json ||= to_h.to_json
+    end
+    
+    def model
+      @source_model_hash ||= {
+        id: name,
+        friendly_name: friendly_name,
+        short_name: short_name,
+        columns: @source_model.column_names.sort,
+        to_associated_classes: associations.map{|association| association[:target]}
+      }
+    end
+    
+    def associations(association_type = nil)
+      if association_type
+        associations.select{ |association| association[:association_type] == association_type }
+      else
+        @associations ||= (associations_to_h(:belongs_to, @source_model.reflect_on_all_associations(:belongs_to)) + 
+          associations_to_h(:has_one, @source_model.reflect_on_all_associations(:has_one)) +
+          associations_to_h(:has_many, @source_model.reflect_on_all_associations(:has_many)) +
+          associations_to_h(:has_and_belongs_to_many, @source_model.reflect_on_all_associations(:has_and_belongs_to_many))).flatten
+      end
+    end
+    
+    def associations_to_h(association_type, associations)
+      associations.map{|association| association_to_h(association_type, association)}
+    end
+    
+    def to_models
+      @to_models ||= associations.map{|association| association[:to]}.sort.uniq
+    end
+    
+    def association_to_h(association_type, association)
+      options = {}
+      association.options.each do |k, v|
+        options[k.to_s] = v.to_s
+      end
+      
+      {
+        source: name,
+        target: to_class_name(association),
+        name: association.macro == :belongs_to || association.macro == :has_one ? association.name : association.plural_name,
+        options: options,
+        association_type: association_type
+      }
+    end
+    
+    def clean_name(_name)
+      _name.gsub(/^::/, "")
+    end
+    
+    def self.add_backlinks(figures)
+      figures.each do |from_figure|
+        from_figures[:from] = []
+        figures.each do |to_figure|
+          if to_figure.name != from_figure.name && to_figure.to_models.include?(from_figure.name)
+            from_figures[:from] << to_figure.name
+          end
+          from_figures[:from].sort!
+        end
+      end
+    end
+    
+    def to_class_name(association)
+      class_name = association.options[:class_name] || association.name.to_s.singularize.camelize
+      begin
+        class_name = association.klass.name
+      rescue => e
+      end
+      clean_name(class_name)
+    end
+  end
+end

data/lib/caravaggio/version.rb

@@ -0,0 +1,3 @@
+module Caravaggio
+  VERSION = "0.0.12"
+end

data/lib/caravaggio.rb

@@ -0,0 +1,38 @@
+require "caravaggio/engine"
+
+module Caravaggio
+  def self.gem_path
+    Pathname(File.realpath(__FILE__)).join('../..')
+  end
+
+  def self.load_paths
+    gem_path.join('app/assets').each_child.to_a
+  end
+
+  def self.dependencies
+    [
+      
+    ]
+  end
+
+  if defined?(Rails)
+    class Engine < ::Rails::Engine
+      # Rails -> use app/assets directory.
+    end
+  end
+
+end
+
+class RailsAssets
+  @components ||= []
+
+  class << self
+    attr_accessor :components
+
+    def load_paths
+      components.flat_map(&:load_paths)
+    end
+  end
+end
+
+RailsAssets.components << Caravaggio

data/lib/tasks/caravaggio_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :caravaggio do
+#   # Task goes here
+# end

data/test/caravaggio_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CaravaggioTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Caravaggio
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end