doctree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48ac7895871e517a7ae8a8d9720cba53fe3f81ec
+  data.tar.gz: b4bbf31434897c08affe812e674a87839fec69dd
+SHA512:
+  metadata.gz: c7e0ffa36d43ce48190350d848cf845d61d6c76619ed4c656b77e730cd162f7efa058507376cdfcb8140ecd1d9cb8a75d33152a5ca47be675559f36c8c69f863
+  data.tar.gz: d9b18e500e8135edfda526b5a8cb3a858ab7acca96b7890ef839721968ebe6708ed28cdf48180fc90aa48d0cb433e378346a9a9cde52354116cfb1e3ba12549f

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.1

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Ralf Ebert
+
+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,28 @@
+# doctree-ruby
+
+doctree-ruby is a Ruby gem for generating doctrees f.e. from HTML documents.
+
+## Installation
+
+```
+    $ gem install doctree
+```
+
+## Usage
+
+Use `html2doctree` from the command line to extract links in list items from HTML pages:
+
+    curl https://en.wikipedia.org/wiki/Book | html2doctree --css "#toc"
+    
+See [test/doctree_test.rb](test/doctree_test.rb) for usage examples in Ruby code.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ralfebert/doctree-ruby.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "doctree"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

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/doctree.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doctree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doctree"
+  spec.version       = DocTree::VERSION
+  spec.authors       = ["Ralf Ebert"]
+  spec.email         = ["info@ralfebert.de"]
+
+  spec.summary       = %q{Generates table of contents documents in the .doctree format.}
+  spec.homepage      = "https://doctree.org/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubytree"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "trollop"
+  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 "pry"
+end

data/exe/html2doctree

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'doctree'
+require 'nokogiri'
+require 'trollop'
+require 'pry'
+
+opts = Trollop::options do
+  version "html2doctree"
+  banner <<-EOS
+
+Converts HTML from STDIN to a doctree.
+
+Usage:
+       html2doctree [options]
+       
+EOS
+
+  opt :css, "A css selector to restrict content", type: String
+end
+
+html = Nokogiri::HTML(STDIN)
+
+tree = DocTree::DocTreeNode.forHTML(html)
+
+elements = if css = opts[:css] then elements = html.css(css) else [html] end
+
+raise "No elements found" if elements.count == 0
+
+elements.each do |element|
+  tree.map_html_tree(element) do |html|
+    if html.name == 'li' and link = html.css(">a").first
+      DocTree::DocTreeNode.forHTML(link)
+    end
+  end
+end
+
+puts tree.to_s

data/lib/doctree.rb

@@ -0,0 +1,53 @@
+require 'doctree/version'
+require 'tree'
+require 'json'
+require 'nokogiri'
+
+module DocTree
+
+  class DocTreeNode < Tree::TreeNode
+  
+    attr_accessor :attrs
+    attr_accessor :name
+  
+    def attrs
+      @attrs ||= { }
+    end
+    
+    def href
+      attrs[:href]
+    end
+
+    def href=(new_value)
+      attrs[:href] = new_value
+    end
+    
+    def to_s
+      self.string_value { |node| node.name + if node.attrs and !node.attrs.empty? then " -- " + node.attrs.to_json.gsub("\n", "") else "" end }
+    end
+  
+    def string_value(depth = 0, indent = "\t", &block)
+      childStr = self.children.count > 0 ? "\n" + children.map{ |node| node.string_value(depth + 1, &block) }.join("\n") : ""
+      return [indent * depth, block.call(self), childStr].join("")
+    end
+  
+    def self.forHTML(html)
+      return DocTreeNode.new(html.title, html) if html.is_a? Nokogiri::XML::Document
+
+      if html.name == 'a'
+        node = DocTreeNode.new(html.text.strip, html)
+        node.href = html["href"].to_s
+        return node
+      end
+
+      raise "Unsupported node \"#{node.name}\", expected a Nokigiri XML/HTML document or <a> element"
+    end
+    
+    def map_html_tree(html, &block)
+      parent = if result = block.call(html) then self << result else self end
+      html.children.each { |c| parent.map_html_tree(c, &block) }
+    end
+  
+  end
+
+end

data/lib/doctree/version.rb

@@ -0,0 +1,3 @@
+module DocTree
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: doctree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ralf Ebert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubytree
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: 
+email:
+- info@ralfebert.de
+executables:
+- html2doctree
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doctree.gemspec
+- exe/html2doctree
+- lib/doctree.rb
+- lib/doctree/version.rb
+homepage: https://doctree.org/
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Generates table of contents documents in the .doctree format.
+test_files: []