yuml 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 309834061e6f7f3f42c926fe7a57261a3d72cd7b
-  data.tar.gz: 9c681e097d910258cf71ede0f49fb892e09dfdbf
+  metadata.gz: 08d748325a616407967febe42befb19be51ca4b6
+  data.tar.gz: 3366bcee2cb3dd6009a426a4e5114859ecaa5003
 SHA512:
-  metadata.gz: f009740b9a5333ec255bd2e1401102ab557766935dbd8aeefea58ee344c03bc0bd15d86c12f2ac23b0ef1fb88d497196878eba363e691fb533f85994891dfbe1
-  data.tar.gz: af3d8b66b1870167705f33adf42e0e8ee2fa094031e7108a227ea239e90365e8649d0b284b420eafe34fbd1963fa38ab637a31ff22cb01649203299a1b02cc77
+  metadata.gz: b7720f885df0dd8fe38d71223c7c8e221d30fc867435fde0e8554cba425413e5790dd8abd5d2c04f8d99c2930dbe1d996cfbba85926378ea0ee8fc75f3de7cd5
+  data.tar.gz: 11ff15392add8a1c50919e6badddd4bedc8996573958cd12e55c383b04d52430c0c592c25c29f16c717c488e35905b11f5345e648fd650c847e231604e8a7ddb

data/README.md

@@ -16,9 +16,12 @@ end
 
 To generate a class for the document use `uml.class` and pass a code block in to configure it. It accepts the following methods for configuration.
 
-* name (required)
-* variables
-* methods
+* `name(name = nil)` (required)
+* `interface(interface = nil, sterotype = 'interface')`*
+* `variables(*args)`
+* `methods(*args)`
+
+\*use `interface` in place of `name` when generating an interface
 
 #### Example
 
@@ -34,6 +37,13 @@ document = uml.class do
 end
 ```
 
+```ruby
+shape = uml.class do
+  interface 'Shape', 'module'
+  methods '+draw(id: int, content: String, style: Symbol)'
+end
+```
+
 ### Adding Relationships
 
 After generating some classes to add relationships to them use the following `YUML::Class` methods.

data/lib/yuml.rb

@@ -17,12 +17,11 @@ module YUML
     '#' => "\u0023"
   }
 
-  def generate(options)
-    options = { file: '/tmp/yuml.pdf' }.merge(options)
+  def generate(file: '/tmp/yuml.pdf')
     classes.clear
     notes.clear
     yield self
-    fetch_uml options[:file]
+    fetch_uml file
   end
 
   def class(&block)
@@ -32,8 +31,8 @@ module YUML
     yuml_class
   end
 
-  def attach_note(content, options = {})
-    notes << YUML::Note.create(content, options)
+  def attach_note(content, color = nil)
+    notes << YUML::Note.create(content, color)
   end
 
   private

data/lib/yuml/class.rb

@@ -1,7 +1,7 @@
 module YUML
   # Represents a yUML Class
   class Class
-    attr_writer :name, :interface
+    attr_writer :name
 
     def initialize
       @methods = []
@@ -14,11 +14,18 @@ module YUML
       "#{normalized_interface}#{@name}"
     end
 
-    def interface(interface = nil)
+    def interface(interface = nil, sterotype = 'interface')
       @interface = interface if interface
+      @sterotype = sterotype if interface
       @interface
     end
 
+    def interface=(*args)
+      args.flatten!
+      @interface = args.first
+      @sterotype = args.size > 1 ? args.pop : 'interface'
+    end
+
     def variables(*args)
       args.flatten!
       return attributes(@variables) if args.empty?
@@ -31,28 +38,28 @@ module YUML
       @methods << normalize(args)
     end
 
-    def has_a(dest, options = {})
-      options[:type] = :aggregation unless %i(composition aggregation).include?(options[:type])
-      relationship = YUML::Relationship.send(options[:type], options[:cardinality])
+    def has_a(dest, type: :aggregation, cardinality: nil)
+      type = :aggregation unless %i(composition aggregation).include?(type)
+      relationship = YUML::Relationship.send(type, cardinality)
       @relationships << "[#{name}]#{relationship}[#{dest.name}]"
     end
 
-    def is_a(dest, options = {})
-      options[:type] = :inheritance unless %i(inheritance interface).include?(options[:type])
-      relationship = YUML::Relationship.send(options[:type])
+    def is_a(dest, type: :inheritance)
+      type = :inheritance unless %i(inheritance interface).include?(type)
+      relationship = YUML::Relationship.send(type)
       @relationships << "[#{dest.name}]#{relationship}[#{name}]"
     end
 
-    def associated_with(dest, options = {})
-      options[:type] = :directed_assoication unless %i(
+    def associated_with(dest, type: :directed_assoication, cardinality: nil)
+      type = :directed_assoication unless %i(
         association directed_assoication two_way_association dependency
-      ).include?(options[:type])
-      relationship = YUML::Relationship.send(options[:type], options[:cardinality])
+      ).include?(type)
+      relationship = YUML::Relationship.send(type, cardinality)
       @relationships << "[#{name}]#{relationship}[#{dest.name}]"
     end
 
-    def attach_note(content, options = {})
-      @relationships << "[#{name}]-#{YUML::Note.create(content, options)}"
+    def attach_note(content, color = nil)
+      @relationships << "[#{name}]-#{YUML::Note.create(content, color)}"
     end
 
     def to_s
@@ -74,7 +81,7 @@ module YUML
 
     def normalized_interface
       name interface unless @name
-      return normalize(['<<interface>>']).first << ';' if interface
+      return normalize(["<<#{@sterotype}>>"]).first << ';' if interface
     end
 
     def attributes(attrs)

data/lib/yuml/note.rb

@@ -3,9 +3,8 @@ module YUML
   module Note
     module_function
 
-    def create(body, options = {})
-      color = options[:color] || 'cornsilk'
-      "[note: #{body}{bg:#{color}}]"
+    def create(body, color = 'cornsilk')
+      "[note: #{body}{bg:#{color || 'cornsilk'}}]"
     end
   end
 end

data/spec/yuml_class_spec.rb

@@ -42,15 +42,31 @@ describe YUML::Class do
       left = "#{YUML::ESCAPE_CHARACTERS['<']}" * 2
       right = "#{YUML::ESCAPE_CHARACTERS['>']}" * 2
       @interface_uml = "[#{left}interface#{right};Document]"
+      @module_uml = "[#{left}module#{right};Document]"
     end
-    it 'takes a interface and updates the class' do
-      @uut.interface 'Document'
-      expect(@uut.to_s).to eq @interface_uml
+
+    context 'with default sterotype' do
+      it 'takes an interface and updates the class' do
+        @uut.interface 'Document'
+        expect(@uut.to_s).to eq @interface_uml
+      end
+
+      it 'should work with interface=' do
+        @uut.interface = 'Document'
+        expect(@uut.to_s).to eq @interface_uml
+      end
     end
 
-    it 'should work with interface= as well' do
-      @uut.interface = 'Document'
-      expect(@uut.to_s).to eq @interface_uml
+    context 'with custom sterotype' do
+      it 'takes an interface and updates the class' do
+        @uut.interface 'Document', 'module'
+        expect(@uut.to_s).to eq @module_uml
+      end
+
+      it 'should work with interface=' do
+        @uut.interface = 'Document', 'module'
+        expect(@uut.to_s).to eq @module_uml
+      end
     end
   end
 

data/spec/yuml_note_spec.rb

@@ -4,7 +4,7 @@ require_relative '../lib/yuml'
 describe YUML::Note do
   describe '#create' do
     it 'should return a formatted string' do
-      note = YUML::Note.create('This diagram blongs to Derek Stride', color: :green)
+      note = YUML::Note.create('This diagram blongs to Derek Stride', :green)
       expect(note).to eq '[note: This diagram blongs to Derek Stride{bg:green}]'
     end
   end

data/spec/yuml_spec.rb

@@ -71,4 +71,10 @@ describe YUML do
       expect(File.read(@options[:file])).to eq 'abc'
     end
   end
+
+  describe '#attach_note' do
+    it 'should work' do
+      expect { YUML.attach_note('test', 'green') }.not_to raise_error
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yuml
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Derek Stride
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-27 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec