ohloh_scm 2.5.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7aabc469e74657337d3401366c824c144fd4b569
-  data.tar.gz: 2f34967d29e05c980b5c6acc43a10d9f36bcf3a8
+SHA256:
+  metadata.gz: 2173a9ecad75fe5931641a605c4e8706bdfb309223d19b2684e011adcfb9fae9
+  data.tar.gz: 2aef4446cfc221a4a98c999234b8ca68f2ec9d0497802b79ee2b3014605af3c1
 SHA512:
-  metadata.gz: 45e426c1379169bdffcee9683d84bbf6428eb55c727e869c75e6e4b23195aa045e109bbb9be0956ed27b9dd4afb729cdc17c327b842df4692b23910bd688a051
-  data.tar.gz: 30d48db3b286541d580e59a1d432b5bce19808c7ce92b2b322e69ecbbdd746af6e1ca18bccd29a41e4a3c2dafa61df778463c1a2864238bcf545835c43a8d2ff
+  metadata.gz: f165668f9034a61e88147e16573cc8e1ac04200868e31cd1de2f7b0ce52518c4ebd53e3255b87c7d18d80b6c912a442ef0c6aed5c23c7c248f3da8ab8bf7a8c1
+  data.tar.gz: ed2815782e55330b3ad564b37c450d6e5402418816580aa2bb0006081672c12ed60a62539ba79c41bf939e647b74b991cdc56cb8d5ed0476ae8fdc293ac4a310

data/.bin/check_scm_version

@@ -0,0 +1,28 @@
+#! /usr/bin/env ruby
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
+require 'open3'
+require_relative '../lib/ohloh_scm/version'
+
+SCM_CLI_LIST = %w[git svn cvsnt hg bzr].freeze
+
+def match_scm_cli(scm_type)
+  scm_version = get_scm_version(scm_type)
+  major_version = Object.const_get('OhlohScm::Version::' + scm_type.upcase)
+  return if scm_version.nil? || major_version.to_i == scm_version.to_i
+  STDERR.puts "warning: Ohloh SCM is compatible with #{scm_type} v#{major_version.to_i}.x.x. "\
+              "The installed #{scm_type} version is #{scm_version}."
+end
+
+def get_scm_version(scm_type)
+  out, _err, _status = Open3.capture3("#{scm_type} --version --quiet")
+  out, _err, _status = Open3.capture3("#{scm_type} --version") if out.empty?
+  out.match(/(\d+\.)(\d+\.)(\d+)/).to_s
+rescue => exception
+  STDERR.puts exception
+  nil
+end
+
+SCM_CLI_LIST.each do |scm_type|
+  match_scm_cli(scm_type)
+end

data/.bin/run-test

@@ -0,0 +1,3 @@
+#! /usr/bin/env bash
+
+bundle exec ruby -Ispec $1 --name /.*$2.*/

data/.bin/run-tests

@@ -0,0 +1,3 @@
+#! /usr/bin/env bash
+
+bundle exec ruby -Ispec $@

data/.git_hooks/pre-commit

@@ -0,0 +1,20 @@
+#! /usr/bin/env bash
+
+echo-color() { echo " $@ "; }
+modified_files=$(git diff --cached --name-only | grep '.*.rb$')
+
+# Run Rubocop
+[ -z "$modified_files" ] && exit 0
+echo-color 'Running rubocop on cached ruby files:'
+bundle exec rubocop $modified_files || exit 1
+
+test_files=()
+for filepath in $modified_files; do
+  testpath=$(echo $filepath | sed 's/^lib/spec/' | sed 's/\.rb$/_spec.rb/')
+  [ -e $testpath ] && test_files+=($testpath)
+done
+
+# Run tests
+[ -z "$test_files" ] && exit 0
+echo-color 'Running related tests for cached ruby files:'
+.bin/run-tests $test_files

data/.gitignore

@@ -1,5 +1,2 @@
-*.swp
-*.pyc
-pkg/
-*.cache
 .byebug*
+coverage

data/.rubocop.yml

@@ -0,0 +1,13 @@
+require: rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/LineLength:
+  Max: 99
+
+Documentation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/.ruby-version

@@ -1,2 +1 @@
-2.2.5
-
+2.5.3

data/.travis.yml

@@ -2,5 +2,6 @@ language: generic
 services:
   - docker
 before_install:
-  - docker pull notalex/ohloh_scm:ubuntu18
-script: docker run -P -w /home/app/ohloh_scm -v $(pwd):/home/app/ohloh_scm -ti notalex/ohloh_scm:ubuntu18 /bin/sh -c "/etc/init.d/ssh start; LANG=en_US.UTF-8 rake test 2> /dev/null"
+  - docker pull ohdeployer/ohloh_scm:ubuntu18
+script:
+  - docker run -P -v $(pwd):/home/app/ohloh_scm -ti ohdeployer/ohloh_scm:ubuntu18 /bin/sh -c "/etc/init.d/ssh start; rubocop && LANG=en_US.UTF-8 rake test 2> /dev/null"

data/Dockerfile

@@ -9,7 +9,7 @@ RUN locale-gen en_US.UTF-8
 
 RUN apt-add-repository -y ppa:brightbox/ruby-ng
 RUN apt-get update
-RUN apt-get install -y ruby2.3 ruby2.3-dev
+RUN apt-get install -y ruby2.5 ruby2.5-dev
 
 RUN apt-get install -y ragel libxml2-dev libpcre3 libpcre3-dev swig gperf openssh-server expect
 RUN apt-get install -y git git-svn subversion cvs mercurial bzr
@@ -24,8 +24,12 @@ RUN bzr branch lp:bzr-xmloutput ~/.bazaar/plugins/xmloutput
 
 RUN ln -s /usr/bin/cvs /usr/bin/cvsnt
 
-RUN gem install posix-spawn -v '~> 0.3'
-RUN gem install nokogiri -v '~> 1.8'
-RUN gem install rake test-unit byebug
+RUN gem install rake
+RUN gem install bundler -v '~> 1.17'
 
 RUN mkdir -p /home/app/ohloh_scm
+WORKDIR /home/app/ohloh_scm
+ADD . /home/app/ohloh_scm
+
+RUN bundle config --global silence_root_warning 1
+RUN bundle install

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+group :development do
+  gem 'byebug'
+  gem 'minitest'
+  gem 'mocha'
+  gem 'nokogiri'
+  gem 'rake'
+  gem 'rubocop', '~> 0.67'
+  gem 'rubocop-performance'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.0.1)
+    docile (1.3.1)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
+    metaclass (0.0.4)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    mocha (1.8.0)
+      metaclass (~> 0.0.1)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.1.0)
+      rubocop (>= 0.67.0)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  minitest
+  mocha
+  nokogiri
+  rake
+  rubocop (~> 0.67)
+  rubocop-performance
+  simplecov
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -4,20 +4,6 @@
 
 The OpenHub source control management library
 
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License Version 2 as
-published by the Free Software Foundation.
-
-Ohcount is specifically licensed under GPL v2.0, and no later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
 ## Overview
 
 Ohloh SCM is an abstraction layer for source control management systems,
@@ -27,130 +13,80 @@ single interface.
 It was originally developed at OpenHub, and is used to generate
 the reports at www.openhub.net.
 
-## System Requirements
-
-One could use the bundled Dockerfile to test Ohloh SCM in a container and skip
-this section entirely. See [docker](https://github.com/blackducksoftware/ohloh_scm/#using-docker).
-
-Ohloh SCM is developed on Mac OS X 10.13.6(High Sierra) and Ubuntu 18.04 LTS.
-Other Linux environments should also work, but your mileage may vary.
-
-Ohloh SCM does not support Windows.
-
-Ohloh SCM targets Ruby 2.3 and Rake 12.3.
-
-Ohloh SCM interfaces with CVSNT, Subversion, Git and Mercurial through the
-shell. In order to pass the unit tests, all three systems must be installed
-and on your path. Ohloh is currently tested on the following versions:
-
-cvsnt 2.5.03
-svn 1.9.7
-git 2.17.1
-hg 4.5.3
-bzr 2.8.0
-
-If you are using CVS instead of CVSNT, you can potentially try creating
-a shell alias or symlink mapping 'cvsnt' to 'cvs'.
-
-Ohloh SCM uses [posix-spawn](https://github.com/rtomayko/posix-spawn) to
-execute commands so ensure *posix-spawn* gem is installed
+## Using Docker
 
-``gem install posix-spawn``
+One may use Docker to run Ohloh SCM and test changes.
 
+```sh
+$ git clone https://github.com/blackducksoftware/ohloh_scm
+$ cd ohloh_scm
+$ git checkout -b v3
 
-## Usage with Bundler
+# To run all tests, we need to start the ssh server and set UTF-8 locale for encoding tests.
+$ cmd='/etc/init.d/ssh start; LANG=en_US.UTF-8 rake test 2> /dev/null'
+$ docker run -P -v $(pwd):/home/app/ohloh_scm -ti ohdeployer/ohloh_scm:ubuntu18 /bin/sh -c "$cmd"
+# This mounts the current folder into the docker container;
+#   hence any edits made in ohloh_scm on the host machine would reflect in the container.
 
+# One may also edit the Dockerfile & build the image locally for other distros.
+$ docker build -t ohloh_scm:custom .
+$ docker run -P -v $(pwd):/home/app/ohloh_scm -ti ohloh_scm:custom /bin/bash
 ```
-gem 'ohloh_scm', git: 'https://github.com/blackducksw/ohloh_scm/', require: 'scm'
-gem 'posix-spawn'
-```
-## Running
-
-Ensure that cvsnt, svn, svnadmin, svnsync, git, and hg are all on your path. You'll also need to ensure that you have the xmloutput plugin installed for bazaar.
-
-### Installing The XmlOutput Plugin
-    $ cd ~
-    $ mkdir .bazaar
-    $ cd .bazaar
-    $ mkdir plugins
-    $ cd plugins
-
-Now checkout the latest version of the xmloutput plugin (0.8.8 as of 11/21/2011).
-
-    $ bzr branch lp:~amujumdar/bzr-xmloutput/emit_authors
-
-The default checkout directory is poorly named and bazaar will complain about this unless it is renamed.
 
-    $ mv emit_authors xmloutput
+## Development Setup
 
-Now you just need to install the xmloutput plugin
+Besides docker, one could setup OhlohScm locally on Ubuntu with the following commands:
 
-    $ cd xmloutput
-    $ python setup.py build_ext -i
+```sh
+sudo apt-get update
+sudo apt-get install -y build-essential software-properties-common
 
-Verify that the plugin was installed correctly
+sudo apt-add-repository -y ppa:brightbox/ruby-ng
+sudo apt-get update
+sudo apt-get install -y ruby2.5 ruby2.5-dev
 
-    $ bzr plugins
+sudo apt-get install -y ragel libxml2-dev libpcre3 libpcre3-dev swig gperf
+sudo apt-get install -y git git-svn subversion cvs mercurial bzr
+sudo ln -s /usr/bin/cvs /usr/bin/cvsnt
 
-You should see some text like "xmloutput 0.8.8"
+mkdir -p ~/.bazaar/plugins
+cd ~/.bazaar/plugins
+bzr branch lp:bzr-xmloutput ~/.bazaar/plugins/xmloutput
 
-Then you can run the unit tests:
+gem install bundler
+bundle install
 
-    $ rake
+# For running tests
+sudo apt-get install -y openssh-server expect locales
+sudo locale-gen en_US.UTF-8
+```
 
-You can load the library into your own Ruby application by requiring lib/ohloh_scm.rb.
+OhlohScm is currently tested on the following versions:
+Git 2.17.1, SVN 1.9.7, CVSNT 2.5.04, Mercurial 4.5.3 and Bazaar 2.8.0
 
-## Using Docker
+OhlohScm has been tested with other linux distros and MacOSx. The installation instructions will differ.
+Let us know if you need help installing OhlohScm on other distros.
 
-One may use Docker to run Ohloh SCM and test changes.
+## Running tests
 
 ```sh
-$ git clone https://github.com/blackducksoftware/ohloh_scm
-$ cd ohloh_scm
+$ rake test
+$ ./bin/run-test spec/ohloh_scm/version_spec.rb foobar # run a single test matching 'foobar' # Used as /.*foobar.*/.
+$ ./bin/run-tests version_spec.rb foobar_spec.rb      # run multiple tests.
+```
 
-# To run all tests, we need to start the ssh server and set UTF-8 locale for encoding tests.
-$ cmd='/etc/init.d/ssh start; LANG=en_US.UTF-8 rake test 2> /dev/null'
-$ docker run -P -w /home/app/ohloh_scm -v $(pwd):/home/app/ohloh_scm -ti notalex/ohloh_scm:ubuntu18 /bin/sh -c "$cmd"
-# This mounts the current folder into the docker container;
-#   hence any edits made in ohloh_scm on the host machine would reflect in the container.
+## Auto check for rubocop compliance and test failures
 
-# One may also edit the Dockerfile & build the image locally for other distros.
-$ docker build -t ohloh_scm:custom .
-$ docker run -ti ohloh_scm:custom -v $(pwd):/home/app/ohloh_scm /bin/bash
+This will prevent a git commit if the files being committed fail rubocop or their related tests.
+```sh
+$ git config core.hooksPath .git_hooks/
+```
+```sh
+# Skip hooks when committing temporary code that breaks rubocop/tests.
+$ git commit -m 'temp' --no-verify
 ```
 
-# Functionality
-
-For each tracked repository, OpenHub uses the SCM library to maintain a private
-local mirror. The SCM library hides the differences between source control
-systems. The SCM library manages all required updates to a mirror, and reports
-the contents of the mirror in standardized ways.
-
-Each mirror is assigned a dedicated directory, and the SCM library adapter may
-store any content it desires in that directory. Usually, it's a direct clone of
-the original repository, but in the case of CVS or some Subversion servers, it
-is a conversion of the original repository to Git.
-
-The main OpenHub application orchestrates the scheduling of all updates and
-backups. On demand, the SCM library adapter then performs the following basic
-tasks on the local mirror:
-
-1. Pull changes -- From a remote repository URL, pull any changes to the local
-mirror. This step may involve conversion from one system to another.
-2. Push changes -- From the local mirror, push any changes to another OpenHub
-server. This is required to create backup copies and perform load balancing on
-the OpenHub cluster, and typically occurs over ssh.
-3. Commit log -- Given the last known commit, report the list of new commits,
-if any, including their diffs.
-4. Cat file or parent -- Given a commit, return either the contents of a
-single file, or that file's previous contents.
-5. Export tree -- Given a commit, export the entire contents of the source tree
-to a specified temp directory.
-
-The adapter must also implement validation routines used to filter user inputs
-and confirm the presence of the remote server.
-
-# Contact OpenHub
+## Contact OpenHub
 
 You can reach OpenHub via email at:
 [info@openhub.net](mailto:info@openhub.net)

data/Rakefile

@@ -1,33 +1,11 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-
-require 'rubygems'
-require 'rubygems/package_task'
+# frozen_string_literal: true
 
-spec = Gem::Specification.new do |s|
-  s.name = 'ohloh_scm'
-  s.version = '0.0.1'
-  s.author = 'Robin Luckey'
-  s.email = 'robin@ohloh.net'
-  s.homepage = 'http://labs.ohloh.net'
-  s.platform = Gem::Platform::RUBY
-  s.summary = 'Ohloh Source Control Management Library'
-  s.files = FileList['README', 'COPYING', '{bin,lib,test}/**/*']
-  s.require_path = 'lib'
-  s.executables = 'ohlog'
-  s.has_rdoc = true
-  s.extra_rdoc_files = ['README']
-  s.test_files = FileList["test/**/*"]
-end
+require 'rake/testtask'
 
-Gem::PackageTask.new(spec) do |pkg|
-  pkg.need_tar = true
-  pkg.need_zip = true
-end
+ENV['SIMPLECOV_START'] = 'true'
+task default: :test
 
-Rake::TestTask.new :test do |t|
-	t.test_files = FileList[File.dirname(__FILE__) + '/test/unit/**/*_test.rb']
+Rake::TestTask.new do |task|
+  task.libs << 'spec'
+  task.pattern = 'spec/**/*_spec.rb'
 end
-
-task :default => :test