fact_metrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77dd1df505a65d11950bc95d193a7812d3814d421c79c02fba3537e289fe3034
+  data.tar.gz: 3ec05a41dbcabfca15a2655bba69bc9afea6b0496e4887e83da8b683e99c0338
+SHA512:
+  metadata.gz: 47b7f36271813d46ceb7255387c8ad7e861d78457891dabdf2d13ec8233bbb631bacae9d24bbde447b1d6851cc7bf13eb8a2d4318940d6292c4928831b639e8e
+  data.tar.gz: b8d7c5096bd94f3b185903f21b285c80430600a590be5a77c47c429e02cbe7434da26b83d76c8f639e7ef6bf913fdc72cb3ac2b34d6453a1a8911fb4b1ce84bd

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-09
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Scott Maslar
+
+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,57 @@
+# FactMetrics
+
+FactMetrics provides a collection of class methods for defining metrics on Fact
+models.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+In your Fact model you can add the following types of metric definitions.
+
+### Counts
+
+```
+  count :sales_quantity, all: true
+```
+
+### Averages
+
+```
+  average :regular_unit_price
+```
+
+### Percentages
+
+```
+  percentage :received, field: quantity_received, condition: "> 0"
+  percentage :inspected, field: quantity_inspected, condition: "> 0"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/PatchMonkeyHQ/fact_metrics.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/fact_metrics/average.rb

@@ -0,0 +1,14 @@
+require "active_support/concern"
+
+module FactMetrics::Average
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def average(name, uses: nil, **options)
+      average_config = FactMetrics::AverageConfig.new(name, uses: uses, **options)
+
+      scope(average_config.scope_name, -> {select(average_config.sql)} )
+      composed_of(*average_config.composed_of_attributes)
+    end
+  end
+end

data/lib/fact_metrics/average_config.rb

@@ -0,0 +1,38 @@
+class FactMetrics::AverageConfig
+  attr_reader :name, :uses, :options
+
+  def initialize(name, uses: nil, **options)
+    @name = name
+    @uses = uses
+    @options = options
+  end
+
+  def scope_name = "#{name}_averages"
+  def sql_result_name = "average_#{name}"
+  def composed_of_name = "average_#{name}_metric"
+
+  def composed_of_attributes
+    [
+      composed_of_name.to_sym,
+      class_name: "Metric",
+      mapping: {sql_result_name => :value},
+      constructor: proc { |value| FactMetrics::Metric.new(value, metric_options) }
+    ]
+  end
+
+  def sql
+    <<~SQL
+      CASE WHEN count(*) != 0 THEN
+        AVG(#{field_name})
+      END AS #{sql_result_name}
+    SQL
+  end
+
+  def field_name
+    options[:field] || name.to_s
+  end
+
+  def metric_options
+    options.merge({name: composed_of_name})
+  end
+end

data/lib/fact_metrics/count.rb

@@ -0,0 +1,16 @@
+
+
+module FactMetrics::Count
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def count(name, uses: nil, **options)
+      count_config = FactMetrics::CountConfig.new(name, **options)
+
+      scope(count_config.scope_name, -> {select(count_config.sql)} )
+      composed_of(*count_config.composed_of_attributes)
+
+      metric_hash[count_config.scope_name] = [count_config.uses].compact
+    end
+  end
+end

data/lib/fact_metrics/count_config.rb

@@ -0,0 +1,42 @@
+class FactMetrics::CountConfig
+  attr_reader :name, :uses, :options
+
+  def initialize(name, uses: nil, **options)
+    @name = name
+    @uses = options["uses"] || nil
+    @options = options
+  end
+
+  def scope_name = "#{name}_counts"
+  def sql_result_name = "#{name}_count"
+  def composed_of_name = "#{sql_result_name}_metric"
+
+  def composed_of_attributes
+    [
+      composed_of_name.to_sym,
+      class_name: "Metric",
+      mapping: {sql_result_name => :value},
+      constructor: proc { |value| FactMetrics::Metric.new(value, metric_options) }
+    ]
+  end
+
+  def sql
+    <<~SQL
+      COUNT(*) FILTER (WHERE #{condition_sql}) AS #{sql_result_name}
+    SQL
+  end
+
+  def condition_sql
+    if options[:all] == true
+      options[:all].to_s
+    elsif options[:equal].present?
+      "#{options[:field] || name} = '#{options[:equal]}'"
+    elsif options[:condition].present?
+      options[:condition].to_s
+    end
+  end
+
+  def metric_options
+    {name: composed_of_name, precision: 0}.merge(options)
+  end
+end

data/lib/fact_metrics/metric.rb

@@ -0,0 +1,35 @@
+class FactMetrics::Metric
+  attr_reader :value, :options
+
+  BLANK = Class.new do
+    def method_missing(m, *args, &block)
+      if respond_to_missing?(m)
+        Metric.new(0, {precision: 0})
+      end
+    end
+
+    def respond_to_missing?(m)
+      /_metric$/.match?(m)
+    end
+  end
+
+  def initialize(value, options)
+    @value, @options = value, options
+  end
+
+  def name
+    options[:name].humanize
+  end
+
+  def display_value
+    (value || 0).round(precision)
+  end
+
+  def precision
+    options[:precision] || 1
+  end
+
+  def unit
+    options[:unit] || ""
+  end
+end

data/lib/fact_metrics/percentage.rb

@@ -0,0 +1,14 @@
+module FactMetrics::Percentage
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def percentage(name, uses: :itself, **options)
+      percentage_config = FactMetrics::PercentageConfig.new(name, uses: uses, **options)
+
+      scope(percentage_config.scope_name, -> {select(percentage_config.sql)} )
+      composed_of(*percentage_config.composed_of_attributes)
+
+      metric_hash[percentage_config.scope_name] = [percentage_config.uses].compact
+    end
+  end
+end

data/lib/fact_metrics/percentage_config.rb

@@ -0,0 +1,69 @@
+class FactMetrics::PercentageConfig
+  attr_reader :name, :uses, :options
+
+  def initialize(name, uses: nil, **options)
+    @name = name
+    @uses = uses
+    @options = options
+  end
+
+  def scope_name = "#{name}_percentages"
+  def sql_result_name = "#{name}_percentage"
+  def composed_of_name = "#{name}_percentage_metric"
+
+  def composed_of_attributes
+    [
+      composed_of_name.to_sym,
+      class_name: "Metric",
+      mapping: {sql_result_name => :value},
+      constructor: proc { |value| FactMetrics::Metric.new(value, metric_options) }
+    ]
+  end
+
+  def sql
+    <<~SQL
+      ROUND(
+        (
+          (COUNT(*) FILTER (WHERE #{condition_sql}))::decimal
+          /
+          NULLIF(#{denominator_sql}, 0)
+        ) * 100,
+        2
+      ) AS #{sql_result_name}
+    SQL
+  end
+
+  def condition_sql
+    if options[:equal]
+      "#{field_name} = '#{options[:equal]}'"
+    elsif options[:in]
+      "#{field_name} IN (#{options[:in].map { |i| "'#{i}'" }.join(",")})"
+    elsif options[:condition] && options[:field]
+      "#{field_name} #{options[:condition]}"
+    elsif options[:condition]
+      options[:condition].to_s
+    elsif options[:all]
+      "true"
+    else
+      raise "Conditional option ([:equal, :in, :condition, :all]) required to determine percentage."
+    end
+  end
+
+  def denominator_sql
+    if options[:denominator] == :all
+      "COUNT(*)"
+    elsif options[:denominator]
+      "MAX(#{options[:denominator]})"
+    else
+      "SUM(CASE WHEN #{field_name} IS NOT NULL THEN 1 END)"
+    end
+  end
+
+  def field_name
+    options[:field] || name
+  end
+
+  def metric_options
+    {name: composed_of_name, unit: "%"}.merge(options)
+  end
+end

data/lib/fact_metrics/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FactMetrics
+  VERSION = "0.1.0"
+end

data/lib/fact_metrics.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "fact_metrics/version"
+require_relative "fact_metrics/average"
+require_relative "fact_metrics/count"
+require_relative "fact_metrics/percentage"
+require_relative "fact_metrics/average_config"
+require_relative "fact_metrics/count_config"
+require_relative "fact_metrics/percentage_config"
+require_relative "fact_metrics/metric"
+require "active_support/concern"
+
+module FactMetrics
+  class Error < StandardError; end
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :metric_hash, default: {}
+  end
+
+  include Average
+  include Count
+  include Percentage
+
+  class_methods do
+    def all_metrics
+      load_metrics(*metric_hash.keys)
+    end
+
+    def load_metrics(*metrics)
+      metrics = metrics.map(&:to_s)
+      metric_prerequisites = metrics.flat_map { |metric| metric_hash.fetch(metric) }.compact.uniq
+      metric_query = (metric_prerequisites + metrics).inject(self) { |model_klass, metric_method| model_klass.send(metric_method) }
+
+      # ActiveRecord short-circuits "impossible" predicates, returning an empty array.
+      # In aggregation queries, however, results can still be meaningful without matching rows.
+      # To ensure the query executes, replace the conditional with one that cannot be short-circuited.
+      if metric_query.where_clause.contradiction?
+        metric_query.where_clause = ActiveRecord::Relation::WhereClause.empty
+        metric_query.where!("1=0")
+      end
+
+      metric_query
+    end
+  end
+end

data/sig/fact_metrics.rbs

@@ -0,0 +1,4 @@
+module FactMetrics
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: fact_metrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Maslar
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Kimball Fact tables have typical aggregations, this gem makes implementing
+  them straightforward.
+email:
+- scott@patchmonkey.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/fact_metrics.rb
+- lib/fact_metrics/average.rb
+- lib/fact_metrics/average_config.rb
+- lib/fact_metrics/count.rb
+- lib/fact_metrics/count_config.rb
+- lib/fact_metrics/metric.rb
+- lib/fact_metrics/percentage.rb
+- lib/fact_metrics/percentage_config.rb
+- lib/fact_metrics/version.rb
+- sig/fact_metrics.rbs
+homepage: https://github.com/PatchMonkeyHQ/fact_metrics
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/PatchMonkeyHQ/fact_metrics
+  source_code_uri: https://github.com/PatchMonkeyHQ/fact_metric
+  changelog_uri: https://github.com/PatchMonkeyHQ/fact_metrics/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Adds support for aggregations on Kimball style Fact models.
+test_files: []