angus-sdoc 0.0.1 → 0.0.2

data/lib/angus/sdoc/json_formatter.rb

@@ -0,0 +1,317 @@
+require 'json'
+
+module Angus
+  module SDoc
+    class JsonFormatter
+
+      def self.format(x)
+        define_singleton_method("format_#{x}") do |y|
+          JSON(send("#{x}_for_json", y))
+        end
+      end
+
+      format :glossary
+      format :glossary_term
+      format :message
+      format :operation
+      format :proxy_operation
+      format :representation
+      format :representation_field
+      format :request_element
+      format :response_element
+      format :service
+      format :uri_element
+
+      class << self
+        private
+
+        # Returns a hash with the glossary data.
+        #
+        # @param [Angus::SDoc::Definitions::Glossary] glossary_definition
+        #   The glossary definition.
+        #
+        # @return [Hash]
+        # @option return [(see .glossary_term_for_json)] :<term.short_name>
+        def glossary_for_json(glossary_definition)
+          glossary_definition.terms.inject({}) do |result, term|
+            result.merge({ term.short_name => glossary_term_for_json(term) })
+          end
+        end
+
+        # Returns a hash with the glossary term data.
+        #
+        # @param [Angus::SDoc::Definitions::GlossaryTerm] glossary_term_definition
+        #   The glossary term definition.
+        #
+        # @return [Hash]
+        # @option return [String] :long_name
+        # @option return [String] :description
+        def glossary_term_for_json(glossary_term_definition)
+          {
+            :long_name => glossary_term_definition.long_name,
+            :description => glossary_term_definition.description
+          }
+        end
+
+        # Returns a hash with the message data.
+        #
+        # @param [Angus::SDoc::Definitions::Message] message_definition
+        #   The message definition.
+        #
+        # @return [Hash]
+        # @option return [String] :key
+        # @option return [String] :description
+        # @option return [String] :level
+        # @option return [Integer] :status_code
+        def message_for_json(message_definition)
+          {
+            :key => message_definition.key,
+            :description => message_definition.description,
+            :level => message_definition.level,
+            :status_code => message_definition.status_code
+          }
+        end
+
+        # Returns a hash with the operation data.
+        #
+        # @param [Angus::SDoc::Definitions::Operation] operation_definition
+        #   The operation definition.
+        #
+        # @return [Hash]
+        # @option return [String] :name
+        # @option return [String] :description
+        # @option return [String] :path
+        # @option return [String] :method
+        # @option return [Array<(see .uri_element_for_json)>] :uri
+        # @option return [Array<(see .request_element_for_json)>] :request
+        # @option return [Array<(see .response_element_for_json)>] :response
+        # @option return [Array<(see .message_for_json)>] :messages
+        def operation_for_json(operation_definition)
+          data = {
+            :name => operation_definition.name,
+            :description => operation_definition.description,
+            :path => operation_definition.path,
+            :method => operation_definition.method
+          }
+
+          if operation_definition.uri_elements && !operation_definition.uri_elements.empty?
+            uri_elements = operation_definition.uri_elements.map do |uri_element|
+              uri_element_for_json(uri_element)
+            end
+            data.merge!({ :uri => uri_elements })
+          end
+
+          if operation_definition.request_elements && !operation_definition.request_elements.empty?
+            request_elements = operation_definition.request_elements.map do |request_element|
+              request_element_for_json(request_element)
+            end
+
+            data.merge!({ :request => request_elements })
+          end
+
+          if operation_definition.response_elements && !operation_definition.response_elements.empty?
+            response_elements = operation_definition.response_elements.map do |response_element|
+              response_element_for_json(response_element)
+            end
+
+            data.merge!({:response => response_elements})
+          end
+
+          if operation_definition.messages && !operation_definition.messages.empty?
+            messages = operation_definition.messages.map do |message|
+              message_for_json(message)
+            end
+
+            data.merge!({:messages => messages})
+          end
+
+          data
+        end
+
+        # Returns a hash with the proxy operation data.
+        #
+        # @param [Angus::SDoc::Definitions::ProxyOperation] proxy_operation_definition
+        #   The proxy operation definition.
+        #
+        # @return [Hash]
+        # @option return [String] :path
+        # @option return [String] :method
+        # @option return [String] :service
+        def proxy_operation_for_json(proxy_operation_definition)
+          {
+            :path => proxy_operation_definition.path,
+            :method => proxy_operation_definition.method,
+            :service => proxy_operation_definition.service_name
+          }
+        end
+
+        # Returns a hash with the representation data.
+        #
+        # @param [Angus::SDoc::Definitions::Representation] representation_definition
+        #   The representation definition.
+        #
+        # @return [Array<(see .representation_field_for_json)>]
+        def representation_for_json(representation_definition)
+          representation_definition.fields.map do |field|
+            representation_field_for_json(field)
+          end
+        end
+
+        # Returns a hash with the representation field data.
+        #
+        # @param [Angus::SDoc::Definitions::RepresentationField] representation_field_definition
+        #   The representation field definition.
+        #
+        # @return [Hash]
+        # @option return [String] :element
+        # @option return [String] :description
+        # @option return [Boolean] :required
+        # @option return [String] :type
+        # @option return [String] :elements_type
+        def representation_field_for_json(representation_field_definition)
+          data = {
+            :field => representation_field_definition.name,
+            :description => representation_field_definition.description,
+            :required => representation_field_definition.required
+          }
+
+          if representation_field_definition.type
+            data.merge!({:type => representation_field_definition.type})
+          end
+
+          if representation_field_definition.elements_type
+            data.merge!({:elements_type => representation_field_definition.elements_type})
+          end
+
+          data
+        end
+
+        # Returns a hash with the request element data.
+        #
+        # @param [Angus::SDoc::Definitions::RequestElement] request_element_definition
+        #   The request element definition.
+        #
+        # @return [Hash]
+        # @option return [String] :element
+        # @option return [String] :description
+        # @option return [Boolean] :required
+        # @option return [String] :type
+        # @option return [String] :elements_type
+        def request_element_for_json(request_element_definition)
+          data = {
+            :element => request_element_definition.name,
+            :description => request_element_definition.description,
+            :required => request_element_definition.required
+          }
+
+          if request_element_definition.type
+            data.merge!({:type => request_element_definition.type})
+          end
+
+          if request_element_definition.elements_type
+            data.merge!({:elements_type => request_element_definition.elements_type})
+          end
+
+          data
+        end
+
+        # Returns a hash with the response element data.
+        #
+        # @param [Angus::SDoc::Definitions::ResponseElement] response_element_definition
+        #   The response element definition.
+        #
+        # @return [Hash]
+        # @option return [String] :element
+        # @option return [String] :description
+        # @option return [Boolean] :required
+        # @option return [String] :type
+        # @option return [String] :elements_type
+        def response_element_for_json(response_element_definition)
+          data = {
+            :element => response_element_definition.name,
+            :description => response_element_definition.description,
+            :required => response_element_definition.required
+          }
+
+          if response_element_definition.type
+            data.merge!({:type => response_element_definition.type})
+          end
+
+          if response_element_definition.elements_type
+            data.merge!({:elements_type => response_element_definition.elements_type})
+          end
+
+          data
+        end
+
+        # Generates the json for the service definition.
+        #
+        # @param [Angus::SDoc::Definitions::Service] service_definition
+        #   The service definition.
+        #
+        # @return [Hash]
+        # @option return [Hash] :service
+        # @option :service [String] :service
+        # @option :service [String] :code_name
+        # @option :service [String] :version
+        # @option return [Hash<(see .uri_element_for_json)>] :operations
+        # @option return [Hash<(see .request_element_for_json)>] :proxy_operations
+        # @option return [Hash<(see .response_element_for_json)>] :representations
+        # @option return [Array<(see .message_for_json)>] :messages
+        # @option return [(see .message_for_json)] :glossary
+        def service_for_json(service_definition)
+          operations = service_definition.operations.inject({}) do |result, (namespace, operations)|
+            result[namespace] ||= {}
+            operations.each do |operation|
+              result[namespace][operation.code_name] = operation_for_json(operation)
+            end
+            result
+          end
+
+          proxy_operations = service_definition.proxy_operations.inject({}) do |result, operation|
+            result.merge({ operation.code_name => proxy_operation_for_json(operation) })
+          end
+
+          representations = service_definition.representations.inject({}) do |result, representation|
+            result.merge({ representation.name => representation_for_json(representation) })
+          end
+
+          messages = service_definition.messages.inject({}) do |result, message_data|
+            message_name, message = message_data
+            result.merge({ message_name => message_for_json(message) })
+          end
+
+          {
+            :service => {
+              :service => service_definition.name,
+              :code_name => service_definition.code_name,
+              :version => service_definition.version
+            },
+            :operations => operations,
+            :proxy_operations => proxy_operations,
+            :representations => representations,
+            :messages => messages,
+            :glossary => glossary_for_json(service_definition.glossary)
+          }
+        end
+
+        # Returns a hash with the uri element data.
+        #
+        # @param [Angus::SDoc::Definitions::UriElement] uri_element_definition
+        #   The uri element definition.
+        #
+        # @return [Hash]
+        # @option return [String] :element
+        # @option return [String] :description
+        def uri_element_for_json(uri_element_definition)
+          {
+            :element => uri_element_definition.name,
+            :description => uri_element_definition.description
+          }
+        end
+
+      end
+
+    end
+  end
+end

data/lib/angus/sdoc/templates/doc.erb

@@ -0,0 +1,295 @@
+<%
+  glossary_terms_hash = @service.glossary.terms_hash
+%>
+
+<html>
+  <head>
+    <title>Especificaci&oacute;n API de Servicio <%= @service.name %></title>
+
+    <style type="text/css" media="screen">
+      <%= erb :styles %>
+    </style>
+  </head>
+  <body>
+  <div class="content">
+    <h1>Especificaci&oacute;n API de Servicio <%= @service.name %></h1>
+    <h4>Nombre en c&oacute;digo</h4>
+    <p><%= @service.code_name %></p>
+
+    <h3>Operaciones</h3>
+    <p>
+      En esta secci&oacute;n se describen las operaciones presentadas por este servicio.
+    </p>
+
+    <table>
+      <thead>
+        <tr>
+          <td>&Iacute;ndice de Operaciones</td>
+        </tr>
+      </thead>
+      <tbody>
+        <% @service.operations.each do |(controller_name, operations)| %>
+          <% operations.each do |operation| %>
+            <tr>
+              <td>
+                <a href="#operation-<%= controller_name %>-<%= operation.code_name %>">
+                  <%= controller_name %>#<%= operation.code_name %>
+                </a>
+              </td>
+            </tr>
+          <% end %>
+        <% end %>
+      </tbody>
+    </table>
+
+    <% if @service.proxy_operations.any? %>
+    <p></p>
+    <table>
+      <thead>
+        <tr><td>Índice de Operaciones Proxy</td></tr>
+      </thead>
+      <tbody>
+        <% @service.proxy_operations.each do |operation| %>
+          <tr><td>
+            <a href="#proxy-operation-<%= operation.code_name %>">
+              <%= operation.code_name %>
+            </a>
+          </td></tr>
+        <% end %>
+      </tbody>
+    </table>
+    <% end %>
+
+    <% @service.operations.each do |(controller_name, operations)| %>
+      <% operations.each do |operation| %>
+        <div class="operation" id="operation-<%= controller_name %>-<%= operation.code_name %>">
+          <h4>
+            <%= operation.name %>
+          </h4>
+
+          <h5>Descripci&oacute;n</h5>
+          <p><%= operation.description %></p>
+
+          <h5>Versiones</h5>
+          <p>Presente desde versi&oacute;n inicial</p>
+
+          <table class="vertical-header split">
+            <tbody>
+              <tr>
+                <td>M&eacute;todo</td>
+                <td><%= operation.method %></td>
+              </tr>
+              <tr>
+                <td>URI</td>
+                <td><%= operation.path %></td>
+              </tr>
+              <tr>
+                <td>Nombre interno</td>
+                <td><%= operation.code_name %></td>
+              </tr>
+            </tbody>
+          </table>
+
+          <% if !operation.uri_elements.empty? %>
+            <h5>Parametros de Path URI</h5>
+            <table>
+              <thead>
+                <tr>
+                  <td>Par&aacute;metro</td>
+                  <td>Descripción</td>
+                </tr>
+              </thead>
+              <tbody>
+                <% operation.uri_elements.each do |element| %>
+                  <tr>
+                    <td><%= element.name %></td>
+                    <td>
+                      <%= element.description %>
+                    </td>
+                  </tr>
+                <% end %>
+              </tbody>
+            </table>
+          <% end %>
+
+
+          <% if !operation.request_elements.empty? %>
+          <h5>Elementos de Petici&oacute;n</h5>
+          <table>
+            <thead>
+              <tr>
+                <td>Nombre</td>
+                <td>Descripci&oacute;n</td>
+                <td>Requerido</td>
+              </tr>
+            </thead>
+            <tbody>
+              <% operation.request_elements.each do |element| %>
+                <tr>
+                  <td><%= element.name %></td>
+                  <td>
+                    <%= element.description %><br />
+                    Tipo: <%= h_type(element.type, @service) %><br />
+                    Restricciones: <%= element.constraints %><br />
+                    Valores Válidos: <%= element.valid_values %><br />
+                    <% if glossary_terms_hash.include?(element.name)
+                         glossary_term = glossary_terms_hash[element.name]
+                      %>
+                      Glosario:
+                      <a href="#glossary-term-<%= glossary_term.short_name %>"><%= glossary_term.long_name %></a>
+                      <br />
+                    <% end %>
+                  </td>
+                  <td><%= element.required %></td>
+                </tr>
+              <% end %>
+            </tbody>
+          </table>
+          <% end %>
+
+          <% if !operation.response_elements.empty? %>
+          <h5>Elementos de Respuesta</h5>
+          <table>
+            <thead>
+              <tr>
+                <td>Nombre</td>
+                <td>Descripción</td>
+                <td>Requerido</td>
+              </tr>
+            </thead>
+            <tbody>
+              <% operation.response_elements.each do |element| %>
+                <tr>
+                  <td><%= element.name %></td>
+                  <td>
+                    <%= element.description %><br />
+                    <% if element.type %>
+                      Tipo: <%= h_type(element.type, @service) %><br />
+                    <% else %>
+                      Contenedor: <%= h_type(element.elements_type, @service) %><br />
+                    <% end %>
+                    <% if element.default %>
+                      Valor por defecto: <%= element.default %>
+                    <% end %>
+                  </td>
+                  <td><%= element.required %></td>
+                </tr>
+              <% end %>
+            </tbody>
+          </table>
+          <% end %>
+
+          <% if !operation.messages.empty? %>
+          <h5>Mensajes</h5>
+          <table>
+            <thead>
+              <tr>
+                <td>Nivel</td>
+                <td>Código</td>
+                <td>Descripción</td>
+                <td>Código de Estado HTTP</td>
+              </tr>
+            </thead>
+            <tbody>
+              <% operation.messages.each do |message| %>
+                <tr>
+                  <td><%= message.level %></td>
+                  <td><%= message.key %></td>
+                  <td><%= message.description %></td>
+                  <td><%= message.status_code %></td>
+                </tr>
+              <% end %>
+            </tbody>
+          </table>
+          <% end %>
+        </div>
+      <% end %>
+    <% end %>
+
+    <h3>Representaciones</h3>
+    <% @service.representations.each do |representation| %>
+    <div class="representation" id="representation-<%= representation.name %>">
+      <h4><%= representation.name %></h4>
+      <table>
+        <thead>
+          <tr>
+            <td>Nombre de Atributo</td>
+            <td>Descripci&oacute;n</td>
+            <td>Requerido</td>
+          </tr>
+        </thead>
+        <tbody>
+          <% representation.fields.each do |field| %>
+            <tr>
+              <td><%= field.name %></td>
+              <td>
+                <%= field.description %><br />
+                <% if field.type %>
+                  Tipo: <%= h_type(field.type, @service) %><br />
+                <% else %>
+                  Contenedor: <%= h_type(field.elements_type, @service) %><br />
+                <% end %>
+              </td>
+              <td><%= field.required %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+    <% end %>
+
+    <% if @service.proxy_operations.any? %>
+    <h3>Operaciones Proxy</h3>
+    <div id="proxy_operations" class="proxy_operations">
+      <table>
+        <thead>
+          <tr>
+            <td>Nombre Interno</td>
+            <td>Método</td>
+            <td>URI</td>
+            <td>Servicio</td>
+          </tr>
+        </thead>
+        <tbody>
+          <% @service.proxy_operations.each do |operation| %>
+            <tr id="proxy-operation-<%= operation.code_name %>">
+              <td>
+                <%= operation.code_name %>
+              </td>
+              <td><%= operation.method %></td>
+              <td><%= operation.path %></td>
+              <td><%= operation.service_name %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+    <% end %>
+
+    <% if @service.glossary.terms.any? %>
+    <h3>Glosario</h3>
+    <div class="glossary">
+      <table>
+        <thead>
+          <tr>
+            <td>Nombre Corto</td>
+            <td>Nombre Largo</td>
+            <td>Descripción</td>
+          </tr>
+        </thead>
+        <tbody>
+        <% @service.glossary.terms.each do |term| %>
+          <tr id="glossary-term-<%= term.short_name %>">
+            <td><%= term.short_name %></td>
+            <td><%= term.long_name %></td>
+            <td><%= term.description %></td>
+          </tr>
+        <% end %>
+        </tbody>
+      </table>
+    </div>
+    <% end %>
+
+  </body>
+</html>
+

data/lib/angus/sdoc/templates/styles.erb

@@ -0,0 +1,70 @@
+body {
+  font-family: Arial;
+  font-size: 11pt;
+  background-color: #D0D0D0;
+}
+
+h1 {
+  text-align: center;
+  font-size: 24pt;
+  font-weight: bold;
+}
+
+h3 {
+  font-size: 14pt;
+  font-weight: bold;
+}
+
+h4 {
+  font-size: 12pt;
+  font-weight: bold;
+}
+
+h5 {
+  font-size: 11pt;
+  font-weight: bold;
+}
+
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+  width: 50em;
+}
+
+thead {
+  background-color: #EFEFEF;
+  font-size: 10pt;
+  font-weight: bold;
+}
+
+tbody {
+  font-size: 11pt;
+}
+
+td {
+  border: solid 1px #000000;
+  margin: 0;
+  padding: 4pt 6pt;
+}
+
+body > .content {
+  margin: 20px 10px;
+  border: solid 1px #909090;
+  padding: 10px 10px;
+  background-color: #FFFFFF;
+}
+
+.operation, .representation {
+  border-bottom: solid 1px #909090;
+  padding-bottom: 4ex;
+}
+
+table.vertical-header td:first-child {
+  background-color: #EFEFEF;
+  font-size: 10pt;
+  font-weight: bold;
+}
+
+table.split td:first-child {
+  width: 40%;
+}

data/lib/angus/sdoc/version.rb

@@ -1,5 +1,5 @@
 module Angus
-  module Sdoc
-    VERSION = "0.0.1"
+  module SDoc
+    VERSION = '0.0.2'
   end
-end
+end

data/lib/angus/sdoc.rb

@@ -1,7 +1,6 @@
-require "angus/sdoc/version"
+require 'set'
+require 'yaml'
+require 'pathname'
 
-module Angus
-  module Sdoc
-    # Your code goes here...
-  end
-end
+require_relative 'sdoc/version'
+require_relative 'base'