tally 1.0.0.beta1

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/ruby-parse

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-parse' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("parser", "ruby-parse")

data/bin/ruby-rewrite

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-rewrite' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("parser", "ruby-rewrite")

data/bin/sprockets

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'sprockets' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("sprockets", "sprockets")

data/bin/thor

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("thor", "thor")

data/config/routes.rb

@@ -0,0 +1,12 @@
+Tally::Engine.routes.draw do
+
+  get "/days/:type/:id", to: "days#index", as: :recordable_days
+  resources :days, only: :index
+
+  get "/keys/:type/:id", to: "keys#index", as: :recordable_keys
+  resources :keys, only: :index
+
+  get "/records/:type/:id", to: "records#index", as: :recordable_records
+  resources :records, only: :index
+
+end

data/db/migrate/20181016172358_create_tally_records.rb

@@ -0,0 +1,15 @@
+class CreateTallyRecords < ActiveRecord::Migration[5.2]
+  def change
+    create_table :tally_records do |t|
+      t.date :day
+      t.bigint :recordable_id
+      t.string :recordable_type
+      t.string :key
+      t.integer :value, default: 0
+
+      t.timestamps
+    end
+
+    add_index :tally_records, [ :day, :key, :recordable_id, :recordable_type ], name: "index_tally_records_on_day", unique: true
+  end
+end

data/lib/tally.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "tally/engine"
+require "tally/version"
+require "active_support/dependencies/autoload"
+require "kaminari/activerecord"
+
+require "redis"
+
+begin
+  # attempt to load sidekiq if it is installed
+  # if not, just use plain Redis + ActiveJob
+  require "sidekiq"
+rescue LoadError
+  nil
+end
+
+module Tally
+
+  extend ActiveSupport::Autoload
+  include ActiveSupport::Configurable
+
+  autoload :Archiver
+  autoload :Calculator
+  autoload :CalculatorRunner
+  autoload :Countable
+  autoload :Daily
+  autoload :Increment
+  autoload :Keyable
+  autoload :KeyFinder
+  autoload :RecordSearcher
+  autoload :Sweeper
+
+  eager_autoload do
+    autoload :Calculators
+  end
+
+  extend Calculators
+
+  configure do |config|
+    config.prefix = "tally"
+    config.date_format = "%Y-%m-%d"
+
+    # Amount of time a key lives by default
+    config.ttl = 4.days
+
+    # Archivers get queued into the background with ActiveJob by default
+    # Set to :now to run inline
+    config.perform_calculators = :later
+  end
+
+  # If sidekiq is available, piggyback on its pooling
+  #
+  # Otherwise, just use redis directly
+  def self.redis(&block)
+    raise ArgumentError, "requires a block" unless block_given?
+
+    if defined?(Sidekiq)
+      Sidekiq.redis(&block)
+    else
+      block.call(redis_connection)
+    end
+  end
+
+  def self.redis_connection
+    @redis_connection ||= Redis.current
+  end
+
+  def self.redis_connection=(connection)
+    @redis_connection = connection
+  end
+
+  def self.increment(*args)
+    Increment.public_send(:increment, *args)
+  end
+
+end

data/lib/tally/archiver.rb

@@ -0,0 +1,64 @@
+module Tally
+  class Archiver
+
+    def initialize(key: nil, day: nil, record: nil, type: nil)
+      @key = key
+      @day = day
+      @record = record
+      @type = type
+    end
+
+    def archive!
+      remove_existing_records
+
+      finder.entries.each do |entry|
+        next if entry.type.present? && !entry.record
+
+        record = if entry.record
+          Record.find_or_initialize_by(day: entry.date, key: entry.key, recordable: entry.record)
+        else
+          Record.find_or_initialize_by(day: entry.date, key: entry.key, recordable: nil)
+        end
+
+        record.value = entry.value
+        record.save
+      end
+
+      enqueue_registered_calculators
+
+      true
+    end
+
+    def day
+      @day ||= Time.current.utc.to_date
+    end
+
+    def self.archive!(*args)
+      new(*args).archive!
+    end
+
+    private
+
+      def enqueue_registered_calculators
+        day_str = day.strftime("%Y-%m-%d")
+        calculate_method = Tally.config.perform_calculators == :now ? :perform_now : :perform_later
+
+        Tally.calculators.each do |class_name|
+          CalculatorRunnerJob.public_send(calculate_method, class_name, day_str)
+        end
+      end
+
+      def finder
+        @finder ||= Daily.new(key: @key, day: @day, record: @record, type: @type)
+      end
+
+      def remove_existing_records
+        return if @key.present?
+        return if @record.present?
+        return if @type.present?
+
+        Record.where(day: day).delete_all
+      end
+
+  end
+end

data/lib/tally/calculator.rb

@@ -0,0 +1,30 @@
+require "active_support/concern"
+
+module Tally
+  module Calculator
+
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :day
+    end
+
+    def initialize(day = Date.today)
+      @day = day
+    end
+
+    # Override in sub class, this is what gets called when the calculator
+    # is run. This method is run in the background so it can take a while
+    # if needed to summarize data.
+    def call
+      raise NotImplementedError
+    end
+
+    private
+
+      def record_scope
+        Record.where(day: day).includes(:recordable)
+      end
+
+  end
+end

data/lib/tally/calculator_runner.rb

@@ -0,0 +1,56 @@
+module Tally
+  class CalculatorRunner
+
+    attr_reader :date
+
+    def initialize(class_name, date)
+      @date       = date
+      @class_name = class_name
+    end
+
+    def klass
+      @klass ||= @class_name.to_s.safe_constantize
+    end
+
+    # loop through each value and save in db
+    def save
+      return false unless valid?
+
+      values.each do |attributes|
+        create_record(attributes)
+      end
+
+      true
+    end
+
+    def values
+      return [] unless valid?
+
+      @values ||= [ klass.new(date).call ].flatten
+    end
+
+    def valid?
+      klass.present? && date.present?
+    end
+
+    private
+
+      def create_record(attributes)
+        finder = { day: date, key: attributes[:key] }
+
+        id = attributes.delete(:id)
+        type = attributes.delete(:type)
+
+        if id && type
+          finder[:recordable_id] = id
+          finder[:recordable_type] = type.to_s.classify
+        end
+
+        record = Record.find_or_initialize_by(finder)
+
+        record.attributes = attributes
+        record.save
+      end
+
+  end
+end

data/lib/tally/calculators.rb

@@ -0,0 +1,29 @@
+module Tally
+  module Calculators
+
+    def calculators
+      @calculators ||= []
+    end
+
+    def register_calculator(*class_name)
+      @calculators ||= []
+
+      class_name.each do |class_name|
+        unless @calculators.include?(class_name.to_s)
+          @calculators.push(class_name.to_s)
+        end
+      end
+
+      nil
+    end
+
+    def unregister_calculator(*class_names)
+      @calculators ||= []
+
+      class_names = class_names.map(&:to_s)
+
+      @calculators.delete_if { |n| class_names.include?(n) }
+    end
+
+  end
+end

data/lib/tally/countable.rb

@@ -0,0 +1,23 @@
+require "active_support/concern"
+
+module Tally
+  module Countable
+
+    extend ActiveSupport::Concern
+
+    def increment_tally(key, by = 1)
+      return if new_record?
+
+      Tally.increment(key, self, by)
+    end
+
+    def tally_records(search_params = {})
+      if search_params.present?
+        RecordSearcher.search(search_params.merge(record: self))
+      else
+        Record.where(recordable: self)
+      end
+    end
+
+  end
+end