rom_sql_graph 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d085ed2dc932a137c3e195530cf1eba2beb8907
+  data.tar.gz: d8ac0ae301303b4d882c2ea0a22b6ea0757049df
+SHA512:
+  metadata.gz: deeef6a35ac8bf86cac4cedce876c56f930b7d8e68b816949ced33f4d556477bec296b197c1c2dd89d6f47f5179d1059b5999f6e5bfb514337bd52e0675b82bc
+  data.tar.gz: bee087332aeb298b2936c45abc4b94cccb629082ecee298885135bc52279cc9c7ac2a79611bbdafcd4592587ea56b70a36c380e097533b80249909c4ab055a9f

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at antondavydov.o@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Anton Davydov
+
+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,59 @@
+# RomSqlGraph
+
+Rom-rb and hanami tool for generating db (sql) association graph.
+
+**For generating image you need to install graphviz tool (http://www.graphviz.org)**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rom_sql_graph'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rom_sql_graph
+
+## Usage
+
+```ruby
+# First: create rom repository object
+repo = UserRepository.new
+
+# Second: create Rom::Sql::Graph object
+graph = RomSqlGraph.generate(repo)
+
+# Generate image or html file with your db associations
+graph.generate_image
+graph.generate_html
+
+# convert graph to any type
+graph.to_a
+graph.to_s
+graph.to_json
+```
+
+### Image example
+![ossboard-graph](https://github.com/davydovanton/rom_sql_graph/blob/master/graph.jpg?raw=true)
+
+
+## TODO:
+- [ ] add tests
+- [ ] generate html
+- [ ] generate json
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rom_sql_graph. 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,36 @@
+require 'rgl/adjacency'
+require 'rgl/dot'
+
+module RomSqlGraph
+  class Base
+    attr_reader :repo
+
+    def initialize(repo)
+      @repo = repo
+    end
+
+    def edges
+      Edges.new(repo).to_a
+    end
+    alias_method :to_a, :edges
+
+    def generate_image
+      graph.write_to_graphic_file('jpg')
+    end
+
+    def to_s
+      graph.edges.sort.to_s
+    end
+
+  private
+
+    def graph
+      if @graph.nil?
+        @graph ||= RGL::DirectedAdjacencyGraph[]
+        to_a.each { |edge| graph.add_edge(*edge) }
+      end
+
+      @graph
+    end
+  end
+end

data/lib/rom_sql_graph/edges.rb

@@ -0,0 +1,27 @@
+module RomSqlGraph
+  class Edges
+    attr_reader :relations
+
+    def initialize(repo)
+      @relations = sql_relations(repo)
+    end
+
+    def to_a
+      relations.map do |name, relation|
+        relation.schema.associations.elements.map do |_, object|
+          association_name = Inflecto.pluralize(object.target.to_sym.to_s).to_sym
+          [name, association_name]
+        end
+      end.map! { |array| array.empty? ? nil : array }.compact.flatten(1)
+    end
+
+  private
+
+    SQL = :sql
+
+    def sql_relations(repo)
+      repo.container.relations.elements
+        .select { |name, object| object.class.adapter == SQL }
+    end
+  end
+end

data/lib/rom_sql_graph/version.rb

@@ -0,0 +1,3 @@
+module RomSqlGraph
+  VERSION = "0.1.0"
+end

data/lib/rom_sql_graph.rb

@@ -0,0 +1,9 @@
+require "rom_sql_graph/base"
+require "rom_sql_graph/edges"
+require "rom_sql_graph/version"
+
+module RomSqlGraph
+  module_function def generate(repo)
+    Base.new(repo)
+  end
+end

data/rom_sql_graph.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rom_sql_graph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rom_sql_graph"
+  spec.version       = RomSqlGraph::VERSION
+  spec.authors       = ["Anton Davydov"]
+  spec.email         = ["antondavydov.o@gmail.com"]
+
+  spec.summary       = %q{Display your DB (sql) association graph}
+  spec.description   = %q{Display your DB (sql) association graph}
+  spec.homepage      = "https://github.com/davydovanton/rom-sql-graph"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency "rgl"
+  spec.add_dependency "inflecto"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rom_sql_graph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Davydov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rgl
+  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'
+- !ruby/object:Gem::Dependency
+  name: inflecto
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Display your DB (sql) association graph
+email:
+- antondavydov.o@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graph.jpg
+- lib/rom_sql_graph.rb
+- lib/rom_sql_graph/base.rb
+- lib/rom_sql_graph/edges.rb
+- lib/rom_sql_graph/version.rb
+- rom_sql_graph.gemspec
+homepage: https://github.com/davydovanton/rom-sql-graph
+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: Display your DB (sql) association graph
+test_files: []