yuml 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70cbfd4f9496ec8964919e65fc7730c111d76be9
-  data.tar.gz: 718ad5e932d5dafb9124c07a8c65b1d245e3a322
+  metadata.gz: 7e2be29a1f70df149897fb3a989fd9e2cd238c2a
+  data.tar.gz: 81759243732e3cbc3bdfd2aa91f8262b09fdd016
 SHA512:
-  metadata.gz: c1bfb8f6ecec58519b760a6cd252332aeffc23c2bdaba69f5c55905a89396a976376b0bd99b49053ccc9c95b39385e4d4ad97c5f4c8d785319cd84526ee94f48
-  data.tar.gz: 91679a843a383889543853577ab982b3a084a76efe0f21ee565bb9f74968513a777b3d7854b8d7078581c8f365830c91457663133cae058c647263c7f1b8ac19
+  metadata.gz: 57d0e5129d522935c1dc6ef5300d4a825c2534f897db5102dc7ba1627768c4136fc8364dbd9e09d11f2a4fe0120c6126a3a521711d7654be6bae7ad7671c29f0
+  data.tar.gz: c8399b330ec6b1c4982559b3a1523ab0fe86ddbd66eb239890339e097950e8ba524df1e6f1a8b1b60e785d404531101e5f6c9f3226515d2284ab8157772a7046

data/lib/yuml/class.rb

@@ -0,0 +1,104 @@
+module YUML
+  # Represents a yUML Class
+  class Class
+    attr_writer :name
+
+    def initialize
+      @methods = []
+      @variables = []
+      @relationships = []
+    end
+
+    def name(name = nil)
+      @name = name if name
+      @name
+    end
+
+    def public_methods(*args)
+      uml_methods('+', *args)
+    end
+
+    def private_methods(*args)
+      uml_methods('-', *args)
+    end
+
+    def public_variables(*args)
+      uml_variables('+', *args)
+    end
+
+    def private_variables(*args)
+      uml_variables('-', *args)
+    end
+
+    def has_a(dest, options = {})
+      relationship = YUML::Relationship.relationship(options)
+      @relationships << "[#{name}]#{relationship}[#{dest.name}]"
+    end
+
+    def is_a(dest, options = {})
+      options[:type] = :inheritance unless %i(inheritance interface).include?(options[:type])
+      relationship = YUML::Relationship.relationship(options)
+      @relationships << "[#{dest.name}]#{relationship}[#{name}]"
+    end
+
+    def to_s
+      "[#{name}#{variables}#{methods}]"
+    end
+
+    def relationships
+      "#{@relationships.join(',')}" unless @relationships.empty?
+    end
+
+    private
+
+    def normalize(values)
+      values.map(&:to_s).map do |v|
+        YUML::ESCAPE_CHARACTERS.each do |char, escape|
+          v.tr!(char, escape)
+        end
+        v
+      end.join("\u201A ")
+    end
+
+    def uml_variables(scope, *args)
+      args.each { |var| variable(scope: scope, attribute: var) }
+    end
+
+    def uml_methods(scope, *args)
+      args.each do |m|
+        if m.class == Hash
+          mets = m.map { |k, v| "#{k}(#{normalize(v)})" }
+          mets.each { |met| method(scope: scope, attribute: met) }
+        else
+          method(scope: scope, attribute: "#{m}()")
+        end
+      end
+    end
+
+    def method(options)
+      attribute(@methods, options)
+    end
+
+    def variable(options)
+      attribute(@variables, options)
+    end
+
+    def attribute(attributes, options)
+      scope = options[:scope] || '+'
+      scope = '+' unless %w(+ -).include?(scope)
+      attributes << "#{scope}#{options.fetch(:attribute)}"
+    end
+
+    def methods
+      attributes(@methods)
+    end
+
+    def variables
+      attributes(@variables)
+    end
+
+    def attributes(attrs)
+      "|#{attrs.join(';')}" unless attrs.empty?
+    end
+  end
+end

data/lib/yuml/relationship.rb

@@ -0,0 +1,43 @@
+# Represents a yUML relationship
+module YUML
+  module Relationship
+    extend self
+
+    def relationship(options)
+      options = { type: :aggregation }.merge(options)
+      types = %i(aggregation composition inheritance interface)
+      type = options[:type]
+      type = :aggregation unless types.include?(type)
+      cardinality = options[:cardinality]
+      representation(type, cardinality)
+    end
+
+    private
+
+    def representation(type, cardinality)
+      if %i(aggregation composition).include?(type)
+        return composition(type, cardinality)
+      elsif %i(inheritance interface).include?(type)
+        return inheritance(type)
+      end
+    end
+
+    def composition(type, cardinality)
+      base = '+'
+      base << '+' if type == :composition
+      if cardinality.nil?
+        base << '->'
+      elsif cardinality.class == Array && cardinality.length == 2
+        base << "#{cardinality[0]}-#{cardinality[1]}>"
+      else
+        base << "-#{cardinality}>"
+      end
+      base
+    end
+
+    def inheritance(type)
+      return '^-.-' if type == :interface
+      '^-'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yuml
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Derek Stride
@@ -31,6 +31,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/yuml.rb
+- lib/yuml/class.rb
+- lib/yuml/relationship.rb
 homepage: https://github.com/DerekStride/yuml
 licenses:
 - MIT