No commit activity in last 3 years
No release in over 3 years
Calculate statics for multiple project contributoions.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

 Project Readme

Contributors stats

Gem Version Code Climate Coverage Status Build Status Dependency Status Documentation

Update static files with contributors statistics.

  • Static content update of contributors statistics.
  • Plugable:
  • backends to load data
  • user details calculation
  • output fomratters
  • target files updating

Usage

Contributors stats consists on two basic parts and few plugins.

calculator = ContributorsStats.load(<options>)
calculator.load(:<type> => '<name>')
calculator.user_data_type = :<user_data_type>
formatter = calculator.format(:<format>)
formatter.save('<file>', ...)
formatter.update('<file>', ..., options: <options>)
puts formatter.content

Plugins are loaded automatically, for example calculator.user_data_type = :fetch will load plugins/contributors_stats/user_data/fetch.rb and use ContributorsStats::UserData::Fetch and use it to process user details calculation.

Examples

ContributorsStats.load(gh_org:  'railsisntaller').format(:markdown).save('public/contributors.md')
ContributorsStats.load(gh_repo: 'railsisntaller/website').format.update('public/index.html')
ruby -I lib:lib/plugins -rcontributors_stats -e "puts ContributorsStats.load(:gh_org => 'rvm', :gh_repo => ['wayneeseguin/rvm', 'wayneeseguin/rvm-capistrano'], :user_data => :fetch).format(:html).content"