jw-rails-erd 1.4.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 479e99642119a6eb335c9b9c97eed2e0e59ebf86
+  data.tar.gz: a3593fb95a3f2d816660964734e20356921917c1
+SHA512:
+  metadata.gz: 2460431f9ec8fc7daa093b4ecb86e12bea5a7ab471e6db8e309b2c3ecf37f1f9c9acfe87ec2c66e88b7780c0d5701cfeaddaf10e1b54a3221d80d3025ada50ef
+  data.tar.gz: ef125a202ce97ba684ddea1b4344656d54f025a45e857d24e97c35ba42373b4d810bbb4327b58805ffbd04a19b7a0d7780f51b340be9f1847fbaf5754fd5c8bc

data/README.md

@@ -0,0 +1,86 @@
+Rails ERD - Generate Entity-Relationship Diagrams for Rails applications
+========================================================================
+[![Build Status](https://travis-ci.org/voormedia/rails-erd.svg?branch=master)](https://travis-ci.org/voormedia/rails-erd) [![Code Climate](https://codeclimate.com/github/voormedia/rails-erd/badges/gpa.svg)](https://codeclimate.com/github/voormedia/rails-erd)
+
+[Rails ERD](http://voormedia.github.io/rails-erd/) is a gem that allows you to easily generate a diagram based on your application's Active Record models. The diagram gives an overview of how your models are related. Having a diagram that describes your models is perfect documentation for your application.
+
+The second goal of Rails ERD is to provide you with a tool to inspect your application's domain model. If you don't like the default output, it is very easy to use the API to build your own diagrams.
+
+Rails ERD was created specifically for Rails and works on versions 3.0-4.2. It uses Active Record's built-in reflection capabilities to figure out how your models are associated.
+
+
+Preview
+-------
+
+Here's an example entity-relationship diagram that was generated by Rails ERD:
+
+![Entity-Relationship Diagram](http://voormedia.github.io/rails-erd/images/entity-relationship-diagram.png)
+
+Browse the [gallery](http://voormedia.github.io/rails-erd/gallery.html) for more example diagrams.
+
+
+Requirements
+---------------
+
+* Ruby 1.9.3+
+* ActiveRecord 3.x
+
+Getting started
+---------------
+
+See the [installation instructions](http://voormedia.github.io/rails-erd/install.html) for a complete description of how to install Rails ERD. Here's a summary:
+
+* Install Graphviz 2.22+ ([how?](http://voormedia.github.io/rails-erd/install.html))
+
+* Add <tt>gem "rails-erd"</tt> to your application's Gemfile
+
+* Run <tt>bundle exec erd</tt>
+
+### Configuration
+
+
+Rails ERD has the ability to be configured via the command line or through the use of a YAML file with configuration options set. It will look for this file first at `~/.erdconfig` and then `./.erdconfig` (which will override any settings in `~/.erdconfig`). The format of the file is as follows (shown here with the default settings used if no `.erdconfig` is found). More information on [customization options](http://voormedia.github.io/rails-erd/customise.html) can be found in Rails ERD's project documentation.
+
+```
+attributes:
+  - content
+  - foreign_key
+  - inheritance
+disconnected: true
+filename: erd
+filetype: pdf
+indirect: true
+inheritance: false
+markup: true
+notation: simple
+orientation: horizontal
+polymorphism: false
+sort: true
+warn: true
+title: sample title
+exclude: null
+only: null
+prepend_primary: false
+```
+
+
+Learn more
+----------
+
+More information can be found on [Rails ERD's project homepage](http://voormedia.github.io/rails-erd/).
+
+If you wish to extend or customise Rails ERD, take a look at the [API documentation](http://rubydoc.info/github/voormedia/rails-erd/frames).
+
+
+About Rails ERD
+---------------
+
+Rails ERD was created by Rolf Timmermans (r.timmermans *at* voormedia.com)
+
+Copyright 2010-2015 Voormedia - [www.voormedia.com](http://www.voormedia.com/)
+
+
+License
+-------
+
+Rails ERD is released under the MIT license.

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler"
+require "rake/testtask"
+require "yard"
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |test|
+  test.test_files = FileList["test/**/*_test.rb"]
+end
+
+YARD::Rake::YardocTask.new do |yard|
+  yard.files = ["lib/**/*.rb", "-", "LICENSE", "CHANGES.md"]
+end
+
+desc "Generate diagrams for bundled examples"
+task :examples do
+  require File.expand_path("examples/generate", File.dirname(__FILE__))
+end
+
+task :default => :test

data/bin/erd

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "rails_erd/cli"
+
+RailsERD::CLI.start

data/lib/generators/erd/USAGE

@@ -0,0 +1,4 @@
+Add a .rake file that automatically generate the graphical models when you do 
+a db:migrate in development mode:
+
+    rails generate erd:install

data/lib/generators/erd/install_generator.rb

@@ -0,0 +1,14 @@
+module Erd
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy rails-erd rakefiles for automatic graphic generation"
+      source_root File.expand_path('../templates', __FILE__)
+
+      # copy rake tasks
+      def copy_tasks
+        template "auto_generate_diagram.rake", "lib/tasks/auto_generate_diagram.rake"
+      end
+
+    end
+  end
+end

data/lib/generators/erd/templates/auto_generate_diagram.rake

@@ -0,0 +1,6 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if Rails.env.development?
+  Erd.load_tasks
+end

data/lib/rails-erd.rb

@@ -0,0 +1 @@
+require "rails_erd"

data/lib/rails_erd/cli.rb

@@ -0,0 +1,164 @@
+require "choice"
+
+Choice.options do
+  separator ""
+  separator "Diagram options:"
+
+  option :title do
+    long "--title=TITLE"
+    desc "Replace default diagram title with a custom one."
+  end
+
+  option :notation do
+    long "--notation=STYLE"
+    desc "Diagram notation style, one of simple, bachman, uml or crowsfoot."
+  end
+
+  option :attributes do
+    long "--attributes=TYPE,..."
+    desc "Attribute groups to display: false, content, primary_keys, foreign_keys, timestamps and/or inheritance."
+  end
+
+  option :orientation do
+    long "--orientation=ORIENTATION"
+    desc "Orientation of diagram, either horizontal (default) or vertical."
+  end
+
+  option :inheritance do
+    long "--inheritance"
+    desc "Display (single table) inheritance relationships."
+  end
+
+  option :polymorphism do
+    long "--polymorphism"
+    desc "Display polymorphic and abstract entities."
+  end
+
+  option :no_indirect do
+    long "--direct"
+    desc "Omit indirect relationships (through other entities)."
+  end
+
+  option :no_disconnected do
+    long "--connected"
+    desc "Omit entities without relationships."
+  end
+
+  option :only do
+    long "--only"
+    desc "Filter to only include listed models in diagram."
+  end
+
+  option :exclude do
+    long "--exclude"
+    desc "Filter to exclude listed models in diagram."
+  end
+
+  option :sort do
+    long "--sort=BOOLEAN"
+    desc "Sort attribute list alphabetically"
+  end
+
+  option :prepend_primary do
+    long "--prepend_primary=BOOLEAN"
+    desc "Ensure primary key is at start of attribute list"
+  end
+
+  separator ""
+  separator "Output options:"
+
+  option :filename do
+    long "--filename=FILENAME"
+    desc "Basename of the output diagram."
+  end
+
+  option :filetype do
+    long "--filetype=TYPE"
+    desc "Output file type. Available types depend on the diagram renderer."
+  end
+
+  option :no_markup do
+    long "--no-markup"
+    desc "Disable markup for enhanced compatibility of .dot output with other applications."
+  end
+
+  option :open do
+    long "--open"
+    desc "Open the output file after it has been saved."
+  end
+
+  separator ""
+  separator "Common options:"
+
+  option :help do
+    long "--help"
+    desc "Display this help message."
+  end
+
+  option :debug do
+    long "--debug"
+    desc "Show stack traces when an error occurs."
+  end
+
+  option :version do
+    short "-v"
+    long "--version"
+    desc "Show version and quit."
+    action do
+      require "rails_erd/version"
+      $stderr.puts RailsERD::BANNER
+      exit
+    end
+  end
+end
+
+module RailsERD
+  class CLI
+    attr_reader :path, :options
+
+    class << self
+      def start
+        path = Choice.rest.first || Dir.pwd
+        options = Choice.choices.each_with_object({}) do |(key, value), opts|
+          if key.start_with? "no_"
+            opts[key.gsub("no_", "").to_sym] = !value
+          elsif value.to_s.include? ","
+            opts[key.to_sym] = value.split(",").map(&:to_s)
+          else
+            opts[key.to_sym] = value
+          end
+        end
+        new(path, options).start
+      end
+    end
+
+    def initialize(path, options)
+      @path, @options = path, options
+      require "rails_erd/diagram/graphviz"
+    end
+
+    def start
+      load_application
+      create_diagram
+    rescue Exception => e
+      $stderr.puts "Failed: #{e.class}: #{e.message}"
+      $stderr.puts e.backtrace.map { |t| "    from #{t}" } if options[:debug]
+    end
+
+    private
+
+    def load_application
+      $stderr.puts "Loading application in '#{File.basename(path)}'..."
+      # TODO: Add support for different kinds of environment.
+      require "#{path}/config/environment"
+      Rails.application.eager_load!
+    end
+
+    def create_diagram
+      $stderr.puts "Generating entity-relationship diagram for #{ActiveRecord::Base.descendants.length} models..."
+      file = RailsERD::Diagram::Graphviz.create(options)
+      $stderr.puts "Diagram saved to '#{file}'."
+      `open #{file}` if options[:open]
+    end
+  end
+end

data/lib/rails_erd/config.rb

@@ -0,0 +1,97 @@
+require "yaml"
+
+module RailsERD
+  class Config
+    USER_WIDE_CONFIG_FILE = File.expand_path(".erdconfig", ENV["HOME"])
+    CURRENT_CONFIG_FILE   = File.expand_path(".erdconfig", Dir.pwd)
+
+    attr_reader :options
+
+    def self.load
+      new.load
+    end
+
+    def initialize
+      @options = {}
+    end
+
+    def load
+      load_file(USER_WIDE_CONFIG_FILE)
+      load_file(CURRENT_CONFIG_FILE)
+
+      @options
+    end
+
+    def self.font_names_based_on_os
+      if use_os_x_fonts?
+        { normal: "ArialMT",
+          bold:   "Arial BoldMT",
+          italic: "Arial ItalicMT" }
+      else
+        { normal: "Arial",
+          bold:   "Arial Bold",
+          italic: "Arial Italic" }
+      end
+    end
+
+    private
+
+    def load_file(path)
+      if File.exists?(path)
+        YAML.load_file(path).each do |key, value|
+          key = key.to_sym
+          @options[key] = normalize_value(key, value)
+        end
+      end
+    end
+
+    def normalize_value(key, value)
+      case key
+      # <symbol>[,<symbol>,...] | false
+      when :attributes
+        if value == false
+          return value
+        else
+          # Comma separated string and strings in array are OK.
+          Array(value).join(",").split(",").map { |v| v.strip.to_sym }
+        end
+
+      # <symbol>
+      when :filetype, :notation, :orientation
+        value.to_sym
+
+      # [<string>]
+      when :only, :exclude
+        Array(value).join(",").split(",").map { |v| v.strip }
+      # true | false
+      when :disconnected, :indirect, :inheritance, :markup, :polymorphism, :warn
+        !!value
+
+      # nil | <string>
+      when :filename
+        value.nil? ? nil : value.to_s
+
+      # true | false | <string>
+      when :title
+        value.is_a?(String) ? value : !!value
+
+      else
+        value
+      end
+    end
+
+    def self.use_os_x_fonts?
+      host = RbConfig::CONFIG['host_os']
+      return true if host == "darwin"
+
+      if host.include? "darwin"
+        darwin_version_array = host.split("darwin").last.split(".").map(&:to_i)
+
+        return true if darwin_version_array[0] >= 13
+        return true if darwin_version_array[0] == 12 && darwin_version_array[1] >= 5
+      end
+
+      false
+    end
+  end
+end

data/lib/rails_erd/custom.rb

@@ -0,0 +1,99 @@
+require "rails_erd/domain"
+require "rails_erd/domain"
+require "rails_erd"
+require "rails_erd/domain/attribute"
+require "rails_erd/domain/entity"
+require "rails_erd/domain/relationship"
+require "rails_erd/domain/specialization"
+
+
+
+# monkeypatch to fix strange people with edges which causes segfault in graphviz
+# https://github.com/voormedia/rails-erd/issues/70
+module RailsERD
+  class Domain
+    class Relationship
+      class << self
+        private
+
+        def association_identity(association)
+          Set[association_owner(association), association_target(association)]
+        end
+      end
+    end
+  end
+end
+
+
+module RailsERD
+class Custom
+  attr_accessor :classes, :reflection_keys
+  
+  #@class_name - Pass in the class name
+  #@name of the file
+  #@level - the depth you want to browse
+  def initialize( class_name, file_name, level=nil )
+    
+    @file_name = file_name
+    @class_name = class_name
+    @classes = []
+    @classes << class_name
+    @level = level
+    process
+    generate
+      
+  end
+  
+  def generate
+    puts "************************ classes length: #{@classes.length}"
+    options = {
+      :filename=>@file_name,
+      :filetype=>"pdf",
+      :attributes=>["foreign_keys", "primary_keys", "content"],
+      :only=>@classes
+    }
+    begin
+      byebug
+      file = RailsERD::Diagram::Graphviz.create(options)
+    rescue
+      puts "---------------------------------Graph viz creation error"
+    end
+  end
+  def process
+    children_walk(  @class_name.constantize.reflections, 0 )
+  end
+  
+  
+  def children_walk( reflections, cur_level )
+    if @level == cur_level
+      return
+    end
+    keys = reflections.keys
+    for k in keys
+      p "***processing: #{k}"
+      ref = reflections[ k ]
+      class_name = ref.klass.name.to_s
+      p class_name
+      if !@classes.include? class_name
+        
+        p "Adding #{class_name}"
+        @classes << class_name     
+        
+        begin
+          model = class_name.constantize
+          children_walk( model.reflections, cur_level + 1 )    
+        rescue => e
+          warn "Cannot retrieve model: #{class_name}"
+        end
+      end  
+    end
+  end
+  
+  def check_model_validity(model)
+      model.abstract_class? or model.table_exists? or raise "table #{model.table_name} does not exist"
+    rescue => e
+      warn "Ignoring invalid model #{model.name} (#{e.message})"
+  end
+  
+  end
+end