acts_as_graph 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85713371daed2a84ea58c068c10a373165ad9b3b
+  data.tar.gz: 448fd7508d466a053e8568e3958326f0115bd68f
+SHA512:
+  metadata.gz: da1fe3794e4b6d89fe824908f1d1767e3a45dad7206dcf1cb3b4dee9926ff253c6085e7e3067608f2a795dbee6362463a65fc8dc4cbf8346d33573fb43ff6cc5
+  data.tar.gz: 6f2f24d36ca3530c70f9d2a3f700e93fcb6b216b6305ee4a4d8e634445273b91427da69745eaa3f12ba0d0117845ad31438ac6367576f7a133649c342fc6a021

data/.gitignore

@@ -0,0 +1,4 @@
+acts_as_graph-*.gem
+.rspec_status
+tags
+.byebug_history

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    acts_as_graph (0.0.1)
+      rspec
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  acts_as_graph!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,3 @@
+# acts_as_graph
+
+working in progress

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]

data/acts_as_graph.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'acts_as_graph/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'acts_as_graph'
+  s.version     = ActsAsGraph::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Zhichao Feng']
+  s.email       = ['flankerfc@gmail.com']
+  s.homepage    = 'https://github.com/flanker'
+  s.summary     = 'A very simple acts as graph for your model'
+  s.description = 'A very simple acts as graph for your model'
+  s.license     = 'MIT'
+
+  s.required_ruby_version     = '>= 2.3'
+  s.required_rubygems_version = '>= 1.3.6'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- test/*`.split("\n")
+  s.require_path = ['lib']
+
+  s.add_runtime_dependency 'rspec'
+
+end

data/lib/acts_as_graph.rb

@@ -0,0 +1,60 @@
+module ActsAsGraph
+
+  def self.included base
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def acts_as_graph children: nil
+      @children_method_name = children
+
+      define_method "descendant_#{children}" do
+        descendant_vertices
+      end
+    end
+
+    def children_method_name
+      @children_method_name
+    end
+
+  end
+
+  def descendant_vertices
+    vertices_found = []
+    collect_child_vertices vertices_found, starting_vertice: self
+    vertices_found
+  end
+
+  def collect_child_vertices vertices_found, starting_vertice: nil
+    child_vertices.each do |child_vertice|
+      next if vertices_found.include?(child_vertice) || child_vertice == starting_vertice
+      vertices_found << child_vertice
+      child_vertice.collect_child_vertices vertices_found, starting_vertice: starting_vertice
+    end
+  end
+
+  def has_circular_reference?
+    vertices_found = []
+    has_circular_reference_in_child_vertices? vertices_found, starting_vertice: self
+  end
+
+  def has_circular_reference_in_child_vertices? vertices_found, starting_vertice: nil
+    child_vertices.any? do |child_vertice|
+      return true if vertices_found.include?(child_vertice) || child_vertice == starting_vertice
+      vertices_found << child_vertice
+      child_vertice.has_circular_reference_in_child_vertices? vertices_found, starting_vertice: starting_vertice
+    end
+  end
+
+  private
+
+  def children_method_name
+    self.class.children_method_name
+  end
+
+  def child_vertices
+    self.send children_method_name
+  end
+
+end

data/lib/acts_as_graph/version.rb

@@ -0,0 +1,3 @@
+module ActsAsGraph
+  VERSION = '0.0.1'
+end

data/spec/acts_as_graph_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+RSpec.describe ActsAsGraph do
+
+  class Task
+
+    include ActsAsGraph
+
+    acts_as_graph children: :depended_tasks
+
+    attr_reader :title
+    attr_accessor :depended_tasks
+
+    def initialize title, depended_tasks = []
+      @title = title
+      @depended_tasks = depended_tasks
+    end
+
+  end
+
+  context '#descendant_depended_tasks' do
+
+    it 'should get all descendant tasks' do
+      task_1 = Task.new 'task_1'
+      task_2 = Task.new 'task_2'
+      task_3 = Task.new 'task_3', [task_1, task_2]
+
+      descendant_depended_tasks = task_3.descendant_depended_tasks
+      expect(descendant_depended_tasks.length).to eq(2)
+      expect(descendant_depended_tasks).to match_array([task_1, task_2])
+    end
+
+    it 'should handle the circular reference' do
+      task_1 = Task.new 'task_1'
+      task_2 = Task.new 'task_2', [task_1]
+      task_3 = Task.new 'task_3', [task_2]
+      task_1.depended_tasks = [task_3]
+
+      descendant_depended_tasks = task_3.descendant_depended_tasks
+      expect(descendant_depended_tasks.length).to eq(2)
+      expect(descendant_depended_tasks).to match_array([task_1, task_2])
+    end
+
+    it 'should handle a more complex case' do
+      task_1 = Task.new 'task_1'
+      task_2 = Task.new 'task_2'
+      task_3 = Task.new 'task_3'
+      task_4 = Task.new 'task_4'
+      task_5 = Task.new 'task_5'
+      task_6 = Task.new 'task_6'
+      task_1.depended_tasks = [task_2]
+      task_2.depended_tasks = [task_3, task_4]
+      task_3.depended_tasks = [task_1, task_5, task_6]
+      task_4.depended_tasks = [task_5]
+
+      descendant_depended_tasks = task_1.descendant_depended_tasks
+      expect(descendant_depended_tasks.length).to eq(5)
+      expect(descendant_depended_tasks).to match_array([task_2, task_3, task_4, task_5, task_6])
+    end
+  end
+
+  context '#has_circular_reference?' do
+
+    it 'works if there is no circular reference' do
+      task_1 = Task.new 'task_1'
+      task_2 = Task.new 'task_2'
+      task_3 = Task.new 'task_3', [task_1, task_2]
+
+      expect(task_3.has_circular_reference?).to be false
+    end
+
+    it 'works if there is a child vertice references the starting vertice' do
+      task_1 = Task.new 'task_1'
+      task_2 = Task.new 'task_2'
+      task_3 = Task.new 'task_3'
+
+      task_1.depended_tasks = [task_2]
+      task_2.depended_tasks = [task_3]
+      task_3.depended_tasks = [task_1]
+
+      expect(task_1.has_circular_reference?).to be true
+      expect(task_2.has_circular_reference?).to be true
+      expect(task_3.has_circular_reference?).to be true
+    end
+
+    it 'works if there are two vertices reference with each other' do
+      task_1 = Task.new 'task_1'
+      task_2 = Task.new 'task_2'
+      task_3 = Task.new 'task_3'
+
+      task_1.depended_tasks = [task_2]
+      task_2.depended_tasks = [task_3]
+      task_3.depended_tasks = [task_2]
+
+      expect(task_1.has_circular_reference?).to be true
+      expect(task_2.has_circular_reference?).to be true
+      expect(task_3.has_circular_reference?).to be true
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'acts_as_graph'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_graph
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zhichao Feng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: A very simple acts as graph for your model
+email:
+- flankerfc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- acts_as_graph.gemspec
+- lib/acts_as_graph.rb
+- lib/acts_as_graph/version.rb
+- spec/acts_as_graph_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/flanker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A very simple acts as graph for your model
+test_files: []