mahoujin 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa8e14e81fdce25c2a02c5e2f07b3cf851425627
+  data.tar.gz: c590eb53a3ff7b1c3173909b712ee63b943dba90
+SHA512:
+  metadata.gz: 1ac5f46f0a3b10b15034684f0a87be605cd80af3386849f591d1285f36539b6d167401858f817d3e6fb96fc6a72d04099fa13c2878eb844c055574075f715381
+  data.tar.gz: 9cf3f40ed6a9f1065de95bdc902dc404634899fdab515b7989623a614f1f0824c7c1e5827b94b78f477ad35f8d4ae0f0181199d7fa8d36afabb28df36a7bf59e

data/.codeclimate.yml

@@ -0,0 +1,8 @@
+engines:
+  rubocop:
+    enabled: true
+
+ratings:
+  paths:
+    - 'lib/**/*'
+    - 'spec/**/*'

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color --require spec_helper

data/.rubocop.yml

@@ -0,0 +1,51 @@
+require: rubocop-rspec
+
+
+AllCops:
+  Exclude:
+    - 'bin/*'
+    - 'exe/*'
+
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExtraSpacing:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/SpaceAroundOperators:
+  Enabled: false
+
+Style/SpaceBeforeComma:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Style/SpaceInsideParens:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+before_install: gem install bundler -v 1.11.2
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sou.K
+
+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,78 @@
+[![Build Status](http://img.shields.io/travis/0x01f7/mahoujin.svg)](https://travis-ci.org/0x01f7/mahoujin)
+[![Dependency Status](http://img.shields.io/gemnasium/0x01f7/mahoujin.svg)](https://gemnasium.com/0x01f7/mahoujin)
+[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/0x01f7/mahoujin.svg)](https://codeclimate.com/github/0x01f7/mahoujin/coverage)
+[![Code Climate](http://img.shields.io/codeclimate/github/0x01f7/mahoujin.svg)](https://codeclimate.com/github/0x01f7/mahoujin)
+[![Gem Version](http://img.shields.io/gem/v/mahoujin.svg)](https://rubygems.org/gems/mahoujin)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://0x01f7.mit-license.org)
+
+
+# Mahoujin
+
+Generate syntax diagram(aka railroad diagram) from EBNF specification
+
+
+## Requirements
+
+* [Cairo](http://cairographics.org) >= 1.12.0
+* [Ruby](https://www.ruby-lang.org) >= 2.0.0
+
+
+## Installation
+
+* Use Ruby's package manager
+
+    ```Text
+    $ gem install mahoujin
+    ```
+
+* Or from source
+
+    ```Text
+    $ git clone https://github.com/0x01f7/mahoujin.git
+    $ cd mahoujin
+    $ ./bin/setup
+    $ ./bin/rake install
+    ```
+
+
+## Usage
+
+Run command:
+
+```
+$ mahoujin SYNTAX.ebnfspec -o SYNTAX.svg --style Json
+```
+
+Note: the **SYNTAX.ebnfspec** uses **EBNF** which is defined in [ISO/IEC 14977](https://www.cl.cam.ac.uk/~mgk25/iso-14977.pdf) to describe it's rules.
+
+
+## Samples - EBNF
+
+**SYNTAX.ebnfspec**:
+
+```Text
+           syntax = syntax rule, {syntax rule};
+      syntax rule = meta identifier, '=', definitions list, ';';
+ definitions list = single definition, {'|', single definition};
+single definition = term, {',', term};
+             term = factor, ['-', exception];
+        exception = factor;
+           factor = [integer, '*'], primary;
+          primary = optional sequence | repeated sequence
+                  | grouped sequence | special sequence
+                  | meta identifier | terminal string;
+optional sequence = '[', definitions list, ']';
+repeated sequence = '{', definitions list, '}';
+ grouped sequence = '(', definitions list, ')';
+ special sequence = '?', {character - '?'}, '?';
+  meta identifier = letter, {letter | decimal digit | ? ASCII space character ?};
+  terminal string = "'", character - "'", {character - "'"}, "'"
+                  | '"', character - '"', {character - '"'}, '"';
+          integer = decimal digit, {decimal digit};
+        character = ? any character in ASCII alphabet characters ?;
+    decimal digit = ? any character in ASCII number characters ?;
+```
+
+**SYNTAX.svg**:
+
+![SYNTAX.svg](https://rawgit.com/0x01f7/mahoujin/master/samples/ebnf/syntax.svg)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mahoujin'
+require 'irb'
+
+IRB.start

data/bin/rake

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+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/rspec

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/mahoujin

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'mahoujin'
+require 'optionparser'
+
+options = {}
+options[:infile] = OptionParser.new do |opts|
+  opts.banner = "Usage: #{opts.program_name} [options] INFILE"
+  opts.separator ''
+  opts.on('-o', '--output OUTFILE', 'Write output to a file instead of STDOUT') { |f| options[:outfile] = f }
+  opts.on('-s', "--style STYLE", "Choose a graphics style: #{Mahoujin::Graphics::Styles.constants.join(', ')}") { |s| options[:style] = s }
+  opts.on('-h', '--help', 'Show this message') { puts opts; exit }
+  opts.on('-v', '--version', 'Show version') { puts Mahoujin::VERSION; exit }
+end.parse(ARGV).shift
+
+op = lambda do |ostream|
+  istream = options[:infile] ? File.read(options[:infile]) : STDIN.read
+  style = Mahoujin::Graphics::Styles.const_get(options.fetch(:style, :Json)).new
+  ast = Mahoujin::Transform.new.apply(Mahoujin::Parser.new.parse(istream))
+  Mahoujin::Graphics::Renderer.new.render(ast, ostream, style)
+end
+options[:outfile] ? File.open(options[:outfile], 'w', &op) : STDOUT.tap(&op)

data/lib/mahoujin.rb

@@ -0,0 +1,15 @@
+require 'cairo'
+require 'parslet'
+
+require 'mahoujin/atoms'
+require 'mahoujin/parser'
+require 'mahoujin/transform'
+
+require 'mahoujin/graphics/layout'
+require 'mahoujin/graphics/renderer'
+require 'mahoujin/graphics/stringify'
+require 'mahoujin/graphics/styles/basic'
+require 'mahoujin/graphics/styles/json'
+require 'mahoujin/graphics/utilities/rectangle'
+
+require 'mahoujin/version'

data/lib/mahoujin/atoms.rb

@@ -0,0 +1,32 @@
+require 'mahoujin/atoms/choice'
+require 'mahoujin/atoms/concatenation'
+require 'mahoujin/atoms/exception'
+require 'mahoujin/atoms/grouping'
+require 'mahoujin/atoms/non_terminal'
+require 'mahoujin/atoms/optional'
+require 'mahoujin/atoms/prose'
+require 'mahoujin/atoms/rule_name'
+require 'mahoujin/atoms/rule'
+require 'mahoujin/atoms/specific_repetition'
+require 'mahoujin/atoms/syntax'
+require 'mahoujin/atoms/terminal'
+require 'mahoujin/atoms/zero_or_more_repetition'
+
+module Mahoujin
+  module Atoms
+    constants.each do |constant_name|
+      constant = const_get(constant_name)
+      next unless constant.is_a?(Class)
+
+      constant.class_exec do
+        def self.underscore_name
+          name.split('::').last.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+        end
+
+        def bbox
+          @bbox ||= Graphics::Utilities::Rectangle.new
+        end
+      end
+    end
+  end
+end

data/lib/mahoujin/atoms/choice.rb

@@ -0,0 +1,12 @@
+module Mahoujin
+  module Atoms
+    class Choice
+      attr_reader :atoms
+
+      def initialize(atoms)
+        raise if atoms.size < 2
+        @atoms = atoms.freeze
+      end
+    end
+  end
+end

data/lib/mahoujin/atoms/concatenation.rb

@@ -0,0 +1,12 @@
+module Mahoujin
+  module Atoms
+    class Concatenation
+      attr_reader :atoms
+
+      def initialize(atoms)
+        raise if atoms.size < 2
+        @atoms = atoms.freeze
+      end
+    end
+  end
+end

data/lib/mahoujin/atoms/exception.rb

@@ -0,0 +1,11 @@
+module Mahoujin
+  module Atoms
+    class Exception
+      attr_reader :content
+
+      def initialize(content)
+        @content = content.freeze
+      end
+    end
+  end
+end

data/lib/mahoujin/atoms/grouping.rb

@@ -0,0 +1,11 @@
+module Mahoujin
+  module Atoms
+    class Grouping
+      attr_reader :atom
+
+      def initialize(atom)
+        @atom = atom
+      end
+    end
+  end
+end

data/lib/mahoujin/atoms/non_terminal.rb

@@ -0,0 +1,11 @@
+module Mahoujin
+  module Atoms
+    class NonTerminal
+      attr_reader :content
+
+      def initialize(content)
+        @content = content.freeze
+      end
+    end
+  end
+end

data/lib/mahoujin/atoms/optional.rb

@@ -0,0 +1,11 @@
+module Mahoujin
+  module Atoms
+    class Optional
+      attr_reader :atom
+
+      def initialize(atom)
+        @atom = atom
+      end
+    end
+  end
+end

data/lib/mahoujin/atoms/prose.rb

@@ -0,0 +1,11 @@
+module Mahoujin
+  module Atoms
+    class Prose
+      attr_reader :content
+
+      def initialize(content)
+        @content = content.freeze
+      end
+    end
+  end
+end

data/lib/mahoujin/atoms/rule.rb

@@ -0,0 +1,11 @@
+module Mahoujin
+  module Atoms
+    class Rule
+      attr_reader :rule_name_atom, :atom
+
+      def initialize(rule_name_atom, atom)
+        @rule_name_atom, @atom = rule_name_atom, atom
+      end
+    end
+  end
+end

data/lib/mahoujin/atoms/rule_name.rb

@@ -0,0 +1,11 @@
+module Mahoujin
+  module Atoms
+    class RuleName
+      attr_reader :content
+
+      def initialize(content)
+        @content = content.freeze
+      end
+    end
+  end
+end