ohloh_scm 2.5.1 → 3.0.1

data/lib/ohloh_scm/status.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OhlohScm
+  class Status
+    include OhlohScm::System
+    extend Forwardable
+    def_delegators :@core, :scm, :activity
+    attr_reader :errors
+
+    def initialize(core)
+      @core = core
+    end
+
+    def exist?
+      return unless scm_dir_exist?
+
+      !activity.head_token.to_s.empty?
+    end
+
+    def scm_dir_exist?
+      Dir.exist?(scm.vcs_path)
+    end
+  end
+end

data/lib/ohloh_scm/string_extensions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OhlohScm
+  module StringExtensions
+    refine String do
+      def camelize
+        split('_').map(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/ohloh_scm/svn.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'svn/scm'
+require_relative 'svn/status'
+require_relative 'svn/activity'
+require_relative 'svn/validation'
+
+module OhlohScm
+  module Svn
+  end
+end

data/lib/ohloh_scm/svn/activity.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module OhlohScm
+  module Svn
+    class Activity < OhlohScm::Activity
+      def_delegators :scm, :url
+
+      def root
+        Regexp.last_match(1) if info =~ /^Repository Root: (.+)$/
+      end
+
+      def username_and_password_opts(source_scm = scm)
+        username = source_scm.username.to_s.empty? ? '' : "--username #{source_scm.username}"
+        password = source_scm.password.to_s.empty? ? '' : "--password='#{source_scm.password}'"
+        "#{username} #{password}"
+      end
+
+      def ls(path = nil, revision = 'HEAD')
+        stdout = run "svn ls --trust-server-cert --non-interactive -r #{revision} "\
+          "#{username_and_password_opts} "\
+          "'#{uri_encode(File.join(root.to_s, scm.branch_name.to_s, path.to_s))}@#{revision}'"
+        collect_files(stdout)
+      rescue StandardError => e
+        logger.error(e.message) && nil
+      end
+
+      def export(dest_dir, commit_id = 'HEAD')
+        FileUtils.mkdir_p(File.dirname(dest_dir)) unless File.exist?(File.dirname(dest_dir))
+        run 'svn export --trust-server-cert --non-interactive --ignore-externals --force '\
+          "-r #{commit_id} '#{uri_encode(File.join(root.to_s, scm.branch_name.to_s))}'"\
+          " '#{dest_dir}'"
+      end
+
+      def export_tag(dest_dir, tag_name)
+        tag_url = "#{base_path}/tags/#{tag_name}"
+        run 'svn export --trust-server-cert --non-interactive --ignore-externals --force'\
+              " '#{tag_url}' '#{dest_dir}'"
+      end
+
+      # Svn root is not usable here since several projects are nested in subfolders.
+      # e.g. https://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/
+      #      http://svn.apache.org/repos/asf/httpd/httpd/trunk
+      #      http://svn.apache.org/repos/asf/maven/plugin-testing/trunk
+      #      all have the same root value(https://svn.apache.org/repos/asf)
+      # rubocop:disable Metrics/AbcSize
+      def tags
+        doc = Nokogiri::XML(`svn ls --xml #{ base_path}/tags`)
+        doc.xpath('//lists/list/entry').map do |entry|
+          tag_name = entry.xpath('name').text
+          revision = entry.xpath('commit').attr('revision').text
+          commit_time = entry.xpath('commit/date').text
+          date_string = Time.parse(commit_time) unless commit_time.to_s.strip.empty?
+          [tag_name, revision, date_string]
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def head_token
+        return unless info =~ /^Revision: (\d+)$/
+
+        Regexp.last_match(1).to_i
+      end
+
+      private
+
+      def collect_files(stdout)
+        stdout.split("\n").map do |line|
+          # CVSROOT/ is found in cvs repos converted to svn.
+          line.chomp unless line.chomp.empty? || line == 'CVSROOT/'
+        end.compact.sort
+      end
+
+      def info(path = nil, revision = 'HEAD')
+        @info ||= {}
+        uri = path ? File.join(root, scm.branch_name.to_s, path) : url
+        @info[[path, revision]] ||= run 'svn info --trust-server-cert --non-interactive -r '\
+          "#{revision} #{username_and_password_opts} '#{uri_encode(uri)}@#{revision}'"
+      end
+
+      # Because uri(with branch) may have characters(e.g. space) that break the shell command.
+      def uri_encode(uri)
+        # URI.encode is declared obsolete, however we couldn't find an alternative.
+        # URI.encode('foo bar') => foo%20bar # `svn log svn://...foo%20bar` works.
+        # CGI.escape('foo bar') => foo+bar   # `svn log svn://...foo+bar` won't work.
+        # rubocop:disable Lint/UriEscapeUnescape
+        URI.encode(uri)
+        # rubocop:enable Lint/UriEscapeUnescape
+      end
+
+      def base_path
+        url.sub(/(.*)(branches|trunk|tags)(.*)/, '\1').chomp('/')
+      end
+    end
+  end
+end

data/lib/ohloh_scm/svn/scm.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module OhlohScm
+  module Svn
+    class Scm < OhlohScm::Scm
+      def normalize
+        url = prefix_file_for_local_path(@url)
+        @url = force_https_if_sourceforge(url)
+        if branch_name
+          clean_branch_name
+        else
+          @branch_name = recalc_branch_name
+        end
+        self
+      end
+
+      # From the given URL, determine which part of it is the root and
+      # which part of it is the branch_name. The current branch_name is overwritten.
+      def recalc_branch_name
+        @branch_name = url ? url[activity.root.length..-1] : branch_name
+      rescue RuntimeError => e
+        pattern = /(svn:*is not a working copy|Unable to open an ra_local session to URL)/
+        @branch_name = '' if e.message =~ pattern # we have a file system
+      ensure
+        clean_branch_name
+        branch_name
+      end
+
+      def accept_ssl_certificate_cmd
+        File.expand_path('../../../.bin/accept_svn_ssl_certificate', __dir__)
+      end
+
+      # Does some simple searching through the server's directory tree for a
+      # good canditate for the trunk. Basically, we are looking for a trunk
+      # in order to avoid the heavy lifting of processing all the branches and tags.
+      #
+      # There are two simple rules to the search:
+      #  (1) If the current directory contains a subdirectory named 'trunk', go there.
+      #  (2) If the current directory is empty except for a single subdirectory, go there.
+      # Repeat until neither rule is satisfied.
+      #
+      # The url and branch_name of this object will be updated with the selected location.
+      # The url will be unmodified if there is a problem connecting to the server.
+      # rubocop:disable Metrics/AbcSize
+      def restrict_url_to_trunk
+        return url if url.match?(%r{/trunk/?$})
+
+        list = activity.ls
+        return url unless list
+
+        if list.include? 'trunk/'
+          update_url_and_branch_with_trunk
+        elsif list.size == 1 && list.first[-1..-1] == '/'
+          update_url_and_branch_with_subdir(list)
+          return restrict_url_to_trunk
+        end
+        url
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      def update_url_and_branch_with_trunk
+        @url = File.join(url, 'trunk')
+        @branch_name = File.join(branch_name.to_s, 'trunk')
+      end
+
+      def update_url_and_branch_with_subdir(list)
+        folder_name = list.first[0..-2]
+        @url = File.join(url, folder_name)
+        @branch_name = File.join(branch_name.to_s, folder_name)
+      end
+
+      def clean_branch_name
+        return unless branch_name
+
+        @branch_name.chop! if branch_name.to_s.end_with?('/')
+      end
+
+      def force_https_if_sourceforge(url)
+        return url unless url =~ /http(:\/\/.*svn\.(sourceforge|code\.sf)\.net.*)/
+
+        # SourceForge requires https for svnsync
+        "https#{Regexp.last_match(1)}"
+      end
+
+      # If the URL is a simple directory path, make sure it is prefixed by file://
+      def prefix_file_for_local_path(path)
+        return if path.empty?
+
+        %r{://}.match?(url) ? url : 'file://' + File.expand_path(path)
+      end
+    end
+  end
+end

data/lib/ohloh_scm/svn/status.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OhlohScm
+  module Svn
+    class Status < OhlohScm::Status
+    end
+  end
+end

data/lib/ohloh_scm/svn/validation.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module OhlohScm
+  module Svn
+    class Validation < OhlohScm::Validation
+      private
+
+      def validate_server_connection
+        @errors ||= []
+        @errors << head_token_error
+        @errors << url_error
+        @errors.compact!
+      rescue StandardError
+        @errors << server_connection_error
+      end
+
+      def public_url_regex
+        /^(http|https|svn):\/\/[A-Za-z0-9_\-\.]+(:\d+)?(\/[A-Za-z0-9_\-\.\/\+%^~ ]*)?$/
+      end
+
+      # Subversion usernames have been relaxed from the abstract rules.
+      # We allow email names as usernames.
+      def username_errors
+        return if scm.username.to_s.empty?
+
+        if scm.username.length > 32
+          [:username, 'The username must not be longer than 32 characters.']
+        elsif !scm.username.match?(/^\w[\w@\.\+\-]*$/)
+          [:username, 'The username contains illegal characters.']
+        end
+      end
+
+      def head_token_error
+        return if activity.head_token
+
+        [:failed, "The server did not respond to a 'svn info' command. Is the URL correct?"]
+      end
+
+      def url_error
+        root_path = activity.root
+
+        if scm.url[0..root_path.length - 1] != root_path
+          [:failed, "The URL did not match the Subversion root #{root_path}. Is the URL correct?"]
+        elsif scm.recalc_branch_name && activity.ls.nil?
+          [:failed, "The server did not respond to a 'svn ls' command. Is the URL correct?"]
+        end
+      end
+
+      def server_connection_error
+        logger.error { $ERROR_INFO.inspect }
+        [:failed,
+         'An error occured connecting to the server. Check the URL, username, and password.']
+      end
+    end
+  end
+end

data/lib/ohloh_scm/system.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'open3'
+
+module OhlohScm
+  module System
+    protected
+
+    def run(cmd)
+      out, err, status = Open3.capture3(cmd)
+      raise "#{cmd} failed: #{out}\n#{err}" unless status.success?
+
+      out
+    end
+
+    def run_with_err(cmd)
+      logger.debug { cmd }
+      out, err, status = Open3.capture3(cmd)
+      [out, err, status]
+    end
+
+    def string_encoder_path
+      File.expand_path('../../.bin/string_encoder', __dir__)
+    end
+
+    def logger
+      System.logger
+    end
+
+    def temp_folder
+      ENV['OHLOH_SCM_TEMP_FOLDER_PATH'] || Dir.tmpdir
+    end
+
+    class << self
+      # Use a single logger instance.
+      def logger
+        @logger ||= Logger.new(STDERR).tap do |log_obj|
+          log_obj.level = ENV['SCM_LOG_LEVEL'].to_i
+        end
+      end
+    end
+  end
+end

data/lib/ohloh_scm/validation.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'timeout'
+
+module OhlohScm
+  class Validation
+    include OhlohScm::System
+    extend Forwardable
+    def_delegators :@core, :scm, :activity, :status
+    attr_reader :errors
+
+    def initialize(core)
+      @core = core
+    end
+
+    def validate
+      validate_attributes
+      Timeout.timeout(timeout_interval) { validate_server_connection } if @errors.none?
+    end
+
+    private
+
+    def validate_server_connection
+      return unless valid?
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def validate_attributes
+      @errors = []
+      @errors << url_errors
+      @errors << branch_name_errors unless scm.branch_name.to_s.empty?
+      @errors << username_errors if scm.username
+      @errors << password_errors if scm.password
+      @errors.compact!
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # rubocop:disable Metrics/AbcSize
+    def url_errors
+      error = if scm.url.nil? || scm.url.empty?
+                "The URL can't be blank."
+              elsif scm.url.length > 120
+                'The URL must not be longer than 120 characters.'
+              elsif !scm.url.match?(public_url_regex)
+                'The URL does not appear to be a valid server connection string.'
+              end
+
+      [:url, error] if error
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def branch_name_errors
+      if scm.branch_name.length > 80
+        [:branch_name, 'The branch name must not be longer than 80 characters.']
+      elsif !scm.branch_name.match?(/^[\w^\-\+\.\/\ ]+$/)
+        [:branch_name, "The branch name may contain only letters, numbers, \
+           spaces, and the special characters '_', '-', '+', '/', '^', and '.'"]
+      end
+    end
+
+    def username_errors
+      if scm.username.length > 32
+        [:username, 'The username must not be longer than 32 characters.']
+      elsif !scm.username.match?(/^\w*$/)
+        [:username, 'The username may contain only A-Z, a-z, 0-9, and underscore (_)']
+      end
+    end
+
+    def password_errors
+      if scm.password.length > 32
+        [:password, 'The password must not be longer than 32 characters.']
+      elsif !scm.password.match?(/^[\w!@\#$%^&*\(\)\{\}\[\]\;\?\|\+\-\=]*$/)
+        [:password, 'The password contains illegal characters']
+      end
+    end
+
+    def timeout_interval
+      ENV['SCM_URL_VALIDATION_TIMEOUT']&.to_i || 60
+    end
+
+    def public_url_regex; end
+  end
+end

data/lib/ohloh_scm/version.rb

@@ -1,5 +1,12 @@
+# frozen_string_literal: true
+
 module OhlohScm
   module Version
-    STRING = '2.5.1'
+    STRING = '3.0.1'
+    GIT = '2.17.1'
+    SVN = '1.9.7'
+    CVSNT = '2.5.04'
+    HG = '4.5.3'
+    BZR = '2.8.0'
   end
 end