monty-ai 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c79ee491ca508b5a3621e95c0b614897e8fe767f8aa7b76dc9c34aaae69e211a
+  data.tar.gz: 97eaea0303880d411107e523e480436f77712b50bd519af2abc467f8760c04e7
+SHA512:
+  metadata.gz: 27bce8ac44a05a65acd721c24f1e46a7532e8e29b06548baab5f3ee1fe51d4fc574c2060bfe1dd1cf7ab95a05a46d26086e53dd53b0e6ce201f83ed2193e1c52
+  data.tar.gz: 60a63e462b64313c418c538100a0c734c199c1905d6f7777c0f73df21c35caa7b22d2c0662bc3f03513c44a70d08aecb6eacd4cc348333c7ae756dbd6dd9727b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Steve Cook
+
+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,143 @@
+<div align="center">
+  <img src="montyai-logo.svg" alt="MitchAI" width="500">
+</div>
+
+# MontyAI
+
+## 🚀 Overview
+
+MontyAI is an intelligent code explanation tool that uses AI to help you
+understand code faster. Simply point MontyAI at a code file, and it will provide
+a clear, concise explanation of what the code does.
+
+## 🛠️ Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'monty-ai'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install monty-ai
+```
+
+## 💡 Usage
+
+### Basic Usage
+
+Explain a file:
+
+```bash
+monty-ai explain path/to/file.rb
+```
+
+Pipe code to MontyAI:
+
+```bash
+cat path/to/file.rb | monty-ai explain
+```
+
+### Example
+
+```bash
+monty-ai explain lib/my_app/parser.rb
+```
+
+Output:
+
+```
+Explanation for lib/my_app/parser.rb:
+
+This code defines a Parser class that processes text files into structured data.
+
+The Parser class has three main methods:
+- parse: Takes a file path, reads the content, and converts it to a structured format.
+- process_line: Handles individual lines from the file, applying regex patterns.
+- extract_data: Pulls out specific information based on the content type.
+
+The code implements the Strategy pattern by dynamically selecting different
+processing methods based on the file's content type.
+```
+
+### Check Version
+
+```bash
+monty-ai version
+```
+
+## ⚙️ Configuration
+
+MontyAI uses OpenAI or Anthropic APIs for code explanation. Set your API key in
+an environment variable:
+
+```bash
+# For OpenAI (default)
+export OPENAI_API_KEY=your_api_key_here
+
+# For Anthropic
+export ANTHROPIC_API_KEY=your_api_key_here
+```
+
+## 📋 Requirements
+
+- Ruby 3.0+
+- OpenAI API Key
+
+## 🧪 Development
+
+```bash
+# Clone the repository
+git clone https://github.com/scookdev/mitch_ai.git
+
+# Install dependencies
+bundle install
+
+# Run tests
+bundle exec rspec
+
+# Run linter
+bundle exec rubocop
+```
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## 🗺️ Roadmap
+
+Future versions will include:
+
+- Syntax highlighting
+- Multiple explanation formats (line-by-line, summary, concept)
+- Interactive TTY interface
+- Keyboard navigation
+
+## 🤝 Contributing
+
+Contributions are welcome! Please check out our [Contributing Guidelines](CONTRIBUTING.md).
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📄 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 🙌 Acknowledgments
+
+- Powered by OpenAI
+- Inspired by the need for intelligent code reviews
+
+## 💬 Support
+
+If you encounter any problems or have suggestions, please [open an issue](https://github.com/scookdev/monty_ai/issues).

data/exe/monty-ai

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "monty_ai"
+
+MontyAI::CLI.start(ARGV)

data/lib/monty_ai/ai_client.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+
+module MontyAI
+  class AIClient
+    def initialize(api_key: nil)
+      @api_key = api_key || MontyAI.configuration.api_key
+      @endpoint = MontyAI.configuration.api_endpoint
+
+      return unless @api_key.nil? || @api_key.empty?
+
+      raise Error, "API key is required. Set OPENAI_API_KEY or ANTHROPIC_API_KEY environment variable."
+    end
+
+    def explain_code(code)
+      prompt = build_prompt(code)
+      response = send_request(prompt)
+      parse_response(response)
+    end
+
+    private
+
+    def build_prompt(code)
+      "Please explain the following code clearly and concisely:\n\n#{code}\n\n" \
+      "Provide a general overview of what it does followed by explanations of important parts. " \
+      "Include details about any non-obvious logic, design patterns, or potential issues."
+    end
+
+    def send_request(prompt)
+      uri = URI.parse(@endpoint)
+      request = Net::HTTP::Post.new(uri)
+      request["Content-Type"] = "application/json"
+      request["Authorization"] = "Bearer #{@api_key}"
+
+      # Adjust parameters based on API being used
+      if @endpoint.include?("openai")
+        body = {
+          model: "gpt-4",
+          messages: [
+            { role: "system",
+              content: "You are a helpful code explanation assistant that explains code clearly and concisely." },
+            { role: "user", content: prompt }
+          ],
+          temperature: 0.3
+        }
+      elsif @endpoint.include?("anthropic")
+        # Update endpoint if using Anthropic
+        @endpoint = "https://api.anthropic.com/v1/messages"
+        body = {
+          model: "claude-3-opus-20240229",
+          messages: [
+            { role: "user", content: prompt }
+          ],
+          temperature: 0.3
+        }
+      end
+
+      request.body = body.to_json
+
+      response = nil
+      begin
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(request)
+        end
+      rescue StandardError => e
+        raise Error, "API request failed: #{e.message}"
+      end
+
+      raise Error, "API request failed: #{response.code} #{response.message}" unless response.is_a?(Net::HTTPSuccess)
+
+      JSON.parse(response.body)
+    end
+
+    def parse_response(response)
+      if response["choices"]
+        # OpenAI format
+        response["choices"][0]["message"]["content"]
+      elsif response["content"]
+        # Anthropic format
+        response["content"][0]["text"]
+      else
+        raise "Unexpected API response format"
+      end
+    rescue StandardError => e
+      raise Error, "Failed to parse API response: #{e.message}"
+    end
+  end
+end

data/lib/monty_ai/cli.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module MontyAI
+  class CLI < Thor
+    desc "explain FILE", "Explain the code in FILE"
+    def explain(file = nil)
+      if file.nil? && !$stdin.tty?
+        # Handle piped input
+        code = $stdin.read
+        handle_code(code)
+      elsif file.nil?
+        # No file provided and no pipe
+        puts "Error: Please provide a file to explain or pipe code to the command."
+        exit 1
+      else
+        # Handle file input
+        begin
+          code = FileHandler.read(file)
+          handle_code(code, file)
+        rescue Error => e
+          puts "Error: #{e.message}"
+          exit 1
+        end
+      end
+    end
+
+    private
+
+    def handle_code(code, filename = nil)
+      puts "Analyzing code..."
+
+      begin
+        explainer = AIClient.new
+        explanation = explainer.explain_code(code)
+
+        if filename
+          puts "Explanation for #{filename}:"
+          puts ""
+        end
+
+        puts Formatter.format(explanation)
+      rescue Error => e
+        puts "Error: #{e.message}"
+        exit 1
+      end
+    end
+
+    desc "version", "Show version"
+    def version
+      puts "MontyAI version #{MontyAI::VERSION}"
+    end
+  end
+end

data/lib/monty_ai/file_handler.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module MontyAI
+  # Class FileHandler opens files for explanations
+  class FileHandler
+    def self.read(path)
+      raise Error, "File not found: #{path}" unless File.exist?(path)
+
+      raise Error, "Cannot read file: #{path}" unless File.readable?(path)
+
+      File.read(path)
+    rescue StandardError => e
+      raise Error, "Failed to read file: #{e.message}"
+    end
+  end
+end

data/lib/monty_ai/formatter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module MontyAI
+  class Formatter
+    def self.format(explanation)
+      # Simple formatter that just returns the explanation
+      # In future versions, this could be enhanced to do more formatting
+      explanation
+    end
+  end
+end

data/lib/monty_ai/version.rb

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

data/lib/monty_ai.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "monty_ai/version"
+require "monty_ai/cli"
+require "monty_ai/ai_client"
+require "monty_ai/file_handler"
+require "monty_ai/formatter"
+
+# @!parse
+#   # Provides configuration and utility methods for the MontyAI application.
+#   # This module serves as a central point for managing settings and common
+#   # functionalities.
+module MontyAI
+  class Error < StandardError; end
+
+  # Core configuration
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+    end
+  end
+
+  # Configuration class for global settings
+  class Configuration
+    attr_accessor :api_key, :api_endpoint
+
+    def initialize
+      @api_key = ENV["OPENAI_API_KEY"] || ENV["ANTHROPIC_API_KEY"]
+      @api_endpoint = "https://api.openai.com/v1/chat/completions"
+    end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: monty-ai
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Steve Cook
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: MontyAI is an intelligent code explanation tool that uses AI to help
+  you understand code faster.
+email:
+- stevorevo@duck.co
+executables:
+- monty-ai
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/monty-ai
+- lib/monty_ai.rb
+- lib/monty_ai/ai_client.rb
+- lib/monty_ai/cli.rb
+- lib/monty_ai/file_handler.rb
+- lib/monty_ai/formatter.rb
+- lib/monty_ai/version.rb
+homepage: https://github.com/scookdev/monty_ai
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/scookdev/monty_ai
+  source_code_uri: https://github.com/scookdev/monty_ai
+  changelog_uri: https://github.com/scookdev/monty_ai/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: CLI tool to explain code using AI
+test_files: []