rails_graph 0.1.0

data/lib/rails_graph/helpers/models.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RailsGraph
+  module Helpers
+    module Models
+      module_function
+
+      def identifier(model)
+        model.to_s.delete_prefix("::")
+      end
+    end
+  end
+end

data/lib/rails_graph/helpers/options_parser.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module RailsGraph
+  module Helpers
+    module OptionsParser
+      def parse_options(banner, arguments)
+        parser = OptionParser.new
+        parser.banner = banner
+        options = {}
+
+        arguments.each { |argument| parser.on(*argument) }
+
+        parser.parse!(parser.order!(ARGV), into: options)
+
+        options
+      end
+    end
+  end
+end

data/lib/rails_graph/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module RailsGraph
+  class Railtie < ::Rails::Railtie
+    railtie_name :rails_graph
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/rails_graph/tasks/rails_graph.rake

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../helpers/options_parser"
+
+namespace :rails_graph do
+  include RailsGraph::Helpers::OptionsParser
+
+  namespace :export do
+    desc "Export graph to Neo4j graph database"
+    task neo4j: :environment do
+      options = parse_options(
+        "Usage: rails rails_graph:export:neo4j [options]",
+        [
+          ["-h", "--host HOST", "Neo4j host, e.g neo4j://localhost:7687"],
+          ["-u", "--username USERNAME", "Neo4j username"],
+          ["-p", "--password PASSWORD", "Neo4j password"]
+        ]
+      )
+
+      RailsGraph.load_entities
+      graph = RailsGraph.build_graph
+      RailsGraph.export_graph(graph: graph, format: :neo4j, **options)
+
+      exit
+    end
+  end
+end

data/lib/rails_graph/version.rb

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

data/lib/rails_graph.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "rails_graph/version"
+require "rails_graph/error"
+require "rails_graph/configuration"
+require "rails_graph/railtie"
+
+require "rails_graph/commands/build_graph"
+require "rails_graph/commands/export_graph"
+
+module RailsGraph
+  module_function
+
+  def load_entities
+    Rails.application.eager_load!
+  end
+
+  def build_graph(configuration: nil)
+    Commands::BuildGraph.call(configuration: configuration || RailsGraph.configuration)
+  end
+
+  def export_graph(graph:, **opts)
+    Commands::ExportGraph.call(graph: graph, **opts)
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def configure
+    yield configuration if block_given?
+  end
+end

data/sig/rails_graph.rbs

@@ -0,0 +1,4 @@
+module RailsGraph
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: rails_graph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ahmad Elassuty
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: neo4j-ruby-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.0.alpha.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.0.alpha.8
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description:
+email:
+- ahmad.elassuty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".tool-versions"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- graph.svg
+- lib/rails_graph.rb
+- lib/rails_graph/commands/build_graph.rb
+- lib/rails_graph/commands/export_graph.rb
+- lib/rails_graph/configuration.rb
+- lib/rails_graph/error.rb
+- lib/rails_graph/exporters/base.rb
+- lib/rails_graph/exporters/cypher.rb
+- lib/rails_graph/exporters/json.rb
+- lib/rails_graph/exporters/neo4j.rb
+- lib/rails_graph/graph/entity.rb
+- lib/rails_graph/graph/graph.rb
+- lib/rails_graph/graph/node.rb
+- lib/rails_graph/graph/nodes/abstract_model.rb
+- lib/rails_graph/graph/nodes/column.rb
+- lib/rails_graph/graph/nodes/model.rb
+- lib/rails_graph/graph/nodes/virtual_model.rb
+- lib/rails_graph/graph/relationship.rb
+- lib/rails_graph/graph/relationships/association.rb
+- lib/rails_graph/graph/relationships/attribute.rb
+- lib/rails_graph/graph/relationships/inheritance.rb
+- lib/rails_graph/helpers/associations.rb
+- lib/rails_graph/helpers/models.rb
+- lib/rails_graph/helpers/options_parser.rb
+- lib/rails_graph/railtie.rb
+- lib/rails_graph/tasks/rails_graph.rake
+- lib/rails_graph/version.rb
+- sig/rails_graph.rbs
+homepage: https://github.com/ahmad-elassuty/rails_graph
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/ahmad-elassuty/rails_graph
+  source_code_uri: https://github.com/ahmad-elassuty/rails_graph
+  changelog_uri: https://github.com/ahmad-elassuty/rails_graph/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Graph visualization for Rails applications.
+test_files: []