weighted_graph 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41020baf8d67aa652af02d9f7a5068c297a3cb8a
-  data.tar.gz: f8e571e67392eae819f7275ff7c4ad3ffa421e52
+  metadata.gz: 2aeaa497d98a2ce3127350c971b0a95ca8b439d7
+  data.tar.gz: 2d738d658bff3b8e81f7d6c4cef2d22d4cf8dea0
 SHA512:
-  metadata.gz: 991a975216c7a5395bd4af8d4a26edb4ce7f7bb839d0cf71762975a4f97d3530a3e4d34332e195bb7b8599b953ca6b22e989ca69d098f63f8a99c087f93085f7
-  data.tar.gz: 98de78724c26e51f49f7dbf1b9747508667f0150ddc814f241cd23f303d19a99265bc011626870bb6f3cfb84f59eed37661015a3dc7b216cff06bbb59b8360d7
+  metadata.gz: f78b0f3725d12cc951db351850131c772cce8f9f4abed144bcc09f3e0bfbe2528274f7e30226626b3905940e942ec6451b4ab599962b099c35c4dbb0190a8224
+  data.tar.gz: bf24cb04fe31638d191f2926a32cc0a142b264121ce8f0d33f04383e4da257f95b709a22954cd9a07ba03ec80b36a0053a4d7a06ca0efbb0797fb4e69676d9a8

data/README.md

@@ -28,7 +28,20 @@ get_edge_weight(source, destination)
 get_adjacent_vertices(source)
 ```
 
-<!-- TODO: Add installation section after publishing the gem.
+## WeightedGraph::PositiveWeightedGraph API
+
+WeightedGraph::PositiveWeightedGraph extends WeightedGraph::Graph and shares its behaviour, with the following differences:
+
+```ruby
+# Add directed edge (source, destination) to the graph with given weight
+# Requires that weight is a positive number
+add_edge(source, destination, weight)
+
+# Add undirected edge (vertex_a, vertex_b) to the graph with given weight
+# Requires that weight is a positive number
+add_undirected_edge(vertex_a, vertex_b, weight)
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -37,9 +50,17 @@ Add this line to your application's Gemfile:
 gem 'weighted_graph'
 ```
 
-Or install it yourself as:
+Then you can require the gem in Ruby programs:
 
-    $ gem install weighted_graph -->
+```ruby
+require 'weighted_graph'
+
+def myMethod()
+  graph = WeightedGraph::Graph.new
+  graph.add_edge('Vancouver', 'Port Coquitlam', 28)
+  # ...
+end
+```
 
 ## Development
 

data/lib/weighted_graph.rb

@@ -1,5 +1,6 @@
-require 'weighted_graph/version'
 require_relative './weighted_graph/graph'
+require_relative './weighted_graph/positive_weighted_graph'
+require_relative './weighted_graph/version'
 
 # A simple graph with weighted edges
 module WeightedGraph

data/lib/weighted_graph/positive_weighted_graph.rb

@@ -0,0 +1,24 @@
+require_relative './graph'
+
+# A simple graph with weighted edges
+module WeightedGraph
+  # API for a graph that requires positive edge weights
+  class PositiveWeightedGraph < WeightedGraph::Graph
+    # Initialize an empty adjacency list for edges
+    def initialize
+      super(Hash.new(0))
+    end
+
+    # Add directed edge (source, destination) to the graph with given weight
+    # Requires that weight is a positive number
+    def add_edge(source, destination, weight)
+      super(source, destination, weight) if weight > 0
+    end
+
+    # Add undirected edge (vertex_a, vertex_b) to the graph with given weight
+    # Requires that weight is a positive number
+    def add_undirected_edge(vertex_a, vertex_b, weight)
+      super(vertex_a, vertex_b, weight) if weight > 0
+    end
+  end
+end

data/lib/weighted_graph/version.rb

@@ -1,3 +1,3 @@
 module WeightedGraph
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/weighted_graph.gemspec

@@ -16,9 +16,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/msayson/weighted_graph'
   spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org.
-  # To allow pushes either set the 'allowed_push_host' to allow pushing to
-  # a single host or delete this section to allow pushing to any host.
+  # Specify hosts this gem may be pushed to.
   if spec.respond_to?(:metadata)
     spec.metadata['allowed_push_host'] = 'https://rubygems.org/gems/weighted_graph'
   else
@@ -34,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'pry', '~> 0.10'
+  # spec.add_development_dependency 'pry', '~> 0.10' # Local debugging utility
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weighted_graph
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mark Sayson
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +73,7 @@ files:
 - bin/setup
 - lib/weighted_graph.rb
 - lib/weighted_graph/graph.rb
+- lib/weighted_graph/positive_weighted_graph.rb
 - lib/weighted_graph/version.rb
 - weighted_graph.gemspec
 homepage: https://github.com/msayson/weighted_graph