browser.rb 0.16.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d021a1b082f2676924ac7934a2c07630e3e1b9acf0fc6cc5199c089fcdf04e8
+  data.tar.gz: de83b9b9a841bcd7b1c8c22184d9b1d2f2e2f8a1c1010c57a15a1122ec8b2984
+SHA512:
+  metadata.gz: 2b57c7138e471c8bff5954f33d6252fe1584fd6514836d03dd412b1b260726003894e3d8455c02e4218e952a8344ba750821724370461a0bcd6e29e576ab1ea4
+  data.tar.gz: c59caa0712477eb8bf6ec7fe5731e41b50bfa8a5b4fa23b5e0e943ce056e70f41a1ed911551a716b391d25f01aa77bb777aacd812a781c0f1eceb77f7a0eadd8

data/CHANGELOG

@@ -0,0 +1,516 @@
+# browser/CHANGELOG
+
+## How this history is kept
+
+The revisions behind 0.0.0 to 0.6.0 are the record and are not rewritten; the entries
+describing them are narration, and may be corrected toward that record at any time.
+Once a version is published that licence ends: what is published is history someone
+else may hold, and stays.
+
+## Capabilities, and when each arrived
+
+| capability | version | date |
+|---|---|---|
+| The six browsers named, with their data locations: Brave, Chrome, Chromium, Firefox, Safari, Tor Browser | 0.0.0 | 2022-06-22 |
+| Bookmarks and history locations as methods on each browser | 0.1.0 | 2022-12-03 |
+| One class per file; top-level names for a program that wants `Chrome` rather than `Browser::Chrome` | 0.3.0 | 2023-01-02 |
+| History read from SQLite, rendered to CSV, written to a dated file | 0.4.0 | 2023-01-02 |
+| A profile name selects the locations | 0.5.0 | 2023-09-23 |
+| The profile name appears in the dumped filename | 0.5.2 | 2023-09-24 |
+| Bookmarks read: JSON for the Chromium family, plist for Safari, SQLite for the Firefox family | 0.6.1 | 2026-08-22 |
+| Four renderers for both bookmarks and history: CSV, JSON, plist, objects; `dump` takes a format | 0.6.1 | 2026-08-22 |
+| Safari's binary plist read natively, via CFPropertyList | 0.6.1 | 2026-08-22 |
+| MIT licence, and a LICENSE file | 0.6.1 | 2026-08-22 |
+| `Browser.new(:name)`, any case, string or symbol; `browser-classes` for the top-level names | 0.7.0 | 2026-08-23 |
+| `dump(format:, filename:, path:)` returns the path written and writes nothing if the render fails | 0.7.0 | 2026-08-23 |
+| `readable?`, and `Browser::Unreadable` for data that is absent or locked by a running browser | 0.8.0 | 2026-08-23 |
+| A CHANGELOG | 0.9.0 | 2026-08-23 |
+| `Browser::Bookmark`, a tree; folders carried; `to_objects` flattens to title, url, folder | 0.10.0 | 2026-08-25 |
+| Installable as a gem, standing alone without a RUBYLIB | 0.10.1 | 2026-09-04 |
+| A README | 0.11.0 | 2026-09-07 |
+| One set of renderers, shared by bookmarks and history | 0.12.0 | 2026-09-09 |
+| The Firefox family's default profile, the one profiles.ini names | 0.13.0 | 2026-09-09 |
+| Firefox and Tor Browser bookmarks with their folders | 0.14.0 | 2026-09-09 |
+
+
+## Capabilities, per browser, and when each arrived
+
+The README's table, with each cell holding the version at which it became true.
+
+| browser | bookmarks | history | folders | profile named | profile default |
+|---|---|---|---|---|---|
+| Brave | 0.6.1 | 0.4.0 | 0.10.0 | 0.5.0 | 0.0.0 |
+| Chrome | 0.6.1 | 0.4.0 | 0.10.0 | 0.5.0 | 0.0.0 |
+| Chromium | 0.6.1 | 0.4.0 | 0.10.0 | 0.5.0 | 0.0.0 |
+| Firefox | 0.7.0 | 0.7.0 | 0.14.0 | 0.5.0 | 0.13.0 |
+| Safari | 0.6.1 | 0.4.0 | 0.10.0 | none | none |
+| Tor Browser | 0.7.0 | 0.7.0 | 0.14.0 | 0.7.0 | 0.13.0 |
+
+## 20260925
+
+0.16.0: ~ Browser::Rendering::CSV: Use CSV from the standard library; ~ Browser::Bookmarks.from_sqlite: Build the Bookmark object directly; ~ ROADMAP.md and TODO tidied.
+
+1. ~ Browser::Rendering::CSV#render: ::CSV.generate, the column names pushed and then each row, in place of joining Array#to_csv_row's.
+2. The escaping is no longer ours to get wrong, and the library quotes the fields which need it rather than all of them, so an ordinary row is now unquoted.
+3. Taken from the side branch at the tag history-formatter-20250923, whose History::Formatter::CSV rendered this way: its four lines, the results pair become records and column names.
+4. + browser.rb.gemspec: csv, which Rendering now requires and which is no default gem from Ruby 3.4.
+5. Found by installing the built gem into an empty GEM_HOME.
+6. - lib/Array/to_csv_row.rb, - lib/String/wrap.rb, which nothing requires now.
+7. With String#ascii_only gone at 0.15.0 the gem ships no monkeypatch at all, and lib/Array and lib/String go with them.
+8. ~ test/Browser/Rendering_test.rb: the renderings expected unquoted where a field needs no quoting.
+9. The three cases 0.15.0 added each still render and read back as they were.
+10. ~ test/loading_test.rb: that the library loads nothing from lib/Array or lib/String, in place of naming a helper which resolves from lib.
+11. ~ test/gemspec_test.rb: csv among the runtime dependencies.
+12. ~ ROADMAP.md: - whether a CSV library should do the escaping, which this answers.
+13. ~ TODO: - the monkeypatches, done; ~ the renderer, to be revisited if a better writer arrives.
+14. ~ CHANGELOG: How this history is kept, cut to the two rules.
+15. ~ the same: the capabilities table, one version and one date a row, the rows which held several split.
+16. ~ the same: - the note on cells later than the entries suggest, which 0.7.0's items already carry.
+17. ~ TODO: + readers for the bookmark tree and the profile directory; a history representation; the bookmark roots, dates, guid and separators; Tor Browser's bundle; a Browser::Error for Unreadable; the orphaned SQLite bookmark.
+18. ~ Browser::Bookmarks.from_sqlite: builds the root itself, as .from_json and .from_plist do; - sqlite_tree, its only caller.
+19. ~ ROADMAP.md: themes of work, in place of open questions.
+20. ~ the same: + cookies, a client for scraping, driving a browser; - Tor Browser's install; tags and the history record folded into the representation.
+21. ~ Browser::VERSION: /0.15.0/0.16.0/
+
+
+0.15.0: ~ Array#to_csv_row: a quote within a field doubled, and nothing stripped.
+
+1. ~ Array#to_csv_row: a quote within a field doubled, as RFC 4180 carries one.
+2. It had wrapped each field in quotes and left a quote inside it alone, so a title holding one rendered a row no reader could parse.
+3. Present since the method arrived at 0.4.0, in History's CSV from then and in Bookmarks' from 0.12.0.
+4. No test had ever rendered a field with a quote in it.
+5. ~ the same: - String#ascii_only, which had stripped every byte outside printable ASCII.
+6. So Café rendered as Caf, and a title in Japanese as an empty field.
+7. Quoting every field is what makes a comma or a newline safe; nothing was gained by dropping the rest.
+8. - lib/String/ascii_only.rb, which nothing requires now, as lib/String/pascalcase.rb went when its last caller did.
+9. It shipped, and monkeypatched String for anyone who loaded the gem.
+10. + test/Browser/Rendering_test.rb: a quote, a comma and a newline within a field, and a title which is not ASCII.
+11. Each rendered and then read back with the stdlib CSV; all three fail against the old method.
+12. ~ test/loading_test.rb: String/wrap in place of String/ascii_only as the helper it checks resolves from lib.
+13. + ROADMAP.md: whether a CSV library should do the escaping.
+14. ~ TODO: ~ the monkeypatches, two now; + ROADMAP.md on the escaping.
+15. ~ Browser::VERSION: /0.14.6/0.15.0/
+
+
+## 20260909
+
+0.14.6: + test/gemspec_test.rb and test/loading_test.rb, the checks a publish wants; the Gemfile stays.
+
+1. + test/gemspec_test.rb: the gemspec valid, pinning no date, and taking its version from Browser::VERSION.
+2. ~ the same: the three runtime and four development dependencies declared, and no file listed which is not there, as impuri, monotonic.rb, bitget.rb and duration.rb have.
+3. ~ test/loading_test.rb: + require 'browser' resolves its helpers from lib, and require 'browser-classes' gives the top-level names.
+4. ~ the same: + both load without warning under -w, beside the Browser::VERSION example 0.14.4 began the file with.
+5. As monotonic.rb and duration.rb have. The ascii_only fault, resolved only from ~/lib/ruby until 0.10.1, would have failed here.
+6. ~ ROADMAP.md: - whether the Gemfile goes. It stays.
+7. Six of seven recent gems carry one reading gemspec, statistics.rb alone does not, and the question had taken the outlier for the rule.
+8. ~ Browser::VERSION: /0.14.5/0.14.6/
+
+
+0.14.5: Ruby 3.2 or later, which is what the dependencies require.
+
+1. ~ browser.rb.gemspec: required_ruby_version, '>= 2.7' --> '>= 3.2'.
+2. CFPropertyList 4.0.0 and sqlite3 2.9.6 each require Ruby 3.2, so on 2.7 the install failed on the dependencies.
+3. Found by installing for Ruby 2.7.8 into an empty GEM_HOME.
+4. Every file's syntax is fine under 2.7; the floor is the dependencies'.
+5. The suite passes under 3.4.1, the nearest Ruby to it here with an interpreter.
+6. ~ Browser::VERSION: /0.14.4/0.14.5/
+
+
+0.14.4: Browser::VERSION defined by requiring the library.
+
+1. ~ lib/browser.rb: + require_relative './Browser/VERSION'.
+2. Only the gemspec had required it, so the installed gem did not know its version: require 'browser', Browser::VERSION raised NameError.
+3. Found by installing the built gem into an empty GEM_HOME, which is the check a publish wants.
+4. + test/loading_test.rb: require 'browser' defines Browser::VERSION, in a process of its own with lib alone on the load path.
+5. Within the suite's own process everything is loaded already, so no test there could have failed.
+6. ~ Browser::VERSION: /0.14.3/0.14.4/
+
+
+0.14.3: The gemspec's summary and description say what the gem does, and the README carries the header's History.
+
+1. ~ browser.rb.gemspec: the summary, which claimed writing where there is none yet, now says reading.
+2. ~ the same: the description, the summary again and RubyGems warning of it, now names the six browsers and the three renderings.
+3. ~ README.md: + History, the paragraph the load file's header had carried since 0.0.0, in its author's words.
+4. ~ lib/browser.rb: - that paragraph from the header, as exitor's went into its README.
+5. ~ TODO: - the two, done.
+6. ~ Browser::VERSION: /0.14.2/0.14.3/
+
+
+0.14.2: Browser::Base#name public, and the TODO brought up to date.
+
+1. ~ Browser::Base#name: public, the renderers and the tests having reached for it with send; it was private for no reason anyone could name.
+2. ~ Browser::Rendering#dump_filename: asks the browser its name, in place of the send.
+3. ~ test/Browser/*_test.rb: #name called, in place of sent.
+4. ~ TODO: - dump_filename's sends, done; ~ the monkeypatches, a better writer taking the three, in place of the stdlib's CSV.
+5. ~ Browser::VERSION: /0.14.1/0.14.2/
+
+
+0.14.1: + ROADMAP.md and TODO, and the capabilities per browser pinned to their versions.
+
+1. ~ CHANGELOG: + How this history is kept, at the head.
+2. ~ the same: + Capabilities, per browser, and when each arrived.
+3. + ROADMAP.md
+4. + TODO
+5. ~ lib/browser.rb: - the header's Todo, its two items now in ROADMAP.md.
+6. ~ Browser::VERSION: /0.14.0/0.14.1/
+
+
+0.14.0: Firefox and Tor Browser bookmarks with their folders.
+
+1. ~ Browser::Bookmarks.from_sqlite: builds the tree, hanging children under parents from the root down, in position order.
+2. moz_bookmarks is one table of folders and bookmarks, each row naming its parent and its position within it.
+3. ~ the same: separators skipped, and the tags root left out, a tag being a folder holding a copy of every bookmark so tagged.
+4. ~ the same: menu, toolbar, unfiled and mobile shown as Bookmarks Menu, Bookmarks Toolbar, Other Bookmarks and Mobile Bookmarks.
+5. Until now the query fetched leaves alone, and every folder came back empty.
+6. ~ Browser::Bookmark: + name, what a browser stores, which is the title but for Firefox's roots.
+7. The title is what it shows, and what a folder path is made of; writing back into a browser would want the name.
+8. ~ Browser::FirefoxBased.bookmarks_sql: every row with its parent, position, type and guid, in place of the leaves ordered by date.
+9. ~ Rakefile, test/fixtures/FirefoxBased_places.sqlite: + a tag folder, a separator, and a toolbar bookmark, pinning the three rules.
+10. ~ test/Browser/Firefox_test.rb, TorBrowser_test.rb: the five bookmarks in tree order with their folders.
+11. ~ README.md: "yes" for Firefox and Tor Browser's folders; - the caveat that they were flat.
+12. ~ Browser::VERSION: /0.13.0/0.14.0/
+
+
+0.13.0: Firefox and Tor Browser's default profile, the one profiles.ini names.
+
+1. + Browser::FirefoxBased.default_profile_name: the profile Firefox itself would open, read from profiles.ini.
+2. The [Install] section's, as Firefox has written since 67; else the [Profile] flagged Default=1; else the only one there.
+3. No profiles.ini, or two installations each naming a default, raises Browser::Unreadable, which asks for profile_name:.
+4. - Browser::FirefoxBased::DEFAULT_PROFILE_NAME, the glob "**", which File.expand_path never expanded.
+5. An unnamed Firefox read a path with ** in it, and dumped to Firefox_**_Bookmarks_<date>.
+6. + Browser::TorBrowser.profiles_ini_path: beside its profiles, where Firefox keeps its own beside Profiles.
+7. + Browser::Base.default_profile_name, DEFAULT_PROFILE_NAME for the browsers whose default is a constant.
+8. ~ Browser::Base#profile_name, #bookmarks_location, #history_location: readers, each derived when first wanted.
+9. So making a browser reads nothing, and where no default can be named readable? answers false rather than construction raising.
+10. - Browser::Base: the attr_accessor, whose writers nothing used.
+11. ~ test/Browser/Firefox_test.rb, TorBrowser_test.rb: .default_profile_name over profiles.ini texts, [Install] winning over the flag.
+12. ~ the same two: the locations for a named profile, in place of the glob.
+13. ~ test/Browser/Brave_test.rb, Chrome_test.rb, Chromium_test.rb: the profile name read rather than assigned.
+14. ~ README.md: "default, or named" for Firefox and Tor Browser, and the usage and caveat to match.
+15. ~ Browser::VERSION: /0.12.0/0.13.0/
+
+
+0.12.0: + Browser::Rendering, the renderers once, shared by Bookmarks and History.
+
+1. + lib/Browser/Rendering.rb: the CSV, JSON and Plist renderers, over records and their column names.
+2. ~ the same: + to_csv, to_json, to_plist, dump and readable?.
+3. Bookmarks and History include it, each supplying results, to_objects and column_names.
+4. - Browser::Bookmarks::CSV, ::JSON, ::Plist; - Browser::History::CSV, ::JSON, ::Plist, ::Objects: the two sets it replaces.
+5. They had drifted: History's unpacked the column names and rows in each renderer and went through Objects for records, and Bookmarks' CSV wrote its three fields unquoted.
+6. ~ Browser::History#to_objects: the records made once, and what the renderers take.
+7. ~ Browser::History#results: memoises the query as it came.
+8. ~ Browser::Bookmarks#to_csv: every field quoted, as History's have been.
+9. The other 21 renderings across the three fixtures are byte for byte what they were.
+10. ~ Browser::Rendering#dump_filename: the parts joined, a nil profile dropping out, in place of two interpolations.
+11. + test/Browser/Rendering_test.rb
+12. ~ Browser::VERSION: /0.11.2/0.12.0/
+
+
+## 20260908
+
+0.11.2: + Capabilities, and when each arrived, at the head of the CHANGELOG.
+
+1. ~ CHANGELOG: + Capabilities, and when each arrived, at the head.
+2. ~ Browser::VERSION: /0.11.1/0.11.2/
+
+0.11.1: ~ browser.rb.gemspec, brought into line with the others.
+
+1. ~ browser.rb.gemspec: + the header line naming the file.
+2. ~ the same: + #dependencies= and #development_dependencies=, the gems as words, in place of an add_dependency line apiece.
+3. ~ the same: require_paths beside required_ruby_version, rather than after the files.
+4. ~ the same: the gemspec first among the files.
+5. ~ Browser::VERSION: /0.11.0/0.11.1/
+
+
+## 20260907
+
+0.11.0: + README.md
+
+1. + README.md
+2. ~ the Tor Browser caveat, corrected before it went in: it had said the library follows the install, where root_path is one fixed path.
+3. It now says where the library looks, and that an install elsewhere wants bookmarks_location: and history_location:.
+4. ~ browser.rb.gemspec: homepage, /browser.rb/browser/ and https, as http.rb's repository is http.
+5. ~ README.md: the fork link, the same.
+6. ~ Browser::VERSION: /0.10.1/0.11.0/
+
+
+## 20260904
+
+0.10.1: Ship String#ascii_only, so the gem loads without a RUBYLIB.
+
+1. + lib/String/ascii_only.rb, required by Array#to_csv_row and resolved until now from ~/lib/ruby alone.
+2. Requiring Browser::History therefore raised LoadError on any machine but the author's.
+3. ~ Browser::VERSION: /0.10.0/0.10.1/
+
+
+## 20260825
+
+0.10.0: + Browser::Bookmark, the internal representation, and a lowercase load file.
+
+1. + lib/Browser/Bookmark.rb: a bookmark which holds bookmarks; a folder has children, a leaf a url.
+2. ~ Browser::Bookmarks.from_json, .from_plist, .from_sqlite: a Browser::Bookmark tree, in place of the raw parse.
+3. ~ the same three: Chromium's and Safari's trees carry their folders.
+4. ~ Browser::Bookmarks.from_plist: the History proxy skipped, and a leaf sitting at the top level taken.
+5. ~ Browser::Bookmarks.from_sqlite: Firefox and Tor Browser flat still, the query fetching leaves alone.
+6. ~ Browser::Bookmarks#to_objects: the tree flattened to title, url and folder, which the three renderers take.
+7. ~ Browser::Bookmarks#to_csv: it had matched symbol keys against a string-keyed hash, so every row was empty commas.
+8. - Browser::Bookmarks::Objects, which the flatten replaced.
+9. - Browser::Bookmarks: require 'Array/to_csv_row', which nothing there used.
+10. /lib/Browser.rb/lib/browser.rb/, /test/Browser_test.rb/test/browser_test.rb/, require 'Browser' --> require 'browser'.
+11. The uppercase name folded together with the browser gem on a case-insensitive filesystem.
+12. ~ lib/browser.rb: - the header's version and Changes block, VERSION.rb and this CHANGELOG being the one of each.
+13. + test/Browser/Bookmark_test.rb
+14. ~ test/Browser/*_test.rb: #bookmarks checked through to_objects, in place of a raw round-trip.
+15. ~ Browser::VERSION: /0.9.0/0.10.0/
+
+
+## 20260823
+
+0.9.0: + CHANGELOG
+
+1. + CHANGELOG, written by changelogger 0.13.0, and into every earlier revision with it.
+2. ~ browser.rb.gemspec: the test glob widened to Dir['test/**/*'], so the fixtures ship.
+3. ~ browser.rb.gemspec: /'CHANGELOG.md'/'CHANGELOG'/, the name the file has.
+4. ~ lib/Browser.rb: /Changes since 0.7/Changes since 0.8/
+
+
+0.8.0: Make reading trustworthy, and say so when it is not.
+
+1. + lib/Browser/Unreadable.rb: Browser::Unreadable
+2. ~ Browser::Bookmarks#results, Browser::History#results: rescue IOError, SystemCallError, SQLite3::Exception into it.
+3. + Browser::Bookmarks#readable?, Browser::History#readable?
+4. + test/fixtures/FirefoxBased_places.sqlite
+5. + Rakefile: a task building it.
+6. ~ test/Browser/Firefox_test.rb, TorBrowser_test.rb
+7. + tests for #readable? and Browser::Unreadable
+8. ~ lib/Browser.rb: /Changes since 0.6/Changes since 0.7/
+
+
+## 20260822
+
+0.7.0: Settle how a browser is named and constructed.
+
+1. - Browser, the delegating class, which called class methods removed in 0.6.
+2. + Browser.new(name): any case, returning an instance of that browser's class.
+3. ~ Browser::Base: < Browser, so that a browser is_a? Browser.
+4. /lib/TopLevelBrowser.rb/lib/browser-classes.rb/
+5. ~ browser-classes.rb: assigns rather than subclasses.
+6. - Browser::*.bookmarks_location, .history_location: the location arguments.
+7. ~ Browser::Base#initialize takes them instead.
+8. ~ Browser::FirefoxBased.bookmarks_sql, .history_sql: + the join to moz_places, which holds the url.
+9. ~ the same two: + a real column to order by.
+10. ~ Browser::TorBrowser.profiles_path: Browser rather than Firefox's Profiles.
+11. ~ Browser::Bookmarks#dump, Browser::History#dump: + filename:, + path:
+12. ~ the same two: return the path written, and write nothing when the render raises.
+13. - Browser::History#dump_filename: String#pascalcase, a no-op for every browser name.
+14. - lib/String/pascalcase.rb, which nothing else required.
+
+
+0.6.1: The 0.6.0 design made to run, and its tests brought up to it.
+
+1. ~ Browser::Bookmarks, Browser::History: the location given was stored and ignored, in five places.
+2. ~ Browser::Bookmarks.from_json, .from_plist: JSON and Plist named the nested renderers.
+3. ~ Browser::Bookmarks.from_sqlite: opened the history database, ran the history query.
+4. ~ Browser::Bookmarks#to_objects: the instance where the class was meant.
+5. ~ browser.rb.gemspec: /plist/CFPropertyList/, plist reading XML alone, Safari writing binary.
+6. + lib/Browser/VERSION.rb, which the gemspec required and which was never there.
+7. + browser.rb.gemspec: sqlite3, required and undeclared, so a consumer met LoadError.
+8. ~ browser.rb.gemspec: /browser/browser.rb/, the shorter name taken.
+9. /browser.gemspec/browser.rb.gemspec/
+10. + Rakefile: the test task, and two building SQLite fixtures.
+11. + test/fixtures/ChromiumBased_history.sqlite, Safari_bookmarks.plist, Safari_history.sqlite
+12. ~ test/Browser/*_test.rb: converted from the pre-rework API.
+13. - Gemfile.lock, three years older than the gemspec, never resolved against it.
+14. - browser.rb.gemspec: spec.date, a release planned for 2025-09-27 which did not happen.
+15. ~ browser.rb.gemspec: /Ruby/MIT/; + LICENSE, in the files.
+16. + .gitignore: !test/fixtures/*.sqlite, data rather than build output.
+
+
+## 20250923
+
+Renderers under Formatter, CSV through the stdlib, and a new dump.
+
+1. + Browser::History::Formatter, wrapping CSV, JSON, Plist and Objects.
+2. ~ Formatter::CSV#render: ::CSV.generate, in place of Array#to_csv_row.
+3. Only the fields which need it quoted, and a quote within one doubled.
+4. ~ Browser::History#dump: + filename:, + path:
+5. ~ the same: returns the path, and rescues Errno::ENOENT.
+6. + require 'csv'; - require 'Array/to_csv_row'
+7. A scratch copy, on 0.6.0's tree, written that evening, and it entered no version as it stands.
+8. JSON, Plist and Objects went into 0.6.0 the next day, byte for byte.
+9. dump into 0.7.0 eleven months later, byte for byte.
+10. The state is at the tag history-formatter-20250923.
+
+
+## 20250925
+
+0.6.0: + Bookmarks
+
+1. + Browser::Bookmarks.from_json, .from_plist, .from_sqlite
+2. + Browser::Bookmarks: CSV, JSON, Plist, Objects, nested
+3. + Browser::Bookmarks#to_csv, #to_json, #to_plist, #to_objects
+4. + Browser::Bookmarks#dump(format), #dump_filename
+5. + Browser::History: the same four renderers, nested
+6. + Browser::History#to_json, #to_plist, #to_objects
+7. + Browser::Base#bookmarks, #history
+8. - Browser::Base.bookmarks, .bookmarks_json, .bookmarks_plist, .bookmarks_sql
+9. - Browser::Base.bookmarks_location, .history_location, .history_sql, .history
+10. - Browser::Base#history_sql
+11. ~ Browser::Base#initialize: + DEFAULT_PROFILE_NAME where none is given
+12. + ChromiumBased, FirefoxBased, Safari: root_path, profiles_path, private
+13. + ChromiumBased, FirefoxBased, Safari: .bookmarks_format, .history_format
+14. + ChromiumBased, FirefoxBased, Safari: DEFAULT_PROFILE_NAME, Default, ** and nil
+15. - ChromiumBased, FirefoxBased, Safari: .bookmarks, .bookmarks_json, .bookmarks_plist
+16. ~ Brave, Chrome, Chromium, Firefox, TorBrowser: root_path, in place of PROFILE_ROOT_PATH
+17. ~ Safari: root_path, in place of BOOKMARKS_LOCATION and HISTORY_LOCATION
+18. private throughout lib: 20 in 12 files, where there had been 2 in 2
+19. + browser.gemspec
+20. ~ Gemfile: gemspec, in place of the three gems listed
+21. ~ test/Browser/Brave_test.rb: converted to the reworked API
+22. ~ the other five tests: .bookmarks_location, .history_location, in place of PROFILE_ROOT_PATH
+23. ~ lib/Browser.rb: /Changes since 0.4/Changes since 0.5/
+24. ~ Browser#history: + a bookmarks location, both words misspelt
+
+
+## 20250922
+
+0.5.3: Remove unnecessary delegate method.
+
+1. - Browser#delegate
+2. ~ Browser#bookmarks: /delegate.class/delegate_class/
+3. ~ Browser#bookmarks_json: /delegate.class/delegate_class/
+4. ~ Browser#bookmarks_plist: /delegate.class/delegate_class/
+5. ~ Browser#bookmarks_sql: /delegate.class/delegate_class/
+6. ~ Browser#history_sql: /delegate.class/delegate_class/
+7. ~ Browser#history: /delegate.class/delegate_class/
+
+
+## 20230924
+
+Locations onto the family classes, neither pair reachable.
+
+1. + Browser::ChromiumBased.bookmarks_location, .history_location, each with binding.pry.
+2. + Browser::FirefoxBased.bookmarks_location, .history_location
+3. Neither pair is reachable, every browser defining its own.
+4. ChromiumBased's name profile_root_path and default_profile_name, which nothing defines.
+5. FirefoxBased's name PROFILE_ROOT_PATH and DEFAULT_PROFILE_NAME, defined in the browsers where a parent cannot see them.
+6. The copy which ran from ~/lib/ruby, on 0.5.2's tree.
+7. Two files of it, written that afternoon, and it entered no version.
+8. The state is at the tag family-locations-20230924.
+
+
+0.5.2: Add the profile_name to the dumped history filename.
+
+1. ~ Browser#history: + profile_name argument
+2. ~ Browser::Base#history: + profile_name argument
+3. ~ Browser::History#csv_filename: + profile_name in the filename
+
+
+0.5.1: Using the DEFAULT_PROFILE_NAME as the default value for the profile_name argument doesn't seem to work, so assigning the default value in a separate line.
+
+1. ~ Browser::Brave#bookmarks_location: /DEFAULT_PROFILE_NAME/nil/
+2. ~ Browser::Brave#history_location: /DEFAULT_PROFILE_NAME/nil/
+3. ~ Browser::Chrome#bookmarks_location: /DEFAULT_PROFILE_NAME/nil/
+4. ~ Browser::Chrome#history_location: /DEFAULT_PROFILE_NAME/nil/
+5. ~ Browser::Chromium#bookmarks_location: /DEFAULT_PROFILE_NAME/nil/
+6. ~ Browser::Chromium#history_location: /DEFAULT_PROFILE_NAME/nil/
+7. ~ Browser::Firefox#bookmarks_location: /DEFAULT_PROFILE_NAME/nil/
+8. ~ Browser::Firefox#history_location: /DEFAULT_PROFILE_NAME/nil/
+9. ~ Browser::Safari#bookmarks_location: /DEFAULT_PROFILE_NAME/nil/
+10. ~ Browser::Safari#history_location: /DEFAULT_PROFILE_NAME/nil/
+11. ~ Browser::TorBrowser#bookmarks_location: /DEFAULT_PROFILE_NAME/nil/
+12. ~ Browser::TorBrowser#history_location: /DEFAULT_PROFILE_NAME/nil/
+
+
+## 20230923
+
+0.5.0: Use a supplied profile name to determine bookmarks and history locations.
+
+1. ~ Browser#initialize: + profile_name
+2. + Browser#bookmarks_location, so that it may be derived from the profile name in the concrete classes.
+3. + Browser#history_location, so that it may be derived from the profile name in the concrete classes.
+4. ~ Browser#delegate: + profile_name
+5. ~ Browser::Base#initialize: + profile_name
+6. ~ Browser::Brave#bookmarks_location: + profile_name
+7. ~ Browser::Brave#history_location: + profile_name
+8. ~ Browser::Chrome#bookmarks_location: + profile_name
+9. ~ Browser::Chrome#history_location: + profile_name
+10. ~ Browser::Chromium#bookmarks_location: + profile_name
+11. ~ Browser::Chromium#history_location: + profile_name
+12. ~ Browser::Firefox#bookmarks_location: + profile_name
+13. ~ Browser::Firefox#history_location: + profile_name
+14. ~ Browser::Safari#bookmarks_location: + profile_name
+15. ~ Browser::Safari#history_location: + profile_name
+16. ~ Browser::TorBrowser#bookmarks_location: + profile_name
+17. ~ Browser::TorBrowser#history_location: + profile_name
+
+
+## 20230921
+
+0.4.1: Mark the location constants as defaults.
+
+1. ~ ChromiumBased subclasses: /BOOKMARKS_LOCATION/DEFAULT_BOOKMARKS_LOCATION/
+2. ~ ChromiumBased subclasses: /HISTORY_LOCATION/DEFAULT_HISTORY_LOCATION/
+
+
+## 20230102
+
+0.4.0: + Browser::History
+
+1. + Browser::History
+
+
+0.3.1: Made the tests uniform.
+
+1. Made the tests uniform.
+
+
+0.3.0: Move each class to its own file.
+
+1. Moved Browser::Base to own file.
+2. Moved Browser::Brave to own file.
+3. Moved Browser::Chrome to own file.
+4. Moved Browser::Chromium to own file.
+5. Moved Browser::ChromiumBased to own file.
+6. Moved Browser::Firefox to own file.
+7. Moved Browser::FirefoxBased to own file.
+8. Moved Browser::Safari to own file.
+9. Moved Browser::TorBrowser to own file.
+10. + TopLevelBrowser.rb.
+11. Moved tests to Browser directory.
+12. + Firefox test.
+13. + Safari test.
+14. + TorBrowser test.
+
+
+## 20221205
+
+0.2.0: Read a bookmarks file, and split the tests per browser.
+
+1. + Browser::Base.bookmarks, .bookmarks_json, .bookmarks_plist, each taking a location.
+2. + Browser::Base.bookmarks_location, .bookmarks_sql, .history_location, .history_sql
+3. - Browser::Base.bookmarks_path, .history_path
+4. ~ every browser: class << self in place of def self.
+5. ~ Brave, Chrome, Chromium: .bookmarks_location, .history_location default to the constants.
+6. + String#camelcase, in Browser.rb
+7. + require 'json', 'Object/to_const', 'shellwords'
+8. + test/Brave_test.rb, Chrome_test.rb, Chromium_test.rb, out of Browser_test.rb
+9. + test/fixtures/Brave_bookmarks.json, Chromium_bookmarks.json
+
+
+## 20221203
+
+0.1.0: Give every browser its own locations.
+
+1. + .bookmarks_location to all classes except Base
+2. + .history_location to call classes except Base
+
+
+## 20220622
+
+0.0.0: Extract Browser from dump_browser_history_to_csv.
+
+1. + Browser class from dump_browser_history_to_csv.
+2. + BOOKMARKS_LOCATION data from Bookmarks.
+3. + Browser::Base
+4. /Browser::AVAILABLE_BROSWERS/Browser::LIST/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-2026 thoran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# browser.rb
+
+## Description
+
+Read the bookmarks and history of the web browsers on a machine — Brave, Chrome,
+Chromium, Firefox, Safari and Tor Browser — and render them to CSV, JSON or a
+property list.  Bookmarks come through as one common representation whatever the
+browser; history as each browser stores it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'browser.rb'
+```
+
+And then execute:
+```shell
+$ bundle
+```
+
+Or install directly:
+```shell
+$ gem install browser.rb
+```
+
+Note the `.rb`. The plain `browser` gem is someone else's — a user-agent parser —
+so this one is `browser.rb`. The require is the plain name, as it is for `http.rb`:
+```ruby
+require 'browser'
+```
+The `gem 'browser.rb'` line is what makes that require load this gem rather than
+the other; the two ship the same file name.
+
+## Usage
+
+```ruby
+require 'browser'
+
+chrome = Browser.new(:chrome)
+chrome.bookmarks.to_objects   # => [{title:, url:, folder:}, ...]
+chrome.bookmarks.to_csv       # title,url,folder rows
+chrome.bookmarks.to_json
+chrome.history.to_objects
+```
+
+Name a browser by string or symbol, in any case:
+```ruby
+Browser.new(:brave)
+Browser.new('TorBrowser')
+Browser.new('tor_browser')
+```
+
+Firefox and Tor Browser open the profile their profiles.ini names as the default, so
+none need be named. To reach another:
+```ruby
+Browser.new(:firefox, profile_name: 'abcd1234.default-release').bookmarks.to_objects
+```
+
+Or opt into top-level names:
+```ruby
+require 'browser-classes'
+Chrome.new.bookmarks
+```
+
+The renderers are `to_objects` (an array of `{title:, url:, folder:}`), `to_csv`,
+`to_json` and `to_plist`. `dump(format:, path:, filename:)` writes one to a file and
+returns the path. `readable?` says whether the data can be read right now.
+
+## Capabilities
+
+| browser | bookmarks read from | history read from | folders | profile |
+|---|---|---|---|---|
+| Brave | JSON | SQLite | yes | default, or named |
+| Chrome | JSON | SQLite | yes | default, or named |
+| Chromium | JSON | SQLite | yes | default, or named |
+| Firefox | SQLite, places.sqlite | SQLite, the same file | yes | default, or named |
+| Safari | binary plist | SQLite | yes | none |
+| Tor Browser | SQLite, places.sqlite | SQLite, the same file | yes | default, or named |
+
+## Caveats
+
+- **macOS only, for now.** Every location is a macOS path; Linux and Windows are on
+  the Todo.
+- **A running browser locks its database.** History, and Firefox's bookmarks, are
+  read from SQLite, which the browser locks while it is open — so reading a browser
+  you are using raises `Browser::Unreadable`. Ask `readable?` first, or quit it.
+- **Which Firefox profile.** Firefox and Tor Browser keep profiles in hashed
+  directories, and the default is the one profiles.ini names, which is the one
+  Firefox itself would open. A directory named plainly `default` is usually a
+  leftover, the live one being `<hash>.default-release`, and the install entry in
+  profiles.ini knows which. Two installations, say release and Nightly, each name a
+  default, and then `profile_name:` is required.
+- **Tor Browser is looked for in `~/Library/Application Support/TorBrowser-Data`.**
+  That is where an install in `/Applications` keeps its data. One installed elsewhere
+  keeps it beside the application, and wants `bookmarks_location:` and
+  `history_location:` passed to the constructor.
+- **Safari's Bookmarks.plist is a mirror.** With iCloud bookmark sync on, a sync
+  agent maintains it and writes it on change, so it can be absent while Safari is
+  working perfectly. It is a binary property list, read here via CFPropertyList.
+
+## History
+
+I realised when wanting to dump all bookmarks from any browsers on one machine for import to another that I'd already written something of the sort for history called dump_browser_history_to_csv and that it would probably be a good idea to combine those efforts into a single browser library to handle both bookmarks and history, as well as any other similar browser data extraction effort.
+
+## Contributing
+
+1. Fork it (https://github.com/thoran/browser/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new pull request
+
+## License
+
+MIT