ossert 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4e0028dc0e8484c13af62aa08115e2054372885
+  data.tar.gz: f3b8c10d0367809899dd376360155cecb32eee60
+SHA512:
+  metadata.gz: a7f7872c3351e0a19fa4886720d65b32c5c421824d7acd7449f254cf1bbfe58b3eff5ea5d96317978ec47f9cc96a01e1b15fa4db9df246bb91cc1db90e40bc87
+  data.tar.gz: 4324ce5e6650e59a592f608cdb7110b3fa9985b5598bd4a27b50d40cf9e7a225d17bfe4cd7d195c81656cf0df9c7435011a2db09c8b0042382001712f30cfec2

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/db/backups/*.psql
+/db/backups/*.sql
+/db/backups/*.dump
+/tmp/
+/data/
+/reports/
+NOTES.md
+

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop_todo.yml

@@ -0,0 +1,44 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-10-28 16:34:29 +0300 using RuboCop version 0.44.1.
+
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+Metrics/AbcSize:
+  Max: 16
+  Exclude:
+    - 'lib/ossert/fetch/github.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'ossert.gemspec'
+    - 'lib/ossert/tasks/ossert.rake'
+    - 'lib/ossert/tasks/database.rake'
+    - 'spec/ossert_spec.rb'
+    - 'spec/spec_helper.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/ossert/fetch/github.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/ossert/fetch/github.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/ossert/fetch/github.rb'
+
+Metrics/PerceivedComplexity:
+  Max: 16
+  Exclude:
+    - 'lib/ossert/fetch/github.rb'
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+ossert

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2
+cache: bundler
+addons:
+  postgresql: "9.4"
+env:
+  global:
+    - GITHUB_TOKEN="6a21f190e3422bf89afa8b360d923b0c30e8fbfa"
+    - TEST_DATABASE_URL='postgres://localhost/ossert_test'
+    - REDIS_URL='redis://localhost'
+before_script:
+  - bundle exec rake db:test:prepare
+script:
+ - bundle exec rspec

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gem 'decisiontree', github: 'sclinede/decisiontree'
+gem 'sawyer', github: 'sclinede/sawyer'
+
+# Specify your gem's dependencies in ossert.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sergey Dolganov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,199 @@
+Code quality? Checked by [RuboCop](https://github.com/bbatsov/rubocop/) (crowdsourced code quality metrics)
+What about library support?
+Introducing **Ossert**! Crowdsourced project support and availablity metrics.
+
+# ossert (OSS cERTificate) [![Build Status](https://travis-ci.org/ossert/ossert.svg?branch=master)](https://travis-ci.org/ossert/ossert) [![Inline docs](http://inch-ci.org/github/ossert/ossert.svg)](http://inch-ci.org/github/ossert/ossert)  [![Code Climate](https://codeclimate.com/github/ossert/ossert/badges/gpa.svg)](https://codeclimate.com/github/ossert/ossert)
+
+The main goal of project is to provide "certificate" for open-source software with different validity check, just to be more
+formal in estimation of projects' risks, value and ability to use in an enterprise.
+Also system is designed as open one, so any new checks and validations from community are appreciated.
+
+The simple structure is:
+- "Project" has set of raw attributes gathered from different data sources and metrics built upon them.
+- "Fetch" classes gathers data from sources like Rubygems, Bestgems, GitHub.
+- "Reference" class chooses reference projects from different popularity groups (from most to the least popular).
+- "Classifiers::Growing::Classifier" class prepares classification  by sections (Maintenance, Popularity, Maturity) using reference projects.
+  Each classifier section performs calculation upon its own metrics and weights.
+- "Classifiers::Growing::Check" running checks against classifier and prepares marks for particular project.
+
+Project tries to answer simple question: "Is this gem ready for production? Will it be available and consistent in a year?"
+Ossert marks projects with grades A, B, C, D, E. Highest grade means you possibly can trust that open-source project because it is
+used widely and supported in efficient way. Less grades means higher risks for production.
+
+Also you can check several alternatives against same checks to select most stable and mature from them.
+
+Long term milestone is to provide not only marks and metrics but also give a context of classification (trends, metadata, discussions, docs, users and so on).
+This tool should help you dive into any open-source library on any level of detalization, from overall marks to a particular change in time.
+
+## Metrics
+
+I choose to start with following basic validity checks
+
+### Project Community Metrics
+
+#### Stats, total for all time
+- Users count writing issues
+- Users count sent PR
+- Contributors count
+- Watchers, Stargazers, Forks
+- Owners... (link Rubygems and Github by email)
+
+#### Pulse, for last year/quarter/month (amount + delta from total)
+- Users count writing issues
+- Users count sent PR
+- Contributors count
+- Watchers, Stargazers, Forks
+
+### Project Agility Metrics
+
+#### Stats, total for all time
+- Opened and Closed Issues
+- Opened, Merged and Closed PRs
+- Opened non-author Issues, "with author comments" and total count
+- Time since first/last PR and Issue
+- Releases Count
+- Last Release Date
+- Commits count since last release
+- Amount of changes each quarter
+- Stale and Total branches count
+
+#### Pulse, for last year/quarter/month (amount + delta from total)
+- Opened and Closed Issues
+- Opened and Merged PRs
+- Releases Count
+- Downloads divergence
+- Downloads degradation per release (Comes later)
+- Stale Branches Count
+
+## Existining alternatives
+
+### RecordNotFound.com
+Interesting overview by commits and pull requests activity, not very detailed
+
+### Github Archive (https://www.githubarchive.org/#bigquery)
+
+### RubyToolbox has:
+- Popularity Rating (https://www.ruby-toolbox.com/projects/delayed_job/popularity)
+- Links, from gemspec
+  - Website
+  - RDoc
+  - Wiki
+  - Source Code
+  - Bug Tracker
+- from Rubygems
+  - Total Downloads + increased for month
+  - Total Releases Count
+  - Current Version
+  - When Released
+  - First Release Date
+  - Depends on following gems
+  - Depending Gems (reverse dependencies)
+  - Popular gems depending on this... (list)
+- from Github
+  - Watchers
+  - Forks
+  - Development activity (N commits within last year)
+  - Last commit date
+  - First commit date
+  - Top contributors
+  - Contributors Count
+  - Issues Count
+  - Wiki pages link
+
+### Rubygems has:
+- Total Downloads
+- Total Releases Count
+- current version and when it was released
+- first release date
+- Dependencies
+- Depending Gems (reverse dependencies)
+
+### Github has:
+- Opened and Closed PRs
+- Opened and Closed Issues
+- Labels list
+- Milestones list
+- Watchers Count & Links
+- Stargazers Count & Links
+- Forks Count & Links
+- Commits Count
+- Branches Count
+- Releases Count
+- Contributors Count
+- Latest commit date
+
+#### Pulse, for month/week/3 days/24 hours period
+"Excluding merges, 29 authors have pushed 76 commits to master and 87 commits to all branches.
+ On master, 128 files have changed and there have been 5,342 additions and 5,554 deletions."
+- Active PRs Count and List (sent, merged)
+- Active Issues Count and List (new, closed)
+- Unresolved conversations
+  "Sometimes conversations happen on old items that aren’t yet closed.
+  Here is a list of all the Issues and Pull Requests with unresolved conversations."
+
+#### Graphs, all time or selected period
+- Top contributors (by commits/additoins/deletions)
+- Commits timeline
+- Code frequency (Additions/Deletions amount on timeline)
+- Punch card (Days and Hours of most activity)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ossert'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ossert
+
+After that you should set ENV variables:
+
+```
+$ export GITHUB_TOKEN xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+$ export REDIS_URL redis://localhost/
+$ export DATABASE_URL postrgres://localhost/ossert
+$ export TEST_DATABASE_URL postrgres://localhost/ossert_test
+```
+
+Then you can run:
+
+```
+bundle exec rake db:setup
+```
+
+Or if you have previous dumps of data:
+
+```
+bundle exec rake db:restore:last
+```
+
+
+## Usage
+
+For interactive experiments run:
+
+```
+bin/console
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ossert/ossert.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'sequel'
+
+require 'bundler'
+Bundler.require
+
+RSpec::Core::RakeTask.new(:spec)
+Dir.glob('lib/ossert/tasks/*.rake').each { |r| import r }
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ossert'
+
+Ossert.init
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/classifiers.yml

@@ -0,0 +1,153 @@
+classifiers:
+  growth:
+    trusted_probability: 0.65
+    checks:
+      - popularity
+      - maintenance
+      - maturity
+    syntetics:
+      download_divergence: 5
+      stale_branches_count: 15
+      pr_actual_count: 100
+      pr_active_percent: 90
+      pr_closed_percent: 90
+      issues_actual_count: 200
+      issues_active_percent: 90
+      issues_closed_percent: 90
+      dependants_count:
+        - 500
+        - 100
+        - 20
+        - 5
+        - 1
+      first_issue_date_int:
+        - 1161160504 # Best
+        - 1476783369 # Worst
+      first_pr_date_int:
+        - 1161160504 # Best
+        - 1476783369 # Worst
+      last_release_date_int:
+        - 1476783369  # Best
+        - 1161160504 # Worst
+      issues_processed_in_median:
+        - 7
+        - 120
+      pr_processed_in_median:
+        - 1
+        - 90
+      issues_processed_in_avg:
+        - 7
+        - 120
+      pr_processed_in_avg:
+        - 1
+        - 90
+    reversed:
+      - stale_branches_count
+      - issues_active_percent
+      - pr_active_percent
+      - issues_actual_count
+      - pr_actual_count
+      - issues_processed_in_avg
+      - pr_processed_in_avg
+      - issues_processed_in_median
+      - pr_processed_in_median
+      - first_issue_date_int
+      - first_pr_date_int
+    metrics:
+      popularity:
+        last_year:
+          users_creating_issues_count: 3
+          users_commenting_issues_count: 3
+          users_creating_pr_count: 3
+          users_commenting_pr_count: 3
+          stargazers_count: 3
+          forks_count: 3
+          users_involved_count: 3
+          users_involved_no_stars_count: 3
+          total_downloads_count: 3
+        total:
+          dependants_count: 4
+          users_creating_issues_count: 1
+          users_commenting_issues_count: 1
+          users_creating_pr_count: 1
+          users_commenting_pr_count: 1
+          contributors_count: 1
+          watchers_count: 1
+          forks_count: 1
+          users_involved_no_stars_count: 1
+          total_downloads_count: 1
+      maintenance:
+        last_year:
+          issues_processed_in_avg: 1
+          issues_processed_in_median: 1
+          issues_closed_percent: 2
+          issues_all_count: 2
+          pr_processed_in_avg: 1
+          pr_processed_in_median: 1
+          pr_closed_percent: 2
+          pr_all_count: 2
+          releases_count: 4
+          commits: 4
+        total:
+          issues_closed_percent: 0.5
+          issues_non_owner_percent: 0.5
+          issues_with_contrib_comments_percent: 0.5
+          issues_all_count: 0.5
+          issues_processed_in_avg: 0.25
+          issues_processed_in_median: 0.25
+          pr_closed_percent: 0.5
+          pr_non_owner_percent: 0.5
+          pr_with_contrib_comments_percent: 0.5
+          pr_all_count: 0.5
+          pr_processed_in_avg: 0.25
+          pr_processed_in_median: 0.25
+          releases_count: 1
+          stale_branches_count: 1
+          life_period: 1
+          last_changed: 1
+      maturity:
+        last_year:
+          users_creating_issues_count: 2
+          users_commenting_issues_count: 2
+          users_creating_pr_count: 2
+          users_commenting_pr_count: 2
+          stargazers_count: 2
+          forks_count: 2
+          users_involved_count: 2
+          users_involved_no_stars_count: 2
+          total_downloads_count: 2
+          issues_processed_in_avg: 1
+          issues_processed_in_median: 1
+          issues_closed_percent: 1
+          issues_all_count: 1
+          pr_processed_in_avg: 0.5
+          pr_processed_in_median: 0.5
+          pr_closed_percent: 1
+          pr_all_count: 1
+          releases_count: 2
+          commits: 2
+        total:
+          dependants_count: 3
+          users_creating_issues_count: 1
+          users_commenting_issues_count: 1
+          users_creating_pr_count: 1
+          users_commenting_pr_count: 1
+          watchers_count: 1
+          forks_count: 1
+          users_involved_no_stars_count: 1
+          total_downloads_count: 1
+          issues_closed_percent: 0.5
+          issues_non_owner_percent: 0.5
+          issues_with_contrib_comments_percent: 0.5
+          issues_all_count: 0.5
+          issues_processed_in_avg: 0.5
+          pr_closed_percent: 0.5
+          pr_non_owner_percent: 0.5
+          pr_with_contrib_comments_percent: 0.5
+          pr_all_count: 0.5
+          pr_processed_in_avg: 0.5
+          commits: 1
+          releases_count: 1
+          stale_branches_count: 1
+          life_period: 1
+          last_changed: 1

data/config/descriptions.yml

@@ -0,0 +1,45 @@
+descriptions:
+  # Agility
+  dependencies_count: Total number of external dependecies used in runtime
+  issues_closed_percent: Percent of closed issues from the total number
+  issues_non_owner_percent: Percent of issues created by non-owners of the repo from the total number
+  issues_with_contrib_comments_percent: Percent of issues with contributor comments from the total number
+  issues_all_count: Total number of issues with any status
+  issues_processed_in_avg: Average time to close issue up to day
+  issues_processed_in_median: Median time to close issue up to day
+  first_issue_date_int: Date when first issue was created
+  last_issue_date_int:  Date when last issue was created
+  pr_closed_percent: Percent of closed pull requests from the total number
+  pr_non_owner_percent: Percent of pull requests created by non-owners of the repo from the total number
+  pr_with_contrib_comments_percent: Percent of pull requests with contributor comments from the total number
+  pr_all_count: Total number of pull requests with any status
+  pr_processed_in_avg: Average time to close pull request up to day
+  pr_processed_in_median: Median time to close pull request up to day
+  first_pr_date_int: Date when first pull requests was created
+  last_pr_date_int: Date when last pull requests was created
+  pr_actual_count: Number of pull requests that were still open on the start of the period
+  last_release_date_int: Date of latest release of the project
+  releases_count: Total number of releases for period
+  commits_count_since_last_release_count: How many commits where made since the last project release
+  stale_branches_count: Number of stale branches, where stale means that the branch was not updated for whole quarter
+  life_period: Time period since the moment of first action till the last one
+  last_changed: Date of last change of the project
+  issues_actual_count: Number of issues that were open on the start of the period
+  commits: How many commits where made during the period
+
+  # Community
+  dependants_count: Total number of projects that depends on current
+  users_creating_issues_count: Number of unique users that created issues
+  users_commenting_issues_count: Number of unique users that commented any issue
+  users_creating_pr_count: Number of unique users that requested a pull
+  users_commenting_pr_count: Number of unique users commented any pull request
+  watchers_count: Number of unique watchers on Github
+  contributors_count: Number of unique contributors
+  stargazers_count: Number of unique users that starred the project
+  forks_count: Number of unique users that forked the project
+  users_involved_count: Number of unique users made any action for the project like leaving comment or requesting a pull
+  users_involved_no_stars_count:
+    Number of unique users that made any action for project excluding users that only give a Star on Github
+  total_downloads_count: Total number of downloads since first day of the project
+  delta_downloads: Number of downloads that were made during period
+  download_divergence: Downloads Growth From Previous Period %

data/config/sidekiq.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'ossert'
+
+SIDEKIQ_REDIS_CONFIGURATION = {
+  url: ENV.fetch('REDIS_URL'),
+  namespace: 'ossert_sidekiq'
+}.freeze
+
+Sidekiq.configure_server do |config|
+  config.redis = SIDEKIQ_REDIS_CONFIGURATION
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = SIDEKIQ_REDIS_CONFIGURATION
+end