metricky 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 362f2f40e07645963b83935211c9ab8c222db9cb9064c099dd8b466597be2b08
-  data.tar.gz: 5a882ce98adecc050b1f3398935b26b09d961d67d98db24b5a018a3f3c43d65f
+  metadata.gz: ba9f360352ce74897a0d14441895c362c20f030d660f3a3317cc1499c8889938
+  data.tar.gz: 33a086fc39c12b532b607ab8a5a087655a6a62c01a673d3da5f8e1b99724f152
 SHA512:
-  metadata.gz: f3f72bad0f1523a606e27244780c1b43e739fd846e5b393c4ab1bac1a2c4a8b8b2ca63cd23a01f51a7ff7a710faa624b1236dff0b0d1cc613707459ccec3967e
-  data.tar.gz: 9fa0ad994b4c4558f95eecb24ba9bf05ee42f19fc2805771900716925433f1b818e528f6887e2cff0b0f8ba5ab884cb85fd10541fdd482e6937aa9ef0f59103c
+  metadata.gz: 5aa3e090e3e978c9ab99aff4beb8c0037d03829ef78e4bc02c4136ab5a8a599779265b8c90079c13c70299569819afd2e8218e39943d095d635293acc741bc05
+  data.tar.gz: 7942700ad381ac944c887ecadea0f91f945a9c8b19f196a1594a8eb3f92e3cb81320c86a5f7c096369229931c82aed1669e24c7001378b5d233fecb1bfed696e

data/README.md

@@ -176,6 +176,28 @@ class TotalUsersMetric < ApplicationMetric
 end
 ```
 
+#### Customizing the label
+
+Use `collection_label`
+
+```ruby 
+class TotalUsersMetric < ApplicationMetric
+  def collection_label(range_thing)
+    "Born #{range_thing.value.call}"
+  end
+end 
+```
+
+Need helpers? `h`
+
+```
+class TotalUsersMetric < ApplicationMetric
+  def collection_label(range_thing)
+    "Born #{h.time_ago_in_words(range_thing.value.call)}"
+  end
+end 
+```
+
 ### Partial
 
 In your metric, define the partial path:

data/lib/generators/metricky/metric_generator.rb

@@ -4,9 +4,10 @@ module Metricky
       source_root File.expand_path("templates", __dir__)
       check_class_collision suffix: "Metric"
 
-      class_option :scope, type: :string, aliases: %i(--scope), default: '', desc: "What class or scoped class this metric pulls from"
-      class_option :type, type: :string, aliases: %i(--type), default: ':count', desc: "What type of metric (:count, :max, :min, :sum, :average)"
-      class_option :period, type: :string, default: 'nil', aliases: %i{--period}, desc: "What class or scoped class this metric pulls from"
+      class_option :scope, type: :string, aliases: %i(--scope), default: '', desc: "What class or scoped class this metric pulls from. Required."
+      class_option :type, type: :string, aliases: %i(--type), default: ':count', desc: "What type of metric — one of :count, :max, :min, :sum, :average. Default is :count"
+      class_option :period, type: :string, default: 'nil', aliases: %i{--period}, desc: "What class or scoped class this metric pulls from (optional)"
+      class_option :group, type: :string, default: 'nil', aliases: %i{--group}, desc: "Specify what attribute to group by (optional)"
 
       def create_metric_file
         template "metric.rb", File.join("app/metrics", class_path, "#{file_name}_metric.rb")

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

@@ -47,5 +47,10 @@ class <%= class_name %>Metric < ApplicationMetric
   # def form?
   #   false
   # end
+
+  # ==> Change the collection label on ranges
+  # def collection_label(range_thing)
+  #   "Born #{range_thing.label}"
+  # end
 end
 <% end -%>

data/lib/metricky/base.rb

@@ -139,6 +139,9 @@ module Metricky
       @query
     end
 
+    def h
+      @h ||= ActionController::Base.helpers
+    end
 
     def format_value(value)
       value

data/lib/metricky/ranges.rb

@@ -97,13 +97,17 @@ module Metricky
       'created_at'
     end
 
+    def collection_label(range_thing)
+      "#{range_thing.label}"
+    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.sort_by { |_, range| range.priority }.collect { |key, range_thing| [range_thing.label, key] }
+      ranges.sort_by { |_, range| range.priority }.collect { |key, range_thing| [collection_label(range_thing), key] }
     end
   end
 end

data/lib/metricky/version.rb

@@ -1,3 +1,3 @@
 module Metricky
-  VERSION = '0.8.0'
+  VERSION = '0.8.2'
 end

metadata

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