acts_as_graph_diagram 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcef649a07aef82c036b7c6df58bf00513702a32c5960dc3af5d4088267cc618
+  data.tar.gz: fc4a5712c0d0b05f165dc665a324a612cf496ee04eafc69ef587cb1253ee9ecb
+SHA512:
+  metadata.gz: 1cb85f7ee1c208c5571fa3d447045028917f92d91bf3b70deead1afa01b06a43f5c795b2b9bf324e3b111879ec966fb9b9ff3bced0806b37a9c3b4a65d7a0d11
+  data.tar.gz: c27c720b88ca5ae95f4a4c721f5e625625a49b3ae035e0c140a369cb416aeaf0f72a2411521301203d45a4ecb2f600c5ab7a85697226120dc7774b0e7b7f02aa

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 smapira
+
+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,178 @@
+# Acts As Graph Diagram
+
+Acts As Graph Diagram extends Active Record to add simple function for draw the Force Directed Graph with html.
+
+![Ruby](https://img.shields.io/badge/Ruby-CC342D?style=for-the-badge&logo=ruby&logoColor=white)
+[![Gem Version](https://badge.fury.io/rb/acts_as_graph_diagram.svg)](https://badge.fury.io/rb/acts_as_graph_diagram)
+![](https://ruby-gem-downloads-badge.herokuapp.com/acts_as_graph_diagram)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
+[![CircleCI](https://circleci.com/gh/routeflags/acts_as_graph_diagram.svg?style=svg)](https://circleci.com/gh/routeflags/acts_as_graph_diagram)
+
+## See It Work
+
+![acts_as_graph_diagram](https://user-images.githubusercontent.com/25024587/173231019-ede998c4-333a-48dd-b2da-96f04e1fce86.gif)
+
+## Usage
+
+Append the line to your model file like below:
+```ruby
+class God < ApplicationRecord
+  acts_as_graph_diagram
+end
+
+God.find_by(name: 'Rheā').add_destination God.find_by(name: 'Hēra', cost: 1)
+# => #<Edge:0x000000010b0d4560
+#  id: 1,
+#  comment: "",
+#  cost: 0,
+#  directed: true,
+#  destination_type: "God",
+#  destination_id: 2,
+#  departure_type: "God",
+#  departure_id: 1,
+#  created_at: Sun, 12 Jun 2022 11:11:06.995007000 UTC +00:00,
+#  updated_at: Sun, 12 Jun 2022 11:11:06.995007000 UTC +00:00>
+
+God.find_by(name: 'Rheā').connecting_count
+# => 1
+
+God.find_by(name: 'Rheā').destinations
+# => [#<Edge:0x000000010b5642b0
+#   id: 1,
+#   comment: "",
+#   cost: 0,
+#   directed: true,
+#   destination_type: "God",
+#   destination_id: 2,
+#   departure_type: "God",
+#   departure_id: 1,
+#   created_at: Sun, 12 Jun 2022 11:11:06.995007000 UTC +00:00,
+#   updated_at: Sun, 12 Jun 2022 11:11:06.995007000 UTC +00:00>]
+
+God.find_by(name: 'Rheā').aheads.first.destination
+# => #<God:0x000000010b5efb58 id: 2, name: "Hēra", created_at: Sun, 12 Jun 2022 11:11:06.984341000 UTC +00:00, updated_at: Sun, 12 Jun 2022 11:11:06.984341000 UTC +00:00>
+```
+
+### Methods
+
+* aheads
+* behinds
+* add_destination(node, comment: '', cost: 0)
+* add_departure(node, comment: '', cost: 0)
+* get_destination(node)
+* get_departure(node)
+* remove_destination(node)
+* remove_departure(node)
+* connecting?(node)
+* connecting_count()
+* add_connection(node, directed: false, comment: '', cost: 0)
+* sum_cost()
+* sum_tree_cost()
+* assemble_tree_nodes()
+
+### Draws the graph diagram with D3.js
+
+1. Append the lines to your controller file like below:
+```ruby
+class GodsController < ApplicationController
+  def data_network
+    render json: { 'nodes' => God.all.pluck(:id, :name)
+                                 .map { |x| Hash[id: x[0], name: x[1]] },
+                   'links' => Edge.all.pluck(:destination_id, :departure_id)
+                                  .map { |x| Hash[target: x[0], source: x[1]] } }
+  end
+end
+```
+
+2. And append the line to your routes.rb file like below:
+```ruby
+Rails.application.routes.draw do
+  get 'data_network' => 'gods#data_network'
+end
+```
+
+3. Then append the line to your javascript file like below:
+```javascript
+// v7.4.4
+d3.json("http://127.0.0.1:3000/data_network").then(function (graph) {});
+```
+
+### Calculates the Program Evaluation and Review Technique (PERT)
+
+![Pert_chart_colored](https://user-images.githubusercontent.com/25024587/174105277-213a955a-b783-43ae-be98-1174d9256273.gif)
+
+> [PERT Chart. Drawn in Adobe Illustrator - inspired by a chart at netmba.com. Created by Jeremy Kemp. 2005/01/11 From Wikipedia, the free encyclopedia](https://en.wikipedia.org/wiki/Program_evaluation_and_review_technique)
+
+```ruby
+Milestone.create(name: 10)
+Milestone.create(name: 20)
+Milestone.create(name: 30)
+Milestone.create(name: 40)
+Milestone.create(name: 50)
+
+Milestone.find_by(name: 10).add_destination(Milestone.find_by(name: 20), cost: 3)
+Milestone.find_by(name: 10).add_destination(Milestone.find_by(name: 30), cost: 4)
+Milestone.find_by(name: 30).add_destination(Milestone.find_by(name: 40), cost: 1)
+Milestone.find_by(name: 40).add_destination(Milestone.find_by(name: 50), cost: 3)
+Milestone.find_by(name: 30).add_destination(Milestone.find_by(name: 50), cost: 2)
+Milestone.find_by(name: 20).add_destination(Milestone.find_by(name: 50), cost: 3)
+
+Milestone.find_by(name: 10).sum_tree_cost
+
+# => 16
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "acts_as_graph_diagram"
+```
+
+And then execute:
+```bash
+$ bundle
+$ bin/rails generate acts_as_graph_diagram
+$ bin/rails db:migrate
+```
+
+Or install it yourself as:
+```bash
+$ gem install acts_as_graph_diagram
+```
+
+## Development
+### Rails console
+```bash
+test/dummy/bin/rails console
+```
+
+### Test
+```bash
+bin/test
+```
+
+## Contributing
+Bug reports and pull requests are welcome on Github at https://github.com/routeflags/acts_as_graph_diagram. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Changelog
+available [here](https://github.com/routeflags/acts_as_graph_diagram/main/CHANGELOG.md).
+
+## Code of Conduct
+Everyone interacting in the ActsAsTreeDiagram project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/routeflags/acts_as_graph_diagram/main/CODE_OF_CONDUCT.md).
+
+## You may enjoy owning other libraries and my company.
+
+* [acts_as_graph_diagram: ActsAsTreeDiagram extends ActsAsTree to add simple function for draw tree diagram with html.](https://github.com/routeflags/acts_as_graph_diagram)
+* [timeline_rails_helper: The TimelineRailsHelper provides a timeline_molecules_tag helper to draw a vertical time line usable with vanilla CSS.](https://github.com/routeflags/timeline_rails_helper)
+* [株式会社旗指物](https://blog.routeflags.com/)
+
+## Аcknowledgments
+
+- [activerecord - Model an undirected graph in Rails? - Stack Overflow](https://stackoverflow.com/questions/7976301/model-an-undirected-graph-in-rails)
+- [tcocca/acts_as_follower: A Gem to add Follow functionality for models](https://github.com/tcocca/acts_as_follower)
+- [Force layout | D3 in Depth](https://www.d3indepth.com/force-layout/)
+- [Rubyを使って「なぜ関数プログラミングは重要か」を読み解く（改定）─ 前編 ─ 但し後編の予定なし](https://melborne.github.io/2013/01/21/why-fp-with-ruby/)

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'

data/bin/test

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path('../test', __dir__)
+
+require 'bundler/setup'
+require 'rails/plugin/test'

data/lib/acts_as_graph_diagram/edge_scopes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActsAsGraphDiagram # :nodoc:
+  ##
+  # This module represents a act of edge.
+  module EdgeScopes
+    extend ActiveSupport::Concern
+
+    included do
+      # returns Edge records where destination is the record passed in.
+      # @param [Node] node
+      scope :select_destinations, ->(node) { where(destination_id: node.id, destination_type: node.class.name) }
+
+      # returns Edge records where departure is the record passed in.
+      # @param [Node] node
+      scope :select_departures, ->(node) { where(departure_id: node.id, departure_type: node.class.name) }
+
+      # returns Edge records where departure or destination are the record passed in.
+      # @param [Node] node
+      scope :select_connections, ->(node) { select_destinations(node).or(select_departures(node)) }
+    end
+  end
+end

data/lib/acts_as_graph_diagram/node/graph_calculator.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module ActsAsGraphDiagram # :nodoc:
+  ##
+  # This module represents a array of node.
+  class Nodes < Array
+    # @param [Proc] functional
+    # @param [Proc] meta
+    # @param [Array] values
+    # @param [Symbol] operator
+    # @return Proc
+    def read_tree(functional, meta, values, operator)
+      return values if !defined?(empty?) || empty?
+
+      meta[first.destination.read_tree(functional, meta, values, operator),
+           ActsAsGraphDiagram::Nodes.new(tail)
+                                    .read_tree(functional, meta, values, operator)]
+    end
+
+    # @param [Proc] functional
+    # @param [Nodes] values
+    # @return Proc
+    def linear(functional, values)
+      return self if empty? || !first.attributes.include?(:destination)
+
+      functional[first.destination,
+                 ActsAsGraphDiagram::Nodes.new(tail)
+                                          .linear(functional, values)]
+    end
+
+    # @return Array
+    def tail
+      drop 1
+    end
+
+    # @return Proc
+    def confluence
+      # @param [Proc] functional
+      # @param [Nodes] values
+      lambda do |x, list = self|
+        ActsAsGraphDiagram::Nodes.new([x] + list)
+      end
+    end
+
+    # @return Proc
+    def append
+      # @param [Proc] functional
+      # @param [Nodes] values
+      lambda do |nodes = self, list|
+        nodes.linear confluence,
+                     ActsAsGraphDiagram::Nodes.new(list)
+      end
+    end
+  end
+
+  module Node # :nodoc:
+    ##
+    # This module represents a calculation of graph.
+    module GraphCalculator
+      extend ActiveSupport::Concern
+
+      included do
+        # @param [Proc] functional
+        # @param [Proc] meta
+        # @param [Any] value
+        # @param [Symbol] operator
+        # @return Proc
+        def read_tree(functional, meta, value, operator = :self)
+          argument = if operator == :self
+                  self
+                else
+                  public_send(operator)
+                end
+          functional[argument,
+                     ActsAsGraphDiagram::Nodes
+                       .new(aheads.where.not(destination_id: id).to_a)
+                       .read_tree(functional, meta, value, operator)]
+        end
+
+        # @return Integer
+        def sum_tree_cost
+          read_tree addition, addition, 0, :sum_cost
+        end
+
+        # @return Proc
+        def addition
+          # @param [Any] x
+          # @param [Any] y
+          ->(x, y) { x + y }
+        end
+
+        def sum_cost
+          aheads.sum(:cost)
+        end
+
+        # @param [Proc] functional
+        # @param [Proc] meta
+        # @return Proc
+        def linear(functional, meta)
+          raise NotImplementedError
+          ->(x, y) { functional[meta[x], y] }
+        end
+
+        # @return Proc
+        def append
+          # @param [Nodes] nodes
+          # @param [Array] values
+          lambda do |nodes = self, values|
+            nodes.linear confluence, ActsAsGraphDiagram::Nodes.new(values)
+          end
+        end
+
+        # @return Proc
+        def confluence
+          # @param [Node] node
+          # @param [Nodes] nodes
+          lambda do |node, nodes = self|
+            ActsAsGraphDiagram::Nodes.new([node] + nodes)
+          end
+        end
+
+        # @return [Node]
+        def assemble_tree_nodes
+          read_tree confluence, append, []
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_graph_diagram/node.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'acts_as_graph_diagram/node/graph_calculator'
+
+module ActsAsGraphDiagram # :nodoc:
+  module Node
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods # :nodoc:
+      def acts_as_node
+        has_many :behinds, as: :destination,
+                           class_name: 'Edge',
+                           dependent: :destroy
+        has_many :aheads, as: :departure,
+                          class_name: 'Edge',
+                          dependent: :destroy
+        include ActsAsGraphDiagram::Node::InstanceMethods
+        include ActsAsGraphDiagram::Node::GraphCalculator
+      end
+    end
+
+    module InstanceMethods # :nodoc:
+      # rubocop:disable Style/HashSyntax
+
+      # Creates a new destination record for this instance to connect the passed object.
+      # @param [Node] node
+      # @param [String] comment
+      # @param [Integer] cost
+      # @return [Edge]
+      def add_destination(node, comment: '', cost: 0)
+        aheads.select_destinations(node)
+              .where(comment: comment, cost: cost)
+              .first_or_create!
+      end
+
+      # Creates a new departure record for this instance to connect the passed object.
+      # @param [Node] node
+      # @param [String] comment
+      # @param [Integer] cost
+      # @return [Edge]
+      def add_departure(node, comment: '', cost: 0)
+        behinds.select_departures(node)
+               .where(comment: comment, cost: cost)
+               .first_or_create!
+      end
+
+      # Creates a new undirected connection record for this instance to connect the passed object.
+      # @param [Node] node
+      # @param [Boolean] directed
+      # @param [String] comment
+      # @param [Integer] cost
+      # @return [Edge]
+      def add_connection(node, directed: false, comment: '', cost: 0)
+        Edge.where(destination: node,
+                   directed: directed,
+                   departure: self,
+                   comment: comment,
+                   cost: cost).first_or_create!
+      end
+      # rubocop:enable Style/HashSyntax
+
+      # Returns a destination node record for the current instance.
+      # @param [Node] node
+      # @return [Edge]
+      def get_destination(node)
+        aheads.select_destinations(node).first
+      end
+
+      # Deletes the destination record if it exists.
+      # @param [Node] node
+      # @return [Edge|nil]
+      def remove_destination(node)
+        get_destination(node).try(:destroy)
+      end
+
+      # Returns a departure node record for the current instance.
+      # @param [Node] node
+      # @return [Edge]
+      def get_departure(node)
+        behinds.select_departures(node).first
+      end
+
+      # Deletes the destination record if it exists.
+      # @param [Node] node
+      # @return [Edge|nil]
+      def remove_departure(node)
+        get_departure(node).try(:destroy)
+      end
+
+      # Returns a undirected node record for the current instance.
+      # @param [Node] node
+      # @return [Edge]
+      def get_connection(node)
+        Edge.select_connections(node).first
+      end
+
+      # Deletes the undirected record if it exists.
+      # @param [Node] node
+      # @return [Edge|nil]
+      def remove_connection(node)
+        get_connection(node).try(:destroy)
+      end
+
+      # Returns true if this instance is connecting the object passed as an argument.
+      # @param [Node] node
+      # @return [Boolean]
+      def connecting?(node)
+        node.connecting_count.positive?
+      end
+
+      # Returns the number of objects this instance is following.
+      # @return [Integer]
+      def connecting_count
+        Edge.select_connections(self).count
+      end
+    end
+  end
+end

data/lib/acts_as_graph_diagram/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActsAsGraphDiagram # :nodoc:
+  class Railtie < ::Rails::Railtie # :nodoc:
+    initializer 'acts_as_graph_diagram.active_record' do |_app|
+      ActiveSupport.on_load :active_record do
+        include ActsAsGraphDiagram::Node
+      end
+    end
+  end
+end

data/lib/acts_as_graph_diagram/version.rb

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

data/lib/acts_as_graph_diagram.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'acts_as_graph_diagram/version'
+require 'acts_as_graph_diagram/railtie'
+
+# Specify this extension if you want to model a graph
+# network structure by providing any edge association.
+module ActsAsGraphDiagram
+  autoload :Node, 'acts_as_graph_diagram/node'
+  autoload :EdgeScopes, 'acts_as_graph_diagram/edge_scopes.rb'
+  require 'acts_as_graph_diagram/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
+end

data/lib/generators/USAGE

@@ -0,0 +1,5 @@
+Description:
+    rails generate acts_as_graph_diagram
+
+    no need to specify a name after acts_as_graph_diagram as you can not change the model name from Follow
+    the acts_as_graph_diagram_migration file will be created in db/migrate

data/lib/generators/acts_as_graph_diagram_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class ActsAsGraphDiagramGenerator < Rails::Generators::Base # :nodoc:
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from https://github.com/rails/rails/blob/master/activerecord/lib/rails/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
+    else
+      format('%.3d', (current_migration_number(dirname) + 1))
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/acts_as_graph_diagram_migration.rb'
+  end
+
+  def create_model
+    template 'model.rb', File.join('app/models', 'edge.rb')
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class ActsAsGraphDiagramMigration < ActiveRecord::Migration[4.2] # :nodoc:
+  def self.up
+    create_table :edges, force: true do |t|
+      t.string :comment, default: ''
+      t.integer :cost, default: 0
+      t.boolean :directed, default: true
+      t.references :destination, polymorphic: true, null: true
+      t.references :departure, polymorphic: true, null: true
+      t.timestamps
+    end
+
+    add_index :edges, %w[departure_id departure_type], name: 'fk_edges_departure'
+    add_index :edges, %w[destination_id destination_type], name: 'fk_edges_destination'
+  end
+
+  def self.down
+    drop_table :edges
+  end
+end

data/lib/generators/templates/model.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: edges
+#
+#  id               :integer          not null, primary key
+#  comment          :string           default("")
+#  cost             :integer          default(0)
+#  directed         :boolean          default(TRUE)
+#  destination_type :string
+#  destination_id   :integer
+#  departure_type   :string
+#  departure_id     :integer
+#  created_at       :datetime
+#  updated_at       :datetime
+#
+class Edge < ActiveRecord::Base
+  extend ActsAsGraphDiagram::Node
+  include ActsAsGraphDiagram::EdgeScopes
+
+  belongs_to :destination, polymorphic: true, optional: true
+  belongs_to :departure,   polymorphic: true, optional: true
+end

data/test/acts_as_graph_diagram_test.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class ActsAsGraphDiagramTest < ActiveSupport::TestCase
+  test 'it has a version number' do
+    assert ActsAsGraphDiagram::VERSION
+  end
+
+  test 'be defined' do
+    assert God.first.respond_to?(:aheads)
+    assert God.first.respond_to?(:behinds)
+    assert God.first.respond_to?(:add_destination)
+    assert God.first.respond_to?(:add_departure)
+    assert God.first.respond_to?(:get_destination)
+    assert God.first.respond_to?(:get_departure)
+    assert God.first.respond_to?(:remove_destination)
+    assert God.first.respond_to?(:remove_departure)
+    assert God.first.respond_to?(:connecting?)
+    assert God.first.respond_to?(:connecting_count)
+    assert God.first.respond_to?(:add_connection)
+    assert God.first.respond_to?(:sum_cost)
+    assert God.first.respond_to?(:sum_tree_cost)
+    assert God.first.respond_to?(:assemble_tree_nodes)
+  end
+
+  test 'calculate sum_cost' do
+    God.find(3).add_destination(God.find(5), cost: 4)
+    assert_equal God.find(3).sum_cost, 4
+  end
+
+  test 'calculate sum_tree_cost' do
+    God.find(4).add_destination(God.find(6), cost: 4)
+    God.find(6).add_destination(God.find(7), cost: 3)
+    assert_equal God.find(4).sum_tree_cost, 7
+  end
+
+  test 'call assemble_tree_nodes' do
+    God.find(4).add_destination(God.find(6), cost: 4)
+    God.find(6).add_destination(God.find(7), cost: 3)
+    God.find(6).add_destination(God.find(7), cost: 3)
+    assert_equal God.find(4).assemble_tree_nodes.size, 3
+  end
+end