washout_builder 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e260042314d03a1b4870adc1f58aa09b3bb0f03
-  data.tar.gz: 45e9bd052649d80b029ddfeeb20d8e3399dc89f6
+  metadata.gz: ce93207677248ea25aec7558a3266667c7e1ee45
+  data.tar.gz: 71325291f14d1069c7754c4ba5add1f367cd3335
 SHA512:
-  metadata.gz: a3e0839175bad01174789649207527c2f338cbe42a29e604af71c3b555930687df41d44807aeef2700f5365357d963a69798e8f6920d5fdee7d956de3eca15ba
-  data.tar.gz: dd7a24b984e06b0863e787cf28c54265a74334ba4d9b384a28db59828c8c74c0f514bfa3507f25954bd11ce657323fc6f38ffd84fbe922c37205892ea21a3d17
+  metadata.gz: f6ab9c9c591e68539ffd4f7052f723765a42adfc5401d53866578122771f36b61bfcb9ffb162f5e2b31a00cf15cf564f6cdee853b823f3cef80add358ba109c6
+  data.tar.gz: 70785954e5697320a6c42948f302205120df5632482be8420e38fe8a6b644c093321c0e89402fee3221920857e25d150ab7cd02500cd54b0204e76da8d294cd7

data/app/views/wash_with_html/_complex_type.builder

@@ -4,7 +4,7 @@ unless object.blank?
   xml.h3  { |pre| pre << "#{class_name} #{ancestors.blank? ? "" : "<small>(extends <a href='##{ancestors[0].to_s.classify}'>#{ancestors[0].to_s.classify}</a>)</small>" } " }
 
 
-  if WashoutBuilder::Type.all_param_classes.include?(object.class)
+  if WashoutBuilder::Type.base_param_class.present? && object.is_a?(WashoutBuilder::Type.base_param_class)
     xml.ul("class" => "pre") {
       object.map.each do |element|
         xml.li { |pre|

data/lib/washout_builder.rb

@@ -4,12 +4,16 @@ require 'active_support/core_ext/hash/keys'
 require 'active_support/concern'
 Gem.find_files('washout_builder/**/*.rb').each { |path| require path }
 
+# finds all the exception class and extends them by including the ExceptionModel module in order to be
+# able to generate documentation for exceptions
 WashoutBuilder::Type.all_fault_classes.each do |exception_class|
   exception_class.class_eval do
     extend WashoutBuilder::Document::ExceptionModel
   end
 end
 
+# finds all the classes that have defined the "soap_action" method and overrides it so that
+# it parses the definition properly for generating documentation
 WashoutBuilder::Type.all_controller_classes.each do |controller|
   controller.class_eval do
     alias_method :original_soap_action, :soap_action
@@ -17,13 +21,18 @@ WashoutBuilder::Type.all_controller_classes.each do |controller|
   end
 end
 
-WashoutBuilder::Type.all_param_classes.each do |controller|
-  controller.class_eval do
+# find the class that is used for parsing definition of soap actions and add method for parsing definition
+# and also includes the ComplexType module that is used for generating documentation
+base_param_class = WashoutBuilder::Type.base_param_class
+if base_param_class.present?
+  base_param_class.class_eval do
     extend WashoutBuilder::Param
     include WashoutBuilder::Document::ComplexType
   end
 end
 
+# finds all the soap config classes that have the methods "config" and "keys" and overrides them in order to add the "description"key to the allowed keys
+# this will allow webservices to specify a description besides the namespace and endpoint
 WashoutBuilder::Type.all_soap_config_classes.each do |controller|
   controller.class_eval do
     singleton_class.send(:alias_method, :original_config, :config)

data/lib/washout_builder/document/complex_type.rb

@@ -27,7 +27,7 @@ module WashoutBuilder
       # @param [Class] complex_class the complex type name used for searching
       #
       # @return [Boolean] returns true or false if the complex type is found inside the array
-      #
+      # @raise [RuntimeError] Raises a runtime error if is detected a duplicate use of the complex type
       # @api public
       def check_duplicate_complex_class(defined, complex_class)
         complex_obj_found = defined.find { |hash| hash[:class] == complex_class }

data/lib/washout_builder/param.rb

@@ -1,29 +1,39 @@
 module WashoutBuilder
+  # module that extends the base WashoutParam to allow parsing of definitions for building documentation
   module Param
     extend ActiveSupport::Concern
 
+    # Method that receives the arguments for a soap action (input or output) and tries to parse the definition (@see WashOutParam#parse_def)
+    #
+    # the following lines was removed from original method because when generating the documentation
+    #  the "source_class" attrtibute of the object was not the name of the class of the complex tyoe
+    # but instead was the name given in the hash
+    #
+    # if definition.is_a?(Class) && definition.ancestors.include?(WashOut::Type)
+    #        definition = definition.wash_out_param_map
+    #    end
+    #
+    # @example Given the class ProjectType as a "definition" argument, the complex type name should be  ProjectType and not "project"
+    #  class ProjectType < WashOut::Type
+    #  map :project => {
+    # :name                                    => :string,
+    #  :description                           => :string,
+    #  :users                                    => [{:mail => :string }],
+    #  }
+    # end
+    #
+    #
+    # @see WashoutBuilder::SOAP#soap_action
+    # @see WashOutParam#initialize
+    #
+    # @param [WasOut::SoapConfig] soap_config Holds the soap configuration for the entire web service
+    # @param [Object] definition  Any type of object ( this is passed from the soap action)
+    #
+    # @return [Type] description of returned object
     def parse_builder_def(soap_config, definition)
       raise '[] should not be used in your params. Use nil if you want to mark empty set.' if definition == []
       return [] if definition.blank?
 
-      # the following lines was removed because when generating the documentation
-      #  the "source_class" attrtibute of the object was not the name of the class of the complex tyoe
-      # but instead was the name given in the hash
-      # Example :
-      #  class ProjectType < WashOut::Type
-      #  map :project => {
-      # :name                                    => :string,
-      #  :description                           => :string,
-      #  :users                                    => [{:mail => :string }],
-      #  }
-      # end
-      #
-      # The name of the complex type should be ProjectType and not "project"
-
-      #     if definition.is_a?(Class) && definition.ancestors.include?(WashOut::Type)
-      #        definition = definition.wash_out_param_map
-      #    end
-
       definition = { value: definition } unless definition.is_a?(Hash) # for arrays and symbols
 
       definition.map do |name, opt|

data/lib/washout_builder/type.rb

@@ -16,6 +16,10 @@ module WashoutBuilder
       classes
     end
 
+    # returns all the controller classes that should override the "soap_action" method
+    #
+    # @return [Array<Class>] returns all the controller classes that should override the "soap_action" method
+    # @api public
     def self.all_controller_classes
       classes = []
       classes << WashOut::Rails::Controller::ClassMethods if defined?(WashOut::Rails::Controller::ClassMethods)
@@ -23,12 +27,18 @@ module WashoutBuilder
       classes
     end
 
-    def self.all_param_classes
-      classes = []
-      classes << WashOut::Param if defined?(WashOut::Param)
-      classes
+    # returns the base class that is used for parsing definitions of soap actions
+    #
+    # @return [Class] returns the base class that is used for parsing definitions of soap actions
+    # @api public
+    def self.base_param_class
+      defined?(WashOut::Param) ? WashOut::Param : nil
     end
 
+    # returns all the soap config classss that should be overriden to allow description of web service also besides namespace and endpoint
+    #
+    # @return [Array<Class>] returns all the soap config classss that should be overriden to allow description of web service also besides namespace and endpoint
+    # @api public
     def self.all_soap_config_classes
       classes = []
       classes << WashOut::SoapConfig if defined?(WashOut::SoapConfig)

data/lib/washout_builder/version.rb

@@ -12,7 +12,7 @@ module WashoutBuilder
     # the minor version of the gem
     MINOR = 0
     # the tiny version of the gem
-    TINY = 0
+    TINY = 2
     # if the version should be a e
     PRE = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: washout_builder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - bogdanRada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2015-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wash_out