mdn_query 0.1.0

data/lib/mdn_query/table.rb

@@ -0,0 +1,114 @@
+module MdnQuery
+  # A symmetric table with a nicely aligned textual representation.
+  #
+  # The table automatically adjusts rows that are too small by padding them with
+  # empty strings.
+  class Table
+    # @return [Array<Array<String>>] the body (list of rows) of the table
+    attr_reader :body
+
+    # @return [Array<String>] the heading of the table
+    attr_reader :heading
+
+    # @return [Fixnum] the number of columns in the table
+    attr_reader :size
+
+    # Creates a new table.
+    #
+    # @param heading [Array<String>] the heading of the table
+    # @param rows [Array<String>] rows to add to the body
+    # @return [MdnQuery::Table]
+    def initialize(heading, *rows)
+      @heading = heading
+      @size = heading.size
+      @body = []
+      rows.each { |row| add_row(row) }
+    end
+
+    # Adds a row to the body of the table.
+    #
+    # When the size of the row is smaller than the current table size, it is
+    # padded with empty strings to that size.
+    # When the size is greater than the current table size, the entire table is
+    # padded with empty strings to that size.
+    #
+    # @param row [Array<String>] the row to add
+    # @return [void]
+    def add_row(row)
+      if row.size < @size
+        row.fill('', row.size...@size)
+      elsif row.size > @size
+        @heading.fill('', @size...row.size)
+        @body.each { |r| r.fill('', @size...row.size) }
+        @size = row.size
+      end
+      @body << row
+    end
+
+    # Returns the number of columns in the table.
+    #
+    # @return [Fixnum]
+    def cols
+      @size
+    end
+
+    # Returns the number of rows in the body of the table.
+    #
+    # @return [Fixnum]
+    def rows
+      @body.size
+    end
+
+    # Returns the string representation of the table.
+    #
+    # This representation is a Markdown table that is aligned nicely, so that it
+    # is also easy to read in its raw format.
+    #
+    # @example Small table
+    #   | Title | Description      |
+    #   | ----- | ---------------- |
+    #   | One   |                  |
+    #   | Two   | Long description |
+    #
+    # @return [String]
+    def to_s
+      return '' if cols < 1
+      col_sizes = max_col_sizes
+      str = heading_str(col_sizes)
+      str << separator(col_sizes)
+      str << body_str(col_sizes)
+      str
+    end
+
+    private
+
+    def max_col_sizes
+      max_sizes = @heading.map { |col| col.size > 3 ? col.size : 3 }
+      @body.each do |row|
+        row.each.with_index do |str, index|
+          next unless str.size > max_sizes[index]
+          max_sizes[index] = str.size
+        end
+      end
+      max_sizes
+    end
+
+    def pad_cols(row, col_sizes)
+      row.map.with_index { |col, index| col.ljust(col_sizes[index]) }
+    end
+
+    def heading_str(col_sizes)
+      "| #{pad_cols(@heading, col_sizes).join(' | ')} |\n"
+    end
+
+    def body_str(col_sizes)
+      return '' if @body.empty?
+      rows = @body.map { |row| "| #{pad_cols(row, col_sizes).join(' | ')} |" }
+      "#{rows.join("\n")}\n"
+    end
+
+    def separator(col_sizes)
+      "| #{col_sizes.map { |size| '-' * size }.join(' | ')} |\n"
+    end
+  end
+end

data/lib/mdn_query/traverse_dom.rb

@@ -0,0 +1,176 @@
+module MdnQuery
+  # A DOM traverser that extracts relevant elements.
+  class TraverseDom
+    # @return [MdnQuery::Section] the current section
+    attr_reader :current_section
+
+    # @return [Nokogiri::HTML::Document] the DOM that is traversed
+    attr_reader :dom
+
+    # @return [MdnQuery::Document] the document that contains the extracted text
+    attr_reader :document
+
+    # Sections that are blacklisted and excluded from the document.
+    BLACKLIST = %w(Specifications Browser_compatibility).freeze
+
+    # Creates a new document with the extracted text.
+    #
+    # @param dom [Nokogiri::HTML::Document] the DOM that is traversed
+    # @param title [String] the title of the document
+    # @param url [String] the URL to the document on the web
+    # @return [MdnQuery::Document] the document with the extracted text
+    def self.create_document(dom, title, url)
+      document = MdnQuery::Document.new(title, url)
+      fill_document(dom, document)
+    end
+
+    # Fills a document with the extracted text.
+    #
+    # @param dom [Nokogiri::HTML::Document] the DOM that is traversed
+    # @param document [MdnQuery::Document] the document to be filled
+    # @return [MdnQuery::Document] the document with the extracted text
+    def self.fill_document(dom, document)
+      traverser = new(dom, document: document)
+      traverser.traverse
+      traverser.document
+    end
+
+    # Creates a new DOM traverser.
+    #
+    # The given document is used to save the extracted text. If no document is
+    # given, a new one is created with the generic title 'root' and the given
+    # url.
+    #
+    # The DOM is not automatically traversed (use {#traverse}).
+    #
+    # @param dom [Nokogiri::HTML::Document] the DOM that is traversed
+    # @param document [MdnQuery::Document] the document to be filled
+    # @param url [String] the URL for the new document if none was provided
+    # @return [MdnQuery::TraverseDom]
+    def initialize(dom, document: nil, url: nil)
+      @dom = dom
+      @document = document || MdnQuery::Document.new('root', url)
+      @current_section = @document.section
+    end
+
+    # Creates a new child section on the appropriate parent section.
+    #
+    # @param desired_level [Fixnum] the desired level for the child section
+    # @param name [String] the name and title of the child section
+    # @return [MdnQuery::Section] the newly created child section
+    def create_child(desired_level, name)
+      until @current_section.level < desired_level ||
+            @current_section.parent.nil?
+        @current_section = @current_section.parent
+      end
+      @current_section = @current_section.create_child(name)
+    end
+
+    # Traverses the DOM and extracts relevant informations into the document.
+    #
+    # @return [void]
+    def traverse
+      unless @dom.css('div.nonStandard').empty?
+        @current_section.append_text("\n> ***Non-standard***\n")
+      end
+      blacklist_level = nil
+      @dom.children.each do |child|
+        if child_blacklisted?(child, blacklist_level)
+          if blacklist_level.nil?
+            blacklist_level = child.name.match(/\Ah(?<level>\d)\z/)[:level]
+          end
+          next
+        end
+        blacklist_level = nil
+        case child.name
+        when 'p'
+          @current_section.append_text(child.text)
+        when 'ul'
+          @current_section.append_text(convert_list(child))
+        when 'dl'
+          @current_section.append_text(convert_description(child))
+        when 'pre'
+          @current_section.append_code(child.text, language: 'javascript')
+        when /\Ah(?<level>\d)\z/
+          level = $LAST_MATCH_INFO[:level].to_i
+          create_child(level, child[:id].tr('_', ' '))
+        when 'table'
+          @current_section.append_text(convert_table(child))
+        when 'div'
+          next if child[:class].nil?
+          if child[:class].include?('note') || child[:class].include?('warning')
+            @current_section.append_text("\n> #{child.text}\n")
+          end
+        end
+      end
+    end
+
+    # Returns whether the id is blacklisted.
+    #
+    # @param id [String] the id to be tested
+    # @return [Boolean]
+    def blacklisted?(id)
+      BLACKLIST.include?(id)
+    end
+
+    private
+
+    def child_blacklisted?(child, blacklist_level)
+      match = child.name.match(/\Ah(?<level>\d)\z/)
+      if match.nil?
+        !blacklist_level.nil?
+      else
+        blacklisted?(child[:id]) ||
+          (!blacklist_level.nil? && match[:level] > blacklist_level)
+      end
+    end
+
+    def convert_list(ul)
+      lines = ul.children.map do |child|
+        if child.name == 'ul'
+          convert_list(child)
+        elsif child.name == 'li'
+          "- #{child.text}\n"
+        else
+          child.text
+        end
+      end
+      lines.join
+    end
+
+    def convert_description(dl)
+      lines = dl.children.map do |child|
+        if child.name == 'dl'
+          convert_description(child)
+        elsif child.name == 'dt'
+          "\n**#{child.text}**\n"
+        else
+          "\n#{child.text}\n"
+        end
+      end
+      lines.join
+    end
+
+    def convert_table(table)
+      body = table.css('tbody > tr').map { |tr| extract_table_row(tr) }
+      head_row = table.css('thead > tr').first
+      head = if head_row.nil?
+               # Make first row in body the table heading
+               body.shift
+             else
+               extract_table_row(head_row)
+             end
+      table = MdnQuery::Table.new(head, *body)
+      table.to_s
+    end
+
+    def extract_table_row(tr)
+      cols = []
+      tr.children.each do |child|
+        next unless child.name == 'th' || child.name == 'td'
+        cols << child.text
+      end
+      cols
+    end
+  end
+end

data/lib/mdn_query/version.rb

@@ -0,0 +1,4 @@
+module MdnQuery
+  # The version of the gem
+  VERSION = '0.1.0'.freeze
+end

data/mdn_query.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mdn_query/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mdn_query'
+  spec.version       = MdnQuery::VERSION
+  spec.authors       = ['Michael Jungo']
+  spec.email         = ['michaeljungo92@gmail.com']
+
+  spec.summary       = 'Query the MDN docs'
+  spec.description   = 'Query the MDN docs'
+  spec.homepage      = 'https://github.com/jungomi/mdn_query'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'launchy', '~> 2.4'
+  spec.add_dependency 'nokogiri', '~> 1.6'
+  spec.add_dependency 'rest-client', '~> 1.8'
+  spec.add_dependency 'slop', '~> 4.4'
+  spec.add_dependency 'tty-pager', '~> 0.4'
+  spec.add_dependency 'tty-prompt', '~> 0.7'
+
+  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 'minitest-reporters', '~> 1.1'
+  spec.add_development_dependency 'rubocop', '~> 0.43'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: mdn_query
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Jungo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: tty-pager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !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: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: Query the MDN docs
+email:
+- michaeljungo92@gmail.com
+executables:
+- mdn-query
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/mdn-query
+- lib/mdn_query.rb
+- lib/mdn_query/document.rb
+- lib/mdn_query/entry.rb
+- lib/mdn_query/errors.rb
+- lib/mdn_query/list.rb
+- lib/mdn_query/search.rb
+- lib/mdn_query/search_result.rb
+- lib/mdn_query/section.rb
+- lib/mdn_query/table.rb
+- lib/mdn_query/traverse_dom.rb
+- lib/mdn_query/version.rb
+- mdn_query.gemspec
+- screenshots/demo.gif
+homepage: https://github.com/jungomi/mdn_query
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Query the MDN docs
+test_files: []