activerecord_uml 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75bc29669bc6893589083ea59d6dcb6699a53165b3258a008ed69fce1f907c7d
+  data.tar.gz: 8fa743ad797eef029abd1d347654f51589c9b575bced44735ea62752e7b906cc
+SHA512:
+  metadata.gz: c026ab1b8b5de2630e49ec544c73693d157cee869c0b8995109e877611a6522d5f48f703dd5d0eb08fb74cf094454a887ba2511353d67837894fa3edf8bed62c
+  data.tar.gz: 6c08b058547c1f8010fefb5048653ff462d47618689b722b23db679e3b1cc375525a1323d77f0ee06936f84e214c55d8f887bae19d15a31a3bd4fd9c6823dfaf

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+/.idea

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activerecord_uml.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+

data/README.md

@@ -0,0 +1,63 @@
+# ActiverecordUml
+
+ActiverecordUml draws class diagrams of ActiveRecord models.
+
+We sometimes wander in the existing Ruby on Rails application.
+All models are too much to see.
+We want to select from three to seven models to see their attributes and relations.
+
+ActiverecordUml draws class diagrams of selected models to help to recognize their attributes and relations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord_uml'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install activerecord_uml
+
+## Usage
+
+In your Ruby on Rails directory:
+
+```
+activerecord_uml User
+```
+
+Execute the activerecord_uml command with name of model classes.
+Then the activerecord_uml outputs HTML text includes class diagrams of specified model classes. 
+
+For MacOs, I recommend to use the activerecord_uml with [browser](https://gist.github.com/defunkt/318247) command.
+For example:
+
+Install browser with Homebrew.
+
+```
+$ brew install browser
+```
+
+And then execute:
+
+```
+activerecord_uml User | browser
+```
+
+Open the class diagrams with the browser immediately.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake ` 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 the created tag, 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/ledsun/activerecord_uml.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/activerecord_uml.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/activerecord_uml/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord_uml"
+  spec.version       = ActiverecordUml::VERSION
+  spec.authors       = ["shigeru.nakajima"]
+  spec.email         = ["shigeru.nakajima@gmail.com"]
+
+  spec.summary       = "Generate UML class diagram from ActiveRecord instances."
+  spec.description   = "Generate UML class diagram for Mermaid.js from ActiveRecord instances by Rails runner."
+  spec.homepage      = "https://github.com/ledsun/activerecord_uml"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ledsun/activerecord_uml"
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "activerecord_uml"
+
+# 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/exe/activerecord_uml

@@ -0,0 +1,7 @@
+#! /usr/bin/env ruby
+require "activerecord_uml"
+
+require(File.join(Dir.pwd, "config/application"))
+Rails.application.require_environment!
+
+ActiverecordUml.draw

data/lib/activerecord_uml.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require_relative "activerecord_uml/version"
+require_relative "activerecord_uml/diagram_drawer"
+
+module ActiverecordUml
+  def self.draw
+    html = <<EOF
+<html>
+  <body>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+    <script>mermaid.initialize({startOnLoad:true});</script>
+
+    <div class="mermaid">
+
+classDiagram
+<% class_diagrams.each do |d| %>
+  <%= d %>
+<% end %>
+<% relations.each do |r| %>
+  <%= r %>
+<% end %>
+
+    </div>
+  </body>
+</html>
+EOF
+
+    html_template = ERB.new html, nil, "<>"
+    classes = ARGV.map { |model_name| DiagramDrawer.new(model_name) }
+    puts html_template.result_with_hash class_diagrams: classes.map { |c| c.class_diagram },
+                                        relations: classes.map { |c| c.relations }.flatten.uniq
+  end
+end

data/lib/activerecord_uml/diagram_drawer.rb

@@ -0,0 +1,55 @@
+require "erb"
+
+module ActiverecordUml
+  class DiagramDrawer
+    CLASS_TEMPLATE = <<EOF
+class <%= class_name %> {
+<% class_name.columns.each do |c| %>
+  <%= sprintf("%8s %s", c.type, c.name) %>
+<% end %>
+<% methods.each do |m, parameters| %>
+  <%= sprintf("%s(%s)", m, parameters) %>
+<% end %>
+}
+EOF
+
+    def initialize(model_name)
+      begin
+        @class_name = Object.const_get model_name
+      rescue NameError
+        STDERR.puts "#{model_name}というクラスがみつかりません"
+        raise
+      end
+    end
+
+    def class_diagram
+      class_template.result_with_hash class_name: @class_name, methods: methods
+    end
+
+    def relations
+      @class_name.reflect_on_all_associations(:belongs_to).map do |a|
+        "#{a.name.to_s.classify} --* #{@class_name}"
+      end.concat(@class_name.reflect_on_all_associations(:has_many).map do |a|
+        "#{@class_name} --* #{a.name.to_s.classify}"
+      end).concat(@class_name.reflect_on_all_associations(:has_one).map do |a|
+        "#{@class_name} --* #{a.name.to_s.classify}"
+      end)
+    end
+
+    private
+
+    def class_template
+      ERB.new CLASS_TEMPLATE, nil, "<>"
+    end
+
+    def methods
+      @class_name.public_instance_methods(false).sort.map do |m|
+        method_parameters = @class_name.new.method(m)
+                                       .parameters
+                                       .filter { |a| a[0] == :req }
+                                       .map { |a| a[1] }.join(", ")
+        [m.to_s, method_parameters]
+      end
+    end
+  end
+end

data/lib/activerecord_uml/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiverecordUml
+  VERSION = "0.5.0"
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_uml
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- shigeru.nakajima
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-15 00:00:00.000000000 Z
+dependencies: []
+description: Generate UML class diagram for Mermaid.js from ActiveRecord instances
+  by Rails runner.
+email:
+- shigeru.nakajima@gmail.com
+executables:
+- activerecord_uml
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- activerecord_uml.gemspec
+- bin/console
+- bin/setup
+- exe/activerecord_uml
+- lib/activerecord_uml.rb
+- lib/activerecord_uml/diagram_drawer.rb
+- lib/activerecord_uml/version.rb
+homepage: https://github.com/ledsun/activerecord_uml
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ledsun/activerecord_uml
+  source_code_uri: https://github.com/ledsun/activerecord_uml
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Generate UML class diagram from ActiveRecord instances.
+test_files: []