libxml-io 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 505e7a54d194ddc69c072cd2e594eb5d98d8e444
+  data.tar.gz: c23e3c7055e1ed400393fc599d7ba87dabb3a360
+SHA512:
+  metadata.gz: caed745b6199ab0f92d8f9d0b552c0e9133fccd917c88f3cf90fb3a1be808c7292e3b6d71336204d87b98a1d24124619b26dcd81ee798b95b1b5037a60ef4248
+  data.tar.gz: 0b1100315eaa9730194ac32394eebad4ab8549c3288e41b4dbdce67885082f9bb81efb2318ab0b5c7b7a2bdb7da9adbee69efb870cb9e1512866b7f789efa899

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in libxml-io.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    libxml-io (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+    rake-compiler (1.0.4)
+      rake
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  libxml-io!
+  minitest (~> 5.11)
+  rake (~> 10.0)
+  rake-compiler (~> 1.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.md

@@ -0,0 +1,24 @@
+(The MIT License)
+
+Copyright (c) 2018:
+
+* Anton Kozhemyachenko
+
+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,56 @@
+# LibXML::IO
+
+The libxml-io gem provides Ruby language bindings for Libxml2 [xmlRegisterInputCallbacks](http://xmlsoft.org/html/libxml-xmlIO.html#xmlRegisterInputCallbacks).
+Can be used with any gem using Libxml2 XML toolkit, however this gem was primary designed to use with [Nokogiri](https://github.com/sparklemotion/nokogiri) which doesn't support this feature.
+Inspired by part of [Libxml-Ruby](https://github.com/xml4r/libxml-ruby).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'libxml-io'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install libxml-io
+
+## Usage
+
+```ruby
+    require 'libxml/io'
+
+    class InputCbc
+        def initialize
+            @xsd = ['test_common.xsd']
+        end
+
+        def match filename
+            @xsd.include? filename
+        end
+
+        def query filename
+            case filename
+            when 'test_common.xsd'
+                GET_FILE
+            end
+        end
+    end
+
+    LibXML::IO::InputCallbacks.register
+    LibXML::IO::InputCallbacks.add_handler InputCbc.new
+
+    INTERACT_WITH_LIBXML
+
+    LibXML::IO::InputCallbacks.clear_handlers
+    LibXML::IO::InputCallbacks.pop
+```
+
+## License
+
+MIT. See [`LICENSE.md`](LICENSE.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/libxml-io/extconf.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'mkmf'
+
+def crash(str)
+  printf(" extconf failure: %s\n", str)
+  exit 1
+end
+
+xc = with_config('xml2-config')
+if xc
+  cflags = `#{xc} --cflags`.chomp
+  if $CHILD_STATUS
+    libs = `#{xc} --libs`.chomp
+    if $CHILD_STATUS
+      $CFLAGS += ' ' + cflags
+      $libs = libs + ' ' + $libs
+    end
+  end
+else
+  dir_config('xml2')
+end
+
+unless find_header('libxml/xmlversion.h',
+                   '/opt/include/libxml2',
+                   '/opt/local/include/libxml2',
+                   '/usr/local/include/libxml2',
+                   '/usr/include/libxml2') &&
+       find_library('xml2', 'xmlParseDoc',
+                    '/opt/lib',
+                    '/opt/local/lib',
+                    '/usr/local/lib',
+                    '/usr/lib')
+  crash(<<EOL)
+need libxml2.
+
+    Install the library or try one of the following options to extconf.rb:
+
+      --with-xml2-config=/path/to/xml2-config
+      --with-xml2-dir=/path/to/libxml2
+      --with-xml2-lib=/path/to/libxml2/lib
+      --with-xml2-include=/path/to/libxml2/include
+EOL
+end
+
+$INCFLAGS << ' -I/usr/local/include'
+$CFLAGS << ' ' << $INCFLAGS
+
+create_header
+create_makefile('libxml_io')

data/ext/libxml-io/libxml-io.c

@@ -0,0 +1,189 @@
+#include "ruby.h"
+
+#include <libxml/parser.h>
+#include <libxml/xmlreader.h>
+
+static VALUE LibXMLIO = Qnil;
+
+typedef struct libxml_io_doc_context {
+	char *buffer;
+	char *bpos;
+	int remaining;
+} libxml_io_doc_context;
+
+typedef struct libxml_io_handler {
+	VALUE class;
+	struct libxml_io_handler *next_handler;
+} libxml_io_handler;
+
+static libxml_io_handler *first_handler = 0;
+
+static int libxml_io_registered = 0;
+
+static int libxml_io_match(char const *filename)
+{
+	libxml_io_handler *handler;
+	VALUE res;
+
+	handler = first_handler;
+	while (handler) {
+		res = rb_funcall(handler->class, rb_intern("match"), 1, rb_str_new2(filename));
+		if (!(RUBY_Qfalse == res || RUBY_Qnil == res || RUBY_Qundef == res)) {
+			return 1;
+		}
+		handler = handler->next_handler;
+	}
+	return 0;
+}
+
+static void* libxml_io_open(char const *filename)
+{
+	libxml_io_handler *handler;
+	VALUE res;
+
+	handler = first_handler;
+	while (handler) {
+		res = rb_funcall(handler->class, rb_intern("query"), 1, rb_str_new2(filename));
+		if (!(RUBY_Qfalse == res || RUBY_Qnil == res || RUBY_Qundef == res || !strlen(StringValuePtr(res)))) {
+			libxml_io_doc_context *libxml_io_doc;
+			libxml_io_doc = (libxml_io_doc_context*)malloc(sizeof(libxml_io_doc_context));
+			libxml_io_doc->buffer = strdup(StringValuePtr(res));
+			libxml_io_doc->bpos = libxml_io_doc->buffer;
+			libxml_io_doc->remaining = (int)strlen(libxml_io_doc->buffer);
+			return libxml_io_doc;
+		}
+		handler = handler->next_handler;
+	}
+
+	return 0;
+}
+
+static int libxml_io_read(void *context, char *buffer, int len)
+{
+	int ret_len;
+	libxml_io_doc_context *libxml_io_doc = (libxml_io_doc_context*)context;
+
+	if (len >= libxml_io_doc->remaining) {
+		ret_len = libxml_io_doc->remaining;
+	} else {
+		ret_len = len;
+	}
+	strncpy(buffer, libxml_io_doc->bpos, ret_len);
+	libxml_io_doc->bpos += ret_len;
+	libxml_io_doc->remaining -= ret_len;
+
+	return ret_len;
+}
+
+static int libxml_io_close(void *context)
+{
+	ruby_xfree(((libxml_io_doc_context*)context)->buffer);
+	ruby_xfree(context);
+	return 1;
+}
+
+static VALUE libxml_io_register_input_callbacks()
+{
+	if (libxml_io_registered) {
+		return Qfalse;
+	}
+	xmlRegisterInputCallbacks(libxml_io_match, libxml_io_open, libxml_io_read, libxml_io_close);
+	libxml_io_registered = 1;
+	return Qtrue;
+}
+
+static VALUE libxml_io_pop_input_callbacks()
+{
+	if (!libxml_io_registered) {
+		return Qfalse;
+	}
+	xmlPopInputCallbacks();
+	libxml_io_registered = 0;
+	return Qtrue;
+}
+
+static VALUE libxml_io_add_handler(VALUE self, VALUE class)
+{
+	libxml_io_handler *handler;
+
+	handler = (libxml_io_handler*)malloc(sizeof(libxml_io_handler));
+	handler->next_handler = 0;
+	handler->class = class;
+
+	if (!first_handler) {
+		first_handler = handler;
+	} else {
+		libxml_io_handler *pos;
+		pos = first_handler;
+		while (pos->next_handler) {
+			pos = pos->next_handler;
+		}
+		pos->next_handler = handler;
+	}
+
+	return Qtrue;
+}
+
+static VALUE libxml_io_remove_handler(VALUE self, VALUE class)
+{
+	libxml_io_handler *save_handler, *handler;
+
+	if (!first_handler) {
+		return Qfalse;
+	}
+
+	if (class == first_handler->class) {
+		save_handler = first_handler->next_handler;
+		ruby_xfree(first_handler);
+		first_handler = save_handler;
+		return Qtrue;
+	}
+
+	handler = first_handler;
+	while (handler->next_handler) {
+		if (class == handler->next_handler->class) {
+			save_handler = handler->next_handler->next_handler;
+			ruby_xfree(handler->next_handler);
+			handler->next_handler = save_handler;
+			return Qtrue;
+		}
+		handler = handler->next_handler;
+	}
+	return Qfalse;
+}
+
+static VALUE libxml_io_clear_handlers(VALUE self)
+{
+	libxml_io_handler *save_handler, *handler;
+
+	handler = first_handler;
+	while (handler) {
+		save_handler = handler;
+		handler = handler->next_handler;
+		ruby_xfree(save_handler);
+	}
+	first_handler = 0;
+	return Qtrue;
+}
+
+static void libxml_io_init_input_callbacks(void)
+{
+	VALUE cInputCallbacks = rb_define_class_under(LibXMLIO, "InputCallbacks", rb_cObject);
+
+	rb_define_singleton_method(cInputCallbacks, "register",
+			libxml_io_register_input_callbacks, 0);
+	rb_define_singleton_method(cInputCallbacks, "pop",
+			libxml_io_pop_input_callbacks, 0);
+	rb_define_singleton_method(cInputCallbacks, "add_handler",
+			libxml_io_add_handler, 1);
+	rb_define_singleton_method(cInputCallbacks, "remove_handler",
+			libxml_io_remove_handler, 1);
+	rb_define_singleton_method(cInputCallbacks, "clear_handlers",
+			libxml_io_clear_handlers, 0);
+}
+
+void Init_libxml_io()
+{
+	LibXMLIO = rb_define_module_under(rb_define_module("LibXML"), "IO");
+	libxml_io_init_input_callbacks();
+}

data/lib/libxml/io.rb

@@ -0,0 +1,13 @@
+require 'libxml/io/version'
+
+begin
+  RUBY_VERSION =~ /(\d+.\d+)/
+  require "#{Regexp.last_match(1)}/libxml_io"
+rescue LoadError
+  require 'libxml_io'
+end
+
+module LibXML
+  module IO
+  end
+end

data/lib/libxml/io/version.rb

@@ -0,0 +1,5 @@
+module LibXML
+  module IO
+    VERSION = '0.1.0'.freeze
+  end
+end

data/libxml-io.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'libxml/io/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'libxml-io'
+  spec.version       = LibXML::IO::VERSION
+  spec.authors       = ['Anton Kozhemyachenko']
+  spec.email         = ['gmerzu@gmail.com']
+
+  spec.homepage      = 'https://github.com/gmerzu/libxml-io_gem'
+  spec.summary       = 'LibXML xmlRegisterInputCallbacks extenstion for Ruby.'
+  spec.description   = <<-EOS
+    Allow to register an I/O callback for handling parser input (xmlRegisterInputCallbacks).
+    Primary designed to use with Nokogiri which doesn't support this feature.
+  EOS
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'bin'
+  spec.extensions = ['ext/libxml-io/extconf.rb']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.8.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-compiler', '~> 1.0'
+  spec.add_development_dependency 'minitest', '~> 5.11'
+
+  spec.license = 'MIT'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: libxml-io
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Kozhemyachenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+description: |2
+      Allow to register an I/O callback for handling parser input (xmlRegisterInputCallbacks).
+      Primary designed to use with Nokogiri which doesn't support this feature.
+email:
+- gmerzu@gmail.com
+executables:
+- setup
+extensions:
+- ext/libxml-io/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/setup
+- ext/libxml-io/extconf.rb
+- ext/libxml-io/libxml-io.c
+- lib/libxml/io.rb
+- lib/libxml/io/version.rb
+- libxml-io.gemspec
+homepage: https://github.com/gmerzu/libxml-io_gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: LibXML xmlRegisterInputCallbacks extenstion for Ruby.
+test_files: []