flexparser 1.0.2

data/lib/flexparser/configuration.rb

@@ -0,0 +1,23 @@
+module Flexparser
+  #
+  # Class to keep config-options for the whole module.
+  #
+  class Configuration
+    AVAILABLE_OPTIONS =
+      %i[retry_without_namespaces explicit_property_naming].freeze
+    attr_accessor(*AVAILABLE_OPTIONS)
+
+    def initialize
+      set_defaults
+    end
+
+    def to_h
+      Hash[AVAILABLE_OPTIONS.map { |o| [o, public_send(o)] }]
+    end
+
+    def set_defaults
+      @retry_without_namespaces = true
+      @explicit_property_naming = true
+    end
+  end
+end

data/lib/flexparser/empty_fragment.rb

@@ -0,0 +1,23 @@
+module Flexparser
+  #
+  # Used as a safeguard when passing nil or an empty string
+  # to the FragmentBuilder.
+  #
+  class EmptyFragment < Fragment
+    def xpath(_path)
+      self.class.new(nil)
+    end
+
+    def empty?
+      true
+    end
+
+    def text
+      nil
+    end
+
+    def namespaces
+      {}
+    end
+  end
+end

data/lib/flexparser/errors.rb

@@ -0,0 +1,21 @@
+module Flexparser
+  class Error < StandardError; end
+
+  #
+  # An Error that will be thrown if a value is required but
+  # missing.
+  #
+  class RequiredMissingError < Error
+    attr_reader :parser
+
+    def initialize(parser)
+      @parser = parser
+    end
+  end
+
+  #
+  # An Error that is thrown when there is no clear name
+  #   for a property.
+  #
+  class AmbiguousNamingError < ArgumentError; end
+end

data/lib/flexparser/fragment.rb

@@ -0,0 +1,44 @@
+module Flexparser
+  #
+  # Wraps Nokogiri::Xml::Document to automatically hand down namespaces
+  # to fragments generated by #xpath
+  #
+  class Fragment
+    extend Forwardable
+
+    attr_reader :doc
+    attr_writer :namespaces
+
+    def_delegators(:@doc, :text, :empty?, :map,
+                   :each, :namespaces, :collect_namespaces)
+
+    def initialize(str, namespaces: {})
+      @doc = str.is_a?(String) ? Nokogiri::XML(str) : str
+      @propagated_namespaces = namespaces
+    end
+
+    def to_s
+      "#{self.class}: \n\tNamespaces: #{_namespaces}
+      \tRaw:\n\t\t#{@raw_doc}\tNokogiri:\n#{doc}"
+    end
+
+    #
+    # The same as Nokogiri::Xml::Document#xpath but
+    # namespaces are passed down to resulting fragments.
+    #
+    def xpath(path)
+      FragmentBuilder
+        .build(doc.xpath(path, propagating_namespaces))
+    end
+
+    def propagating_namespaces
+      return @propagated_namespaces unless doc.respond_to?(:namespaces)
+      if doc.respond_to?(:collect_namespaces)
+        return @propagated_namespaces.merge doc.collect_namespaces
+      end
+      @propagated_namespaces.merge doc.namespaces
+    end
+
+    alias pns propagating_namespaces
+  end
+end

data/lib/flexparser/fragment_builder.rb

@@ -0,0 +1,15 @@
+module Flexparser
+  #
+  # Class to build handle turn a given object into
+  # a Fragment. Used mostly as a Safeguard.
+  #
+  class FragmentBuilder
+    class << self
+      def build(str, namespaces: {})
+        return str if str.is_a?(Fragment)
+        return EmptyFragment.new(str) if str.nil?
+        Fragment.new(str, namespaces: namespaces)
+      end
+    end
+  end
+end

data/lib/flexparser/tag_parser.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Flexparser
+  #
+  # A parser for a single tag.
+  #
+  class TagParser
+    attr_accessor :xpaths, :options
+
+    #
+    # @param name [Symbol] the name used for the accessor
+    #   defined on the parent.
+    # @param xpath [String] an xpath string used to access a Nokogiri-Fragment
+    #
+    def initialize(tags, **opts)
+      @xpaths  = XPaths.new(tags)
+      @options = opts
+    end
+
+    #
+    # @param doc [Nokogiri::Node] a node that can be accessed through xpath
+    # @return a String if no type was specified, otherwise the type
+    #   will try to parse the string using ::parse
+    #
+    def parse(doc)
+      result = content(doc) || return
+      return options[:sub_parser].parse(result) if sub_parser
+      type ? transform(result.text) : result.text
+    end
+
+    def name
+      options[:name] || xpaths.method_name
+    end
+
+    protected
+
+    def sub_parser
+      options[:sub_parser]
+    end
+
+    def type
+      options[:type] || options[:transform]
+    end
+
+    def transform(string)
+      return options[:type].parse string if options[:type]
+      return string.public_send(options[:transform]) if options[:transform]
+      string
+    end
+
+    def content(doc)
+      xpaths.valid_paths(doc).each do |path|
+        set = doc.xpath("(#{path})[1]")
+        return set unless set.empty?
+      end
+      return unless options[:required]
+      raise_required_error(doc)
+    end
+
+    def raise_required_error(doc)
+      raise(RequiredMissingError.new(self),
+            "Required field #{name} not found in #{doc}")
+    end
+  end
+end

data/lib/flexparser/version.rb

@@ -0,0 +1,3 @@
+module Flexparser
+  VERSION = '1.0.2'.freeze
+end

data/lib/flexparser/xpaths.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Flexparser
+  #
+  # A class to represent a collection of paths.
+  # This class is supposed to be more convenient for
+  # handeling a collection of xpaths.
+  #
+  class XPaths
+    attr_accessor :tags
+
+    #
+    # @param tags [Array<String>] a list of names for xpaths
+    #   that the xpaths instance will handle.
+    #
+    def initialize(tags)
+      @tags = Array(tags).map(&:to_sym).flatten
+      raise ArgumentError, arg_err_msg if @tags.empty?
+    end
+
+    #
+    # The name of an accesor, based on the collection of tags.
+    #
+    def method_name
+      tags.first.to_s.sub(/^@/, '').gsub(/([[:punct:]]|-)+/, '_')
+    end
+
+    #
+    # Builds xpaths from the given tags
+    #
+    def xpaths
+      @xpaths ||= begin
+                    paths = tags.map do |t|
+                      XPath.current.descendant(t)
+                    end
+                    if Flexparser.configuration.retry_without_namespaces
+                      paths += ns_ignortant_xpaths
+                    end
+                    paths
+                  end
+    end
+
+    #
+    # Returns the valid paths from this collection, based on the given doc.
+    # @param doc [Flexparser::Fragment] the fragment
+    #   that carries the namespaces.
+    # @return [Array<String>] the xpaths that can be applied to this fragment
+    #
+    def valid_paths(doc)
+      xpaths.reject do |path|
+        namespaced?(path) && !namespace_available?(path, doc)
+      end
+    end
+
+    private
+
+    #
+    # Returns xpaths that ignore namespaces.
+    #
+    def ns_ignortant_xpaths
+      tags.reject(&method(:namespaced?)).flat_map do |tag|
+        XPath.current.descendant[XPath.name.equals(tag.to_s)]
+      end
+    end
+
+    #
+    # Checks whether a tag has a specified namespace.
+    # @param tag [String] The tag to be looked at
+    #
+    def namespaced?(tag)
+      !(tag.to_s =~ /\w+:\w+/).nil?
+    end
+
+    #
+    # Checks whether or not a path is can be applied to a given fragment.
+    # @param path [String] the path that is to be checked
+    # @param doc [Flexparser::Fragment] the fragment that carries the
+    #   namespaces.
+    # @return [Boolean] true if the path can be applied, false otherwise.
+    #
+    def namespace_available?(path, doc)
+      nms = doc.propagating_namespaces.keys.map { |ns| ns.gsub('xmlns:', '') }
+      path.to_s.match Regexp.union(nms)
+    end
+
+    # no-doc
+    def arg_err_msg
+      'There needs to be at least one path for a path-collection to be valid'
+    end
+  end
+end

data/test.xml

@@ -0,0 +1,11 @@
+<bookstore>
+  <book>James</book>
+  <book>John</book>
+  <book>Jeff</book>
+  <book>Jerry</book>
+  <mag>Ed</mag>
+  <mag>Eddy</mag>
+  <tomb>
+    <paper>John</paper>
+  </tomb>
+</bookstore>

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: flexparser
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Paul Martensen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: xpath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A flexible and robust parser-dsl.
+email:
+- paul.martensen@gmx.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flexparser.gemspec
+- lib/flexparser.rb
+- lib/flexparser/anonymous_parser.rb
+- lib/flexparser/class_methods.rb
+- lib/flexparser/collection_parser.rb
+- lib/flexparser/configuration.rb
+- lib/flexparser/empty_fragment.rb
+- lib/flexparser/errors.rb
+- lib/flexparser/fragment.rb
+- lib/flexparser/fragment_builder.rb
+- lib/flexparser/tag_parser.rb
+- lib/flexparser/version.rb
+- lib/flexparser/xpaths.rb
+- test.xml
+homepage: https://github.com/lokalportal/flexparser
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: A xml-parser dsl
+test_files: []