newsman 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c6eaa01ebc8b603b13a1bb158e8a491ed2c51df32d973d56e9e99d959db7d4a
-  data.tar.gz: be86c2c47cc64f2da87a04127cf879a8ccabfff8fa9557730e6f3031a225efdb
+  metadata.gz: 28993b9f11754759d159a42a76b5979bec9c12980098de771abd5442fc124ccd
+  data.tar.gz: 1e98570b8d3b0cb9b0694472e5fefa7fe780ce6434efa12cd231dfa86a31c885
 SHA512:
-  metadata.gz: b2b8972c04260e5c588015270b0e192c47bc39cc72c52124b200b5150b16be0e0d149ebb85d890ebcf2e21d98168b220c49953e769b852a62f6d9e18af627a5c
-  data.tar.gz: 12b435a44fb9687e9904f436f8b7203927856be57d1933045ca5fefbbe9d076346869962abd884c71e9bd6c2674daa1f9334186a90a84a79d2baa9b0c47d02a8
+  metadata.gz: a807c540f352124e1a89d485cccfb2f0cf6ff36300b42d57ebb591b5e3e4b03d12413325f69a75d7f99e309c0813d336b1c3e32bb71012e22dd1093129cee5a6
+  data.tar.gz: 81a635a5caba68596e9c3acd7a242fbf597da0cb06ce87c2103cdab84c1e2e89ef59ec9812e997ff970a0484a16ace406415a83b8c642f6db8ff0f82e571c111

data/README.md

@@ -62,7 +62,7 @@ Usage: newsman [options]
     -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 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'
+    -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 '-o docx'. The 'html' output also generates a downloadable '.docx' copy (Times New Roman, 12pt) and links it from the page.
     -t, --title TITLE                Project Title. Empty by default
     -m, --model MODEL                AI model to use. gpt-3.5-turbo by default
 ```

data/lib/newsman/docx_output.rb

@@ -0,0 +1,94 @@
+# 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 'zip'
+require 'cgi'
+
+# This class represents a report output in DOCX (MS Word) format.
+# It builds a minimal, valid OOXML package by hand (no external docx-builder
+# gem), so every run of text is explicitly styled with Times New Roman, 12pt.
+class Docxout
+  # Content types part, required by every OOXML package.
+  CONTENT_TYPES = <<~XML
+    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+    <Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types"><Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/><Default Extension="xml" ContentType="application/xml"/><Override PartName="/word/document.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"/></Types>
+  XML
+
+  # Package-level relationships, pointing at the main document part.
+  RELS = <<~XML
+    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+    <Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="word/document.xml"/></Relationships>
+  XML
+
+  FONT = 'Times New Roman'
+  # Word expresses font size in half-points, so 12pt is 24.
+  SIZE = '24'
+
+  def initialize(root = '.')
+    @root = root
+  end
+
+  def print(report, reporter, model)
+    puts "Create a docx file in a directory #{@root}"
+    path = File.join(@root, filename(reporter, model))
+    Zip::File.open(path, create: true) do |zip|
+      zip.get_output_stream('[Content_Types].xml') { |f| f.write(CONTENT_TYPES) }
+      zip.get_output_stream('_rels/.rels') { |f| f.write(RELS) }
+      zip.get_output_stream('word/document.xml') { |f| f.write(document_xml(report)) }
+    end
+    puts "Report was successfully printed to a #{path}"
+    File.basename(path)
+  end
+
+  def filename(reporter, model)
+    date = Time.new.strftime('%d.%m.%Y')
+    model = model.gsub('.', '-')
+    "#{date}.#{reporter}.#{model}.docx"
+  end
+
+  private
+
+  def document_xml(report)
+    body = paragraphs(report).map { |lines| paragraph_xml(lines) }.join
+    <<~XML
+      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+      <w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"><w:body>#{body}<w:sectPr/></w:body></w:document>
+    XML
+  end
+
+  def paragraphs(report)
+    report.to_s.split(/\n{2,}/).map { |paragraph| paragraph.split("\n") }
+  end
+
+  def paragraph_xml(lines)
+    runs = lines.each_with_index.map do |line, index|
+      "#{run_xml(line)}#{'<w:r><w:br/></w:r>' if index < lines.size - 1}"
+    end.join
+    "<w:p>#{runs}</w:p>"
+  end
+
+  def run_xml(line)
+    "<w:r><w:rPr><w:rFonts w:ascii=\"#{FONT}\" w:hAnsi=\"#{FONT}\" w:cs=\"#{FONT}\"/>" \
+      "<w:sz w:val=\"#{SIZE}\"/><w:szCs w:val=\"#{SIZE}\"/></w:rPr>" \
+      "<w:t xml:space=\"preserve\">#{CGI.escapeHTML(line)}</w:t></w:r>"
+  end
+end

data/lib/newsman/html_output.rb

@@ -23,6 +23,7 @@
 require 'erb'
 require 'redcarpet'
 require 'nokogiri'
+require_relative 'docx_output'
 
 # This class represents a report output in HTML format.
 class Htmlout
@@ -32,6 +33,7 @@ class Htmlout
     </head>
     <body>
       <h1><%= title %></h1>
+      <p><a href="<%= docx %>">Download as Word (.docx)</a></p>
       <%= body %>
     </body>
   HTML
@@ -44,6 +46,7 @@ class Htmlout
   def print(report, reporter, model)
     title = title(reporter)
     body = to_html(report)
+    docx = Docxout.new(@root).print(report, reporter, model)
     puts "Create a html file in a directory #{@root}"
     file = File.new(File.join(@root, filename(reporter, model)), 'w')
     puts "File #{file.path} was successfully created"

data/lib/newsman.rb

@@ -31,6 +31,7 @@ require_relative 'newsman/issues'
 require_relative 'newsman/stdout_output'
 require_relative 'newsman/txt_output'
 require_relative 'newsman/html_output'
+require_relative 'newsman/docx_output'
 require_relative 'newsman/report'
 require_relative 'newsman/assistant'
 require_relative 'newsman/github'
@@ -60,7 +61,7 @@ def generate
     end
     opts.on('-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'") do |o|
+            "You can choose another options like '-o html', '-o txt' or '-o docx'") do |o|
       options[:output] = o
     end
     opts.on('-t', '--title TITLE', 'Project Title. Empty by default') { |t| options[:title] = t }
@@ -128,14 +129,19 @@ def generate
   full_answer = report.append_additional(full_answer)
   output_mode = options[:output]
   puts "Output mode is '#{output_mode}'"
-  if output_mode.eql? 'txt'
+  case output_mode
+  when 'txt'
     puts 'Print result to a txt file'
     output = Txtout.new('.')
     output.print(full_answer, github_username)
-  elsif output_mode.eql? 'html'
+  when 'html'
     puts 'Print result to a html file'
     output = Htmlout.new('.')
     output.print(full_answer, github_username, options[:model])
+  when 'docx'
+    puts 'Print result to a docx file'
+    output = Docxout.new('.')
+    output.print(full_answer, github_username, options[:model])
   else
     puts 'Print result to a stdout'
     output = Stdout.new

data/test/test_docxout.rb

@@ -0,0 +1,53 @@
+#!/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 'date'
+require 'zip'
+require_relative '../lib/newsman/docx_output'
+
+class TestDocxout < Minitest::Test
+  def test_writes_to_a_docx_file
+    Dir.mktmpdir do |temp_dir|
+      output = Docxout.new(temp_dir)
+      today = Date.today.strftime('%d.%m.%Y')
+      expected = "#{today}.volodya-lombrozo.gpt-3-5-turbo.docx"
+      returned = output.print("Issue description\n\nHere is a new paragraph\nList is here:\n - one\n - two\n - three",
+                              'volodya-lombrozo',
+                              'gpt-3.5-turbo')
+      assert_equal(expected, returned)
+      assert(File.exist?(File.join(temp_dir, expected)))
+    end
+  end
+
+  def test_docx_uses_times_new_roman_12pt
+    Dir.mktmpdir do |temp_dir|
+      output = Docxout.new(temp_dir)
+      path = File.join(temp_dir, output.print('Issue description', 'volodya-lombrozo', 'gpt-3.5-turbo'))
+      document_xml = Zip::File.open(path) { |zip| zip.read('word/document.xml') }
+      assert_includes(document_xml, 'w:ascii="Times New Roman"')
+      assert_includes(document_xml, '<w:sz w:val="24"/>')
+      assert_includes(document_xml, 'Issue description')
+    end
+  end
+end

data/test/test_htmlout.rb

@@ -22,6 +22,7 @@
 # SOFTWARE.
 
 require 'minitest/autorun'
+require 'date'
 require_relative '../lib/newsman/html_output'
 
 class TestHtmlout < Minitest::Test
@@ -32,6 +33,7 @@ class TestHtmlout < Minitest::Test
   </head>
   <body>
   <h1>volodya-lombrozo #{Time.new.strftime('%d.%m.%Y')}</h1>
+  <p><a href=\"#{Time.new.strftime('%d.%m.%Y')}.volodya-lombrozo.gpt-3-5-turbo.docx\">Download as Word (.docx)</a></p>
   <p>Issue description</p>
 
 <p>Here is a new paragraph<br/>
@@ -56,4 +58,14 @@ List is here:<br/>
       assert_equal(EXPECTED, File.read(File.join(temp_dir, expected)))
     end
   end
+
+  def test_also_writes_a_docx_file
+    Dir.mktmpdir do |temp_dir|
+      output = Htmlout.new(temp_dir)
+      today = Date.today.strftime('%d.%m.%Y')
+      expected = "#{today}.volodya-lombrozo.gpt-3-5-turbo.docx"
+      output.print('Issue description', 'volodya-lombrozo', 'gpt-3.5-turbo')
+      assert(File.exist?(File.join(temp_dir, expected)))
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: newsman
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Volodya Lombrozo
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -164,6 +163,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: A simple gem that gathers GitHub statistics and creates human-readable
   report
 email:
@@ -178,6 +191,7 @@ files:
 - bin/newsman
 - lib/newsman.rb
 - lib/newsman/assistant.rb
+- lib/newsman/docx_output.rb
 - lib/newsman/github.rb
 - lib/newsman/html_output.rb
 - lib/newsman/issues.rb
@@ -186,6 +200,7 @@ files:
 - lib/newsman/stdout_output.rb
 - lib/newsman/txt_output.rb
 - test/test_assistant.rb
+- test/test_docxout.rb
 - test/test_htmlout.rb
 - test/test_issue.rb
 - test/test_pdd_issue.rb
@@ -198,7 +213,6 @@ homepage: https://github.com/volodya-lombrozo/newsman
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -214,8 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key: 
+rubygems_version: 4.0.16
 specification_version: 4
 summary: GitHub user weekly news
 test_files: []