以图形方式呈现数据

在本指南中，我们将使用 API 获取我们拥有的仓库及其所使用的编程语言信息。然后，使用 D3.js 库以几种不同方式对这些信息进行可视化。为了与 GitHub API 交互，我们将使用优秀的 Ruby 库 Octokit。

如果您还没有阅读，请先阅读身份验证基础指南，然后再开始本示例。您可以在 platform-samples 仓库中找到本项目的完整源代码。

让我们马上开始吧！

设置 OAuth 应用

首先，在 GitHub 上注册一个新应用。将主 URL 和回调 URL 设置为 https://:4567/。如同之前所述，我们将通过使用 sinatra-auth-github 实现 Rack 中间件来处理 API 的身份验证。

require 'sinatra/auth/github'

module Example
  class MyGraphApp < Sinatra::Base
    # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!!
    # Instead, set and test environment variables, like below
    # if ENV['GITHUB_CLIENT_ID'] && ENV['GITHUB_CLIENT_SECRET']
    #  CLIENT_ID        = ENV['GITHUB_CLIENT_ID']
    #  CLIENT_SECRET    = ENV['GITHUB_CLIENT_SECRET']
    # end

    CLIENT_ID = ENV['GH_GRAPH_CLIENT_ID']
    CLIENT_SECRET = ENV['GH_GRAPH_SECRET_ID']

    enable :sessions

    set :github_options, {
      :scopes    => "repo",
      :secret    => CLIENT_SECRET,
      :client_id => CLIENT_ID,
      :callback_url => "/"
    }

    register Sinatra::Auth::Github

    get '/' do
      if !authenticated?
        authenticate!
      else
        access_token = github_user["token"]
      end
    end
  end
end

像前面的示例一样，设置一个类似的 config.ru 文件

ENV['RACK_ENV'] ||= 'development'
require "rubygems"
require "bundler/setup"

require File.expand_path(File.join(File.dirname(__FILE__), 'server'))

run Example::MyGraphApp

获取仓库信息

这一次，为了与 GitHub API 交互，我们将使用 Octokit Ruby 库。这比直接进行大量 REST 调用要容易得多。而且 Octokit 由 GitHub 员工开发，并且持续维护，可确保其可用。

使用 Octokit 对 API 进行身份验证很简单，只需将您的登录名和令牌传递给 Octokit::Client 构造函数即可。

if !authenticated?
  authenticate!
else
  octokit_client = Octokit::Client.new(:login => github_user.login, :oauth_token => github_user.token)
end

让我们对仓库数据做点有趣的事。我们将查看它们使用的不同编程语言，并统计哪些语言使用最频繁。为此，我们首先需要从 API 获取我们的仓库列表。使用 Octokit，可以这样实现：

repos = client.repositories

接下来，我们将遍历每个仓库，并统计 GitHub 为其关联的语言。

language_obj = {}
repos.each do |repo|
  # sometimes language can be nil
  if repo.language
    if !language_obj[repo.language]
      language_obj[repo.language] = 1
    else
      language_obj[repo.language] += 1
    end
  end
end

languages.to_s

当您重启服务器后，网页应显示类似如下的内容

{"JavaScript"=>13, "PHP"=>1, "Perl"=>1, "CoffeeScript"=>2, "Python"=>1, "Java"=>3, "Ruby"=>3, "Go"=>1, "C++"=>1}

到目前为止，一切顺利，但并不够友好。可视化可以帮助我们更好地了解这些语言计数的分布情况。让我们把计数数据喂给 D3，生成一个简洁的条形图，展示我们使用的语言的流行程度。

可视化语言计数

D3.js，简称 D3，是一个功能全面的库，用于创建各种图表、图形和交互式可视化。详细使用 D3 超出本指南的范围，但想了解入门文章，可参阅 D3 for Mortals。

D3 是一个 JavaScript 库，喜欢将数据以数组形式处理。因此，让我们将 Ruby 哈希转换为 JSON 数组，以便在浏览器中的 JavaScript 使用。

languages = []
language_obj.each do |lang, count|
  languages.push :language => lang, :count => count
end

erb :lang_freq, :locals => { :languages => languages.to_json}

我们只是遍历对象中的每个键值对并将其推入一个新数组。之所以之前没有这样做，是因为在创建 language_obj 对象时我们不想遍历它。

现在，lang_freq.erb 需要一些 JavaScript 来支持渲染条形图。目前，您可以直接使用此处提供的代码，若想深入了解 D3 的工作原理，可参考上述资源。

<!DOCTYPE html>
<meta charset="utf-8">
<html>
  <head>
    <script src="//cdnjs.cloudflare.com/ajax/libs/d3/3.0.1/d3.v3.min.js"></script>
    <style>
    svg {
      padding: 20px;
    }
    rect {
      fill: #2d578b
    }
    text {
      fill: white;
    }
    text.yAxis {
      font-size: 12px;
      font-family: Helvetica, sans-serif;
      fill: black;
    }
    </style>
  </head>
  <body>
    <p>Check this sweet data out:</p>
    <div id="lang_freq"></div>

  </body>
  <script>
    var data = <%= languages %>;

    var barWidth = 40;
    var width = (barWidth + 10) * data.length;
    var height = 300;

    var x = d3.scale.linear().domain([0, data.length]).range([0, width]);
    var y = d3.scale.linear().domain([0, d3.max(data, function(datum) { return datum.count; })]).
      rangeRound([0, height]);

    // add the canvas to the DOM
    var languageBars = d3.select("#lang_freq").
      append("svg:svg").
      attr("width", width).
      attr("height", height);

    languageBars.selectAll("rect").
      data(data).
      enter().
      append("svg:rect").
      attr("x", function(datum, index) { return x(index); }).
      attr("y", function(datum) { return height - y(datum.count); }).
      attr("height", function(datum) { return y(datum.count); }).
      attr("width", barWidth);

    languageBars.selectAll("text").
      data(data).
      enter().
      append("svg:text").
      attr("x", function(datum, index) { return x(index) + barWidth; }).
      attr("y", function(datum) { return height - y(datum.count); }).
      attr("dx", -barWidth/2).
      attr("dy", "1.2em").
      attr("text-anchor", "middle").
      text(function(datum) { return datum.count;});

    languageBars.selectAll("text.yAxis").
      data(data).
      enter().append("svg:text").
      attr("x", function(datum, index) { return x(index) + barWidth; }).
      attr("y", height).
      attr("dx", -barWidth/2).
      attr("text-anchor", "middle").
      text(function(datum) { return datum.language;}).
      attr("transform", "translate(0, 18)").
      attr("class", "yAxis");
  </script>
</html>

呼！再次提醒，别担心这段代码的大部分细节。这里相关的部分是位于顶部的一行代码——var data = <%= languages %>;——它表明我们将先前创建的 languages 数组传递给 ERB 进行处理。

正如《D3 for Mortals》指南所指出的，这并不是使用 D3 的最佳方式，但它足以演示如何结合该库和 Octokit 创造一些真正惊人的效果。

组合不同的 API 调用

现在该坦白了：仓库中的 language 属性只标识“主要”语言。这意味着如果一个仓库使用了多种语言，代码字节数最多的那种语言会被视为主要语言。

让我们组合几个 API 调用，获得一个真实的表示，显示在所有代码中哪种语言的字节数最多。树状图（treemap）是可视化各语言使用规模的好方法，而不仅仅是计数。我们需要构造一个类似以下的对象数组：

[ { "name": "language1", "size": 100},
  { "name": "language2", "size": 23}
  ...
]

既然我们已经拥有上面的仓库列表，就检查每个仓库，并调用 GET /repos/{owner}/{repo}/languages 接口

repos.each do |repo|
  repo_name = repo.name
  repo_langs = octokit_client.languages("#{github_user.login}/#{repo_name}")
end

随后，我们会累计将每个发现的语言添加到语言列表中

repo_langs.each do |lang, count|
  if !language_obj[lang]
    language_obj[lang] = count
  else
    language_obj[lang] += count
  end
end

之后，我们会将内容格式化为 D3 能够理解的结构

language_obj.each do |lang, count|
  language_byte_count.push :name => "#{lang} (#{count})", :count => count
end

# some mandatory formatting for D3
language_bytes = [ :name => "language_bytes", :elements => language_byte_count]

（欲了解更多 D3 树状图的使用技巧，请查看此简单教程。）

最后，我们将这些 JSON 信息传递给同一个 ERB 模板

erb :lang_freq, :locals => { :languages => languages.to_json, :language_byte_count => language_bytes.to_json}

和之前一样，这里是一段可以直接放入模板的 JavaScript 代码

<div id="byte_freq"></div>
<script>
  var language_bytes = <%= language_byte_count %>
  var childrenFunction = function(d){return d.elements};
  var sizeFunction = function(d){return d.count;};
  var colorFunction = function(d){return Math.floor(Math.random()*20)};
  var nameFunction = function(d){return d.name;};

  var color = d3.scale.linear()
              .domain([0,10,15,20])
              .range(["grey","green","yellow","red"]);

  drawTreemap(5000, 2000, '#byte_freq', language_bytes, childrenFunction, nameFunction, sizeFunction, colorFunction, color);

  function drawTreemap(height,width,elementSelector,language_bytes,childrenFunction,nameFunction,sizeFunction,colorFunction,colorScale){

      var treemap = d3.layout.treemap()
          .children(childrenFunction)
          .size([width,height])
          .value(sizeFunction);

      var div = d3.select(elementSelector)
          .append("div")
          .style("position","relative")
          .style("width",width + "px")
          .style("height",height + "px");

      div.data(language_bytes).selectAll("div")
          .data(function(d){return treemap.nodes(d);})
          .enter()
          .append("div")
          .attr("class","cell")
          .style("background",function(d){ return colorScale(colorFunction(d));})
          .call(cell)
          .text(nameFunction);
  }

  function cell(){
      this
          .style("left",function(d){return d.x + "px";})
          .style("top",function(d){return d.y + "px";})
          .style("width",function(d){return d.dx - 1 + "px";})
          .style("height",function(d){return d.dy - 1 + "px";});
  }
</script>

就是这样！美观的矩形展示了您的仓库语言，比例清晰一目了然。您可能需要调整树状图的高度和宽度（传递给上面的 drawTreemap 的前两个参数），以确保所有信息正确显示。

本文内容

设置 OAuth 应用

获取仓库信息

可视化语言计数

组合不同的 API 调用