deba 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad9e94cee53cfd87b42e07aa49768998c7426135
+  data.tar.gz: 65034ed3fe3b044c1537a785c7e9dcd5c8964303
+SHA512:
+  metadata.gz: d6f759d4ea466c431aad03f62f65fa5e23ef14881d3ae4532497c1d9a2e869fd282807d434ddd44b5fe1e8b1e089afdac53bc3de62f660b9be896a9fb25aeb0d
+  data.tar.gz: 51a467840d948a621df946a1d8507c8cd0a3f902f4bd5f35079e014d5c5f1486a7ddd918137cf4b3c3fbbc0f8e484e8ad4dd5de88fb153b4fde915bb46ec94c1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Brenton "B-Train" Fletcher
+
+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,41 @@
+# Deba
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/deba`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deba'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deba
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/deba.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deba"
+
+# 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/deba.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deba/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deba"
+  spec.version       = Deba::VERSION
+  spec.authors       = ["Brenton \"B-Train\" Fletcher"]
+  spec.email         = ["i@bloople.net"]
+
+  spec.summary       = %q{Deba}
+  spec.description   = %q{Deba}
+  spec.homepage      = "http://example.com"
+  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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "nokogiri"
+end

data/lib/deba/break.rb

@@ -0,0 +1,5 @@
+class Deba::Break
+  def to_s
+    "\n"
+  end
+end

data/lib/deba/extractor.rb

@@ -0,0 +1,82 @@
+class Deba::Extractor
+  HEADING_TAGS = %w(h1 h2 h3 h4 h5 h6)
+  BLOCK_INITIATING_TAGS = %w(article aside body blockquote dd dt header li nav ol p pre section td th ul)
+  ENHANCERS = { %w(b strong) => "*", %(i em) => "_" }
+
+  attr_reader :blocks
+
+  def initialize(doc)
+    @doc = doc
+  end
+
+  def extract
+    @blocks = []
+    @just_appended_br = false
+    @text_run = Deba::TextRunner.new(self)
+
+    process(@doc.root)
+
+    @blocks.map { |block| block.to_s }.join
+  end
+
+  def process(node)
+    node_name = node.name.downcase
+
+    return if node_name == 'head'
+
+    #Handle repeated brs by making a paragraph break
+    if node_name == 'br'
+      if @just_appended_br
+        @just_appended_br = false
+
+        @text_run.break
+
+        return
+      else
+        @just_appended_br = true
+      end
+    elsif @just_appended_br
+      @just_appended_br = false
+
+      @text_run << Deba::Break.new
+    end
+
+    if node.text?
+      @text_run << node.inner_text if Deba::Utils.present?(node.inner_text)
+
+      return
+    end
+
+    if ENHANCERS.keys.flatten.include?(node_name)
+      ENHANCERS.each_pair do |tags, nsf_rep|
+        if tags.include?(node_name)
+          @text_run << nsf_rep
+          node.children.each { |n| process(n) }
+          @text_run << nsf_rep
+        end
+      end
+
+      return
+    end
+
+    #These tags terminate the current paragraph, if present, and start a new paragraph
+    if BLOCK_INITIATING_TAGS.include?(node_name)
+      @text_run.break(Deba::Paragraph)
+      node.children.each { |n| process(n) }
+      @text_run.break
+
+      return
+    end
+
+    if HEADING_TAGS.include?(node_name)
+      @text_run.break(Deba::Heading, node_name[1..-1].to_i)
+      node.children.each { |n| process(n) }
+      @text_run.break
+
+      return
+    end
+
+    #Pretend that the children of this node were siblings of this node (move them one level up the tree)
+    node.children.each { |n| process(n) }
+  end
+end

data/lib/deba/heading.rb

@@ -0,0 +1,12 @@
+class Deba::Heading
+  attr_reader :segments, :level
+
+  def initialize(segments, level)
+    @segments = segments
+    @level = level
+  end
+
+  def to_s
+    "#{"#" * @level} #{Deba::Stringifier.new(@segments).stringify}\n\n"
+  end
+end

data/lib/deba/paragraph.rb

@@ -0,0 +1,11 @@
+class Deba::Paragraph
+  attr_reader :segments
+
+  def initialize(segments)
+    @segments = segments
+  end
+
+  def to_s
+    "#{Deba::Stringifier.new(@segments).stringify}\n\n"
+  end
+end

data/lib/deba/stringifier.rb

@@ -0,0 +1,17 @@
+class Deba::Stringifier
+  def initialize(segments)
+    @segments = segments
+  end
+
+  def stringify
+    chunks = @segments.chunk { |segment| segment.class }
+
+    chunks.map do |type, chunk_segments|
+      if type == String
+        Deba::Utils.normalise(chunk_segments.join)
+      elsif type == Deba::Break
+        chunk_segments.map { |s| s.to_s }.join
+      end
+    end.join
+  end
+end

data/lib/deba/text_runner.rb

@@ -0,0 +1,33 @@
+class Deba::TextRunner
+  def initialize(extractor)
+    @extractor = extractor
+
+    start
+  end
+
+  def <<(segment)
+    @segments << segment
+  end
+
+  def break(block_type = Deba::Paragraph, param = nil)
+    finish
+    start(block_type, param)
+  end
+
+  def finish
+    return unless present?
+
+    block = @param.nil? ? @block_type.new(@segments) : @block_type.new(@segments, @param)
+    @extractor.blocks << block
+  end
+
+  def start(block_type = Deba::Paragraph, param = nil)
+    @segments = []
+    @block_type = block_type
+    @param = param
+  end
+
+  def present?
+    @segments.any? { |segment| segment.is_a?(String) && Deba::Utils.present?(segment) }
+  end
+end

data/lib/deba/utils.rb

@@ -0,0 +1,15 @@
+class Deba::Utils
+  BLANK_RE = /\A[[:space:]]*\z/
+
+  def self.blank?(text)
+    text.empty? || text =~ BLANK_RE
+  end
+
+  def self.present?(text)
+    !blank?(text)
+  end
+
+  def self.normalise(text)
+    text.gsub(/[[:space:]]+/, ' ').strip
+  end
+end

data/lib/deba/version.rb

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

data/lib/deba.rb

@@ -0,0 +1,19 @@
+require "nokogiri"
+
+module Deba
+end
+
+require "deba/version"
+require "deba/utils"
+require "deba/stringifier"
+require "deba/break"
+require "deba/heading"
+require "deba/paragraph"
+require "deba/text_runner"
+require "deba/extractor"
+
+module Deba
+  def self.extract(html)
+    Deba::Extractor.new(html.is_a?(Nokogiri::XML::Node) ? html : Nokogiri::HTML(html)).extract
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: deba
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brenton "B-Train" Fletcher
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-30 00:00:00.000000000 Z
+dependencies:
+- !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: 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: Deba
+email:
+- i@bloople.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deba.gemspec
+- lib/deba.rb
+- lib/deba/break.rb
+- lib/deba/extractor.rb
+- lib/deba/heading.rb
+- lib/deba/paragraph.rb
+- lib/deba/stringifier.rb
+- lib/deba/text_runner.rb
+- lib/deba/utils.rb
+- lib/deba/version.rb
+homepage: http://example.com
+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.8
+signing_key: 
+specification_version: 4
+summary: Deba
+test_files: []