flexparser 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85cd8bfa607fb3c293defb0150461353fa31319b
-  data.tar.gz: 87df797b67ba0e6cd49ec0dee5344a018192a366
+  metadata.gz: b4ba7b7c2ab1a7b1dc24734ad511d993f2066f55
+  data.tar.gz: 1fb2f8ab41e9de46bc75a5ac5f3a7353187ed64e
 SHA512:
-  metadata.gz: a55b522c114fa5a97e5b48acb4683ae41f9df5cd3ac6931bd542df0ad55fd2f47e433cfecd05244e06050f1262a2cf3086faa1069096005565965d7220795f9b
-  data.tar.gz: 0dbee10fd2c10f6a5a30bf7ff919e8989b867c937ca449067bd73d8de7042e09f2a53181a540948ebfe9239a4f2d25a6456883ec8960404e1c132a7a0dc5e2e9
+  metadata.gz: 168e4a55291b552671ab2d3cd37721f6b60eb8e74c6f769a0c8628038707acd57a7ce4df05aa34d58d4041b94f904f92786a800066d1cf61497c80c1f73f0f5a
+  data.tar.gz: 24aca6ac3b60723efad772664d11ed20c13401f003b59517604b5cf5c9ddf3bc52e9884e999bb3409204a785ad7cfc197c5790a7e9c33a0ff4581a07b5a05cae

data/.rubocop.yml

@@ -1 +1,4 @@
-inherit_from: .rubocop_todo.yml
+AllCops:
+  Exclude:
+    - 'Guardfile'
+    - 'flexparser.gemspec'

data/.travis.yml

@@ -1,5 +1,17 @@
 sudo: false
 language: ruby
 rvm:
+  - 2.2.4
+  - 2.2.1
+  - 2.3.0
   - 2.3.3
-before_install: gem install bundler -v 1.13.7
+  - 2.4.3
+  - 2.5.0
+  - jruby
+before_install: gem install bundler flay rubocop
+install:
+  - bundle install --retry=3 --with development
+script:
+  - bundle exec rake test
+  - bundle exec rubocop
+  - bundle exec flay

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+<!--
+
+// Please add your own contribution below inside the Master section, no need to
+// set a version number, that happens during a deploy.
+//
+// These docs are aimed at users rather than danger developers, so please limit technical
+// terminology in here.
+
+-->
+
+## master
+
+* Added some more documentation to Classmethods#parse.
+* Added minimum required ruby version.
+* Updated dependencies.

data/README.md

@@ -1,17 +1,22 @@
+
 # Flexparser
-`Flexparser` provides an easy to use DSL for flexible, robust xml parsers.  The goal of eflexparser is to be able to write **One Parser to parse them all**. 
+ [![travis](https://travis-ci.org/lokalportal/flexparser.svg?branch=master)](https://travis-ci.org/lokalportal/flexparser)
+`Flexparser`
+
+Provides an easy to use DSL for flexible, robust xml parsers.  The goal of flexparser is to be able to write **One Parser to parse them all**. 
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'flexparser', path: 'vendor/gems/' # Or whereever you have eflexparser stored
+gem 'flexparser'
 ```
 
-Since this gem is private, it can only be vendored into a project right now. 
-
-**BEWARE:** Since i started working on this gem, another gem by the name of `flexparser` has been published to rubygems. So calling `gem install flexparser` will in fact install the wrong gem.
+Or simply
+```shell
+gem install flexparser
+```
 
 ## Usage
 #### Basics:
@@ -58,7 +63,7 @@ work.story #=> ['The Call of Cthulhu', 'Dagon', 'The Nameless City']
 ```
 
 #### Nested Parsers
-Sometimes you want more than to just xtract a String. This way you can make your parser return complex Objects and nest parsers as deep as you like.
+Sometimes you want more than to just extract a String. This way you can make your parser return complex Objects and nest parsers as deep as you like.
 ```ruby
 library = "
 <book>
@@ -119,6 +124,24 @@ class UniParser
   property %w[image picture @img media:image], name: 'visual', type: URI, collection: true
 end
 ```
+#### Defining a parser with a block
+When defining nested parsers, you would use a block. Like this:
+```ruby
+class ParserClass
+  include Flexparser
+  
+  property 'story', collection: true do
+    property 'author'
+    property 'title'
+  end
+end
+```
+When passing a block to a parser definition, a new class is created that basically looks like this:
+```ruby
+Class.new { include Flexparser }
+```
+The block is then `class_eval`ed on this anonymous class. Thats gives you a lot of flexibility in definen your parsers. 
+
 ### Configuration
 You can configure Flexparser by using a block (for example in an initializer) like so:
 ```ruby
@@ -129,7 +152,7 @@ end
 At time of writing there are two Options:
 
 ####  `explicit_property_naming` 
-**Default: ** `true`
+**Default:**  `true`
 If this is `true` you need to specify a `:name` for your `property` everytime there is more than one tag in your tag-list.
 Example: 
 ```ruby
@@ -153,7 +176,7 @@ class SomeParser
   property 'inventory'
 end
 
-xml = "<inventory xmlns="www.my-inventory.com">james</inventory>"
+xml = '<inventory xmlns="www.my-inventory.com">james</inventory>'
 
 # The inventory can't be found because it is namespaced.
 SomeParser.parse(xml).inventory #=> nil :(
@@ -163,7 +186,7 @@ class SomeBetterParser
   property 'inventory'
 end
 
-xml = "<inventory xmlns="www.my-inventory.com">james</inventory>"
+xml = '<inventory xmlns="www.my-inventory.com">james</inventory>'
 
 # The inventory can be found because we don't care.
 SomeParser.parse(xml).inventory #=> 'james'
@@ -181,20 +204,3 @@ The `Flexparser` module defines certain class methods. Most importantly `propert
 The Parsers use an instance of `Flexparser::XPaths` to handle the array of tags that they are passed.
 When everything is setup (i.e. the class is loaded), you can call `::parse` on your MainClass and pass it an XML string.  At this point the MainClass instantiates itself and the `TagParser`s and `CollectionParser`s extract a value from the xml, that is then assigned to the newly created MainClass instance.
 
-#### Defining a parser with a block
-When defining nested parsers, you would use a block. Like this:
-```ruby
-class ParserClass
-  include Flexparser
-  
-  property 'story', collection: true do
-    property 'author'
-    property 'title'
-  end
-end
-```
-When passing a block to a parser definition, a new class is created that basically looks like this:
-```ruby
-Class.new { include Flexparser }
-```
-The block is then `class_eval`ed on this anonymous class. Thats gives you a lot of flexibility in definen your parsers. 

data/flexparser.gemspec

@@ -5,14 +5,17 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'flexparser/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'flexparser'
-  spec.version       = Flexparser::VERSION
-  spec.authors       = ['Paul Martensen']
-  spec.email         = ['paul.martensen@gmx.de']
-  spec.licenses      = ['GPL-3.0']
-  spec.homepage      = 'https://github.com/lokalportal/flexparser'
-  spec.summary       = 'A xml-parser dsl'
-  spec.description   = 'A flexible and robust parser-dsl.'
+  spec.name                  = 'flexparser'
+  spec.version               = Flexparser::VERSION
+  spec.authors               = ['Paul Martensen']
+  spec.email                 = ['paul.martensen@gmx.de']
+  spec.licenses              = ['GPL-3.0']
+  spec.homepage              = 'https://github.com/lokalportal/flexparser'
+  spec.summary               = 'A xml-parser dsl'
+  spec.required_ruby_version = '>= 2.1.0'
+  spec.description           = <<-DESC
+    A flexible and robust parser-dsl which is escpecially good for data-normalization.
+  DESC
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -21,12 +24,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'nokogiri', '~> 1.7'
-  spec.add_dependency 'xpath', '~> 2.1'
+  spec.add_dependency 'nokogiri', '~> 1'
+  spec.add_dependency 'xpath', '~> 2'
   spec.add_development_dependency 'guard', '~> 2.14'
   spec.add_development_dependency 'guard-minitest', '~> 2.4'
-  spec.add_development_dependency 'pry-byebug', '~> 3.4'
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest', '~> 5'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'flay', '~> 2'
 end

data/lib/flexparser/class_methods.rb

@@ -6,6 +6,11 @@ module Flexparser
     #
     # Applies the previously set up property-structure to the given xml
     # and returns Instances of the including Class.
+    # @param xml [String] The xml string to be parsed by this parser.
+    # @param _options [Hash] an (as of yet) unused options hash.
+    #   Swallowing options here keeps compatability with HappyMapper.
+    # @return [Object] An object of `self.class` that is initialized
+    #   with the extracted values from its subparsers.
     #
     def parse(xml, _options = {})
       return if parsers.empty?

data/lib/flexparser/collection_parser.rb

@@ -1,13 +1,18 @@
 module Flexparser
   #
   # A Parser similar to the TagParser but intendet for a collection
-  # of propertys.
+  # of properties.
   # @param sub_parser [Wrench] all CollectionParsers need a subparser to
   #   deal with the content of the nodes parsed. This should ideally be
   #   a class that includes Spigots::Wrench and can parse the fragment it
   #   is dealt.
   #
   class CollectionParser < TagParser
+    #
+    # @param doc [Nokogiri::Node] a node that can be accessed through xpath
+    # @return [Array<Object>] An array of String if no type was specified,
+    # otherwise the type will try to parse the string using ::parse
+    #
     def parse(doc)
       content(doc).map do |n|
         next sub_parser.parse(n) if sub_parser

data/lib/flexparser/fragment.rb

@@ -31,6 +31,9 @@ module Flexparser
         .build(doc.xpath(path, propagating_namespaces))
     end
 
+    #
+    # The namespaces that are propagating to the child-fragment of this.
+    #
     def propagating_namespaces
       return @propagated_namespaces unless doc.respond_to?(:namespaces)
       if doc.respond_to?(:collect_namespaces)

data/lib/flexparser/fragment_builder.rb

@@ -5,6 +5,12 @@ module Flexparser
   #
   class FragmentBuilder
     class << self
+      #
+      # @param str [String|Fragment] The object that will be turned into
+      #   a Fragment.
+      # @return A fragment of some kind. Either the given fragment, a new
+      #   normal {Fragment} or en {EmptyFragment}.
+      #
       def build(str, namespaces: {})
         return str if str.is_a?(Fragment)
         return EmptyFragment.new(str) if str.nil?

data/lib/flexparser/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexparser
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Paul Martensen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: xpath
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -67,62 +67,76 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.52'
   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.
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: "    A flexible and robust parser-dsl which is escpecially good for data-normalization.\n"
 email:
 - paul.martensen@gmx.de
 executables: []
@@ -131,8 +145,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -153,7 +167,6 @@ files:
 - 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
@@ -166,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -174,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A xml-parser dsl

data/.rubocop_todo.yml

@@ -1,22 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2017-08-10 12:10:56 +0200 using RuboCop version 0.49.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-Metrics/AbcSize:
-  Max: 16
-
-# Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 28
-
-# Offense count: 6
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 105

data/test.xml

@@ -1,11 +0,0 @@
-<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>