RubyGems - newsman - Versions diffs - 0.1.9 → 0.1.11 - Mend

newsman 0.1.9 → 0.1.11

Files changed (11) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2394e606a441d219f1b63d81957596975476de4da4a8cf2a8565638d9e5fd31e
-  data.tar.gz: 10c89c9e91a89fde8c67822d72ada6de3cf731b1c3a7fc9aa9d0e7ad90c1f43a
+  metadata.gz: 47097e4e1db8dbfaa84c2aa58d8d9a13294cab2ab471a5927f1d083327a713db
+  data.tar.gz: 48ea4b8237d6daff81c15bbfc7786850c820a2a3bcceb931332594c5f5e2a02e
 SHA512:
-  metadata.gz: d649675bf107b488ce5c8644414589419518e9f8f8ea497d80da5a3810de6fecc1a1f346fbd4c06a84f41e979df890af50ec89bbc89ed34056af5b7467f40dce
-  data.tar.gz: 7de3191d99baee21f3346434d6aeb6550e9bb07e8f9a944215958206cd94a1176f367f699b84778a063227a165bf4e065bccbe48def5e8d9b1ae33eb6a59d2fc
+  metadata.gz: 662c512d37c279e44957de12a6d2825a266f048edf350ea5e272d23b88f7b35df0461c9eef3478e8e75e1623d6a8f5240d9000bd865d99498285dfec69ffd5bd
+  data.tar.gz: 764561fef8f5de1aea6cfa05983b767bc6d40707d82c9e8b5aaa96faffac4815bc934078852d03ec89be6b8f5445e45c9611666fef5b2a3bff26cb3b8bcd19d3

data/lib/newsman/html_output.rb CHANGED Viewed

@@ -1,34 +1,37 @@
+# frozen_string_literal: true
 require 'erb'
+require 'redcarpet'
+require 'nokogiri'
 # frozen_string_literal: true
 class Htmlout
-  TEMPLATE = "<!DOCTYPE html>
-<html lang=\"en\">
+  TEMPLATE = "
 <head>
-  <meta charset=\"UTF-8\">
   <title><%= title %></title>
 </head>
 <body>
   <h1><%= title %></h1>
-  <p><%= body %></p>
+  <%= body %>
 </body>
-</html>
 "
   def initialize(root = '.')
     @root = root
   end
   def print(report, reporter)
-    title = title(reporter)
-    body = report
+    title = title(reporter)
+    renderer = Redcarpet::Render::HTML.new(no_links: true, hard_wrap: true, prettify: true)
+    markdown = Redcarpet::Markdown.new(renderer, autolink: true, tables: true)
+    body = markdown.render(report)
     renderer = ERB.new(TEMPLATE)
     html_content = renderer.result(binding)
+    html_content = Nokogiri::HTML(html_content, &:noblanks).to_xhtml(indent: 2)
     puts "Create a html file in a directory #{@root}"
     file = File.new(File.join(@root, filename(reporter)), 'w')
     puts "File #{file.path} was successfully created"
-    file.puts html_content
+    file.puts html_content
     puts "Report was successfully printed to a #{file.path}"
     file.close
   end

data/lib/newsman/issues.rb CHANGED Viewed

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 require 'net/http'
 # frozen_string_literal: true
-class Issue
+class Issue
   attr_accessor :title, :body, :repo, :number
   def initialize(title, body, repo, number)
@@ -17,7 +19,6 @@ class Issue
 end
 class PddIssue
   def initialize(title, body, repo, number)
     @title = title
     @body = body
@@ -26,18 +27,19 @@ class PddIssue
   end
   def extract_real_body
-    address = issue_link()
+    address = issue_link
     line_numbers = address.scan(/#L(\d+)-L(\d+)/).flatten.map(&:to_i)
     uri = URI(address)
-    return Net::HTTP.get(uri).lines[line_numbers[0]-1..line_numbers[1]]
+    Net::HTTP.get(uri).lines[line_numbers[0] - 1..line_numbers[1]]
   end
-  def issue_link
-    return @body[/https:\/\/github\.com\/[\w\-\/]+\/blob\/[\w\d]+\/[\w\/\.\-]+#\w+-\w+/, 0].gsub('https://github.com','https://raw.githubusercontent.com').gsub('blob/', '')
+  def issue_link
+    @body[%r{https://github\.com/[\w\-/]+/blob/[\w\d]+/[\w/.-]+#\w+-\w+}, 0].gsub('https://github.com', 'https://raw.githubusercontent.com').gsub(
+      'blob/', ''
+    )
   end
   def to_s
     "title: ```#{@title}```,\ndescription: ```#{extract_real_body}```,\nrepo: ```#{@repo}```,\nissue number: \##{@number}\n"
   end
 end

data/lib/newsman/pull_request.rb CHANGED Viewed

@@ -13,4 +13,3 @@ class PullRequest
     "title: ```#{@title}```,\ndescription: ```#{@description}```,\nrepo: ```#{@repository}```\n"
   end
 end

data/lib/newsman/report.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 class Report
   def initialize(user, position, title)
@@ -6,8 +7,10 @@ class Report
     @position = position
     @title = title
   end
-  def build(achievements, plans, date)
-    return "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- <todo>\n\nBest regards,\n#{@user}\n#{@position}\n#{date}"
+  def build(achievements, plans, risks, date)
+    "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}"
   end
 end
@@ -15,4 +18,3 @@ def week_of_a_year(project, today)
   number = today.strftime('%U').to_i + 1
   "WEEK #{number} #{project}"
 end

data/lib/newsman.rb CHANGED Viewed

@@ -76,7 +76,6 @@ def generate
   # Create a GitHub client instance with your access token
   client = Octokit::Client.new(github_token: github_token)
   # Calculate the date one week ago
-  report_date = Date.today
   one_week_ago = date_one_week_ago(Date.today)
   one_month_ago = Date.today.prev_month.strftime('%Y-%m-%d')
   # Display pull request
@@ -96,7 +95,7 @@ def generate
     prs << pr
   end
   prs = prs.map(&:to_s).join("\n\n\n")
   puts "Searching issues using the following query: '#{issues_query}'"
   issues = []
   client.search_issues(issues_query).items.each do |issue|
@@ -105,32 +104,39 @@ def generate
     repository = issue.repository_url.split('/').last
     number = issue.number.to_s
     puts "Found issue in #{repository}:[##{number}] #{title}"
-    if issue.user.login == "0pdd"
-      issues << PddIssue.new(title, body, repository, number)
-    else
-      issues << Issue.new(title, body, repository, number)
-    end
+    issues << if issue.user.login == '0pdd'
+                PddIssue.new(title, body, repository, number)
+              else
+                Issue.new(title, body, repository, number)
+              end
   end
   issues = issues.map(&:to_s).join("\n\n\n")
-  #puts "Found issues:\n #{issues}"
+  # puts "Found issues:\n #{issues}"
   puts "\nNow lets test some aggregation using OpenAI\n\n"
   openai_client = OpenAI::Client.new(access_token: openai_token)
-  example = "jeo-meven-plugin:
+  example = "some-repository-name-x:
   - Added 100 new files to the Dataset [#168]
   - Fixed the deployment of XYZ [#169]
   - Refined the requirements [#177]
-  opeo-maven-plugin:
+  some-repository-name-y:
   - Removed XYZ class [#57]
   - Refactored http module [#69]"
-  example_plans = "jeo-maven-plugin:
+  example_plans = "some-repository-name-x:
   - To publish ABC package draft [#27]
   - To review first draft of the report [#56]
-  opeo-maven-plugin:
+  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',
@@ -138,7 +144,7 @@ def generate
         { 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. 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}]" }
+          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
     }
@@ -151,25 +157,40 @@ def generate
         { 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. 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" }
+          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, Date.today)
+  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"
+    puts 'Print result to txy file'
     output = Txtout.new('.')
     output.print(full_answer, github_username)
   elsif output_mode.eql? 'html'
-    puts "Print result to html file"
+    puts 'Print result to html file'
     output = Htmlout.new('.')
     output.print(full_answer, github_username)
   else
-    puts "Print result to stdout"
+    puts 'Print result to stdout'
     output = Stdout.new
     output.print(full_answer)
   end

data/test/test_htmlout.rb CHANGED Viewed

@@ -25,16 +25,21 @@ require 'minitest/autorun'
 require_relative '../lib/newsman/html_output'
 class TestHtmlout < Minitest::Test
-  EXPECTED = "<!DOCTYPE html>
-<html lang=\"en\">
-<head>
-  <meta charset=\"UTF-8\">
-  <title>volodya-lombrozo #{Time.new.strftime('%d.%m.%Y')}</title>
-</head>
-<body>
+  EXPECTED = "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\">
+<html>
+  <head>
+    <title>volodya-lombrozo #{Time.new.strftime('%d.%m.%Y')}</title>
+  </head>
+  <body>
   <h1>volodya-lombrozo #{Time.new.strftime('%d.%m.%Y')}</h1>
   <p>Issue description</p>
+<p>Here is a new paragraph<br/>
+List is here:<br/>
+ - one<br/>
+ - two<br/>
+ - three</p>
 </body>
 </html>
 "
@@ -44,7 +49,8 @@ class TestHtmlout < Minitest::Test
       output = Htmlout.new(temp_dir)
       today = Date.today.strftime('%d.%m.%Y')
       expected = "#{today}.volodya-lombrozo.html"
-      output.print("Issue description", 'volodya-lombrozo')
+      output.print("Issue description\n\nHere is a new paragraph\nList is here:\n - one\n - two\n - three",
+                   'volodya-lombrozo')
       assert(File.exist?(File.join(temp_dir, expected)))
       assert_equal(EXPECTED, File.read(File.join(temp_dir, expected)))
     end

data/test/test_pdd_issue.rb CHANGED Viewed

@@ -26,22 +26,23 @@ require_relative '../lib/newsman/issues'
 class TestPddIssue < Minitest::Test
   TEST_BODY = "
-    The puzzle `531-462261de` from #531 has to be resolved:
+    The puzzle `531-462261de` from #531 has to be resolved:
     https://github.com/objectionary/jeo-maven-plugin/blob/5a42b2c9f7e0ff01cbb2c4626e1dc5dc3f8aa7b8/src/it/annotations/src/main/java/org/eolang/jeo/annotations/AnnotationsApplication.java#L32-L35
-    The puzzle was created by @volodya-lombrozo on 29-Mar-24.
+    The puzzle was created by @volodya-lombrozo on 29-Mar-24.
-    Estimate: 90 minutes,  role: DEV.
+    Estimate: 90 minutes,  role: DEV.
-    If you have any technical questions, don't ask me, submit new tickets instead. The task will be \"done\" when the problem is fixed and the text of the puzzle is _removed_ from the source code. Here is more about [PDD](http://www.yegor256.com/2009/03/04/pdd.html) and [about me](http://www.yegor256.com/2017/04/05/pdd-in-action.html).
+    If you have any technical questions, don't ask me, submit new tickets instead. The task will be \"done\" when the problem is fixed and the text of the puzzle is _removed_ from the source code. Here is more about [PDD](http://www.yegor256.com/2009/03/04/pdd.html) and [about me](http://www.yegor256.com/2017/04/05/pdd-in-action.html).
       "
-  EXPECTED_DESCRIPTION = "     * @todo #531:90min Check default values for annotation properties.\n", "     *  We still encounter some problems with annotation processing.\n", "     *  Especially with Autowired annotation from Spring Framework.\n", "     *  It's relatively simple annotation, but it's not processed correctly.\n", "     */\n"
+  EXPECTED_DESCRIPTION = ["     * @todo #531:90min Check default values for annotation properties.\n",
+                          "     *  We still encounter some problems with annotation processing.\n", "     *  Especially with Autowired annotation from Spring Framework.\n", "     *  It's relatively simple annotation, but it's not processed correctly.\n", "     */\n"].freeze
   def test_parses_pdd_issue
     issue = PddIssue.new('AnnotationsApplication.java:32-35: Check default values...',
-                         TEST_BODY,
+                         TEST_BODY,
                          'jeo-maven-plugin', 531)
     assert_equal(EXPECTED_DESCRIPTION, issue.extract_real_body)
   end

data/test/test_report.rb CHANGED Viewed

@@ -22,7 +22,7 @@
 # SOFTWARE.
 require 'minitest/autorun'
-require_relative '../lib/newsman/report.rb'
+require_relative '../lib/newsman/report'
 class TestReport < Minitest::Test
   def test_report
@@ -47,8 +47,8 @@ User
 Developer
 2024-03-14"
     report = Report.new('User', 'Developer', 'Project')
-    out = report.build("repository-a:\n - Did a lot of for (a) repository", "repository-b:\n - I will do a lot for repository (b)", Date.new(2024, 3, 14))
+    out = report.build("repository-a:\n - Did a lot of for (a) repository",
+                       "repository-b:\n - I will do a lot for repository (b)", '- <todo>', Date.new(2024, 3, 14))
     assert_equal expected, out
   end
 end

data/test/test_week_of_a_year.rb CHANGED Viewed

@@ -30,4 +30,3 @@ class TestWeekOfYear < Minitest::Test
     assert_equal 'WEEK 9 OPEO', week_of_a_year('OPEO', Date.new(2024, 2, 29))
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: newsman
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Volodya Lombrozo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -95,33 +123,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: ruby-openai
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: net-http
+  name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '6.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '6.3'
 description: A simple gem that gathers GitHub statistics and creates human-readable
   report
 email: