diaspora-cluster-creator 0.2.0 → 0.3.0

data/.gitignore

@@ -15,5 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-cluster.png
-cluster.dot
+cluster.*

data/Guardfile

@@ -33,7 +33,7 @@ end
 
 guard 'bundler' do
   watch('Gemfile')
-  watch('*.gemspec')
+  watch(%r{.*\.gemspec})
   # Uncomment next line if Gemfile contain `gemspec' command
   # watch(/^.+\.gemspec/)
 end
@@ -42,5 +42,4 @@ guard 'cucumber' do
   watch(%r{^features/.+\.feature$})
   watch(%r{^features/support/.+$})          { 'features' }
   watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
-  watch(%r{^lib/diaspora-cluster-creator/(.+)\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
 end

data/README.md

@@ -38,6 +38,8 @@ Or you can specify names
 Or perhaps you prefer a PNG
 
 	$ diaspora-cluster filename=output.png names="Sparta [T2 E1 R3], Athens [T-2], Corinth [R3 T2 E1], Ephesus, Rhodes [T4]"
+	
+Take a look at /features/command_line.feature for better definitions.
 
 ## Contributing
 

data/TODO.todo

@@ -0,0 +1,2 @@
+– Allow different attributes to be passed.
+– The above implies an NodeAttribute class; And a Config class as well.

data/bin/diaspora-cluster

@@ -5,25 +5,28 @@ require_relative '../lib/diaspora-cluster-creator'
 
 Main do
   description 'Generate a diaspora cluster'
-  keyword('names', 'n') {
+  keyword('names') {
     arity(-1)
     cast :list_of_string
     description "List of cluster names, comma separated."
   }
-  keyword('count', 'c') {
+  keyword('count') {
     arity 1
     cast :integer
     description "Instead of a list of names, provide a cluster count."
   }
-  keyword('filename', 'f') {
-    required
+  keyword('filename') {
     arity 1
-    validate {|output| output =~ /\w\.(png|dot)$/i}
-    description "filename.DOT or filename.PNG"
-    default "cluster.dot"
+    validate {|output| output =~ /\w\.(png|svg|dot)$/i}
+    description ".png, .svg, .dot formats"
+  }
+  keyword('attributes') {
+    arity(-1)
+    cast :list_of_string
+    description "Instead of the default attributes, specify a different set"
   }
   def run
-    options = {:names => params[:names].value, :count => params[:count].value, :filename => params[:filename].value}
+    options = {:names => params[:names].value, :count => params[:count].value, :filename => params[:filename].value, :attributes => params[:attributes].value}
     Diaspora::Cluster::Creator.run(options)
   end
 end

data/diaspora-cluster-creator.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'guard-bundler'
   gem.add_development_dependency 'guard-cucumber'
   gem.add_development_dependency 'growl'
+  gem.add_development_dependency 'debugger'
+  gem.add_development_dependency 'aruba'
   
   gem.add_runtime_dependency "ruby-graphviz"
   gem.add_runtime_dependency "main"

data/features/cluster.feature

@@ -1,6 +1,6 @@
 Feature: Cluster creation
 
 Scenario: Cluster creation
-  When I request a new cluster with 5 star systems
+  When I request a new cluster with 5 node systems
   Then the output should have 5 nodes
   And the output should have at least 4 edges

data/features/command_line.feature

@@ -0,0 +1,165 @@
+@announce
+Feature: Provide tested examples of the command-line interface
+
+Scenario: Specify without parameters
+  When I run `diaspora-cluster`
+  Then it should pass with output like:
+  """
+  graph Cluster {
+    A \[label = "A
+  T-?\d R-?\d E-?\d"\];
+    B \[label = "B
+  T-?\d R-?\d E-?\d"\];
+    A -- B
+  }
+  """
+
+Scenario: Specify with names
+  When I run `diaspora-cluster names="Sparta{T2 E-1 R0},Athens{T1 E1 R0}"`
+  Then it should pass with:
+  """
+  graph Cluster {
+    Sparta [label = "Sparta
+  T2 R0 E-1"];
+    Athens [label = "Athens
+  T1 R0 E1"];
+    Sparta -- Athens
+  }
+  """
+
+Scenario: Specify with technology guarantee
+  When I run `diaspora-cluster names="Sparta{T0 E-1 R0},Athens{T1 E1 R0},Corinth{T1 E0 R0}"`
+  Then it should pass with output like:
+  """
+  graph Cluster {
+    Sparta \[label = "Sparta
+  T2 R0 E-1"\];
+    Athens \[label = "Athens
+  T2 R0 E1"\];
+    Corinth \[label = "Corinth
+  T1 R0 E0"\];
+    Sparta -- Athens
+    Athens -- Corinth
+  }
+  """
+
+Scenario: With -h
+  When I run `diaspora-cluster -h`
+  Then it should fail with output like:
+  """
+  NAME
+    diaspora-cluster
+  
+  SYNOPSIS
+    diaspora-cluster \[names=names\] \[count=count\] \[filename=filename\]
+  
+  DESCRIPTION
+    Generate a diaspora cluster
+  
+  PARAMETERS
+    names
+    count
+    filename
+    --help, -h
+  """
+
+Scenario Outline: I want files of different formats
+  When I run `diaspora-cluster filename=cluster.<FORMAT>`
+  Then the following files should exist:
+    | cluster.<FORMAT> |
+
+  Examples:
+  | FORMAT |
+  | png    |
+  | dot    |
+  | svg    |
+
+Scenario: Specify different attributes
+  When I run `diaspora-cluster attributes="Magic, Religion, Science"`
+  Then it should pass with output like:
+  """
+  graph Cluster {
+    A \[label = "A
+  M-?\d R-?\d S-?\d"\];
+    B \[label = "B
+  M-?\d R-?\d S-?\d"\];
+    C \[label = "C
+  M-?\d R-?\d S-?\d"\];
+    D \[label = "D
+  M-?\d R-?\d S-?\d"\];
+    E \[label = "E
+  M-?\d R-?\d S-?\d"\];
+    A -- B
+    B -- C
+    C -- D
+    D -- E
+  """
+
+Scenario: Specify different attributes with prefix override
+  When I run `diaspora-cluster attributes="M(a)gic, Religion, Science"`
+  Then it should pass with output like:
+  """
+  graph Cluster {
+    A \[label = "A
+  A-?\d R-?\d S-?\d"\];
+    B \[label = "B
+  A-?\d R-?\d S-?\d"\];
+    C \[label = "C
+  A-?\d R-?\d S-?\d"\];
+    D \[label = "D
+  A-?\d R-?\d S-?\d"\];
+    E \[label = "E
+  A-?\d R-?\d S-?\d"\];
+    A -- B
+    B -- C
+    C -- D
+    D -- E
+  """
+  
+Scenario: Specify different attributes with default
+  When I run `diaspora-cluster names="Sparta{M5},Athens{R-5}" attributes="Magic, Religion, Science"`
+  Then it should pass with output like:
+  """
+  graph Cluster {
+    Sparta \[label = "Sparta
+  M5 R-?\d S-?\d"\];
+    Athens \[label = "Athens
+  M-?\d R-5 S-?\d"\];
+    Sparta -- Athens
+  """
+
+Scenario: Specify with count parameters
+  When I run `diaspora-cluster count=10`
+  Then it should pass with output like:
+  """
+  graph Cluster {
+    A \[label = "A
+  T-?\d R-?\d E-?\d"\];
+    B \[label = "B
+  T-?\d R-?\d E-?\d"\];
+    C \[label = "C
+  T-?\d R-?\d E-?\d"\];
+    D \[label = "D
+  T-?\d R-?\d E-?\d"\];
+    E \[label = "E
+  T-?\d R-?\d E-?\d"\];
+    F \[label = "F
+  T-?\d R-?\d E-?\d"\];
+    G \[label = "G
+  T-?\d R-?\d E-?\d"\];
+    H \[label = "H
+  T-?\d R-?\d E-?\d"\];
+    I \[label = "I
+  T-?\d R-?\d E-?\d"\];
+    J \[label = "J
+  T-?\d R-?\d E-?\d"\];
+    A -- B
+    B -- C
+    C -- D
+    D -- E
+    E -- F
+    F -- G
+    H -- I
+    I -- J
+  }
+  """

data/features/node.feature

@@ -0,0 +1,13 @@
+Feature: Node Creation
+
+Scenario: Node Creation
+  When I create a Node
+  Then it should have a technology rating
+  And it should have a resources rating
+  And it should have a environment rating
+  
+Scenario: Named Node Creation
+  When I create a Node with name "Sparta [T1 E-2 R3]"
+  Then it should have a technology rating of 1
+  And it should have a resources rating of 3
+  And it should have a environment rating of -2

data/features/step_definitions/cluster_steps.rb

@@ -1,11 +1,11 @@
-When /^I request a new cluster with (#{CAPTURE_INTEGER}) star systems?$/ do |count|
+When /^I request a new cluster with (#{CAPTURE_INTEGER}) node systems?$/ do |count|
   set_current_cluster(['a']*count)
 end
 
 Then /^the output should have (#{CAPTURE_INTEGER}) nodes$/ do |count|
-  current_graph.nodes.count.must_equal count
+  current_cluster.nodes.count.must_equal count
 end
 
 Then /^the output should have at least (#{CAPTURE_INTEGER}) edges$/ do |count|
-  current_graph.edges.count.must_be :>=, count
+  current_cluster.edges.count.must_be :>=, count
 end

data/features/step_definitions/command_line_steps.rb

@@ -0,0 +1,7 @@
+Then /^it should (pass|fail) with output like:$/ do |pass_or_fail, lines|
+  to_execute = ''
+  lines.split("\n").each_with_object(to_execute) do |line, mem|
+    mem << %(And it should #{pass_or_fail} with regex:\n"""\n#{line}\n"""\n)
+  end
+  steps to_execute
+end

data/features/step_definitions/node_steps.rb

@@ -0,0 +1,16 @@
+When /^I create a Node$/ do
+  current_node
+end
+
+When /^I create a Node with (?:the )?name "([^"]*)"$/ do |name|
+  set_current_node(name)
+end
+
+Then /^it should have an? (#{CAPTURE_SYSTEM_ATTRIBUTE}) rating$/ do |system_attribute|
+  current_node.send(system_attribute).must_be :<=, 4
+  current_node.send(system_attribute).must_be :>=, -4
+end
+
+Then /^it should have an? (#{CAPTURE_SYSTEM_ATTRIBUTE}) rating of (#{CAPTURE_INTEGER})$/ do |system_attribute, rating|
+  current_node.send(system_attribute).must_equal rating
+end

data/features/support/aruba.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/features/support/world.rb

@@ -12,16 +12,12 @@ module KnowsTheDomain
     @current_roller ||= FateDice.new
   end
   
-  def current_star_system
-    @current_star_system ||= StarSystem.new(current_cluster, 1)
+  def current_node
+    @current_node ||= Node.new(current_cluster, 1)
   end
 
-  def set_current_star_system(value)
-    @current_star_system = StarSystem.new(current_cluster, value)
-  end
-  
-  def current_graph
-    @current_graph ||= Graph.new(current_cluster)
+  def set_current_node(value)
+    @current_node = Node.new(current_cluster, value)
   end
 end
 

data/lib/diaspora-cluster-creator.rb

@@ -4,21 +4,24 @@ module Diaspora
   module Cluster
     module Creator
       def self.run(params)
+        filename = params[:filename].to_s
         names = ('A'..'Z').to_a[0,params[:count] || 6]
-        cluster = Cluster.new( params[:names] || names )
-        graph = Graph.new(cluster)
-        template = Template.new(graph)
-        case File.extname(params[:filename])
+
+        cluster = Cluster.new(params[:names] || names, params[:attributes])
+        template = Template.new(cluster)
+
+        case File.extname(filename)
         when '.dot' then template.to_dot(params[:filename])
         when '.png' then template.to_png(params[:filename])
+        when '.svg' then template.to_svg(params[:filename])
+        else
+          STDOUT.write template.to_s
         end
       end
     end
   end
 end
 
-require_relative "diaspora-cluster-creator/fate_dice"
-require_relative "diaspora-cluster-creator/graph"
-require_relative "diaspora-cluster-creator/cluster"
-require_relative "diaspora-cluster-creator/star_system"
-require_relative "diaspora-cluster-creator/template"
+Dir.glob(File.join(File.dirname(__FILE__),'diaspora-cluster-creator', '*')).each do |filename|
+  require filename
+end

data/lib/diaspora-cluster-creator/attribute.rb

@@ -0,0 +1,29 @@
+module Diaspora
+  module Cluster
+    module Creator
+      class Attribute
+        attr_reader :name, :prefix
+        def initialize(name)
+          if /\((?<extracted_prefix>\w)\)/ =~ name
+            @prefix = extracted_prefix.upcase
+          else
+            @prefix = name.slice(0).upcase
+          end
+          @name = name.gsub(/[\(\)]/,'')
+        end
+        
+        def to_s
+          name
+        end
+        
+        def to_sym
+          name.to_s.gsub(/\W+/,'_').downcase.to_sym
+        end
+        
+        def label
+          prefix
+        end
+      end
+    end
+  end
+end

data/lib/diaspora-cluster-creator/attribute_collection_factory.rb

@@ -0,0 +1,29 @@
+require 'dependency_injector'
+module Diaspora
+  module Cluster
+    module Creator
+      class AttributeCollectionFactory
+        DEFAULT_ATTRIBUTE_NAMES = [
+          "Technology",
+          "Resources",
+          "Environment",
+        ].freeze
+        extend DependencyInjector
+        def_injector(:attribute_builder) { Attribute.public_method(:new) }
+        
+        attr_reader :cluster
+        def initialize(cluster)
+          @cluster = cluster
+        end
+        
+        def build_from(names = [])
+          from_these_names = (!names.nil? && names.any?) ? names : DEFAULT_ATTRIBUTE_NAMES
+          from_these_names.each_with_object([]) do |name, mem|
+            mem << attribute_builder.call(name)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/diaspora-cluster-creator/cluster.rb

@@ -1,41 +1,54 @@
 require 'dependency_injector'
-require_relative 'star_system'
+require_relative 'node_collection_factory'
+require_relative 'attribute_collection_factory'
+require_relative 'edge_drawer'
 
 module Diaspora
   module Cluster
     module Creator
       class Cluster
-        include Enumerable
         extend DependencyInjector
-        def_injector(:star_system_builder) { StarSystem.public_method(:new) }
-        def_injector(:star_system_guarantor) { StarSystem.public_method(:guarantee!) }
+        def_injector(:edge_collection_builder) { lambda { EdgeDrawer.new(self).draw(nodes) } }
+        def_injector(:node_collection_builder) { lambda { NodeCollectionFactory.new(self).build_from(names) } }
+        def_injector(:attribute_collection_builder) { lambda { AttributeCollectionFactory.new(self).build_from(attribute_names) } }
 
         attr_reader :names
+        attr_reader :settings
+        attr_reader :attribute_names
 
-        def initialize(*names)
-          @names = names.flatten.compact
+        def initialize(names = [], attribute_names = [])
+          @names = names
+          @attribute_names = attribute_names
         end
 
-        def each
-          star_systems.each {|ss| yield(ss)}
+        def each_node
+          nodes.each { |node| yield(node) }
         end
 
-        def star_systems
-          @star_systems ||= build_star_systems
+        def each_edge
+          edges.each { |edge| yield(edge) }
         end
         
-        def to_s
-          'Cluster'
+        def each_attribute
+          attributes.each { |attribute| yield(attribute) }
         end
 
-        protected
-        def build_star_systems
-          @star_systems ||= star_system_guarantor.call(generate_first_pass)
+        def nodes
+          @nodes ||= node_collection_builder.call
         end
-        def generate_first_pass
-          names.each_with_object([]) {|name,mem| mem << star_system_builder.call(self, name)}
+
+        def edges
+          @edges ||= edge_collection_builder.call
+        end
+        
+        def attributes
+          @attributes ||= attribute_collection_builder.call
+        end
+
+        def to_s
+          'Cluster'
         end
       end
     end
   end
-end
+end