tractive 1.0.5 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db1fec86bca93ac81ac4ce8c4f1e6fb99f0983743c55fc3275a95188c8178e0e
-  data.tar.gz: f2907430c9a64b4cd5e0004050c1d7eddf11a18f94a4a007bf5315706a73e23b
+  metadata.gz: 5ebcddc1621be979b25f4041cc4eac2429e6a6a08b05611154c230d49d9de86c
+  data.tar.gz: f61bd5af4741266ae56d81c277c7aaec723a49358f81dcb6eebdc3dbaae2e37c
 SHA512:
-  metadata.gz: 1828a51469e9418188cd72195b51b245bb47921b7fbc883287bd089f9b2da58d18fbf08411c9f5cc33ed4a4a92259e365931afe281e1cf810a16c97a0632fa1a
-  data.tar.gz: f898f265b58c41ca3ae59ee20cf52ec50ced92045a1595f23ea50e66bb4b0bd911a8695cfdc34b3a41a248a8b11bcb3a20be70eb8193aba8a7867c3f9ba4cc1e
+  metadata.gz: b29d97cc67c43cc4d9ee72d88563e01dc6d7cdc7b988ed3b987c73a3cbc9a2fc8746597c3d3b1e175ebca83073fd6e4b19f8b51f60c9792849893a6816483f5d
+  data.tar.gz: d07192c1b845a3a4ca266e881ead6a7583ba5575313d68372ffa9df6785c0f4e8856be09cafdf736bb279e5e651a4d3eb1e6f294b0754b0dd4c3a5dfded9ac03

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/.rubocop.yml

@@ -25,12 +25,18 @@ Style/Documentation:
 Style/GlobalVars:
   Enabled: false
 
+Style/HashTransformKeys:
+   Enabled: false
+
 Metrics/AbcSize:
   Enabled: false
 
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/ModuleLength:
+  Max: 150
+
 Security/Open:
   Enabled: false
 

data/README.adoc

@@ -297,6 +297,8 @@ trac:
   ticketbaseurl: https://example.org/trac/foobar/ticket
 ----
 
+`ticketbaseurl:`::: The Trac Url which will be added in Github issues. A link will be added in the footer of Github issue to link it to Trac ticket.
+
 [[config-github]]
 ==== GitHub configuration
 
@@ -680,6 +682,7 @@ The following options are allowed (at least one necessary):
 * `column-name`
 * `operator`
 * `column-value`
+* `include-null`
 
 | Boolean
 
@@ -695,6 +698,10 @@ The following options are allowed (at least one necessary):
 | Value of the column to filter.
 | String
 
+| `--include-null`
+| Include rows having null value in filtered column.
+| Boolean
+
 | `-h`, `help`
 | Display the Tractive help message, or you can provide a command to know more
   about a single command via `tractive help {command}`.

data/exe/tractive

@@ -30,6 +30,8 @@ class TractiveCommand < Thor
                             desc: "Operator for filter."
   method_option "columnvalue", type: :string, aliases: ["--column-value"],
                                desc: "Value of the column to filter."
+  method_option "includenull", type: :boolean, aliases: ["--include-null"],
+                               desc: "Flag for including null values in the filter result."
 
   method_option "importfromfile", type: :string, aliases: ["-I", "--import-from-file"],
                                   desc: "Import issues from a json file"

data/lib/tractive/info.rb

@@ -34,8 +34,8 @@ module Tractive
         "milestones" => milestones,
         "labels" => {
           "type" => Utilities.make_hash("type_", types),
-          "component" => Utilities.make_hash("component_", components),
           "resolution" => Utilities.make_hash("resolution_", resolutions),
+          "component" => Utilities.make_each_hash(components, %w[name color], "component: "),
           "severity" => Utilities.make_each_hash(severity, %w[name color]),
           "priority" => Utilities.make_each_hash(priorities, %w[name color]),
           "tracstate" => Utilities.make_each_hash(tracstates, %w[name color])

data/lib/tractive/main.rb

@@ -8,7 +8,7 @@ module Tractive
       @opts = opts
       @cfg  = YAML.load_file(@opts[:config])
 
-      Tractive::Utilities.setup_logger(output_stream: @opts[:log_file] || $stderr, verbose: @opts[:verbose])
+      Tractive::Utilities.setup_logger(output_stream: @opts[:logfile] || $stderr, verbose: @opts[:verbose])
       @db = Tractive::Utilities.setup_db!(@cfg["trac"]["database"])
     rescue Sequel::DatabaseConnectionError, Sequel::AdapterNotFound, URI::InvalidURIError, Sequel::DatabaseError => e
       $logger.error e.message

data/lib/tractive/migrator/converter/trac_to_github.rb

@@ -6,7 +6,7 @@ module Migrator
       def initialize(args)
         @tracticketbaseurl    = args[:cfg]["trac"]["ticketbaseurl"]
         @attachurl            = args[:opts][:attachurl] || args[:cfg].dig("attachments", "url")
-        @changeset_base_url   = args[:cfg]["trac"]["changeset_base_url"]
+        @changeset_base_url   = args[:cfg]["trac"]["changeset_base_url"] || ""
         @singlepost           = args[:opts][:singlepost]
         @labels_cfg           = args[:cfg]["labels"].transform_values(&:to_h)
         @milestonesfromtrac   = args[:cfg]["milestones"]
@@ -15,14 +15,17 @@ module Migrator
         @repo                 = args[:cfg]["github"]["repo"]
         @client               = GithubApi::Client.new(access_token: args[:cfg]["github"]["token"])
         @wiki_attachments_url = args[:cfg]["trac"]["wiki_attachments_url"]
+        @revmap_file_path     = args[:opts][:revmapfile] || args[:cfg]["revmap_path"]
+        @attachment_options   = { hashed: args[:cfg].dig("attachments", "hashed") }
 
         load_milestone_map
         create_labels_on_github(@labels_cfg["severity"].values)
         create_labels_on_github(@labels_cfg["priority"].values)
         create_labels_on_github(@labels_cfg["tracstate"].values)
+        create_labels_on_github(@labels_cfg["component"].values)
 
         @uri_parser = URI::Parser.new
-        @twf_to_markdown = Migrator::Converter::TwfToMarkdown.new(@tracticketbaseurl, @attachurl, @changeset_base_url, @wiki_attachments_url)
+        @twf_to_markdown = Migrator::Converter::TwfToMarkdown.new(@tracticketbaseurl, @attachurl, @changeset_base_url, @wiki_attachments_url, @revmap_file_path)
       end
 
       def compose(ticket)
@@ -77,7 +80,6 @@ module Migrator
 
         badges = Set[]
 
-        badges.add(@labels_cfg.fetch("component", {})[ticket[:component]])
         badges.add(@labels_cfg.fetch("type", {})[ticket[:type]])
         badges.add(@labels_cfg.fetch("resolution", {})[ticket[:resolution]])
         badges.add(@labels_cfg.fetch("version", {})[ticket[:version]])
@@ -85,6 +87,8 @@ module Migrator
         labels.add(@labels_cfg.fetch("severity", {})[ticket[:severity]])
         labels.add(@labels_cfg.fetch("priority", {})[ticket[:priority]])
         labels.add(@labels_cfg.fetch("tracstate", {})[ticket[:status]])
+        labels.add(@labels_cfg.fetch("component", {})[ticket[:component]])
+
         labels.delete(nil)
 
         keywords = ticket[:keywords]
@@ -100,7 +104,7 @@ module Migrator
         milestone = @milestonemap[ticket[:milestone]]
 
         # compute footer
-        footer = "_Issue migrated from trac:#{ticket[:id]} at #{Time.now}_"
+        footer = "_Issue migrated from #{trac_ticket_link(ticket)} at #{Time.now}_"
 
         # compute badgetabe
         #
@@ -201,8 +205,17 @@ module Migrator
       def create_labels_on_github(labels)
         return if labels.nil? || labels.empty?
 
-        existing_labels = @client.labels(@repo, per_page: 100).map { |label| label["name"] }
-        new_labels = labels.reject { |label| existing_labels.include?(label["name"]) }
+        page = 1
+        existing_labels = []
+        result = @client.labels(@repo, per_page: 100, page: page).map { |label| label["name"] }
+
+        until result.empty?
+          existing_labels += result
+          page += 1
+          result = @client.labels(@repo, per_page: 100, page: page).map { |label| label["name"] }
+        end
+
+        new_labels = labels.reject { |label| existing_labels.include?(label["name"]&.strip) }
 
         new_labels.each do |label|
           params = { name: label["name"] }
@@ -262,7 +275,7 @@ module Migrator
           changeset = body.match(/In \[changeset:"(\d+)/).to_a[1]
           text += if changeset
                     # changesethash = @revmap[changeset]
-                    "_committed #{Tractive::Utilities.map_changeset(changeset)}_"
+                    "_committed #{Tractive::Utilities.map_changeset(changeset, @revmap, @changeset_base_url)}_"
                   else
                     "_commented_\n\n"
                   end
@@ -275,7 +288,7 @@ module Migrator
           name = meta[:filename]
           body = meta[:description]
           if @attachurl
-            url = @uri_parser.escape("#{@attachurl}/#{meta[:id]}/#{name}")
+            url = @uri_parser.escape("#{@attachurl}/#{attachment_path(meta[:id], name, @attachment_options)}")
             text += "[`#{name}`](#{url})"
             body += "\n![#{name}](#{url})" if [".png", ".jpg", ".gif"].include? File.extname(name).downcase
           else
@@ -321,6 +334,23 @@ module Migrator
         !(%w[keywords cc reporter version].include?(kind) ||
           (kind == "comment" && (newvalue.nil? || newvalue.lstrip.empty?)))
       end
+
+      def trac_ticket_link(ticket)
+        return "trac:#{ticket[:id]}" unless @tracticketbaseurl
+
+        "[trac:#{ticket[:id]}](#{@tracticketbaseurl}/#{ticket[:id]})"
+      end
+
+      def attachment_path(id, filename, options = {})
+        return "#{id}/#{filename}" unless options[:hashed]
+
+        folder_name = Digest::SHA1.hexdigest(id)
+        parent_folder_name = folder_name[0..2]
+        hashed_filename = Digest::SHA1.hexdigest(filename)
+        file_extension = File.extname(filename)
+
+        "#{parent_folder_name}/#{folder_name}/#{hashed_filename}#{file_extension}"
+      end
     end
   end
 end

data/lib/tractive/migrator/converter/twf_to_markdown.rb

@@ -4,11 +4,12 @@ module Migrator
   module Converter
     # twf => Trac wiki format
     class TwfToMarkdown
-      def initialize(base_url, attach_url, changeset_base_url, wiki_attachments_url)
+      def initialize(base_url, attach_url, changeset_base_url, wiki_attachments_url, revmap_file_path)
         @base_url = base_url
         @attach_url = attach_url
         @changeset_base_url = changeset_base_url
         @wiki_attachments_url = wiki_attachments_url
+        @revmap = load_revmap_file(revmap_file_path)
       end
 
       def convert(str)
@@ -26,6 +27,24 @@ module Migrator
 
       private
 
+      def load_revmap_file(revmapfile)
+        # load revision mapping file and convert it to a hash.
+        # This revmap file allows to map between SVN revisions (rXXXX)
+        # and git commit sha1 hashes.
+        revmap = nil
+        if revmapfile
+          File.open(revmapfile, "r:UTF-8") do |f|
+            $logger.info("loading revision map #{revmapfile}")
+
+            revmap = f.each_line
+                      .map { |line| line.split(/\s+\|\s+/) }
+                      .map { |rev, sha| [rev.gsub(/^r/, ""), sha] }.to_h # remove leading "r" if present
+          end
+        end
+
+        revmap
+      end
+
       # CommitTicketReference
       def convert_ticket_reference(str)
         str.gsub!(/\{\{\{\n(#!CommitTicketReference .+?)\}\}\}/m, '\1')
@@ -72,9 +91,11 @@ module Migrator
         str.gsub!(%r{#{Regexp.quote(changeset_base_url)}/(\d+)/?}, '[changeset:\1]') if changeset_base_url
         str.gsub!(/\[changeset:"r(\d+)".*\]/, '[changeset:\1]')
         str.gsub!(/\[changeset:r(\d+)\]/, '[changeset:\1]')
-        str.gsub!(/\br(\d+)\b/) { Tractive::Utilities.map_changeset(Regexp.last_match[1]) }
-        str.gsub!(/\[changeset:"(\d+)".*\]/) { Tractive::Utilities.map_changeset(Regexp.last_match[1]) }
-        str.gsub!(/\[changeset:"(\d+).*\]/) { Tractive::Utilities.map_changeset(Regexp.last_match[1]) }
+        str.gsub!(/\br(\d+)\b/) { Tractive::Utilities.map_changeset(Regexp.last_match[1], @revmap, changeset_base_url) }
+        str.gsub!(/\[changeset:"(\d+)".*\]/) { Tractive::Utilities.map_changeset(Regexp.last_match[1], @revmap, changeset_base_url) }
+        str.gsub!(/\[changeset:(\d+).*\]/) { Tractive::Utilities.map_changeset(Regexp.last_match[1], @revmap, changeset_base_url) }
+        str.gsub!(/\[(\d+)\]/) { Tractive::Utilities.map_changeset(Regexp.last_match[1], @revmap, changeset_base_url) }
+        str.gsub!(%r{\[(\d+)/.*\]}) { Tractive::Utilities.map_changeset(Regexp.last_match[1], @revmap, changeset_base_url) }
       end
 
       # Font styles

data/lib/tractive/migrator/engine.rb

@@ -27,7 +27,7 @@ module Migrator
       input_file_name   = args[:opts][:importfromfile]
 
       @filter_applied   = args[:opts][:filter]
-      @filter_options   = { column_name: args[:opts][:columnname], operator: args[:opts][:operator], column_value: args[:opts][:columnvalue] }
+      @filter_options   = { column_name: args[:opts][:columnname], operator: args[:opts][:operator], column_value: args[:opts][:columnvalue], include_null: args[:opts][:includenull] }
 
       @trac  = Tractive::Trac.new(db)
       @repo  = github["repo"]
@@ -87,7 +87,7 @@ module Migrator
 
           revmap = f.each_line
                     .map { |line| line.split(/\s+\|\s+/) }
-                    .map { |rev, sha, _| [rev.gsub(/^r/, ""), sha] }.to_h # remove leading "r" if present
+                    .map { |rev, sha| [rev.gsub(/^r/, ""), sha] }.to_h # remove leading "r" if present
         end
       end
 

data/lib/tractive/models/ticket.rb

@@ -19,14 +19,18 @@ module Tractive
       def filter_column(options)
         return self if options.nil? || options.values.compact.empty?
 
-        case options[:operator].downcase
-        when "like"
-          where { Sequel.like(options[:column_name].to_sym, options[:column_value]) }
-        when "not like"
-          where { ~Sequel.like(options[:column_name].to_sym, options[:column_value]) }
-        else
-          where { Sequel.lit("#{options[:column_name]} #{options[:operator]} '#{options[:column_value]}'") }
-        end
+        query = case options[:operator].downcase
+                when "like"
+                  Sequel.like(options[:column_name].to_sym, options[:column_value])
+                when "not like"
+                  ~Sequel.like(options[:column_name].to_sym, options[:column_value])
+                else
+                  Sequel.lit("#{options[:column_name]} #{options[:operator]} '#{options[:column_value]}'")
+                end
+
+        query = Sequel.|(query, { options[:column_name].to_sym => nil }) if options[:include_null]
+
+        where { query }
       end
     end
 

data/lib/tractive/utilities.rb

@@ -7,10 +7,10 @@ module Tractive
         array.map { |i| [i, "#{prefix}#{i}"] }.to_h
       end
 
-      def make_each_hash(values, keys)
+      def make_each_hash(values, keys, prefix = "")
         values.map do |value|
           value = [value] unless value.is_a?(Array)
-          [value[0], keys.zip(value).to_h]
+          [value[0], keys.zip(value.map { |v| "#{prefix}#{v}" }).to_h]
         end.to_h
       end
 
@@ -45,11 +45,13 @@ module Tractive
       end
 
       # returns the git commit hash for a specified revision (using revmap hash)
-      def map_changeset(str)
-        if @revmap&.key?(str)
-          "[r#{str}](../commit/#{@revmap[str]}) #{@revmap[str]}"
+      def map_changeset(str, revmap, changeset_base_url = "")
+        if revmap&.key?(str)
+          base_url = changeset_base_url
+          base_url += "/" if base_url[-1] && base_url[-1] != "/"
+          "#{base_url}#{revmap[str].strip}"
         else
-          str
+          "[#{str}]"
         end
       end
 

data/lib/tractive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tractive
-  VERSION = "1.0.5"
+  VERSION = "1.0.9"
 end

data/tractive.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/ietf-ribose/tractive"
   spec.metadata["changelog_uri"] = "https://github.com/ietf-ribose/tractive"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tractive
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.9
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -124,7 +124,6 @@ files:
 - ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.adoc
 - Rakefile
@@ -171,6 +170,7 @@ metadata:
   homepage_uri: https://github.com/ietf-ribose/tractive
   source_code_uri: https://github.com/ietf-ribose/tractive
   changelog_uri: https://github.com/ietf-ribose/tractive
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/Gemfile.lock

@@ -1,100 +0,0 @@
-PATH
-  remote: .
-  specs:
-    tractive (1.0.5)
-      mysql2
-      ox
-      rest-client
-      sequel
-      sqlite3
-      thor
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    coderay (1.1.3)
-    crack (0.4.5)
-      rexml
-    diff-lcs (1.4.4)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    hashdiff (1.0.1)
-    http-accept (1.7.0)
-    http-cookie (1.0.4)
-      domain_name (~> 0.5)
-    method_source (1.0.0)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0901)
-    mysql2 (0.5.3)
-    netrc (0.11.0)
-    ox (2.14.5)
-    parallel (1.21.0)
-    parser (3.0.2.0)
-      ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.1.1)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.22.1)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    sequel (5.49.0)
-    sqlite3 (1.4.2)
-    thor (1.1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8)
-    unicode-display_width (2.1.0)
-    webmock (3.14.0)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  pry
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.7)
-  tractive!
-  webmock (~> 3.14)
-
-BUNDLED WITH
-   2.1.2