metricky 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e086c84c42383acedfc1764f23062f6641aeb60
+  data.tar.gz: f0593fe336c19a310c77e5b369752ae86945fa3f
+SHA512:
+  metadata.gz: 2a3899d310416542e06a3b670686c3124508e1324efd4447f653cce260c7160b7b55b116fc3695ea4148776a3d360615ed04ade87dea38ffb1c623289f57e2a2
+  data.tar.gz: 726d8a8d650ec84b9b714720717b9d9c94c18438c7e10041811de51444314ce628cdd56b839f91220b26bf80011df67b76bd0e9046eabb143a12a802ed75a123

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Josh Brody
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,163 @@
+# Metricky
+Display metrics about your database in your application. Depends on the awesome [Chartkick](https://github.com/ankane/chartkick) and [Groupdate](https://github.com/ankane/groupdate).
+
+## Usage
+
+Make this in Ruby:
+
+<img src="https://i.imgur.com/PQhFyAE.png" alt="Metricky example">
+
+In your view where you want to display the metric: 
+
+```erbruby
+render_metric :users
+```
+
+In `app/metrics/users_metric.rb`
+
+```ruby 
+class UsersMetric < Metricky::Base 
+  def scope
+    User
+  end
+
+  def type
+    :count
+  end
+
+  def columns
+    :id
+  end
+
+  def trend
+    :day 
+  end
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metricky'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install metricky
+```
+
+Then drop in Chartkick into your `application.js` (or similar):
+
+```javascript
+//= require chartkick
+```
+
+## Customizing
+
+~~Blatantly ripped from~~ Super-inspired by Laravel Nova's metric system.
+
+### Value to calculate
+
+In your metric, define columns:
+
+```ruby 
+def columns
+  :id 
+end
+```
+
+### Grouping
+
+In your metric, define what trend:
+
+```ruby
+def trend 
+  :day 
+end
+```
+
+This can be any one of `Groupdate::PERIODS`
+
+Define what column should be used:
+
+```ruby
+def trend_column
+  :created_at 
+end
+```
+
+### Value type 
+
+In your metric, define what type:
+
+```ruby
+def type 
+  :count 
+end
+```
+
+This can be any one of `:min, :max, :sum, :count`
+
+### Ranges
+
+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',
+  }
+end
+```
+
+And then their corresponding values (instance-level):
+
+```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
+end
+```
+
+This is used with a `where` query against the `range_column`.
+
+```ruby 
+def range_column
+  :created_at
+end
+```
+
+### Partial
+
+In your metric, define the partial path:
+
+```ruby 
+def to_partial_path
+  "shared/metric"
+end
+```
+
+Take a look at `app/views/metricky/_metric.html.erb` for implementation.
+
+## Contributing
+Add stuff.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Metricky'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

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

@@ -0,0 +1,24 @@
+<div class="card card-body">
+  <%= metric_form_for metric do |f| %>
+    <div class="header-elements-inline">
+      <div>
+        <h5><%= metric.title %></h5>
+      </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()" }  %>
+        </div>
+      <% end %>
+    </div>
+    <div class="media">
+      <div class="media-body">
+        <% if metric.results.is_a?(Hash) %>
+          <%= metricky_chart(metric) %>
+        <% else %>
+          <h3 class="font-weight-semibold mb-0"><%= metric.results %></h3>
+        <% end %>
+        <span class="text-uppercase font-size-sm text-muted"><%= metric.subtitle %></span>
+      </div>
+    </div>
+  <% end %>
+</div>

data/lib/metricky/base.rb

@@ -0,0 +1,173 @@
+module Metricky
+  class Base
+    VALID_TYPES = [:sum, :max, :min, :average, :count].freeze
+    attr_reader :params
+    def initialize(params)
+      @params = params
+      @query = nil
+    end
+
+    # Must be one of Chartkick charts
+    # line_chart, pie_chart, columnchart, bar_chart, areachart, geo_chart, timeline
+    def chart
+      :column_chart
+    end
+
+    # What partial is rendered.
+    def to_partial_path
+      '/metricky/metric'
+    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',
+      }
+    end
+
+    # Actual result of the metric
+    def results
+      assets
+    end
+
+    def self.metric_name
+      name.demodulize.sub(/Metric$/, "")
+    end
+
+    def title
+      self.class.metric_name
+    end
+
+    def subtitle
+      "#{noun} #{scope.model_name.human.pluralize}"
+    end
+
+    # Form key
+    def form_name
+      "#{uri_key}_metric"
+    end
+
+    # Param key
+    def uri_key
+      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."
+    end
+
+    # What kind of metric we're pulling.
+    #
+    # Must be one of :sum, :max, :min, :average, :count
+    def type
+      :count
+    end
+
+    # Column(s) to perform the calculation on.
+    # [:total_in_cents, :department]
+    def columns
+      '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
+      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 trend_column
+      'created_at'
+    end
+
+    def range
+      params.dig(form_name, :range)
+    end
+
+    private
+
+    def trend?
+      trend.present?
+    end
+
+    def assets
+      if range_value != nil
+        @query = scope.where("#{range_column} > ?", range_value)
+      else
+        @query = scope
+      end
+      if trend? && valid_trend?
+        @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}."
+    end
+
+    def check_type
+      unless VALID_TYPES.include?(type.to_sym)
+        raise NameError, "#{type} must be one of :sum, :max, :min, :average, :count"
+      end
+    end
+  end
+end

data/lib/metricky/engine.rb

@@ -0,0 +1,7 @@
+require 'rails'
+
+module Metricky
+  class Engine < Rails::Engine
+    isolate_namespace Metricky
+  end
+end

data/lib/metricky/helper.rb

@@ -0,0 +1,30 @@
+module Metricky
+  module Helper
+    def metric_form_for(metric)
+      form_for("#{request.path}", as: metric.form_name.to_sym, method: :get) do |f|
+        yield(f)
+      end
+    end
+
+    def render_metric(metric_name)
+      if metric_name.is_a?(String) || metric_name.is_a?(Symbol)
+        metric_name = metric_name.to_s
+        if metric_name.end_with?("Metric")
+          metric = metric_name.safe_constantize
+        else
+          klass_name = "#{metric_name.to_s}Metric".camelize
+          metric = "Metrics::#{klass_name}".safe_constantize
+        end
+        raise NameError, "#{metric_name} does not exist" unless metric
+      else
+        metric = metric_name
+      end
+      metric = metric.new(params)
+      render metric, metric: metric
+    end
+
+    def metricky_chart(metric)
+      send(metric.chart, metric.results)
+    end
+  end
+end

data/lib/metricky/version.rb

@@ -0,0 +1,3 @@
+module Metricky
+  VERSION = '0.1.0'
+end

data/lib/metricky.rb

@@ -0,0 +1,13 @@
+require "groupdate"
+require "chartkick"
+require "metricky/base"
+require "metricky/helper"
+
+require "metricky/engine"
+
+module Metricky
+end
+
+ActiveSupport.on_load(:action_view) do
+  include Metricky::Helper
+end

data/lib/tasks/metricky_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :metricky do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: metricky
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Brody
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: groupdate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: chartkick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Metricky
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/views/metricky/_metric.html.erb
+- lib/metricky.rb
+- lib/metricky/base.rb
+- lib/metricky/engine.rb
+- lib/metricky/helper.rb
+- lib/metricky/version.rb
+- lib/tasks/metricky_tasks.rake
+homepage: https://github.com/joshmn/metricky
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A simple stats.
+test_files: []