washout_builder 1.7.5 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 159e07561571b409357453527454de91fc1ed030b715b663467d5609fc171e90
-  data.tar.gz: 763e07ae420b1897eb031e33cb0b5073cd534c6f262eb358b6e7d9a1c2f0a95e
+  metadata.gz: 07cbf72181269afe7c81be817b82027fc0353f4be0174b926b329c9963712d20
+  data.tar.gz: 6431a14a4a5e4fedc0c3682dbeec724678eaec360025eff7292a5c133d2cc421
 SHA512:
-  metadata.gz: 7a7d90b7e0e07f2de6be67edeb1fa0957e966c26da4bb53b1c14a38d9e8e25fec19ef6da7fb043c9ff9d4ff4f3506351854766b1a2c3f1cd25b9d5e97e0ca7e9
-  data.tar.gz: bc06865bdb9a5f2411cb84434659fb3a5c948107c69e41aee60893a5dc456f28945c4b0662f1bcd08a3966e900574024f529ca5f2f117356965592297437e01a
+  metadata.gz: '0220855ff5d6656482d2a23db14e6150330508d9d55ca8cdd89bd66605ae783afcf2c0416f188eeb4f58b0dc8ec69c5d2d20326d1cec0bad3cba6d1aac7dbd02'
+  data.tar.gz: 373c906bb927c4dc0e4a5610f811dccba8ff39adfa3dc5fa1e919dcdca23861d35ab605eca7d0b1b7457dfcd3fb3dc840b9bd55e078f0943323a61343fcab7a8

data/.travis.yml

@@ -58,7 +58,7 @@ matrix:
   - rvm: 2.6.5
     gemfile: gemfiles/rails_4.1.1.gemfile
   - rvm: 2.6.5
-   gemfile: gemfiles/rails_4.2.0.gemfile
+    gemfile: gemfiles/rails_4.2.0.gemfile
 rvm:
   - 2.2.5
   - 2.3.1
@@ -67,5 +67,7 @@ rvm:
   - 2.4.7
   - 2.5.6
   - 2.6.5
+  - 2.7.1
+  - 3.0.0
 notifications:
   email: false

data/Appraisals

@@ -17,7 +17,7 @@ if RUBY_VERSION <= "2.4.0"
     gem 'actionpack' , '4.2.7.1'
   end
 end
-if  RUBY_VERSION >= '2.2.0' && ENV['BUNDLER_VERSION'].to_s <= '2.0'
+if RUBY_VERSION >= '2.2.0' && RUBY_VERSION < '3.0.0' && ENV['BUNDLER_VERSION'].to_s <= '2.0'
   appraise "rails-5.0.0" do
     gem "rails", "5.0.0"
   end
@@ -40,7 +40,7 @@ if  RUBY_VERSION >= '2.2.0' && ENV['BUNDLER_VERSION'].to_s <= '2.0'
   end
 end
 
-if  RUBY_VERSION >= '2.2.0' && ENV['BUNDLER_VERSION'].to_s >= '2.0'
+if RUBY_VERSION >= '2.2.0' && RUBY_VERSION < '3.0.0' && ENV['BUNDLER_VERSION'].to_s >= '2.0'
   appraise "rails-5.2.0" do
     gem "rails", "5.2.0"
   end
@@ -57,3 +57,9 @@ if  RUBY_VERSION >= '2.2.0' && ENV['BUNDLER_VERSION'].to_s >= '2.0'
     gem "rails", "6.0.1"
   end
 end
+
+if RUBY_VERSION >= '3.0.0' && ENV['BUNDLER_VERSION'].to_s >= '2.0'
+  appraise "rails-6.1.3" do
+    gem "rails", "6.1.3"
+  end
+end

data/Gemfile

@@ -3,21 +3,3 @@ source 'http://rubygems.org'
 gemspec
 
 gem 'wash_out', git: 'https://github.com/inossidabile/wash_out.git'
-
-gem 'wasabi'
-gem 'savon', '>= 2.11'
-gem 'httpi', '>= 2.4'
-gem 'nokogiri', '>= 1.7'
-
-gem 'rspec-rails','4.0.0.beta3'
-gem 'appraisal', '>= 2.1'
-gem 'simplecov', '>= 0.12'
-gem 'simplecov-summary', '>= 0.0.5'
-gem 'mocha', '>= 1.2'
-gem 'coveralls', '>= 0.8'
-
-gem "yard", '>= 0.9.20'
-gem 'yard-rspec', '>= 0.1'
-gem 'redcarpet', '>= 3.4'
-gem 'github-markup', '>= 1.4'
-gem 'inch', '>= 0.7'

data/README.md

@@ -10,6 +10,27 @@ WashOutBuilder is a Soap Service Documentation generator (extends [WashOut](http
 
 The way [WashOut](https://github.com/inossidabile/wash_out) is used is not modified, it just extends its functionality by generating html documentation to your services that you write
 
+NEW Improvements in version 2.0.1
+---------------------------------
+ - Fix issue when trying to re-use same complex type (with same structure) multiple times inside same controller 
+
+NEW Improvements in version 2.0.0
+---------------------------------
+
+This release tries to fix some major bugs and introduces backward incompatible changes. 
+ - The complex type list will contain now exactly same types used when doing an actual SOAP request
+ - Same for when listing the soap actions ( the return type and parameters ).
+ 
+Initially the way the complex types were shown on the page was not correct, because it was not reflecting 
+the actual way the SOAP action receives its arguments when doing an actual SOAP request to that controller
+
+The main issue was not handling correctly the classes that are inheriting from WashOut::Type. 
+
+This release tries to fix those issues.
+
+Note: Only internal methods have been changed. The configuration has not changed.
+So in order to upgrade to this new version, just update the version in your Gemfile/gemspec file
+
 NEW Improvements in version 1.5.1
 ---------------------------------
 

data/app/helpers/washout_builder_complex_type_helper.rb

@@ -1,5 +1,6 @@
 # module that is used for constructing complex types in HTML-Documentation
 module WashoutBuilderComplexTypeHelper
+  include WashoutBuilderSharedHelper
   # this method is for printing the attributes of a complex type
   # if the attributes are primitives this will show the attributes with  blue color
   # otherwise will call another method for printing the complex attribute
@@ -49,8 +50,9 @@ module WashoutBuilderComplexTypeHelper
   def create_complex_element_type_html(pre, element, element_description)
     complex_class = element.find_complex_class_name
     return if complex_class.nil?
-    complex_class_content = element.multiplied ? "Array of #{complex_class}" : "#{complex_class}"
-    pre << "<a href='##{complex_class}'><span class='lightBlue'>#{complex_class_content}</span></a>&nbsp;<span class='bold'>#{element.name}</span>"
+    real_class = find_correct_complex_type(complex_class)
+    complex_class_content = element.multiplied ? "Array of #{real_class}" : "#{real_class}"
+    pre << "<a href='##{real_class}'><span class='lightBlue'>#{complex_class_content}</span></a>&nbsp;<span class='bold'>#{element.name}</span>"
     pre << "&#8194;<span>#{html_safe(element_description)}</span>" unless element_description.blank?
     pre
   end

data/app/helpers/washout_builder_method_arguments_helper.rb

@@ -1,5 +1,6 @@
 # helper that is used to show the arguments of a method with their types in HTML documentation
 module WashoutBuilderMethodArgumentsHelper
+  include WashoutBuilderSharedHelper
   # displays the parameter of a method as argument and determines if the parameter is basic type or complex type
   #
   # @see WashoutBuilder::Document::ComplexType#find_complex_class_name
@@ -37,8 +38,9 @@ module WashoutBuilderMethodArgumentsHelper
   # @api public
   def create_method_argument_complex_element(pre, param, use_spacer, spacer, complex_class)
     return if complex_class.nil?
-    argument_content = param.multiplied ? "Array of #{complex_class}" : "#{complex_class}"
-    pre << "#{use_spacer ? spacer : ''}<a href='##{complex_class}'><span class='lightBlue'>#{argument_content}</span></a>&nbsp;<span class='bold'>#{param.name}</span>"
+    real_class = find_correct_complex_type(complex_class)
+    argument_content = param.multiplied ? "Array of #{real_class}" : "#{real_class}"
+    pre << "#{use_spacer ? spacer : ''}<a href='##{real_class}'><span class='lightBlue'>#{argument_content}</span></a>&nbsp;<span class='bold'>#{param.name}</span>"
   end
 
   # this method will check if the current index of the argument is not last, will insert a comma  then a break if the argument is followed by other arguments,

data/app/helpers/washout_builder_method_list_helper.rb

@@ -1,5 +1,6 @@
 # helper that is used to list the method's return tyep as a LI element in HTML documentation
 module WashoutBuilderMethodListHelper
+  include WashoutBuilderSharedHelper
   # this method will create the return type of the method and check if the type is basic or complex type or array of types
   #
   # @param [Builder::XmlMarkup] xml the markup builder that is used to insert HTML line breaks or span elements
@@ -10,9 +11,10 @@ module WashoutBuilderMethodListHelper
   #
   # @api public
   def create_return_complex_type_list_html(xml, complex_class, builder_out)
-    return_content = builder_out[0].multiplied ?  "Array of #{complex_class}" : "#{complex_class}"
+    real_class = find_correct_complex_type(complex_class)
+    return_content = builder_out[0].multiplied ?  "Array of #{real_class}" : "#{real_class}"
     xml.span('class' => 'pre') do
-      xml.a('href' => "##{complex_class}") do |inner_xml|
+      xml.a('href' => "##{real_class}") do |inner_xml|
         inner_xml.span('class' => 'lightBlue') do |y|
           y << "#{return_content}"
         end

data/app/helpers/washout_builder_method_return_type_helper.rb

@@ -1,5 +1,6 @@
 # helper that is used to create the return types of methods in HTML documentation
 module WashoutBuilderMethodReturnTypeHelper
+  include WashoutBuilderSharedHelper
   # this method will print the return type next to the method name
   # @see WashoutBuilder::Document::ComplexType#find_complex_class_name
   # @see WashoutBuilder::Type::BASIC_TYPES
@@ -37,11 +38,12 @@ module WashoutBuilderMethodReturnTypeHelper
   # @api public
   def html_public_method_complex_type(pre, output, complex_class)
     return if complex_class.nil?
+    real_class = find_correct_complex_type(complex_class)
     if output[0].multiplied
-      complex_return_type = "Array of #{complex_class}"
+      complex_return_type = "Array of #{real_class}"
     else
-      complex_return_type = "#{complex_class}"
+      complex_return_type = "#{real_class}"
     end
-    pre << "<a href='##{complex_class}'><span class='lightBlue'>#{complex_return_type}</span></a>"
+    pre << "<a href='##{real_class}'><span class='lightBlue'>#{complex_return_type}</span></a>"
   end
 end

data/app/helpers/washout_builder_shared_helper.rb

@@ -0,0 +1,29 @@
+module WashoutBuilderSharedHelper
+  # When displaying a complex type that inherits from WashOut::Type
+  # we must use its descendant name to properly show the correct Type
+  # that can we used to make the actual request to the action
+  #
+  # @param [Class, String] complex_class the name of the complex type either as a string or a class
+  # @return [Class, String]
+  # @api public
+  def find_correct_complex_type(complex_class)
+    real_class = find_class_from_string(complex_class)
+    if real_class.present? && real_class.ancestors.include?( WashoutBuilder::Type.base_type_class)
+      descendant = WashoutBuilder::Type.base_param_class.parse_def(config, real_class.wash_out_param_map)[0]
+      descendant.find_complex_class_name
+    else
+      complex_class
+    end
+  end
+
+  # Tries to constantize a string or a class to return the class
+  #
+  # @param [String] complex_class A string that contains the name of a class
+  # @return [Class, nil] returns the class if it is classes_defined otherwise nil
+  # @api public
+  def find_class_from_string(complex_class)
+    complex_class.is_a?(Class) ? complex_class : complex_class.constantize
+  rescue
+    nil
+  end
+end

data/gemfiles/rails_6.1.3.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "wash_out", git: "https://github.com/inossidabile/wash_out.git"
+gem "rails", "6.1.3"
+
+gemspec path: "../"

data/install-travis-bundler.sh

@@ -11,8 +11,8 @@ echo "Trying to compare rails ${rails_version:="1"} with 5.2"
 if (( $(echo "${rails_version%.*} >= 5.2" |bc -l) )); then
    echo "Installing Bundler v2"
    gem uninstall -v '< 2.0' -i "$(rvm gemdir)"@global -ax bundler --force || true
-   gem install bundler -v '2.0.1'
-   export MY_BUNDLER_VERSION="_2.0.1_"
+   gem install bundler -v '2.2.11'
+   export MY_BUNDLER_VERSION="_2.2.11_"
 else
    echo "Installing Bundler v1"
    gem uninstall -v '>= 2' -i "$(rvm gemdir)"@global -ax bundler --force  || true

data/lib/washout_builder.rb

@@ -52,7 +52,6 @@ end
 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

data/lib/washout_builder/document/complex_type.rb

@@ -30,7 +30,7 @@ module WashoutBuilder
       # @raise [RuntimeError] Raises a runtime error if is detected a duplicate use of the complex type
       # @api public
       def check_duplicate_complex_class(classes_defined, complex_class)
-        complex_obj_found = classes_defined.find { |hash| hash[:class] == complex_class }
+        complex_obj_found = classes_defined.find { |hash| hash if hash[:class] == complex_class && hash[:obj].find_param_structure.keys != self.find_param_structure.keys }
         raise "Duplicate use of `#{basic_type}` type name. Consider using classified types." if !complex_obj_found.nil? && struct? && !classified?
       end
 
@@ -71,25 +71,6 @@ module WashoutBuilder
         self.map = map.delete_if { |element| keys.include?(element.name) }
       end
 
-      # Dirty hack to fix the first washout param type.
-      # This only applies if the first complex type is inheriting WashOutType
-      # its name should be set to its descendant  and the map of the current object will be set to its descendant
-      # @see  WashOut::Param#parse_builder_def
-      #
-      # @param [WashOut::SoapConfig] config an object that holds the soap configuration
-      # @param [Class, String] complex_class the name of the complex type either as a string or a class
-      # @return [void]
-      # @api public
-      def fix_descendant_wash_out_type(config, complex_class)
-        param_class = find_class_from_string(complex_class)
-        base_param_class = WashoutBuilder::Type.base_param_class
-        base_type_class =  WashoutBuilder::Type.base_type_class
-        return if base_param_class.blank? || base_type_class.blank?
-        return unless param_class.present? && param_class.ancestors.include?(base_type_class) && map[0].present?
-        descendant = base_param_class.parse_builder_def(config, param_class.wash_out_param_map)[0]
-        self.name = descendant.name
-        self.map = descendant.map
-      end
 
       # Description of method
       #
@@ -172,8 +153,8 @@ module WashoutBuilder
       def get_nested_complex_types(config, classes_defined)
         classes_defined = [] if classes_defined.blank?
         complex_class = find_complex_class_name(classes_defined)
-        fix_descendant_wash_out_type(config, complex_class)
-        unless complex_class.nil?
+        real_class = find_class_from_string(complex_class)
+        if complex_class.present? && (real_class.blank? || (real_class.present? && !real_class.ancestors.include?( WashoutBuilder::Type.base_type_class)))
           classes_defined << complex_type_hash(complex_class, self, complex_type_ancestors(config, complex_class, classes_defined))
         end
         classes_defined = complex_type_descendants(config, classes_defined)
@@ -216,7 +197,7 @@ module WashoutBuilder
       # @param [Array<Hash>] classes_defined An Array with all the complex types that have been detected so far
       # @return [Array<Class>] An Array of classes from which the class that is sent as parameter inherits from
       # @api public
-      def get_class_ancestors(config, class_name, classes_defined)
+      def  get_class_ancestors(config, class_name, classes_defined)
         ancestors = get_ancestors(class_name)
         return if ancestors.blank?
         base_param_class = WashoutBuilder::Type.base_param_class

data/lib/washout_builder/document/shared_complex_type.rb

@@ -8,7 +8,11 @@ module WashoutBuilder
       # @param [Array<Class>] array The array of classes that should be fitered from the ancestors if they are present
       # @return [Array<Class>] The classes from which the class given as first argument inherits from but filtering the classes passed as second argument
       def get_complex_type_ancestors(class_name, array)
-        (class_name.ancestors - class_name.included_modules).delete_if { |x| x.to_s.downcase == class_name.to_s.downcase || array.include?(x.to_s) }
+        (class_name.ancestors - class_name.included_modules).delete_if do |x|
+          x.to_s.downcase == class_name.to_s.downcase ||
+            array.include?(x.to_s) ||
+            (x.respond_to?(:abstract_class) && x.abstract_class)
+        end
       end
     end
   end

data/lib/washout_builder/soap.rb

@@ -37,8 +37,8 @@ module WashoutBuilder
         current_action = soap_actions[action]
         base_param_class = WashoutBuilder::Type.base_param_class
         return if base_param_class.blank?
-        current_action[:builder_in] = base_param_class.parse_builder_def(soap_config, options[:args])
-        current_action[:builder_out] = base_param_class.parse_builder_def(soap_config, options[:return])
+        current_action[:builder_in] = base_param_class.parse_def(soap_config, options[:args])
+        current_action[:builder_out] = base_param_class.parse_def(soap_config, options[:return])
         current_action[:args_description] = options[:args_description].present? && options[:args_description].is_a?(Hash) ? options[:args_description].stringify_keys : {}
         current_action
       end

data/lib/washout_builder/version.rb

@@ -8,9 +8,9 @@ module WashoutBuilder
   # the module that is used to generate the gem version
   module VERSION
     # the major version of the gem
-    MAJOR = 1
+    MAJOR = 2
     # the minor version of the gem
-    MINOR = 7
+    MINOR = 0
     # the tiny version of the gem
     TINY = 5
     # if the version should be a prerelease

data/spec/lib/washout_builder/document/complex_type_spec.rb

@@ -14,29 +14,29 @@ describe WashoutBuilder::Document::ComplexType do
   let(:namespaced_object) { get_wash_out_param(Api::TestType) }
 
   it 'returns the complex class name' do
-    expect(subject.find_complex_class_name).to eq('ProjectType')
+    expect(subject.find_complex_class_name).to eq('Project')
   end
 
   it 'returns the complex class with namespace' do
-    expect(namespaced_object.find_complex_class_name).to eq('Api::TestType')
+    expect(namespaced_object.find_complex_class_name).to eq('Project')
   end
 
-  it 'returns error if classname already detected (only used for hashes)' do
+  it 'does not return error if classname already detected (only used for hashes) and same structure' do
     subject.stubs(:classified?).returns(false)
     subject.stubs(:basic_type).returns('ProjectType')
-    defined = [{ class: 'ProjectType' }]
-    expect { subject.find_complex_class_name(defined) }.to raise_error(RuntimeError, 'Duplicate use of `ProjectType` type name. Consider using classified types.')
+    classes_defined = [{ class: 'ProjectType', obj: get_wash_out_param(ProjectType), ancestors: [] }]
+    expect { subject.find_complex_class_name(classes_defined) }.to_not raise_error(RuntimeError, 'Duplicate use of `ProjectType` type name. Consider using classified types.')
   end
 
-  it 'returns the param structure' do
-    expect(subject.find_param_structure).to eq("project"=>"struct")
+  it 'returns error if classname already detected (only used for hashes)' do
+    subject.stubs(:classified?).returns(false)
+    subject.stubs(:basic_type).returns('ProjectType')
+    classes_defined = [{ class: 'ProjectType', obj: get_wash_out_param(Api::TestType), ancestors: [] }]
+    expect { subject.find_complex_class_name(classes_defined) }.to raise_error(RuntimeError, 'Duplicate use of `ProjectType` type name. Consider using classified types.')
   end
 
-  it 'fixes the first descendant ' do
-    descendant = get_wash_out_param(ProjectType.wash_out_param_map)
-    subject.fix_descendant_wash_out_type(soap_config, ProjectType)
-    expect(subject.name).to eq(descendant.name)
-    expect(subject.map[0].find_param_structure).to eq(descendant.map[0].find_param_structure)
+  it 'returns the param structure' do
+    expect(subject.find_param_structure).to eq("description"=>"string", "name"=>"string", "users"=>"struct")
   end
 
   it 'same as ancestor' do
@@ -75,18 +75,18 @@ describe WashoutBuilder::Document::ComplexType do
 
   describe '#complex_type_descendants' do
     it 'returns empty array if not struct?' do
-      defined = []
+      classes_defined = []
       subject.stubs(:struct?).returns(false)
-      expect(subject.complex_type_descendants(soap_config, defined)).to eq(defined)
+      expect(subject.complex_type_descendants(soap_config, classes_defined)).to eq(classes_defined)
     end
 
     it 'returns the descendants if  struct?' do
-      defined = []
+      classes_defined = []
       subject.map.each do |obj|
-        obj.expects(:get_nested_complex_types).with(soap_config, defined).returns([obj.name])
+        obj.expects(:get_nested_complex_types).with(soap_config, classes_defined).returns([obj.name])
       end
       subject.stubs(:struct?).returns(true)
-      expect(subject.complex_type_descendants(soap_config, defined)).to eq(subject.map.map(&:name))
+      expect(subject.complex_type_descendants(soap_config, classes_defined)).to eq(subject.map.map(&:name))
     end
   end
 
@@ -97,21 +97,20 @@ describe WashoutBuilder::Document::ComplexType do
     let(:expected) { [complex_type_hash] }
 
     it 'returns the complex class ancestors' do
-      defined = []
-      subject.expects(:find_complex_class_name).with(defined).returns(complex_class)
-      subject.expects(:fix_descendant_wash_out_type).with(soap_config, complex_class).returns(true)
-      subject.expects(:complex_type_ancestors).with(soap_config, complex_class, defined).returns(ancestors)
+      classes_defined = []
+      subject.expects(:find_complex_class_name).with(classes_defined).returns(complex_class)
+      subject.expects(:find_class_from_string).with(complex_class).returns(nil)
+      subject.expects(:complex_type_ancestors).with(soap_config, complex_class, classes_defined).returns(ancestors)
       subject.expects(:complex_type_hash).with(complex_class, subject, ancestors).returns(complex_type_hash)
       subject.expects(:complex_type_descendants).with(soap_config, [complex_type_hash]).returns(expected)
-      expect(subject.get_nested_complex_types(soap_config, defined)).to eq(expected)
+      expect(subject.get_nested_complex_types(soap_config, classes_defined)).to eq(expected)
     end
 
     it 'returns the the descendants' do
-      defined = nil
+      classes_defined = nil
       subject.expects(:find_complex_class_name).with([]).returns(nil)
-      subject.expects(:fix_descendant_wash_out_type).with(soap_config, nil).returns(true)
       subject.expects(:complex_type_descendants).with(soap_config, []).returns(expected)
-      expect(subject.get_nested_complex_types(soap_config, defined)).to eq(expected)
+      expect(subject.get_nested_complex_types(soap_config, classes_defined)).to eq(expected)
     end
   end
 
@@ -135,7 +134,7 @@ describe WashoutBuilder::Document::ComplexType do
 
   describe '#get_class_ancestors' do
     let(:class_name) { 'ProjectType' }
-    let(:defined) { [] }
+    let(:classes_defined) { [] }
     let(:ancestors) { ['SomeInexistentClass'] }
     let(:ancestor_structure) { { ancestors[0].to_s.downcase => 'bla' } }
     let(:top_ancestors) {}
@@ -143,7 +142,7 @@ describe WashoutBuilder::Document::ComplexType do
 
     it 'returns nil if no ancestors' do
       subject.expects(:get_ancestors).with(class_name).returns(nil)
-      expect(subject.get_class_ancestors(soap_config, class_name, defined)).to eq(nil)
+      expect(subject.get_class_ancestors(soap_config, class_name, classes_defined)).to eq(nil)
     end
 
     it 'returns the ancestors and the top ones' do
@@ -153,15 +152,16 @@ describe WashoutBuilder::Document::ComplexType do
       WashOut::Param.stubs(:parse_def).returns([namespaced_object])
       subject.expects(:same_structure_as_ancestor?).with(namespaced_object).returns(false)
       subject.expects(:complex_type_hash).returns(complex_type_hash)
-      expect(subject.get_class_ancestors(soap_config, class_name, defined)).to eq([complex_type_hash])
+      expect(subject.get_class_ancestors(soap_config, class_name, classes_defined)).to eq([complex_type_hash])
     end
 
     it 'returns nil if same structure as ancestor' do
+      namespaced_object
       subject.expects(:get_ancestors).with(class_name).returns(ancestors)
       subject.expects(:ancestor_structure).with(ancestors).returns(ancestor_structure)
-      WashOut::Param.stubs(:parse_def).returns([namespaced_object])
+      WashOut::Param.stubs(:parse_def).with(soap_config, ancestor_structure).returns([namespaced_object])
       subject.expects(:same_structure_as_ancestor?).with(namespaced_object).returns(true)
-      expect(subject.get_class_ancestors(soap_config, class_name, defined)).to eq(nil)
+      expect(subject.get_class_ancestors(soap_config, class_name, classes_defined)).to eq(nil)
     end
   end
 end

data/spec/spec_helper.rb

@@ -102,7 +102,7 @@ def get_wash_out_param(class_or_struct, soap_config = OpenStruct.new(
   camelize_wsdl: false,
   namespace: '/api/wsdl'
 ))
-  WashOut::Param.parse_builder_def(soap_config, class_or_struct)[0]
+  WashOut::Param.parse_def(soap_config, class_or_struct)[0]
 end
 
 class Hash
@@ -154,3 +154,28 @@ unless defined?(silence_stream) # Rails 5
     old_stream.close
   end
 end
+
+# TODO: remove this when wasabi will update their code
+require 'uri'
+if !defined?(::URI.unescape)
+  ::URI.class_eval do
+    # this was removed in this commit
+    # https://github.com/ruby/uri/commit/61c6a47ebf1f2726b60a2bbd70964d64e14b1f98
+    # so we are adding it back because we need to be compatible with wasabi on ruby 3.0.0
+    module UriEscapeBackport
+
+      def escape(*arg)
+        ::URI::DEFAULT_PARSER.escape(*arg)
+      end
+
+      alias encode escape
+
+      def unescape(*arg)
+        ::URI::DEFAULT_PARSER.unescape(*arg)
+      end
+
+      alias decode unescape
+    end
+    extend UriEscapeBackport
+  end
+end

data/spec/support/complex_types/test_type.rb

@@ -2,9 +2,8 @@ module Api
   class TestType < WashOut::Type
     map project: {
       name: :string,
-      description: :string,
+      title: :string,
       users: [{ mail: :string }],
-      #  'dada'                                    => [Project]
     }
   end
 end

data/washout_builder.gemspec

@@ -21,4 +21,23 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'wash_out', '>= 0.9.1', '>= 0.9.1'
   s.add_runtime_dependency 'activesupport', '>= 4.0', '>= 4.0'
+
+  # wasabi >= 3.6.0 does not work well with savon
+  s.add_development_dependency 'wasabi', '< 3.6.0'
+  s.add_development_dependency 'savon', '~> 2.11', '>= 2.11'
+  s.add_development_dependency 'httpi', '~> 2.4', '>= 2.4'
+  s.add_development_dependency 'nokogiri', '~> 1.7', '>= 1.7'
+
+  s.add_development_dependency 'rspec-rails','4.0.2'
+  s.add_development_dependency 'appraisal', '~> 2.1', '>= 2.1'
+  s.add_development_dependency 'simplecov', '~> 0.12', '>= 0.12'
+  s.add_development_dependency 'simplecov-summary', '~> 0.0.5', '>= 0.0.5'
+  s.add_development_dependency 'mocha','~> 1.2', '>= 1.2'
+  s.add_development_dependency 'coveralls','~> 0.8', '>= 0.8'
+
+  s.add_development_dependency "yard", '~> 0.9', '>= 0.9.20'
+  s.add_development_dependency 'yard-rspec', '~> 0.1', '>= 0.1'
+  s.add_development_dependency 'redcarpet', '~> 3.4', '>= 3.4'
+  s.add_development_dependency 'github-markup', '~> 1.4', '>= 1.4'
+  s.add_development_dependency 'inch', '~> 0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: washout_builder
 version: !ruby/object:Gem::Version
-  version: 1.7.5
+  version: 2.0.5
 platform: ruby
 authors:
 - bogdanRada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-29 00:00:00.000000000 Z
+date: 2021-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wash_out
@@ -38,6 +38,288 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: wasabi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov-summary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+- !ruby/object:Gem::Dependency
+  name: yard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: 'WashOut Soap Service HTML-Documentation generator (extends WashOut https://github.com/inossidabile/wash_out/) '
 email: raoul_ice@yahoo.com
 executables: []
@@ -62,6 +344,7 @@ files:
 - app/helpers/washout_builder_method_arguments_helper.rb
 - app/helpers/washout_builder_method_list_helper.rb
 - app/helpers/washout_builder_method_return_type_helper.rb
+- app/helpers/washout_builder_shared_helper.rb
 - app/views/wash_with_html/_complex_type.builder
 - app/views/wash_with_html/_fault_type.builder
 - app/views/wash_with_html/_public_method.builder
@@ -82,6 +365,7 @@ files:
 - gemfiles/rails_5.2.4.gemfile
 - gemfiles/rails_6.0.0.gemfile
 - gemfiles/rails_6.0.1.gemfile
+- gemfiles/rails_6.1.3.gemfile
 - gemfiles/rails_api_4.2.7.gemfile
 - init.rb
 - install-travis-bundler.sh
@@ -92,7 +376,6 @@ files:
 - lib/washout_builder/document/shared_complex_type.rb
 - lib/washout_builder/engine.rb
 - lib/washout_builder/env_checker.rb
-- lib/washout_builder/param.rb
 - lib/washout_builder/router.rb
 - lib/washout_builder/soap.rb
 - lib/washout_builder/type.rb
@@ -158,7 +441,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: WashOut Soap Service HTML-Documentation generator (extends WashOut https://github.com/inossidabile/wash_out/)

data/lib/washout_builder/param.rb

@@ -1,50 +0,0 @@
-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?
-
-      definition = { value: definition } unless definition.is_a?(Hash) # for arrays and symbols
-
-      definition.map do |name, opt|
-        if opt.is_a? self
-          opt
-        elsif opt.is_a? Array
-          new(soap_config, name, opt[0], true)
-        else
-          new(soap_config, name, opt)
-        end
-      end
-    end
-  end
-end