prosperity 0.0.1 → 0.0.2

data/app/views/prosperity/metrics/index.html.erb

@@ -0,0 +1,8 @@
+<h1>Metrics</h1>
+<ul>
+  <% @metrics.each do |metric| %>
+    <li>
+      <%= link_to_metric metric %>
+    </li>
+  <% end %>
+</ul>

data/app/views/prosperity/metrics/show.html.erb

@@ -0,0 +1,23 @@
+<h1>
+  <%= @metric.title %>
+</h1>
+
+<div class="metric" data-url="<%= metric_path(params) %>"></div>
+
+<%= form_tag(metric_path(params[:id]), method: 'get') do %>
+  <h2>Settings</h2>
+  <div class='well'>
+    <h3>Option</h3>
+
+    <%= select_tag :option, options_for_select(@metric.options.keys, option) %>
+
+    <h3>Period</h3>
+    <% Prosperity::Periods::ALL.each do |key, period_object| %>
+      <%= radio_button_tag "period", key, key == period %>
+      <%= label_tag "period_#{key}", key.titleize %>
+    <% end %>
+
+    <%= render 'prosperity/shared/date_range' %>
+    <%= submit_tag "Update", class: 'btn btn-primary' %>
+  </div>
+<% end %>

data/app/views/prosperity/shared/_date_range.html.erb

@@ -0,0 +1,9 @@
+<div class="form-group">
+  <%= label_tag :start_time %>
+  <%= date_field_tag :start_time, start_time.to_date %>
+</div>
+
+<div class="form-group">
+  <%= label_tag :end_time %>
+  <%= date_field_tag :end_time, end_time.try(:to_date) %>
+</div>

data/config/routes.rb

@@ -1,5 +1,15 @@
-Prosperity::Engine.routes.draw do
-  resources :metrics
+Prosperity::Engine.routes.draw do 
+  resources :dashboards do
+    post "graphs/:graph_id", to: "dashboard_graphs#create", as: :dashboard_graphs
+    delete "graphs/:graph_id", to: "dashboard_graphs#destroy"
+  end
+  resources :metrics do 
+    member do
+      get :data
+    end
+  end
+
+  resources :graphs
 
   root to: 'metrics#index'
 end

data/db/migrate/20131127042251_dashboards.rb

@@ -0,0 +1,34 @@
+class Dashboards < ActiveRecord::Migration
+  def change
+    # Note: foreign_key: false is for schema_plus support
+    create_table :prosperity_dashboards do |t|
+      t.string :title, null: false
+      t.boolean :default, null: false
+      t.timestamps
+    end
+
+    create_table :prosperity_graph_lines do |t|
+      t.integer :graph_id, null: false, foreign_key: false
+      t.string :option, null: false
+      t.string :metric, null: false
+      t.string :extractor, null: false
+      t.timestamps
+    end
+
+    create_table :prosperity_graphs do |t|
+      t.string :title, null: false
+      t.string :period, null: false
+      t.timestamps
+    end
+
+    create_table :prosperity_dashboard_graphs do |t|
+      t.integer :graph_id, null: false, foreign_key: false
+      t.integer :dashboard_id, null: false, foreign_key: false
+      t.timestamps
+    end
+
+    add_index :prosperity_dashboard_graphs, [:graph_id, :dashboard_id], unique: true
+    add_index :prosperity_dashboard_graphs, :dashboard_id
+    add_index :prosperity_graph_lines, :graph_id
+  end
+end

data/lib/generators/metric/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a new Prosperity metric for your application.
+
+Example:
+    rails generate metric User
+
+    This will create:
+      app/properity/user_metric.rb

data/lib/generators/metric/metric_generator.rb

@@ -0,0 +1,7 @@
+class MetricGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def generate_metric
+    template "metric.rb.erb", File.join("app", "prosperity", class_path, "#{file_name}_metric.rb")
+  end
+end

data/lib/generators/metric/templates/metric.rb.erb

@@ -0,0 +1,3 @@
+class <%= class_name%>Metric < Prosperity::Metric
+  scope { <%= class_name %> }
+end

data/lib/prosperity/aggregate/aggregate_builder.rb

@@ -0,0 +1,42 @@
+module Prosperity
+  class Aggregate::AggregateBuilder 
+    attr_reader :block
+
+    def initialize(string = nil, &block)
+      raise "Can't specify a string and a block" if string && block_given?
+
+      @string = string
+      @block = block
+    end
+
+    def build
+      res = @string ? @string : instance_eval(&block)
+      if res.is_a?(String)
+        Aggregate::Sql.new(res)
+      else
+        res
+      end
+    end
+
+    def count
+      Aggregate::Count.new
+    end
+
+    def sum(column)
+      Aggregate::Sum.new(column)
+    end
+
+    def maximum(column)
+      Aggregate::Maximum.new(column)
+    end
+
+    def minimum(column)
+      Aggregate::Minimum.new(column)
+    end
+
+    def average(column)
+      Aggregate::Average.new(column)
+    end
+  end
+end
+

data/lib/prosperity/aggregate/average.rb

@@ -0,0 +1,12 @@
+module Prosperity
+  class Aggregate::Average < Aggregate::WithColumn
+    def to_sql
+      "AVG(#{column})"
+    end
+
+    def apply(scope)
+      scope.average(column)
+    end
+  end
+end
+

data/lib/prosperity/aggregate/base.rb

@@ -0,0 +1,5 @@
+module Prosperity
+  class Aggregate::Base 
+  end
+end
+

data/lib/prosperity/aggregate/count.rb

@@ -0,0 +1,12 @@
+module Prosperity
+  class Aggregate::Count < Aggregate::Base
+    def to_sql
+      "COUNT(1)"
+    end
+
+    def apply(scope)
+      scope.count
+    end
+  end
+end
+

data/lib/prosperity/aggregate/maximum.rb

@@ -0,0 +1,12 @@
+module Prosperity
+  class Aggregate::Maximum < Aggregate::WithColumn
+    def to_sql
+      "MAX(#{column})"
+    end
+
+    def apply(scope)
+      scope.maximum(column)
+    end
+  end
+end
+

data/lib/prosperity/aggregate/minimum.rb

@@ -0,0 +1,12 @@
+module Prosperity
+  class Aggregate::Minimum < Aggregate::WithColumn
+    def to_sql
+      "MIN(#{column})"
+    end
+
+    def apply(scope)
+      scope.minimum(column)
+    end
+  end
+end
+

data/lib/prosperity/aggregate/sql.rb

@@ -0,0 +1,12 @@
+module Prosperity
+  class Aggregate::Sql < Aggregate::Base
+    def initialize(sql)
+      @sql = sql
+    end
+
+    def to_sql
+      @sql
+    end
+  end
+end
+

data/lib/prosperity/aggregate/sum.rb

@@ -0,0 +1,12 @@
+module Prosperity
+  class Aggregate::Sum < Aggregate::WithColumn
+    def to_sql
+      "SUM(#{column})"
+    end
+
+    def apply(scope)
+      scope.sum(column)
+    end
+  end
+end
+

data/lib/prosperity/aggregate/with_column.rb

@@ -0,0 +1,10 @@
+module Prosperity
+  class Aggregate::WithColumn 
+    attr_reader :column
+
+    def initialize(column)
+      @column = column
+    end
+  end
+end
+

data/lib/prosperity/aggregate.rb

@@ -0,0 +1,5 @@
+module Prosperity
+  class Aggregate 
+  end
+end
+

data/lib/prosperity/engine.rb

@@ -5,5 +5,19 @@ module Prosperity
     config.after_initialize do
       require "prosperity/exception"
     end
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixtures => false
+      g.view_specs false
+      g.fixture_replacement nil
+    end
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
   end
 end

data/lib/prosperity/exception.rb

@@ -4,7 +4,25 @@ module Prosperity
 
   class MissingScope < Exception
     def initialize
-      super "You must specify a scope for all metrics."
+      super "You have asked for the scope of a metric with no scope."
+    end
+  end
+
+  class MissingSql < Exception
+    def initialize
+      super "You have asked for the sql of a metric with no sql."
+    end
+  end
+
+  class MissingValueAt < Exception
+    def initialize
+      super "You have asked for the value_at, but none was specified"
+    end
+  end
+
+  class SqlMetricCannotHaveOption < Exception
+    def initialize
+      super "Sql metrics cannot have options"
     end
   end
 end

data/lib/prosperity/extractors/base.rb

@@ -1,11 +1,39 @@
 module Prosperity
   class Extractors::Base 
-    attr_reader :metric, :start_time, :end_time, :period
+    attr_reader :metric, :start_time, :end_time, :period, :option
 
-    def initialize(metric, start_time, end_time, period)
-      @metric, @start_time, @end_time, @period =
-        metric, start_time, end_time, period
+    def initialize(metric, option, start_time, end_time, period)
+      @metric, @option, @start_time, @end_time, @period =
+        metric, option, period.floor_date.call(start_time), period.ceil_date.call(end_time), period
+    end
+
+    def scope
+      @metric.options.fetch(option).block.call(metric.scope)
+    end
+
+    def key
+      self.class.key
+    end
+
+    def label
+      "#{metric.title} by #{key} with option #{option}"
+    end
+
+    def aggregate
+      metric.aggregate
+    end
+
+    private
+    def count_up_to_date_with_sql(date)
+      fragment = <<-SQL
+        WITH prosperity_metric_count AS (
+          #{metric.sql}
+        )
+        SELECT #{aggregate.to_sql} AS RESULT FROM prosperity_metric_count
+        WHERE #{metric.group_by} < '#{date.iso8601}'
+      SQL
+      result = ActiveRecord::Base.connection.execute(fragment)
+      result.to_a.first["result"].to_f
     end
   end
 end
-

data/lib/prosperity/extractors/change.rb

@@ -0,0 +1,35 @@
+module Prosperity
+  class Extractors::Change < Extractors::Base
+    def self.key
+      'change'
+    end
+
+    def to_a
+      data = []
+
+      period.each_period(start_time, end_time) do |start_time|
+        if metric.sql?
+          new = count_up_to_date_with_sql(start_time)
+          last = count_up_to_date_with_sql(start_time - period.duration)
+        elsif metric.ruby?
+          new = metric.value_at.call(start_time, period)
+          last = metric.value_at.call(start_time - period.duration, period)
+        else
+          new = aggregate.apply(scope.where("#{metric.group_by} < ?", start_time))
+          last = aggregate.apply(scope.where("#{metric.group_by} < ?", start_time - period.duration))
+        end
+
+        change = if last && last > 0
+                   ((new.to_f / last) - 1.0) * 100
+                 else
+                   0.0
+                 end
+
+        data << change
+      end
+
+      data
+    end
+  end
+end
+

data/lib/prosperity/extractors/interval.rb

@@ -0,0 +1,51 @@
+module Prosperity
+  class Extractors::Interval < Extractors::Base
+    def self.key
+      "interval"
+    end
+
+    def to_a
+      if metric.sql?
+        fragment = <<-SQL
+          WITH prosperity_metric_count AS (
+            #{metric.sql}
+          )
+          SELECT to_char(#{metric.group_by}, '#{period.db_strf_str}') AS bucket, #{aggregate.to_sql} AS result
+          FROM prosperity_metric_count
+          WHERE (#{metric.group_by} BETWEEN '#{@start_time.iso8601}' AND '#{@end_time.iso8601}')
+          GROUP BY bucket
+        SQL
+        result = ActiveRecord::Base.connection.execute(fragment)
+        s = result.to_a.inject({}) {|accum, el|
+          accum.update(el["bucket"] => el["result"].to_f)
+        }
+      elsif metric.ruby?
+        data = []
+        period.each_period(start_time, end_time) do |start_time|
+          new = metric.value_at.call(start_time, period)
+          last = metric.value_at.call(start_time - period.duration, period)
+
+          data << new - last
+        end
+
+        return data
+      else
+        s = scope.where("#{metric.group_by} BETWEEN ? AND ?", @start_time, @end_time)
+        s = s.group("to_char(#{metric.group_by}, '#{period.db_strf_str}')")
+        s = aggregate.apply(s)
+      end
+
+
+      data = []
+
+      period.each_period(start_time, end_time) do |start_time|
+        str = start_time.strftime(period.ruby_strf_str)
+        value = s.has_key?(str) ? s[str].to_f : 0.0
+        data << value
+      end
+
+      data
+    end
+  end
+end
+

data/lib/prosperity/extractors/total.rb

@@ -0,0 +1,23 @@
+module Prosperity
+  class Extractors::Total < Extractors::Base
+    def self.key
+      "total"
+    end
+
+    def to_a
+      data = []
+
+      period.each_period(start_time, end_time) do |start_time|
+        if metric.sql?
+          data << count_up_to_date_with_sql(start_time)
+        elsif metric.ruby?
+          data << metric.value_at.call(start_time, period)
+        else
+          data << metric.aggregate.apply(scope.where("#{metric.group_by} < ?", start_time))
+        end
+      end
+
+      data
+    end
+  end
+end

data/lib/prosperity/helpers/time.rb

@@ -0,0 +1,12 @@
+module Prosperity
+  class Helpers::Time 
+    def self.beginning_of_hour(date)
+      DateTime.new(date.year, date.month, date.day, date.hour)
+    end
+
+    def self.end_of_hour(date)
+      DateTime.new(date.year, date.month, date.day, date.hour) + 1.hour
+    end
+  end
+end
+

data/lib/prosperity/metric.rb

@@ -9,32 +9,117 @@ module Prosperity
       end
     end
 
-    def self.options(name = nil, &block)
+    def self.sql(fragment = nil, &block)
+      if fragment && block_given?
+        raise ArgumentError, "Must pass string or block but not both"
+      elsif fragment
+        @sql = fragment
+      elsif block_given?
+        @sql = block.call
+      elsif @sql.nil?
+        raise MissingSql.new
+      else
+        @sql
+      end
+    end
+
+    def self.option(name, &block)
+      raise SqlMetricCannotHaveOption.new unless @sql.nil?
       @options ||= default_options
       if block_given?
         @options[name] = Metrics::Option.new(name, &block)
       else
-        raise MissingScope.new if @options.nil?
-        @options
+        raise MissingScope.new
+      end
+    end
+
+    def self.value_at(&block)
+      if block_given?
+        @value_at = block
+      else
+        @value_at or raise MissingValueAt
+      end
+    end
+
+    def self.options
+      @options ||= default_options
+    end
+
+    def self.group_by(column = nil)
+      if column
+        @group_by = column
+      else
+        @group_by || :created_at
+      end
+    end
+
+    def self.aggregate(&block)
+      if block_given?
+        @aggregate = ::Prosperity::Aggregate::AggregateBuilder.new(&block).build
+      else
+        @aggregate || ::Prosperity::Aggregate::Count.new
       end
     end
 
+    def self.extractors
+      [Extractors::Interval, Extractors::Total, Extractors::Change].inject({}) do |h, ext|
+        h[ext.key] = ext
+        h
+      end
+    end
+
+    def self.sql?
+      @sql.present?
+    end
+
+    def self.ruby?
+      @value_at.present?
+    end
+
     def extractors
-      [Extractors::Group, Extractors::Count]
+      self.class.extractors.values
     end
 
     def group_by
-      :created_at
+      self.class.group_by
     end
 
     def scope
       self.class.scope
     end
 
+    def sql
+      self.class.sql
+    end
+
+    def value_at
+      self.class.value_at
+    end
+
     def options
       self.class.options
     end
 
+    def aggregate
+      self.class.aggregate
+    end
+
+    def title
+      self.class.to_s.gsub(/Metric$/, "").titleize
+    end
+
+    def id
+      self.class.name
+    end
+
+    def sql?
+      self.class.sql?
+    end
+
+    def ruby?
+      self.class.ruby?
+    end
+
     private
 
     def self.default_options

data/lib/prosperity/metric_finder.rb

@@ -9,6 +9,16 @@ module Prosperity
     def self.all
       self.new(File.join(Rails.root, "app/prosperity")).metrics
     end
+
+    def self.find_by_name(name)
+      klass = name.constantize
+
+      if klass < Metric
+        klass
+      else
+        nil
+      end
+    end
   end
 end
 

data/lib/prosperity/metrics/option.rb

@@ -1,5 +1,7 @@
 module Prosperity
   class Metrics::Option 
+    attr_reader :name, :block
+
     def initialize(name, &block)
       @name = name
       @block = block

data/lib/prosperity/period.rb

@@ -1,11 +1,12 @@
 module Prosperity
-  class Period < Struct.new(:db_strf_str, :ruby_strf_str, :duration)
+  class Period < Struct.new(:db_strf_str, :ruby_strf_str, :duration, :floor_date, :ceil_date)
     def each_period(start_time, end_time)
-      while start_time < end_time
+      start_time = floor_date.call(start_time)
+      end_time = ceil_date.call(end_time) + 1
+      while start_time <= end_time
         yield start_time
         start_time += duration
       end
     end
   end
 end
-

data/lib/prosperity/periods.rb

@@ -1,6 +1,17 @@
 module Prosperity
   class Periods 
-    MONTH = Period.new("YYYY-MM", "%Y-%m", 1.month)
+    MONTH = Period.new("YYYY-MM", "%Y-%m", 1.month, ->(start_ts){ start_ts.beginning_of_month }, ->(end_ts){ end_ts.end_of_month })
+    WEEK = Period.new("YYYY-WW", "%Y-%W", 1.week, ->(start_ts){ start_ts.beginning_of_week }, ->(end_ts){ end_ts.end_of_week })
+    DAY = Period.new("YYYY-MM-DD", "%Y-%m-%d", 1.day, ->(start_ts){ start_ts.at_midnight }, ->(end_ts){ end_ts.at_end_of_day })
+    HOUR = Period.new("YYYY-MM-DD-H", "%Y-%m-%d-%h", 1.hour, 
+                      ->(start_ts){ Helpers::Time.beginning_of_hour(start_ts) }, 
+                      ->(end_ts){ Helpers::Time.end_of_hour(end_ts) })
+
+    ALL = {
+      month: MONTH, 
+      week: WEEK, 
+      day: DAY,
+      hour: HOUR,
+    }.with_indifferent_access.freeze
   end
 end
-

data/lib/prosperity/version.rb

@@ -1,3 +1,3 @@
 module Prosperity
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end