Project

kitkat

0.0
No release in over a year
kitkatmattruggio/kitkatHomepageDocumentationSource CodeBug TrackerWiki
Small library that can populate a SQLite database with the recursive list of all files and their respective metadata.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,169
Stars
0
Forks
0
Watchers
1
 Releases
Current version
1.0.0
Total releases
3
First release
2022-06-10
Latest release
2023-02-12
 Issues
Open Issues
0
Closed Issues
3
Total Issues
3
Issue Closure Rate
100%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
2
Merged Pull Requests
1
Pull Request Acceptance Rate
33%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2022-08-25
Reverse Dependencies
0

 Dependencies

Development

bundler-audit
>= 0
guard-rspec
>= 0
pry
>= 0
rake
>= 0
rspec
>= 0
rubocop
>= 0
rubocop-rake
>= 0
rubocop-rspec
>= 0
simplecov
>= 0
simplecov-console
>= 0

Runtime

sqlite3
>= 0
 Project Readme

Kitkat

File/Metadata Database Populator

Gem Version Ruby Gem CI Maintainability License: MIT

I had a need to recursively enumerate a directory and load the paths, and some metadata about the files, into a SQLite file. Currently, the following metadata is stored in the SQLite file

field description
path path of the file (with the root removed)
mime_type left-side mime type (i.e. image)
mime_subtype right-side mime type (i.e. jpeg)
bytesize size in bytes of the file.
last_modified_at last time the file was reported to be modified by the filesystem.
digest SHA256 hash of the file's contents.
created_at UTC date and time when the record was inserted into the DB.

Installation

To install through Rubygems:

gem install kitkat

You can also add this to your Gemfile using:

bundle add kitkat

Usage

Executable

This library ships with an executable: kitkat. Simply run this from your shell:

bundle exec kitkat <path> <database>

For Example: bundle exec kitkat some_directory some_directory_contents.db. This will recursively scan the relative path at: some_directory and list all its contents in a SQLite database file relatively located at: some_directory_contents.db.

Notes:

  • The database positional argument is optional. If it is not supplied then it will default to: kitkat.db

Ruby API

You can also include this gem and use directly through code:

Kitkat.crawl(db: 'some_directory_contents.db', path: 'some_directory')

The Ruby code above is functionally equivalent to running the executable script above.

Contributing

Development Environment Configuration

Basic steps to take to get this repository compiling:

  1. Install Ruby (check kitkat.gemspec for versions supported)
  2. Install bundler (gem install bundler)
  3. Clone the repository (git clone git@github.com:mattruggio/kitkat.git)
  4. Navigate to the root folder (cd kitkat)
  5. Install dependencies (bundle)

Running Tests

To execute the test suite run:

bin/rspec spec --format documentation

Alternatively, you can have Guard watch for changes:

bin/guard

Also, do not forget to run Rubocop:

bin/rubocop

And auditing the dependencies:

bin/bundler-audit check --update

Publishing

Note: ensure you have proper authorization before trying to publish new versions.

After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:

  1. Merge Pull Request into main
  2. Update version.rb using semantic versioning
  3. Install dependencies: bundle
  4. Update CHANGELOG.md with release notes
  5. Commit & push main to remote and ensure CI builds main successfully
  6. Run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Code of Conduct

Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

License

This project is MIT Licensed.