scaffold_parser 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1394d7a717a8378ce9ae245bf6c06c6ca52a3cf35319e33b68817b5232b7e34d
-  data.tar.gz: ab02c055478a1e5ecec8ca99e852354e78dac60b738afcf42d1b3c22d4194f8d
+SHA1:
+  metadata.gz: 9b4ffe5b906e5b2e028aa175ec02018bef03aee4
+  data.tar.gz: 60e240f28ca2ad99677c27e846468d54bea1dcc8
 SHA512:
-  metadata.gz: bfc02d05c852fa0e2729fdaa522ba79ed3c9326113efc454a9e10cefae6f914f6d3ee04e7607d8664b81567120087e992dd1b80438c6c8e0920249d1c8973ce3
-  data.tar.gz: e9fbf75cc51ff8ad53db88f19126869bd0ea7dff62f795493e2c4283b447e1d47e982fcb51327941dc0b3138a75eecbaee5b2e2610fa967f2dede17b125af547
+  metadata.gz: 691f8d7819b3f41aa64aee39b49872e901a1b9ef4136b00fd8e9b6b927903eaa3c4f607bad91081da461c1de2b2baaf5bfa186c8ffd82615ae015f241beeb278
+  data.tar.gz: e834263aba43d562a45ae7a6ab5766c6d4d615b98b85fee16e3d5d1907af11b935cd20d06d875c7ddcf977fb8fda25560c21f4b363448d113644b0a022b3ab48

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 *.gem
+/Gemfile.lock

data/README.md

@@ -1,37 +1,56 @@
 # ScaffoldParser
 
-Tool for fast parser scaffolding
+Scaffolds XML file parser from XSD spec
 
-## Installation
+Content:
+1. [About](#about)
+    1. [Naming](#naming)
+    2. [What's missing](#whats-missing)
+2. [Api](#api)
+    1. [Parsers](#parsers)
+    2. [Builder](#builder)
+3. [Performance](#performance)
+4. [External links](#external-links)
+5. [License](#license)
 
-Add this line to your application's Gemfile:
+## About
 
-```ruby
-gem 'scaffold_parser'
-```
+WIP
 
-And then execute:
+### Naming
 
-    $ bundle
+WIP
 
-Or install it yourself as:
+#### Method names
 
-    $ gem install scaffold_parser
+WIP
 
-## Usage
+#### Class names
 
-TODO: Write usage instructions here
+WIP
 
-## Development
+### Missing parts
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+WIP
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Api
 
-## Contributing
+### Parsing a document
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/scaffold_parser.
+WIP
+
+### Creating a document
+
+WIP
+
+## Performance
+
+WIP
+
+## External links
+
+WIP
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/scaffold_parser

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'scaffold_parser'
+require 'optparse'
+
+options = {}
+path = ARGV.shift
+abort 'Path to schema file as a first argument is required' unless path
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: scaffold_parser <path_to_schema> [options]'
+
+  opts.on("-nNAMESPACE", "--namespace=NAMESPACE") do |v|
+    options[:namespace] = v
+  end
+end.parse!
+
+ScaffoldParser.scaffold(path, options)

data/lib/scaffold_parser.rb

@@ -1,4 +1,17 @@
-require 'scaffold_parser/version'
+require 'scaffold_parser/builder'
+require 'nokogiri'
+require 'active_support/all'
+require 'scaffold_parser/nokogiri_patches'
+require 'scaffold_parser/file_patches'
+
+Nokogiri::XML::Element.include ScaffoldParser::NokogiriPatches::Element
+Nokogiri::XML::Document.include ScaffoldParser::NokogiriPatches::Document
+File.include ScaffoldParser::FilePatches
 
 module ScaffoldParser
+  def self.scaffold(path, options = {})
+    doc = Nokogiri::XML(File.open(path))
+
+    Builder.call(doc, options)
+  end
 end

data/lib/scaffold_parser/builder.rb

@@ -0,0 +1,129 @@
+module ScaffoldParser
+  class Builder
+    def self.call(doc, options, already_scaffolded_classes = [])
+      self.new(doc, options, already_scaffolded_classes).call
+    end
+
+    def initialize(doc, options, already_scaffolded_classes)
+      @doc = doc
+      @options = options
+      @already_scaffolded_classes = already_scaffolded_classes
+    end
+
+    def call
+      unless Dir.exists?('./tmp/')
+        Dir.mkdir('./tmp/')
+        puts './tmp/ directory created'
+      end
+
+      parent_nodes = @doc.parent_nodes.select do |node|
+        !@already_scaffolded_classes.include? node.to_class_name
+      end
+
+      parent_nodes.each do |parent|
+        @already_scaffolded_classes << parent.to_class_name
+
+        if parent.custom_type?
+          type_def = parent.type_def
+
+          scaffold_class(type_def)
+          self.class.call(type_def, @options, @already_scaffolded_classes)
+        else
+          scaffold_class(parent)
+          self.class.call(parent, @options, @already_scaffolded_classes)
+        end
+      end
+
+      list_nodes = @doc.list_nodes.select do |node|
+        !@already_scaffolded_classes.include? node.list_element.to_class_name
+      end
+
+      list_nodes.each do |list|
+        @already_scaffolded_classes << list.list_element.to_class_name
+
+        if list.list_element.custom_type?
+          type_def = list.list_element.type_def
+
+          scaffold_class(type_def)
+          self.class.call(type_def, @options, @already_scaffolded_classes)
+        elsif !list.list_element.xs_type?
+          scaffold_class(list.list_element)
+          self.class.call(list.list_element, @options, @already_scaffolded_classes)
+        end
+      end
+    end
+
+    private
+
+    def namespaced(path)
+      [@options[:namespace]&.underscore, path].compact.join('/')
+    end
+
+    def scaffold_class(node)
+      path = "./tmp/#{node.to_file_name}.rb"
+
+      File.open(path, 'wb') do |f|
+        f.indent = true if @options[:namespace]
+
+        f.puts "require '#{namespaced('base_element')}'"
+        node.parent_nodes.each { |n| f.puts "require '#{namespaced(n.to_require)}'" }
+        node.list_nodes.reject { |l| l.list_element.xs_type? }.each { |n| f.puts "require '#{namespaced(n.to_require)}'" }
+        f.puts
+
+        f.puts "module #{@options[:namespace]}" if @options[:namespace]
+        f.putsi "class #{node.to_class_name}"
+        f.putsi "  include BaseElement"
+
+        node.end_nodes.each do |method|
+          f.puts
+
+          method_name = method.to_method_name
+          at = method.to_location
+
+          f.putsi "  def #{method_name}"
+          f.putsi "    at :#{at}"
+          f.putsi "  end"
+        end
+
+        node.parent_nodes.each do |method|
+          f.puts
+
+          klass = method.to_class_name
+          method_name = method.to_method_name
+          at = method.to_location
+
+          f.putsi "  def #{method_name}"
+          f.putsi "    submodel_at(#{klass}, :#{at})"
+          f.putsi "  end"
+        end
+
+        node.list_nodes.reject { |l| l.list_element.xs_type? }.each do |method|
+          f.puts
+
+          list_element_klass = method.list_element_klass
+          method_name = method.to_method_name
+          list_element_at = method.list_element_at.map { |e| ":#{e}" }.join(', ')
+
+          f.putsi "  def #{method_name}"
+          f.putsi "    array_of_at(#{list_element_klass}, [#{list_element_at}])"
+          f.putsi "  end"
+        end
+
+        node.list_nodes.select { |l| l.list_element.xs_type? }.each do |method|
+          f.puts
+
+          list_element_klass = method.list_element_klass
+          method_name = method.to_method_name
+          list_element_at = method.list_element_at.map { |e| ":#{e}" }.join(', ')
+
+          f.putsi "  def #{method_name}"
+          f.putsi "    array_of_at(String, [#{list_element_at}])"
+          f.putsi "  end"
+        end
+
+        f.putsi "end"
+        f.puts "end" if @options[:namespace]
+      end
+    end
+  end
+end

data/lib/scaffold_parser/file_patches.rb

@@ -0,0 +1,13 @@
+module ScaffoldParser
+  module FilePatches
+    attr_accessor :indent
+
+    def putsi(str)
+      if indent
+        puts str.prepend('  ')
+      else
+        puts str
+      end
+    end
+  end
+end

data/lib/scaffold_parser/nokogiri_patches.rb

@@ -0,0 +1,217 @@
+require 'active_support/all'
+
+module ScaffoldParser
+  module NokogiriPatches
+    module Element
+      def attribute_elements
+        if name == 'complexType'
+          xpath('xs:sequence/xs:element|xs:sequence/xs:sequence/xs:element|xs:sequence/xs:choice/xs:sequence/xs:element|xs:sequence/xs:choice/xs:element')
+        elsif name == 'element'
+          xpath('xs:complexType/xs:sequence/xs:element')
+        else
+          fail 'whatever'
+        end
+      end
+
+      def parent_nodes
+        attribute_elements.select(&:parent_type?) + extension_parent_nodes
+      end
+
+      def end_nodes
+        attribute_elements.select(&:end_type?) + extension_end_nodes
+      end
+
+      def list_nodes
+        attribute_elements.select(&:list_type?) + extension_list_nodes
+      end
+
+      def extension_end_nodes
+        extension ? extension.end_nodes : []
+      end
+
+      def extension_parent_nodes
+        extension ? extension.parent_nodes : []
+      end
+
+      def extension_list_nodes
+        extension ? extension.list_nodes : []
+      end
+
+      def end_type?
+        if custom_type?
+          type_def&.end_type?
+        else
+          xs_type? || (no_type? && complex_types.empty? && !complex_type? && !list_type?)
+        end
+      end
+
+      def parent_type?
+        if custom_type?
+          type_def&.parent_type?
+        else
+          (complex_type? || complex_types.any?) && !list_type?
+        end
+      end
+
+      def list_type?
+        if list_element
+          max_occure = list_element['maxOccurs']
+
+          max_occure == 'unbounded' || max_occure.to_i > 1
+        end
+      end
+
+      def list_element_klass
+        if list_element
+          if list_element['type']
+            list_element['type'].camelize
+          else
+            list_element['name'].camelize
+          end
+        end
+      end
+
+      def list_element_at
+        if list_element
+          [at_xpath('xs:complexType').to_location, list_element.to_location]
+        end
+      end
+
+      def to_class_name
+        if self['type']
+          self['type'].camelize
+        else
+          to_name.camelize
+        end
+      end
+
+      def to_file_name
+        to_class_name.underscore
+      end
+
+      def to_require
+        if parent_type?
+          to_class_name.underscore
+        elsif list_type?
+          if list_element
+            list_element.to_class_name.underscore
+          end
+        end
+      end
+
+      def to_method_name
+        to_name.underscore
+      end
+
+      def to_location
+        to_name
+      end
+
+      def custom_type?
+        self['type'].present? && !xs_type?
+      end
+
+      def type_def
+        find_type(self['type'])
+      end
+
+      def list_element
+        eles = xpath('xs:complexType/xs:sequence/xs:element')
+
+        if eles.size == 1
+          eles.first
+        end
+      end
+
+      def extension
+        elem = at_xpath('xs:complexType/xs:complexContent/xs:extension')
+
+        if elem
+          find_type(elem['base'])
+        end
+      end
+
+      def xs_type?
+        self['type'].present? && self['type'].start_with?('xs:')
+      end
+
+      private
+
+      def to_name
+        if self['name']
+          self['name']
+        else
+          at_xpath('..')['name']
+        end
+      end
+
+      def complex_types
+        xpath('xs:complexType')
+      end
+
+      def no_type?
+        self['type'].blank?
+      end
+
+      def complex_type?
+        name == 'complexType'
+      end
+
+      def simple_type?
+        name == 'simpleType'
+      end
+
+      def find_type(name)
+        doc = includes.find do |doc|
+          doc.at_xpath("//*[@name='#{name}']").present?
+        end
+
+        if doc.blank?
+          fail "Cant find element definition for '#{name}'. Might be not enough includes?"
+        end
+
+        doc.at_xpath("//*[@name='#{name}']")
+      end
+
+      def includes
+        original_path = ENV['XSD_PATH'] || './'
+
+        collect_includes([], [], self) + [self]
+      end
+
+      def collect_includes(collection, names, doc)
+        original_path = ENV['XSD_PATH'] || './'
+
+        new_names = doc.xpath('//xs:include').map { |incl| incl['schemaLocation'] }
+
+        (new_names - names).each do |name|
+          if names.include? name
+            next
+          else
+            dir = original_path.split('/')
+            include_path = (dir + [name]).join('/')
+
+            new_doc = Nokogiri::XML(File.open(include_path))
+
+            collection << new_doc
+            names << name
+
+            collect_includes(collection, names, new_doc)
+          end
+        end
+
+        collection
+      end
+    end
+
+    module Document
+      def parent_nodes
+        xpath('xs:schema/xs:complexType|xs:schema/xs:element')
+      end
+
+      def list_nodes
+        []
+      end
+    end
+  end
+end

data/scaffold_parser.gemspec

@@ -1,10 +1,9 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'scaffold_parser/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'scaffold_parser'
-  spec.version       = ScaffoldParser::VERSION
+  spec.version       = '0.1.0'
   spec.authors       = ['Premysl Donat']
   spec.email         = ['pdonat@seznam.cz']
 
@@ -16,11 +15,14 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['scaffold_parser']
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'nokogiri'
+  spec.add_development_dependency 'activesupport'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scaffold_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Premysl Donat
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-01-07 00:00:00.000000000 Z
+date: 2018-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,10 +52,53 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - pdonat@seznam.cz
-executables: []
+executables:
+- scaffold_parser
 extensions: []
 extra_rdoc_files: []
 files:
@@ -67,9 +110,12 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/scaffold_parser
 - bin/setup
 - lib/scaffold_parser.rb
-- lib/scaffold_parser/version.rb
+- lib/scaffold_parser/builder.rb
+- lib/scaffold_parser/file_patches.rb
+- lib/scaffold_parser/nokogiri_patches.rb
 - scaffold_parser.gemspec
 homepage: https://github.com/Masa331/scaffold_parser
 licenses:
@@ -91,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Tool for fast parser scaffolding

data/lib/scaffold_parser/version.rb

@@ -1,3 +0,0 @@
-module ScaffoldParser
-  VERSION = '0.0.1'
-end