matheus 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72cfeba7ddd84ef4fd7c7c80144a1a8821eb4c3d03fd33f3d718109b08d39bae
-  data.tar.gz: add8482702c9e6af603e6ea2ba5cb7cefa589c57bf133385f2682db7532b8324
+  metadata.gz: 8f0188994d160b9cfc3ce6ab06610e4f42102ddf828dc01e1c917cdf02ac77c6
+  data.tar.gz: 0cf90a3177f25047f2b15fcf5198eb0de8ea3439116107576b7fdd7daab5bddf
 SHA512:
-  metadata.gz: 222e09a48119ad9aa15daa86b26f8159dd45dc9f7b1a8743e6bc8e1255399562e4a4ed2ee3a8ac2539b61c15d61b5d79532913cd2710b2a9f1657dae82de4a44
-  data.tar.gz: c46798f32fc8a73cd99fb47372bdb61060718e1f0366f5d1623215e397bdb0ae5074666fc145a7957350f80bcdd4eeb459fe47809f4e656fa242423d07e28d9c
+  metadata.gz: 364f6273dfdbc464d491b3ce29d670351c5c4c007524c0aa6ad46e1d44e810bf4e7dfa083821a20ae2f0058d01e45a601f7b68c70b9d42ed156df3e6205af895
+  data.tar.gz: d8c641cbaeca884aff2d5782b0abbe720ddaf08af0057676d85ea9bdb9bb0adff33f81c8b158d8a18ba32879dd2f7e30f667c9e400ca4e9862befcae44409366

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.0
+ruby 3.3.4

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.4.0]
+
+_Released 2024-10-02_
+
+- Save past questions with `q` and retrieve them with the `qs` command.
+- Reuse answers for the same questions.
+
+## [0.3.0]
+
+_Released 2024-08-27_
+
+- Add `alert-me` command.
+
 ## [0.2.0]
 
 _Released 2024-08-26_

data/README.md

@@ -6,6 +6,48 @@ A bunch of CLI tools I made for my own use.
 
     $ gem install matheus
 
+## Usage
+
+### `alert-me`
+
+```sh
+$ alert-me 'sleep 1 && echo "Done!"'
+Done!
+# plays a sound after the command finishes
+```
+
+### `date-of-last`
+
+Prints the date of the last week day.
+
+```sh
+$ date-of-last monday
+2024-02-12
+
+$ date-of-last sun
+2024-02-11
+```
+
+### `q`
+
+It expects a OPENAI_API_KEY environment variable to be set. It will try to load
+it from a `.env` file at `~/.env`.
+
+```sh
+$ q "What is the capital of France?"
+The capital of France is **Paris**
+```
+
+### `puts`
+
+It evaluates the given Ruby code and prints the result. Active Support is
+available.
+
+```sh
+$ puts 10.days.ago
+2024-08-17 15:50:11 -0300
+```
+
 ## Contributing
 
 Probably not accepting contributions at the moment, but feel free to open an issue if you have any ideas or suggestions.

data/Rakefile

@@ -45,3 +45,5 @@ end
 
 # Ensure the generate_executables task runs before the build task
 task build: :generate_executables
+# Ensure tests are run before releasing the gem
+task release: :spec

data/exe/alert-me

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "matheus"
+
+Matheus::AlertMe.call ARGV

data/exe/qs

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "matheus"
+
+Matheus::Qs.call ARGV

data/lib/matheus/alert_me.rb

@@ -0,0 +1,16 @@
+module Matheus
+  class AlertMe < Command
+    # Usage:
+    #    $ alert-me "sleep 1 && echo 'Done!'"
+    #    Runs the command and plays a sound based on its success or failure after it finishes.
+    def call(*args)
+      if system(args.join(" "))
+        system("afplay /System/Library/Sounds/Glass.aiff")
+      else
+        system("afplay /System/Library/Sounds/Sosumi.aiff")
+      end
+    rescue => e
+      Failure(e.message)
+    end
+  end
+end

data/lib/matheus/q.rb

@@ -1,5 +1,7 @@
 require "openai"
 require "tty-markdown"
+require "tty-prompt"
+require "json"
 
 module Matheus
   # Usage:
@@ -9,7 +11,17 @@ module Matheus
     BASE_PROMPT = "Answer this question in a short and concise way. You can use markdown in the response: "
 
     def call(question)
-      ask_llm(question).then { print_markdown _1 }
+      question = question.join(" ")
+      existing_entry = search_question_in_history(question)
+
+      if existing_entry && use_existing_answer?
+        answer = existing_entry['answer']
+      else
+        answer = ask_llm(question)
+        save_qa(question, answer)
+      end
+
+      print_markdown(answer)
     rescue => e
       Failure(e.message)
     end
@@ -21,7 +33,7 @@ module Matheus
 
       response = client.chat(
         parameters: {
-          model: "gpt-4o-mini", # using gpt-4o model
+          model: "gpt-4o-mini",
           messages: [{role: "user", content: "#{BASE_PROMPT}#{question}"}]
         }
       )
@@ -29,6 +41,8 @@ module Matheus
       raise response["error"]["message"] if response.has_key?("error")
 
       response.dig("choices", 0, "message", "content")
+    rescue Faraday::ClientError => error
+      raise error.response_body.dig("error", "message") || error
     end
 
     def print_markdown(text)
@@ -38,5 +52,26 @@ module Matheus
     def client
       OpenAI::Client.new(access_token: ENV.fetch("OPENAI_API_KEY"))
     end
+
+    def save_qa(question, answer)
+      history = load_history
+      history << { question:, answer:, timestamp: Time.now.to_s }
+      File.write(QUESTION_HISTORY_FILE, JSON.pretty_generate(history))
+    end
+
+    def load_history
+      File.exist?(QUESTION_HISTORY_FILE) ? JSON.parse(File.read(QUESTION_HISTORY_FILE)) : []
+    end
+
+    def search_question_in_history(question)
+      load_history.reverse.find { |entry| entry['question'].downcase.strip == question.downcase.strip }
+    end
+
+    def use_existing_answer?
+      prompt = TTY::Prompt.new
+      prompt.yes?("An existing answer was found. Do you want to use it?") do |q|
+        q.default true
+      end
+    end
   end
 end

data/lib/matheus/qs.rb

@@ -0,0 +1,40 @@
+require "json"
+require "tty-prompt"
+require "tty-markdown"
+
+module Matheus
+  # Usage:
+  #    $ qs
+  #    Lists the questions asked and their answers.
+  class Qs < Command
+    def call(_)
+      return puts "No questions found in history." if history.empty?
+
+      answer = prompt.select("Question:", choices, per_page: 10)
+      print_markdown(answer)
+    rescue => e
+      Failure(e.message)
+    end
+
+    private
+    def choices
+      history.map do |entry|
+        {entry['question'] => entry['answer'] }
+      end
+    end
+
+
+    def history
+      @history ||= File.exist?(QUESTION_HISTORY_FILE) ? JSON.parse(File.read(QUESTION_HISTORY_FILE)) : []
+    end
+
+    def prompt
+      @prompt ||= TTY::Prompt.new(interrupt: :exit)
+    end
+
+    def print_markdown(answer)
+      puts
+      puts TTY::Markdown.parse(answer)
+    end
+  end
+end

data/lib/matheus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Matheus
-  VERSION = "0.2.1"
+  VERSION = "0.4.0"
 end

data/lib/matheus.rb

@@ -9,4 +9,5 @@ Dotenv.load("~/.env")
 Zeitwerk::Loader.for_gem.setup
 
 module Matheus
+  QUESTION_HISTORY_FILE = File.expand_path("~/.qa_history.json")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matheus
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Matheus Richard
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-26 00:00:00.000000000 Z
+date: 2024-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -84,9 +112,11 @@ description: A bunch of CLI tools I made for my own use.
 email:
 - matheusrichardt@gmail.com
 executables:
+- alert-me
 - date-of-last
 - puts
 - q
+- qs
 extensions: []
 extra_rdoc_files: []
 files:
@@ -96,14 +126,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/alert-me
 - exe/date-of-last
 - exe/puts
 - exe/q
+- exe/qs
 - lib/matheus.rb
+- lib/matheus/alert_me.rb
 - lib/matheus/command.rb
 - lib/matheus/date_of_last.rb
 - lib/matheus/puts.rb
 - lib/matheus/q.rb
+- lib/matheus/qs.rb
 - lib/matheus/result.rb
 - lib/matheus/string_format.rb
 - lib/matheus/version.rb
@@ -129,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A bunch of CLI tools I made for my own use.