diaspora-cluster-creator 0.3.0 → 0.4.0

data/diaspora-cluster-creator.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'growl'
   gem.add_development_dependency 'debugger'
   gem.add_development_dependency 'aruba'
+  gem.add_development_dependency 'factory_girl'
   
   gem.add_runtime_dependency "ruby-graphviz"
   gem.add_runtime_dependency "main"

data/features/command_line.feature

@@ -19,6 +19,9 @@ Scenario: Specify with names
   Then it should pass with:
   """
   graph Cluster {
+    "Cluster Legend" [label = "T - Technology
+  R - Resources
+  E - Environment", shape = "box"];
     Sparta [label = "Sparta
   T2 R0 E-1"];
     Athens [label = "Athens
@@ -32,6 +35,9 @@ Scenario: Specify with technology guarantee
   Then it should pass with output like:
   """
   graph Cluster {
+    "Cluster Legend" \[label = "T - Technology
+  R - Resources
+  E - Environment", shape = "box"\];
     Sparta \[label = "Sparta
   T2 R0 E-1"\];
     Athens \[label = "Athens
@@ -79,6 +85,9 @@ Scenario: Specify different attributes
   Then it should pass with output like:
   """
   graph Cluster {
+    "Cluster Legend" \[label = "M - Magic
+  R - Religion
+  S - Science", shape = "box"\];
     A \[label = "A
   M-?\d R-?\d S-?\d"\];
     B \[label = "B
@@ -115,6 +124,19 @@ Scenario: Specify different attributes with prefix override
     C -- D
     D -- E
   """
+
+@wip
+Scenario: Specify different attributes with guarantee
+  When I run `diaspora-cluster attributes="Knights,Dragons,Maidens" guarantee="2 Knights @ 2 and 2 Dragons @ -3" names="Sparta {K1},Athens {K1}"`
+  Then it should pass with output like:
+  """
+  graph Cluster {
+    Sparta \[label = "Sparta
+  K2 D-3 M-?\d"\];
+    Athens \[label = "Athens
+  K2 D-3 M-?\d"\];
+    Sparta -- Athens
+  """
   
 Scenario: Specify different attributes with default
   When I run `diaspora-cluster names="Sparta{M5},Athens{R-5}" attributes="Magic, Religion, Science"`

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

@@ -0,0 +1,8 @@
+module Diaspora
+  module Cluster
+    module Creator
+      module Conversions
+      end
+    end
+  end
+end

data/lib/diaspora-cluster-creator/{edge_drawer.rb → edge_collection_factory.rb}

@@ -1,7 +1,7 @@
 module Diaspora
   module Cluster
     module Creator
-      class EdgeDrawer
+      class EdgeCollectionFactory
         extend DependencyInjector
         def_injector(:dice) { FateDice.new }
         attr_reader :cluster
@@ -9,7 +9,7 @@ module Diaspora
           @cluster = cluster
         end
         
-        def draw(nodes)
+        def build_from(nodes)
           return @edges if @edges
           nodes.each_with_index do |node, i|
             result = dice.roll

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

@@ -3,6 +3,9 @@ require 'set'
 require_relative 'fate_dice'
 require_relative 'node_attribute'
 
+# TODO: Need to write NodeAttribute collection class; the frequent
+# use of attributes.detect smells bad.
+
 module Diaspora
   module Cluster
     module Creator

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

@@ -2,11 +2,37 @@ require 'graphviz'
 module Diaspora
   module Cluster
     module Creator
+      module Conversions
+        module Legend
+          def to_legend
+            if respond_to?(:prefix)
+              "#{prefix} - #{to_s}"
+            else
+              to_s
+            end
+          end
+        end
+        private
+        def Legendary(item)
+          return item if item.kind_of?(Legend)
+          if item.is_a?(Array)
+            item.each {|i| i.extend(Legend) }
+            def item.to_legend
+              collect(&:to_legend).join("\n")
+            end
+          else
+            item.extend(Legend)
+          end
+          item
+        end
+      end
       class Template
+        include Conversions
         attr_reader :cluster
         def initialize(cluster)
           raise RuntimeError unless cluster.respond_to?(:each_node)
           raise RuntimeError unless cluster.respond_to?(:each_edge)
+          raise RuntimeError unless cluster.respond_to?(:attributes)
           @cluster = cluster
         end
         
@@ -26,6 +52,8 @@ module Diaspora
         def canvas
           return @canvas if @canvas
           @canvas = GraphViz.new(cluster.to_s, :type => :graph )
+          
+          @canvas.add_nodes('Cluster Legend', :label => Legendary(cluster.attributes).to_legend, :shape => 'box')
 
           cluster.each_node do |node|
             options = {}

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

@@ -1,7 +1,7 @@
 module Diaspora
   module Cluster
     module Creator
-      VERSION = "0.3.0"
+      VERSION = "0.4.0"
     end
   end
 end

data/spec/diaspora-cluster-creator/{edge_drawer_spec.rb → edge_collection_factory_spec.rb}

@@ -1,15 +1,15 @@
 require_relative '../spec_helper_lite'
-require 'edge_drawer'
+require 'edge_collection_factory'
 
-describe EdgeDrawer do
-  subject { EdgeDrawer.new(context)}
+describe EdgeCollectionFactory do
+  subject { EdgeCollectionFactory.new(context)}
   let(:context) { Object.new }
   
-  describe '#draw' do
+  describe '#build_from' do
     it 'should return' do
       nodes = ['a','b','c']
       with_loaded_dice(0,subject) do
-        output = subject.draw(nodes)
+        output = subject.build_from(nodes)
         
         output.must_include ['a','b']
         output.must_include ['a','c']

data/spec/diaspora-cluster-creator/node_spec.rb

@@ -3,14 +3,6 @@ require 'node'
 require 'ostruct'
 
 describe Node do
-  class MockAttribute
-    attr_accessor :value, :to_sym, :prefix
-    def to_i; value; end
-    def value
-      @value.to_i
-    end
-  end
-    
   let(:attribute_builder) { lambda {|node,attribute| attribute } }
   let(:name) { 'Name' }
   subject {
@@ -22,9 +14,9 @@ describe Node do
     Object.new.tap do |obj|
       def obj.attributes
         [
-          MockAttribute.new.tap{|obj| obj.to_sym = :technology; obj.prefix = 'T'; obj.value = 1},
-          MockAttribute.new.tap{|obj| obj.to_sym = :resources; obj.prefix = 'R'; obj.value = 1},
-          MockAttribute.new.tap{|obj| obj.to_sym = :environment; obj.prefix = 'E'; obj.value = 1},
+          FactoryGirl.build(:attribute, :to_sym => :technology, :value => 1, :prefix => 'T'),
+          FactoryGirl.build(:attribute, :to_sym => :resources, :value => 1, :prefix => 'R'),
+          FactoryGirl.build(:attribute, :to_sym => :environment, :value => 1, :prefix => 'E'),
         ]
       end
     end
@@ -34,9 +26,9 @@ describe Node do
       Object.new.tap do |obj|
         def obj.attributes
           [
-            MockAttribute.new.tap{|obj| obj.to_sym = :knights; obj.prefix = 'K'; obj.value = 1},
-            MockAttribute.new.tap{|obj| obj.to_sym = :dragons; obj.prefix = 'D'; obj.value = 2},
-            MockAttribute.new.tap{|obj| obj.to_sym = :maidens; obj.prefix = 'M'; obj.value = 3},
+            FactoryGirl.build(:attribute, :to_sym => :knights, :prefix => 'K', :value => 1),
+            FactoryGirl.build(:attribute, :to_sym => :dragons, :prefix => 'D', :value => 2),
+            FactoryGirl.build(:attribute, :to_sym => :maidens, :prefix => 'M', :value => 3),
           ]
         end
       end

data/spec/diaspora-cluster-creator/template_spec.rb

@@ -1,10 +1,16 @@
 require_relative '../spec_helper_lite'
 require 'template'
+require 'ostruct'
 
 describe Template do
   subject { Template.new(graph) }
   let(:graph) {
     object = Object.new
+    def object.attributes
+      [
+        FactoryGirl.build(:attribute, :name => 'Name')
+      ]
+    end
     def object.each_node
       yield('a')
       yield('b')
@@ -23,6 +29,7 @@ describe Template do
       subject.to_s.must_equal(
       [
         %(graph #{graph.to_s.inspect} {),
+        %(  "Cluster Legend" [label = "N - Name", shape = "box"];),
         %(  a [label = "a"];),
         %(  b [label = "b"];),
         %(  c [label = "c"];),
@@ -33,4 +40,21 @@ describe Template do
       )
     end
   end
+  
+  describe 'Conversions' do
+    describe 'Legendary' do
+      it 'should append to_legend method' do
+        object = FactoryGirl.build(:attribute, :to_s => 'Shoe', :prefix => 'S')
+        self.extend(Conversions)
+        Legendary(object).to_legend.must_equal('S - Shoe')
+      end
+
+      it 'should append to_legend method' do
+        object1 = FactoryGirl.build(:attribute, :to_s => 'Shoe', :prefix => 'S')
+        object2 = FactoryGirl.build(:attribute, :to_s => 'Hair', :prefix => 'H')
+        self.extend(Conversions)
+        Legendary([object1,object2]).to_legend.must_equal("S - Shoe\nH - Hair")
+      end
+    end
+  end
 end

data/spec/factories.rb

@@ -0,0 +1,31 @@
+class AttributeInterface
+  attr_accessor :name
+  attr_writer :value, :prefix, :to_sym, :to_s, :to_i
+  
+  def to_sym
+    @to_sym || name.gsub(/\W+/,'_').downcase.to_sym
+  end
+  def prefix
+    @prefix || name.slice(0)
+  end
+  
+  def to_s
+    @to_s || name.to_s
+  end
+  
+  def to_i
+    @to_i || @value.to_i
+  end
+  
+  def value
+    (@value || 0).to_i
+  end
+end
+FactoryGirl.define do
+  sequence(:name) do |n|
+    "name_#{n}"
+  end
+  factory(:attribute, :class => AttributeInterface) do
+    name { FactoryGirl.generate(:name) }
+  end
+end

data/spec/spec_helper_lite.rb

@@ -2,8 +2,10 @@ gem 'minitest' # demand gem version
 require 'minitest/spec'
 require 'minitest/autorun'
 require 'ostruct'
+require 'factory_girl'
 $: << File.expand_path('../lib/diaspora-cluster-creator', File.dirname(__FILE__))
 require 'diaspora-cluster-creator'
+require_relative 'factories'
 
 # Cheating a bit to help tests be a bit more readable
 include Diaspora::Cluster::Creator

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diaspora-cluster-creator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &2151894880 !ruby/object:Gem::Requirement
+  requirement: &2152626040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151894880
+  version_requirements: *2152626040
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2151894400 !ruby/object:Gem::Requirement
+  requirement: &2152625020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151894400
+  version_requirements: *2152625020
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2151893780 !ruby/object:Gem::Requirement
+  requirement: &2152624240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151893780
+  version_requirements: *2152624240
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2151893300 !ruby/object:Gem::Requirement
+  requirement: &2152623500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151893300
+  version_requirements: *2152623500
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &2151892780 !ruby/object:Gem::Requirement
+  requirement: &2152622660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151892780
+  version_requirements: *2152622660
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &2151892140 !ruby/object:Gem::Requirement
+  requirement: &2152621640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151892140
+  version_requirements: *2152621640
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
-  requirement: &2151891540 !ruby/object:Gem::Requirement
+  requirement: &2152620600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151891540
+  version_requirements: *2152620600
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &2151891000 !ruby/object:Gem::Requirement
+  requirement: &2152619660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151891000
+  version_requirements: *2152619660
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &2151890480 !ruby/object:Gem::Requirement
+  requirement: &2152618940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151890480
+  version_requirements: *2152618940
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &2151889940 !ruby/object:Gem::Requirement
+  requirement: &2152618440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151889940
+  version_requirements: *2152618440
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: &2152617900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152617900
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
-  requirement: &2151889460 !ruby/object:Gem::Requirement
+  requirement: &2152617280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +142,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2151889460
+  version_requirements: *2152617280
 - !ruby/object:Gem::Dependency
   name: main
-  requirement: &2151888940 !ruby/object:Gem::Requirement
+  requirement: &2152616440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +153,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2151888940
+  version_requirements: *2152616440
 - !ruby/object:Gem::Dependency
   name: dependency_injector
-  requirement: &2151888460 !ruby/object:Gem::Requirement
+  requirement: &2152615640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,7 +164,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2151888460
+  version_requirements: *2152615640
 description: Command-line utility to create Diaspora cluster
 email:
 - jeremy.n.friesen@gmail.com
@@ -169,7 +180,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- TODO.todo
 - bin/diaspora-cluster
 - diaspora-cluster-creator.gemspec
 - features/cluster.feature
@@ -189,7 +199,8 @@ files:
 - lib/diaspora-cluster-creator/attribute.rb
 - lib/diaspora-cluster-creator/attribute_collection_factory.rb
 - lib/diaspora-cluster-creator/cluster.rb
-- lib/diaspora-cluster-creator/edge_drawer.rb
+- lib/diaspora-cluster-creator/conversions.rb
+- lib/diaspora-cluster-creator/edge_collection_factory.rb
 - lib/diaspora-cluster-creator/fate_dice.rb
 - lib/diaspora-cluster-creator/guarantor.rb
 - lib/diaspora-cluster-creator/node.rb
@@ -200,7 +211,7 @@ files:
 - spec/diaspora-cluster-creator/attribute_collection_factory_spec.rb
 - spec/diaspora-cluster-creator/attribute_spec.rb
 - spec/diaspora-cluster-creator/cluster_spec.rb
-- spec/diaspora-cluster-creator/edge_drawer_spec.rb
+- spec/diaspora-cluster-creator/edge_collection_factory_spec.rb
 - spec/diaspora-cluster-creator/fate_dice_spec.rb
 - spec/diaspora-cluster-creator/guarantor_spec.rb
 - spec/diaspora-cluster-creator/node_attribute_spec.rb
@@ -208,6 +219,7 @@ files:
 - spec/diaspora-cluster-creator/node_spec.rb
 - spec/diaspora-cluster-creator/template_integration_spec.rb
 - spec/diaspora-cluster-creator/template_spec.rb
+- spec/factories.rb
 - spec/spec_helper_lite.rb
 homepage: ''
 licenses: []
@@ -250,7 +262,7 @@ test_files:
 - spec/diaspora-cluster-creator/attribute_collection_factory_spec.rb
 - spec/diaspora-cluster-creator/attribute_spec.rb
 - spec/diaspora-cluster-creator/cluster_spec.rb
-- spec/diaspora-cluster-creator/edge_drawer_spec.rb
+- spec/diaspora-cluster-creator/edge_collection_factory_spec.rb
 - spec/diaspora-cluster-creator/fate_dice_spec.rb
 - spec/diaspora-cluster-creator/guarantor_spec.rb
 - spec/diaspora-cluster-creator/node_attribute_spec.rb
@@ -258,4 +270,5 @@ test_files:
 - spec/diaspora-cluster-creator/node_spec.rb
 - spec/diaspora-cluster-creator/template_integration_spec.rb
 - spec/diaspora-cluster-creator/template_spec.rb
+- spec/factories.rb
 - spec/spec_helper_lite.rb

data/TODO.todo

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