rails_model_visualizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74b719c6e52da8ef01549c4eeebffcaaa202924e
+  data.tar.gz: 3fe284d7fe93d667b3cb5d35a541a91c5047e638
+SHA512:
+  metadata.gz: 9a66c64b68359f34ec4a9d6aa854e41d6a6e38a4a804670b4c5bc5ef042268b65a95feddbfebf1b12db18ae54a0b09f541916eff156da0d0316846b59c5b23ee
+  data.tar.gz: d2888fd5740789e4022289509ebe768d1dabbbbcae8401a1b7b748083060ac53206cf41a41f0446b9bbf5500d1311911ec0e550a6f76a58857ca2f502a76735f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at halil.coban@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_model_visualizer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Halil Coban
+
+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,40 @@
+# RailsModelVisualizer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_model_visualizer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_model_visualizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_model_visualizer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/rails_model_visualizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_model_visualizer"
+
+# 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

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/docs/readme.md

@@ -0,0 +1,70 @@
+# RailsModelVisualizer
+
+[Ruby Gems Link][link]
+[link]: http://www.example.com
+
+## Minimum Viable Product
+
+RailsModelVisualizer is a ruby gem which will improve documentation of rails apps. Developers will be able to generate a diagram summarizing a rails app using RailsModelVisualizer. The diagram will show inheritance, AR associations, public and private methods, and instance variables of user-defined classes. By the end of week 11, this app will, at a minimum, satisfy the following criteria.
+
+- [ ] Installing through command line with `gem install rails_model_visualizer`
+- [ ] Extracting user-defined methods and instance variables
+- [ ] Determining associations and inheritance between classes
+- [ ] Generating an interactive html output
+- [ ] Production readme
+
+## Wireframes
+
+This gem will generate an html file consists of boxes styled with css.
+- Each box will correspond to a single ruby class.   
+- Boxes will consist of following sections
+  - Instance variables: will list instance variables
+  - Methods: will list user-defined public and private methods
+    - method's source code will be shown on mouseover
+  - Associations: will list AR associations
+    - associated class will be shown on click
+  - Inheritance: will list parent and child classes
+    - child/parent class source code will be shown on click
+
+![expected output](/docs/wireframes/wireframe.png)
+
+## Technologies
+
+The project will be implemented with the following technologies:
+
+- `Ruby` for the gem development.
+- `CSS` for styling.
+- Possible `JavaScript and JQuery` for an interactive UI.
+
+## Implementation Timeline
+
+### Day 1
+
+**Objective:** Developing a locally available version of the gem
+
+- [ ] Read RubyGems documentation
+- [ ] Organize project structure/folders
+- [ ] Test installing gem (locally)
+- [ ] Extract classes from rails apps
+
+### Day 2
+
+**Objective:** Extract information from ruby classes
+
+- [ ] Scan .rb files found in Day 1 and extract public and private methods
+- [ ] Extract AR associations from `has_many`, `has_one`, and `belongs_to` methods.
+- [ ] Extract inheritance information from class definitions
+
+### Day 3
+
+**Objective:** Generate html output
+
+- [ ] Generate an HTML file as a diagram
+- [ ] Publish previously extracted information into the html file
+- [ ] Style using CSS (and JavaScript, JQuery)
+
+### Day 4
+
+- [ ] Write tests
+- [ ] Write production readme
+- [ ] Push gem to RubyGems.org

data/lib/rails_model_visualizer.rb

@@ -0,0 +1,56 @@
+require "rails_model_visualizer/version"
+require "rails_model_visualizer/templates"
+require "rails_model_visualizer/model"
+require "launchy"
+
+
+class RMVisualizer
+
+  def self.import_models
+    if Rails.application
+      Rails.application.eager_load!
+      return ActiveRecord::Base.descendants.map do |rails_model|
+        Model.new(rails_model)
+      end
+    else
+      return []
+    end
+  end
+
+  def self.print_models
+    superclasses = {}
+    RMVisualizer.import_models.each do |m|
+      if superclasses[m.super_class]
+        superclasses[m.super_class] += m.to_div
+      else
+        superclasses[m.super_class] = m.to_div
+      end
+    end
+
+    body = ""
+    superclasses.each do |superclass, model_div|
+      body += "<div class=\"superclass\">#{superclass}
+        #{model_div}
+      </div>"
+    end
+
+    File.open("output.html", 'w+') do |file|
+      file.write(RMVisualizer.html(body))
+    end
+
+    File.open("application.css", "w+") do |file|
+      file.write(RMVisualizer.css)
+    end
+
+    puts "output.html created at root folder"
+    Launchy.open("./output.html")
+    return nil
+  end
+
+
+
+
+
+
+
+end

data/lib/rails_model_visualizer/model.rb

@@ -0,0 +1,139 @@
+class Model
+  attr_reader :name, :columns, :super_class
+
+  def initialize(rails_model)
+    @name = rails_model.name
+    @columns = rails_model.columns
+    @rails_model = rails_model
+    @super_class = @rails_model.superclass
+    @children = @rails_model.descendants
+  end
+
+  def to_div
+    columns = []
+    @columns.each do |c|
+      columns.push(
+      "<div class=\"list-name\">#{c.name}
+      <div class=\"list-source\">#{c.sql_type}</div>
+      </div>")
+    end
+
+    methods = []
+    public_methods.each do |name, source_code|
+      methods.push(
+      "<div class=\"list-name\">#{name}
+      <div class=\"list-source\">#{source_code}</div>
+      </div>")
+    end
+
+    private_methods.each do |name, source_code|
+      methods.push(
+      "<div class=\"list-name\">#{name}
+      <div class=\"list-source\">#{source_code}</div>
+      </div>")
+    end
+
+    assoc_list = []
+    associations.each do |assoc_name, value|
+      assoc_list.push(
+      "<div class=\"list-name\">#{value["type"]}: #{assoc_name}
+      <div class=\"list-source\">#{value["options"]}</div>
+      </div>")
+    end
+    return (
+      "<div class=\"model\">
+        <h1>#{@name}</h1>
+        <div class=\"model-details\">
+          <ul>SQL Columns
+          #{columns.join("")}
+          </ul>
+          <ul>Methods
+          #{methods.join("")}
+          </ul>
+          <ul>Associations
+          #{assoc_list.join("")}
+          </ul>
+        </div>
+      </div>"
+    )
+  end
+
+  def source(model, method)
+    m = method.to_sym
+    @rails_model.new.method(m).source_location
+  end
+
+  def indent(string)
+    indent = ">"
+    string.each_char do |char|
+      break unless char == " "
+      indent += ">"
+    end
+    indent = indent[2..-1] if indent.length > 1
+    indent + string
+  end
+
+  def source_code(source_file, method)
+    path, start_line = source_file
+    source_code = []
+    line_to_read = start_line - 1
+    file = File.readlines(path)
+
+    while true
+      source_code.push(indent(file[line_to_read]))
+      break if file[line_to_read] == "  end\n"
+
+      line_to_read += 1
+    end
+
+    source_code.join("<br>")
+  end
+
+  def get_methods(type)
+    filename = "#{@name.underscore}.rb"
+    result = {};
+
+    @rails_model.new.method(type).call(false).each do |pm|
+      source_file = source(@rails_model, pm)
+      if source_file[0].include?(filename)
+        result[pm] = source_code(source_file, pm)
+      end
+    end
+
+    result
+  end
+
+  def public_methods
+    get_methods(:public_methods)
+  end
+
+  def private_methods
+    get_methods(:private_methods)
+  end
+
+  def associations
+    assoc = {}
+    @rails_model.reflections.each do |name, association|
+      if association.class.name.include?("HasManyReflection")
+        type = "has_many"
+      elsif association.class.name.include?("HasOneReflection")
+        type = "has_one"
+      elsif association.class.name.include?("BelongsToReflection")
+        type = "belongs_to"
+      else
+        type = "other"
+      end
+      options = []
+      association.options.each do |key, value|
+        options.push("#{key}: #{value}")
+      end
+
+      assoc[association.name.to_s] = {"type" => type, "options" => options.join("\n") }
+
+    end
+    assoc
+  end
+
+
+
+end

data/lib/rails_model_visualizer/templates.rb

@@ -0,0 +1,109 @@
+class RMVisualizer
+
+  def self.css
+    "html, body, h1, ul, li,
+    button, div, h2, h3, p {
+      margin: 0;
+      padding: 0;
+      border: 0;
+      outline: 0;
+      font: inherit;
+      color: inherit;
+      text-align: inherit;
+      text-decoration: inherit;
+      vertical-align: inherit;
+      box-sizing: inherit;
+      background: transparent;
+    }
+
+    body {
+        display: flex;
+        flex-direction: column
+    }
+
+    ul {
+      list-style: none;
+      margin-top: 10px;
+/*       margin-right: 20px; */
+      font-size: 18px;
+      width: 350px;
+      font-size: 20px;
+    }
+
+    ul li, .list-name {
+      text-decoration: none;
+      padding-top: 5px;
+      font-size: 16px;
+    }
+
+    ul li:first-child, .list-name:first-child {
+        margin-top: 10px;
+    }
+
+    .model {
+      border: 5px solid black;
+      margin: 10px;
+      padding: 10px;
+      color: white;
+      background-color: red;
+      padding: 20px;
+      text-align: center;
+    }
+
+    h1 {
+     font-size: 40px;
+     text-align: center;
+    }
+
+    .model-details {
+      display: flex;
+      justify-content: space-between;
+    }
+
+    .list-source {
+      display: none;
+      position: absolute;
+      background-color: #ccc;
+      color: black;
+      z-index: 1;
+      left:150px;
+      padding: 5px;
+      border-radius: 3px;
+      text-align: left;
+    }
+
+    .list-name:hover > div {
+      display: block;
+    }
+
+    .list-name {
+      position: relative;
+      cursor: pointer;
+    }
+
+    .superclass {
+       display flex;
+       border: 10px solid black;
+       text-align: center;
+       font-size: 40px;
+       padding: 10px;
+    }"
+
+  end
+
+  def self.html(body)
+    start = "<!DOCTYPE html>
+    <html>
+      <head>
+        <meta charset=\"utf-8\">
+        <title>Rails Model Visualizer</title>
+        <link rel=\"stylesheet\" media=\"all\" href=\"./application.css\">
+      </head>
+      <body>"
+
+    finish = "</body> </html>"
+
+    return(start + body + finish)
+  end
+
+end

data/lib/rails_model_visualizer/version.rb

@@ -0,0 +1,3 @@
+class RMVisualizer
+  VERSION = "0.1.0"
+end

data/rails_model_visualizer.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_model_visualizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_model_visualizer"
+  spec.version       = RMVisualizer::VERSION
+  spec.authors       = ["Halil Coban"]
+  spec.email         = ["halil.coban@gmail.com"]
+
+  spec.summary       = %q{RMVisualizer is a ruby gem that generates a diagram
+    summarizing rails apps.}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "rails", "~> 4.1"
+  spec.add_runtime_dependency 'launchy', '~> 2.4', '>= 2.4.3'
+
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: rails_model_visualizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Halil Coban
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+description: 
+email:
+- halil.coban@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docs/readme.md
+- docs/wireframes/wireframe.png
+- lib/rails_model_visualizer.rb
+- lib/rails_model_visualizer/model.rb
+- lib/rails_model_visualizer/templates.rb
+- lib/rails_model_visualizer/version.rb
+- rails_model_visualizer.gemspec
+homepage: 
+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.5.1
+signing_key: 
+specification_version: 4
+summary: RMVisualizer is a ruby gem that generates a diagram summarizing rails apps.
+test_files: []