gitlab_awesome_release 0.1.0.beta2 → 0.1.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70ed582ce67159f6cbe5199f9322fc946fe65cdf
-  data.tar.gz: 97ea9c7a5b9dc5afc9080dee8da1589d640278bd
+  metadata.gz: 9e6ff73c0318107e4b3b2cc7fa5dda3f7630b429
+  data.tar.gz: 156be8774fdfd86f83040b1c33edce322214efe2
 SHA512:
-  metadata.gz: 12fbf0ffd8df27ab7e77cdd65ccbc11ae735690545eec60ad609c4a18db6af684c44c0ab76706eefff9beb3615d85284c3451b54f004a54f85216d7436ad42b4
-  data.tar.gz: 6098f639d11a6c0608bca5afd18fb2a193bcbe290b9bb4c9fff32805a8ea4ae8408293c79bae4cf6419f6f17e6898a4975c04e85a858485a253b457772a7d3d5
+  metadata.gz: 758d123c1789cbe68239e56cb5116f8ba4dff72dc84009e9b897da9aa0f72f67cdb0d1030737e1a3bc0b98bf28c488d900b7759ed50ae5c1b18f11ae01e15829
+  data.tar.gz: 29f84ad3e708a9f79adeae1a6bd22e8f202dc2e5bcbad32e8ef113c9587f16d271e2adeae01e9f547da1d332239949e5655a422cf90b41e42556e2af662df5aa

data/.env.example

@@ -1,3 +1,4 @@
 GITLAB_API_ENDPOINT=http://example.com/api/v3
 GITLAB_API_PRIVATE_TOKEN=XXXXXXXXXXXXXXXXXXX
 GITLAB_PROJECT_NAME=group/name
+ALLOW_TAG_FORMAT=^v?[\d.]+

data/lib/gitlab_awesome_release.rb

@@ -2,6 +2,7 @@ require "active_support/all"
 require "gitlab_awesome_release/version"
 require "gitlab_awesome_release/project"
 require "gitlab"
+# require "gitlab_awesome_release/gitlab_logging_ext"
 
 module GitlabAwesomeRelease
   # Your code goes here...

data/lib/gitlab_awesome_release/cli.rb

@@ -4,6 +4,8 @@ require "dotenv"
 
 module GitlabAwesomeRelease
   class CLI < Thor
+    DEFAULT_VERSION_FORMAT = "^v?[\\d.]+"
+
     desc "version", "Show gitlab_awesome_release version"
     def version
       puts GitlabAwesomeRelease::VERSION
@@ -16,33 +18,45 @@ module GitlabAwesomeRelease
     option :gitlab_api_endpoint
     option :gitlab_api_private_token
     option :gitlab_project_name
+    option :allow_tag_format, desc: "Regular expression of tag format", default: "^v?[\\d.]+"
+    option :log_level, desc: "Log level (debug|info|warn|error|fatal|unknown)", default: "info"
     def create_note
       Dotenv.load
 
       gitlab_api_endpoint      = option_or_env!(:gitlab_api_endpoint)
       gitlab_api_private_token = option_or_env!(:gitlab_api_private_token)
       gitlab_project_name      = option_or_env!(:gitlab_project_name)
+      allow_tag_format         = option_or_env(:allow_tag_format, DEFAULT_VERSION_FORMAT)
+
+      @logger = Logger.new(STDOUT)
+      @logger.level = logger_level(option_or_env(:log_level))
+      @logger.formatter = proc{ |severity, datetime, progname, message|
+        "[#{datetime}] #{message}\n"
+      }
 
       project = GitlabAwesomeRelease::Project.new(
-        api_endpoint:  gitlab_api_endpoint,
-        private_token: gitlab_api_private_token,
-        project_name:  gitlab_project_name,
+        api_endpoint:     gitlab_api_endpoint,
+        private_token:    gitlab_api_private_token,
+        project_name:     gitlab_project_name,
+        allow_tag_format: /#{allow_tag_format}/,
+        logger:           @logger,
       )
 
-      tag_names = project.all_tag_names
+      tag_names = project.release_tag_names
       oldest_tag = option_or_env(:from) || tag_names.first
       newest_tag = option_or_env(:to)   || tag_names.last
 
       changelog = project.generate_change_log(oldest_tag, newest_tag)
 
       write_changelog(changelog)
+      @logger.info "finish!"
     end
 
     private
 
-    def option_or_env(name)
+    def option_or_env(name, default = nil)
       upper_name = name.to_s.upcase
-      options[name].presence || ENV[upper_name].presence
+      options[name].presence || ENV[upper_name].presence || default
     end
 
     def option_or_env!(name)
@@ -59,10 +73,29 @@ module GitlabAwesomeRelease
         File.open(filename, "wb") do |f|
           f.write(changelog)
         end
-        puts "Write #{filename}"
+        @logger.info "Write to #{filename}"
       else
         puts changelog
       end
     end
+
+    def logger_level(log_level)
+      case log_level.to_sym
+      when :debug
+        Logger::DEBUG
+      when :error
+        Logger::ERROR
+      when :fatal
+        Logger::FATAL
+      when :info
+        Logger::INFO
+      when :unknown
+        Logger::UNKNOWN
+      when :warn
+        Logger::WARN
+      else
+        raise "Unknown log_level: #{log_level}"
+      end
+    end
   end
 end

data/lib/gitlab_awesome_release/gitlab_logging_ext.rb

@@ -0,0 +1,24 @@
+module GitlabAwesomeRelease
+  module GitlabLoggingExt
+    def get(path, options={})
+      start_time = Time.now
+
+      super(path, options)
+
+    ensure
+      end_time = Time.now
+
+      # NOTE: options[:headers] contains PRIVATE-TOKEN
+      _options = options.reject{ |k, _v| k == :headers }
+      logger.debug "(#{end_time - start_time} sec) GET #{path} #{_options}"
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+end
+
+Gitlab::Request.class_eval do
+  prepend GitlabAwesomeRelease::GitlabLoggingExt
+end

data/lib/gitlab_awesome_release/project.rb

@@ -7,26 +7,30 @@ module GitlabAwesomeRelease
 
     PER_PAGE = 100
 
-    # @param api_endpoint  [String]
-    # @param private_token [String]
-    # @param project_name  [String]
-    def initialize(api_endpoint:, private_token:, project_name:)
+    # @param api_endpoint     [String]
+    # @param private_token    [String]
+    # @param project_name     [String]
+    # @param allow_tag_format [Regexp]
+    def initialize(api_endpoint:, private_token:, project_name:, allow_tag_format:, logger:)
       Gitlab.configure do |config|
         config.endpoint      = api_endpoint
         config.private_token = private_token
       end
       @project_name = project_name
+      @allow_tag_format = allow_tag_format
+      @logger = logger
     end
 
     def web_url
       @web_url ||= Gitlab.project(escaped_project_name).web_url
     end
 
-    # all tag name order by author date
+    # all tag names order by author date
     # @return [Array<String>]
     def all_tag_names
       return @all_tag_names if @all_tag_names
 
+      @logger.info "fetch git tags"
       repo_tags =
         with_paging do |params|
           Gitlab.repo_tags(escaped_project_name, params)
@@ -34,12 +38,17 @@ module GitlabAwesomeRelease
       @all_tag_names = repo_tags.sort_by{ |tag| tag.commit.authored_date }.map(&:name)
     end
 
+    # @return [Array<String>]
+    def release_tag_names
+      all_tag_names.find_all { |tag| tag =~ @allow_tag_format }
+    end
+
     # @param oldest_tag [String]
     # @param newest_tag [String]
     # @return [String]
     def generate_change_log(oldest_tag, newest_tag)
       release_notes = []
-      all_tag_names.within(oldest_tag, newest_tag).each_cons(2) do |from, to|
+      release_tag_names.within(oldest_tag, newest_tag).each_cons(2) do |from, to|
         release_notes << generate_release_note(from, to)
       end
       release_notes << generate_release_note(newest_tag, "HEAD", title: "Unreleased") if newest_tag == all_tag_names.last
@@ -56,6 +65,8 @@ module GitlabAwesomeRelease
     # @param title [String]
     # @return [String]
     def generate_release_note(from, to, title: nil)
+      @logger.info "generate release note (#{from}...#{to})"
+
       title ||= to
       summary = merge_requests_summary_between(from, to)
 

data/lib/gitlab_awesome_release/version.rb

@@ -1,3 +1,3 @@
 module GitlabAwesomeRelease
-  VERSION = "0.1.0.beta2"
+  VERSION = "0.1.0.beta3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_awesome_release
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta2
+  version: 0.1.0.beta3
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2015-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -188,6 +188,7 @@ files:
 - lib/gitlab_awesome_release.rb
 - lib/gitlab_awesome_release/array_within_ext.rb
 - lib/gitlab_awesome_release/cli.rb
+- lib/gitlab_awesome_release/gitlab_logging_ext.rb
 - lib/gitlab_awesome_release/project.rb
 - lib/gitlab_awesome_release/version.rb
 - script/build.sh