metricky 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54becc08e11727ef77a77175dd2039f34451e53fbd21df65cd9f041ed1b3177e
-  data.tar.gz: 8c99b91ae474c167102f58d7f080ad653abf65cb7f777fb0a00a2fe2ba03a731
+  metadata.gz: 362f2f40e07645963b83935211c9ab8c222db9cb9064c099dd8b466597be2b08
+  data.tar.gz: 5a882ce98adecc050b1f3398935b26b09d961d67d98db24b5a018a3f3c43d65f
 SHA512:
-  metadata.gz: 10dfa8257b5fae1e6169182f30f53800df54faa933e3daf73bb39382c2207c6a8c2f810a10b27b2e88b30249f2bc8d9865713c1c9deb190e678ac2f5c3bd7556
-  data.tar.gz: 2e203ea4e914c2aa3a6309a3e92bafa0604656dc8b9ebd47f299f1cc00d631d11b5f520e3d5da669d07e16392e1e1957b0112141f91737658d6fd357f96a14c4
+  metadata.gz: f3f72bad0f1523a606e27244780c1b43e739fd846e5b393c4ab1bac1a2c4a8b8b2ca63cd23a01f51a7ff7a710faa624b1236dff0b0d1cc613707459ccec3967e
+  data.tar.gz: 9fa0ad994b4c4558f95eecb24ba9bf05ee42f19fc2805771900716925433f1b818e528f6887e2cff0b0f8ba5ab884cb85fd10541fdd482e6937aa9ef0f59103c

data/README.md

@@ -86,6 +86,16 @@ def columns
 end
 ```
 
+### Grouping the value
+
+To `User.all.group(:color).count`
+
+```ruby
+def group
+  :color 
+end
+```
+
 ### Grouping by period (day, month, year, quarter, etc.)
 
 In your metric, define what period:
@@ -150,6 +160,14 @@ class TotalUsersMetric < ApplicationMetric
 end
 ```
 
+#### Removing all ranges
+
+```ruby
+class TotalUsersMetric < ApplicationMetric
+  reset_ranges!
+end
+```
+
 #### Setting the default range 
 
 ```ruby

data/app/controllers/metrics_controller.rb

@@ -0,0 +1,11 @@
+module Metricky
+  class MetricsController < ActionController::Base
+    def show
+      metric = "#{params[:name].classify}Metric".constantize.new(params[:query] || {}, params[:options] || {})
+      unless metric.results.is_a?(Hash) || metric.results.is_a?(Array)
+        raise RenderError, "results must be a hash or array"
+      end
+      render json: metric.to_json
+    end
+  end
+end

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

@@ -12,7 +12,7 @@
     </div>
     <div class="media">
       <div class="media-body">
-        <% if metric.results.is_a?(Hash) %>
+        <% if metric.chart? %>
           <%= metricky_chart(metric) %>
         <% else %>
           <h3 class="font-weight-semibold mb-0"><%= metric.results %></h3>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Metricky::Engine.routes.draw do
+  resources :metrics, only: [:show], param: :name
+end

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

@@ -10,15 +10,14 @@ class <%= class_name %>Metric < ApplicationMetric
   def type
     <%= options[:type][0] == ':' ? options[:type] : ":#{options[:type]}" %>
   end
-  <% if options[:period] %>
+  <% if options[:group] %>
   def period
-    <%= options[:period][0] == ':' ? options[:period] : ":#{options[:period]}" %>
+    <%= options[:group][0] == ':' ? options[:group] : ":#{options[:group]}" %>
   end
   <% else %>
-  # ==> Change the period grouping
-  # Must be one of Groupdate::PERIODS
-  # def period
-  #   :week
+  # ==> Change the grouping
+  # def group
+  #   :color
   # end
   <% end %>
 
@@ -42,5 +41,11 @@ class <%= class_name %>Metric < ApplicationMetric
   # def form?
   #   false
   # end
+
+  # ==> Render chart async
+  # Renders the chart asynchronously with an ajax request. There are some limitations. Read here.
+  # def form?
+  #   false
+  # end
 end
 <% end -%>

data/lib/metricky/base.rb

@@ -20,6 +20,10 @@ module Metricky
       :column_chart
     end
 
+    def chart_options
+      @chart_options ||= {}
+    end
+
     # What partial is rendered.
     def to_partial_path
       '/metricky/metric'
@@ -40,6 +44,10 @@ module Metricky
       assets
     end
 
+    def name
+      self.class.metric_name
+    end
+
     def self.metric_name
       name.demodulize.sub(/Metric$/, "")
     end
@@ -85,6 +93,26 @@ module Metricky
       ranges.any?
     end
 
+    def chart?
+      results.is_a?(Hash) || results.is_a?(Array)
+    end
+
+    def to_json
+      results.chart_json
+    end
+
+    def group
+      false
+    end
+
+    def group?
+      group.present?
+    end
+
+    def json?
+      false
+    end
+
     private
 
     def assets
@@ -95,6 +123,9 @@ module Metricky
       if period? && valid_period?
         @query = @query.group_by_period(period, period_column)
       end
+      if group?
+        @query = @query.group(group)
+      end
       if valid_type?
         @query = @query.send(type, *columns)
       else
@@ -108,6 +139,7 @@ module Metricky
       @query
     end
 
+
     def format_value(value)
       value
     end

data/lib/metricky/helper.rb

@@ -6,6 +6,10 @@ module Metricky
       end
     end
 
+    def metricky_metric_path(metric, options = {})
+      metricky.metric_path(name: metric.name.underscore, query: request.query_parameters, options: options)
+    end
+
     def render_metric(metric_name, options = {})
       if metric_name.is_a?(String) || metric_name.is_a?(Symbol)
         metric_name = metric_name.to_s
@@ -23,8 +27,12 @@ module Metricky
       render metric, metric: metric
     end
 
-    def metricky_chart(metric)
-      send(metric.chart, metric.results)
+    def metricky_chart(metric, options = {})
+      if metric.json?
+        send(metric.chart, metricky_metric_path(metric, options))
+      else
+        send(metric.chart, metric.results, options)
+      end
     end
   end
 end

data/lib/metricky/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metricky
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.0
 platform: ruby
 authors:
 - Josh Brody
@@ -118,8 +118,10 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/metrics_controller.rb
 - app/metrics/application_metric.rb
 - app/views/metricky/_metric.html.erb
+- config/routes.rb
 - lib/generators/metricky/USAGE
 - lib/generators/metricky/metric_generator.rb
 - lib/generators/metricky/templates/application_metric.rb.tt