gitlab-release-tools 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc5b89c86cac432823c0c80465f2db7bca594f032f147acb2a44e3fc541eeca0
-  data.tar.gz: 486d3550693609d543427d5cbd4186c19db079289600384da6c6b57d256062f8
+  metadata.gz: e31f5cb41ec6a8a0512162473f092a20c9c6c033bb03cdc7768c98bed72a78a6
+  data.tar.gz: 3ca9e40c679f14a00d6ca6c711f559f17205a2707417a0999496d9756189d8ca
 SHA512:
-  metadata.gz: 9ae7ca58e5f26bfceddf60705098129908146e55f48e8be23efbe502778c1a9050bbe54d8f4bd7ee3241732d1efc05d45547c6daf9bb56813387c8c4ab01a81a
-  data.tar.gz: d58da60bac59b9342ee7feebc8985b778de4cf1c87bca5434a95558327ffb4284e71dea511a9b56c205d1d84f983edc19b9e13a0b3b10bab591cfbdff965d4b5
+  metadata.gz: 68957e07b20608018f3cb018f0fcb1a4a06f52cb6a855b6e5996f10760bbc876284f023d324eb8049b28a988396e440d88a83ed7485b39aa8b2090f042429fb2
+  data.tar.gz: 55847bebbb6d94a3c9203fd0b298fa24ed253e8e6bf6b47d39e4beac1cc03f327a543eaaa13b33d0cf6047bab05bae810d9e076cdc5bcfc6653e8484d14d350e

data/.env.gitlab

@@ -1,2 +1,2 @@
 GITLAB_BASE_URL=http://gitlab.com/api/v4
-PRIVATE_TOKEN=ebjfSuxMXLuJhV_UuKbn
+PRIVATE_TOKEN=

data/.travis.yml

@@ -2,8 +2,11 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.6
+  - 2.4.6
+  - 2.6.4
+before_install:
+  - gem install bundler
+  - bundle install
 
 script:
   - rspec spec

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 1.0.0
+Hello World!

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-release-tools (0.2.0)
+    gitlab-release-tools (1.0.0)
       gitlab (~> 4.12.0)
 
 GEM
@@ -26,19 +26,19 @@ GEM
     multi_xml (0.6.0)
     public_suffix (4.0.1)
     rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.3)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
     safe_yaml (1.0.5)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
@@ -47,6 +47,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.20)
 
 PLATFORMS
   ruby
@@ -59,6 +60,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   webmock
+  yard
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -1,4 +1,7 @@
 # gitlab-release-tools
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/andreadelfante/gitlab-release-tools/blob/master/LICENSE)
+[![Gem](https://img.shields.io/gem/v/gitlab-release-tools.svg?style=flat)](https://rubygems.org/gems/gitlab-release-tools)
+[![Build Status](https://travis-ci.org/andreadelfante/gitlab-release-tools.svg?branch=master)](https://travis-ci.org/andreadelfante/gitlab-release-tools)
 
 ## Installation
 
@@ -10,21 +13,38 @@ gem 'gitlab-release-tools'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
-    $ gem install gitlab-changelog-generator
+    $ gem install gitlab-release-tools
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+endpoint = 'endpoint' # or value from ENV for CI/CD
+private_token = 'private_token' # or value from ENV for CI/CD
+project_id = 50 # or value from ENV for CI/CD
+version = '1.0'
+
+generator = Gitlab::Release::Changelog::Generator.new(endpoint: endpoint, private_token: private_token)
+changelog = generator.changelog(version, project_id: project_id)
+# print(changelog) for a simple changelog list
+# print(changelog.to_s_with_reference) for a changelog list with mrs/issues references 
+
+manager = Gitlab::Release::Manager.new(endpoint: endpoint, private_token: private_token)
+manager.define_tag(version, changelog.to_s_with_reference)
+manager.close_milestones(version)
+```
 
-## Development
+Check out the [documentation](./doc/index.html) for more.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+1. Install this gem onto your local machine, `bundle exec rake install`.
+2. Copy `.env.example` and rename with `.env`.
+3. Define Gitlab base url and generate a private token. 
+4. You are ready to go!
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,11 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
 
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
 task :default => :spec

data/exe/gitlab-release-tools

@@ -8,7 +8,8 @@ Dotenv.load('../.env')
 endpoint = ENV["GITLAB_BASE_URL"]
 private_token = ENV["PRIVATE_TOKEN"]
 
-generator = Gitlab::Release::Changelog::Generator.new(endpoint, private_token)
+generator = Gitlab::Release::Changelog::Generator.new(endpoint: endpoint,
+                                                      private_token: private_token)
 
 changelog = generator.changelog("1.1", project_id: 50)
 print(changelog)

data/gitlab-release-tools.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   if spec.respond_to?(:metadata)
     spec.metadata["homepage_uri"] = spec.homepage
     spec.metadata["source_code_uri"] = "https://github.com/andreadelfante/gitlab-release-tools"
-    #spec.metadata["changelog_uri"] = ""
+    spec.metadata["changelog_uri"] = "https://github.com/andreadelfante/gitlab-release-tools/blob/master/CHANGELOG.md##{Gitlab::Release::VERSION}"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  #spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "gitlab", "~> 4.12.0"
@@ -39,4 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard'
 end

data/lib/gitlab/release/api_client.rb

@@ -3,12 +3,10 @@ require 'gitlab'
 module Gitlab
   module Release
     class ApiClient
-      # @param [String] endpoint API endpoint URL, default: ENV['GITLAB_API_ENDPOINT'] and falls back to ENV['CI_API_V4_URL']
-      # @param [String] private_token user's private token or OAuth2 access token, default: ENV['GITLAB_API_PRIVATE_TOKEN']
-      def initialize(endpoint, private_token)
+      def initialize(options = {})
         @client = Gitlab.client(
-            endpoint: endpoint,
-            private_token: private_token
+            endpoint: options[:endpoint],
+            private_token: options[:private_token]
         )
       end
 

data/lib/gitlab/release/changelog/entries.rb

@@ -1,38 +1,73 @@
 module Gitlab
   module Release
     module Changelog
+      ##
+      # This class is a collection wrapper of changelog items, useful to generate easily changelog as String.
+      #
       class Entries
         def initialize
           # @type [Array] elements
           @elements = []
         end
 
+        ##
+        # Add a new Entry element.
+        #
         # @param [Entry] element
+        #
         def push(element)
           @elements.push(element)
         end
 
+        ##
+        # Print the changelog without any reference.
+        #
+        # @return [String]
+        #
         def to_s
-          to_s_with_reference(true)
+          internal_to_s_with_reference(false)
         end
 
-        # @param [Boolean] with_reference
-        def to_s_with_reference(with_reference)
-          @elements.map { |element| element.to_s_with_reference(with_reference) }
-              .join("\n")
+        ##
+        # Print the changelog with relative reference.
+        #
+        # @return [String]
+        #
+        def to_s_with_reference
+          internal_to_s_with_reference(true)
         end
 
-        # @param [String] path
-        # @param [Boolean] appending default false
-        # @param [Boolean] with_reference default true
-        def write_on_file(path, appending = false, with_reference = true)
+        ##
+        # Write the changelog content as String in a file.
+        #
+        # @param [String] path Required. path The file path. You can specify a series of file paths with regex.
+        # @param [Boolean] appending Optional. Append the changelog contents at the bottom of the file. Default: false
+        # @param [Boolean] with_reference Optional. Generate the changelog with MRs and Issues reference. Default true
+        #
+        def write_in_file(path, appending = false, with_reference = true)
           # @type [String] changelog_string
-          changelog_string = to_s_with_reference(with_reference)
+          changelog_string = internal_to_s_with_reference(with_reference)
+
+          searched_paths = Dir.glob(path)
+          if !searched_paths.empty?
+            searched_paths.each do |single_path|
+              internal_write_on_file(single_path, changelog_string, appending)
+            end
+          else
+            internal_write_on_file(path, changelog_string, appending)
+          end
+        end
 
+        private def internal_write_on_file(path, content, appending)
           File.open(path, appending ? "a" : "w+") do |file|
-            file.puts(changelog_string)
+            file.puts(content)
           end
         end
+
+        private def internal_to_s_with_reference(with_reference)
+          @elements.map { |element| element.to_s_for_changelog(with_reference) }
+              .join("\n")
+        end
       end
     end
   end

data/lib/gitlab/release/changelog/entry.rb

@@ -1,6 +1,9 @@
 module Gitlab
   module Release
     module Changelog
+      ##
+      # This class represents a single changelog element.
+      #
       class Entry
         attr_reader :title, :id
 
@@ -11,20 +14,35 @@ module Gitlab
           @title = title
         end
 
-        # @param [Boolean] with_reference
-        def to_s_with_reference(with_reference)
+        def to_s
+          "Changelog::Entry { id: #{id}, title: '#{title}' }"
+        end
+
+        ##
+        # Print this entry with or without reference.
+        #
+        # @param [Boolean] with_reference Required. Generate the changelog with MRs and Issues reference.
+        # @return [String]
+        #
+        def to_s_for_changelog(with_reference)
           "- #{title}"
         end
       end
 
+      ##
+      # This class represents a single Merge Request.
+      #
       class MergeRequest < Entry
-        def to_s_with_reference(with_reference)
+        def to_s_for_changelog(with_reference)
           with_reference ? "- #{title} !#{id}" : super
         end
       end
 
+      ##
+      # This class represents a single Issue.
+      #
       class Issue < Entry
-        def to_s_with_reference(with_reference)
+        def to_s_for_changelog(with_reference)
           with_reference ? "- #{title} ##{id}" : super
         end
       end

data/lib/gitlab/release/changelog/generator.rb

@@ -6,31 +6,40 @@ require 'gitlab/release/version'
 module Gitlab
   module Release
     module Changelog
+      ##
+      # This class generates the changelog entries
+      #
       class Generator < ApiClient
-        # @param [String] endpoint API endpoint URL, default: ENV['GITLAB_API_ENDPOINT'] and falls back to ENV['CI_API_V4_URL']
-        # @param [String] private_token user's private token or OAuth2 access token, default: ENV['GITLAB_API_PRIVATE_TOKEN']
-        # @param [Integer] max_loop_mrs
-        # @param [Integer] max_loop_issues
-        def initialize(endpoint, private_token, max_loop_mrs = 1000, max_loop_issues = 1000)
-          @max_loops_merge_requests = max_loop_mrs
-          @max_loop_issues = max_loop_issues
-          super(endpoint, private_token)
+        ##
+        # @option [String] endpoint Optional. The API endpoint URL. Default: ENV['GITLAB_API_ENDPOINT'] and falls back to ENV['CI_API_V4_URL']
+        # @option [String] private_token Optional. User's private token or OAuth2 access token. Default: ENV['GITLAB_API_PRIVATE_TOKEN']
+        # @option [Integer] max_loops_merge_requests Optional. The limit of the loop to fetch merge requests. Default: 2000
+        # @option [Integer] max_loop_issues Optional. The limit of the loop to fetch issues. Default: 2000
+        #
+        def initialize(options = {})
+          @max_loops_merge_requests = options[:max_loops_merge_requests] || 2000
+          @max_loop_issues = options[:max_loop_issues] || 2000
+          super(options)
         end
 
-        # @param [String] version_name required
-        # @param [String or Integer] project_id default ENV["CI_PROJECT_ID"]
-        # @param [TrueClass or FalseClass] include_mrs default true
-        # @param [TrueClass or FalseClass] include_issues default false
-        # @param [Array[String]] filtering_labels default []
-        # @param [Array[String]] filtering_mrs_labels default []
-        # @param [Array[String]] filtering_issues_labels default []
+        ##
+        # Generate the changelog.
+        #
+        # @param [String] version_name Required. The name of the version. (ex: 1.0)
+        # @option [String or Integer] project_id Optional. The id of this project, given from GitLab. Default ENV["CI_PROJECT_ID"]
+        # @option [Boolean] include_mrs Optional. Should the generator include merge requests? Default: true
+        # @option [Boolean] include_issues Optional. Should the generator include issues? Default false
+        # @option [Array[String]] filtering_labels Optional. A general list of labels to filter items. Default: []
+        # @option [Array[String]] filtering_mrs_labels Optional. A specific list of labels to filter merge requests. Default: []
+        # @option [Array[String]] filtering_issues_labels Optional. A specific list of labels to filter issues. Default: []
         # @return [Entries]
-        def changelog(version_name, params = {})
-          project_id = params[:project_id] || ENV["CI_PROJECT_ID"]
-          include_mrs = params[:include_mrs] || true
-          include_issues = params[:include_issues] || false
-          filtering_mrs_labels = params[:filtering_mrs_labels] || params[:filtering_labels] || []
-          filtering_issue_labels = params[:filtering_issues_labels] || params[:filtering_labels] || []
+        #
+        def changelog(version_name, options = {})
+          project_id = options[:project_id] || ENV["CI_PROJECT_ID"]
+          include_mrs = options[:include_mrs] || true
+          include_issues = options[:include_issues] || false
+          filtering_mrs_labels = options[:filtering_mrs_labels] || options[:filtering_labels] || []
+          filtering_issue_labels = options[:filtering_issues_labels] || options[:filtering_labels] || []
 
           entries = Entries.new
           if include_mrs
@@ -51,7 +60,7 @@ module Gitlab
         # @param [Entries] entries
         # @param [String or Integer] project_id
         # @param [String] version_name
-        # @param Array[String] filtering_labels
+        # @param [Array[String]] filtering_labels
         private def changelog_from_merge_requests(entries, project_id, version_name, filtering_labels)
           select_milestones(project_id, version_name).each do |milestone|
             i = 1
@@ -74,7 +83,7 @@ module Gitlab
 
         # @param [Gitlab::ObjectifiedHash] mr
         # @param [Array[String]] filtering_labels
-        # @return [TrueClass or FalseClass]
+        # @return [Boolean]
         private def check_mr(mr, filtering_labels)
           mr.state == 'merged' and (filtering_labels - mr.labels).empty?
         end
@@ -82,8 +91,7 @@ module Gitlab
         # @param [Entries] entries
         # @param [String or Integer] project_id
         # @param [String] version_name
-        # @param [TrueClass or FalseClass] only_closed
-        # @param Array[String] filtering_labels
+        # @param [Array[String]] filtering_labels
         private def changelog_from_issues(entries, project_id, version_name, filtering_labels)
           select_milestones(project_id, version_name).each do |milestone|
             i = 1
@@ -106,7 +114,7 @@ module Gitlab
 
         # @param [Gitlab::ObjectifiedHash] issue
         # @param [Array[String]] filtering_labels
-        # @return [TrueClass or FalseClass]
+        # @return [Boolean]
         private def check_issue(issue, filtering_labels)
           issue.state == 'closed' and (filtering_labels - issue.labels).empty?
         end

data/lib/gitlab/release/manager.rb

@@ -2,22 +2,33 @@ require 'gitlab/release/api_client'
 
 module Gitlab
   module Release
+    ##
+    # This class contains some tools to finish a release.
+    #
     class Manager < ApiClient
-      # @param [String] tag_name
-      # @param [String] changelog
-      # @param [String or Integer] project_id default ENV["CI_PROJECT_ID"]
-      # @param [String] ref default ENV["CI_COMMIT_SHA"]
-      def define_tag(tag_name, changelog, params = {})
-        project_id = params[:project_id] || ENV["CI_PROJECT_ID"]
-        ref = params[:ref] || ENV["CI_COMMIT_SHA"]
+      ##
+      # Create a new tag in the Repo.
+      #
+      # @param [String] tag_name Required. The name of the tag. (ex: 1.0)
+      # @param [String] changelog Optional. The release notes related to the tag.
+      # @option [String or Integer] project_id Optional. The id of this project, given from GitLab. Default ENV["CI_PROJECT_ID"]
+      # @option [String] ref Optional. The commit SHA. Default ENV["CI_COMMIT_SHA"]
+      #
+      def define_tag(tag_name, changelog, options = {})
+        project_id = options[:project_id] || ENV["CI_PROJECT_ID"]
+        ref = options[:ref] || ENV["CI_COMMIT_SHA"]
 
         @client.create_tag(project_id, tag_name, ref, '', changelog)
       end
 
-      # @param [String] version_name
-      # @param [String or Integer] project_id default ENV["CI_PROJECT_ID"]
-      def close_milestones(version_name, params = {})
-        project_id = params[:project_id] || ENV["CI_PROJECT_ID"]
+      ##
+      # Close all the milestones containing the version name.
+      #
+      # @param [String] version_name Required. The name of the version. (ex: 1.0)
+      # @option [String or Integer] project_id Optional. The id of this project, given from GitLab. Default ENV["CI_PROJECT_ID"]
+      #
+      def close_milestones(version_name, options = {})
+        project_id = options[:project_id] || ENV["CI_PROJECT_ID"]
 
         select_milestones(project_id, version_name).each do |milestone|
           @client.edit_milestone(project_id, milestone.id, state_event: 'close')

data/lib/gitlab/release/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Release
-    VERSION = "0.2.0"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-release-tools
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrea Del Fante
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2019-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -94,11 +94,24 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Automation gitlab release tools from MR and issues for your new versions.
 email:
 - andreadelfante94@gmail.com
-executables:
-- gitlab-release-tools
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -108,6 +121,7 @@ files:
 - ".rakeTasks"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -129,6 +143,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/andreadelfante/gitlab-release-tools
   source_code_uri: https://github.com/andreadelfante/gitlab-release-tools
+  changelog_uri: https://github.com/andreadelfante/gitlab-release-tools/blob/master/CHANGELOG.md#1.0.0
 post_install_message: 
 rdoc_options: []
 require_paths: