metricky 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24b5d4ea790824df18783742e69969e024b31cf44b4164a191d3ff0215804873
-  data.tar.gz: 72143e22bb37bd47da23c70d527011e86f35c2d840dd9593d1a845e0619e40a1
+  metadata.gz: 658a25239c266d3ecdb01b9a7e189fe872e527b93f2eebf4d18a1ced0c6f44b7
+  data.tar.gz: a568dcedbed1b33cd18f5a8fac81acb997557962475f7930399c0d805a0b6ab3
 SHA512:
-  metadata.gz: 753fe8c0f2d2e47b36042426d00a4dfe0352745b4bccc7142de4f4e8f621b7cefb3a19276e56894508f19e53911f836a71300b289dd83a337d9ffe0b0fa0ffea
-  data.tar.gz: cf3896f56e6475af16c5f1d6984d1a177ced083da92f416942ca0eeeeaffe3b70ab1b1caae51c57d8f3cadbcdf77841ff3dd29091dd7cafe86435814aa4afbbe
+  metadata.gz: a07937c18a85e031d0dbe2abcda2d9c3234327cccac545841f159f147e9ed542cbec0c6ad31bc7a68d5e5f6e5fb287a0b3187ce5368f268e85ffb3c2010fde17
+  data.tar.gz: de9ed1c8abd005edb7dba4a86596feaa833a28093b42f9c108803bbc9700cd218f62f6b5315b245669ab99f23d18fb3b901828bbfdfa1430993de936abb4330f

data/README.md

@@ -9,17 +9,22 @@ Make this in Ruby:
 
 ## Generate it 
 
-`rails g metricky:metric User --scope User --type :count --period :day`
+`rails g metricky:metric TotalUsersMetric --scope User --type :count --period :day`
+
+## Display it 
+
 In your view where you want to display the metric: 
 
 ```erbruby
-render_metric :users
+render_metric :total_users
 ```
 
-In `app/metrics/users_metric.rb`
+## Customize it 
+
+In `app/metrics/total_users_metric.rb`
 
 ```ruby 
-class UsersMetric < Metricky::Base 
+class TotalUsersMetric < ApplicationMetric 
   def scope
     User
   end
@@ -28,10 +33,6 @@ class UsersMetric < Metricky::Base
     :count
   end
 
-  def columns
-    :id
-  end
-
   def period
     :day 
   end
@@ -75,7 +76,7 @@ def columns
 end
 ```
 
-### Grouping by date
+### Grouping by period (day, month, year, quarter, etc.)
 
 In your metric, define what period:
 
@@ -105,45 +106,45 @@ def type
 end
 ```
 
-This can be any one of `:min, :max, :sum, :count`
+This can be any one of `:min, :max, :sum, :count, :average`
 
 ### Ranges
 
+Ranges are what values are available on the form (used to query the metric, if applicable) via the `range_column`
+
+```ruby 
+def range_column
+  :created_at
+end
+```
+
+Defaults are `all`, `today`, `24 hours`, `3 days`, `7 days`, `10 days`, `14 days`, `30 days`, `3 months`, `6 months`, `12 months`
+
+#### Creating a new range
 In your metric, define what ranges as a class method:
 
 ```ruby
-def self.ranges
-  {
-      'all' => 'All',
-      '30' => '30 Days',
-      '60' => '60 Days',
-      '365' => '365 Days',
-  }
+class TotalUsersMetric < ApplicationMetric
+  register_range '15h', label: "15 hours" do 
+    15.hours.ago   
+  end
 end
 ```
 
-And then their corresponding values (instance-level):
+#### Removing a range
 
-```ruby 
-def range_value
-  case range
-  when 'all'
-    nil
-  when '30'
-    30.days.ago
-  when '60'
-    60.days.ago
-  when '365'
-    365.days.ago
-  end
+```ruby
+class TotalUsersMetric < ApplicationMetric
+  remove_ranges '24h', '7d' # an array 
+  remove_range '3d' # individual 
 end
 ```
 
-This is used with a `where` query against the `range_column`.
+#### Setting the default range 
 
-```ruby 
-def range_column
-  :created_at
+```ruby
+class TotalUsersMetric < ApplicationMetric
+  default_range '24h'
 end
 ```
 

data/app/metrics/application_metric.rb

@@ -1,3 +1,2 @@
 class ApplicationMetric < Metricky::Base
-
 end

data/app/views/metricky/_metric.html.erb

@@ -6,7 +6,7 @@
       </div>
       <% if metric.class.ranges.any? %>
         <div>
-          <%= f.select :range, metric.class.ranges.invert, { selected: metric.range }, { class: "form-control-sm", name: "#{metric.form_name}[range]", onchange: "this.form.submit()" }  %>
+          <%= f.select :range, metric.range_collection, { selected: metric.range }, { class: "form-control-sm", name: "#{metric.form_name}[range]", onchange: "this.form.submit()" }  %>
         </div>
       <% end %>
     </div>

data/lib/generators/metricky/templates/metric.rb.tt

@@ -1,5 +1,8 @@
 <% module_namespacing do -%>
 class <%= class_name %>Metric < ApplicationMetric
+  # ==> Change the default range (default is all)
+  # default_range '24h'
+
   def scope
     <%= options[:scope] %>
   end
@@ -7,11 +10,31 @@ class <%= class_name %>Metric < ApplicationMetric
   def type
     <%= options[:type][0] == ':' ? options[:type] : ":#{options[:type]}" %>
   end
-
   <% if options[:period] %>
   def period
     <%= options[:period][0] == ':' ? options[:period] : ":#{options[:period]}" %>
   end
+  <% else %>
+  # ==> Change the period grouping
+  # Must be one of Groupdate::PERIODS
+  # def period
+  #   :week
+  # end
   <% end %>
+
+  # ==> Change the chart
+  # def chart
+  #   :column_chart
+  # end
+
+  # ==> Register a new range
+  # Add a range to the select
+  # register_range '15w', label: "15 weeks" do
+  #   15.weeks.ago
+  # end
+
+  # ==> Remove ranges
+  # Remove ranges from the select
+  # exclude_ranges '24h', '30d'
 end
 <% end -%>

data/lib/metricky/base.rb

@@ -1,3 +1,6 @@
+require 'metricky/period'
+require 'metricky/ranges'
+
 module Metricky
   class Base
     VALID_TYPES = [:sum, :max, :min, :average, :count].freeze
@@ -19,32 +22,13 @@ module Metricky
     end
 
     def noun
-      case type.to_sym
-      when :count
-        "total number of"
-      when :average
-        "average #{columns}"
-      when :sum
-        "total"
-      when :min
-        "minimum"
-      when :max
-        "maximum"
-      end
-    end
-
-    # List of ranges and their values. Used (inverted) on the form.
-    def self.ranges
       {
-          'all' => 'All',
-          'Today' => 'Today',
-          '30' => '30 Days',
-          '60' => '60 Days',
-          '365' => '365 Days',
-          'WTD' => 'WTD',
-          'MTD' => 'MTD',
-          'YTD' => 'YTD',
-      }
+          count: "total number of",
+          average: "average #{columns}",
+          sum: "total",
+          min: "minimum",
+          max: "maximum"
+      }[type.to_sym]
     end
 
     # Actual result of the metric
@@ -74,32 +58,6 @@ module Metricky
       self.class.metric_name.tableize
     end
 
-    # Converts range string to a Ruby object
-    def range_value
-      case range
-      when nil
-        nil
-      when 'all'
-        nil
-      when '30'
-        30.days.ago
-      when '60'
-        60.days.ago
-      when '365'
-        365.days.ago
-      when 'WTD'
-        DateTime.now.beginning_of_week
-      when 'MTD'
-        DateTime.now.beginning_of_month
-      when 'YTD'
-        DateTime.now.beginning_of_year
-      when 'Today'
-        DateTime.now.beginning_of_day
-      else
-        raise TypeError, "unknown range_value for range #{range}. Please define it on range_value"
-      end
-    end
-
     # What ActiveRecord class (or scoped class) is being used for  the metric
     def scope
       raise NotImplementedError, "please add a scope to your metric."
@@ -118,66 +76,26 @@ module Metricky
       'id'
     end
 
-    # How it's grouped. Leave nil if no grouping
-    #
-    # [:second, :minute, :hour, :day, :week, :month, :quarter, :year, :day_of_week,
-    # :hour_of_day, :minute_of_hour, :day_of_month, :month_of_year]
-    def trend
-      ActiveSupport::Deprecation.warn('Use period instead')
-      period
-    end
-
-    def period
-      nil
-    end
-
-    # What column to specify for the range calculation. Normally `created_at`
-    def range_column
-      'created_at'
-    end
-
-    # What column to specify for the trend calculation. Normally `created_at`
-    def period_column
-      'created_at'
-    end
-
-    def trend_column
-      ActiveSupport::Deprecation.warn('Use period_column instead')
-      period_column
-    end
-
-    def range
-      params.dig(form_name, :range)
-    end
-
     private
 
-    def period?
-      period.present?
-    end
-
     def assets
-      if range_value != nil
-        @query = scope.where("#{range_column} > ?", range_value)
-      else
-        @query = scope
+      @query = scope
+      unless range_to_value.nil?
+        @query = scope.where("#{range_column} > ?", range_to_value)
       end
       if period? && valid_period?
-        @query = @query.group_by_period(trend, trend_column)
+        @query = @query.group_by_period(period, period_column)
+      end
+      if valid_type?
+        @query = @query.send(type, *columns)
+      else
+        raise TypeError, "#{type} is not a valid type."
       end
-      @query = @query.send(type, *columns)
       @query
     end
 
-    def valid_period?
-      return true if Groupdate::PERIODS.include?(period.to_sym)
-      raise NameError, "period must be one of #{Groupdate::PERIODS}. It is #{period}."
-    end
-
-    def check_type
-      unless VALID_TYPES.include?(type.to_sym)
-        raise NameError, "#{type} must be one of :sum, :max, :min, :average, :count"
-      end
+    def valid_type?
+      VALID_TYPES.include?(type.to_sym)
     end
   end
 end

data/lib/metricky/core_ext.rb

@@ -0,0 +1,8 @@
+class Object
+  def self.deprecate_and_alias_method(new_method, old_method)
+    define_method(old_method) do
+      ActiveSupport::Deprecation.warn("#{old_method} is deprecated. Use #{new_method} instead.")
+      send(new_method)
+    end
+  end
+end

data/lib/metricky/period.rb

@@ -0,0 +1,32 @@
+module Metricky
+  class Base
+    # How it's grouped. Leave nil if no grouping
+    #
+    # [:second, :minute, :hour, :day, :week, :month, :quarter, :year, :day_of_week,
+    # :hour_of_day, :minute_of_hour, :day_of_month, :month_of_year]
+    def period
+      nil
+    end
+    deprecate_and_alias_method :period, :trend
+
+    # What column to specify for the period calculation. Normally `created_at`
+    def period_column
+      'created_at'
+    end
+    deprecate_and_alias_method :period_column, :trend_column
+
+    private
+
+    def period?
+      period.present?
+    end
+    deprecate_and_alias_method :period?, :trend?
+
+    def valid_period?
+      return true if Groupdate::PERIODS.include?(period.to_sym)
+      raise NameError, "period must be one of #{Groupdate::PERIODS}. It is #{period}."
+    end
+    deprecate_and_alias_method :valid_period?, :valid_trend?
+
+  end
+end

data/lib/metricky/range_thing.rb

@@ -0,0 +1,10 @@
+module Metricky
+  class RangeThing
+    attr_reader :label, :priority, :value
+    def initialize(label, priority, value)
+      @label = label
+      @priority = priority
+      @value = value
+    end
+  end
+end

data/lib/metricky/ranges.rb

@@ -0,0 +1,104 @@
+module Metricky
+  class Base
+    class_attribute :ranges, default: {}
+    class_attribute :excluded_ranges, default: []
+    class_attribute :default_range_key, default: 'all'
+
+    def self.default_range(val = nil)
+      self.default_range_key = val
+    end
+
+    # Rewrite the priority of a range thing.
+    #
+    # class UserMetric
+    #   range_priority '24h', 99
+    # end
+    def self.range_priority(key, priority)
+      self.ranges[key.to_s].priority = priority
+    end
+
+    # Register a range. Priority is used for the select order.
+    #
+    # @param [String] key The value for the option in the select for the form
+    # @param [String] label The text shown on the option in the select for the form
+    # @param [Integer] priority What order the resulting collection
+    # @param [Block/Proc] block The Ruby-converted value. Usually a DateTime/Date/Time object.
+    #
+    # class UserMetric
+    #   register_range '15w', label: '15 weeks', priority: 99 do
+    #     15.weeks.ago
+    #   end
+    # end
+    #
+    # @return RangeThing
+    def self.register_range(key, label: nil, priority: nil, &block)
+      label ||= key
+      priority ||= self.ranges.size
+      self.ranges[key.to_s] = RangeThing.new(label, priority, block)
+    end
+
+    # Removes the listed ranges from the select
+    def self.remove_ranges(*keys)
+      keys.each { self.remove_range(key) }
+    end
+
+    def self.remove_range(key)
+      self.excluded_ranges << key.to_s
+    end
+
+    register_range 'all', label: 'All' do
+      nil
+    end
+
+    register_range 'today', label: 'Today' do
+      DateTime.now.beginning_of_day
+    end
+
+    register_range '24h', label: '24 hours' do
+      24.hours.ago
+    end
+
+    [3, 7, 10, 14, 21, 30].each do |day|
+      register_range "#{day}d", label: "#{day} Days" do
+        day.days.ago
+      end
+    end
+
+    register_range "MTD", label: "MTD" do
+      DateTime.now.beginning_of_month
+    end
+
+    register_range "QTD", label: "QTD" do
+      DateTime.now.beginning_of_quarter
+    end
+
+    register_range "YTD", label: "YTD" do
+      DateTime.now.beginning_of_year
+    end
+
+    # Lookup the passed range and convert it to a value for our ActiveRecord query
+    def range_to_value
+      return nil if range.nil?
+      if val = self.ranges[range]
+        val.value.call
+      else
+        raise TypeError, "invalid range #{range}. Please define it."
+      end
+    end
+    deprecate_and_alias_method :range_to_value, :range_value
+
+    # What column to specify for the range calculation. Normally `created_at`
+    def range_column
+      'created_at'
+    end
+
+    def range
+      params.dig(form_name, :range) || default_range_key
+    end
+
+    # Used in the HTML form for the metric as the select options
+    def range_collection
+      ranges.except(*excluded_ranges).sort_by { |_, range| range.priority }.collect { |key, range_thing| [range_thing.label, key] }
+    end
+  end
+end

data/lib/metricky/version.rb

@@ -1,3 +1,3 @@
 module Metricky
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/metricky.rb

@@ -1,11 +1,15 @@
 require "groupdate"
 require "chartkick"
+require 'metricky/core_ext'
+require 'active_support/core_ext'
+require 'active_support/concern'
+require "metricky/range_thing"
+require "metricky/ranges"
 require "metricky/base"
 require "metricky/helper"
 require "metricky/engine"
 
-module Metricky
-end
+module Metricky; end
 
 ActiveSupport.on_load(:action_view) do
   include Metricky::Helper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metricky
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2019-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -126,8 +126,12 @@ files:
 - lib/generators/metricky/templates/metric.rb.tt
 - lib/metricky.rb
 - lib/metricky/base.rb
+- lib/metricky/core_ext.rb
 - lib/metricky/engine.rb
 - lib/metricky/helper.rb
+- lib/metricky/period.rb
+- lib/metricky/range_thing.rb
+- lib/metricky/ranges.rb
 - lib/metricky/version.rb
 homepage: https://github.com/joshmn/metricky
 licenses: