jekyll_asciidoctor_pdf 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c7baeda17a015c813d1081ac35e2241af1f6fd722af24a2bbfd45a5067737d5
-  data.tar.gz: 8e0a31816601b5241e1fb0f95945af92853d9b9fbcea4ac077e767174f01bf02
+  metadata.gz: b29afdc7f4b9576e8bd9a63f147add555327c85d5c11ead433b0144dada30efa
+  data.tar.gz: 1d99eb123d43e9c41642ca629d968d02a6ffe2a977eb70352ba3f2f6218f0c97
 SHA512:
-  metadata.gz: 8e43bc13d66a6b2513e76f7fe731b9b9a607dd0db369f9f63e0229c228d9bd8adbaa34d4d9c5a9bd1d687dc54e768ea04bea74ad02a690fd873052f27b11b9dd
-  data.tar.gz: a332b9b64a1ae676252cd75d0863244c7afae34c75db5801bc7b0d3f4de55eed06aa81475344c83d65a40eccb6669e39aa0c16870d77944202d84e8fe8225888
+  metadata.gz: bd1a561f9f3b6a8498687b395871a7e78b4e5025e5e7fc28e10d3d18eb7c04d2566d6c2811ba81dd3f9594b7d41580a673fcd2a4668d1466af3cefc6258f55c7
+  data.tar.gz: b660f73123430215b6a576677609da1167cec6606ae600767a4a02825c5c262a09f42e622629b3808da8cfa17a16f18fe07b2632c0479f5325aacd3c9daaa1dc

data/README.adoc

@@ -2,7 +2,7 @@
 :gem-name: jekyll_asciidoctor_pdf
 :gh-branch: master
 :badge-style: flat
-:release-version: 0.1.2
+:release-version: 0.3.0
 
 image:https://img.shields.io/gem/v/{gem-name}.svg?style={badge-style}[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
 image:https://travis-ci.com/NetAppDocs/jekyll-asciidoctor-pdf.svg?token=jmKxRqiJdAgY6ceg7i2d&branch=master["Build Status", link="https://travis-ci.com/NetAppDocs/jekyll-asciidoctor-pdf"]
@@ -43,7 +43,9 @@ require 'rake_jekyll_asciidoctor_pdf'
   
 RakeJekyllAsciidoctorPdf::BuildTask.new('buildAll') do |t|
   t.jekyll_config_file = '_config.yml'
-  t.fullsite_title = ENV['PRODUCT_NAME']
+  t.product_name = ENV['PRODUCT_NAME']
+  t.repo_name = ENV['REPO_NAME']
+  t.git_token = ENV['GH_API_TOKEN']
 end
 ----
 
@@ -124,7 +126,7 @@ A complex directory structure could be like this
  * Gif files need prawn-gmagick
  * Absolute URL not supported in the sidebar.yml
  * Problems with image labels like that
- * Problems with interal *links:*
+ * Problems with internal *links:*
  * Unicode characters are not supported by AsciiDocPdf (e.i. ✓)
  
 [source,asciidoc]
@@ -144,6 +146,9 @@ image:diagram_networking_cloud.png["service, a"]
  * [x] Generate a PDF for each section
  * [ ] Support multiple sidebar.yml like HCI (Partial)
  * [x] Support basic recursion over directories
+ * [x] Add Copyright page 
+ * [x] Support remote authors information with GitHub API
+
  
  
  

data/jekyll_asciidoctor_pdf.gemspec

@@ -43,6 +43,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rake', '>= 10.0'
   spec.add_runtime_dependency 'fileutils', '>= 1.1'
   spec.add_runtime_dependency 'safe_yaml', '>= 1.0.5'
+  spec.add_runtime_dependency 'json', '>= 2.1.0'
+  spec.add_runtime_dependency 'rest-client', '>= 2.0.0'
   spec.add_runtime_dependency 'asciidoctor-pdf', '>= 1.5.1'
 
 end

data/lib/jekyll_asciidoctor_pdf/adoc.rb

@@ -25,7 +25,7 @@ module JekyllAsciidoctorPdf
         #  - Execute the convert process 
         #  - Let the caller to collect information from the front_matter and from the file itself
         #
-        def self.generatePdf(product_name, file, output_path, parameters, cover_page, theme_pdf, revision)
+        def self.generatePdf(product_name, file, output_path, parameters, cover_page, theme_pdf, revision, authors)
 
             front_matter = {}
 
@@ -44,7 +44,7 @@ module JekyllAsciidoctorPdf
             filename = File.basename(file,'.*') + '.pdf'
             filename_path = output_path
             base_path = File.dirname(file)
-            authors = getAuthorsList(file)
+            #authors = getAuthorsList(file)
 
             generateBookTypePdf(filename, filename_path, product_name, title, base_path, stream_adoc, parameters, cover_page, theme_pdf, revision, authors)
 
@@ -95,6 +95,8 @@ module JekyllAsciidoctorPdf
         # TODO: Add more configuracion
         #
         def self.getFullsiteTemplate(title, product_name, fullsite, parameters, cover_page, theme_pdf, revision, authors)
+
+            copyright = getCopyright()
             fullsite_config = parameters['fullsite']
 
             if (authors.nil?)
@@ -135,6 +137,54 @@ module JekyllAsciidoctorPdf
                     :leveloffset: +1
                     #{fullsite}
                     :leveloffset: -1
+                    #{copyright}
+            TEXT
+
+            return text
+        end
+
+        def self.getCopyright()
+            text = <<~TEXT
+                <<<
+                *Copyright Information*
+
+                Copyright © 2019–2020 NetApp, Inc. All rights reserved. Printed in the U.S. No part of this document
+                covered by copyright may be reproduced in any form or by any means-graphic, electronic, or
+                mechanical, including photocopying, recording, taping, or storage in an electronic retrieval system-
+                without prior written permission of the copyright owner.
+
+                Software derived from copyrighted NetApp material is subject to the following license and disclaimer:
+
+                THIS SOFTWARE IS PROVIDED BY NETAPP “AS IS” AND WITHOUT ANY EXPRESS OR IMPLIED
+                WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+                MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WHICH ARE HEREBY
+                DISCLAIMED. IN NO EVENT SHALL NETAPP BE LIABLE FOR ANY DIRECT, INDIRECT,
+                INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+                LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+                PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+                LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+                OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+                THE POSSIBILITY OF SUCH DAMAGE.
+
+                NetApp reserves the right to change any products described herein at any time, and without notice.
+                NetApp assumes no responsibility or liability arising from the use of products described herein, 
+                except as expressly agreed to in writing by NetApp. The use or purchase of this product does not 
+                convey a license under any patent rights, trademark rights, or any other intellectual property 
+                rights of NetApp.
+
+                The product described in this manual may be protected by one or more U.S. patents, 
+                foreign patents, or pending applications.
+
+                RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the government is subject to
+                restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and 
+                Computer Software clause at DFARS 252.277-7103 (October 1988) and FAR 52-227-19 (June 1987).
+
+                *Trademark Information*
+
+
+                NETAPP, the NETAPP logo, and the marks listed at http://www.netapp.com/TM are trademarks of
+                NetApp, Inc. Other company and product names may be trademarks of their respective owners.
+
             TEXT
 
             return text

data/lib/jekyll_asciidoctor_pdf/commands.rb

@@ -7,6 +7,7 @@ require 'fileutils'
 require 'asciidoctor-pdf'
 require 'asciidoctor'
 require 'jekyll_asciidoctor_pdf/adoc'
+require 'jekyll_asciidoctor_pdf/gitinfo'
 require 'jekyll_asciidoctor_pdf/logger'
 require 'jekyll_asciidoctor_pdf/sidebar'
 require 'jekyll_asciidoctor_pdf/permalink'
@@ -65,12 +66,15 @@ module JekyllAsciidoctorPdf
 
         attr_reader :absolute_cover_page
         attr_reader :absolute_theme_pdf
+        attr_reader :git_info
 
         attr_reader :quiet
 
         callable_attr :jekyll_config_file, '_config.yml'
 
         callable_attr :product_name, 'NetApp'
+        callable_attr :repo_name, ''
+        callable_attr :git_token, ''
 
 
         ##
@@ -87,6 +91,7 @@ module JekyllAsciidoctorPdf
 
             yield self if block_given?
 
+            @git_info    = GitInfo.new(git_token, repo_name)
             @absolute_config_file  = File.join(@absolute_working_path, jekyll_config_file);
 
             do_jekyll_config_ok? do |t|
@@ -244,8 +249,9 @@ module JekyllAsciidoctorPdf
                 output_path = File.join(pdf_pages,File.dirname(file))
                 mkdir_p_if_not_exist(output_path)
 
-                
-                JekyllAsciidoctorPdf::ADoc.generatePdf(product_name, file, output_path, parameters, absolute_cover_page, absolute_theme_pdf, last_modified_at ) do |front_matter, stream_adoc|
+                authors = git_info.getAuthorsList(file)
+
+                JekyllAsciidoctorPdf::ADoc.generatePdf(product_name, file, output_path, parameters, absolute_cover_page, absolute_theme_pdf, last_modified_at, authors ) do |front_matter, stream_adoc|
                     if front_matter.key?('permalink')  
                         name = File.join('/', front_matter['permalink'])
                         data = PermalinkData.new(front_matter['sidebar'], stream_adoc, file, last_modified_at)

data/lib/jekyll_asciidoctor_pdf/gitinfo.rb

@@ -0,0 +1,142 @@
+require 'json'
+require 'rest-client'
+
+module JekyllAsciidoctorPdf
+
+    ##
+    # Abstract structure for a hash dictionary
+    #
+    # We use to create a dictionary of all github users to avoid multiple requests
+    #
+    class Gituser
+        attr_reader :username, :name
+        def initialize(username, name)
+            @username = username
+            @name = name 
+        end
+    end
+
+    class GitInfo
+        attr_accessor :authors_hash
+        attr_accessor :remote
+        def initialize(token, repo)
+            @authors_hash = Hash.new
+            @token        = token
+            @repo         = repo
+            if (token.empty? || token.nil?) 
+                @remote = false
+            else
+                @remote = true
+            end
+        end
+
+
+        ##
+        # Get the real user name or return the login name
+        #
+        # Avoid unexpected terminations / Best Effort approach
+        #
+        def getRealUser(login_name)
+            headers = {Authorization: "token #{@token}"}
+            uri = "https://api.github.com/users/#{login_name.to_s}"
+        
+            if authors_hash.key?(login_name) 
+                return authors_hash[login_name]
+            end
+            begin
+                response = RestClient.get(uri, headers)
+                if response.code == 200
+                    userResponse = response.body
+                    unless userResponse.nil? || userResponse.empty?
+                        hash = JSON.parse(userResponse)
+                        if (hash.key?('name'))
+                            authors_hash[login_name] = hash['name']
+                            return hash['name']
+                        end
+                    end
+                else
+                    puts "Error Code: #{response.code.to_s}"
+                end
+            rescue => e
+                puts "Error Message: #{e.to_s}"
+            end
+            return login_name
+        end
+
+
+        ##
+        # List of contributors order by commits
+        #
+        # Avoid unexpected terminations / Best Effort approach
+        #
+        def getContributors(file)
+            headers = {Authorization: "token #{@token}"}
+            uri     = "https://api.github.com/repos/#{@repo}/commits?path=#{file.to_s}"
+
+            contributors = Hash.new;
+            begin
+                response = RestClient.get(uri, headers)
+                if response.code == 200
+                    responseBody = response.body;
+
+                    unless responseBody.nil? || responseBody.empty?
+                        commits = JSON.parse(responseBody);
+                        if commits.nil? || commits.empty?
+                            puts "Warning: Unable to find contributors for page in github repository.";
+                        else
+                            commits.each do |commit|
+                                author = commit['author']
+                                name = getRealUser(author["login"])
+                                if contributors.key?(name)
+                                    contributors[name] = contributors[name] + 1;
+                                else
+                                    contributors[name] = 1;
+                                end
+                            end
+                        end
+                    end
+                else
+                    puts "Warning: Invalid Response code received for page: #{uri.to_s}. Response headers set to #{response.headers.to_str}";
+                end
+            rescue => e
+                puts "Error Message: #{e.to_s}";
+            end
+
+            authors = contributors.sort_by{|name, commits| [-commits, name]}.transpose[0]
+
+            if (authors.nil? || authors.empty? )
+                return 'NetApp'
+            end
+
+            return authors.join(', ')
+        end
+
+        ##
+        # Get authors information from git log
+        #
+        def getContributorsWithoutGithubToken(file)
+            names = %x[ git log --pretty=format:"%an" #{file} | sort | uniq ]
+            # last_commit_date can be nil iff the file was not committed.
+            if (names.nil? || names.empty?)
+                return 'NetApp'
+            end
+
+            return names.split(/\n+/).join(', ')
+        end
+
+
+        ##
+        # Get authors information
+        #
+        def getAuthorsList(file)
+            if (remote) 
+                return getContributors(file);
+            else 
+                return getContributorsWithoutGithubToken(file);
+            end
+        end
+
+    end
+
+end
+

data/lib/jekyll_asciidoctor_pdf/version.rb

@@ -1,3 +1,3 @@
 module JekyllAsciidoctorPdf
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_asciidoctor_pdf
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Guido Genzone
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: asciidoctor-pdf
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +154,7 @@ files:
 - lib/jekyll_asciidoctor_pdf.rb
 - lib/jekyll_asciidoctor_pdf/adoc.rb
 - lib/jekyll_asciidoctor_pdf/commands.rb
+- lib/jekyll_asciidoctor_pdf/gitinfo.rb
 - lib/jekyll_asciidoctor_pdf/logger.rb
 - lib/jekyll_asciidoctor_pdf/permalink.rb
 - lib/jekyll_asciidoctor_pdf/sidebar.rb