washout_builder 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68cb0141260d3fc89155efb053c52aa7cf930884
-  data.tar.gz: b825e32605a57ce23663a8a4f9bd195cab8df9af
+  metadata.gz: 1e702f0e9e4f763b5deffe0314155a86ddd682d6
+  data.tar.gz: 3f8af9a0673595dfda19fb26c8c13f2127fe15aa
 SHA512:
-  metadata.gz: 570b1c3d47b9ec70b0c9a109a9522241a3e2540e97b68c04490b16c10add4c7310f0db39b0bcb73f7040fffffaf8d07d04d91e3eb8432f2f6453edb327cf0779
-  data.tar.gz: 472a262dd70a473e9447b47b15fbeea6a358dbc2bae5241162af6f8c1ca57fefa601149d28d5c6a56003b38bd9216cb88598104a7bbb576b6c912ade8a71195b
+  metadata.gz: db067847f80138433cc00bb80d6fd47d59792bb7823041f9ebe4f059e5ec5442bafd904eccbff80f7b7984bd3f9496932ed8e0527f19333a817c88c672d4a691
+  data.tar.gz: 7d5ac46444d9e033e4a5c15a01f60e8e553f42dfbffb54bbcecb18217f9d4d0885bde9825b7bb130c91436a206bddb9b093e04b7ff0a6856c5bd933b13048927

data/.gitignore

@@ -15,3 +15,4 @@ Gemfile.lock
 /nbproject/
 /.git-rewrite/
 /bin/**
+gemfiles

data/README.md

@@ -0,0 +1,162 @@
+washout_builder
+===============
+
+[![Gem Version](https://badge.fury.io/rb/washout_builder.svg)](http://badge.fury.io/rb/washout_builder) [![Build Status](https://travis-ci.org/bogdanRada/washout_builder.png?branch=master,develop)](https://travis-ci.org/bogdanRada/washout_builder) [![Dependency Status](https://gemnasium.com/bogdanRada/washout_builder.svg)](https://gemnasium.com/bogdanRada/washout_builder) [![Documentation Status](http://inch-ci.org/github/bogdanRada/washout_builder.svg?branch=master)](http://inch-ci.org/github/bogdanRada/washout_builder) [![Coverage Status](https://coveralls.io/repos/bogdanRada/washout_builder/badge.svg?branch=master)](https://coveralls.io/r/bogdanRada/washout_builder?branch=master) [![Code Climate](https://codeclimate.com/github/bogdanRada/washout_builder/badges/gpa.svg)](https://codeclimate.com/github/bogdanRada/washout_builder) [![Repo Size](https://reposs.herokuapp.com/?path=bogdanRada/washout_builder)](https://github.com/bogdanRada/washout_builder) [![Gem Downloads](https://ruby-gem-downloads-badge.herokuapp.com/washout_builder?type=total)](https://github.com/bogdanRada/washout_builder) [![Maintenance Status](http://stillmaintained.com/bogdanRada/washout_builder.png)](https://github.com/bogdanRada/washout_builder)
+
+Overview
+--------
+
+WashOutBuilder is a Soap Service Documentation generator (extends [WashOut](https://github.com/inossidabile/wash_out) /\)
+
+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
+
+Features
+--------
+
+-	Provides way of seeing the available services with links to documentation, endpoint and namespace
+-	Provides a human-readable HTML documentation generated for each service that you write
+
+Live DEMO
+=========
+
+-	[Demo Application](http://washout-builder.herokuapp.com)
+
+Demo Application Source Code
+----------------------------
+
+-	[Source Code](https://github.com/bogdanRada/washout_builder_demo)
+
+Requirements
+------------
+
+1.	[Ruby 1.9.x or Ruby 2.x](http://www.ruby-lang.org)
+2.	[Ruby On Rails](http://rubyonrails.org)
+3.	[WashOut gem version >= 0.9.1](https://github.com/inossidabile/wash_out)
+
+Compatibility
+-------------
+
+-	Rails >3.0 only. MRI 1.9, 2.0, .
+
+-	JRuby is not offically supported since 0.15.0.
+
+-	Ruby 1.8 is not officially supported since 0.5.3.
+
+We will accept further compatibilty pull-requests but no upcoming versions will be tested against it.
+
+Rubinius support temporarily dropped since 0.6.2 due to Rails 4 incompatibility.
+
+Setup
+-----
+
+Type the following from the command line to install:
+
+```ruby
+gem install washout_builder
+```
+
+Add the following to your Gemfile:
+
+```ruby
+gem "washout_builder"
+```
+
+it will automatically install also [WashOut](https://github.com/inossidabile/wash_out) gem that is currently used
+
+Or if you want this to be available only in development mode , you can do something like this inside the Gemfile:
+
+```ruby
+gem 'wash_out' # The WashOut gem would be used also in production
+
+group :development, :test do
+    gem 'washout_builder' # only available in development mode.
+end
+```
+
+Please read [Release Details]([https://github.com/bogdanRada/washout_builder/releases) if you are upgrading. We break backward compatibility between large ticks but you can expect it to be specified at release notes.
+
+Usage
+-----
+
+The way soap_actions, or reusable types are defined or how the configuration is made using [WashOut](https://github.com/inossidabile/wash_out) haven't changed You can still do everything that gem does .
+
+In order to see the documentation you must write something like this in the routes (exactly like you would do when using only WashOut)
+
+In the following file **config/routes** you can put this configuration
+
+```ruby
+WashOutSample::Application.routes.draw do
+    wash_out :rumbas wash_out :my_other_service
+
+    namespace :api do
+        wash_out :project_service
+    end
+
+    mount WashoutBuilder::Engine => "/washout"
+end
+
+```
+
+You can access the url **/washout** and you will see a list with available services ( in our case there are only two : The RumbasController and MyOtherServiceController) with links to their documentation and where you can find the WSDL.
+
+If you want to access directly the hml documentation that was generated for RumbasController you can do that by accessing url like this:
+
+```ruby
+/washout/Rumbas                  # camelcase name
+/washout/rumbas                  # without camelcase
+/washout/Api::ProjectService     # for namespaced services with camelcase
+/washout/api/project_service     # without camelcase
+```
+
+When specifying the **soap_service** you can also pass a **option for description** . Here is an example
+
+```ruby
+soap_service
+    namespace: 'http://my.app.com/my_service/wsdl',
+    description: 'here goes some description for your service'
+```
+
+When specifying the **soap_action** you can also pass a **option for description**, **option for arguments description** and a **list of exceptions(need to be classes)** that the method can raise at a certain moment.
+
+Here is an example :
+
+```ruby
+soap_action "find",
+    args: { number: :integer },
+    args_description: { number: 'some description about this argument' },
+    return: :boolean,
+    raises: [MyCustomSoapError, MyOtherCustomSoapError ] ,
+    description: "some description about this method to show in the documentation"
+```
+
+The exception classes used **must inherit** from **WashOut::Dispatcher::SOAPError**, which has by default a error code and a message as attributes .
+
+Testing
+-------
+
+To test, do the following:
+
+1.	cd to the gem root.
+2.	bundle install
+3.	bundle exec rake
+
+Contributions
+-------------
+
+Please log all feedback/issues via [Github Issues](http://github.com/bogdanRada/washout_builder/issues). Thanks.
+
+Contributing to washout_builder
+-------------------------------
+
+-	Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+-	Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+-	Fork the project.
+-	Start a feature/bugfix branch.
+-	Commit and push until you are happy with your contribution.
+-	Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+-	Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2013 bogdanRada. See LICENSE.txt for further details.

data/app/helpers/washout_builder_complex_type_helper.rb

@@ -12,11 +12,13 @@ module WashoutBuilderComplexTypeHelper
   # @return [void]
   #
   # @api public
-  def create_element_type_html(pre, element)
+  def create_element_type_html(pre, element, element_description)
     element.type = 'string' if element.type == 'text'
     element.type = 'integer' if element.type == 'int'
     if WashoutBuilder::Type::BASIC_TYPES.include?(element.type)
       pre << "<span class='blue'>#{element.type}</span>&nbsp;<span class='bold'>#{element.name}</span>"
+      pre << "&#8194;<span>#{element_description}</span>" unless element_description.nil?
+      pre
     else
       create_complex_element_type_html(pre, element)
     end

data/app/views/wash_with_html/_complex_type.builder

@@ -8,7 +8,7 @@ unless object.blank?
     xml.ul("class" => "pre") {
       object.map.each do |element|
         xml.li { |pre|
-          create_element_type_html(pre, element)
+          create_element_type_html(pre, element, nil)
         }
       end
     }

data/app/views/wash_with_html/_public_method.builder

@@ -13,7 +13,7 @@ xml.p "#{description}" unless description.blank?
     xml.ul {
       input.each do |element|
         xml.li("class" => "pre") { |pre|
-          create_element_type_html(pre, element)
+          create_element_type_html(pre, element, args_description.nil? ? nil : args_description[element.name.to_sym])
         }
       end
     }

data/app/views/wash_with_html/doc.builder

@@ -102,7 +102,14 @@ xml.html( "xmlns" => "http://www.w3.org/1999/xhtml" ) {
       @map =  @document.sorted_operations
       unless @map.blank?
         @map.each {  |operation, formats| 
-          xml <<    render(:partial => "wash_with_html/public_method", :locals => { :operation=> operation, :input =>  formats[:in], :output => formats[:out] , :exceptions => formats[:raises], :description => formats[:description]})
+          xml <<    render(:partial => "wash_with_html/public_method", :locals => {
+              :operation => operation,
+              :input =>  formats[:in],
+              :output => formats[:out] ,
+              :exceptions => formats[:raises],
+              :description => formats[:description],
+              :args_description => formats[:args_description]
+          })
         }
       end
       

data/lib/washout_builder.rb

@@ -43,8 +43,9 @@ WashoutBuilder::Type.all_soap_config_classes.each do |controller|
     end
 
     def self.config
-      original_config.merge(description: nil)
+      original_config.merge(description: nil, args_description: nil)
     end
   end
   controller.soap_accessor(:description)
+  controller.soap_accessor(:args_description)
 end

data/lib/washout_builder/document/generator.rb

@@ -70,6 +70,14 @@ module WashoutBuilder
         config.respond_to?(:description) ? config.description : nil
       end
 
+      # Returns the service arguments description if the service can respond to args_description method
+      #
+      # @return [String] Returns the service arguments description if the service can respond to args_description method
+      # @api public
+      def service_args_description
+        config.respond_to?(:args_description) ? config.args_description : nil
+      end
+
       #  returns a collection of all operation that the service responds to
       #
       # @return [Array<String>]  returns a collection of all operation that the service responds to

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 = 5
+    TINY = 6
     # if the version should be a e
     PRE = nil
 

data/spec/app/helpers/washout_builder_complex_type_helper_spec.rb

@@ -14,14 +14,14 @@ describe WashoutBuilderComplexTypeHelper, type: :helper do
 
     def expect_included_type_result(pre, element)
       WashoutBuilder::Type::BASIC_TYPES.expects(:include?).with(element.type).returns(true)
-      result = helper.create_element_type_html(pre, element)
+      result = helper.create_element_type_html(pre, element, nil)
       expect(result).to eq(["<span class='blue'>#{element.type}</span>&nbsp;<span class='bold'>#{element.name}</span>"])
     end
 
     def expect_excluded_type_result(pre, element)
       WashoutBuilder::Type::BASIC_TYPES.expects(:include?).with(element.type).returns(false)
       helper.expects(:create_complex_element_type_html).with(pre, element)
-      helper.create_element_type_html(pre, element)
+      helper.create_element_type_html(pre, element, nil)
     end
 
     it 'returns the element of type text' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: washout_builder
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - bogdanRada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wash_out
@@ -574,7 +574,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - app/controllers/washout_builder/washout_builder_controller.rb
 - app/helpers/washout_builder_complex_type_helper.rb

data/README.rdoc

@@ -1,144 +0,0 @@
-= washout_builder  {<img src="https://badge.fury.io/rb/washout_builder.png" alt="Gem Version" />}[http://badge.fury.io/rb/washout_builder]
-{<img src="https://travis-ci.org/bogdanRada/washout_builder.png?branch=master,develop" />}[https://travis-ci.org/bogdanRada/washout_builder]
-{<img src="https://gemnasium.com/bogdanRada/washout_builder.svg" alt="Dependency Status" />}[https://gemnasium.com/bogdanRada/washout_builder]
-{<img src="http://inch-ci.org/github/bogdanRada/washout_builder.svg?branch=master" alt="Inline docs" />}[http://inch-ci.org/github/bogdanRada/washout_builder]
-{<img src="https://coveralls.io/repos/bogdanRada/washout_builder/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/bogdanRada/washout_builder?branch=master]
-{<img src="https://codeclimate.com/github/bogdanRada/washout_builder.png" />}[https://codeclimate.com/github/bogdanRada/washout_builder]
-{<img src="https://reposs.herokuapp.com/?path=bogdanRada/washout_builder"  alt="Repo Size"/>}[https://github.com/bogdanRada/washout_builder]
-{<img src="https://ruby-gem-downloads-badge.herokuapp.com/washout_builder?type=total&style=dynamic"  alt="Gem Downloads"/>}[https://rubygems.org/gems/washout_builder]
-{<img src="http://stillmaintained.com/bogdanRada/washout_builder.png"  alt=""/>}[https://rubygems.org/gems/washout_builder]
-
-= Overview
-WashOutBuilder is a  Soap Service Documentation generator (extends WashOut https://github.com/inossidabile/wash_out/)
-
-The way WashOut is used is not modified, it just extends its functionality by generating html documentation to your services that you write
-
-= Features
-
-* Provides way of seeing the available services with links to documentation, endpoint and namespace
-* Provides a human-readable HTML documentation generated  for each service that you write
-
-= LIVE DEMO!!!
-
-* {Demo Application}[http://washout-builder.herokuapp.com/]
-
-= Demo app source code:
-
-* {Source code}[https://github.com/bogdanRada/washout_builder_demo]
-
-= Requirements
-
-1. {Ruby 1.9.x or Ruby 2.0.x}[http://www.ruby-lang.org]
-2. {Ruby on Rails}[http://rubyonrails.org].
-3. {WashOut Gem version >= 0.9.1}[https://github.com/inossidabile/wash_out]
-
-= Compatibility
-
-Rails >3.0 only. MRI 1.9, 2.0, .
-
-JRuby is not offically supported since 0.15.0.
-
-Ruby 1.8 is not officially supported since 0.5.3.
-
-We will accept further compatibilty pull-requests but no upcoming versions will be tested against it.
-
-Rubinius support temporarily dropped since 0.6.2 due to Rails 4 incompatibility.
-
-= Setup
-
-Type the following from the command line to install:
-
-  gem install washout_builder
-
-Add the following to your Gemfile:
-
-
-  gem "washout_builder"
-
-it will automatically install  also +wash_out+ gem  that is currently used
-
-Or if you want this to be available only in development mode , you can do something like this inside the Gemfile:
-
-  gem 'wash_out'       # The WashOut gem  would be used also  in production
-
-  group :development, :test do
-    gem 'washout_builder'            # only  available in development mode.
-  end
-
-
-Please read {release details}[https://github.com/bogdanRada/washout_builder/releases] if you are upgrading. We break backward compatibility between large ticks but you can expect it to be specified at release notes.
-
-= Usage
-
-The way soap_actions, or reusable types are defined or how the configuration is made using WashOut(https://github.com/inossidabile/wash_out)  haven't changed
-You can still do everything that gem does .
-
-In order to see the documentation you must write something like this  in the routes (exactly like you would do when using only WashOut)
-
-In the following file  +config/routes.rb+ you can put this configuration
-
- WashOutSample::Application.routes.draw do
-  wash_out :rumbas
-  wash_out :my_other_service
-
-  namespace :api do
-    wash_out :project_service
-  end
-
-  mount WashoutBuilder::Engine => "/washout"
- end
-
-You can access the url +/washout+ and you will see a list with available services ( in our case there are only two : The RumbasController and MyOtherServiceController) with links to their documentation and where you can find the WSDL.
-
-If you want to access directly the hml documentation that was generated for RumbasController  you can do that by accessing url like this:
-
- /washout/Rumbas    #camelcase name
- /washout/rumbas    #without camelcase
-
- /washout/Api::ProjectService   # for namespaced services with camelcase
- /washout/api/project_service   # without camelcase
-
-When specifying the <b>soap_service</b> you can also pass a <b>option for description</b> . Here is an example
-
-  soap_service  namespace: "http://my.app.com/my_service/wsdl",
-   :description => "here goes some description for your service"
-
-When specifying the <b>soap_action</b> you can also pass a <b>option for description</b> and a <b>list of exceptions(need to be classes)</b> that the method can raise at a certain moment.
-
-Here is an example :
-
- soap_action "find",
-  :args   => {:number => :integer} ,
-  :return => :boolean,
-  :raises => [MyCustomSoapError, MyOtherCustomSoapError ] ,
-  :description => "some description about this method to show in the documentation"
-
-
-The exception classes used <b>must inherit</b> from  <tt>WashOut::Dispatcher::SOAPError</tt>, which has  by default  a error code and a message as attributes .
-
-= Testing
-
-To test, do the following:
-
-1. cd to the gem root.
-2. bundle install
-3. bundle exec rake
-
-= Contributions
-
-Please log all feedback/issues via {GitHub Issues}[http://github.com/bogdanRada/washout_builder/issues]. Thanks.
-
-== Contributing to washout_builder
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2013 bogdanRada. See LICENSE.txt for
-further details.