nbf_tools 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 885abc5c5af24a8ee6d9d08d83ca302291b14e868684742404f10116c2983b19
-  data.tar.gz: 4806b463cccf40009c29c9ff3d8508a0920dd5a1f91a2f30ab430713f345f4cf
+  metadata.gz: de5e17d1820e018c6dc5e9af02592540a633f591d394f379e3728c1a8895195d
+  data.tar.gz: 0f41f05769c1e740f56e44ca316604b8aaf485852659c9b661cbb8f86013ee6a
 SHA512:
-  metadata.gz: 4c5d27b869913b81e7766544bb033fbf1b5290ff655855e29e608644e27231cf4817b628c80f747afb9bc15bcfde2d14ad1e55b36ab82a4ac7f21fc460379830
-  data.tar.gz: 9765ee19f410e561f083cf754bace377a99f63ad2c30deb072c6caafab40beac993f8f2258352d17f9fdb05f241975751ea1ec4fa99220495f5df8f6b798ed66
+  metadata.gz: 84ff37f2ae40c766b750c0e731bc29f03beb714ba761d0149d379ff2bd1d0798637a8f5888853ef32a5264ada0e83e1d8e329bce48f1fd9c23f6ce94c8127c62
+  data.tar.gz: 04b1eda848f324e4e138ef40d8eccd4f60f1556f122b573801a47ce6a2d19d302baa0407bca79b08d24e776748e34225bf88b87ec5089c0940f8342fafc1f0ad

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # [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

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,8 @@
 # NbfTools
 
-NETSCAPE Bookmark file tools，file from chrome edge firefox safari browser
+NETSCAPE Bookmark file tools, parse and merge multiple files.
+
+The file was exported from Chrome, Edge, Firefox or Safari browser.
 
 ## Installation
 
@@ -14,27 +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 multiple NETSCAPE Bookmark files.
+Example.
 
-```ruby
-NbfTools.parse_files_to_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
 ```
 
-Merge multiple NETSCAPE Bookmark files into one html string.
+### Code
+
+Example.
 
 ```ruby
-NbfTools.merge_files_to_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/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/type.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-module NbfTools::Type
-  LINK = "link"
-  FOLDER = "folder"
+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.2.1"
+  VERSION = "0.3.0"
 end

data/lib/nbf_tools.rb

@@ -3,16 +3,24 @@
 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
 
   class << self
+
+    # parse file
+    # options: `{personal_toolbar_folder_text: "some string"}`, is optional
     def parse(file, **options)
       Parse.new(**options).parse(file)
     end
 
+    # 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) }
@@ -20,10 +28,27 @@ module NbfTools
       Merge.new(data).to_a
     end
 
-    def merge_files_to_one_html(*files, **custom_options)
+    # 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_to_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,8 +8,8 @@ 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nbf_tools
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Sapeu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-11 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,9 +54,11 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- exe/nbf_tools
 - lib/nbf_tools.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
@@ -84,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: []