picatrix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e2e397e99116fa0b237db3f59a35ab0c7521f4e
+  data.tar.gz: 835f2a685518c5448ad260577949244cf1feca77
+SHA512:
+  metadata.gz: 0cbd222ea637fe500cc864a89dcb244e743405d83b31cadbb1e6b891637c50a8a898a83e9f39b5426d514fb955f3d36be5823d89d9087c5b08150a485bf6c9f8
+  data.tar.gz: a36dc255cf23bc5305af1edaf7299bd65db0a6a9b4259e138fa1ecbbbf0d322c9d8beff005812a4fdbbcecdf6aca9db81c128d46208961284e9c990396a18e3a

data/.gitignore

@@ -0,0 +1,37 @@
+.DS_Store
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,130 @@
+PATH
+  remote: .
+  specs:
+    picatrix (0.1.0)
+      activesupport
+      grape
+      grape-roar
+      parslet
+      require_all
+      roar
+      ruby-graphviz
+      sinatra
+      sinatra-contrib
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    backports (3.6.7)
+    blankslate (3.1.3)
+    builder (3.2.2)
+    coderay (1.1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    equalizer (0.0.11)
+    grape (0.13.0)
+      activesupport
+      builder
+      hashie (>= 2.1.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      rack (>= 1.3.0)
+      rack-accept
+      rack-mount
+      virtus (>= 1.0.0)
+    grape-roar (0.3.0)
+      grape
+      roar (>= 1.0)
+    hashie (3.4.3)
+    i18n (0.7.0)
+    ice_nine (0.11.1)
+    json (1.8.3)
+    method_source (0.8.2)
+    minitest (5.8.2)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    parslet (1.7.1)
+      blankslate (>= 2.0, <= 4.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (10.4.2)
+    representable (2.3.0)
+      uber (~> 0.0.7)
+    require_all (1.3.3)
+    roar (1.0.3)
+      representable (>= 2.0.1, <= 3.0.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    ruby-graphviz (1.2.2)
+    sinatra (1.4.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sinatra-contrib (1.4.6)
+      backports (>= 2.0)
+      multi_json
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.0)
+      tilt (>= 1.3, < 3)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (2.0.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uber (0.0.15)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  picatrix!
+  pry
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alex Moore-Niemi
+
+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,86 @@
+         .--.
+        /( @ >    ,-.
+       / ' .'--._/  /
+       :   ,    , .'
+       '. (___.'_/
+        ((-((-''mrf
+
+# Picatrix
+
+An opinionated hypermedia API generator.
+
+Requires:
+- valid `.dot` file (with some specific styles)
+
+Outputs:
+- Sinatra style routes
+- `application/vnd.mason+json` assets
+  - serializers
+  - templates (think forms, not views)
+- state diagram image ([see below](https://github.com/mooreniemi/picatrix#sample-image-output))
+
+## About
+
+Directed graphs get complicated, but can be divded into simpler subgraphs. Picatrix is currently useful for only a single workflow (and barely that right now, as we're way before a real release). Integrated workflows will involve generating several route sets that will be required into a single Sinatra app. Some workflows may even be representable as DAGs/trees.
+
+The ideal way to use Picatrix is to do an exercise in designing your API "outside in" where all inputs/outputs are defined, and a state diagram is drawn. This diagram can be translated to a dot file, and the inputs/outputs can be translated into hypermedia assets.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'picatrix'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install picatrix
+
+## Usage
+
+In its final state, the intent is to use it as a CLI:
+
+```bash
+$ bin/picapica dg_api.dot app_name
+=> generated/app_name.rb
+```
+
+## Sample Image Output
+
+    # to generate the image with graphviz installed
+    $ dot -Tpng spec/support/dg_api.dot -o spec/support/dg_api.dot.png
+
+![state diagram image of sample app](spec/support/dg_api.dot.png "simple photo viewing app")
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+
+### TODO
+- generate sinatra routes from app & resource edges
+  - initially make mason stubs myself
+  - usage will be to iteratively make the necessary templates until routes are filled out
+- with all mason stubs established, make generators for them from
+  - RAML?
+  - json
+  - yml?
+
+#### done
+- parse dot file in Ruby
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/mooreniemi/picatrix). 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "picatrix"
+
+require "pry"
+pry.start

data/bin/picapica

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+
+require "picatrix"
+
+Picatrix::CLI.start

data/bin/setup

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

data/lib/picatrix.rb

@@ -0,0 +1,28 @@
+require "picatrix/version"
+require "parslet"
+require "graphviz"
+require "active_support"
+require "active_support/core_ext/string"
+require "thor"
+
+require "picatrix/pacman"
+require "picatrix/digraph_parser"
+require "picatrix/transform_to_hash"
+require "picatrix/jenny"
+
+module Picatrix
+  class CLI < Thor
+    desc "g <dot file name> <output file name>", "generate <dot file name> <output file name>"
+    option :force, :type => :boolean
+
+    def g(dot_file_name, output=nil)
+      puts "using: #{dot_file_name}"
+      puts "output: #{output}" if output
+
+      Jenny.new(
+        Pacman.new(dot_file_name).hash,
+        options
+      ).just_do_it
+    end
+  end
+end

data/lib/picatrix/digraph_parser.rb

@@ -0,0 +1,137 @@
+module Picatrix
+  class DigraphParser < Parslet::Parser
+    rule(:space) { str(" ") }
+    rule(:indent) { str(" ").repeat(2) }
+    rule(:newline) { str("\n") }
+    rule(:eof) { any.absent? }
+    rule(:comment) do
+      indent.repeat(0) >>
+      str("//") >>
+      (newline.absent? >> any).repeat(1) >>
+      newline
+    end
+    rule(:default_definitions) do
+      indent >>
+      str("edge [") >>
+      newline >>
+      indent.repeat >>
+      str("arrowhead=\"odiamond\"") >>
+      newline >>
+      indent >>
+      str("]") >>
+      newline
+    end
+    rule(:arrow) { str("->") }
+    rule(:snake_case_key) do
+      match('[a-zA-Z0-9_]').repeat(1)
+    end
+    rule(:quoted_string) do
+      str('"') >>
+      (
+        (str('\\') >> any) | (str('"').absent? >> any)
+      ).repeat(1) >>
+      str('"')
+    end
+    rule(:style) do
+      str("style=dotted") |
+      str("style=bold") |
+      delete_marker
+    end
+    rule(:post_marker) do
+      str("arrowhead=normal")
+    end
+    rule(:delete_marker) do
+      str("color=red fontcolor=red")
+    end
+    rule(:shape) do
+      str("shape=note") |
+      str("shape=folder") |
+      str("shape=rectangle")
+    end
+    rule(:label) do
+      str("[") >>
+      str("label=") >>
+      quoted_string.as(:label) >>
+      space.repeat(0) >>
+      style.repeat(0).as(:style) >>
+      space.repeat(0) >>
+      shape.repeat(0).as(:shape) >>
+      str("]")
+    end
+    rule(:link_relation) do
+      str("[") >>
+      str("label=") >>
+      quoted_string.as(:link_relation) >>
+      space.repeat(0) >>
+      style.repeat(0).as(:style) >>
+      space.repeat(0) >>
+      shape.repeat(0).as(:shape) >>
+      space.repeat(0) >>
+      post_marker.repeat(0).as(:post) >>
+      str("]")
+    end
+    rule(:edge_target) do
+      str("{") >>
+      space.repeat(0) >>
+      snake_case_key >>
+      space.repeat(0) >>
+      str("}")
+    end
+    rule(:root_label) do
+      str("[xlabel=") >>
+      (str("shape=point]").absent? >> any).repeat >>
+      str("shape=point]")
+    end
+    rule(:root_line) do
+      indent >>
+      snake_case_key >>
+      space >>
+      root_label
+    end
+    rule(:digraph_open_tag) { str("digraph d {") }
+    rule(:digraph_close_tag) { str("}") >> newline.repeat(0) >> eof }
+    rule(:digraph_heading) do
+      digraph_open_tag >>
+      newline >>
+      comment.repeat(0) >>
+      default_definitions >>
+      newline >>
+      comment.repeat(0) >>
+      root_of_api
+    end
+    rule(:root_of_api) do
+      root_line.as(:initial_inbound_request) >>
+      newline.repeat(1) >>
+      (
+        digraph_close_tag.absent? >>
+        (
+          comment |
+          node_definition.as(:node) |
+          edge_definition.as(:edge)
+        ) >>
+        newline.repeat(0)
+      ).repeat >>
+      digraph_close_tag
+    end
+    rule(:node_definition) do
+      indent >>
+      snake_case_key.as(:name) >>
+      space.repeat(0) >>
+      label >>
+      newline
+    end
+    rule(:edge_definition) do
+      indent >>
+      snake_case_key.as(:outbound) >>
+      space.repeat(0) >>
+      arrow >>
+      space.repeat(0) >>
+      edge_target.as(:inbound) >>
+      space.repeat(0) >>
+      link_relation >>
+      newline
+    end
+    root(:digraph_heading)
+  end
+
+end