kitkat 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbdbb6ec1c0293541eed2e6d3227dd23157f6de455499df55d5bc32f6044c025
-  data.tar.gz: 2c02ad2202530ef1d4d2201711bc4dcf18ef1cfeb3543d3b54756b5238cc3be3
+  metadata.gz: 17654438fa4ef7a3ed4c7050ccccfa152d315a233a3776e3ddc64a234f8f0d7b
+  data.tar.gz: 7a9d327cc6cc8cf6dbdaff076f4b1e0d3c6cc39822a8aeeb4d95b2db1f43aa0b
 SHA512:
-  metadata.gz: bc533656a79f62e7f1ab832166035c24ad2d614e090b4fec5a08a5b5c4218c987aab94437141870fb02931330785819b467034aa437b5be55fedae37c2c90c54
-  data.tar.gz: af88084f7c99abcd4c141d419b11628b74178615acf959b667f7d66b1c5881d32e3f64946fb2765c2045094226b28cc8ac0ebb463d2e06744703c05dd3a2429f
+  metadata.gz: fa9081036b32b79d977c32416db7ab733007cd6d55bb0ff2f898852a065a57cf556d579399dc0047083f6c2b29ae4e54ba4a56f6cb397e42b0d9ab9f339585fb
+  data.tar.gz: f9af84a84eebd3b1f7723b7fe3428ebb1eea95bf58cfb6677af8a70d0228ee0b64b93ef677e520ceeeb38e7fcb96168fda691e4fd0d165b706f7615ab7334419

data/.github/workflows/rubygem.yml

@@ -11,15 +11,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['3.2.1']
 
     steps:
     - uses: actions/checkout@v2
+    # https://github.com/ruby/setup-ruby#versioning
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/.rubocop.yml

@@ -1,9 +1,19 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
   Exclude:
     - bin/*
     - vendor/bundle/**/*
 
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
 Metrics/MethodLength:
   Max: 20
+
+RSpec/ExampleLength:
+  Max: 10

data/.tool-versions

@@ -1 +1 @@
-ruby 2.6.6
+ruby 3.2.1

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+#### 1.0.0 - February 12th, 2023
+
+* Update to use Ruby 3.2.1 and later only.
+
+#### 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/exe/kitkat

@@ -7,4 +7,4 @@ require 'kitkat'
 path = ARGV[0].to_s
 db   = ARGV[1].to_s.empty? ? 'kitkat.db' : ARGV[1].to_s
 
-Kitkat.crawl(db: db, path: path)
+Kitkat.crawl(db:, path:)

data/kitkat.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
     'rubygems_mfa_required' => 'true'
   }
 
-  s.required_ruby_version = '>= 2.6'
+  s.required_ruby_version = '>= 3.2.1'
 
   s.add_dependency('sqlite3')
 

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)
+    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)
@@ -13,21 +15,21 @@ module Kitkat
       freeze
     end
 
-    def each(&block)
+    def each(&)
       return enum_for(:each) unless block_given?
 
-      traverse(root, &block)
+      traverse(root, &)
 
       self
     end
 
     private
 
-    def traverse(dir, &block)
+    def traverse(dir, &)
       Dir[File.join(dir, '*')].each do |path|
-        yield FileInfo.new(path, root: root)
+        yield FileInfo.new(path, root:)
 
-        traverse(path, &block) if File.directory?(path)
+        traverse(path, &) if File.directory?(path)
       end
     end
   end

data/lib/kitkat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitkat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-10 00:00:00.000000000 Z
+date: 2023-02-12 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
@@ -216,14 +217,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: 3.2.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: File/Metadata Database Populator