metricular 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc80e11c169f09cf82d3cbbacaaffa36ea40a918
+  data.tar.gz: cfd1c6a74ba2afed60b26e20b2d9cb2413f93f1c
+SHA512:
+  metadata.gz: 084f4fea09a408f353f932156e826033fa2335f9a7c7d5beb2bbce8f11523a602935a5e6f69679b4740670b3dc848de04ebbe6178ddfbb85b6dd59d2e0f789d2
+  data.tar.gz: df7c2bf2c783cbf53c73a09abde4b2f0a17e3ef25676c26f16e31e6573f47fa3e4740105713a56cd074659b37a3489b7267c4d7c0df209d6055998d3502e97bb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nicholas Firth-McCoy
+
+MIT License
+
+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,29 @@
+# Metricular
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'metricular'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metricular
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/metricular/migration_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class Metricular::MigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def copy_migrations
+    migration_template 'create_metrics.rb', "db/migrate/create_metrics.rb"
+  end
+end

data/lib/generators/metricular/templates/create_metrics.rb

@@ -0,0 +1,18 @@
+# Creates the database table plus indexes you'll need to use Metricular
+class CreateMetrics < ActiveRecord::Migration
+  def self.up
+    create_table :metrics, force: true do |t|
+      t.string :name
+      t.date :date
+      t.string :value
+      t.timestamps
+    end
+
+    add_index :metrics, :name
+    add_index :metrics, [ :name, :date ]
+  end
+
+  def self.down
+    drop_table :metrics
+  end
+end

data/lib/metricular.rb

@@ -0,0 +1,2 @@
+require "metricular/version"
+require "metricular/metric"

data/lib/metricular/metric.rb

@@ -0,0 +1,68 @@
+module Metricular
+  class Metric < ActiveRecord::Base
+    # Return all metrics that have been defined
+    def self.metrics
+      @metrics
+    end
+
+    # Define a new metric for recording
+    def self.define(name, block, options = {})
+      @metrics ||= {}
+      @metrics[name] = [block, options]
+      scope name, -> { where(name: name) }
+    end
+
+    # Record data for all defined metrics
+    def self.record_all
+      @metrics.each { |name, _| record(name) }
+    end
+
+    # Record data for the specified metric, for the specified date
+    def self.record(name, date = Time.now.utc)
+      block, options = @metrics[name]
+      value = block.call(date)
+      find_or_create_by(name: name, date: date) { |metric| metric.value = value }
+    end
+
+    # Return an array of recorded metric data in [date, value] format
+    def self.data
+      all.map { |metric| [metric.date.to_time.to_i * 1000, metric.value.to_f] }
+    end
+
+    ####################
+    # Stats
+    ####################
+
+    def self.mean
+      (data.sum { |date, val| val }) / count.to_f
+    end
+
+    def self.variance
+      mean = self.mean
+      count = self.count
+      (data.sum { |date, val| (val - mean) ** 2 }) / (count - 1).to_f
+    end
+
+    def self.standard_deviation
+      return Math.sqrt(variance)
+    end
+
+    ####################
+    # Scopes
+    ####################
+
+    # By default, order recorded metrics from oldest to newest
+    default_scope { order('date ASC') }
+
+    # Handy date range scopes
+    scope :in_range, -> (start_date, end_date) { where('date > ? and date < ?', start_date, end_date) }
+    scope :in_month, -> (month) { in_range(month.beginning_of_month, month.end_of_month) }
+    scope :in_week, -> (week) { in_range(week.beginning_of_week, week.end_of_week) }
+    scope :this_month, -> { in_month(Time.now.utc) }
+    scope :last_month, -> { in_month(1.month.ago) }
+
+    # Maximum and minimum scopes
+    scope :maximum_value, -> { order('value DESC').limit(1).first }
+    scope :minimum_value, -> { order('value ASC').limit(1).first }
+  end
+end

data/lib/metricular/version.rb

@@ -0,0 +1,3 @@
+module Metricular
+  VERSION = "0.0.1"
+end

data/lib/tasks/metricular.rake

@@ -0,0 +1,6 @@
+namespace :metricular do
+  desc "Record data for all defined Metricular metrics"
+  task record_all: :environment do
+    Metricular::Metric.record_all
+  end
+end

data/metricular.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metricular/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "metricular"
+  spec.version       = Metricular::VERSION
+  spec.authors       = ["Nicholas Firth-McCoy"]
+  spec.email         = ["nicholas@2suggestions.com.au"]
+  spec.summary       = "A little metric snapshot framework for keeping track of your SaaS metrics"
+  spec.homepage      = "https://github.com/nfm/metricular"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: metricular
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicholas Firth-McCoy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- nicholas@2suggestions.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/metricular/migration_generator.rb
+- lib/generators/metricular/templates/create_metrics.rb
+- lib/metricular.rb
+- lib/metricular/metric.rb
+- lib/metricular/version.rb
+- lib/tasks/metricular.rake
+- metricular.gemspec
+homepage: https://github.com/nfm/metricular
+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.1.3
+signing_key: 
+specification_version: 4
+summary: A little metric snapshot framework for keeping track of your SaaS metrics
+test_files: []