rails_graph 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aa9e5821416a34e7eca9ba18199bea6007190821c50cabb84147db6232b06e2
-  data.tar.gz: f54cb43940dba30d7ddc5915cb8669601d0e05b9b5eb4582c18a504859101ed0
+  metadata.gz: a941a0470a1b02c82bab156a908ccd4e44fefe6c55de286aac071124c87ca3d7
+  data.tar.gz: d313e6ad0f56c18d7026e8f199752f318a771f5bd6f07d5484f58b590d8c3255
 SHA512:
-  metadata.gz: 714e4e3d097f8fda7958665d9f4f8ee0ca78978ecab77be2a59ad84fa1921c3204ae93d111072882068ce33ee3966786a3d7473d787e275077d61785f105815a
-  data.tar.gz: f3889f7437868743a38971f1808e2b3e9d6ac8445a8567f3e96ebb7722d35a24795830f220bdf7eeb1940bfefe472c1cc33f2539a4bd380358af006ad4c62035
+  metadata.gz: 7e9c40831fa2b9077efdc0e7d05ebb0f769fd8c118f6a472d2b5f4edd258db50f8dd281b00cb4e8565b236e5b1f467d13f86db36e038c92b209d4f950fae3af4
+  data.tar.gz: b5bfc0cd608cc3d0ba77724ac8fd28bfc2c81f32e79a95e23bd1eaac62f922c2928460fd682be5374149c1d7a86121dffccbbf0d08f1c6f1287e5cce60e6d759

data/.ruby-version

@@ -1 +1 @@
-ruby-3.1.2
+ruby-3.2.3

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.2
+ruby 3.2.3

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    rails_graph (0.3.0)
-      activerecord (>= 6.0, < 7.1)
-      neo4j-ruby-driver (>= 4.4.0.alpha.8)
-      railties (>= 6.0, < 7.1)
+    rails_graph (0.4.0)
+      activerecord (>= 6.0)
+      neo4j-ruby-driver (>= 4.4)
+      railties (>= 6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -48,30 +48,26 @@ GEM
     diff-lcs (1.5.0)
     erubi (1.12.0)
     fiber-local (1.0.0)
-    i18n (1.13.0)
+    i18n (1.14.0)
       concurrent-ruby (~> 1.0)
     io-event (1.2.2)
-    json (2.6.2)
+    json (2.6.3)
     loofah (2.21.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     method_source (1.0.0)
-    mini_portile2 (2.8.2)
     minitest (5.18.0)
     neo4j-ruby-driver (4.4.4)
       activesupport
       async-io
       connection_pool
       zeitwerk (>= 2.1.10)
-    nokogiri (1.15.2)
-      mini_portile2 (~> 2.8.2)
-      racc (~> 1.4)
     nokogiri (1.15.2-arm64-darwin)
       racc (~> 1.4)
     nokogiri (1.15.2-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
     racc (1.6.2)
     rack (2.2.7)
@@ -92,39 +88,39 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.1)
-    rubocop (1.36.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.52.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     thor (1.2.2)
     timers (4.3.5)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
     zeitwerk (2.6.8)
 
 PLATFORMS
@@ -139,4 +135,4 @@ DEPENDENCIES
   rubocop (~> 1.21)
 
 BUNDLED WITH
-   2.3.22
+   2.4.13

data/README.md

@@ -8,6 +8,8 @@ Gain visibility on your Rails application data model and identify bottlenecks. I
 
 ![Graph](graph.svg "Graph")
 
+https://github.com/ahmad-elassuty/rails_graph/assets/4674035/53deb04e-f995-4af6-9496-a873f84b5445
+
 ## Features
 
 - Application Databases and Tables
@@ -24,6 +26,7 @@ Gain visibility on your Rails application data model and identify bottlenecks. I
 - ActiveRecord Abstract models
 - Class Hierarchy
 - [Packwerk](https://github.com/Shopify/packwerk) packages (disabled by default)
+- Application Gems (disabled by default)
 
 ## Installation
 
@@ -59,23 +62,28 @@ You can control what RailsGraph will include in the final graph by:
 # config/initializers/rails_graph.rb
 
 RailsGraph.configure do |config|
-  # Configure extra classes that are not loaded automatically
+  # Explicitly define classes that are not loaded automatically
   config.include_classes = [ActsAsTaggableOn::Tag, ActsAsTaggableOn::Tagging]
 
-  # Configure Columns parsing
+  # Enable Columns visualisation
   # default false
   config.columns = true
 
-  # Configure Class Hierarchy parsing
+  # Enable Class Hierarchy visualisation
+  # default true
   config.inheritance = true
 
-  # Configure Database entities
+  # Enable Databases visualisation
   # default true
-  config.database = false
+  config.databases = false
 
-  # Configure inclusion of Packwerk packages
+  # Enable Packwerk packages visualisation
   # default false
   config.include_packwerk = true
+
+  # Enable Gems visualisation
+  # default false
+  config.gems = true
 end
 ```
 

data/lib/rails_graph/commands/build_graph.rb

@@ -7,6 +7,7 @@ require_relative "../graph/relationship"
 require_relative "../graph/nodes/abstract_model"
 require_relative "../graph/nodes/column"
 require_relative "../graph/nodes/database"
+require_relative "../graph/nodes/gem"
 require_relative "../graph/nodes/model"
 require_relative "../graph/nodes/pack"
 require_relative "../graph/nodes/table"
@@ -25,6 +26,7 @@ require_relative "./builders/associations"
 require_relative "./builders/models"
 require_relative "./builders/packs"
 require_relative "./builders/databases"
+require_relative "./builders/gems_builder"
 
 module RailsGraph
   module Commands
@@ -36,10 +38,11 @@ module RailsGraph
       def call
         setup_generic_nodes
 
-        RailsGraph::Commands::Builders::Databases.enrich(graph: graph) if configuration.databases?
+        RailsGraph::Commands::Builders::GemsBuilder.enrich(graph: graph, configuration: configuration)
+        RailsGraph::Commands::Builders::Databases.enrich(graph: graph, configuration: configuration)
         RailsGraph::Commands::Builders::Models.enrich(inspector: inspector, graph: graph, classes: classes,
                                                       configuration: configuration)
-        RailsGraph::Commands::Builders::Packs.enrich(graph: graph) if configuration.include_packwerk?
+        RailsGraph::Commands::Builders::Packs.enrich(graph: graph, configuration: configuration)
 
         graph
       end

data/lib/rails_graph/commands/builders/databases.rb

@@ -4,7 +4,9 @@ module RailsGraph
   module Commands
     module Builders
       class Databases
-        def self.enrich(graph:)
+        def self.enrich(graph:, configuration:)
+          return unless configuration.databases?
+
           new(graph: graph).enrich
 
           graph

data/lib/rails_graph/commands/builders/gems_builder.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RailsGraph
+  module Commands
+    module Builders
+      class GemsBuilder
+        def self.enrich(graph:, configuration:)
+          return unless configuration.gems?
+
+          new(graph: graph).enrich
+
+          graph
+        end
+
+        def enrich
+          build_gems_nodes
+
+          gems.each do |specifications|
+            source_node = graph.node("gem_#{specifications.name}")
+
+            # build_authored_by_relationships(specifications, source_node)
+            build_depends_on_gem_relationships(specifications, source_node)
+          end
+        end
+
+        private
+
+        attr_reader :graph
+
+        def initialize(graph:)
+          @graph = graph
+        end
+
+        def build_gems_nodes
+          gems.each do |gem|
+            node = RailsGraph::Graph::Nodes::Gem.new(gem)
+            graph.add_node(node)
+          end
+        end
+
+        # def build_authored_by_relationships(specifications); end
+
+        def build_depends_on_gem_relationships(specifications, source_node)
+          specifications.dependencies.each do |dependency|
+            target_node = graph.node("gem_#{dependency.name}")
+            add_depends_on_gem_relationship(source_node, target_node, dependency)
+          end
+        end
+
+        def add_depends_on_gem_relationship(source_node, target_node, dependency)
+          relationship = RailsGraph::Graph::Relationship.new(
+            source: source_node,
+            target: target_node,
+            label: "DependsOnGem",
+            name: "depends_on_gem",
+            properties: { type: dependency.type, requirement: dependency.requirement.to_s }
+          )
+
+          graph.add_relationship(relationship)
+        end
+
+        def gems
+          @gems ||= Gem::Specification.all
+        end
+      end
+    end
+  end
+end

data/lib/rails_graph/commands/builders/packs.rb

@@ -4,7 +4,9 @@ module RailsGraph
   module Commands
     module Builders
       class Packs
-        def self.enrich(graph:)
+        def self.enrich(graph:, configuration:)
+          return unless configuration.include_packwerk?
+
           new(graph: graph).enrich
 
           graph

data/lib/rails_graph/configuration.rb

@@ -3,7 +3,7 @@
 module RailsGraph
   class Configuration
     attr_reader :include_classes
-    attr_writer :columns, :inheritance, :include_packwerk, :databases
+    attr_writer :columns, :inheritance, :include_packwerk, :databases, :gems
 
     def initialize
       @include_classes = []
@@ -11,6 +11,7 @@ module RailsGraph
       @databases = true
       @columns = false
       @inheritance = true
+      @gems = false
     end
 
     def include_classes=(include_classes)
@@ -32,5 +33,9 @@ module RailsGraph
     def databases?
       @databases
     end
+
+    def gems?
+      @gems
+    end
   end
 end

data/lib/rails_graph/exporters/cypher.rb

@@ -32,7 +32,7 @@ module RailsGraph
 
         item.properties.each do |k, v|
           formatted_value = case v
-                            when String, Symbol then "'#{v}'"
+                            when String, Symbol then "'#{escape_quotes(v)}'"
                             when nil then "null"
                             else v.to_s
                             end
@@ -57,6 +57,12 @@ module RailsGraph
 
         "CREATE (#{source_ref})-[:#{relationship.label} {#{format_properties(relationship)}}]->(#{target_ref})"
       end
+
+      def self.escape_quotes(value)
+        return value if value.is_a? Symbol
+
+        value.gsub("'") { "\\'" }
+      end
     end
   end
 end

data/lib/rails_graph/graph/nodes/database.rb

@@ -28,8 +28,8 @@ module RailsGraph
             replica: configs.replica? || false,
             database_name: configs.database,
             reaping_frequency: configs.reaping_frequency,
-            min_threads: configs.min_threads,
-            max_threads: configs.max_threads
+            min_threads: configs.try(:min_threads),
+            max_threads: configs.try(:max_threads)
           }
         end
       end

data/lib/rails_graph/graph/nodes/gem.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "../node"
+
+module RailsGraph
+  module Graph
+    module Nodes
+      class Gem < Node
+        attr_reader :specifications
+
+        def initialize(specifications)
+          @specifications = specifications
+
+          super(labels: "Gem", name: specifications.name, properties: build_properties)
+        end
+
+        def identifier
+          "gem_#{name}"
+        end
+
+        private
+
+        def build_properties
+          {
+            description: specifications.description,
+            summary: specifications.summary,
+            homepage: specifications.homepage,
+            version: specifications.version.to_s,
+            licenses: specifications.licenses
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rails_graph/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_graph
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ahmad Elassuty
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-29 00:00:00.000000000 Z
+date: 2024-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,23 +24,20 @@ dependencies:
     - - ">="
       - !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
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.4.0.alpha.8
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -51,9 +45,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -61,9 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
 description:
 email:
 - ahmad.elassuty@gmail.com
@@ -87,6 +75,7 @@ files:
 - lib/rails_graph/commands/build_graph.rb
 - lib/rails_graph/commands/builders/associations.rb
 - lib/rails_graph/commands/builders/databases.rb
+- lib/rails_graph/commands/builders/gems_builder.rb
 - lib/rails_graph/commands/builders/models.rb
 - lib/rails_graph/commands/builders/packs.rb
 - lib/rails_graph/commands/export_graph.rb
@@ -102,6 +91,7 @@ files:
 - lib/rails_graph/graph/nodes/abstract_model.rb
 - lib/rails_graph/graph/nodes/column.rb
 - lib/rails_graph/graph/nodes/database.rb
+- lib/rails_graph/graph/nodes/gem.rb
 - lib/rails_graph/graph/nodes/model.rb
 - lib/rails_graph/graph/nodes/pack.rb
 - lib/rails_graph/graph/nodes/table.rb
@@ -143,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Graph visualization for Rails applications.