nbf_tools 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 023b1e16f83687108652237e0e32b8a7e1ad942c4d0fbedf06f9a3845353d809
-  data.tar.gz: 9c35361b95ea7e3e6857cac1fdd6288abb3579e4e1bb98f1f8eff84447735228
+  metadata.gz: de5e17d1820e018c6dc5e9af02592540a633f591d394f379e3728c1a8895195d
+  data.tar.gz: 0f41f05769c1e740f56e44ca316604b8aaf485852659c9b661cbb8f86013ee6a
 SHA512:
-  metadata.gz: 0f8bbe44b621662f646b2ec9befb410ec0b4e9f3e2826295688929ba80734ab11ec965c9566752ffdee4e75bd67472c7e7276d72c6a842f53eba19f8885e9eb3
-  data.tar.gz: ed8924a1e235f9ea288bf31b2f5def66637f4f603b1533e9f89dd31946bec52a649ce3efd34f25bd10e975a0cf9e1e0292a8f3038e83eb9e006b3b5f25204491
+  metadata.gz: 84ff37f2ae40c766b750c0e731bc29f03beb714ba761d0149d379ff2bd1d0798637a8f5888853ef32a5264ada0e83e1d8e329bce48f1fd9c23f6ce94c8127c62
+  data.tar.gz: 04b1eda848f324e4e138ef40d8eccd4f60f1556f122b573801a47ce6a2d19d302baa0407bca79b08d24e776748e34225bf88b87ec5089c0940f8342fafc1f0ad

data/CHANGELOG.md

@@ -1,5 +1,22 @@
-## [Unreleased]
+# [Changelog]
+
+## [0.3.0] - 2023-10-21
+
+- feat: implement command line tools haha `nbf_tools`
+
+## [0.2.1] - 2023-10-11
+
+- doc: quote CHANGELOG.md method name
+
+## [0.2.0] - 2023-10-11
+
+- feat: Reomve configuration, add parse options
+- feat: change method name, `merge_files_to_one_html` -> `merge_files_to_one_html`, `parse_files_to_one` -> `parse_files_to_one`
+
+## [0.1.1] - 2023-10-06
+
+- fix: CONTENT_FORMAT `s` char
 
 ## [0.1.0] - 2022-12-17
 
-- Initial release
+- Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nbf_tools (0.1.1)
+    nbf_tools (0.3.0)
       nokogiri (~> 1.15)
 
 GEM

data/README.md

@@ -1,6 +1,8 @@
 # NbfTools
 
-NETSCAPE Bookmark file tools.
+NETSCAPE Bookmark file tools, parse and merge multiple files.
+
+The file was exported from Chrome, Edge, Firefox or Safari browser.
 
 ## Installation
 
@@ -14,28 +16,63 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-Parse NETSCAPE Bookmark file.
+### Command
 
-```ruby
-NbfTools.parse bookmark_file_path
+Help.
+
+```sh
+usage: nbf_tools [options]
+          -f, --files                         NETSCAPE Bookmark files, delimit by space
+          -o, --out-format                    output parse result format (default: html), options: json, html
+          -t, --personal-toolbar-folder-text  custom personal toolbar folder text
+
+      other options:
+          -h, --help                      print help
+          -v, --version                   print version
 ```
 
-Merge and parse NETSCAPE Bookmark files.
+Example.
 
-```ruby
-NbfTools.parse_files_in_one bookmark_file_path1, bookmark_file_path2
+```sh
+# print merged json
+nbf_tools -f bk2.html bk1.html -o json
+
+# save merged new html file
+nbf_tools -f bk2.html bk1.html -o json > bk.html
 ```
 
-Export merge NETSCAPE Bookmark files to one html string.
+### Code
+
+Example.
 
 ```ruby
-NbfTools.parse_files_in_one_html bookmark_file_path1, bookmark_file_path2
+require "nbf_tools"
+
+# parse file
+# options: `{personal_toolbar_folder_text: "some string"}`, is optional
+NbfTools.parse "bk2.html"
+
+# merge and parse multiple files
+# options: `{personal_toolbar_folder_text: "some string"}`, is optional
+NbfTools.parse_files_to_one "bk1.html", "bk2.html", personal_toolbar_folder_text: "bk"
+
+# merge multiple files into one html string
+# options: `{personal_toolbar_folder_text: "some string"}`, is optional
+NbfTools.merge_files_to_one_html "bk1.html", "bk2.html"
+
+# parse and merge operate with options
+# options: `{files: [], personal_toolbar_folder_text: [], out_format: []}`
+# `:files` must present
+# `:personal_toolbar_folder_text` is optional
+# if `:out_format` is `"json"` return json format else retrun return html format
+NbfTools.merge_files_to_one_html(files: %w[bk1.html bk2.html], personal_toolbar_folder_text: [], out_format: %w[json])
 ```
 
-
 ## 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.
+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).
 

data/exe/nbf_tools

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$stdout.sync = true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "nbf_tools"
+
+puts NbfTools.operate_with_options(NbfTools::Options.new(ARGV).parse)

data/lib/nbf_tools/html.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "type"
+
 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>"
@@ -22,9 +24,9 @@ module NbfTools
       return if data.nil?
       data.map do |e|
         case e["type"]
-        when NbfTools.config.link_type_text
+        when NbfTools::Type::LINK
           link_html(e)
-        when NbfTools.config.folder_type_text
+        when NbfTools::Type::FOLDER
           folder_html(e)
         end
       end.join("\n")

data/lib/nbf_tools/merge.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "type"
+
 module NbfTools
   class Merge
     def initialize(data)
@@ -35,9 +37,9 @@ module NbfTools
     def flat_folder_and_link_map(data, link_map, folder_map)
       data.map do |e|
         case e["type"]
-        when NbfTools.config.link_type_text
+        when NbfTools::Type::LINK
           choose_latest_element(link_map, "href", e)
-        when NbfTools.config.folder_type_text
+        when NbfTools::Type::FOLDER
           choose_latest_element(folder_map, "path", e)
           flat_folder_and_link_map(e["items"], link_map, folder_map)
         end

data/lib/nbf_tools/options.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module NbfTools
+  class Options
+    COMMAND_HELP_TEXT = <<~TEXT.chomp
+      usage: nbf_tools [options]
+          -f, --files                         NETSCAPE Bookmark files, delimit by space
+          -o, --out-format                    output parse result format (default: html), options: json, html
+          -t, --personal-toolbar-folder-text  custom personal toolbar folder text
+
+      other options:
+          -h, --help                      print help
+          -v, --version                   print version
+    TEXT
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def parse
+      opts = {unknown_option: [], files: [], personal_toolbar_folder_text: [], out_format: []}
+      option_key = :unknown_option
+
+      @argv.each do |e|
+        case e
+        when "-h", "--help"
+          puts COMMAND_HELP_TEXT
+          exit
+        when "-v", "--version"
+          puts NbfTools::VERSION
+          exit
+        when "-f", "--files"
+          option_key = :files
+        when "-o", "--out_format"
+          option_key = :out_format
+        when "-t", "--personal_toolbar_folder_text"
+          option_key = :personal_toolbar_folder_text
+        when /\A-.+\z/
+          option_key = :unknown_option
+          warn "unknown option #{e}"
+        else
+          opts[option_key] << e
+        end
+      end
+
+      opts
+    end
+  end
+end

data/lib/nbf_tools/parse.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
 require "nokogiri"
+require_relative "type"
+
 module NbfTools
   class Parse
-    def initialize file
-      @document = Nokogiri::HTML(File.open(file))
+    def initialize options = {}
+      @options = options
     end
 
-    def parse
+    def parse file
+      @document = Nokogiri::HTML(File.open(file))
       parse_node_children(@document.xpath("/html/body/dl").first, Pathname.new("/"))
     end
 
@@ -17,18 +20,26 @@ module NbfTools
         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)
+          bookmark = c.to_h.merge("text" => c.text, "type" => NbfTools::Type::LINK, "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" => [])
+          text = folder_text(c)
+          folder = c.to_h.merge("text" => text, "type" => NbfTools::Type::FOLDER, "path" => (path + text).to_s, "items" => [])
           items.push folder
         when "dl"
-          folder = items.select { |e| e["type"] == "folder" }.last
+          folder = items.reverse.find { |e| e["type"] == "folder" }
           folder.nil? ? items.push(*parse_node_children(c), path) : folder["items"] = parse_node_children(c, path + folder["text"])
         end
       end
     end
+
+    def folder_text item
+      return item.text unless item["personal_toolbar_folder"] == "true"
+      if @options[:personal_toolbar_folder_text].to_s.empty?
+        @options[:personal_toolbar_folder_text] = item.text
+      else
+        @options[:personal_toolbar_folder_text]
+      end
+    end
   end
 end

data/lib/nbf_tools/type.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module NbfTools
+  module Type
+    LINK = "link"
+    FOLDER = "folder"
+  end
+end

data/lib/nbf_tools/version.rb

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

data/lib/nbf_tools.rb

@@ -1,45 +1,54 @@
 # 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/options"
 require_relative "nbf_tools/version"
 
+require "json"
+
 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)
+    # parse file
+    # options: `{personal_toolbar_folder_text: "some string"}`, is optional
+    def parse(file, **options)
+      Parse.new(**options).parse(file)
     end
 
-    def parse(file)
-      Parse.new(file).parse
-    end
-
-    def parse_files_in_one(*files)
-      data = files.map { |file| parse(file) }
+    # merge and parse multiple files
+    # options: `{personal_toolbar_folder_text: "some string"}`, is optional
+    def parse_files_to_one(*files, **options)
+      parse_tool = Parse.new(**options)
+      data = files.map { |file| parse_tool.parse(file) }
       return data[0] if files.size < 2
       Merge.new(data).to_a
     end
 
-    def parse_files_in_one_html(*files)
+    # merge multiple files into one html string
+    # options: `{personal_toolbar_folder_text: "some string"}`, is optional
+    def merge_files_to_one_html(*files, **options)
       return File.read(files[0]) if files.size < 2
-      data = parse_files_in_one(*files)
+      data = parse_files_to_one(*files, **options)
       HTML.new(data).to_s
     end
+
+    # parse and merge operate with options
+    # options: `{files: [], personal_toolbar_folder_text: [], out_format: []}`
+    # `:files` must present
+    # `:personal_toolbar_folder_text` is optional
+    # if `:out_format` is `"json"` return json format else retrun return html format
+    def operate_with_options(opts)
+      opts[:out_format] ||= []
+      opts[:personal_toolbar_folder_text] = [opts[:personal_toolbar_folder_text]] if opts[:personal_toolbar_folder_text].is_a?(Array)
+      if opts[:out_format].join(" ") == "json"
+        parse_files_to_one(*opts[:files], personal_toolbar_folder_text: opts[:personal_toolbar_folder_text].join(" ")).to_json
+      else
+        merge_files_to_one_html(*opts[:files], personal_toolbar_folder_text: opts[:personal_toolbar_folder_text].join(" "))
+      end
+    end
   end
 end

data/nbf_tools.gemspec

@@ -8,10 +8,11 @@ Gem::Specification.new do |spec|
   spec.authors = ["Sapeu"]
   spec.email = ["sapeu.lee@foxmail.com"]
 
-  spec.summary = "NETSCAPE Bookmark file tools."
-  spec.description = "NETSCAPE Bookmark file tools."
+  spec.summary = "NETSCAPE Bookmark file tools, parse and merge multiple files."
+  spec.description = "NETSCAPE Bookmark file tools, parse file and merge multiple files.\nThe file was exported from Chrome, Edge, Firefox or Safari browser."
   spec.homepage = "https://github.com/sapeu/nbf_tools"
   spec.required_ruby_version = ">= 2.7.0"
+  spec.license = "MIT"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nbf_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Sapeu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-06 00:00:00.000000000 Z
+date: 2023-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -38,10 +38,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.31'
-description: NETSCAPE Bookmark file tools.
+description: |-
+  NETSCAPE Bookmark file tools, parse file and merge multiple files.
+  The file was exported from Chrome, Edge, Firefox or Safari browser.
 email:
 - sapeu.lee@foxmail.com
-executables: []
+executables:
+- nbf_tools
 extensions: []
 extra_rdoc_files: []
 files:
@@ -51,16 +54,19 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- exe/nbf_tools
 - lib/nbf_tools.rb
-- lib/nbf_tools/configuration.rb
 - lib/nbf_tools/html.rb
 - lib/nbf_tools/merge.rb
+- lib/nbf_tools/options.rb
 - lib/nbf_tools/parse.rb
+- lib/nbf_tools/type.rb
 - lib/nbf_tools/version.rb
 - nbf_tools.gemspec
 - sig/nbf_tools.rbs
 homepage: https://github.com/sapeu/nbf_tools
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/sapeu/nbf_tools
   source_code_uri: https://github.com/sapeu/nbf_tools
@@ -83,5 +89,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: NETSCAPE Bookmark file tools.
+summary: NETSCAPE Bookmark file tools, parse and merge multiple files.
 test_files: []

data/lib/nbf_tools/configuration.rb

@@ -1,12 +0,0 @@
-# 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