newsman 0.1.12 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f089cfc5c61266ac51d4c8ed7648268d8c7e7ef61a7476c48d08f099e96bb8d2
-  data.tar.gz: f5ac355f83f8a93e59a36a3a663931f22af7ef117d995bda73f63502f41bb4ed
+  metadata.gz: 5a68ba87116b71adc25a5983ee3b91cc94414b27edee46781fdec6141988a278
+  data.tar.gz: 02f0cb536bbe01e60578755227a0b0a03eed4c6086bceebcee399f6ae2a53aba
 SHA512:
-  metadata.gz: 59575806b0b0ff92dc1b93740c4286bd538ee3710a2429ed44ffecd467ed19787ddd30bfa035dbd7bf14324d2bdebcdea75c6908aa6ca45e550eb652ce811764
-  data.tar.gz: 7a3a4c2345f72501b5ce10a36ee3675f0ee6f3e687c881878914a17a7c0178e035382515ab01ff27c07e776e4b033eaaa4d2641dd00310e8c62a528917ab5a3b
+  metadata.gz: 6e247fd019a04cc39c3d9bb3e2bc0db202947941cad27e968501f9d355308ee4704b6f8c76267e1b2953f00996e15a2c5c6c5dd03e7712f93e400ab3fd3633e7
+  data.tar.gz: 2d416b5a3476432636e78fe08d18bc3480539ecaea6f896c757a99a85d11b0be47aa7459448c9b3a536f942828d6e2cf512a5cc5c6f1296248b03f33bae8f249

data/README.md

@@ -65,4 +65,4 @@ And you should see a welcome message from newsman.
 
 ## Examples
 
-You can find examples of generated reports [here](https://github.com/volodya-lombrozo/newsman/tree/gh-pages)
+You can find examples of generated reports [here](https://volodya-lombrozo.github.io/newsman/)

data/lib/newsman/assistant.rb

@@ -0,0 +1,149 @@
+require 'openai'
+
+class Assistant
+
+  CONTEXT = 'You are a developer tasked with composing a concise report detailing your activities and progress for the previous week, intended for submission to your supervisor.' 
+
+  def initialize(token, model: 'gpt-3.5-turbo', temperature: 0.3)
+    @token = token
+    @model = model
+    @temperature = temperature
+    @client = OpenAI::Client.new(access_token: token)
+  end
+
+  def say_hello
+    "I'm an assistant that can work with OpenAI client. Please, use me, if you need any help. I'm using #{@model}, with #{@temperature} temperature."
+  end
+
+  def next_plans(issues)
+    example = "repository-name:\n
+      - To publish ABC package draft [#27]\n
+      - To review first draft of the report [#56]\n
+      - To implement optimization for the class X [#125]"
+    return send("Please compile a summary of the plans for the next week using the following GitHub Issues descriptions. Each issue should be summarized in a single sentence, focusing more on the issue title and less on implementation details. Pay attention, that you didn't loose any issue. Ensure that each sentence includes the corresponding issue number as an integer value. If an issue doesn't mention an issue number, just print [#chore]. Combine all the information from each Issue into a concise and fluent sentences, as if you were a developer reporting on your work. Please strictly adhere to the example template provided: ```#{example}```. List of GitHub issues to aggregate: [#{issues}].")
+  end
+
+  def prev_results(prs)
+    example = "repository-name:\n
+      - Added 100 new files to the Dataset [#168]\n
+      - Fixed the deployment of XYZ [#169]\n
+      - Refined the requirements [#177]\n"
+    return send("Please compile a summary of the work completed in the following Pull Requests (PRs). Each PR should be summarized in a single sentence, focusing more on the PR title and less on implementation details. Pay attention, that you don't lose any PR. Ensure that each sentence includes the corresponding issue number as an integer value. If a PR doesn't mention an issue number, just print [#chore]. Combine all the information from each PR into a concise and fluent sentence, as if you were a developer reporting on your work. Please strictly adhere to the example template provided: ```#{example}```. List of Pull Requests: [#{prs}]")
+  end
+
+  def risks(all)
+    example = "repository-name:\n
+      - The server is weak, we may fail the delivery\n
+      of the dataset, report milestone will be missed [#487].\n
+      - The code in repository is suboptimal, we might have some problems for the future maintainability [#44].\n"
+    return send("Please compile a summary of the risks identified in the repository. If you can't find anything, just answer 'No risks identified'. Developers usually mention some risks in pull request descriptions. They either mention 'risk' or 'issue'. I will give you a list of pull requests. Each risk should be summarized in a single sentence. Ensure that each sentence includes the corresponding PR number as an integer value. If a PR doesn't mention an issue number, just print [#chore]. Combine all the information from each PR into a concise and fluent sentence, as if you were a developer reporting on your work. Please strictly adhere to the example template provided: ```#{example}```. List of Pull Requests: [#{all}]") 
+  end
+
+  def old_prev_results(prs)
+    deprecated(__method__)
+    example = "some-repository-name-x:
+    - Added 100 new files to the Dataset [#168]
+    - Fixed the deployment of XYZ [#169]
+    - Refined the requirements [#177]
+    some-repository-name-y:
+    - Removed XYZ class [#57]
+    - Refactored http module [#69]"
+    response = @client.chat(
+      parameters: {
+        model: 'gpt-3.5-turbo',
+        messages: [
+          { role: 'system',
+            content: 'You are a developer tasked with composing a concise report detailing your activities and progress for the previous week, intended for submission to your supervisor.' },
+          { role: 'user',
+            content: "Please compile a summary of the work completed in the following Pull Requests (PRs). Each PR should be summarized in a single sentence, focusing more on the PR title and less on implementation details. Group the sentences by repositories, each identified by its name mentioned in the 'repository:[name]' attribute of the PR. Pay attention, that you don't lose any PR. The grouping is important an should be precise. Ensure that each sentence includes the corresponding issue number as an integer value. If a PR doesn't mention an issue number, just print [#chore]. Combine all the information from each PR into a concise and fluent sentence, as if you were a developer reporting on your work. Please strictly adhere to the example template provided. Example of a report: #{example}. List of Pull Requests: [#{prs}]" }
+        ],
+        temperature: 0.3
+      }
+    )
+    answer = response.dig('choices', 0, 'message', 'content')
+    return answer 
+  end
+
+  def old_next_plans(issues)
+    deprecated(__method__)
+    example_plans = "some-repository-name-x:
+    - To publish ABC package draft [#27]
+    - To review first draft of the report [#56]
+    some-repository-name-y:
+    - To implement optimization for the class X [#125]"
+    issues_response = @client.chat(
+      parameters: {
+        model: 'gpt-3.5-turbo',
+        messages: [
+          { role: 'system',
+            content: 'You are a developer tasked with composing a concise report detailing your activities and progress for the previous week, intended for submission to your supervisor.' },
+          { role: 'user',
+            content: "Please compile a summary of the plans for the next week using the following GitHub Issues descriptions. Each issue should be summarized in a single sentence, focusing more on the issue title and less on implementation details. Group the sentences by repositories, each identified by its name mentioned in the 'repository:[name]' attribute of the issue. Pat attention, that you din't loose any issue. The grouping is important an should be precise. Ensure that each sentence includes the corresponding issue number as an integer value. If an issue doesn't mention an issue number, just print [#chore]. Combine all the information from each Issue into a concise and fluent sentences, as if you were a developer reporting on your work. Please strictly adhere to the example template provided: #{example_plans}. List of GitHub issues to aggregate: [#{issues}]." }
+        ],
+        temperature: 0.3
+      }
+    )
+    issues_full_answer = issues_response.dig('choices', 0, 'message', 'content')
+    return issues_full_answer
+  end 
+
+  def old_risks(all)
+    deprecated(__method__)
+    example_risks = "some-repository-name-x:
+  - The server is weak, we may fail the delivery
+  of the dataset, report milestone will be missed [#487].
+some-repository-name-y:
+  - The code in repository is suboptimal, we might have some problems for the future maintainability [#44]."
+    return @client.chat(
+        parameters: {
+          model: 'gpt-3.5-turbo',
+          messages: [
+            { role: 'system',
+              content: 'You are a developer tasked with composing a concise report detailing your activities and progress for the previous week, intended for submission to your supervisor.' },
+            { role: 'user',
+              content: "Please compile a summary of the risks identified in some repositories. If you can't find anything, just leave answer empty. Add some entries to a report only if you are sure it's a risk. Developers usually mention some risks in pull request descriptions. They either mention 'risk' or 'issue'. I will give you a list of pull requests. Each risk should be summarized in a single sentence. Ensure that each sentence includes the corresponding issue number or PR number as an integer value. If a PR or an issue doesn't mention an issue number, just print [#chore]. Combine all the information from each PR into a concise and fluent sentence, as if you were a developer reporting on your work. Please strictly adhere to the example template provided. Example of a report: #{example_risks}. List of Pull Requests: ```#{all}```.]" }
+          ],
+          temperature: 0.3
+        }
+      ).dig('choices', 0, 'message', 'content')
+  end
+
+  def send(request)
+    return @client.chat(
+      parameters: {
+        model: @model,
+        messages: [
+          { role: 'system',
+            content: CONTEXT },
+          { role: 'user',
+            content: "#{request}" } 
+        ],
+        temperature: @temperature
+      }
+    ).dig('choices', 0, 'message', 'content')
+  end
+
+  def deprecated(method)
+    warn "Warning! '#{method}' is deprecated and will be removed in future versions."
+  end
+
+  def send(request)
+    return @client.chat(
+      parameters: {
+        model: @model,
+        messages: [
+          { role: 'system',
+            content: CONTEXT },
+          { role: 'user',
+            content: "#{request}" } 
+        ],
+        temperature: @temperature
+      }
+    ).dig('choices', 0, 'message', 'content')
+  end
+
+  def deprecated(method)
+    warn "Warning! '#{method}' is deprecated and will be removed in future versions."
+  end
+
+end

data/lib/newsman/issues.rb

@@ -5,25 +5,35 @@ require 'net/http'
 
 class Issue
   attr_accessor :title, :body, :repo, :number
+  attr_reader :url
 
-  def initialize(title, body, repo, number)
+  def initialize(title, body, repo, number, url: 'undefined')
     @title = title
     @body = body
     @repo = repo
     @number = number
+    @url = url
   end
 
   def to_s
     "title: ```#{@title}```,\ndescription: ```#{@body}```,\nrepo: ```#{@repo}```,\nissue number: \##{@number}\n"
   end
+
+  def detailed_title 
+    "title: #{@title}, repo: #{@repo}, number: \##{@number}, url: #{@url}"
+  end
+    
 end
 
 class PddIssue
-  def initialize(title, body, repo, number)
+  attr_accessor :repo
+
+  def initialize(title, body, repo, number, url: 'undefined')
     @title = title
     @body = body
     @repo = repo
     @number = number
+    @url = url 
   end
 
   def extract_real_body
@@ -42,4 +52,9 @@ class PddIssue
   def to_s
     "title: ```#{@title}```,\ndescription: ```#{extract_real_body}```,\nrepo: ```#{@repo}```,\nissue number: \##{@number}\n"
   end
+
+  def detailed_title
+    "title: #{@title}, repo: #{@repo}, issue number: \##{@number}, url: #{@url}"
+  end
+
 end

data/lib/newsman/pull_request.rb

@@ -2,14 +2,21 @@
 
 class PullRequest
   attr_accessor :repository, :title, :description
+  attr_reader :url
 
-  def initialize(repository, title, description)
+  def initialize(repository, title, description, url: 'undefined')
     @repository = repository
     @title = title
     @description = description
+    @url = url
   end
 
   def to_s
     "title: ```#{@title}```,\ndescription: ```#{@description}```,\nrepo: ```#{@repository}```\n"
   end
+
+  def detailed_title
+    "title: #{@title}, repo: #{@repository}, url: #{@url}"
+  end
+
 end

data/lib/newsman/report.rb

@@ -2,15 +2,22 @@
 # frozen_string_literal: true
 
 class Report
-  def initialize(user, position, title)
+  def initialize(user, position, title, additional: ReportItems.new([],[]))
     @user = user
     @position = position
     @title = title
+    @additional = additional
   end
 
   def build(achievements, plans, risks, date)
-    "From: #{@user}\nSubject: #{week_of_a_year(@title,
+    start = "From: #{@user}\nSubject: #{week_of_a_year(@title,
                                                date)}\n\nHi all,\n\nLast week achievements:\n#{achievements}\n\nNext week plans:\n#{plans}\n\nRisks:\n#{risks}\n\nBest regards,\n#{@user}\n#{@position}\n#{date}"
+
+    finish = ''
+    if !@additional.empty?
+      finish = "\n------\n" + @additional.to_s
+    end
+    return start + finish;
   end
 end
 
@@ -18,3 +25,23 @@ def week_of_a_year(project, today)
   number = today.strftime('%U').to_i + 1
   "WEEK #{number} #{project}"
 end
+
+
+class ReportItems
+  
+  def initialize(prs, issues)
+    @prs = prs || []
+    @issues = issues || []
+  end
+
+  # Returns true if there are no pull requests or issues, false otherwise
+  def empty?
+    @prs.empty? && @issues.empty?
+  end
+
+  def to_s
+    prs_list = @prs.map(&:detailed_title).map { |obj| " - #{obj}\n" }.join
+    issues_list = @issues.map(&:detailed_title).map { |obj| " - #{obj}\n" }.join 
+    return "Closed Pull Requests:\n#{prs_list}\nOpen Issues:\n#{issues_list}"
+  end
+end

data/lib/newsman.rb

@@ -11,6 +11,7 @@ require_relative 'newsman/stdout_output'
 require_relative 'newsman/txt_output'
 require_relative 'newsman/html_output'
 require_relative 'newsman/report'
+require_relative 'newsman/assistant'
 
 def generate
   # Load all options required
@@ -91,10 +92,12 @@ def generate
     repository = pr.repository_url.split('/').last
     puts "Found PR in #{repository}: #{title}"
     # Create a new PullRequest object and add it to the list
-    pr = PullRequest.new(repository, title, description)
+    pr = PullRequest.new(repository, title, description, url: pr.html_url)
     prs << pr
   end
+  raw_prs = prs
   prs = prs.map(&:to_s).join("\n\n\n")
+  grouped_prs = raw_prs.group_by { |pr| pr.repository }
 
   puts "Searching issues using the following query: '#{issues_query}'"
   issues = []
@@ -105,82 +108,57 @@ def generate
     number = issue.number.to_s
     puts "Found issue in #{repository}:[##{number}] #{title}"
     issues << if issue.user.login == '0pdd'
-                PddIssue.new(title, body, repository, number)
+                PddIssue.new(title, body, repository, number, url: issue.html_url)
               else
-                Issue.new(title, body, repository, number)
+                Issue.new(title, body, repository, number, url: issue.html_url)
               end
   end
+  raw_issues = issues
   issues = issues.map(&:to_s).join("\n\n\n")
-  # puts "Found issues:\n #{issues}"
+  grouped_issues = raw_issues.group_by { |iss| iss.repo }
 
   puts "\nNow lets test some aggregation using OpenAI\n\n"
   openai_client = OpenAI::Client.new(access_token: openai_token)
+  
+  assistant = Assistant.new(openai_token)
+  
+  old_way = false
+  if old_way
+    answer = assistant.old_prev_results(prs)
+    issues_full_answer = assistant.old_next_plans(issues) 
+    risks_full_answer = assistant.old_risks(prs)
+ else
+    puts "Assistant builds a report using a new approach, using groupping"
+    # Build previous results
+    answer = "" 
+    grouped_prs.each do |repository, rprs|
+      puts "Building a results report for the repository: #{repository}"
+      answer = answer + assistant.prev_results(rprs.map(&:to_s).join("\n\n\n"))
+    end
+    # Build next plans 
+    issues_full_answer = "" 
+    grouped_issues.each do |repository, rissues|
+      puts "Building a future plans report for the repository: #{repository}"
+      issues_full_answer = issues_full_answer + assistant.next_plans(rissues.map(&:to_s).join("\n\n\n"))
+    end
+    # Find risks
+    risks_full_answer = assistant.risks(prs)
+  end
 
-  example = "some-repository-name-x:
-  - Added 100 new files to the Dataset [#168]
-  - Fixed the deployment of XYZ [#169]
-  - Refined the requirements [#177]
-  some-repository-name-y:
-  - Removed XYZ class [#57]
-  - Refactored http module [#69]"
-
-  example_plans = "some-repository-name-x:
-  - To publish ABC package draft [#27]
-  - To review first draft of the report [#56]
-  some-repository-name-y:
-  - To implement optimization for the class X [#125]"
-
-  example_risks = "some-repository-name-x:
-  - The server is weak, we may fail the delivery
-  of the dataset, report milestone will be missed [#487].
-some-repository-name-y:
-  - The code in repository is suboptimal, we might have some problems for the future maintainability [#44].
-  "
-
-  response = openai_client.chat(
-    parameters: {
-      model: 'gpt-3.5-turbo',
-      messages: [
-        { role: 'system',
-          content: 'You are a developer tasked with composing a concise report detailing your activities and progress for the previous week, intended for submission to your supervisor.' },
-        { role: 'user',
-          content: "Please compile a summary of the work completed in the following Pull Requests (PRs). Each PR should be summarized in a single sentence, focusing more on the PR title and less on implementation details. Group the sentences by repositories, each identified by its name mentioned in the 'repository:[name]' attribute of the PR. Pay attention, that you don't lose any PR. The grouping is important an should be precise. Ensure that each sentence includes the corresponding issue number as an integer value. If a PR doesn't mention an issue number, just print [#chore]. Combine all the information from each PR into a concise and fluent sentence, as if you were a developer reporting on your work. Please strictly adhere to the example template provided. Example of a report: #{example}. List of Pull Requests: [#{prs}]" }
-      ],
-      temperature: 0.3
-    }
+  full_answer = Report.new(
+    reporter, 
+    reporter_position, 
+    options[:title],
+    additional: ReportItems.new(raw_prs, raw_issues)
+  ).build(
+    answer, 
+    issues_full_answer,
+    risks_full_answer, 
+    Date.today
   )
-  answer = response.dig('choices', 0, 'message', 'content')
-  issues_response = openai_client.chat(
-    parameters: {
-      model: 'gpt-3.5-turbo',
-      messages: [
-        { role: 'system',
-          content: 'You are a developer tasked with composing a concise report detailing your activities and progress for the previous week, intended for submission to your supervisor.' },
-        { role: 'user',
-          content: "Please compile a summary of the plans for the next week using the following GitHub Issues descriptions. Each issue should be summarized in a single sentence, focusing more on the issue title and less on implementation details. Group the sentences by repositories, each identified by its name mentioned in the 'repository:[name]' attribute of the issue. Pat attention, that you din't loose any issue. The grouping is important an should be precise. Ensure that each sentence includes the corresponding issue number as an integer value. If an issue doesn't mention an issue number, just print [#chore]. Combine all the information from each Issue into a concise and fluent sentences, as if you were a developer reporting on your work. Please strictly adhere to the example template provided: #{example_plans}. List of GitHub issues to aggregate: [#{issues}]. Use the same formatting as here \n```#{answer}```\n" }
-      ],
-      temperature: 0.3
-    }
-  )
-  issues_full_answer = issues_response.dig('choices', 0, 'message', 'content')
-
-  risks_full_answer = openai_client.chat(
-    parameters: {
-      model: 'gpt-3.5-turbo',
-      messages: [
-        { role: 'system',
-          content: 'You are a developer tasked with composing a concise report detailing your activities and progress for the previous week, intended for submission to your supervisor.' },
-        { role: 'user',
-          content: "Please compile a summary of the risks identified in some repositories. If you can't find anything, just leave answer empty. Add some entries to a report only if you are sure it's a risk. Developers usually mention some risks in pull request descriptions. They either mention 'risk' or 'issue'. I will give you a list of pull requests. Each risk should be summarized in a single sentence. Ensure that each sentence includes the corresponding issue number or PR number as an integer value. If a PR or an issue doesn't mention an issue number, just print [#chore]. Combine all the information from each PR into a concise and fluent sentence, as if you were a developer reporting on your work. Please strictly adhere to the example template provided. Example of a report: #{example_risks}. List of Pull Requests: ```#{prs}```.]" }
-      ],
-      temperature: 0.3
-    }
-  ).dig('choices', 0, 'message', 'content')
 
   output_mode = options[:output]
   puts "Output mode is '#{output_mode}'"
-  full_answer = Report.new(reporter, reporter_position, options[:title]).build(answer, issues_full_answer,
-                                                                               risks_full_answer, Date.today)
   if output_mode.eql? 'txt'
     puts 'Print result to txy file'
     output = Txtout.new('.')

data/test/test_assistant.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright (c) 2024 Volodya Lombrozo
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'minitest/autorun'
+require_relative '../lib/newsman/assistant'
+
+class TestAssistant < Minitest::Test
+  def test_creates_default_assistant
+    assistant = Assistant::new('test-token');
+    assert_equal "I'm an assistant that can work with OpenAI client. Please, use me, if you need any help. I'm using gpt-3.5-turbo, with 0.3 temperature.", assistant.say_hello
+  end
+end
+

data/test/test_report.rb

@@ -23,6 +23,8 @@
 
 require 'minitest/autorun'
 require_relative '../lib/newsman/report'
+require_relative '../lib/newsman/issues'
+require_relative '../lib/newsman/pull_request'
 
 class TestReport < Minitest::Test
   def test_report
@@ -51,4 +53,16 @@ Developer
                        "repository-b:\n - I will do a lot for repository (b)", '- <todo>', Date.new(2024, 3, 14))
     assert_equal expected, out
   end
+
+  def test_report_items
+    expected = "Closed Pull Requests:\n - title: title, repo: repo, url: http://some.url.com\n\nOpen Issues:\n - title: title, repo: repo, number: #123, url: http://google.com\n"
+    issues = [ Issue::new('title', 'body', 'repo', '123', url: 'http://google.com')]
+    prs = [ PullRequest::new('repo', 'title', 'body', url: 'http://some.url.com') ]
+    actual = ReportItems.new(prs, issues).to_s
+
+    puts actual 
+    assert_equal expected, actual
+  end
+
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: newsman
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.14
 platform: ruby
 authors:
 - Volodya Lombrozo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-14 00:00:00.000000000 Z
+date: 2024-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -163,12 +163,14 @@ files:
 - README.md
 - bin/newsman
 - lib/newsman.rb
+- lib/newsman/assistant.rb
 - lib/newsman/html_output.rb
 - lib/newsman/issues.rb
 - lib/newsman/pull_request.rb
 - lib/newsman/report.rb
 - lib/newsman/stdout_output.rb
 - lib/newsman/txt_output.rb
+- test/test_assistant.rb
 - test/test_htmlout.rb
 - test/test_pdd_issue.rb
 - test/test_report.rb