newsman 0.1.13 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b76df23c180a0cc0a30bdc4d60fd675ece0c5201605bcbdea44bd0a7d25bce
-  data.tar.gz: 72e37a051f065fcc3a625ba3175439b1351e28acc6e0b2cc33a352c3f5dda652
+  metadata.gz: c0ec4c08d224982a75fc3ae533368cdeff2c4d7cab0072441fcfbd604f194b42
+  data.tar.gz: 8633c4f4dc84b0f6a285e06b67b0cb9dd3f9e7a18d6dc032589237652181d36f
 SHA512:
-  metadata.gz: e66602a260c38095c76e367b8a84f52f1f16bc6a74b103e3b0c0e6e8690e8bea1d1d54b41ca97cc0c259c55b571485e788864b3f788251730759ffd19ce356ec
-  data.tar.gz: e4d0aef6d9a2958084402468adc84f2e24d8f7da507ea8a2dab7515f5855411f6e6a73e1969a4cc30f413e180eee2ceaab520c5addb7d59fa780090516dc7e76
+  metadata.gz: 85df6a743456154cdfcd2999a2f3a1977347cf9b101c8f2e35bd0b13024e6e1d66e8cf699bc7a11feac586f5b7bb6a2bdc08b75936bf967b011afdc2f1963716
+  data.tar.gz: e4aa02defb4c4a02dee05fe334fb799f0f10b825110e194e0f3d7e5da79ce54144e5a77d1543c57acbdc56ca444fa4be625f4e16a9c83487abc917711d0e771c

data/README.md

@@ -1,5 +1,9 @@
 # Newsman 
 
+
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE.txt)
+[![Gem Version](https://img.shields.io/gem/v/newsman.svg)](https://rubygems.org/gems/newsman)
+
 Newsman is a simple script that collects information about a developer's weekly activity on GitHub and creates a human-readable summary of the work done. To create the summary, Newsman asks ChatGPT to handle all the information about a developer's activity, including their pull requests and created issues.
 
 ## Install
@@ -31,7 +35,9 @@ Usage: newsman [options]
     -n, --name NAME                  Reporter name. Human readable name that will be used in a report
     -u, --username USERNAME          GitHub username. For example, 'volodya-lombrozo'
     -r, --repository REPOSITORIES    Specify which repositories to include in a report. You can specify several repositories using a comma separator, for example: '-r objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin'
-    -p, --position                   Reporter position in a company. Default value is a 'Software Developer'.
+    -p, --position POSITION          Reporter position in a company. Default value is a 'Software Developer'.
+    -o, --output OUTPUT              Output type. Newsman prints a report to a stdout by default. You can choose another options like '-o html', '-o txt' or even '-o html'
+    -t, --title TITLE                Project Title. Empty by default
 ```
 
 ### Example

data/lib/newsman/assistant.rb

@@ -0,0 +1,136 @@
+# 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 'openai'
+
+# This class mimics a robot that can analyse a developer activity.
+# The assistant uses OpenAI API to analyze.
+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
+    <<~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.
+    HELLO
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  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]"
+    prompt = <<~PROMPT
+      Please compile a summary of the plans for the next week using the GitHub Issues.
+      Each issue should be summarized in a single sentence.
+      Combine all the information from each Issue into a concise and fluent sentence.
+      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].
+      If several issues have the same number, combine them into a single sentence.
+      Please strictly adhere to the example template provided: "#{example}".
+      List of GitHub Issues in JSON format: ```json #{issues}```.
+    PROMPT
+    send(prompt)
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # rubocop:disable Metrics/MethodLength
+  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"
+    prompt = <<~PROMPT
+      Please compile a summary of the work completed in the following Pull Requests (PRs).
+      Each PR should be summarized in a single sentence, focusing on the PR title rather than the implementation details.
+      Ensure no PR is omitted.
+      Each sentence must include the corresponding issue number as an integer value. If a PR does not mention an issue number, use [#chore].
+      If several PRs have the same number, combine them into a single sentence.
+      Combine the information from each PR into a concise and fluent sentence.
+      Follow the provided example template strictly: "#{example}".
+      List of Pull Requests in JSON format: ```json #{prs}```.
+    PROMPT
+    send(prompt)
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # rubocop:disable Metrics/MethodLength
+  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"
+    prompt = <<~PROMPT
+      Please compile a summary of the risks identified in the repository from the list of pull requests provided.
+      If no risks are identified in a pull request, just answer 'No risks identified' for that PR.
+      Each risk should be summarized in a concise and fluent single sentence.
+      Developers usually mention some risks in pull request descriptions, either as 'risk' or 'issue'.#{' '}
+      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].
+      Please strictly adhere to the example template provided: "#{example}".
+      List of Pull Requests: ```json #{all}```.
+    PROMPT
+    send(prompt)
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  def format(report)
+    prompt = <<~PROMPT
+      I have a weekly report with different parts that use various formatting styles.
+      Please format the entire report into a single cohesive format while preserving the original text without any changes.
+      Ensure that the formatting is consistent throughout the document.
+
+      Here is the report:
+
+      #{report}
+    PROMPT
+    send(prompt)
+  end
+
+  def send(request)
+    @client.chat(
+      parameters: {
+        model: @model,
+        messages: [
+          { role: 'system', content: CONTEXT },
+          { role: 'user', content: request.to_s }
+        ],
+        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/github.rb

@@ -0,0 +1,80 @@
+#!/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.
+
+# This class represents a useful abstraction over Github API.
+class Github
+  def initialize(token)
+    @client = Octokit::Client.new(github_token: token)
+  end
+
+  def pull_requests(username, repositories)
+    query = "is:pr author:#{username} created:>=#{date_one_week_ago(Date.today)} #{repositories}"
+    puts "Searching pull requests for #{username}."
+    puts 'Newsman uses the following request to GitHub to gather the'\
+      " required information about user activity: '#{query}'"
+    @client.search_issues(query).items.map do |pull_request|
+      parse_pr(pull_request)
+    end
+  end
+
+  def issues(username, repositories)
+    one_month_ago = Date.today.prev_month.strftime('%Y-%m-%d')
+    query = "is:issue is:open author:#{username}"\
+      " author:0pdd created:>=#{one_month_ago} #{repositories}"
+    puts "Searching issues using the following query: '#{query}'"
+    @client.search_issues(query).items.map do |issue|
+      parse_issue(issue)
+    end.select(&:important?)
+  end
+
+  def parse_pr(pull_request)
+    title = pull_request.title.to_s
+    repository = pull_request.repository_url.split('/').last
+    puts "Found PR in #{repository}: #{title}"
+    PullRequest.new(repository, title, pull_request.body.to_s, url: pull_request.html_url)
+  end
+
+  def parse_issue(issue)
+    title, repository, number = issue_details(issue)
+    if issue.user.login == '0pdd'
+      PddIssue.new(title, issue.body.to_s, repository, number, url: issue.html_url, labels: issue.labels.map(&:name))
+    else
+      Issue.new(title, issue.body.to_s, repository, number, url: issue.html_url, labels: issue.labels.map(&:name))
+    end
+  end
+
+  def issue_details(issue)
+    title = issue.title.to_s
+    repository = issue.repository_url.split('/').last
+    number = issue.number.to_s
+    puts "Found issue in #{repository}:[##{number}] #{title}"
+    [title, repository, number]
+  end
+end
+
+def date_one_week_ago(today)
+  today = Date.parse(today) unless today.is_a?(Date)
+  one_week_ago = today - 7
+  one_week_ago.strftime('%Y-%m-%d')
+end

data/lib/newsman/html_output.rb

@@ -1,40 +1,57 @@
 # 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 'erb'
 require 'redcarpet'
 require 'nokogiri'
-# frozen_string_literal: true
 
+# This class represents a report output in HTML format.
 class Htmlout
-  TEMPLATE = "
-<head>
-  <title><%= title %></title>
-</head>
-<body>
-  <h1><%= title %></h1>
-  <%= body %>
-</body>
-"
+  TEMPLATE = <<~HTML
+    <head>
+      <title><%= title %></title>
+    </head>
+    <body>
+      <h1><%= title %></h1>
+      <%= body %>
+    </body>
+  HTML
 
   def initialize(root = '.')
     @root = root
   end
 
+  # rubocop:disable Metrics/AbcSize
   def print(report, reporter)
     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)
+    body = to_html(report)
     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 Nokogiri::HTML(ERB.new(TEMPLATE).result(binding), &:noblanks).to_xhtml(indent: 2)
     puts "Report was successfully printed to a #{file.path}"
     file.close
   end
+  # rubocop:enable Metrics/AbcSize
 
   def title(reporter)
     date = Time.new.strftime('%d.%m.%Y')
@@ -45,4 +62,12 @@ class Htmlout
     date = Time.new.strftime('%d.%m.%Y')
     "#{date}.#{reporter}.html"
   end
+
+  def to_html(report)
+    Redcarpet::Markdown.new(
+      Redcarpet::Render::HTML.new(no_links: true, hard_wrap: true, prettify: true),
+      autolink: true,
+      tables: true
+    ).render(report)
+  end
 end

data/lib/newsman/issues.rb

@@ -1,37 +1,89 @@
 # 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 'net/http'
-# frozen_string_literal: true
+require 'json'
 
+# This class represents a GitHub Issue abstraction created by a user.
 class Issue
   attr_accessor :title, :body, :repo, :number
-  attr_reader :url
 
-  def initialize(title, body, repo, number, url: 'undefined')
+  def initialize(title, body, repo, number, **additional)
+    defaults = { url: 'undefined', labels: [] }
     @title = title
     @body = body
     @repo = repo
     @number = number
-    @url = url
+    @additional = defaults.merge(additional)
   end
 
   def to_s
-    "title: ```#{@title}```,\ndescription: ```#{@body}```,\nrepo: ```#{@repo}```,\nissue number: \##{@number}\n"
+    <<~MARKDOWN
+      title: ```#{@title}```,
+      description: ```#{@body}```,
+      repo: ```#{@repo}```,
+      issue number: \##{@number},
+      additional: #{@additional}
+    MARKDOWN
+  end
+
+  def detailed_title
+    "title: #{@title}, repo: #{@repo}, number: \##{@number}, url: #{url}, labels: #{labels}"
   end
 
-  def detailed_title 
-    "title: #{@title}, repo: #{@repo}, number: \##{@number}, url: #{@url}"
+  def url
+    @additional[:url]
+  end
+
+  def labels
+    @additional[:labels]
+  end
+
+  def to_json(*_args)
+    {
+      number: @number,
+      title: @title,
+      description: @body,
+      repository: @repo,
+      url: url.to_s
+    }.to_json
+  end
+
+  def important?
+    labels.include? 'soon'
   end
-    
 end
 
+# This class represents a GitHub issue abstraction created by a 0pdd robot.
 class PddIssue
-  def initialize(title, body, repo, number, url: 'undefined')
+  attr_accessor :repo
+
+  def initialize(title, body, repo, number, **additional)
+    defaults = { url: 'undefined', labels: [] }
     @title = title
     @body = body
     @repo = repo
     @number = number
-    @url = url 
+    @additional = defaults.merge(additional)
   end
 
   def extract_real_body
@@ -42,17 +94,44 @@ class PddIssue
   end
 
   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/', ''
-    )
+    @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"
+    <<~MARKDOWN
+      title: ```#{@title}```,
+      description: ```#{extract_real_body}```,
+      repo: ```#{@repo}```,
+      issue number: \##{@number},
+      additional: #{@additional}
+    MARKDOWN
   end
 
   def detailed_title
-    "title: #{@title}, repo: #{@repo}, issue number: \##{@number}, url: #{@url}"
+    "title: #{@title}, repo: #{@repo}, issue number: \##{@number}, url: #{url}, labels: #{labels}"
   end
 
+  def to_json(*_args)
+    {
+      number: @number,
+      title: @title,
+      description: @body,
+      repository: @repo,
+      url: url.to_s
+    }.to_json
+  end
+
+  def important?
+    labels.include? 'soon'
+  end
+
+  def url
+    @additional[:url]
+  end
+
+  def labels
+    @additional[:labels]
+  end
 end

data/lib/newsman/pull_request.rb

@@ -1,5 +1,28 @@
 # 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 'json'
+
+# This class represents GitHub Pull Request abstraction.
+# In the future, it might be any Pull or Merge request.
 class PullRequest
   attr_accessor :repository, :title, :description
   attr_reader :url
@@ -11,6 +34,15 @@ class PullRequest
     @url = url
   end
 
+  def to_json(*_args)
+    {
+      title: @title,
+      description: @description,
+      repository: @repository,
+      url: @url
+    }.to_json
+  end
+
   def to_s
     "title: ```#{@title}```,\ndescription: ```#{@description}```,\nrepo: ```#{@repository}```\n"
   end
@@ -18,5 +50,4 @@ class PullRequest
   def detailed_title
     "title: #{@title}, repo: #{@repository}, url: #{@url}"
   end
-
 end

data/lib/newsman/report.rb

@@ -1,8 +1,29 @@
 #!/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.
+
+# This class builds entire report based on issues and pull requests passed.
 class Report
-  def initialize(user, position, title, additional: ReportItems.new([],[]))
+  def initialize(user, position, title, additional: ReportItems.new([], []))
     @user = user
     @position = position
     @title = title
@@ -10,14 +31,30 @@ class Report
   end
 
   def build(achievements, plans, risks, date)
-    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;
+    <<~TEMPLATE
+      From: #{@user}
+      Subject: #{week_of_a_year(@title, date)}
+
+      Hi all,
+
+      Last week achievements:
+      #{achievements}
+
+      Next week plans:
+      #{plans}
+
+      Risks:
+      #{risks}
+
+      Best regards,
+      #{@user}
+      #{@position}
+      #{date}
+    TEMPLATE
+  end
+
+  def append_additional(report)
+    "#{report}\n#{"------\n#{@additional}" unless @additional.empty?}"
   end
 end
 
@@ -26,9 +63,8 @@ def week_of_a_year(project, today)
   "WEEK #{number} #{project}"
 end
 
-
+# Report items inner class.
 class ReportItems
-  
   def initialize(prs, issues)
     @prs = prs || []
     @issues = issues || []
@@ -41,7 +77,7 @@ class ReportItems
 
   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}"
+    issues_list = @issues.map(&:detailed_title).map { |obj| " - #{obj}\n" }.join
+    "Closed Pull Requests:\n#{prs_list}\nOpen Issues:\n#{issues_list}"
   end
 end

data/lib/newsman/stdout_output.rb

@@ -1,5 +1,27 @@
 # 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.
+
+# This class prints report to a console.
 class Stdout
   def print(report)
     puts 'Print a report to stdout'

data/lib/newsman/txt_output.rb

@@ -1,5 +1,26 @@
 # 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.
+
+# This class knows how to print a report to a separate file.
 class Txtout
   def initialize(root = '.')
     @root = root