yuml 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08d748325a616407967febe42befb19be51ca4b6
-  data.tar.gz: 3366bcee2cb3dd6009a426a4e5114859ecaa5003
+  metadata.gz: d301a5a94555df94b0aeb705e58c0e18d10b2f29
+  data.tar.gz: 2058b126b7b21ff0e81b627ec18b533f6aa6d171
 SHA512:
-  metadata.gz: b7720f885df0dd8fe38d71223c7c8e221d30fc867435fde0e8554cba425413e5790dd8abd5d2c04f8d99c2930dbe1d996cfbba85926378ea0ee8fc75f3de7cd5
-  data.tar.gz: 11ff15392add8a1c50919e6badddd4bedc8996573958cd12e55c383b04d52430c0c592c25c29f16c717c488e35905b11f5345e648fd650c847e231604e8a7ddb
+  metadata.gz: 01756670bbb5f097a1e90fcbb872483ccc09156b923928da5d2850d811873d688c78355d3e86655d8cff1d67d6ee3773bb7c2d26f51ba8904eec0c24a91e959e
+  data.tar.gz: 7ea6a585f33b5edf0c521ea7f017271cdbd5c0f3d70782cf64aa6ab13ec6dc2cdcc29d322ea5c2f7ebba3b2075e3d3cf589bae42cbd1f928446412effe8b161b

data/README.md

@@ -1,10 +1,10 @@
-# yuml
+# The UML DSL
 
-A Ruby DSL for generating UML built on yuml.me
+A Ruby DSL for generating UML built on yuml.me, visit the [homepage](http://derekstride.io/yuml/) to learn more.
 
 ## Getting Started
 
-To build a UML document start with this block of code. Everything inside the block will be used to descibe the uml document you want to create.
+To build a UML document start with this block of code. Everything inside the block will be used to describe the uml document you want to create.
 
 ```ruby
 YUML.generate(file: 'tmp.pdf') do |uml|
@@ -16,13 +16,10 @@ 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(name = nil)` (required)
-* `interface(interface = nil, sterotype = 'interface')`*
+* `name(name = nil, prototype = nil)` (required)
 * `variables(*args)`
 * `methods(*args)`
 
-\*use `interface` in place of `name` when generating an interface
-
 #### Example
 
 ```ruby
@@ -39,7 +36,7 @@ end
 
 ```ruby
 shape = uml.class do
-  interface 'Shape', 'module'
+  name 'Shape', 'module'
   methods '+draw(id: int, content: String, style: Symbol)'
 end
 ```
@@ -66,13 +63,13 @@ document.has_a(picture, cardinality: '0..*')
 document.is_a(content)
 
 picture.is_a(content, type: :interface)
-content.associated_with(content, type: dependency)
-document.attach_note('This is a document', color: :green)
+content.associated_with(content, type: :association, cardinality: %w(uses used))
+document.attach_note('This is a document', 'green')
 ```
 
 ### Adding notes
 
-You can add notes too the document itself as well as attached to class
+You can add notes to the document itself as well as attached to a class
 
 ```ruby
 YUML.generate(file: 'tmp.pd') do |uml|

data/lib/yuml/class.rb

@@ -9,21 +9,16 @@ module YUML
       @relationships = []
     end
 
-    def name(name = nil)
+    def name(name = nil, prototype = nil)
       @name = name if name
-      "#{normalized_interface}#{@name}"
+      @prototype = prototype if prototype
+      "#{normalized_prototype}#{@name}"
     end
 
-    def interface(interface = nil, sterotype = 'interface')
-      @interface = interface if interface
-      @sterotype = sterotype if interface
-      @interface
-    end
-
-    def interface=(*args)
+    def name=(*args)
       args.flatten!
-      @interface = args.first
-      @sterotype = args.size > 1 ? args.pop : 'interface'
+      @name = args.first
+      @prototype = args.pop if args.size > 1
     end
 
     def variables(*args)
@@ -79,9 +74,8 @@ module YUML
       end
     end
 
-    def normalized_interface
-      name interface unless @name
-      return normalize(["<<#{@sterotype}>>"]).first << ';' if interface
+    def normalized_prototype
+      return normalize(["<<#{@prototype}>>"]).first << ';' if @prototype
     end
 
     def attributes(attrs)

data/spec/yuml_class_spec.rb

@@ -26,45 +26,32 @@ describe YUML::Class do
   end
 
   describe '#name' do
-    it 'takes a name and updates the class' do
-      @uut.name 'Document'
-      expect(@uut.to_s).to eq '[Document]'
-    end
-
-    it 'should work with name= as well' do
-      @uut.name = 'Document'
-      expect(@uut.to_s).to eq '[Document]'
-    end
-  end
-
-  describe '#interface' do
     before :all do
       left = "#{YUML::ESCAPE_CHARACTERS['<']}" * 2
       right = "#{YUML::ESCAPE_CHARACTERS['>']}" * 2
-      @interface_uml = "[#{left}interface#{right};Document]"
       @module_uml = "[#{left}module#{right};Document]"
     end
 
-    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
+    context 'without a prototype' do
+      it 'takes a name and updates the class' do
+        @uut.name 'Document'
+        expect(@uut.to_s).to eq '[Document]'
       end
 
-      it 'should work with interface=' do
-        @uut.interface = 'Document'
-        expect(@uut.to_s).to eq @interface_uml
+      it 'should work with name= as well' do
+        @uut.name = 'Document'
+        expect(@uut.to_s).to eq '[Document]'
       end
     end
 
-    context 'with custom sterotype' do
-      it 'takes an interface and updates the class' do
-        @uut.interface 'Document', 'module'
+    context 'with a prototype' do
+      it 'takes a name and updates the class' do
+        @uut.name 'Document', 'module'
         expect(@uut.to_s).to eq @module_uml
       end
 
-      it 'should work with interface=' do
-        @uut.interface = 'Document', 'module'
+      it 'should work with name= as well' do
+        @uut.name = 'Document', 'module'
         expect(@uut.to_s).to eq @module_uml
       end
     end
@@ -121,7 +108,7 @@ describe YUML::Class do
     end
 
     it 'should handle interfaces' do
-      @pic.interface 'Picture'
+      @pic.name 'Picture', 'interface'
       @doc.is_a(@pic, type: :interface)
       left = "#{YUML::ESCAPE_CHARACTERS['<']}" * 2
       right = "#{YUML::ESCAPE_CHARACTERS['>']}" * 2

metadata

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