xml_split 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xml_split.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Seamus Abshere
+
+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,29 @@
+# XmlSplit
+
+Split XML files on an element, yielding (streaming, so constant memory usage) each node in turn.
+
+Uses [sgrep](http://www.cs.helsinki.fi/u/jjaakkol/sgrepman.html) internally.
+
+As seen on ["Split XML files with `sgrep`, a classic UNIX utility from 1995"](http://numbers.brighterplanet.com/2012/09/11/split-xml-files-with-unix-utility-sgrep/)
+
+## Usage
+
+    >> require 'xml_split'
+    => true
+    >> x = XmlSplit.new('15MinLP_15Days.xml', 'IntervalReading')
+    => #<XmlSplit:0x0000010395ce60 @nodes=[], @cache_full=false, @path="/tmp/scratch/15MinLP_15Days.xml", @element="IntervalReading", @caching=false>
+    >> x.each { |node| puts node }
+    <IntervalReading>
+        <cost>907</cost>
+        <timePeriod>
+            <duration>900</duration>
+            <start>1330578000</start>
+             <!-- 3/1/2012 5:00:00 AM  -->
+        </timePeriod>
+        <value>302</value>
+    </IntervalReading>
+    [...]
+
+## Copyright
+
+Copyright 2012 Brighter Planet, Inc.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = %w{--format pretty}
+end
+
+task :default => [:cucumber]
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/bin/xml_split

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'xml_split'

data/features/step_definitions/xml_split_steps.rb

@@ -0,0 +1,13 @@
+require 'tempfile'
+
+Given /the element to split by "(.*)" and XML/ do |element, xml|
+  tmp = Tempfile.new(element)
+  tmp.write xml
+  tmp.flush
+  @object = XmlSplit.new(tmp.path, element)
+end
+
+Then /calling :(.*) must give (.*)/ do |method_id, raw_nodes|
+  nodes = eval raw_nodes
+  @object.send(method_id).should == nodes
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+
+require 'rspec/expectations'
+
+require 'xml_split'

data/features/xml_split.feature

@@ -0,0 +1,8 @@
+Feature: XmlSplit
+
+Scenario:
+  Given the element to split by "foo" and XML
+    """
+    <foo>bar</foo><foo>baz</foo>
+    """
+  Then calling :to_a must give ["<foo>bar</foo>", "<foo>baz</foo>"]

data/lib/xml_split/version.rb

@@ -0,0 +1,3 @@
+class XmlSplit
+  VERSION = "0.0.1"
+end

data/lib/xml_split.rb

@@ -0,0 +1,64 @@
+require "xml_split/version"
+
+class XmlSplit
+  class << self
+    def sgrep_bin
+      @sgrep_bin ||= POSSIBLE_BIN_NAMES.detect { |bin| `which #{bin}`; $?.success? } or raise("Can't find any of #{POSSIBLE_BIN_NAMES.inspect} in your PATH")
+    end
+  end
+
+  POSSIBLE_BIN_NAMES = %w{ sgrep sgrep2 }
+  MAGIC_START = 'n8frNy6J'
+  MAGIC_STOP = 'H6py5pxG'
+  CHUNK_SIZE = 65536
+
+  include Enumerable
+
+  attr_reader :path
+  attr_reader :element
+  attr_reader :caching
+
+  def initialize(path, element, options = {})
+    @nodes = []
+    @cache_full = false
+
+    @path = File.expand_path path
+    @element = element
+    @caching = options.fetch :caching, false
+  end
+
+  def each(&blk)
+    if caching and @cache_full
+      @nodes.each(&blk)
+    else
+      caching = caching
+      leftover = ''
+      IO.popen([ XmlSplit.sgrep_bin, '-n', '-o', "#{MAGIC_START}%r#{MAGIC_STOP}", %{"#{start}" .. "#{stop}"}, path ]) do |io|
+        while additional = io.read(CHUNK_SIZE)
+          buffer = leftover + additional
+          while (start = buffer.index(MAGIC_START)) and (stop = buffer.index(MAGIC_STOP))
+            node = buffer[(start+MAGIC_START.length)...stop] + '>'
+            if caching
+              @nodes << node
+            end
+            yield node
+            buffer = buffer[(stop+MAGIC_STOP.length)..-1]
+          end
+          leftover = buffer
+        end
+      end
+      @cache_full = true
+    end
+  end
+
+  private
+
+  def start
+    "<#{element}"
+  end
+
+  def stop
+    "</#{element}"
+  end
+
+end

data/xml_split.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xml_split/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "xml_split"
+  gem.version       = XmlSplit::VERSION
+  gem.authors       = ["Seamus Abshere"]
+  gem.email         = ["seamus@abshere.net"]
+  gem.description   = %q{Split XML files on an element, yielding (streaming, so constant memory usage) each node in turn. Uses sgrep internally.}
+  gem.summary       = %q{Split XML files on an element, yielding (streaming, so constant memory usage) each node in turn.}
+  gem.homepage      = "https://github.com/seamusabshere/xml_split"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec-core'
+  gem.add_development_dependency 'rspec-expectations'
+  gem.add_development_dependency 'rspec-mocks'
+  gem.add_development_dependency 'cucumber'
+  gem.add_development_dependency 'yard'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: xml_split
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Split XML files on an element, yielding (streaming, so constant memory
+  usage) each node in turn. Uses sgrep internally.
+email:
+- seamus@abshere.net
+executables:
+- xml_split
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/xml_split
+- features/step_definitions/xml_split_steps.rb
+- features/support/env.rb
+- features/xml_split.feature
+- lib/xml_split.rb
+- lib/xml_split/version.rb
+- xml_split.gemspec
+homepage: https://github.com/seamusabshere/xml_split
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Split XML files on an element, yielding (streaming, so constant memory usage)
+  each node in turn.
+test_files:
+- features/step_definitions/xml_split_steps.rb
+- features/support/env.rb
+- features/xml_split.feature
+has_rdoc: