llt-xml_handler 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6625e462a881ed0ba364c7390ca5e8fd1acde74
+  data.tar.gz: a50e3fd4598e9d733a5e0fd15b4211c5b0551b03
+SHA512:
+  metadata.gz: a6ba8f8ccb038fed2c55d29339f0c34a8896d438f2b6d11029b78b4ea052ce6ccd31b189ccce3e1ac37a3f93c7d2757a3e05aee735e932a94c70a094f1985911
+  data.tar.gz: e862b0c7fdf853cd07ff5e7b28cb9a31560369b377748758cc73304f5ab39339c4b57d19aa4ab935c7a064d131b841ad6af9fb84e5c81361307309792343efb4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+language: ruby
+before_script:
+- export JRUBY_OPTS=--2.0
+rvm:
+- 2.1.0
+- 2.0.0
+- jruby-1.7.8

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in llt-tei_handler.gemspec
+gemspec
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 LFDM
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# LLT::XmlHandler
+
+[![Version](http://allthebadges.io/latin-language-toolkit/llt-xml_handler/badge_fury.png)](http://allthebadges.io/latin-language-toolkit/llt-xml_handler/badge_fury)
+[![Dependencies](http://allthebadges.io/latin-language-toolkit/llt-xml_handler/gemnasium.png)](http://allthebadges.io/latin-language-toolkit/llt-xml_handler/gemnasium)
+[![Build Status](http://allthebadges.io/latin-language-toolkit/llt-xml_handler/travis.png)](http://allthebadges.io/latin-language-toolkit/llt-xml_handler/travis)
+[![Coverage](http://allthebadges.io/latin-language-toolkit/llt-xml_handler/coveralls.png)](http://allthebadges.io/latin-language-toolkit/llt-xml_handler/coveralls)
+[![Code Climate](http://allthebadges.io/latin-language-toolkit/llt-xml_handler/code_climate.png)](http://allthebadges.io/latin-language-toolkit/llt-xml_handler/code_climate)
+
+Leightweigth transformations of XML Documents
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'llt-xml_handler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install llt-xml_handler
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/llt-xml_handler/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/llt/xml_handler.rb

@@ -0,0 +1,7 @@
+require "llt/xml_handler/version"
+
+module LLT
+  module XmlHandler
+    require 'llt/xml_handler/pre_processor'
+  end
+end

data/lib/llt/xml_handler/pre_processor.rb

@@ -0,0 +1,60 @@
+module LLT
+  module XmlHandler
+    class PreProcessor
+      require 'nokogiri'
+
+      attr_reader :document
+
+      def initialize(document, root: nil, ns: nil)
+        @document = Nokogiri::XML(document)
+        @namespace = ns
+        go_to_root(root) if root
+
+        @document.encoding = "UTF-8"
+      end
+
+      def to_xml
+        without_duplicate_declaration(@document.to_xml).strip
+      end
+
+      def remove_nodes(*nodes)
+        nodes.each do |node|
+          @document.xpath(*to_xpath(node, @namespace)).each(&:remove)
+        end
+      end
+
+      private
+
+      DUPLICATE_XML_VERSION = /<\?xml version=.*\?>\s*{2}/m
+      def without_duplicate_declaration(doc)
+        if doc.match(DUPLICATE_XML_VERSION)
+          doc.sub(/^<\?xml version=.*\?>/, '')
+        else
+          doc
+        end
+      end
+
+      def to_xpath(elem, ns)
+        ns ? ["//ns:#{elem}", ns: ns] : ["//#{elem}"]
+      end
+
+      def go_to_root(root)
+        new_root = @document.xpath(*to_xpath(root, @namespace)).first
+        return unless new_root # or throw an error?
+
+        if RUBY_ENGINE == "jruby"
+          # Pretty unnecessarily reparses the document fragment, but
+          # nokogiri-java seems to have problems with handling namespaces
+          # when assigning the root node of a document by hand.
+          #
+          # The issue has been reported on the nokogiri-talk Google group
+          # and is described in detail there (currently awaiting approval)
+          @document = Nokogiri::XML(new_root.to_s)
+        else
+          @document = Nokogiri::XML::Document.new
+          @document.root = new_root
+        end
+      end
+    end
+  end
+end

data/lib/llt/xml_handler/version.rb

@@ -0,0 +1,5 @@
+module LLT
+  module XmlHandler
+    VERSION = "0.0.3"
+  end
+end

data/llt-xml_handler.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'llt/xml_handler/version' 
+Gem::Specification.new do |spec|
+  spec.name          = "llt-xml_handler"
+  spec.version       = LLT::XmlHandler::VERSION
+  spec.authors       = ["LFDM"]
+  spec.email         = ["1986gh@gmail.com"]
+  spec.summary       = %q{Leightweigth transformations of XML Documents}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov", "~> 0.7"
+  spec.add_dependency "nokogiri"
+end

data/spec/lib/llt/xml_handler/pre_processor_spec.rb

@@ -0,0 +1,152 @@
+require 'spec_helper'
+
+describe LLT::XmlHandler::PreProcessor do
+  let(:pre_processor) { LLT::XmlHandler::PreProcessor }
+
+  def load_fixture(filename)
+    File.read(File.expand_path("../../../fixtures/#{filename}", __FILE__))
+  end
+
+  let(:embedded_tei_doc) do
+    <<-EOF
+      <?xml version="1.0" encoding="utf-8"?>
+      <reply>
+        <TEI xmlns="http://www.tei-c.org/ns/1.0">
+          <teiHeader>
+            <xxx/>
+          </teiHeader>
+          <body>
+            <head>TITLE</head>
+            <p>Text <ref type='note'>Note</ref> resumed</p>
+          </body>
+        </TEI>
+      </reply
+    EOF
+  end
+
+  let(:tei_doc) do
+    <<-EOF
+      <?xml version="1.0" encoding="utf-8"?>
+      <TEI xmlns="http://www.tei-c.org/ns/1.0">
+        <teiHeader>
+          <xxx/>
+        </teiHeader>
+        <body>
+          <head>TITLE</head>
+          <p>Text <ref type='note'>Note</ref> resumed</p>
+        </body>
+      </TEI>
+    EOF
+  end
+
+  let(:prefixed_tei_doc) do
+    <<-EOF
+      <?xml version="1.0" encoding="utf-8"?>
+      <reply xmlns:tei="http://www.tei-c.org/ns/1.0">
+        <tei:TEI>
+          <tei:teiHeader>
+            <xxx/>
+          </tei:teiHeader>
+          <tei:body>
+            <tei:head>TITLE</head>
+            <tei:p>Text <tei:ref type='note'>Note</tei:ref> resumed</tei:p>
+          </tei:body>
+        </tei:TEI>
+      </tei:reply
+    EOF
+  end
+
+  let(:doc_wo_ns) do
+    <<-EOF
+      <?xml version="1.0" encoding="utf-8"?>
+      <reply>
+        <custom_root>
+          <teiHeader></teiHeader>
+          <body></body>
+        </custom_root>
+      </reply>
+    EOF
+  end
+
+  describe "#new" do
+    it "takes a xml document on initialization" do
+      doc = <<-EOF
+        <?xml version="1.0" encoding="utf-8"?>
+        <TEI xmlns="http://www.tei-c.org/ns/1.0">
+        </TEI>
+      EOF
+      expect { pre_processor.new(doc) }.not_to raise_error
+    end
+
+    it "tries to find a root element, given as optional keyword param" do
+      doc = pre_processor.new(doc_wo_ns, root: 'custom_root')
+      doc.document.root.name.should == 'custom_root'
+    end
+
+    it "root element can have a namespace, given as optional keyword param" do
+      doc = pre_processor.new(embedded_tei_doc, root: 'TEI', ns: "http://www.tei-c.org/ns/1.0")
+      doc.document.root.name.should == "TEI"
+    end
+
+    it "really honors the namespace - it has to be present when given" do
+      doc = pre_processor.new(embedded_tei_doc, root: 'TEI')
+      doc.document.root.name.should_not == "TEI"
+    end
+
+    it "also works with prefixes" do
+      doc = pre_processor.new(prefixed_tei_doc, root: 'TEI', ns: "http://www.tei-c.org/ns/1.0")
+      doc.document.root.name.should == "TEI"
+    end
+  end
+
+  describe "#remove_nodes" do
+    def with_stripped_lines(string)
+      string.lines.map(&:strip).join
+    end
+
+    it "takes out a given node including all of its content" do
+      doc = pre_processor.new(doc_wo_ns)
+
+      doc.document.xpath('//teiHeader').should_not be_empty
+
+      doc.remove_nodes('teiHeader')
+      doc.document.xpath('//teiHeader').should be_empty
+    end
+
+    it "can remove several nodes at a single step" do
+      doc = pre_processor.new(doc_wo_ns)
+
+      doc.document.xpath('//teiHeader').should_not be_empty
+      doc.document.xpath('//body').should_not be_empty
+
+      doc.remove_nodes('teiHeader', 'body')
+      doc.document.xpath('//teiHeader').should be_empty
+      doc.document.xpath('//body').should be_empty
+    end
+
+    it "honors a namespace given on initialization" do
+      ns =  "http://www.tei-c.org/ns/1.0"
+      doc1 = pre_processor.new(tei_doc,   ns: ns)
+      doc2 = pre_processor.new(doc_wo_ns, ns: ns)
+
+      doc1.document.xpath('//ns:teiHeader', ns: ns).should_not be_empty
+      doc2.document.xpath('//teiHeader').should_not be_empty
+
+      doc1.remove_nodes('teiHeader')
+      doc2.remove_nodes('teiHeader')
+
+      doc1.document.xpath('//ns:teiHeader', ns: ns).should be_empty
+      doc2.document.xpath('//teiHeader').should_not be_empty
+    end
+
+    it "also works with prefixes" do
+      ns =  "http://www.tei-c.org/ns/1.0"
+      doc = pre_processor.new(prefixed_tei_doc,   ns: ns)
+
+      doc.document.xpath('//ns:teiHeader', ns: ns).should_not be_empty
+
+      doc.remove_nodes('teiHeader')
+      doc.document.xpath('//ns:teiHeader', ns: ns).should be_empty
+    end
+  end
+end

data/spec/lib/llt/xml_handler_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe LLT::XmlHandler do
+  it 'has a version number' do
+    expect(LLT::XmlHandler::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'simplecov'
+require 'coveralls'
+
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'llt/xml_handler'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: llt-xml_handler
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- LFDM
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Leightweigth transformations of XML Documents
+email:
+- 1986gh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/llt/xml_handler.rb
+- lib/llt/xml_handler/pre_processor.rb
+- lib/llt/xml_handler/version.rb
+- llt-xml_handler.gemspec
+- spec/lib/llt/xml_handler/pre_processor_spec.rb
+- spec/lib/llt/xml_handler_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Leightweigth transformations of XML Documents
+test_files:
+- spec/lib/llt/xml_handler/pre_processor_spec.rb
+- spec/lib/llt/xml_handler_spec.rb
+- spec/spec_helper.rb