angus-sdoc 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f1e789e1dbc54103d3e5a3c77dba6921a183c2e2
-  data.tar.gz: a7c9c1940257b319fdb7718d5bb0f600e7a38f88
+SHA256:
+  metadata.gz: 9f8ca0e037913ac03e2a659e4414b3443836939bacbd681343bf762fa199a0c0
+  data.tar.gz: 99dbb0ed5a0f1a9baebb1c2a32938c88d564a41cdb8533ff26ec7c00491a858c
 SHA512:
-  metadata.gz: 489847ef042e704b7e2ede824a5780b6527497d0f99c3bca6e152e4fba9d09a458b9b4148e26d708a473b56d83dd70e5ee594704c76fab88356e64a6d2a716a6
-  data.tar.gz: b86b74e9d35be027ac08367b98288f88f2549ff4a6f39bc9122e4438e324d8b51cca318fbb4e9d21e10d7292e2404f32bde13fed2e174a172847aa0f1a56d594
+  metadata.gz: d5b8ef213b828c9a37ce60bfc021fc3e836ccec7a79a98d3a0fcb34755b8ce33f651f557d65aba6cd96210f41e27f276b03aa0c6ba168b4eee2bd17eaf18ecfa
+  data.tar.gz: b6176bd9bba8546a226bfeb186e6c6d1934883e26c21ca07d79a61abe6ba5c3796e9486af5d23c02f1dabf82cb11ce5c57a064817160216e3614aecc18060529

data/lib/angus/base.rb

@@ -8,4 +8,4 @@ require_relative 'exceptions/base'
 require_relative 'definitions_reader'
 require_relative 'definitions_utils'
 require_relative 'sdoc/json_formatter'
-require_relative 'sdoc/html_formatter'
+require_relative 'sdoc/html_formatter'

data/lib/angus/definitions/glossary.rb

@@ -49,4 +49,4 @@ module Angus
 
     end
   end
-end
+end

data/lib/angus/definitions/glossary_term.rb

@@ -26,7 +26,7 @@ module Angus
       # @param [GlossaryTerm] other The object to be compared.
       #
       # @return [Boolean] true if all the attributes are equal and false otherwise.
-      def == (other)
+      def ==(other)
         other.kind_of?(Definitions::GlossaryTerm) &&
           self.short_name == other.short_name && self.long_name == other.long_name &&
           self.description == other.description
@@ -34,4 +34,4 @@ module Angus
 
     end
   end
-end
+end

data/lib/angus/definitions/message.rb

@@ -33,4 +33,4 @@ module Angus
 
     end
   end
-end
+end

data/lib/angus/definitions/message_field.rb

@@ -24,4 +24,4 @@ module Angus
 
     end
   end
-end
+end

data/lib/angus/definitions/proxy_operation.rb

@@ -21,4 +21,4 @@ module Angus
 
     end
   end
-end
+end

data/lib/angus/definitions/representation.rb

@@ -12,4 +12,4 @@ module Angus
 
     end
   end
-end
+end

data/lib/angus/definitions/representation_field.rb

@@ -1,7 +1,6 @@
 module Angus
   module SDoc
     class Definitions::RepresentationField
-
       # @!attribute [rw] name
       #   @return [String] the name of the representation field.
       attr_accessor :name
@@ -24,15 +23,21 @@ module Angus
       #     This attribute is used when the representation is a list of objects.
       attr_accessor :elements_type
 
+      # @!attribute [rw] optional
+      #   @return [Boolean] true if the element is optional
+      attr_accessor :optional
+
       # @note if the elements_type attribute is different from nil, it means that the
       #   representation field is a list of objects. In that case, the type parameter
       #   is not considered.
-      def initialize(name = nil, description = nil, required = nil, type = nil, elements_type = nil)
-        self.name= name
-        self.description= description
-        self.required= required
-        self.type= type
-        self.elements_type= elements_type
+      def initialize(name = nil, description = nil, required = nil, type = nil, elements_type = nil,
+                     optional = nil)
+        self.name = name
+        self.description = description
+        self.required = required
+        self.type = type
+        self.elements_type = elements_type
+        self.optional = optional
       end
 
       # Check if an object is equals to the current instance.
@@ -40,12 +45,12 @@ module Angus
       # @param [RepresentationField] other The object to be compared.
       #
       # @return [Boolean] true if all the attributes are equal and false otherwise.
-      def == (other)
+      def ==(other)
         other.kind_of?(Definitions::RepresentationField) &&
-          self.name == other.name && self.description == other.description &&
-          self.required == other.required && self.type == other.type && self.elements_type == other.elements_type
+          name == other.name && description == other.description &&
+          required == other.required && type == other.type &&
+          elements_type == other.elements_type && optional == other.optional
       end
-
     end
   end
-end
+end

data/lib/angus/definitions/request_element.rb

@@ -30,16 +30,21 @@ module Angus
       #   @return [String] the elements type of the request element.
       attr_accessor :elements_type
 
+      # @!attribute [rw] optional
+      #   @return [Boolean] true if the element is optional
+      attr_accessor :optional
+
 
       def initialize(name = nil, description = nil, required = nil, type = nil,
-                     constraints = nil, valid_values = nil, elements_type = nil)
-        self.name= name if name
-        self.description= description if description
-        self.required= required if required
-        self.type= type if type
-        self.constraints= constraints if constraints
-        self.valid_values= valid_values if valid_values
-        self.elements_type= elements_type if elements_type
+                     constraints = nil, valid_values = nil, elements_type = nil, optional = nil)
+        self.name = name if name
+        self.description = description if description
+        self.required = required if required
+        self.type = type if type
+        self.constraints = constraints if constraints
+        self.valid_values = valid_values if valid_values
+        self.elements_type = elements_type if elements_type
+        self.optional = optional if optional
       end
 
       # Check if an object is equals to the current instance.
@@ -47,15 +52,14 @@ module Angus
       # @param [RequestElement] other The object to be compared.
       #
       # @return [Boolean] true if all the attributes are equal and false otherwise.
-      def == (other)
+      def ==(other)
         other.instance_of?(Definitions::RequestElement) &&
-          self.name == other.name && self.description == other.description &&
-          self.required == other.required && self.type == other.type &&
-          self.constraints == other.constraints &&
-          self.valid_values == other.valid_values &&
-          self.elements_type == other.elements_type
+          name == other.name && description == other.description &&
+          required == other.required && type == other.type &&
+          constraints == other.constraints &&
+          valid_values == other.valid_values &&
+          elements_type == other.elements_type && optional == other.optional
       end
-
     end
   end
-end
+end

data/lib/angus/definitions/response_element.rb

@@ -1,7 +1,6 @@
 module Angus
   module SDoc
     class Definitions::ResponseElement
-
       # @!attribute [rw] name
       #   @return [String] the name of the response element.
       attr_accessor :name
@@ -26,16 +25,20 @@ module Angus
       #   @return [String] the elements type of the response element.
       attr_accessor :elements_type
 
+      # @!attribute [rw] optional
+      #   @return [Boolean] true if the element is optional
+      attr_accessor :optional
+
       def initialize(name = nil, description = nil, required = nil, type = nil, default = nil,
-                     elements_type = nil)
+                     elements_type = nil, optional = nil)
         @name = name
         @description = description
         @required = required
         @type = type
         @default = default
         @elements_type = elements_type
+        @optional = optional
       end
-
     end
   end
-end
+end

data/lib/angus/definitions/service.rb

@@ -114,4 +114,4 @@ module Angus
 
     end
   end
-end
+end

data/lib/angus/definitions/uri_element.rb

@@ -17,4 +17,4 @@ module Angus
 
     end
   end
-end
+end

data/lib/angus/definitions_reader.rb

@@ -1,12 +1,11 @@
 module Angus
   module SDoc
     class DefinitionsReader
-
-      OPERATIONS = 'operations'
-      CONFIGURATIONS = %w{service proxy_operations representations glossary messages}
+      OPERATIONS = 'operations'.freeze
+      CONFIGURATIONS =
+        %w[service proxy_operations representations glossary messages optional].freeze
 
       class << self
-
         # Returns the tree of objects for the service.
         #
         # @param [String] base_path The base path of the YML files.
@@ -214,6 +213,7 @@ module Angus
               field.type = field_hash['type']
               field.required = field_hash['required']
               field.elements_type = field_hash['elements_type']
+              field.optional = field_hash['optional']
               field
             end
 
@@ -273,6 +273,7 @@ module Angus
                 request_element.constraints = element_hash['constraints']
                 request_element.valid_values = element_hash['valid_values']
                 request_element.elements_type = element_hash['elements_type']
+                request_element.optional = element_hash['optional']
 
                 request_element
               end
@@ -306,6 +307,7 @@ module Angus
                 response_element.type = element_hash['type']
                 response_element.default = element_hash['default']
                 response_element.elements_type = element_hash['elements_type']
+                response_element.optional = element_hash['optional']
 
                 response_element
               end
@@ -329,9 +331,7 @@ module Angus
           Angus::SDoc::Definitions::Glossary.new(glossary_hash)
         end
         private :build_glossary
-
       end
-
     end
   end
-end
+end

data/lib/angus/exceptions/base.rb

@@ -1 +1 @@
-require_relative 'invalid_service_message'
+require_relative 'invalid_service_message'

data/lib/angus/exceptions/invalid_service_message.rb

@@ -22,11 +22,11 @@ module Angus
         message
       end
 
-      def == (other)
+      def ==(other)
         other.kind_of?(InvalidServiceMessage) &&
           other.message == self.message && self.message_key == other.message_key
       end
 
     end
   end
-end
+end

data/lib/angus/sdoc/html_formatter.rb

@@ -52,4 +52,4 @@ module Angus
 
     end
   end
-end
+end

data/lib/angus/sdoc/json_formatter.rb

@@ -48,8 +48,8 @@ module Angus
         # @option return [String] :description
         def glossary_term_for_json(glossary_term_definition)
           {
-            :long_name => glossary_term_definition.long_name,
-            :description => glossary_term_definition.description
+            long_name: glossary_term_definition.long_name,
+            description: glossary_term_definition.description
           }
         end
 
@@ -65,10 +65,10 @@ module Angus
         # @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
+            key: message_definition.key,
+            description: message_definition.description,
+            level: message_definition.level,
+            status_code: message_definition.status_code
           }
         end
 
@@ -88,17 +88,17 @@ module Angus
         # @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.http_method
+            name: operation_definition.name,
+            description: operation_definition.description,
+            path: operation_definition.path,
+            method: operation_definition.http_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 })
+            data.merge!({ uri: uri_elements })
           end
 
           if operation_definition.request_elements && !operation_definition.request_elements.empty?
@@ -106,7 +106,7 @@ module Angus
               request_element_for_json(request_element)
             end
 
-            data.merge!({ :request => request_elements })
+            data.merge!({ request: request_elements })
           end
 
           if operation_definition.response_elements && !operation_definition.response_elements.empty?
@@ -114,7 +114,7 @@ module Angus
               response_element_for_json(response_element)
             end
 
-            data.merge!({:response => response_elements})
+            data.merge!({ response: response_elements })
           end
 
           if operation_definition.messages && !operation_definition.messages.empty?
@@ -122,7 +122,7 @@ module Angus
               message_for_json(message)
             end
 
-            data.merge!({:messages => messages})
+            data.merge!({ messages: messages })
           end
 
           data
@@ -139,9 +139,9 @@ module Angus
         # @option return [String] :service
         def proxy_operation_for_json(proxy_operation_definition)
           {
-            :path => proxy_operation_definition.path,
-            :method => proxy_operation_definition.http_method,
-            :service => proxy_operation_definition.service_name
+            path: proxy_operation_definition.path,
+            method: proxy_operation_definition.http_method,
+            service: proxy_operation_definition.service_name
           }
         end
 
@@ -170,17 +170,18 @@ module Angus
         # @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
+            field: representation_field_definition.name,
+            description: representation_field_definition.description,
+            required: representation_field_definition.required,
+            optional: representation_field_definition.optional
           }
 
           if representation_field_definition.type
-            data.merge!({:type => 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})
+            data.merge!({ elements_type: representation_field_definition.elements_type })
           end
 
           data
@@ -199,17 +200,18 @@ module Angus
         # @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
+            element: request_element_definition.name,
+            description: request_element_definition.description,
+            required: request_element_definition.required,
+            optional: request_element_definition.optional
           }
 
           if request_element_definition.type
-            data.merge!({:type => 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})
+            data.merge!({ elements_type: request_element_definition.elements_type })
           end
 
           data
@@ -228,17 +230,18 @@ module Angus
         # @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
+            element: response_element_definition.name,
+            description: response_element_definition.description,
+            required: response_element_definition.required,
+            optional: response_element_definition.optional
           }
 
           if response_element_definition.type
-            data.merge!({:type => 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})
+            data.merge!({ elements_type: response_element_definition.elements_type })
           end
 
           data
@@ -282,16 +285,16 @@ module Angus
           end
 
           {
-            :service => {
-              :service => service_definition.name,
-              :code_name => service_definition.code_name,
-              :version => service_definition.version
+            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)
+            operations: operations,
+            proxy_operations: proxy_operations,
+            representations: representations,
+            messages: messages,
+            glossary: glossary_for_json(service_definition.glossary)
           }
         end
 
@@ -305,8 +308,8 @@ module Angus
         # @option return [String] :description
         def uri_element_for_json(uri_element_definition)
           {
-            :element => uri_element_definition.name,
-            :description => uri_element_definition.description
+            element: uri_element_definition.name,
+            description: uri_element_definition.description
           }
         end
 
@@ -314,4 +317,4 @@ module Angus
 
     end
   end
-end
+end

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

@@ -122,6 +122,7 @@
                 <td>Name</td>
                 <td>Description</td>
                 <td>Required?</td>
+                <td>Optional?</td>
               </tr>
             </thead>
             <tbody>
@@ -144,6 +145,7 @@
                     <% end %>
                   </td>
                   <td><%= element.required %></td>
+                  <td><%= element.optional %></td>
                 </tr>
               <% end %>
             </tbody>
@@ -158,6 +160,7 @@
                 <td>Name</td>
                 <td>Description</td>
                 <td>Required?</td>
+                <td>Optional?</td>
               </tr>
             </thead>
             <tbody>
@@ -176,6 +179,7 @@
                     <% end %>
                   </td>
                   <td><%= element.required %></td>
+                  <td><%= element.optional %></td>
                 </tr>
               <% end %>
             </tbody>
@@ -219,6 +223,7 @@
             <td>Name</td>
             <td>Description</td>
             <td>Required?</td>
+            <td>Optional?</td>
           </tr>
         </thead>
         <tbody>
@@ -234,6 +239,7 @@
                 <% end %>
               </td>
               <td><%= field.required %></td>
+              <td><%= field.optional %></td>
             </tr>
           <% end %>
         </tbody>
@@ -295,4 +301,3 @@
 
   </body>
 </html>
-

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

@@ -121,6 +121,7 @@
               <td>Nombre</td>
               <td>Descripción</td>
               <td>Requerido</td>
+              <td>Opcional</td>
             </tr>
           </thead>
           <tbody>
@@ -143,6 +144,7 @@
               <% end %>
               </td>
               <td><%= element.required %></td>
+              <td><%= element.optional %></td>
             </tr>
           <% end %>
           </tbody>
@@ -157,6 +159,7 @@
               <td>Nombre</td>
               <td>Descripción</td>
               <td>Requerido</td>
+              <td>Opcional</td>
             </tr>
           </thead>
           <tbody>
@@ -175,6 +178,7 @@
               <% end %>
               </td>
               <td><%= element.required %></td>
+              <td><%= element.optional %></td>
             </tr>
           <% end %>
           </tbody>
@@ -218,6 +222,7 @@
               <td>Nombre de Atributo</td>
               <td>Descripción</td>
               <td>Requerido</td>
+              <td>Opcional</td>
             </tr>
           </thead>
           <tbody>
@@ -233,6 +238,7 @@
               <% end %>
               </td>
               <td><%= field.required %></td>
+              <td><%= field.optional %></td>
             </tr>
           <% end %>
           </tbody>
@@ -293,4 +299,4 @@
     <% end %>
 
     </body>
-</html>
+</html>

data/lib/angus/sdoc/version.rb

@@ -1,5 +1,5 @@
 module Angus
   module SDoc
-    VERSION = '0.0.7'
+    VERSION = '0.0.8'
   end
 end

data/lib/angus/sdoc.rb

@@ -3,4 +3,4 @@ require 'yaml'
 require 'pathname'
 
 require_relative 'sdoc/version'
-require_relative 'base'
+require_relative 'base'

data/lib/angus-sdoc.rb

@@ -1 +1 @@
-require_relative 'angus/sdoc'
+require_relative 'angus/sdoc'

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: angus-sdoc
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Pablo Ifran
 - Adrian Gomez
 - Gianfranco Zas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -30,32 +30,32 @@ dependencies:
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,6 +68,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 6.4.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 6.4.5
 - !ruby/object:Gem::Dependency
   name: json_expressions
   requirement: !ruby/object:Gem::Requirement
@@ -86,44 +100,44 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov-text
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ci_reporter
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +192,7 @@ homepage: https://github.com/Moove-it/angus-sdoc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,9 +207,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Expose service API documentation.
 test_files: []