yuml 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6ddb73f6188b78f0c8993ae7c3d43fb0a23a1a3
-  data.tar.gz: 1a751eb056f3b131d9a2c811889788d3c1ff981d
+  metadata.gz: 99b5862e06b3aa1de18dfeb4ee79d1e4c126d27c
+  data.tar.gz: 2a417c8ffb3950322453492712e8fb3271ba6de6
 SHA512:
-  metadata.gz: a3cf60e22f95ec592cd24a2e1bbd91c4bbdeb6e77bde82e70cc98b6a24a7c33ce1e87fb00d0b95bf0a46e62a396488cb248d5315fcd50a2b837dd2f87bb4d07a
-  data.tar.gz: 4f05dca0218587e339774ba7e8faf990b5afe8ca7b145b2249251bc641302439601b9d0604249bee5837a5fa6a3e130e26f3e1771263bdc4a2b924f36791b75c
+  metadata.gz: 6711c541ea638decf9ce1e9d52980b1a5ec1402fbe216223dd3cc4acf0e81a21e66fd5b383b544a7506ec864652cff795c16ce4d0112a9885d2097da4fb969d4
+  data.tar.gz: f0921550ab9e6a33c437210cec7770c760cfc32d58b0c0ac5dc31f9793b2b77c59412298b593ff1320e53ed236be635c0cd753798a4cd0297f14185e2eb54a54

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Derek Stride
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# yuml
+
+A Ruby DSL for generating UML built on yuml.me
+
+## 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.
+
+```ruby
+YUML.generate(file: 'tmp.pdf') do |uml|
+  ...
+end
+```
+
+### Generating a Class
+
+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
+
+#### Example
+
+```ruby
+document = uml.class do
+  name 'Document'
+  variables '-title: String', '-body: String'
+  methods(
+    '+add_section(id: int, content: String, style: Symbol)',
+    '+remove_section(id: int)',
+    '+edit_section(id: int, content: String, style: Symbol)'
+  )
+end
+```
+
+### Adding Relationships
+
+After generating some classes to add relationships to them use the following `YUML::Class` methods.
+
+* `has_a(node, options = {})`
+* `is_a(node, options = {})`
+* `associated_with(node, options = {})`
+* `attach_note(content, options = {})` *options include color!
+
+`has_a` can be **composition** or **aggregation** but defaults to aggregation.
+
+`is_a` can be **inheritance** or **interface** but defaults to inheritance.
+
+`associated_with` can be **association**, **directed_association**, **two_way_association**, or **dependancy** but defaults to directed_association.
+
+#### Example
+
+```ruby
+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)
+```
+
+### Adding notes
+
+You can add notes too the document itself as well as attached to class
+
+```ruby
+YUML.generate(file: 'tmp.pd') do |uml|
+  uml.attach_note('Cool UML Tool?')
+end
+```
+
+
+### Test it Out
+
+```ruby
+require 'yuml'
+
+YUML.generate(file: 'example.pdf') do |uml|
+  document = uml.class do
+    name 'Document'
+    variables '-title: String', '-body: String'
+    methods(
+      '+add_section(id: int, content: String, style: Symbol)',
+      '+remove_section(id: int)',
+      '+edit_section(id: int, content: String, style: Symbol)'
+    )
+  end
+
+  picture = uml.class do
+    name 'Picture'
+  end
+
+  content = uml.class do
+    name 'Content'
+  end
+
+  document.has_a(picture, cardinality: '0..*')
+  document.is_a(content)
+
+  picture.is_a(content)
+end
+```
+
+![output](https://cloud.githubusercontent.com/assets/6456191/13322710/bc91e81c-dba3-11e5-88d3-16e1980f7cb4.png)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.fail_on_error = false
+end

data/lib/yuml.rb

@@ -13,7 +13,8 @@ module YUML
     '}' => "\u23AC",
     '<' => "\u3008",
     '>' => "\u3009",
-    ',' => "\u201A"
+    ',' => "\u201A",
+    '#' => "\u0023"
   }
 
   def generate(options)

data/lib/yuml/class.rb

@@ -1,7 +1,7 @@
 module YUML
   # Represents a yUML Class
   class Class
-    attr_writer :name
+    attr_writer :name, :interface
 
     def initialize
       @methods = []
@@ -11,7 +11,12 @@ module YUML
 
     def name(name = nil)
       @name = name if name
-      @name
+      "#{normalized_interface}#{@name}"
+    end
+
+    def interface(interface = nil)
+      @interface = interface if interface
+      @interface
     end
 
     def variables(*args)
@@ -67,6 +72,11 @@ module YUML
       end
     end
 
+    def normalized_interface
+      name interface unless @name
+      return normalize(['<<interface>>']).first << ';' if interface
+    end
+
     def attributes(attrs)
       "|#{attrs.join(';')}" unless attrs.empty?
     end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'webmock/rspec'
+require 'fakefs/spec_helpers'
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/yuml_class_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+require_relative '../lib/yuml'
+
+describe YUML::Class do
+  before :each do
+    @uut = YUML::Class.new
+    @doc = YUML.class do |c|
+      c.name 'Document'
+      c.variables('+foo', '+bar')
+      c.methods(
+        '+foo(name, other = nil)',
+        '+bar()'
+      )
+    end
+    @pic = YUML.class do |c|
+      c.name 'Picture'
+      c.methods('+bar()')
+      c.variables('-foo')
+    end
+  end
+
+  describe '#new' do
+    it 'takes no parameters and returns a YUML::Class object' do
+      expect(@uut).to be_an_instance_of(YUML::Class)
+    end
+  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]"
+    end
+    it 'takes a interface and updates the class' do
+      @uut.interface 'Document'
+      expect(@uut.to_s).to eq @interface_uml
+    end
+
+    it 'should work with interface= as well' do
+      @uut.interface = 'Document'
+      expect(@uut.to_s).to eq @interface_uml
+    end
+  end
+
+  describe '#variables' do
+    before :each do
+      @uut.name 'Document'
+    end
+
+    it 'takes symbols and adds it to the class' do
+      @uut.variables(:foo, :bar)
+      expect(@uut.to_s).to eq '[Document|foo;bar]'
+    end
+
+    it 'takes strings and adds it to the class' do
+      @uut.variables('+foo:String', '-bar:int')
+      expect(@uut.to_s).to eq '[Document|+foo:String;-bar:int]'
+    end
+  end
+
+  describe '#methods' do
+    it 'takes an array of symbols and adds it to the class' do
+      @uut.name 'Document'
+      @uut.methods(
+        '+foo(name, other = nil)',
+        '-bar()'
+      )
+      expect(@uut.to_s).to eq "[Document|+foo(name#{YUML::ESCAPE_CHARACTERS[',']} other = nil);-bar()]"
+    end
+  end
+
+  describe '#has_a' do
+    it 'should handle aggregation' do
+      @doc.has_a(@pic)
+      expect(@doc.relationships).to eq '[Document]+->[Picture]'
+    end
+
+    it 'should handle cardinality' do
+      @doc.has_a(@pic, cardinality: '*')
+      expect(@doc.relationships).to eq '[Document]+-*>[Picture]'
+    end
+
+    it 'should handle composition and cardinality' do
+      @doc.has_a(@pic, type: :composition, cardinality: [0, '*'])
+      expect(@doc.relationships).to eq '[Document]++0-*>[Picture]'
+    end
+  end
+
+  describe '#is_a' do
+    it 'should handle inheritance' do
+      @doc.is_a(@pic, type: :inheritance)
+      expect(@doc.relationships).to eq '[Picture]^-[Document]'
+    end
+
+    it 'should handle interfaces' do
+      @pic.interface 'Picture'
+      @doc.is_a(@pic, type: :interface)
+      left = "#{YUML::ESCAPE_CHARACTERS['<']}" * 2
+      right = "#{YUML::ESCAPE_CHARACTERS['>']}" * 2
+      expect(@doc.relationships).to eq "[#{left}interface#{right};Picture]^-.-[Document]"
+    end
+  end
+
+  describe '#associated_with' do
+    it 'should handle a default association' do
+      @doc.associated_with(@pic)
+      expect(@doc.relationships).to eq '[Document]->[Picture]'
+    end
+
+    it 'should handle an association with cardinality' do
+      @doc.associated_with(@pic, cardinality: %w(uses used))
+      expect(@doc.relationships).to eq '[Document]uses-used>[Picture]'
+    end
+
+    it 'should handle a bi directional associations with cardinality' do
+      @doc.associated_with(@pic, type: :two_way_association, cardinality: ['used by'])
+      expect(@doc.relationships).to eq '[Document]<-used by>[Picture]'
+    end
+
+    it 'should handle a undirected association' do
+      @doc.associated_with(@pic, type: :association, cardinality: ['used by'])
+      expect(@doc.relationships).to eq '[Document]-used by[Picture]'
+    end
+
+    it 'should handle a dependency' do
+      @doc.associated_with(@pic, type: :dependency, cardinality: %w(uses used))
+      expect(@doc.relationships).to eq '[Document]uses-.-used>[Picture]'
+    end
+  end
+
+  describe '#attach_note' do
+    it 'should add a note to the relationships' do
+      @doc.attach_note('This diagram blongs to Derek Stride')
+      expect(@doc.relationships).to eq '[Document]-[note: This diagram blongs to Derek Stride{bg:cornsilk}]'
+    end
+  end
+end

data/spec/yuml_note_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+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)
+      expect(note).to eq '[note: This diagram blongs to Derek Stride{bg:green}]'
+    end
+  end
+end

data/spec/yuml_relationship_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+require_relative '../lib/yuml'
+
+describe YUML::Relationship do
+  describe '#inheritance' do
+    it 'should return the default inheritance relationship' do
+      expect(YUML::Relationship.inheritance).to eq '^-'
+    end
+  end
+
+  describe '#interface' do
+    it 'should return the default interface relationship' do
+      expect(YUML::Relationship.interface).to eq '^-.-'
+    end
+  end
+
+  describe '#composition' do
+    it 'should return the default composition relationship' do
+      expect(YUML::Relationship.composition).to eq '++->'
+    end
+
+    it 'should handle a single cardinality' do
+      expect(YUML::Relationship.composition('*')).to eq '++-*>'
+    end
+
+    it 'should handle a two sided cardinality' do
+      expect(YUML::Relationship.composition('1', '*')).to eq '++1-*>'
+    end
+  end
+
+  describe '#aggregation' do
+    it 'should return the default aggregation relationship' do
+      expect(YUML::Relationship.aggregation).to eq '+->'
+    end
+
+    it 'should handle a single cardinality' do
+      expect(YUML::Relationship.aggregation('*')).to eq '+-*>'
+    end
+
+    it 'should handle a two sided cardinality' do
+      expect(YUML::Relationship.aggregation('1', '*')).to eq '+1-*>'
+    end
+  end
+
+  describe '#association' do
+    it 'should return the default association relationship' do
+      expect(YUML::Relationship.association).to eq '-'
+    end
+
+    it 'should handle a single cardinality' do
+      expect(YUML::Relationship.association('*')).to eq '-*'
+    end
+
+    it 'should handle a two sided cardinality' do
+      expect(YUML::Relationship.association('1', '*')).to eq '1-*'
+    end
+  end
+
+  describe '#two_way_association' do
+    it 'should return the default two_way_association relationship' do
+      expect(YUML::Relationship.two_way_association).to eq '<->'
+    end
+
+    it 'should handle a single cardinality' do
+      expect(YUML::Relationship.two_way_association('*')).to eq '<-*>'
+    end
+
+    it 'should handle a two sided cardinality' do
+      expect(YUML::Relationship.two_way_association('1', '*')).to eq '<1-*>'
+    end
+  end
+
+  describe '#directed_assoication' do
+    it 'should return the default directed_assoication relationship' do
+      expect(YUML::Relationship.directed_assoication).to eq '->'
+    end
+
+    it 'should handle a single cardinality' do
+      expect(YUML::Relationship.directed_assoication('*')).to eq '-*>'
+    end
+
+    it 'should handle a two sided cardinality' do
+      expect(YUML::Relationship.directed_assoication('1', '*')).to eq '1-*>'
+    end
+  end
+
+  describe '#dependency' do
+    it 'should return the default dependency relationship' do
+      expect(YUML::Relationship.dependency).to eq '-.->'
+    end
+
+    it 'should handle a single cardinality' do
+      expect(YUML::Relationship.dependency('*')).to eq '-.-*>'
+    end
+
+    it 'should handle a two sided cardinality' do
+      expect(YUML::Relationship.dependency('1', '*')).to eq '1-.-*>'
+    end
+  end
+end

data/spec/yuml_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require_relative '../lib/yuml'
+
+describe YUML do
+  before :all do
+    @doc_uml = "[Document|+foo;+bar|+foo(name#{YUML::ESCAPE_CHARACTERS[',']} other = nil);+bar()]"
+  end
+
+  before :each do
+    @uut = YUML.class do |c|
+      c.name 'Document'
+      c.variables('+foo', '+bar')
+      c.methods('+foo(name, other = nil)', '+bar()')
+    end
+  end
+
+  describe '#class' do
+    it 'should return a YUML::Class' do
+      expect(@uut).to be_an_instance_of YUML::Class
+    end
+
+    context 'it should work when given an arity > 0' do
+      it 'takes a block and builds a YUML::Class' do
+        expect(@uut.to_s).to eq @doc_uml
+      end
+    end
+
+    context 'it should work when given with instance_eval' do
+      it 'takes a block and builds a YUML::Class' do
+        doc = YUML.class do
+          name 'Document'
+          variables('+foo', '+bar')
+          methods('+foo(name, other = nil)', '+bar()')
+        end
+        expect(doc.to_s).to eq @doc_uml
+      end
+    end
+  end
+
+  describe '#generate' do
+    include FakeFS::SpecHelpers
+
+    before :all do
+      @options = { file: 'test.pdf' }
+    end
+
+    before :each do
+      @stub = stub_request(:any, %r{http://yuml.me/.*}).to_return(body: 'abc', status: 200)
+    end
+
+    it 'should yield the block' do
+      expect { |b| YUML.generate(@options, &b) }.to(yield_control.once)
+    end
+
+    it 'should make the api call' do
+      YUML.generate(@options) do |uml|
+        uml.class do
+          name 'Document'
+        end
+      end
+      expect(@stub).to have_been_requested
+    end
+
+    it 'should write the contents to a file' do
+      YUML.generate(@options) do |uml|
+        uml.class do
+          name 'Document'
+        end
+      end
+      expect(File.exist?(@options[:file])).to be true
+      expect(File.read(@options[:file])).to eq 'abc'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yuml
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Derek Stride
@@ -30,10 +30,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- Rakefile
 - lib/yuml.rb
 - lib/yuml/class.rb
 - lib/yuml/note.rb
 - lib/yuml/relationship.rb
+- spec/spec_helper.rb
+- spec/yuml_class_spec.rb
+- spec/yuml_note_spec.rb
+- spec/yuml_relationship_spec.rb
+- spec/yuml_spec.rb
 homepage: https://github.com/DerekStride/yuml
 licenses:
 - MIT