newsman 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbdbadb8ae1727aa56b52deae928ceb16d0068d9b0190ac2672a75a98c669231
-  data.tar.gz: 5b0487e709dd265cfcfe39ffadab3ac1bff14fd0e94ad547fb49aa56567e317d
+  metadata.gz: a4c62dd4456a16613a0e0d56216eddc8ab292ce140ba3392efea52a1e60eb582
+  data.tar.gz: 979d40aba31400af7600f11561d2b0b143b2b6948d9c5489b95f6aebb60beeb7
 SHA512:
-  metadata.gz: 749af2c2ce1a20006ad4ba4373c2d53f0f52c604c8f9801acb87f6f2cd6bd421d79690e643e46b5c97fad09a80a7ea75e41db8e6e4523da689c07025d0e0b059
-  data.tar.gz: 68e39b6efe454c926b8164e4c3c7e7fe6682c6086f80b0a579a84cc3116df2f424c2bad1f8572d2466bf07f8fc6c3b703c9325fa295eba028b229935c53535b9
+  metadata.gz: 0663b8583dbc3aade358d1fbe4087aab6cb092892b347936ab415fb729dab781fdfdb3164c72ec48b64767b781d4a9f46f58c7e2cb072e4fc0a1d1b80ee0c89e
+  data.tar.gz: af4e35da01996ff3495e8e052d9692ac5582b65e981da51b4bd4594158cb255af9bf8cd38a88e85cc508401e7ac8574cb9701c150c7a72328947be109d26b9dc

data/README.md

@@ -2,6 +2,14 @@
 
 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
+
+To install [newsman](https://rubygems.org/gems/newsman) from RubyGems.org use the following command:
+```shell
+gem install newsman
+```
+The newest version of newsman will be installed on your system.
+
 ## How to Use
 
 To use newsman, you need to perfom several actions. 
@@ -27,13 +35,16 @@ Usage: newsman [options]
 ```
 
 ### Example
-
-You can download this repository and run the newsman script directly using the following command:
+To run `newsman` use the following command:
 ```shell
-./bin/newsman --name "Vladimir Zakharov" --username "volodya-lombrozo" --repository objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin
+newsman --name "Vladimir Zakharov" --username "volodya-lombrozo" --repository objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin
 ```
 
 Don't forget to set your own values for `name`, `username` and `repository` parameters.
+Also you can download this repository and run the newsman script directly using the following command:
+```shell
+./bin/newsman --name "Vladimir Zakharov" --username "volodya-lombrozo" --repository objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin
+```
 
 ## How to build a gem from sources
 

data/lib/newsman/stdout_output.rb

@@ -0,0 +1,6 @@
+class Stdout
+  def print(report)
+    puts "Print a report to stdout"
+    puts report
+  end
+end

data/lib/newsman/txt_output.rb

@@ -0,0 +1,17 @@
+class Txtout
+  def initialize(root=".")
+    @root=root
+  end
+  def print(report, reporter)
+    puts "Create a file in a directory #{@root}"
+    file = File.new(File.join(@root, filename(reporter)), "w")
+    puts "File #{file.path} was successfully created"
+    file.puts report
+    puts "Report was successfully printed to a #{file.path}"
+    file.close
+  end
+  def filename(reporter)
+    date = Time.new.strftime('%d.%m.%Y')
+    "#{date}.#{reporter}.txt"    
+  end
+end

data/lib/newsman.rb

@@ -5,6 +5,8 @@ require 'openai'
 require 'dotenv'
 require 'optparse'
 require_relative 'newsman/pull_request.rb'
+require_relative 'newsman/stdout_output.rb'
+require_relative 'newsman/txt_output.rb'
 
 def generate
   # Load all options required
@@ -21,9 +23,12 @@ def generate
     opts.on("-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'") do |r|
       options[:repositories] = r
     end
-    opts.on("-p", "--position", "Reporter position in a company. Default value is a 'Software Developer'.") do |p|
+    opts.on("-p", "--position POSITION", "Reporter position in a company. Default value is a 'Software Developer'.") do |p|
       options[:position] = p
     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' or '-o txt'") do |o|
+      options[:output] = o
+    end
   end.parse!
   # Custom method to raise exception with a human-readable message
   def options.require_option(key, message)
@@ -35,6 +40,7 @@ def generate
   options.require_option(:username, "GitHub username is required. Please specify using -u or --username.")
   options.require_option(:repositories, "GitHub repository is required. Please specify one or several repositories using -r or --repositories.")
   options[:position] ||= "Software Developer"
+  options[:output] ||= "stdout"
   all_params = options.map { |key, value| "#{key}: #{value}" }.join(", ")
   puts "Parsed parameters: #{all_params}"
 
@@ -113,7 +119,14 @@ response = openai_client.chat(
         ],
         temperature: 0.3,
     })
-puts response.dig("choices", 0, "message", "content")
+  output_mode = options[:output]
+  puts "Output mode is '#{output_mode}'"
+  if output_mode.eql? "txt"
+    output = Txtout.new(".", github_username)
+  else
+    output = Stdout.new
+  end
+  output.print(response.dig("choices", 0, "message", "content"))
 end
 
 

data/test/test_txtout.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# 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/txt_output.rb'
+
+class TestTxtout < Minitest::Test
+  def test_writes_to_a_file
+    Dir.mktmpdir do |temp_dir| 
+      output = Txtout.new(temp_dir)
+      expected = '17.03.2024.volodya-lombrozo.txt'
+      output.print("496", "volodya-lombrozo")
+      assert(File.exist?(File.join(temp_dir, expected)))
+      assert_equal("496\n", File.read(File.join(temp_dir, expected)))
+    end
+  end
+end

data/test/{newsman/test_week_before.rb → test_week_before.rb}

@@ -20,7 +20,7 @@
 # SOFTWARE.
 
 require 'minitest/autorun'
-require_relative '../../lib/newsman/newsman.rb'
+require_relative '../lib/newsman.rb'
 
 class TestDateOneWeekAgo < Minitest::Test
   def test_date_one_week_ago

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: newsman
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Volodya Lombrozo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-12 00:00:00.000000000 Z
+date: 2024-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 description: A simple gem that gathers GitHub statistics and creates human-readable
   report
 email:
@@ -38,7 +94,10 @@ files:
 - bin/newsman
 - lib/newsman.rb
 - lib/newsman/pull_request.rb
-- test/newsman/test_week_before.rb
+- lib/newsman/stdout_output.rb
+- lib/newsman/txt_output.rb
+- test/test_txtout.rb
+- test/test_week_before.rb
 homepage: https://github.com/volodya-lombrozo/newsman
 licenses:
 - MIT