walkthrough_awanllm 0.1.20 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec195b8ba320b5775eca40fe298a17296c4d0d606d9d7033d39b264b6623d4f5
-  data.tar.gz: b6868fe445362fd7b32aebc703fe6cde3c114347949403c5346bb1a218721ab0
+  metadata.gz: 5b76c11f4c34ccc7a844c06185e914b47051ebf39d0a854f936dc01f6cde6466
+  data.tar.gz: af9165c374930e086281ff113bebb931d555bf84a9bd2bb9e512d66827fadac6
 SHA512:
-  metadata.gz: d77f4ac5afe4d1739275124108ef41e7a0c2ab8b643c7d5a3b05cbd47fb45c879a2a52f877e3cf1abb318528ef45632944e824b2dc5781f456bc1fe2e1dea976
-  data.tar.gz: 7e36f89303d7db1a751cf38705362ef8398135d7815eb6a9f81e6f9ade05885218dbf3abaffdd9ee20c16a9695cdd7f593a0800febdf2a090fad153fe3077cc3
+  metadata.gz: cdddb7addbbe2ce894a03983573afa05fd1a4a713b4d4b3b0306eff67957db6b60b777efbe2cbe64f1215c59f70e596ac620c1cd7abf1bb865d9f3b7a45dc728
+  data.tar.gz: a82152fe5b7c7b08b759eaa37dc924c0192e24e58b7027dcf534aa71ed0d02fd78893d9c828ec724c122589ac0621e93fe55a4e46792966ac2f25d376ba95e10

data/README.md

@@ -1,5 +1,7 @@
-Here's an updated README for your gem `walkthrough_awanllm`, including all necessary installation and usage instructions, as well as development and contributing guidelines.
+Here's an updated README for your gem `walkthrough_awanllm`, including all necessary installation and usage instructions, as well as development and contributing guidelines. All credits for AwanLLM goes to the orginal creators of API for offering a free tier. 
 
+### Email: contact.awanllm@gmail.com
+### https://www.awanllm.com/
 ```markdown
 # WalkthroughAwanllm
 
@@ -30,9 +32,11 @@ $ gem install walkthrough_awanllm
 After installing the gem, you need to configure it by running the setup script. This will prompt you for your AwanLLM API key and the model name you wish to use.
 
 ```sh
-$ ruby ./vendor/bundle/ruby/YOUR_VERSION/gems/walkthrough_awanllm-0.1.20/bin/setup_awanllm.rb
+$ ruby ./vendor/bundle/ruby/YOUR_VERSION/gems/walkthrough_awanllm-0.2.12/bin/setup_awanllm.rb
 ```
 
+Get API key from https://www.awanllm.com/
+
 ## Usage
 
 
@@ -45,7 +49,7 @@ rails console
 > awanllm = WalkthroughAwanllm::AwanLLM.new
 > awanllm.generate_walkthrough
 ```
-Or by running :
+(IF ABOVE IS NOT WORKING) by running :
 ```ruby
 rails awanllm:generate_walkthrough
 ```

data/lib/walkthrough_awanllm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WalkthroughAwanllm
-  VERSION = "0.1.20"
+  VERSION = "0.2.12"
 end

data/lib/walkthrough_awanllm.rb

@@ -1,5 +1,6 @@
 require 'httparty'
 require 'json'
+require 'fileutils'
 require_relative "walkthrough_awanllm/cli"
 require_relative "walkthrough_awanllm/version"
 require_relative "walkthrough_awanllm/railtie" if defined?(Rails)
@@ -42,20 +43,83 @@ module WalkthroughAwanllm
 
     def generate_walkthrough
       activities = File.read("log/awanllm_activity.log")
-      prompt = "Here is a log of activities:\n#{activities}\nGenerate a detailed walkthrough based on these activities. It should include the steps taken and the expected outcomes."
+      commits = split_by_commits(activities)
 
-      options = {
-        temperature: 0.7,
-        top_p: 0.9,
-        max_tokens: 1024
-      }
+      # Read the last processed commit hash from file
+      last_commit_file = "last_processed_commit.txt"
+      last_processed_commit = read_last_processed_commit(last_commit_file)
+
+      # Find the index of the last processed commit
+      start_index = commits.index { |commit| commit.include?(last_processed_commit) }
+      start_index = start_index.nil? ? 0 : start_index + 1  # Start from the next commit
+
+      # Extract new commits
+      new_commits = commits[start_index..-1] || []
+      return if new_commits.empty?
+
+      prompt_template = <<~PROMPT
+        Here is a log of activities for a specific git commit: {{commit}}.
+        Using this log, generate a detailed walkthrough for this commit. This walkthrough should be narrated from the first-person perspective of the developer, resembling a personal diary or story. It must include the following:
+        - Personal Insights: Capture the developer's thoughts, decisions, and reflections during this commit.
+        - Challenges: Describe any difficulties or obstacles faced and how they were resolved or worked around.
+        - Technical Details: Provide detailed explanations of the technical aspects and steps involved, including relevant code snippets.
+        - Reasoning: Explain the reasoning behind major decisions during this commit, such as choosing specific tools, technologies, or methods.
+        - Step-by-Step Process: Offer a structured guide through the entire commit process.
+        - Lessons Learned: Conclude with insights or lessons learned from this commit, including what could be done differently in future commits.
+        Ensure the walkthrough is thorough, engaging, and informative, offering a deep dive into the developer's journey during this commit.
+      PROMPT
+
+      walkthrough = ""
 
-      response = generate_content(nil, prompt, options)
-      walkthrough = response['choices'][0]['text']
+      new_commits.each do |commit|
+        prompt = prompt_template.gsub("{{commit}}", commit)
+        options = {
+          temperature: 0.7,
+          top_p: 0.9,
+          max_tokens: 2048  # Adjust if your model supports more tokens
+        }
 
-      File.open("walkthrough.md", "w") do |file|
-        file.write(walkthrough)
+        response = generate_content(nil, prompt, options)
+        commit_walkthrough = response['choices'][0]['text']
+
+        walkthrough += commit_walkthrough + "\n\n"
       end
+
+      # Append to the file only if it exists
+      if File.exist?("walkthrough.md")
+        File.open("walkthrough.md", "a") do |file|
+          file.puts("\n")
+          file.puts(walkthrough)
+        end
+      else
+        File.write("walkthrough.md", walkthrough)
+      end
+
+      # Update the last processed commit hash
+      update_last_processed_commit(last_commit_file, extract_commit_hash(new_commits.last))
+    end
+
+
+    # Method to split the log by git commits
+    def split_by_commits(log_content)
+      log_content.scan(/#### Commit Details:.*?(?=(### \[|\z))/m).map(&:strip)
+    end
+
+    # Read the last processed commit from file
+    def read_last_processed_commit(file)
+      return nil unless File.exist?(file)
+      File.read(file).strip
+    end
+
+    # Update the last processed commit in file
+    def update_last_processed_commit(file, commit_hash)
+      File.write(file, commit_hash)
+    end
+
+    # Extract the commit hash from a commit section
+    def extract_commit_hash(commit_section)
+      match = commit_section.match(/#### Commit Details: (\w+)/)
+      match[1] if match
     end
 
     def self.activate!
@@ -67,7 +131,7 @@ module WalkthroughAwanllm
         puts 'Walkthrough_AwanLLM gem is already configured.'
       else
         ruby_version = RUBY_VERSION.split('.').first(3).join('.')
-        path_to_script = "./vendor/bundle/ruby/#{ruby_version}/gems/walkthrough_awanllm-0.1.20/bin/setup_awanllm.rb"
+        path_to_script = "./vendor/bundle/ruby/#{ruby_version}/gems/walkthrough_awanllm-0.2.12/bin/setup_awanllm.rb"
         system("ruby #{path_to_script}")
       end
     end
@@ -85,5 +149,6 @@ module WalkthroughAwanllm
         raise "Error: #{response.code} - #{error_message}"
       end
     end
+
   end
 end

data/walkthrough_awanllm.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email       = ["mrudulmathews@gmail.com"]
 
   spec.summary     = "A Ruby gem to Generate Project Development Walkthrough with the AwanLLM API."
-  spec.description = "{UNDER DEVELOPMENT NOT FOR USE YET}A Ruby gem to generate a walkthrough the project lifecycle with the AwanLLM API for generating and retrieving content."
+  spec.description = "A Ruby gem to generate a walkthrough the project lifecycle with the AwanLLM API for generating and retrieving content. Please feel free to update the gem with your updates"
   spec.homepage    = "https://github.com/mruduljohn/Walkthrough_awanllm_gem"
   spec.license     = "MIT"
   spec.required_ruby_version = ">= 3.0.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: walkthrough_awanllm
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.2.12
 platform: ruby
 authors:
 - Mrudul John
@@ -80,8 +80,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: "{UNDER DEVELOPMENT NOT FOR USE YET}A Ruby gem to generate a walkthrough
-  the project lifecycle with the AwanLLM API for generating and retrieving content."
+description: A Ruby gem to generate a walkthrough the project lifecycle with the AwanLLM
+  API for generating and retrieving content. Please feel free to update the gem with
+  your updates
 email:
 - mrudulmathews@gmail.com
 executables:
@@ -110,7 +111,7 @@ metadata:
 post_install_message: |2
       Thank you for installing the Walkthrough_AwanLLM gem!
       To complete the setup, please run the following command:
-      ruby ./vendor/bundle/ruby/3.3.0/gems/walkthrough_awanllm-0.1.20/bin/setup_awanllm.rb
+      ruby ./vendor/bundle/ruby/3.3.0/gems/walkthrough_awanllm-0.2.12/bin/setup_awanllm.rb
 rdoc_options: []
 require_paths:
 - lib