models_stats 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43a556631c74099ee79afa59fd528b167bf6adc4
+  data.tar.gz: 3a36eb3f4851b85ef6f9b406fb025ffd6aeefcf5
+SHA512:
+  metadata.gz: 81676a6eb2455a149ed00992732f29c1b8a1703950f880b95a007bb31af98296986a1558fbc7a5f8bd8bab375c79af302c065c7673bc9a0aae749042b55ba499
+  data.tar.gz: 7a9bf584641949a6edf457fe3282689d9eb8202f3bb2283fc658ce4075e94f17d586fbd1e763c4df010c46b36468b652472c108deacf88bb9c335aa47f9691ce

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in models_stats.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrey Morskov
+
+MIT License
+
+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,157 @@
+# ModelsStats
+
+Graphics for your rails models. It may show count(or average, or sum, or another sql agregate function) of models for each day with grouping, conditions.
+
+For graphics it uses for your choice [MetricsGraphics.js](https://github.com/mozilla/metrics-graphics) or/and [NVD3](http://nvd3.org/).
+
+Dependencies: [Redis](http://redis.io/) for store statistics.
+[D3](http://d3js.org/), [jQuery](http://jquery.com/), [Bootstrap](http://getbootstrap.com/) it's dependencies of MetricsGraphics.js.
+
+Preview:
+
+NVD3:
+
+![ScreenShot](https://raw.github.com/accessd/models_stats/master/doc/img/nvd3_example.png)
+
+![ScreenShot](https://raw.github.com/accessd/models_stats/master/doc/img/nvd3_users_example.png)
+
+MetricsGraphics.js
+
+![ScreenShot](https://raw.github.com/accessd/models_stats/master/doc/img/mg_example.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'models_stats', github: 'accessd/models_stats'
+```
+
+And then execute:
+
+    $ bundle
+
+In your application.js manifest:
+
+    //= require models_stats/nvd3
+
+or/and
+
+    //= require models_stats/metrics_graphics
+
+if you want use MetricsGraphics.
+
+In your application.css.scss manifest:
+
+    //= require models_stats/nvd3
+
+or/and
+
+    //= require models_stats/metrics_graphics
+
+if you want use MetricsGraphics.
+
+Also if you use MetricsGraphics.js you must have [jQuery](http://jquery.com/) and [Bootstrap](http://getbootstrap.com/) js/css included.
+
+
+## Usage
+
+### Configuration
+
+Add config file `config/models_stats.yml`, for example:
+
+minimal configuration:
+
+```yaml
+  ---
+  - total_users:
+      description: "Total users"
+      model: User
+```
+
+it would be calculate total users for day.
+
+Enhanced configuration:
+
+```yaml
+  ---
+  - total_links_by_error_types: # Statistics alias, must be uniq
+      description: "Total links by error types"
+      model: Link
+      datetime_attr: :created_at # Date or datetime attribute, allows to calculate the count of models per day
+      group_by: :error_type_id
+      conditions: "error_type_id != <%= Link::NO_ERROR %>"
+      group_by_values_map: <%= ModelsStats.convert_hash_to_yaml(Link::ERROR_NAMES) %> # for example maping integer field to text representation
+      graph_width: 430
+      graph_height: 140
+      graphic_lib: nvd3 # By default, or can be metrics_graphics
+      graphic_type: stacked # It's can be using with nvd3, by default line
+      date_tick: day # By default, or can be month or week
+      date_format: '%d/%m' # By default is %x, more information about formattting time available at https://github.com/mbostock/d3/wiki/Time-Formatting
+  - average_by_keyword_positions:
+      description: "Average by keyword positions"
+      select_statement: "AVG(google_position) AS count" # Right here you may specify select query, `count` alias for function required
+      model: KeywordPosition
+```
+
+If you want using specific redis for store statistics, set it in `config/initializers/models_stats.rb`, for example:
+
+    ModelsStats.redis_connection = Redis.new(host: '127.0.0.1', port: 6379, db: 5)
+
+Default graphics library can be configured through:
+
+    ModelsStats.default_lib_for_graphics = :nvd3 # Or metrics_graphics
+
+Default graphics type:
+
+    ModelsStats.default_graphics_type = :line # Or stacked
+
+Default graph width:
+
+    ModelsStats.default_graphics_width = 500
+
+Default graph height:
+
+    ModelsStats.default_graphics_height = 120
+
+Default date tick:
+
+    ModelsStats.default_date_tick = :day # Or month, week
+
+Default date format:
+
+    ModelsStats.default_date_format = '%d/%m'
+
+For the full list of directives for formatting time, refer to [this list](https://github.com/mbostock/d3/wiki/Time-Formatting)
+
+### Collecting statistics
+
+Add to your crontab(may use [whenever](https://github.com/javan/whenever)) rake task `models_stats:collect_stat_for_yesterday`, run it at 00:00 or later and it will collect statistics for yesterday.
+For collecting statistics for last month run rake task `models_stats:collect_stat_for_last_month`.
+Also you may collect statistics for specific date and config, for example:
+
+```ruby
+  date = 2.days.ago.to_date
+  statistics_alias = 'total_links_by_error_types' # statistic alias which you define in `config/models_stats.yml`
+  ModelsStats::StatisticsCollector.new.collect(statistics_alias, date) # By default date is yestarday
+```
+
+### Display graphics
+
+In your views use helpers:
+
+Render single graphic for total_links_by_error_types statistic alias(which you define in `config/models_stats.yml`) and last week
+
+    = render_models_stats_graph('total_links_by_error_types', 1.week) # By default period is 1.month
+
+Render all defined graphics splited by two columns - first for new models count, second for total models count
+
+    = render_models_stats_dashboard
+
+## Contributing
+
+1. Fork it ( https://github.com/accessd/models_stats/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+import "./lib/tasks/models_stats.rake"
+

data/app/assets/javascripts/models_stats/graphs/metrics_graph.js.coffee

@@ -0,0 +1,63 @@
+class @MetricsGraph
+  constructor: (graph_title, keys, data, stat_alias, date_axis_tick, date_format, width, height) ->
+    @width = width
+    @height = height
+    @graphTitle = graph_title
+    @statAlias = stat_alias
+    @dateAxisTick = date_axis_tick
+    @dateFormat = date_format
+    @keys = keys
+    @data = @prepareData(data)
+    if data.length
+      @draw()
+
+  prepareData: (rawData) ->
+    resultData = []
+
+    rawData.forEach (dataForKey) =>
+      values = convert_dates(dataForKey, 'date')
+      resultData.push values
+
+    resultData
+
+  draw: ->
+    placeholder_name = "#{@statAlias}_statistics"
+    maximums = []
+    @data.forEach (data) =>
+      maximum = d3.max data, (d) -> d.date
+      maximums.push maximum
+    maxDate = d3.max maximums
+
+    minimums = []
+    @data.forEach (data) =>
+      minimum = d3.min data, (d) -> d.date
+      minimums.push minimum
+    minDate = d3.max minimums
+    daysCount = d3.time.day.range(minDate, maxDate, 1).length
+    switch @dateAxisTick
+      when 'month'
+        xax_count = d3.time.month.range(minDate, maxDate, 1).length
+      when 'week'
+        xax_count = d3.time.week.range(minDate, maxDate, 1).length
+      else
+        xax_count = d3.time.day.range(minDate, maxDate, 1).length
+
+    data_graphic
+      title: @graphTitle
+      area: true
+      legend: @keys
+      legend_target: ".#{placeholder_name}_legend"
+      data: @data
+      width: @width
+      height: @height
+      bottom: 0
+      top: 20
+      show_years: false
+      y_extended_ticks: true
+      xax_count: xax_count
+      xax_format: (d) =>
+        df = d3.time.format(@dateFormat)
+        df(d)
+      target: "##{placeholder_name}"
+      x_accessor: 'date'
+      y_accessor: 'value'

data/app/assets/javascripts/models_stats/graphs/nvd3_graph.js.coffee

@@ -0,0 +1,88 @@
+class @Nvd3Graph
+  constructor: (data, keys, stat_alias, graph_type, date_axis_tick, date_format, width, height) ->
+    @statAlias = stat_alias
+    @width = width
+    @height = height
+    @keys = keys
+    @graphType = graph_type
+    @dateAxisTick = date_axis_tick
+    @dateFormat = date_format
+    @data = @prepareData(data)
+    @draw()
+
+  prepareData: (rawData) ->
+    resultData = []
+
+    i = 0
+    rawData.forEach (dataForKey) =>
+      values = []
+      dataForKey.forEach (stat) =>
+        fff = d3.time.format('%Y-%m-%d')
+        date = fff.parse(stat.date)
+        values.push [date, stat.value]
+
+      resultData.push {values: values, key: keys[i]}
+      i++
+
+    resultData
+
+  draw: ->
+    placeholder_name = "#{@statAlias}_statistics"
+    graphData = @data
+    dateFormat = @dateFormat
+    graphType = @graphType
+
+    if graphData.length
+      maximums = []
+      graphData.forEach (data) =>
+        maximum = d3.max data.values, (d) -> d[1]
+        maximums.push maximum
+      maxY = d3.max maximums
+
+      maximums = []
+      graphData.forEach (data) =>
+        maximum = d3.max data.values, (d) -> d[0]
+        maximums.push maximum
+      maxDate = d3.max maximums
+
+      minimums = []
+      graphData.forEach (data) =>
+        minimum = d3.min data.values, (d) -> d[0]
+        minimums.push minimum
+      minDate = d3.max minimums
+
+      nv.addGraph =>
+        if graphType == 'stacked'
+          chart = nv.models.stackedAreaChart().x((d) -> d[0]).y((d) -> d[1]).useInteractiveGuideline(true)
+            .transitionDuration(500)
+            .showControls(true)
+            .clipEdge(true)
+            .color(d3.scale.category20().range())
+        else
+          chart = nv.models.lineChart().interpolate("basic").x((d) ->
+            d[0]
+          ).y((d) ->
+            d[1]
+          ).color(d3.scale.category20().range())
+        chart.width = @width
+        chart.height = @height
+
+        chart.yAxis.tickFormat(d3.format('f'))
+
+        chart.forceY([0, maxY])
+        chart.yDomain([0.001, maxY])
+
+        chart.xAxis.tickFormat (d) ->
+          d3.time.format(dateFormat) new Date(d)
+
+        switch @dateAxisTick
+          when 'month'
+            chart.xAxis.tickValues(d3.time.month.range(minDate, maxDate, 1))
+          when 'week'
+            chart.xAxis.tickValues(d3.time.week.range(minDate, maxDate, 1))
+          else
+            chart.xAxis.tickValues(d3.time.day.range(minDate, maxDate, 1))
+        d3.select("##{placeholder_name} svg").datum(graphData).transition().duration(500).call(chart)
+
+        nv.utils.windowResize chart.update
+        chart

data/app/assets/javascripts/models_stats/metrics_graphics.js

@@ -0,0 +1,3 @@
+//= require d3.min
+//= require metricsgraphics.min
+//= require ./graphs/metrics_graph

data/app/assets/javascripts/models_stats/nvd3.js

@@ -0,0 +1,3 @@
+//= require d3.min
+//= require nv.d3.min
+//= require ./graphs/nvd3_graph

data/app/assets/stylesheets/models_stats/metrics_graphics.css

@@ -0,0 +1,17 @@
+/*
+ *= require bootstrap.min
+ *= require metricsgraphics
+ */
+
+.models_stats_graph .chart_title {
+  font-size: 15px;
+}
+
+@font-face {
+  font-family: 'Glyphicons Halflings';
+  src: url('../assets/bootstrap/glyphicons-halflings-regular.eot');
+  src: url('../assets/bootstrap/glyphicons-halflings-regular.eot?#iefix') format('embedded-opentype'),
+  url('../assets/bootstrap/glyphicons-halflings-regular.woff') format('woff'),
+  url('../assets/bootstrap/glyphicons-halflings-regular.ttf') format('truetype'),
+  url('../assets/bootstrap/glyphicons-halflings-regular.svg#glyphicons_halflingsregular') format('svg');
+}

data/app/assets/stylesheets/models_stats/nvd3.css

@@ -0,0 +1,4 @@
+/*
+ *= require bootstrap.min
+ *= require nv.d3.min
+ */

data/app/helpers/models_stats/graph_helper.rb

@@ -0,0 +1,27 @@
+module ModelsStats::GraphHelper
+  def render_models_stats_graph(stat_alias, period = 1.month)
+    stat_params = ModelsStats::CONFIG.select{|config| name, params = config.first; name.to_s == stat_alias.to_s}.first
+    if stat_params
+      stat_params = stat_params.values[0]
+      keys, stat_data = ModelsStats::Statistics.for_period(stat_alias, period)
+      graph_width = stat_params["graph_width"] || ModelsStats.default_graphics_width
+      graph_height = stat_params["graph_height"] || ModelsStats.default_graphics_height
+      if stat_params["graphic_type"].present? && !stat_params["graphic_type"].to_sym.in?(ModelsStats::GRAPHICS_TYPES)
+        return "Unknown graphic type"
+      end
+      graphic_type = stat_params["graphic_type"] || ModelsStats.default_graphics_type
+      graphic_lib = stat_params["graphic_lib"] || ModelsStats.default_lib_for_graphics
+      date_tick = stat_params["date_tick"] || ModelsStats.default_date_tick
+      date_format = stat_params["date_format"] || ModelsStats.default_date_format
+      render partial: 'models_stats/model_statistics_graph', locals: {graph_title: stat_params["description"] || stat_alias, keys: keys, stat_data: stat_data, 
+                                                                      stat_alias: stat_alias, width: graph_width, height: graph_height, graphic_lib: graphic_lib, 
+                                                                      graphic_type: graphic_type, date_tick: date_tick, date_format: date_format}
+    else
+      "No params for #{stat_alias}"
+    end
+  end
+
+  def render_models_stats_dashboard
+    render partial: 'models_stats/dashboard'
+  end
+end

data/app/views/models_stats/_dashboard.html.erb

@@ -0,0 +1,11 @@
+<h2>Models statistics dashboard</h2>
+<div class="row">
+  <% ModelsStats::CONFIG.group_by{|params| params.values[0]["datetime_attr"].present?}.each do |for_new_models, models_group| %>
+    <div class="col-md-6">
+      <h3><%= for_new_models ? "New models" : "Total models" %></h3>
+      <% models_group.each do |params| %>
+        <%= render_models_stats_graph(params.keys[0], 1.month) %>
+      <% end %>
+    </div>
+  <% end %>
+</div>

data/app/views/models_stats/_model_statistics_graph.html.erb

@@ -0,0 +1,39 @@
+<script type="text/javascript">
+  $(function(){
+    keys = <%= keys.to_json.html_safe %>
+    data = <%= stat_data.to_json.html_safe %>
+    <% case graphic_lib.to_s
+       when 'nvd3' %>
+     new Nvd3Graph(data, keys, '<%= stat_alias %>', '<%= graphic_type %>', '<%= date_tick %>', '<%= date_format %>', <%= width %>, <%= height %>)
+    <% when 'metrics_graphics' %>
+    new MetricsGraph('<%= graph_title %>', keys, data, '<%= stat_alias %>', '<%= date_tick %>', '<%= date_format %>', <%= width %>, <%= height %>)
+    <% end %>
+  })
+</script>
+
+<% if stat_data.empty? %>
+  <%= graph_title %>
+  </br>
+  No data
+  </br>
+  </br>
+<% else %>
+  <% case graphic_lib.to_s
+    when 'nvd3' %>
+    <h4 style="margin: 0;"><%= graph_title %></h4>
+    <div id="<%= stat_alias %>_statistics", style="height: <%= height %>px; width: <%= width %>px;">
+      <svg></svg>
+    </div>
+  <% when 'metrics_graphics' %>
+    <div class="models_stats_graph" style='clear: both;'>
+      <div class='<%= stat_alias %>_statistics_legend legend' style='float: right;'></div>
+      <div class='col-lg-12 text-center extended-y-ticks' id='<%= stat_alias %>_statistics'></div>
+    </div>
+  <% else %>
+    <%= graph_title %>
+    </br>
+    Unknown graphics lib
+    </br>
+    </br>
+  <% end %>
+<% end %>