nbf_tools 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 023b1e16f83687108652237e0e32b8a7e1ad942c4d0fbedf06f9a3845353d809
+  data.tar.gz: 9c35361b95ea7e3e6857cac1fdd6288abb3579e4e1bb98f1f8eff84447735228
+SHA512:
+  metadata.gz: 0f8bbe44b621662f646b2ec9befb410ec0b4e9f3e2826295688929ba80734ab11ec965c9566752ffdee4e75bd67472c7e7276d72c6a842f53eba19f8885e9eb3
+  data.tar.gz: ed8924a1e235f9ea288bf31b2f5def66637f4f603b1533e9f89dd31946bec52a649ce3efd34f25bd10e975a0cf9e1e0292a8f3038e83eb9e006b3b5f25204491

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-17
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nbf_tools.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    nbf_tools (0.1.1)
+      nokogiri (~> 1.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    minitest (5.20.0)
+    nokogiri (1.15.4-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rubocop (1.56.2)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.19.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.31.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.56.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  nbf_tools!
+  rake (~> 13.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.10

data/README.md

@@ -0,0 +1,44 @@
+# NbfTools
+
+NETSCAPE Bookmark file tools.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add nbf_tools
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install nbf_tools
+
+## Usage
+
+Parse NETSCAPE Bookmark file.
+
+```ruby
+NbfTools.parse bookmark_file_path
+```
+
+Merge and parse NETSCAPE Bookmark files.
+
+```ruby
+NbfTools.parse_files_in_one bookmark_file_path1, bookmark_file_path2
+```
+
+Export merge NETSCAPE Bookmark files to one html string.
+
+```ruby
+NbfTools.parse_files_in_one_html bookmark_file_path1, bookmark_file_path2
+```
+
+
+## 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 on GitHub at https://github.com/Sapeu/nbf_tools.

data/Rakefile

@@ -0,0 +1,14 @@
+# 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 "standard/rake"
+
+task default: %i[test standard]

data/lib/nbf_tools/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module NbfTools
+  class Configuration
+    # personal toolbar folder text, default: ''
+    attr_accessor :personal_toolbar_folder_text
+    # link type text, default: 'link'
+    attr_accessor :link_type_text
+    # folder type text, default: 'folder'
+    attr_accessor :folder_type_text
+  end
+end

data/lib/nbf_tools/html.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module NbfTools
+  class HTML
+    CONTENT_FORMAT = "<!DOCTYPE NETSCAPE-Bookmark-file-1>\n<!-- This is an automatically generated file.\n     It will be read and overwritten.\n     DO NOT EDIT! -->\n<META HTTP-EQUIV=\"Content-Type\" CONTENT=\"text/html; charset=UTF-8\">\n<TITLE>Bookmarks</TITLE>\n<H1>Bookmarks</H1>\n<DL><p>\n%{content}\n</DL><p>"
+    LINK_FORMAT = "%{indent}<DT><A %{attributes}>%{text}</A>"
+    FOLDER_FORMAT = "%{indent}<DT><H3 %{attributes}>%{text}</H3>\n%{indent}<DL><p>\n%{items}\n%{indent}</DL><p>"
+
+    def initialize(data)
+      @data = data
+    end
+
+    def to_s
+      sprintf(CONTENT_FORMAT, content: data_html)
+    end
+
+    def generate_attributes(element, *except_keys)
+      element.except(*except_keys).transform_keys(&:upcase).map { |k, v| "#{k}=\"#{v}\"" }.join(" ")
+    end
+
+    def data_html(data = @data)
+      return if data.nil?
+      data.map do |e|
+        case e["type"]
+        when NbfTools.config.link_type_text
+          link_html(e)
+        when NbfTools.config.folder_type_text
+          folder_html(e)
+        end
+      end.join("\n")
+    end
+
+    def link_html(item)
+      indent = "\t" * (item["path"].count("/") + 1)
+      attributes = generate_attributes(item, "path", "text", "type")
+      text = item["text"]
+      sprintf(LINK_FORMAT, indent: indent, attributes: attributes, text: text)
+    end
+
+    def folder_html(folder)
+      indent = "\t" * folder["path"].count("/")
+      attributes = generate_attributes(folder, "path", "text", "type", "items")
+      text = folder["text"]
+      items = data_html(folder["items"])
+      sprintf(FOLDER_FORMAT, indent: indent, attributes: attributes, text: text, items: items)
+    end
+  end
+end

data/lib/nbf_tools/merge.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module NbfTools
+  class Merge
+    def initialize(data)
+      @data = data
+      @link_map = {}
+      @folder_map = {}
+    end
+
+    def to_a
+      @data.each do |file_data|
+        flat_folder_and_link_map(file_data, @link_map, @folder_map)
+      end
+
+      @link_map.values.each do |e|
+        folder = @folder_map[e["path"]]
+        next if folder.nil?
+        folder["items"] ||= []
+        folder["items"] << e
+        @folder_map[e["path"]] = folder
+      end
+
+      @folder_map.values.each do |e|
+        parent_path = e["path"].split("/")[0..-2].join("/")
+        folder = @folder_map[parent_path]
+        next if folder.nil?
+        folder["items"] ||= []
+        folder["items"] << e
+        @folder_map[parent_path] = folder
+      end
+      @folder_map.values.select { |e| e["path"].count("/") < 2 } + @link_map.values.select { |e| e["path"] == "/" }
+    end
+
+    def flat_folder_and_link_map(data, link_map, folder_map)
+      data.map do |e|
+        case e["type"]
+        when NbfTools.config.link_type_text
+          choose_latest_element(link_map, "href", e)
+        when NbfTools.config.folder_type_text
+          choose_latest_element(folder_map, "path", e)
+          flat_folder_and_link_map(e["items"], link_map, folder_map)
+        end
+      end
+    end
+
+    def choose_latest_element(data_map, key, new_element)
+      if data_map.key?(new_element[key])
+        old_e = data_map[new_element[key]]
+        if [new_element["add_date"].to_i, new_element["last_modified"].to_i].max > [old_e["add_date"].to_i, old_e["last_modified"].to_i].max
+          data_map[new_element[key]] = new_element.except("items")
+        end
+      else
+        data_map[new_element[key]] = new_element.except("items")
+      end
+    end
+  end
+end

data/lib/nbf_tools/parse.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+module NbfTools
+  class Parse
+    def initialize file
+      @document = Nokogiri::HTML(File.open(file))
+    end
+
+    def parse
+      parse_node_children(@document.xpath("/html/body/dl").first, Pathname.new("/"))
+    end
+
+    def parse_node_children(node, path)
+      node.children.each_with_object([]) do |c, items|
+        case c.node_name
+        when "dt"
+          items.push(*parse_node_children(c, path))
+        when "a"
+          bookmark = c.to_h.merge("text" => c.text, "type" => NbfTools.config.link_type_text, "path" => path.to_s)
+          items.push bookmark
+        when "h3"
+          folder_name = c.text
+          folder_name = NbfTools.config.personal_toolbar_folder_text if c["personal_toolbar_folder"] == "true"
+          folder = c.to_h.merge("text" => folder_name, "type" => NbfTools.config.folder_type_text, "path" => (path + folder_name).to_s, "items" => [])
+          items.push folder
+        when "dl"
+          folder = items.select { |e| e["type"] == "folder" }.last
+          folder.nil? ? items.push(*parse_node_children(c), path) : folder["items"] = parse_node_children(c, path + folder["text"])
+        end
+      end
+    end
+  end
+end

data/lib/nbf_tools/version.rb

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

data/lib/nbf_tools.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "nbf_tools/configuration"
+require_relative "nbf_tools/html"
+require_relative "nbf_tools/merge"
+require_relative "nbf_tools/parse"
+require_relative "nbf_tools/version"
+
+module NbfTools
+  class Error < StandardError; end
+  # Your code goes here...
+
+  class << self
+    def config
+      return @config if defined?(@config)
+
+      @config = Configuration.new
+      @config.personal_toolbar_folder_text = "personal toolbar"
+      @config.link_type_text = "link"
+      @config.folder_type_text = "folder"
+
+      @config
+    end
+
+    def configure(&block)
+      config.instance_exec(&block)
+    end
+
+    def parse(file)
+      Parse.new(file).parse
+    end
+
+    def parse_files_in_one(*files)
+      data = files.map { |file| parse(file) }
+      return data[0] if files.size < 2
+      Merge.new(data).to_a
+    end
+
+    def parse_files_in_one_html(*files)
+      return File.read(files[0]) if files.size < 2
+      data = parse_files_in_one(*files)
+      HTML.new(data).to_s
+    end
+  end
+end

data/nbf_tools.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/nbf_tools/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "nbf_tools"
+  spec.version = NbfTools::VERSION
+  spec.authors = ["Sapeu"]
+  spec.email = ["sapeu.lee@foxmail.com"]
+
+  spec.summary = "NETSCAPE Bookmark file tools."
+  spec.description = "NETSCAPE Bookmark file tools."
+  spec.homepage = "https://github.com/sapeu/nbf_tools"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sapeu/nbf_tools"
+  spec.metadata["changelog_uri"] = "https://github.com/sapeu/nbf_tools/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "nokogiri", "~> 1.15"
+  spec.add_development_dependency "standard", "~> 1.31"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/nbf_tools.rbs

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

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: nbf_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sapeu
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+description: NETSCAPE Bookmark file tools.
+email:
+- sapeu.lee@foxmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/nbf_tools.rb
+- lib/nbf_tools/configuration.rb
+- lib/nbf_tools/html.rb
+- lib/nbf_tools/merge.rb
+- lib/nbf_tools/parse.rb
+- lib/nbf_tools/version.rb
+- nbf_tools.gemspec
+- sig/nbf_tools.rbs
+homepage: https://github.com/sapeu/nbf_tools
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sapeu/nbf_tools
+  source_code_uri: https://github.com/sapeu/nbf_tools
+  changelog_uri: https://github.com/sapeu/nbf_tools/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: NETSCAPE Bookmark file tools.
+test_files: []