empyrean 0.1.0

data/lib/empyrean/templaterenderer.rb

@@ -0,0 +1,192 @@
+# templaterenderer.rb - renders a ERB template
+#
+# This file is part of Empyrean
+# Copyright (C) 2015 nilsding, pixeldesu
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any 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/>.
+
+require 'erb'
+require 'empyrean/defaults'
+
+module Empyrean
+  class TemplateRenderer
+
+    ##
+    # Initializes a new TemplateRenderer.
+    #
+    # template: The template to use (i.e. not the file name)
+    # parsed_tweets: The dict that gets returned by TweetParser::merge_parsed
+    def initialize(config, template, parsed_tweets)
+      @config = config
+      @template = template
+      @parsed = parsed_tweets
+    end
+
+    ##
+    # Renders @template.
+    def render
+      mentions = mentions_erb
+      hashtags = hashtags_erb
+      smileys = smileys_erb
+      clients = clients_erb
+      counters = {
+        tweets: @parsed[:tweet_count],
+        retweets: @parsed[:retweet_count],
+        retweets_percentage: (@parsed[:retweet_count] * 100 / @parsed[:tweet_count].to_f).round(2),
+        selftweets: @parsed[:selftweet_count],
+        selftweets_percentage: (@parsed[:selftweet_count] * 100 / @parsed[:tweet_count].to_f).round(2)
+      }
+      times_of_day = times_erb
+      erb = ERB.new @template
+      erb.result binding
+    end
+
+    private
+    ##
+    # Returns an array with the mentions which can be easily used within ERB.
+    def mentions_erb
+      retdict = {
+        enabled: @config[:mentions][:enabled],
+        top: [],
+        nottop: []
+      }
+
+      if @config[:mentions][:enabled]
+        top = @parsed[:mentions].slice(0, @config[:mentions][:top]) # top X mentions
+        top.each do |mention|
+          retdict[:top] << mention[1]
+        end
+
+        nottop = @parsed[:mentions].slice(@config[:mentions][:top], @config[:mentions][:notop]) # not in the top X
+        unless nottop.nil?
+          nottop.each do |mention|
+            mention[1].delete(:example)
+            retdict[:nottop] << mention[1]
+          end
+        end
+      end
+
+      retdict
+    end
+
+    ##
+    # Returns an array with the hashtags which can be easily used within ERB.
+    def hashtags_erb
+      retdict = {
+        enabled: @config[:hashtags][:enabled],
+        top: [],
+        nottop: []
+      }
+
+      if @config[:hashtags][:enabled]
+        top = @parsed[:hashtags].slice(0, @config[:hashtags][:top]) # top X hashtags
+        top.each do |hashtag|
+          retdict[:top] << hashtag[1]
+        end
+
+        nottop = @parsed[:hashtags].slice(@config[:hashtags][:top], @config[:hashtags][:notop]) # not in the top X
+        unless nottop.nil?
+          nottop.each do |hashtag|
+            hashtag[1].delete(:example)
+            retdict[:nottop] << hashtag[1]
+          end
+        end
+      end
+
+      retdict
+    end
+
+    ##
+    # Returns an array with the smileys which can be easily used within ERB.
+    def smileys_erb
+      retdict = {
+        enabled: @config[:smileys][:enabled],
+        top: [],
+        nottop: []
+      }
+
+      if @config[:smileys][:enabled]
+        top = @parsed[:smileys].slice(0, @config[:smileys][:top]) # top X smileys
+        top.each do |smiley|
+          retdict[:top] << smiley[1]
+        end
+
+        nottop = @parsed[:smileys].slice(@config[:smileys][:top], @config[:smileys][:notop]) # not in the top X
+        unless nottop.nil?
+          nottop.each do |smiley|
+            smiley[1].delete(:example)
+            retdict[:nottop] << smiley[1]
+          end
+        end
+      end
+
+      retdict
+    end
+
+    ##
+    # Returns an array with the clients which can be easily used within ERB.
+    def clients_erb
+      retdict = {
+        enabled: @config[:clients][:enabled],
+        top: [],
+        nottop: []
+      }
+
+      if @config[:clients][:enabled]
+        top = @parsed[:clients].slice(0, @config[:clients][:top]) # top X clients
+        top.each do |client|
+          retdict[:top] << {
+            name: client[1][:name],
+            url: client[1][:url],
+            count: client[1][:count],
+            percentage: (client[1][:count] * 100 / @parsed[:tweet_count].to_f).round(2)
+          }
+        end
+
+        nottop = @parsed[:clients].slice(@config[:clients][:top], @config[:clients][:notop]) # not in the top X
+        unless nottop.nil?
+          nottop.each do |client|
+            client[1].delete(:example)
+            retdict[:nottop] << {
+              name: client[1][:name],
+              url: client[1][:url],
+              count: client[1][:count],
+              percentage: (client[1][:count] * 100 / @parsed[:tweet_count].to_f).round(2)
+            }
+          end
+        end
+      end
+
+      retdict
+    end
+
+    def times_erb
+      retarr = []
+      max_count = @parsed[:times_of_day].max
+
+      @parsed[:times_of_day].each do |count|
+        retarr << {
+          count: count,
+          percentage: (count * 100 / @parsed[:tweet_count].to_f).round(1),
+          size: ((count / max_count.to_f) * 100).to_i,
+          max: count == max_count
+        }
+      end
+
+      retarr
+    end
+  end
+end
+
+# kate: indent-width 2

data/lib/empyrean/templates/default.html.erb

@@ -0,0 +1,237 @@
+<%#-*- coding: utf-8 -*-%>
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Twitter Stats</title>
+    <link rel="stylesheet" href="http://static.leafc.at/css/bootstrap.css">
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
+    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
+    <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet">
+    <!--[if lt IE 9]>
+      <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+      <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+    <![endif]-->
+  </head>
+  <style>
+  thead {
+    font-weight: bold;
+  }
+
+  .badge {
+    float: right;
+  }
+
+  .float-right {
+    float: right;
+  }
+  .progress.vertical {
+    position: relative;
+    width: 20px;
+    margin: 0 auto;
+    background: none;
+    box-shadow: none;
+    border: none;
+  }
+  td.bottom-center {
+    vertical-align: bottom;
+    text-align: center;
+  }
+  .small {
+    font-size: 80%;
+  }
+  .bold {
+    font-weight: bold;
+  }
+  </style>
+  <body>
+    <div class="container">
+      <div class="page-header">
+        <h2>Twitter Stats</h2>
+      </div>
+
+      <p>Statistics generated on <%= Time.now.strftime("%A %d %B %Y - %T") %></p>
+      <p>Total number of tweets: <%= counters[:tweets] %> (<%= counters[:retweets_percentage] %>% retweets)</p>
+
+      <h4>Most active times</h4>
+      <p>What time do you tweet the most?</p>
+      <table class="table">
+        <tr>
+<% times_of_day.each_with_index do |time, index| %>
+          <td class="small bottom-center">
+            <%= time[:percentage] %>%
+  <% if time[:size] > 0 %>
+            <br />
+            <div class="progress vertical" style="height: <%= time[:size] %>px;" alt="<%= time[:count] %>" title="<%= time[:count] %>"><div class="progress-bar" style="width: 100%"></div>
+  <% end %>
+          </td>
+<% end %>
+        </tr>
+        <tr>
+<% times_of_day.each_with_index do |time, index| %>
+          <td class="<% if time[:max] %>bold <% end %>small" align="center"><%= index %></td>
+<% end %>
+        </tr>
+      </table>
+
+<% if mentions[:enabled] %>
+      <h4>Most mentioned users</h4>
+      <p>With this, you can see the people you mentioned most in your Twitter time!</p>
+      <table class="table table-responsive table-bordered table-condensed">
+        <thead>
+          <tr>
+            <td>&nbsp;</td>
+            <td>Username</td>
+            <td>Times Mentioned</td>
+            <td>Example</td>
+          </tr>
+        </thead>
+        <tbody>
+  <% mentions[:top].each_with_index do |user, index| %>
+          <tr>
+            <td><%= index + 1 %>.</td>
+            <td><b><a href="https://twitter.com/<%= user[:name] %>">@<%= user[:name] %></a></b></td>
+            <td><%= user[:count] %></td>
+            <td><%= user[:example][:text] %> <a class="float-right" href="https://twitter.com/statuses/<%= user[:example][:id] %>"><i class="fa fa-arrow-right"></i></a></td>
+          </tr>
+  <% end %>
+        </tbody>
+      </table>
+  <% if mentions[:nottop].length > 0 %>
+      <h5>These didn't make it to the top…</h5>
+      <table class="table table-responsive table-bordered table-condensed">
+        <tr>
+    <% mentions[:nottop].each_with_index do |user, index| %>
+          <td><b><a href="https://twitter.com/<%= user[:name] %>">@<%= user[:name] %></a></b> <span class="badge"><%= user[:count] %></span></td>
+      <% if index % 5 == 4 %>
+        </tr>
+        <tr>
+      <% end %>
+    <% end %>
+        </tr>
+      </table>
+  <% end %>
+<% end %>
+
+<% if clients[:enabled] %>
+      <h4>Most used clients</h4>
+      <p>What is/was your favorite and most used client? Find it out right here!</p>
+      <table class="table table-responsive table-bordered table-condensed">
+        <thead>
+          <tr>
+            <td>&nbsp;</td>
+            <td>Client</td>
+            <td>Times Used</td>
+            <td>Percentage (% of total)</td>
+          </tr>
+        </thead>
+        <tbody>
+  <% clients[:top].each_with_index do |client, index| %>
+          <tr>
+            <td><%= index + 1 %>.</td>
+            <td><b><a href="<%= client[:url] %>"><%= client[:name] %></a></b></td>
+            <td><%= client[:count] %></td>
+            <td><%= client[:percentage] %>%</td>
+          </tr>
+  <% end %>
+        </tbody>
+      </table>
+  <% if clients[:nottop].length > 0 %>
+      <h5>These didn't make it to the top…</h5>
+      <table class="table table-responsive table-bordered table-condensed">
+        <tr>
+    <% clients[:nottop].each_with_index do |client, index| %>
+          <td><b><a href="<%= client[:url] %>"><%= client[:name] %></a></b> <span class="badge"><%= client[:count] %></span></td>
+      <% if index % 5 == 4 %>
+        </tr>
+        <tr>
+      <% end %>
+    <% end %>
+        </tr>
+      </table>
+  <% end %>
+<% end %>
+
+<% if smileys[:enabled] %>
+      <h4>Most used smileys :^)</h4>
+      <p>;-)</p>
+      <table class="table table-responsive table-bordered table-condensed">
+        <thead>
+          <tr>
+            <td>&nbsp;</td>
+            <td>Smiley</td>
+            <td>Times Used</td>
+            <td>Example</td>
+          </tr>
+        </thead>
+        <tbody>
+  <% smileys[:top].each_with_index do |smiley, index| %>
+          <tr>
+            <td><%= index + 1 %>.</td>
+            <td><%= smiley[:smiley] %></td>
+            <td><%= smiley[:count] %></td>
+            <td><%= smiley[:example][:text] %> <a class="float-right" href="https://twitter.com/statuses/<%= smiley[:example][:id] %>"><i class="fa fa-arrow-right"></i></a></td>
+          </tr>
+  <% end %>
+        </tbody>
+      </table>
+  <% if smileys[:nottop].length > 0 %>
+      <h5>These didn't make it to the top…  ;_;</h5>
+      <table class="table table-responsive table-bordered table-condensed">
+        <tr>
+    <% smileys[:nottop].each_with_index do |smiley, index| %>
+          <td><%= smiley[:smiley] %> <span class="badge"><%= smiley[:count] %></span></td>
+      <% if index % 5 == 4 %>
+        </tr>
+        <tr>
+      <% end %>
+    <% end %>
+        </tr>
+      </table>
+  <% end %>
+<% end %>
+
+<% if hashtags[:enabled] %>
+      <h4>Most used hashtags</h4>
+      <p>What were you talking about on Twitter most? <span class="text-muted">(Or you simply spammed/overused those hashtags)</span></p>
+      <table class="table table-responsive table-bordered table-condensed">
+        <thead>
+          <tr>
+            <td>&nbsp;</td>
+            <td>Hashtag</td>
+            <td>Times Used</td>
+            <td>Example</td>
+          </tr>
+        </thead>
+        <tbody>
+  <% hashtags[:top].each_with_index do |hashtag, index| %>
+          <tr>
+            <td><%= index + 1 %>.</td>
+            <td><b><a href="https://twitter.com/search?q=%23<%= hashtag[:hashtag] %>">#<%= hashtag[:hashtag] %></a></b></td>
+            <td><%= hashtag[:count] %></td>
+            <td><%= hashtag[:example][:text] %> <a class="float-right" href="https://twitter.com/statuses/<%= hashtag[:example][:id] %>"><i class="fa fa-arrow-right"></i></a></td>
+          </tr>
+  <% end %>
+        </tbody>
+      </table>
+  <% if hashtags[:nottop].length > 0 %>
+      <h5>These didn't make it to the top…</h5>
+      <table class="table table-responsive table-bordered table-condensed">
+        <tr>
+    <% hashtags[:nottop].each_with_index do |hashtag, index| %>
+          <td><b><a href="https://twitter.com/search?q=%23<%= hashtag[:hashtag] %>">#<%= hashtag[:hashtag] %></a></b> <span class="badge"><%= hashtag[:count] %></span></td>
+      <% if index % 5 == 4 %>
+        </tr>
+        <tr>
+      <% end %>
+    <% end %>
+        </tr>
+      </table>
+  <% end %>
+<% end %>
+
+    </div>
+  </body>
+</html>