metricky 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00c9f64ffdfcde854adec21097bbee40db3346ae0e29e135515ec369ab2c4125
-  data.tar.gz: 1a505fad343ef588d47a9ac91031aa08742ebe83b391950867e0e245d33668f9
+  metadata.gz: 2ba909df61c99a49ddea9e6bc914eb941796f18c38443e6becdecf3766542522
+  data.tar.gz: 3c69b7adda470fe9d06e7fb0383213d988b191a0224b3be4d6cf1518c450887a
 SHA512:
-  metadata.gz: 28785bf4d28eada869bc59818f86309bf1e0dd1bf9171eda4bdd5dcf902f782273198023086b672dd49500c79ac1670b5eec17c371903478e41b7bb39b051e71
-  data.tar.gz: 3ba646a2f5b421496652e43b4591ae7029769e87501dc91fa476ef99f2d825830e1cc75cbfc59310e7731e3282557899657b5ffd3d86079ea67413ca2e7da63e
+  metadata.gz: 924c1ded4febd716dbbd9d01885581668cd3dfb014595fb630efe2e5c92d3e280fdc7b04ad87d5797fc528b2f639fc67585f392755cf1dfd68046a36c8fb9d62
+  data.tar.gz: 25309a6bd7a3836ab5a6b69b85301c958c64023638a0d3b4100b9c8fd117d263a1376cd13dedb7ad728bbfe6ac2c0d397a17255d5f30dd7a9a59d139fc8d9594

data/README.md

@@ -7,6 +7,9 @@ Make this in Ruby:
 
 <img src="https://i.imgur.com/PQhFyAE.png" alt="Metricky example">
 
+## Generate it 
+
+`rails g metricky:metric User --scope User --type :count --period :day`
 In your view where you want to display the metric: 
 
 ```erbruby
@@ -29,7 +32,7 @@ class UsersMetric < Metricky::Base
     :id
   end
 
-  def trend
+  def period
     :day 
   end
 end
@@ -72,12 +75,12 @@ def columns
 end
 ```
 
-### Grouping
+### Grouping by date
 
-In your metric, define what trend:
+In your metric, define what period:
 
 ```ruby
-def trend 
+def period 
   :day 
 end
 ```
@@ -87,7 +90,7 @@ This can be any one of `Groupdate::PERIODS`
 Define what column should be used:
 
 ```ruby
-def trend_column
+def period_column
   :created_at 
 end
 ```

data/lib/generators/metricky/metric_generator.rb

@@ -18,6 +18,7 @@ module Metricky
       end
 
       private
+
       def file_name # :doc:
         @_file_name ||= super.sub(/_metric\z/i, "")
       end

data/lib/metricky/base.rb

@@ -123,6 +123,11 @@ module Metricky
     # [: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
 
@@ -132,18 +137,23 @@ module Metricky
     end
 
     # What column to specify for the trend calculation. Normally `created_at`
-    def trend_column
+    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 trend?
-      trend.present?
+    def period?
+      period.present?
     end
 
     def assets
@@ -152,16 +162,16 @@ module Metricky
       else
         @query = scope
       end
-      if trend? && valid_trend?
+      if period? && valid_period?
         @query = @query.group_by_period(trend, trend_column)
       end
       @query = @query.send(type, *columns)
       @query
     end
 
-    def valid_trend?
-      return true if Groupdate::PERIODS.include?(trend.to_sym)
-      raise NameError, "trend must be one of #{Groupdate::PERIODS}. It is #{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
 
     def check_type

data/lib/metricky/version.rb

@@ -1,3 +1,3 @@
 module Metricky
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metricky
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Josh Brody