kitkat 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbdbb6ec1c0293541eed2e6d3227dd23157f6de455499df55d5bc32f6044c025
-  data.tar.gz: 2c02ad2202530ef1d4d2201711bc4dcf18ef1cfeb3543d3b54756b5238cc3be3
+  metadata.gz: 4d628ae53c4814952a15decd1ad945e63582df6a0021b50a642e21aeae3ddfd2
+  data.tar.gz: 67d0781bb56c93cc7c1d3476a0d19dabb2df09140c831ae30b83b7f99af970c6
 SHA512:
-  metadata.gz: bc533656a79f62e7f1ab832166035c24ad2d614e090b4fec5a08a5b5c4218c987aab94437141870fb02931330785819b467034aa437b5be55fedae37c2c90c54
-  data.tar.gz: af88084f7c99abcd4c141d419b11628b74178615acf959b667f7d66b1c5881d32e3f64946fb2765c2045094226b28cc8ac0ebb463d2e06744703c05dd3a2429f
+  metadata.gz: e13624e8469b16e2286be815c37340b5402d0697023831f56f32256c66aae9480b5b0a920df1298016eb72f3065ba1f13b1984c3b05402f078bf54736b0eb59d
+  data.tar.gz: cc72cb9c18db99192df99f5572d5c229c1c6eaf50372b88cf80421d12bf9e032449799d4aa299810f4070b8144a9e50a54e594af073d42c165e18abe0b022d25

data/.rubocop.yml

@@ -1,3 +1,7 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   NewCops: enable
   TargetRubyVersion: 2.6
@@ -7,3 +11,6 @@ AllCops:
 
 Metrics/MethodLength:
   Max: 20
+
+RSpec/ExampleLength:
+  Max: 10

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+#### 0.0.2 - June 11th, 2022
+
+* Internal API Change: Kitkat::Reader is now Enumerable.
+
+#### 0.0.1 - June 10th, 2022
+
+* Initial version.

data/README.md

@@ -2,9 +2,19 @@
 
 #### File/Metadata Database Populator
 
-[![Gem Version](https://badge.fury.io/rb/kitkat.svg)](https://badge.fury.io/rb/kitkat) [![Ruby Gem CI](https://github.com/mattruggio/kitkat/actions/workflows/rubygem.yml/badge.svg)](https://github.com/mattruggio/kitkat/actions/workflows/rubygem.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/kitkat.svg)](https://badge.fury.io/rb/kitkat) [![Ruby Gem CI](https://github.com/mattruggio/kitkat/actions/workflows/rubygem.yml/badge.svg)](https://github.com/mattruggio/kitkat/actions/workflows/rubygem.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/7d9a8642cf5bd88a550d/maintainability)](https://codeclimate.com/github/mattruggio/kitkat/maintainability) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-I had a need to recursively enumerate a directory and load the paths, and some metadata about the files, into a SQLite file.
+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
 
@@ -24,15 +34,17 @@ bundle add kitkat
 
 ### Executable
 
-This library ships with an executable: `exe/kitkat`.  Simply run this from your shell:
+This library ships with an executable: `kitkat`.  Simply run this from your shell:
 
 ````zsh
-exe/kitkat <path> <database>
+bundle exec kitkat <path> <database>
 ````
 
-For Example: `bin/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`.
+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:
 
-Note: database positional argument is optional.  If it is not supplied then it will default to: `kitkat.db`
+* The database positional argument is optional.  If it is not supplied then it will default to: `kitkat.db`
 
 ### Ruby API
 

data/lib/kitkat/database.rb

@@ -4,6 +4,8 @@ module Kitkat
   # Database-level operations.
   class Database
     def initialize(path)
+      ensure_dir_exists(path)
+
       @connection = SQLite3::Database.new(path)
 
       load_schema
@@ -30,6 +32,12 @@ module Kitkat
 
     attr_reader :connection
 
+    def ensure_dir_exists(path)
+      dir = File.dirname(path)
+
+      FileUtils.mkdir_p(dir) unless File.exist?(dir)
+    end
+
     def sql_statement
       'INSERT OR IGNORE INTO files VALUES (?, ?, ?, ?, ?, ?, ?)'
     end

data/lib/kitkat/file_info.rb

@@ -32,6 +32,7 @@ module Kitkat
       full_mime_type.split(MIME_TYPE_SEPARATOR).last
     end
 
+    # Important note: Calling this on a directory will result in a blank string.
     def digest
       File.directory?(path) ? BLANK : Digest::SHA256.file(path).hexdigest
     end

data/lib/kitkat/reader.rb

@@ -5,6 +5,8 @@ require_relative 'file_info'
 module Kitkat
   # Directory operations.
   class Reader
+    include Enumerable
+
     attr_reader :root
 
     def initialize(root)

data/lib/kitkat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kitkat
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitkat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-10 00:00:00.000000000 Z
+date: 2022-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -178,6 +178,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".tool-versions"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile