zillace 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19b7f2fd9f94f910b62184f4bd8bc1c940e887e772b729089c729fa386d5f418
+  data.tar.gz: d2bdb6c7e6c172a7f3fad783268a7dda28845b1dc48899713ac6b7a140f8e635
+SHA512:
+  metadata.gz: 00275e10e87ba43b5c725e722ff7b905e477ca9acefe8494c9e442e720c57673d77415f4dd0772446a07511cb0f42ca8ad92452df2b9e105d1d1a27c0ea93ce4
+  data.tar.gz: 4f2231c47d58d523d001248396a9528c56721b304251f3ab39c7671f085306694c8072ba1da6cb65df12fbf781638c485ba4775774c707b3823b4a57d8bffafe

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  DisabledByDefault: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: never

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2023-12-02
+
+- Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+gem 'rake', '~> 13.0'
+gem 'test-unit', '~> 3.0'
+gem 'rubocop', '~> 1.21'

data/README.md

@@ -0,0 +1,23 @@
+# Zillace
+
+## Installation
+
+Install the gem and add to the application's `Gemfile` by executing: `bundle add zillace`.
+If Bundler is not being used to manage dependencies, install the gem by executing: `gem install zillace`.
+
+## Usage
+
+Please see `script/sample.rb` as a simple example at the moment.
+
+## 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,14 @@
+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/lib/zillace/version.rb

@@ -0,0 +1,3 @@
+module Zillace
+  VERSION = '0.0.1'
+end

data/lib/zillace.rb

@@ -0,0 +1,80 @@
+require_relative 'zillace/version'
+require 'sqlite3'
+require 'forwardable'
+
+module Zillace
+  def self.prtime(micro_seconds)
+    Time.new(Rational(micro_seconds, 1_000_000))
+  end
+
+  class Error < StandardError; end
+
+  class Database
+    def initialize(profile_prefix: File.join(Dir.home, '.var/app/org.mozilla.firefox'))
+      @profile_prefix = profile_prefix
+    end
+
+    def connect
+      pattern = File.join(@profile_prefix, '.mozilla/firefox/*.default-release/places.sqlite')
+      path = Dir[pattern].first
+      @database = SQLite3::Database.new(path)
+      self
+    end
+
+    extend Forwardable
+    def_delegators :@database, :execute
+  end
+
+  class Place
+    attr_reader :url, :title
+
+    def initialize(id:, url:, title:)
+      @id = id
+      @url = url
+      @title = title
+    end
+
+    def self.each(database: Database.new.connect, &block)
+      enumerator = Enumerator.new do |enumerator|
+        database.execute('select id, url, title from moz_places') do |row|
+          id, url, title = row
+          enumerator << new(id:, url:, title:)
+        end
+      end
+
+      block_given? ? enumerator.each(&block) : enumerator
+    end
+
+    def self.find(id, database: Database.new.connect)
+      url, title = database.execute('select url, title from moz_places where id = ?', id).first
+      return new(id:, url:, title:)
+    end
+  end
+
+  class Bookmark
+    attr_reader :title, :date_added, :last_modified
+
+    def initialize(fk:, title:, date_added:, last_modified:, database: Database.new.connect)
+      @fk = fk
+      @title = title
+      @date_added = date_added
+      @last_modified = last_modified
+      @database = database
+    end
+
+    def self.each(database: Database.new.connect, &block)
+      enumerator = Enumerator.new do |enumerator|
+        database.execute('select fk, title, dateAdded, lastModified from moz_bookmarks') do |row|
+          fk, title, date_added, last_modified = row
+          enumerator << new(fk:, title:, date_added: ::Zillace.prtime(date_added), last_modified: ::Zillace.prtime(last_modified), database:)
+        end
+      end
+
+      block_given? ? enumerator.each(&block) : enumerator
+    end
+
+    def url
+      Place.find(@fk, database: @database).url
+    end
+  end
+end

data/manifest.scm

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

data/script/sample.rb

@@ -0,0 +1,13 @@
+# This sample script generates bookmark contents for qutebrowser's quickmarks file content
+#
+# Usage:
+#   ruby script/sample.rb >> ~/.config/qutebrowser/quickmarks
+
+require_relative '../lib/zillace'
+
+Zillace::Bookmark.each do |bookmark|
+  url = bookmark.url or next
+  title = bookmark.title or next
+  title = title.lines.join(' ')
+  puts [title, url].join(' ')
+end

data/sig/zillace.rbs

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: zillace
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- gemmaro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-sqlite3
+  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'
+description: Zillace is a database manipulation library for Mozilla Firefox.  It reads
+  the places.sqlite file under the user's Firefox profile directory.
+email:
+- gemmaro.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/zillace.rb
+- lib/zillace/version.rb
+- manifest.scm
+- script/sample.rb
+- sig/zillace.rbs
+homepage: https://codeberg.org/gemmaro/zillace
+licenses: []
+metadata:
+  homepage_uri: https://codeberg.org/gemmaro/zillace
+  source_code_uri: https://codeberg.org/gemmaro/zillace.git
+  changelog_uri: https://codeberg.org/gemmaro/zillace/src/branch/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+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: Mozilla Firefox places SQLite3 database library
+test_files: []