opml2html 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86f8b4072a12bf95e2bc5432d08f89810703425938d2ad537a3e0460eb34972a
+  data.tar.gz: cd58c06735451231cd56708c0cc144e27737573b24d363d57ec45f10fdfec8e5
+SHA512:
+  metadata.gz: 50da65a32f37b59868dec3c76514a5e826c2533045fd4b1cfd8c517bc33ec17046160339296dca5e55cd20af7ec3756f89f43bb5b121196cdb0999138578e182
+  data.tar.gz: 6008a560211d1253f7c34947cba17658b44561fe98cacd7b5f404f0791d818d12c2d0b30469f58b7af7f95c127524f38f0af4b1bdacc112aed6b17b715ab81f4

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable

data/.rubocop_todo.yml

@@ -0,0 +1,85 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-01-05 06:02:27 UTC using RuboCop version 1.48.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'opml2html.gemspec'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceInsideStringInterpolation:
+  Exclude:
+    - 'lib/opml2html/renderer.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 6
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 22
+
+# Offense count: 8
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'exe/opml2html~'
+    - 'lib/opml2html/dumper.rb'
+    - 'lib/opml2html/html_document.rb'
+    - 'lib/opml2html/renderer.rb'
+    - 'lib/opml2html/traverser.rb'
+
+# Offense count: 6
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'exe/opml2html'
+    - 'exe/opml2html~'
+    - 'lib/opml2html/dumper.rb'
+    - 'lib/opml2html/html_document.rb'
+    - 'lib/opml2html/renderer.rb'
+    - 'lib/opml2html/traverser.rb'
+
+# Offense count: 118
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/console'
+    - 'exe/opml2html'
+    - 'exe/opml2html~'
+    - 'lib/opml2html.rb'
+    - 'lib/opml2html/html_document.rb'
+    - 'lib/opml2html/renderer.rb'
+    - 'lib/opml2html/traverser.rb'
+    - 'lib/opml2html/version.rb'
+    - 'opml2html.gemspec'
+    - 'test/opml2html_test.rb'
+    - 'test/test_helper.rb'
+
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 259

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# OPML2HTML change log
+
+## Unreleased
+
+## 0.0.1 - 2025-01-05
+
+* Initial release

data/README.md

@@ -0,0 +1,38 @@
+# OPML2HTML
+
+OPML to HTML renderer (converter) command line tool.
+
+Currently only the [OPML 2.0](http://opml.org/spec2.opml) is supported, and
+there are a lot of limitations on outline structures.
+
+## Installation
+
+Install the gem by executing:
+
+``` shell
+gem install opml2html
+```
+
+## Usage
+
+```shell
+opml2html < /path/to/some.opml > /path/to/output.html
+```
+
+See also the help message by `opml2html --help`.
+
+## 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 the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/opml2html

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require_relative "../lib/opml2html"
+
+css = "main.css"
+parser = OptionParser.new
+parser.on("--css=PATH") { |path| css = path }
+parser.parse!
+
+doc = OPML2HTML::HTMLDocument.new
+hook = OPML2HTML::Renderer.new(doc, css:)
+trav = OPML2HTML::Traverser.start($stdin, hook:)
+trav.write_html_to($stdout, encoding: Encoding::UTF_8)

data/lib/opml2html/dumper.rb

@@ -0,0 +1,35 @@
+module OPML2HTML
+  class Dumper
+    def head_title(content)
+      warn "head / title: #{content}"
+    end
+
+    def head_date_created(time)
+      warn "head / date created: #{time}"
+    end
+
+    def head_owner_twitter_screen_name(content)
+      warn "head / owner Twitter screen name: #{content}"
+    end
+
+    def head_owner_name(content)
+      warn "head / owner name: #{content}"
+    end
+
+    def head_date_modified(time)
+      warn "head / date modified: #{time}"
+    end
+
+    def head_end; end
+
+    def body_outline_heading(*); end
+
+    def body_outline_text(value)
+      warn "body / outline / text: #{value}"
+    end
+
+    def body_outline_created(time)
+      warn "body / outline / created: #{time}"
+    end
+  end
+end

data/lib/opml2html/html_document.rb

@@ -0,0 +1,51 @@
+require "nokogiri"
+
+module OPML2HTML
+  class HTMLDocument
+    def initialize
+      @document = Nokogiri::HTML::Document.new
+    end
+
+    def head
+      @head and return @head
+      @head = create_element("head")
+      root.add_child(@head)
+      @head
+    end
+
+    def body
+      @body and return @body
+      @body = create_element("body")
+      root.add_child(@body)
+      @body
+    end
+
+    def main
+      @main and return @main
+      @main = create_element("main")
+      body.add_child(@main)
+      @main
+    end
+
+    def metadata
+      @metadata and return @metadata
+      @metadata = create_element("p")
+      @metadata["style"] = "text-align: right"
+      main.add_child(@metadata)
+      @metadata
+    end
+
+    def create_element(name)
+      Element.new(name, @document)
+    end
+
+    private
+
+    def root
+      @root and return @root
+      @root = create_element("html")
+      @document.add_child(@root)
+      @root
+    end
+  end
+end

data/lib/opml2html/renderer.rb

@@ -0,0 +1,55 @@
+module OPML2HTML
+  class Renderer
+    def initialize(document, css:)
+      @document = document
+      @css = css
+    end
+
+    def head_title(content)
+      title = @document.create_element("title")
+      title.content = content
+      @document.head.add_child(title)
+
+      heading = @document.create_element("h1")
+      heading.content = content
+      @document.main.add_child(heading)
+    end
+
+    def head_date_created(time)
+      @document.metadata.add_child("created: #{time}<br/>")
+    end
+
+    def head_owner_twitter_screen_name(content)
+      @document.metadata.add_child("Twitter: #{content}<br/>")
+    end
+
+    def head_owner_name(content)
+      @document.metadata.add_child("owner: #{content}<br/>")
+    end
+
+    def head_date_modified(time)
+      @document.metadata.add_child("modified: #{time}<br/>")
+    end
+
+    def head_end
+      @document.head.add_child("<link rel=\"stylesheet\" href=\"#{ @css }\"/>")
+      @document.main.add_child(@document.metadata)
+    end
+
+    def body_outline_heading(value)
+      heading = @document.create_element("h2")
+      heading.add_child(value)
+      @document.main.add_child(heading)
+    end
+
+    def body_outline_text(value)
+      par = @document.create_element("p")
+      par.add_child(value)
+      @document.main.add_child(par)
+    end
+
+    def body_outline_created(time)
+      # @document.body.add_child("<p style='text-align: right'><small>#{time}</small></p>")
+    end
+  end
+end

data/lib/opml2html/traverser.rb

@@ -0,0 +1,98 @@
+require "nokogiri"
+require "time"
+
+module OPML2HTML
+  class Traverser
+    def self.start(input, hook:)
+      doc = Nokogiri::XML(input)
+      new(hook:).start(doc)
+    end
+
+    def initialize(hook:) # :nodoc:
+      @hook = hook
+    end
+
+    def start(document)
+      parse_document(document)
+      @hook.instance_variable_get(:@document).instance_variable_get(:@document)
+    end
+
+    private
+
+    def parse_document(node)
+      node => Nokogiri::XML::Document[root: Element[name: "opml",
+                                            attributes: [Attr[name: "version",
+                                                         value: "2.0"]],
+                                            children:]]
+      children.each { |child| parse_under_document(child) }
+    end
+
+    def parse_under_document(node)
+      case node
+      in Text # nop
+      in Element[name: "head", children:]
+        children.each { |child| parse_under_head(child) }
+        @hook.head_end
+      in Element[name: "body", children:]
+        children.each { |child| parse_outline(child, level: 1) }
+      else
+        raise Error, node.inspect
+      end
+    end
+
+    def parse_under_head(node)
+      case node
+      in Element[name: "title", children: [Text[content:]]]
+        @hook.head_title(content)
+      in Element[name: "dateCreated", children: [Text[content:]]]
+        time = Time.parse(content)
+        @hook.head_date_created(time)
+      in Element[name: "ownerTwitterScreenName",
+         children: [Text[content:]]]
+        @hook.head_owner_twitter_screen_name(content)
+      in Element[name: "ownerName", children: [Text[content:]]]
+        @hook.head_owner_name(content)
+      in Element[name: "dateModified", children: [Text[content:]]]
+        time = Time.parse(content)
+        @hook.head_date_modified(time)
+      in Text |
+        Element[name: "ownerId" |
+          "urlUpdateSocket" |
+          "expansionState" |
+          "lastCursor"] # nop
+      else
+        raise Error, node.inspect
+      end
+    end
+
+    def parse_body_outline_attribute(node)
+      case node
+      in Attr[name: "text", value:]
+        value = DocumentFragment.parse(value)
+        @hook.body_outline_text(value)
+      in Attr[name: "created", value:]
+        time = Time.parse(value)
+        @hook.body_outline_created(time)
+      in Attr[name: "flNumberedSubs"] # nop
+      else
+        raise Error, node.inspect
+      end
+    end
+
+    def parse_outline(node, level:)
+      case [node, level]
+      in [Text, _] # nop
+      in [Element[name: "outline", attributes: [Attr[name: "text", value:], Attr[name: "created", value: _]], children: []], _]
+        value = DocumentFragment.parse(value)
+        @hook.body_outline_text(value)
+      in [Element[name: "outline", attributes: [Attr[name: "text", value:], Attr[name: "created", value: _]], children:], 1]
+        value = DocumentFragment.parse(value)
+        @hook.body_outline_heading(value)
+        children.each { |child| parse_outline(child, level: level + 1) }
+      in [Element[name: "outline", attributes:, children:], _]
+        attributes.each { |attribute| parse_body_outline_attribute(attribute) }
+        children.each { |child| parse_outline(child, level: level + 1) }
+      end
+    end
+  end
+end

data/lib/opml2html/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OPML2HTML
+  VERSION = "0.0.1"
+end

data/lib/opml2html.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+require_relative "opml2html/version"
+require_relative "opml2html/traverser"
+require_relative "opml2html/renderer"
+require_relative "opml2html/html_document"
+
+module OPML2HTML
+  Error = Class.new(StandardError)
+  Element = Nokogiri::XML::Element
+  Attr = Nokogiri::XML::Attr
+  Text = Nokogiri::XML::Text
+  DocumentFragment = Nokogiri::XML::DocumentFragment
+end

data/manifest.scm

@@ -0,0 +1 @@
+(specifications->manifest (list "ruby@3.1" "ruby-nokogiri" "ruby-rubocop"))

data/sig/opml2html.rbs

@@ -0,0 +1,4 @@
+module OPML2HTML
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: opml2html
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- gemmaro
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-05 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: OPML2HTML is a OPML to HTML renderer (converter) it currently supports
+  only OPML 2.0 Spec and limited outline structure.  This gem provides executable
+  `opml2html`, which takes standard input as input and emits output to standard output.
+email:
+- gemmaro.dev@gmail.com
+executables:
+- opml2html
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- exe/opml2html
+- lib/opml2html.rb
+- lib/opml2html/dumper.rb
+- lib/opml2html/html_document.rb
+- lib/opml2html/renderer.rb
+- lib/opml2html/traverser.rb
+- lib/opml2html/version.rb
+- manifest.scm
+- sig/opml2html.rbs
+homepage: https://git.disroot.org/gemmaro/opml2html
+licenses: []
+metadata:
+  rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://git.disroot.org/gemmaro/opml2html/issues
+  changelog_uri: https://git.disroot.org/gemmaro/opml2html/src/branch/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/opml2html
+  homepage_uri: https://git.disroot.org/gemmaro/opml2html
+  source_code_uri: https://git.disroot.org/gemmaro/opml2html
+  wiki_uri: https://git.disroot.org/gemmaro/opml2html/wiki
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: OPML to HTML renderer
+test_files: []