yuimaru 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b96ff775d7552bca0fc74a16ad7a3e8191dcdc9
+  data.tar.gz: 8fd3e0e67b2b30637020eda93f1c5eebee581b3a
+SHA512:
+  metadata.gz: f6293b6c4d9fd07cd21a0eafb76fb85bc01d84770b54072cbeb96ca0bfdff3f7021c9924efd44a87d8d03e2203773a173e9a1cf35ceb7422fd51d772ed5b6bc0
+  data.tar.gz: 3fcb5821acbcfeaf340a13a109b3bb46ebba340e4eea5d91b68c8e901c745416116c44591989b937fc4ecf9b119226ef8e952f467faf2b9d8a5953b33533f647

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at hanachin@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yuimaru.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Seiei Miyagi
+
+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,50 @@
+# Yuimaru
+
+Generates sequence diagram.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yuimaru'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yuimaru
+
+## Usage
+
+```rb
+# sample.rb
+"alice" >> "hi bob" >> "bob"
+"alice" << "hi alice" << "bob"
+"alice" >> "hi carol" >> "carol"
+"alice" << "hi alice" << "carol"
+```
+
+```console
+$ bin/yuimaru sample.rb
+```
+
+![sample.png](sample.png)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hanachin/yuimaru. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yuimaru"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/yuimaru

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yuimaru' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yuimaru", "yuimaru")

data/exe/yuimaru

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "yuimaru"
+
+opt = OptionParser.new
+opt.banner = "Usage: yuimaru file [options]"
+opt.on('-o output') {|v| @output = v }
+
+argv = opt.parse(ARGV)
+@output ||= File.basename(argv[0], '.*') + '.png'
+seq = Yuimaru.load_sequence(argv[0])
+seq.save(@output)

data/lib/yuimaru.rb

@@ -0,0 +1,45 @@
+require "yuimaru/version"
+require "yuimaru/message"
+require "yuimaru/dsl/default"
+require "yuimaru/sequence"
+
+module Yuimaru
+  class << self
+    attr_accessor :default_env
+
+    def sequence(seq, env: default_env)
+      add = -> (v) { current << v if v.is_a?(Yuimaru::Message) }
+      trace_var(:$_, add)
+
+      eval(seq, env)
+
+      Sequence.new(current)
+    ensure
+      untrace_var(:$_, add)
+      reset
+    end
+
+    def load_sequence(path, env: default_env)
+      seq = File.read(path)
+      sequence(seq)
+    end
+
+    def method_missing(name, *)
+      return super if /\A_+\z/ !~ name
+
+      current << []
+    end
+
+    private
+
+    def current
+      Thread.current[:yuimaru] ||= []
+    end
+
+    def reset
+      Thread.current[:yuimaru] = nil
+    end
+  end
+
+  Yuimaru.default_env =Yuimaru::Dsl::Default.env
+end

data/lib/yuimaru/dsl/default.rb

@@ -0,0 +1,25 @@
+require "yuimaru/message"
+
+module Yuimaru
+  module Dsl
+    module Default
+      class << self
+        attr_accessor :env
+      end
+
+      refine(String) do
+        def <<(name)
+          $_ = Message.new(nil, name, self)
+        end
+
+        def >>(name)
+          $_ = Message.new(self, name, nil)
+        end
+      end
+
+      using self
+
+      self.env = binding
+    end
+  end
+end

data/lib/yuimaru/message.rb

@@ -0,0 +1,11 @@
+module Yuimaru
+  class Message < Struct.new(:from, :name, :to)
+    def <<(from)
+      self.tap {|m| m.from = from }
+    end
+
+    def >>(to)
+      self.tap {|m| m.to = to }
+    end
+  end
+end

data/lib/yuimaru/sequence.rb

@@ -0,0 +1,22 @@
+require 'yuimaru/sequence/diagram'
+
+module Yuimaru
+  class Sequence
+    attr_reader :messages
+
+    def initialize(messages)
+      @messages = messages
+    end
+
+    def actors
+      messages.map {|m| [m.from, m.to] }.flatten.uniq
+    end
+
+    def save(path)
+      diagram = Diagram.new(self)
+      diagram.draw do |surface|
+        surface.write_to_png(path)
+      end
+    end
+  end
+end

data/lib/yuimaru/sequence/diagram.rb

@@ -0,0 +1,215 @@
+require 'cairo'
+
+module Yuimaru
+  class Sequence
+    class Diagram
+      HAND_FAMILY = 'Daniel'
+
+      attr_reader :surface, :context, :width, :height
+
+      def initialize(sequence)
+        @sequence = sequence
+      end
+
+      def draw
+        set_layout
+        init_surface
+        init_context
+        set_font
+        fill_background
+
+        draw_actors
+        draw_lifeline
+        draw_messages
+
+        yield surface
+      end
+
+      private
+
+      def set_layout
+        s = Cairo::ImageSurface.new(Cairo::FORMAT_ARGB32, 300, 200)
+        c = Cairo::Context.new(s)
+
+        set_font(context: c)
+
+        te = -> (text) { c.text_extents(text) }
+
+        @actors_layout = {}
+
+        actor_padding = 8
+        @sequence.actors.each do |a|
+          a_te = te[a]
+          @actors_layout[a] = {
+            text_width: a_te.width,
+            text_height: a_te.height,
+            width: actor_padding * 2 + a_te.width,
+            height: actor_padding * 2 + a_te.height
+          }
+        end
+
+        @messages_layout = {}
+        message_padding = 32
+        @sequence.messages.each do |m|
+          name_te = te[m.name]
+          @messages_layout[m] = {
+            text_width: name_te.width,
+            text_height: name_te.height,
+            width: message_padding * 2 + name_te.width,
+            height: message_padding * 2 + name_te.height
+          }
+        end
+
+        actor_margin = 16
+        @sequence.messages.each do |m|
+          @actors_layout[m.from][:max_distance] ||= {}
+          @actors_layout[m.from][:max_distance][m.to] = [
+            @actors_layout[m.from][:max_distance][m.to],
+            @messages_layout[m][:width],
+            @actors_layout[m.from][:width] / 2 + @actors_layout[m.to][:width] / 2,
+            actor_margin
+          ].compact.max
+        end
+
+        current_x = current_y = actor_margin
+        @sequence.actors.each_with_index do |a, i|
+          l = @actors_layout[a]
+          l[:x] = current_x
+          l[:y] = current_y
+          l[:text_x] = current_x + actor_padding
+          l[:text_y] = current_y + actor_padding + l[:text_height]
+          if d = l[:max_distance][@sequence.actors[i + 1]]
+            current_x += l[:width] + actor_margin + d
+          else
+            current_x += l[:width] + actor_margin
+          end
+        end
+        current_y = @actors_layout.map {|(a, pos)| pos[:y] + pos[:height] }.max
+
+        message_margin = 16
+        @sequence.messages.each do |m|
+          from_l = @actors_layout[m.from]
+          to_l = @actors_layout[m.to]
+          m_l = @messages_layout[m]
+
+          current_y += [from_l[:text_height], to_l[:text_height]].max
+          current_y += message_margin
+
+          m_l[:line_start] = {
+            x: from_l[:text_x] + from_l[:text_width] / 2,
+            y: current_y + m_l[:text_height]
+          }
+
+          m_l[:line_end] = {
+            x: to_l[:text_x] + to_l[:text_width] / 2,
+            y: current_y + m_l[:text_height]
+          }
+
+          m_l[:text_y] = current_y
+          m_l[:text_x] = m_l[:line_start][:x] + (m_l[:line_end][:x] - m_l[:line_start][:x]) / 2 - m_l[:text_width] / 2
+          current_y += m_l[:text_height]
+          current_y += message_margin
+        end
+
+        @lifeline_layout = {}
+        end_y = @sequence.messages.map {|m| @messages_layout[m][:line_end][:y] }.max
+        @sequence.actors.each do |a|
+          a_l = @actors_layout[a]
+          x = a_l[:text_x] + a_l[:text_width] / 2
+          start_y = a_l[:y] + a_l[:height]
+          @lifeline_layout[a] = {
+            line_start: {x: x, y: start_y},
+            line_end:   {x: x, y: end_y}
+          }
+        end
+
+        @width = current_x
+        @height = current_y + actor_margin
+      end
+
+      def init_surface
+        format = Cairo::FORMAT_ARGB32
+        @surface = Cairo::ImageSurface.new(format, width, height)
+      end
+
+      def init_context
+        @context = Cairo::Context.new(@surface)
+      end
+
+      def set_font(context: self.context, family: HAND_FAMILY, font_size: 16)
+        context.font_face = Cairo::ToyFontFace.new(family)
+        context.font_size = font_size
+      end
+
+      def fill_background
+        context.fill do
+          context.set_source_rgb(1, 1, 1)
+          context.rectangle(0, 0, width, height)
+        end
+      end
+
+      def draw_actors
+        context.set_source_rgb(0, 0, 0)
+        @actors_layout.each do |a, pos|
+          context.move_to(pos[:text_x], pos[:text_y])
+          context.show_text(a)
+          context.stroke do
+            context.rectangle(pos[:x], pos[:y], pos[:width], pos[:height])
+          end
+        end
+      end
+
+      def draw_lifeline
+        dashes = 10
+        context.set_dash(dashes)
+        @lifeline_layout.each do |_a, pos|
+          context.stroke do
+            context.set_source_rgb(0, 0, 0)
+            context.move_to(pos[:line_start][:x], pos[:line_start][:y])
+            context.line_to(pos[:line_end][:x], pos[:line_end][:y] + dashes * 2)
+          end
+        end
+      end
+
+      def draw_messages
+        arrow_margin = 5
+        context.set_source_rgb(0, 0, 0)
+        context.set_dash(nil)
+        @messages_layout.each do |m, pos|
+          context.move_to(pos[:text_x], pos[:text_y])
+          context.show_text(m.name)
+          if pos[:line_end][:x] > pos[:line_start][:x]
+            s, e, dir = pos[:line_start], pos[:line_end], 0
+          else
+            e, s, dir = pos[:line_start], pos[:line_end], 1
+          end
+
+          context.stroke do
+            context.move_to(s[:x] + arrow_margin, s[:y])
+            context.line_to(e[:x] - arrow_margin, e[:y])
+          end
+
+          if dir.zero?
+            x = e[:x] - arrow_margin
+          else
+            x = s[:x] + arrow_margin
+          end
+
+          y = e[:y]
+          if dir.zero?
+            arrow_len = -10
+          else
+            arrow_len = 10
+          end
+
+          context.fill do
+            context.move_to(x, y)
+            context.line_to(x + arrow_len, y - arrow_len)
+            context.line_to(x + arrow_len, y + arrow_len)
+            context.move_to(x, y)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yuimaru/version.rb

@@ -0,0 +1,3 @@
+module Yuimaru
+  VERSION = "0.1.0"
+end

data/sample.rb

@@ -0,0 +1,4 @@
+"alice" >> "hi bob" >> "bob"
+"alice" << "hi alice" << "bob"
+"alice" >> "hi carol" >> "carol"
+"alice" << "hi alice" << "carol"

data/yuimaru.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yuimaru/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yuimaru"
+  spec.version       = Yuimaru::VERSION
+  spec.authors       = ["Seiei Miyagi"]
+  spec.email         = ["hanachin@gmail.com"]
+
+  spec.summary       = %q{Generates sequence diagram.}
+  spec.homepage      = "https://github.com/hanachin/yuimaru"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "cairo"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: yuimaru
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Seiei Miyagi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cairo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- hanachin@gmail.com
+executables:
+- yuimaru
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- bin/yuimaru
+- exe/yuimaru
+- lib/yuimaru.rb
+- lib/yuimaru/dsl/default.rb
+- lib/yuimaru/message.rb
+- lib/yuimaru/sequence.rb
+- lib/yuimaru/sequence/diagram.rb
+- lib/yuimaru/version.rb
+- sample.png
+- sample.rb
+- yuimaru.gemspec
+homepage: https://github.com/hanachin/yuimaru
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Generates sequence diagram.
+test_files: []
+has_rdoc: