tfhelps 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 910d2743b566fb4c2c6447b5b800c55b3a712c017e732bd6a04aa85f0e6a2cb8
+  data.tar.gz: bd18cb72f2b982aea907e039d6ceeaafe2e34fbb0d5192908fac39c0828bf823
+SHA512:
+  metadata.gz: bd49e5b75f382456cf74ef7e1b519f14e25507f4d0a2ac381ecc509d34077207f4a190066da5190c835895dc8965d7d68905b9022e5ddbf4b32417ce5478d8e0
+  data.tar.gz: bab9d2c19af95b095cc520e9017b0463a01e6559e7a746f568b59c9cf041b01222f92daedf4cadee415a46f832b8f5289cddfb1c7fa7ae76e4caccbff3edc2ee

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.3.4'
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run the default task
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Wuletaw Wonte
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# TFHelps
+
+> TFHelps is a command-line tool designed to format text files professionally and efficiently. Built primarily for **Helps Ministries**, it uses the Gemini API to clean up and structure text based on predefined formatting guidelines. This tool is ideal for anyone looking to automate the process of making text more readable and polished.
+
+## Installation
+
+Run this command to install the gem:
+
+```bash
+gem install tfhelps
+```
+
+## Usage
+
+### Prerequisites
+
+Before using TFHelps, you need to obtain an API key from Google's AI Studio. Follow these steps:
+
+1. Visit Google AI Studio and sign in with your Google account.
+2. Generate an API key (free or paid, depending on your usage needs).
+3. Store the API key in your environment variables with the key GEMINI_API_KEY.
+   Add the following line to your .bashrc, .zshrc, or equivalent shell configuration file:
+
+```bash
+export GEMINI_API_KEY="your_api_key_here"
+```
+
+4. Restart your terminal or run `source ~/.bashrc` (or equivalent) to apply the changes.
+
+### Running the Tool
+
+To format a text file, use the following command:
+
+```bash
+tfhelps path/to/your/textfile.txt
+```
+
+The tool will process the file and output the formatted text to a new text file in the current directory.
+
+### Formatting Guidelines
+
+TFHelps follows these rules to format your text:
+
+1. Combine sentences into a single paragraph if they are separated by a single empty line.
+2. Create a new paragraph whenever there are two or more empty lines separating the text.
+3. Ensure proper spacing, punctuation, and capitalization throughout the text.
+4. Maintain a clean and polished format suitable for professional use.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/wuletawwonte/tfhelps>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/wuletawwonte/tfhelps/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tfhelps project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wuletawwonte/tfhelps/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/tfhelps

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "tfhelps"
+
+if ARGV.empty?
+  puts "Usage: tfhelps <input-file.txt> [options]"
+  exit 1
+end
+
+input_file = ARGV.shift
+api_key = ENV["GEMINI_API_KEY"]
+
+if api_key.nil?
+  puts "Please set the GEMINI_API_KEY environment variable"
+  exit 1
+end
+
+output_file = "formatted_#{File.basename(input_file)}"
+
+input_text = File.read(input_file)
+
+formatted_text = Tfhelps.format(input_text, api_key)
+
+if formatted_text
+  File.write(output_file, formatted_text)
+  puts "Formatted text written to #{output_file}"
+else
+  puts "Failed to format text"
+end

data/lib/tfhelps/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Tfhelps
+  VERSION = "0.1.0"
+end

data/lib/tfhelps.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "tfhelps/version"
+require "net/http"
+require "uri"
+require "json"
+
+module Tfhelps
+  class Error < StandardError; end
+
+  class GeminiClient
+    def initialize(api_key)
+      @url = URI.parse("https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=#{api_key}")
+    end
+
+    def format_text(text)
+      prompt = <<~PRO
+        Format the following text into a professional and readable structure.
+          Follow these guidelines:
+          1. Combine sentences into a single paragraph if they are separated by a single empty line.
+          2. Create a new paragraph whenever there are two or more empty lines separating the text.
+          3. Ensure proper spacing, punctuation, and capitalization throughout the text.
+          4. Maintain a clean and polished format suitable for professional use.
+          5. Do not add a title or any additional text content that is not present in the original text.
+
+          Text to format:
+          #{text}
+      PRO
+
+      http = Net::HTTP.new(@url.host, @url.port)
+      http.use_ssl = true
+      request = Net::HTTP::Post.new(@url.request_uri)
+      request.content_type = "application/json"
+
+      payload = {
+        contents: [{
+          parts: [{
+            text: prompt
+          }]
+        }]
+      }.to_json
+
+      request.body = payload
+
+      response = http.request(request)
+
+      return JSON.parse(response.body)["candidates"][0]["content"]["parts"][0]["text"] if response.is_a?(Net::HTTPOK)
+
+      raise Error, "Failed to format text: #{response.code} - #{response.body}"
+    end
+  end
+
+  def self.format(text, api_key)
+    client = GeminiClient.new(api_key)
+    client.format_text(text)
+  end
+end

data/sig/tfhelps.rbs

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

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: tfhelps
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wuletaw Wonte
+bindir: bin
+cert_chain: []
+date: 2025-03-22 00:00:00.000000000 Z
+dependencies: []
+description: |
+  The Helps Text Formatter gem is a command-line tool designed for Helps Ministries to clean up and format text files using the power of Google's Gemini API.
+  It takes a .txt file as input, sends the content to the Gemini API for intelligent formatting, and saves the professionally formatted text to a new file.
+email:
+- wuletawwonte@gmail.com
+executables:
+- tfhelps
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/tfhelps
+- lib/tfhelps.rb
+- lib/tfhelps/version.rb
+- sig/tfhelps.rbs
+homepage: https://github.com/wuletawwonte/tfhelps.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wuletawwonte/tfhelps.git
+  source_code_uri: https://github.com/wuletawwonte/tfhelps.git
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: 'Helps Text Formatter: AI-powered text formatting for Helps Ministries.'
+test_files: []