wsdl-mapper 0.0.7

data/lib/wsdl_mapper/generation/default_module_generator.rb

@@ -0,0 +1,32 @@
+require 'wsdl_mapper/generation/base'
+
+module WsdlMapper
+  module Generation
+    class DefaultModuleGenerator < Base
+      def initialize(generator)
+        @generator = generator
+        super(generator.context)
+      end
+
+      def generate(module_node, result)
+        return self if module_node.leaf?
+
+        append_file_for module_node.type_name, result do |f|
+          module_node.children.each do |child|
+            f.require child.type_name.require_path
+          end
+        end
+
+        module_node.children.each do |child|
+          generate child, result
+        end
+        self
+      end
+
+      protected
+      def get_formatter(io)
+        @generator.get_formatter io
+      end
+    end
+  end
+end

data/lib/wsdl_mapper/generation/facade.rb

@@ -0,0 +1,59 @@
+require 'nokogiri'
+
+require 'wsdl_mapper/naming/default_namer'
+require 'wsdl_mapper/naming/separating_namer'
+require 'wsdl_mapper/generation/context'
+require 'wsdl_mapper/dom_parsing/parser'
+
+module WsdlMapper
+  module Generation
+    # @abstract
+    class Facade
+      # @param [String] file Full path to the XSD or WSDL file
+      # @param [String] out Full path to the desired output directory
+      # @param [Array<String>] module_path Array of module names, to use as root module, i.e. `['Foo', 'Bar']` for `Foo::Bar`
+      # @param [true, false] docs Set to `true` to generate documentation
+      # @param [true, false] separate_modules Set to `true` to separate types and (de)serializers into different modules
+      # @param [WsdlMapper::Naming::AbstractNamer] namer Inject a namer instance here to be used
+      def initialize(file:, out:, module_path: [], docs: false, separate_modules: true, namer: nil)
+        @file = file
+        @out = out
+        @module_path = module_path
+        @docs = docs
+        @separate_modules = separate_modules
+        @namer = namer
+      end
+
+      def generate
+        generator.generate parser.parse document
+      end
+
+      protected
+      def context
+        @context ||= WsdlMapper::Generation::Context.new @out
+      end
+
+      def namer
+        @namer ||= @separate_modules ?
+          WsdlMapper::Naming::SeparatingNamer.new(module_path: @module_path) :
+          WsdlMapper::Naming::DefaultNamer.new(module_path: @module_path)
+      end
+
+      def generator_class
+        raise NotImplementedError
+      end
+
+      def generator
+        @generator ||= generator_class.new context, namer: namer
+      end
+
+      def document
+        @document ||= Nokogiri::XML::Document.parse File.read @file
+      end
+
+      def parser
+        @parser ||= WsdlMapper::DomParsing::Parser.new
+      end
+    end
+  end
+end

data/lib/wsdl_mapper/generation/result.rb

@@ -0,0 +1,61 @@
+module WsdlMapper
+  module Generation
+    class Result
+      class ModuleTreeNode
+        attr_reader :type_name, :children
+
+        def initialize(type_name)
+          @type_name = type_name
+          @children = []
+        end
+
+        def leaf?
+          @children.empty?
+        end
+      end
+
+      attr_reader :files, :module_tree, :schema, :type_names, :description
+
+      def initialize(schema: nil, description: nil)
+        @files = []
+        @module_tree = []
+        @type_names = []
+        @description = description
+        @schema = schema
+      end
+
+      def add_type(type_name)
+        @type_names << type_name
+        modules = type_name.parents.reverse
+
+        children = @module_tree
+        modules.each do |mod|
+          node = children.find { |n| n.type_name == mod }
+          unless node
+            node = ModuleTreeNode.new mod
+            children << node
+          end
+          children = node.children
+        end
+        node = ModuleTreeNode.new type_name
+        children << node
+        self
+      end
+
+      class << self
+        def merge(result, *results)
+          res = new schema: result.schema, description: result.description
+          results.each do |r|
+            r.type_names.each do |type_name|
+              res.add_type type_name
+            end
+            r.files.each do |f|
+              res.files << f
+            end
+          end
+          res
+        end
+      end
+    end
+  end
+end

data/lib/wsdl_mapper/generation/type_to_generate.rb

@@ -0,0 +1,12 @@
+module WsdlMapper
+  module Generation
+    class TypeToGenerate
+      attr_reader :type, :name
+
+      def initialize(type, type_name)
+        @type = type
+        @name = type_name
+      end
+    end
+  end
+end

data/lib/wsdl_mapper/generation/yard_doc_formatter.rb

@@ -0,0 +1,105 @@
+module WsdlMapper
+  module Generation
+    class YardDocFormatter
+      def initialize(formatter)
+        @formatter = formatter
+        @i = 0
+      end
+
+      def line(line)
+        buf = '# '
+        buf << '  ' * @i
+        buf << strip(line)
+        @formatter.statement buf
+        self
+      end
+
+      def inc_indent
+        @i += 1
+        self
+      end
+
+      def dec_indent
+        @i -= 1
+        self
+      end
+
+      def class_doc(type)
+        if type.documentation.present?
+          text type.documentation.default
+          blank_line
+        end
+        return unless type.name
+
+        tag :xml_name, type.name.name
+
+        if type.name.ns
+          tag :xml_namespace, type.name.ns
+        end
+      end
+
+      def text(text)
+        lines = process(text).strip.split("\n")
+
+        lines.each do |l|
+          line l
+        end
+        self
+      end
+
+      def blank_line
+        @formatter.blank_comment
+        self
+      end
+
+      def tag(tag, text)
+        line "@#{tag} #{text}"
+      end
+
+      def type_tag(tag_name, type, text = nil)
+        buf = "@#{tag_name} [#{type}]"
+        buf << " #{text}" if text
+        line buf
+      end
+
+      def attribute!(name, type, doc, &block)
+        tag '!attribute', name
+        inc_indent
+        text doc if doc
+        type_tag 'return', type
+        block.call if block_given?
+        dec_indent
+      end
+
+      def option(param_name, type, name, text = nil)
+        buf = "@option #{param_name} [#{type}] :#{name}"
+        buf << " #{text}" if text
+        line buf
+      end
+
+      def param(name, type, text = nil)
+        buf = "@param #{name} [#{type}]"
+        buf << " #{text}" if text
+        line buf
+      end
+
+      def params(*params)
+        return if params.empty?
+        params.each do |p|
+          param(*p)
+        end
+        blank_line
+      end
+
+      protected
+      def strip(text)
+        return '' if text.nil?
+        text.gsub(/[\n\r]/, ' ').gsub(/\s+/, ' ').strip
+      end
+
+      def process(doc)
+        doc
+      end
+    end
+  end
+end

data/lib/wsdl_mapper/naming/abstract_namer.rb

@@ -0,0 +1,53 @@
+require 'wsdl_mapper/naming/type_name'
+require 'wsdl_mapper/naming/property_name'
+require 'wsdl_mapper/naming/enumeration_value_name'
+require 'wsdl_mapper/naming/inflector'
+
+module WsdlMapper
+  module Naming
+    # @abstract
+    # noinspection RubyUnusedLocalVariable
+    class AbstractNamer
+      def get_type_name(type)
+        raise NotImplementedError
+      end
+
+      def get_property_name(property)
+        raise NotImplementedError
+      end
+
+      def get_enumeration_value_name(type, enum_value)
+        raise NotImplementedError
+      end
+
+      def get_s8r_name(type)
+        raise NotImplementedError
+      end
+
+      def get_d10r_name(type)
+        raise NotImplementedError
+      end
+
+      def get_attribute_name(attribute)
+        raise NotImplementedError
+      end
+
+      def get_content_name(type)
+        raise NotImplementedError
+      end
+
+      def get_inline_type(element)
+        raise NotImplementedError
+      end
+
+      def get_soap_array_item_name(type)
+        raise NotImplementedError
+      end
+
+      def get_support_name(name)
+        raise NotImplementedError
+      end
+    end
+  end
+end
+

data/lib/wsdl_mapper/naming/abstract_service_namer.rb

@@ -0,0 +1,115 @@
+module WsdlMapper
+  module Naming
+    # @abstract
+    # noinspection RubyUnusedLocalVariable
+    class AbstractServiceNamer
+      def get_api_name
+        raise NotImplementedError
+      end
+
+      def get_service_name(service)
+        raise NotImplementedError
+      end
+
+      def get_property_name(type)
+        raise NotImplementedError
+      end
+
+      def get_port_name(service, port)
+        raise NotImplementedError
+      end
+
+      def get_proxy_name(service, port)
+        raise NotImplementedError
+      end
+
+      def get_operation_name(service, port, operation)
+        raise NotImplementedError
+      end
+
+      def get_input_body_name(service, port, op)
+        raise NotImplementedError
+      end
+
+      def get_input_s8r_name(service, port, op)
+        raise NotImplementedError
+      end
+
+      def get_output_s8r_name(service, port, op)
+        raise NotImplementedError
+      end
+
+      def get_input_d10r_name(service, port, op)
+        raise NotImplementedError
+      end
+
+      def get_output_d10r_name(service, port, op)
+        raise NotImplementedError
+      end
+
+      def get_output_type_directory_name
+        raise NotImplementedError
+      end
+
+      def get_output_header_d10r_name
+        raise NotImplementedError
+      end
+
+      def get_output_body_d10r_name
+        raise NotImplementedError
+      end
+
+      def get_output_element_directory_name
+        raise NotImplementedError
+      end
+
+      def get_input_type_directory_name
+        raise NotImplementedError
+      end
+
+      def get_input_header_d10r_name
+        raise NotImplementedError
+      end
+
+      def get_input_body_d10r_name
+        raise NotImplementedError
+      end
+
+      def get_input_element_directory_name
+        raise NotImplementedError
+      end
+
+      def get_operation_part_name(service, port, op, name)
+        raise NotImplementedError
+      end
+
+      def get_header_name(service, port, op, name)
+        raise NotImplementedError
+      end
+
+      def get_body_name(service, port, op, name)
+        raise NotImplementedError
+      end
+
+      def get_output_body_name(service, port, op)
+        raise NotImplementedError
+      end
+
+      def get_input_header_name(service, port, op)
+        raise NotImplementedError
+      end
+
+      def get_output_header_name(service, port, op)
+        raise NotImplementedError
+      end
+
+      def get_header_property_name(message_name, part_name)
+        raise NotImplementedError
+      end
+
+      def get_body_property_name(part_name)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/wsdl_mapper/naming/default_namer.rb

@@ -0,0 +1,183 @@
+require 'wsdl_mapper/dom/name'
+
+require 'wsdl_mapper/naming/type_name'
+require 'wsdl_mapper/naming/property_name'
+require 'wsdl_mapper/naming/enumeration_value_name'
+
+require 'wsdl_mapper/naming/namer_base'
+
+module WsdlMapper
+  module Naming
+    # This is the default Namer implementation. It provides the de-facto standard of organizing and naming
+    # classes in ruby:
+    #
+    # 1. Class/Module names are CamelCase (e.g. `SomeType`)
+    # 2. File names are under_score (e.g. `some_type.rb`)
+    # 3. Each class in its own file
+    # 4. (De)Serializers are put within the same module as XSD Types
+    class DefaultNamer < NamerBase
+      include WsdlMapper::Dom
+
+      class InlineType < Struct.new(:name)
+      end
+
+      # Initializes a new {DefaultNamer} instance.
+      #
+      # @param [Array<String>] module_path the root module for the generated classes, e.g. `['MyApi', 'Types']` => `MyApi::Types::SomeClass` in `my_api/types/some_class.rb`
+      # @param [String] content_attribute_name the accessor name for {file:concepts/wrapping_types.md wrapping types} (complex _type with simple content and simple types with restrictions)
+      def initialize(module_path: [],
+          content_attribute_name: 'content',
+          soap_array_item_name: 'item')
+        super module_path: module_path
+
+        @content_attribute_name = content_attribute_name
+        @soap_array_item_name = soap_array_item_name
+      end
+
+      # Returns a _type name for the given _type (simple or complex).
+      #
+      # @param [WsdlMapper::Dom::ComplexType, WsdlMapper::Dom::SimpleType] type
+      # @return [TypeName]
+      def get_type_name(type)
+        type_name = TypeName.new get_class_name(type), get_class_module_path(type), get_class_file_name(type), get_class_file_path(type)
+        type_name.parent = make_parents get_class_module_path(type)
+        type_name
+      end
+
+      # @param [String] name
+      # @return [TypeName]
+      def get_support_name(name)
+        type_name = TypeName.new get_support_class_name(name), get_support_module_path(name), get_support_file_name(name), get_support_file_path(name)
+        type_name.parent = make_parents get_support_module_path(name)
+        type_name
+      end
+
+      def get_s8r_type_directory_name
+        get_support_name 'S8rTypeDirectory'
+      end
+
+      def get_global_s8r_name
+        get_support_name 'Serializer'
+      end
+
+      def get_d10r_type_directory_name
+        get_support_name 'D10rTypeDirectory'
+      end
+
+      def get_d10r_element_directory_name
+        get_support_name 'D10rElementDirectory'
+      end
+
+      def get_global_d10r_name
+        get_support_name 'Deserializer'
+      end
+
+      # @param [WsdlMapper::Dom::ComplexType, WsdlMapper::Dom::SimpleType] type
+      # @return [TypeName]
+      def get_s8r_name(type)
+        type_name = TypeName.new get_s8r_class_name(type), get_s8r_module_path(type), get_s8r_file_name(type), get_s8r_file_path(type)
+        type_name.parent = make_parents get_s8r_module_path(type)
+        type_name
+      end
+
+      # @param [WsdlMapper::Dom::ComplexType, WsdlMapper::Dom::SimpleType] type
+      # @return [TypeName]
+      def get_d10r_name(type)
+        type_name = TypeName.new get_d10r_class_name(type), get_d10r_module_path(type), get_d10r_file_name(type), get_d10r_file_path(type)
+        type_name.parent = make_parents get_d10r_module_path(type)
+        type_name
+      end
+
+      # @param [WsdlMapper::Dom::Property] property
+      # @return [PropertyName]
+      def get_property_name(property)
+        PropertyName.new get_accessor_name(property.name.name), get_var_name(property.name.name)
+      end
+
+      # @param [WsdlMapper::Dom::Attribute] attribute
+      # @return [PropertyName]
+      def get_attribute_name(attribute)
+        PropertyName.new get_accessor_name(attribute.name.name), get_var_name(attribute.name.name)
+      end
+
+      # @param [WsdlMapper::Dom::SimpleType] _type
+      # @param [WsdlMapper::Dom::EnumerationValue] enum_value
+      # @return [EnumerationValueName]
+      def get_enumeration_value_name(_type, enum_value)
+        EnumerationValueName.new get_constant_name(enum_value.value), get_key_name(enum_value.value)
+      end
+
+      # @param [WsdlMapper::Dom::ComplexType, WsdlMapper::Dom::SimpleType] _type
+      # @return [PropertyName]
+      def get_content_name(_type)
+        @content_name ||= PropertyName.new get_accessor_name(@content_attribute_name), get_var_name(@content_attribute_name)
+      end
+
+      # @param [WsdlMapper::Dom::Property, WsdlMapper::Dom::Element] element
+      # @return [InlineType]
+      def get_inline_type(element)
+        name = element.name.name + 'InlineType'
+        InlineType.new WsdlMapper::Dom::Name.get(element.name.ns, name)
+      end
+
+      # @param [WsdlMapper::Dom::ComplexType] _type
+      # @return [String]
+      def get_soap_array_item_name(_type)
+        @soap_array_item_name
+      end
+
+      protected
+      def get_class_name(type)
+        camelize type.name.name
+      end
+
+      def get_class_file_name(type)
+        underscore(type.name.name) + '.rb'
+      end
+
+      def get_class_module_path(type)
+        @module_path
+      end
+      alias_method :get_s8r_module_path, :get_class_module_path
+      alias_method :get_d10r_module_path, :get_class_module_path
+
+      def get_class_file_path(type)
+        get_file_path get_class_module_path type
+      end
+      alias_method :get_s8r_file_path, :get_class_file_path
+      alias_method :get_d10r_file_path, :get_class_file_path
+
+      def get_d10r_file_name(type)
+        underscore(type.name.name) + '_deserializer.rb'
+      end
+
+      def get_d10r_class_name(type)
+        camelize type.name.name + 'Deserializer'
+      end
+
+      def get_s8r_file_name(type)
+        underscore(type.name.name) + '_serializer.rb'
+      end
+
+      def get_s8r_class_name(type)
+        camelize type.name.name + 'Serializer'
+      end
+
+      def get_support_class_name(name)
+        camelize name
+      end
+
+      def get_support_module_path(_name)
+        @module_path
+      end
+
+      def get_support_file_path(name)
+        get_file_path get_support_module_path name
+      end
+
+      def get_support_file_name(name)
+        get_file_name name
+      end
+    end
+  end
+end