usfx 0.1.2

data/README.md

@@ -0,0 +1,46 @@
+# USFX
+
+This is a very simple SAX Document and Nokogiri SAX Parser for reading [Unified Scripture Format XML](http://ebible.org/usfx/) (USFX) files as a stream and doing something interesting with the verse data.
+
+I needed to get the World English Bible (WEB) into a database easily and efficiently, so this was born. This parser excludes footnotes and other content other than the verse text itself, which may or may not be what you want.
+
+Pull requests welcome!
+
+## Install
+
+```
+gem install usfx
+```
+
+## Use
+
+You can get the World English Bible (WEB) in USFX format [here](http://ebible.org/web/). Unzip and put the usfx.xml file somewhere.
+
+```ruby
+class MyDocument < USFX::Document
+  def verse(data)
+    # do something with verse data, which looks like:
+    # {
+    #   book_num: 1,
+    #   book_id: 'GEN',
+    #   book: 'Genesis',
+    #   chapter: 1,
+    #   verse: 1,
+    #   text: 'In the beginning, God created the heavens and the earth.'
+    # }
+  end
+end
+
+parser = USFX::Parser.new(MyDocument.new)
+parser.parse(File.open('eng-web_usfx.xml'))
+```
+
+## License
+
+Copyright (c) 2013 Tim Morgan
+
+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/lib/document.rb

@@ -0,0 +1,122 @@
+require 'nokogiri'
+
+module USFX
+
+  # The Document class used by Nokogiri SAX Parser,
+  # with an added "verse" event for convenience
+  class Document < Nokogiri::XML::SAX::Document
+
+    # list of book ids that should be skipped
+    IGNORE_BOOK_IDS = %w(FRT)
+
+    def initialize
+      super
+      @book_num = 0
+    end
+
+    # main dispatcher, calls other specific element event methods
+    def start_element(name, attributes)
+      case name
+      when 'book'
+        start_book(attributes)
+      when 'h'
+        start_book_title(attributes)
+      when 'c'
+        start_chapter(attributes)
+      when 'v'
+        start_verse(attributes)
+      when 've'
+        end_verse
+      when 'f'
+        start_footnote(attributes)
+      end
+    end
+
+    # dispatcher for closing tags
+    def end_element(name)
+      case name
+      when 'h'
+        end_book_title
+      when 'f'
+        end_footnote
+      end
+    end
+
+    # event fired when book is started
+    def start_book(attributes)
+      id = Hash[attributes]['id']
+      unless IGNORE_BOOK_IDS.include?(id)
+        @book_num += 1
+        @book_id = id
+        @mode = 'book'
+        @book = ''
+      end
+    end
+
+    # event fired when book title is started
+    def start_book_title(attributes)
+      @mode = 'book-title' if @mode == 'book'
+    end
+
+    # event fired when book title is ended
+    def end_book_title
+      @mode = nil
+    end
+
+    # event fired when chapter is started
+    def start_chapter(attributes)
+      @chapter = Hash[attributes]['id'].to_i
+    end
+
+    # event fired when verse is started
+    def start_verse(attributes)
+      @verse = Hash[attributes]['id'].to_i
+      @text = ''
+      @mode = 'verse'
+    end
+
+    # event fired when verse is ended
+    def end_verse
+      @mode = nil
+      verse(book_num: @book_num, book_id: @book_id, book: @book, chapter: @chapter, verse: @verse, text: @text)
+    end
+
+    # event fired when footnote is started
+    def start_footnote(attributes)
+      @mode = "footnote|#{@mode}"
+    end
+
+    # event fired when footnote is ended
+    def end_footnote
+      @mode = @mode.split('|').last
+    end
+
+    # event fired when encountering text data in a tag
+    def characters(string)
+      case @mode
+      when 'book-title'
+        @book << string unless string == "\n"
+      when 'verse'
+        @text << string
+      end
+    end
+
+    # event fired upon completion of a verse
+    # verse data is passed as a hash of the form:
+    #
+    #   {
+    #     book_num: 1,
+    #     book_id: 'GEN',
+    #     book: 'Genesis',
+    #     chapter: 1,
+    #     verse: 1,
+    #     text: 'In the beginning, God created the heavens and the earth.'
+    #   }
+    #
+    # By default, this event will print the raw verse data.
+    # Override in your subclass to do fun stuff.
+    def verse(data)
+      p(data)
+    end
+  end
+end

data/lib/parser.rb

@@ -0,0 +1,33 @@
+require 'nokogiri'
+
+require_relative 'document'
+
+module USFX
+
+  # A tiny wrapper around Nokogiri::XML::SAX::Parser, just for fun.
+  #
+  # Usage:
+  #
+  #   parser = USFX::Parser.new
+  #   parser.parse(File.open('eng-web_usfx.xml'))
+  #
+  # To use your own Document class:
+  #
+  #   class MyDocument < USFX::Document
+  #     def verse(data)
+  #       # do something with verse data here
+  #     end
+  #   end
+  #
+  #   parser = USFX::Parser.new(MyDocument.new)
+  #   parser.parse(File.open('eng-web_usfx.xml'))
+  #
+  # (and with this example, USFX::Parser does absolutely nothing more than Nokogiri::XML::SAX::Parser)
+  #
+  class Parser < Nokogiri::XML::SAX::Parser
+    def initialize(document=Document.new)
+      super(document)
+    end
+  end
+
+end

data/lib/usfx.rb

@@ -0,0 +1,2 @@
+require_relative 'document'
+require_relative 'parser'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: usfx
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.2
+platform: ruby
+authors:
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :runtime
+  name: nokogiri
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+description: 
+email: tim@timmorgan.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/document.rb
+- lib/parser.rb
+- lib/usfx.rb
+homepage: https://github.com/seven1m/usfx
+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.25
+signing_key: 
+specification_version: 3
+summary: Ruby stream parser for Unified Scripture Format XML (USFX)
+test_files: []