sha256_everything 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 688fe76f244135f722701b6b7e11b0bc9cea9eab7bf64c2be65178437b20f3ae
+  data.tar.gz: cf5b03d7cc0b6963b026217026ac466e87f8e44c81fe393093263d04f112ec0e
+SHA512:
+  metadata.gz: 65fd64a6592fb62d6abecb35770074d1b099d6e02755457d7085fbdcec9b3e5467c45c9e9ca2043c0719d038cc9e5c7917bb98cd309f1a79e10a17cc29e88781
+  data.tar.gz: 8374bb33199253e24d41e2e7d0e322cb73e0af96546d80b9de2bdc44b4a5e5e4ef37a7283c628e96933116cc7b34beab1584815f764ded359a75f77284b90b00

data/README.md

@@ -0,0 +1,77 @@
+# sha256_everything
+
+**sha256_everything** is a Ruby gem that hashes every single file in a specified directory and outputs the result in a neatly formatted TXT file.
+
+## Example Output
+
+```
+File Hierarchy                       SHA256 Hash
+
+├── .gitignore                       1e152031a561398186651a06090f3b08e0c0abb486fd516524e93ec4e57c1cc3
+├── .rspec                           06245e25d7cf46b4fbde27b5faa0df0d4110e11918eeb5848de4ab2aff897b59
+├── CODE_OF_CONDUCT.md               f02b057ee644a4f7e722156b8497d6b8932101ca2083425d829790797d6f538f
+├── Gemfile                          81d62526d923ef3a2b684a4dfa9b3a76eebe03a0fc037268f2763165a52b03a4
+├── lib
+│   ├── sha256_everything
+│   │   ├── application.rb           54b5b8713c27fbc2d61af29a2f7851dc174da80339735013c645a619eb710e5d
+│   │   ├── cli.rb                   d5f9993b29c6adc1569718d17ae10692eb40393019f34673993a3a37b6eaa1d0
+│   │   ├── file_collector.rb        095e96607d636b7392a6201799dc5b54e8bd5a4b0251534091bdb22a16eb0ebd
+│   │   ├── file_hasher.rb           24baecab98a3143a5f292bcd8bb3e85ea29472f0552b65eec08d7581825d1f65
+│   │   ├── output_writer.rb         bb7830388ca1f7ab4faf641508cef101691809b83c3bc0496644c288cac8d3a8
+│   │   ├── tree_generator.rb        448522451bb7a8b52e5bf4f797e3e97a3b443729b660d4b0e1b8e2bf07d0f794
+│   │   └── version.rb               0507bfc041b1fff564afc4fd5e7c293d84b8eb8e53fbd398735c9d6a7625dca3
+│   └── sha256_everything.rb         a458e489aab5eecc4cb328b5ea04e5a2f4cad5872579f62a7faf4ceec10b9011
+
+```
+
+## Features
+
+- **Recursive Processing:** Scans and hashes all files (including hidden ones) while skipping internal directories (like `.git`).
+- **Live Progress:** A dynamic progress bar keeps you informed as each file is hashed.
+- **Formatted Output:** Produces a prettified result showing the file hierarchy and corresponding SHA256 hashes.
+
+## Installation
+
+Install it directly via:
+
+```bash
+gem install sha256_everything
+```
+
+## Usage
+
+After installation, you can run the gem's command from your terminal:
+
+```bash
+sha256_everything
+```
+
+### Options
+
+- `-f [NAME]`, `--filename [NAME]` — Specify the output file name (default: hashes.txt).
+- `-d`, `--display_here` — Display the file hierarchy in the terminal.
+- `-h`, `--help` — Show help and usage instructions.
+
+## Testing
+
+   ```bash
+   bundle install
+   bundle exec rspec
+   ```
+
+## Contributing
+
+Contributions, bug reports, and pull requests are welcome!
+Feel free to check issues or submit your own at [GitHub Issues](https://github.com/jibril-tapiador/sha256_everything/issues).
+
+## License
+
+This gem is available as open source under the terms of the [MIT License](LICENSE).
+
+## Authors
+
+- **Jibril Tapiador** - [tapiador@jib.is](mailto:tapiador@jib.is)
+
+## Acknowledgements
+
+- Thanks to [ruby-progressbar](https://github.com/jfelchner/ruby-progressbar) for the progress bar implementation.

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sha256_everything"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/sha256_everything

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/sha256_everything'
+
+Sha256Everything::CLI.start

data/lib/sha256_everything/application.rb

@@ -0,0 +1,30 @@
+require 'ruby-progressbar'
+
+module Sha256Everything
+  class Application
+    def initialize(options)
+      @directory = options.fetch(:directory, Dir.pwd)
+      file_name = options.fetch(:filename, "hashes.txt")
+      @output_file = file_name.end_with?(".txt") ? file_name : "#{file_name}.txt"
+      @display     = options.fetch(:display_here, false)
+    end
+
+    def run
+      files = FileCollector.new(@directory).files
+      progress = ProgressBar.create(total: files.size, format: '%a %B %p%% %t')
+      results = files.each_with_object({}) do |file, memo|
+        memo[file] = FileHasher.new(file).compute
+        progress.increment
+      end
+
+      # Generate formatted tree (including hash values)
+      tree = TreeGenerator.new(@directory, results).generate
+      OutputWriter.new(@output_file, tree).write
+
+      # Display message after progress bar finishes
+      puts "\n\nHash file saved as #{@output_file}"
+      puts "\n" if @display
+      puts tree if @display
+    end
+  end
+end

data/lib/sha256_everything/cli.rb

@@ -0,0 +1,33 @@
+require 'optparse'
+
+module Sha256Everything
+  class CLI
+    def self.start(args = ARGV)
+      options = parse_options(args)
+      Application.new(options).run
+    end
+
+    def self.parse_options(args)
+      # Set default options
+      options = { filename: 'hashes.txt', display_here: false, directory: Dir.pwd }
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: sha256_everything [options]'
+
+        opts.on('-fNAME', '--filename=NAME', 'Set the output file name') do |name|
+          options[:filename] = name
+        end
+
+        opts.on('-d', '--display_here', 'Display the file hierarchy in the terminal') do
+          options[:display_here] = true
+        end
+
+        opts.on('-h', '--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+      end
+      parser.parse!(args)
+      options
+    end
+  end
+end

data/lib/sha256_everything/file_collector.rb

@@ -0,0 +1,23 @@
+module Sha256Everything
+  class FileCollector
+    IGNORED_DIRECTORIES = ['.git'].freeze
+
+    def initialize(directory)
+      @directory = directory
+    end
+
+    def files
+      pattern = File.join(@directory, '**', '{*,.*}')
+      Dir.glob(pattern, File::FNM_DOTMATCH)
+         .reject { |f| ignore?(f) }
+         .select { |f| File.file?(f) }
+    end
+
+    private
+
+    def ignore?(file)
+      path_components = file.split(File::SEPARATOR)
+      (path_components & IGNORED_DIRECTORIES).any?
+    end
+  end
+end

data/lib/sha256_everything/file_hasher.rb

@@ -0,0 +1,15 @@
+require 'digest'
+
+module Sha256Everything
+  class FileHasher
+    def initialize(file)
+      @file = file
+    end
+
+    def compute
+      Digest::SHA256.file(@file).hexdigest
+    rescue StandardError => e
+      "Error: #{e.message}"
+    end
+  end
+end

data/lib/sha256_everything/output_writer.rb

@@ -0,0 +1,14 @@
+module Sha256Everything
+  class OutputWriter
+    def initialize(filename, tree_str)
+      @filename = filename
+      @tree_str = tree_str
+    end
+
+    def write
+      File.open(@filename, 'w') do |f|
+        f.puts @tree_str
+      end
+    end
+  end
+end

data/lib/sha256_everything/tree_generator.rb

@@ -0,0 +1,49 @@
+module Sha256Everything
+  class TreeGenerator
+    IGNORED_DIRECTORIES = ['.git'].freeze
+
+    def initialize(root, results = {})
+      @root = root
+      @results = results
+    end
+
+    def generate
+      lines = generate_lines(@root)
+      max_length = lines.map { |line| line[:left].length }.max || 0
+      header_left = 'File Hierarchy'
+      header_right = 'SHA256 Hash'
+      header_line = header_left.ljust(max_length + 4) + header_right
+      tree_str = header_line + "\n\n"
+      lines.each do |line|
+        tree_str << line[:left].ljust(max_length + 4) + line[:right] + "\n"
+      end
+      tree_str
+    end
+
+    private
+
+    def generate_lines(base, prefix = '')
+      entries = visible_entries(base)
+      lines = []
+      entries.each_with_index do |entry, index|
+        path = File.join(base, entry)
+        connector = (index == entries.size - 1) ? "└── " : "├── "
+        left_text = "#{prefix}#{connector}#{entry}"
+        if File.file?(path)
+          hash_value = @results[path] || '-'
+          lines << { left: left_text, right: hash_value }
+        else
+          lines << { left: left_text, right: '' }
+          extension = (index == entries.size - 1) ? "    " : "│   "
+          lines.concat(generate_lines(path, prefix + extension))
+        end
+      end
+      lines
+    end
+
+    def visible_entries(base)
+      entries = Dir.entries(base) - %w[. ..]
+      entries.reject { |entry| IGNORED_DIRECTORIES.include?(entry) }.sort
+    end
+  end
+end

data/lib/sha256_everything/version.rb

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

data/lib/sha256_everything.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'sha256_everything/version'
+
+require 'sha256_everything/version'
+require 'sha256_everything/cli'
+require 'sha256_everything/application'
+require 'sha256_everything/file_collector'
+require 'sha256_everything/file_hasher'
+require 'sha256_everything/tree_generator'
+require 'sha256_everything/output_writer'
+
+module Sha256Everything
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sha256_everything.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'lib/sha256_everything/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sha256_everything'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Jibril Tapiador']
+  spec.email         = ['tapiador@jib.is']
+
+  spec.summary       = 'Hashes every file in a directory using SHA256'
+  spec.description   = 'A gem that iterates over each file in a folder, computes its SHA256 hash, and writes a prettified file hierarchy to a text file.'
+  spec.homepage      = 'https://github.com/jibril-tapiador/sha256_everything'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['lib/**/*', 'bin/*', 'README.md', 'LICENSE', '*.gemspec']
+  spec.executables   = ['sha256_everything']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ruby-progressbar', '~> 1.10'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: sha256_everything
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jibril Tapiador
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: A gem that iterates over each file in a folder, computes its SHA256 hash,
+  and writes a prettified file hierarchy to a text file.
+email:
+- tapiador@jib.is
+executables:
+- sha256_everything
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- bin/setup
+- bin/sha256_everything
+- lib/sha256_everything.rb
+- lib/sha256_everything/application.rb
+- lib/sha256_everything/cli.rb
+- lib/sha256_everything/file_collector.rb
+- lib/sha256_everything/file_hasher.rb
+- lib/sha256_everything/output_writer.rb
+- lib/sha256_everything/tree_generator.rb
+- lib/sha256_everything/version.rb
+- sha256_everything.gemspec
+homepage: https://github.com/jibril-tapiador/sha256_everything
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Hashes every file in a directory using SHA256
+test_files: []