luck_remover 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc1b1530a599ee139347208b43f1c6fd6366c9ab7f78024702a5d8cc79293325
+  data.tar.gz: 2c99268c938c575639ff6fe9a06b098e7a419cfe17824d632d631fc462d7338e
+SHA512:
+  metadata.gz: 9686dd5a3997e32c8045db01e564146f8d67cc5d612bef475d69a505c7a3a5eece606f52bfb0a90b80a282453158c2d26dd6fb3a657bf849c69ba37f43e1b9bf
+  data.tar.gz: 0c01f0d6f8dcbda67ccb8fb1096b7bada0713bc202792771e5c3edd27abaa71f027df33c3e9ca6877446e369a3fe8e4f60876053d06b4ea2936f2b09c48b86fc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright TODO: Write your name
+
+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,3 @@
+# luck_remover
+
+Goals set against an app's own metrics.

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/app/assets/stylesheets/luck_remover/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/luck_remover/application_controller.rb

@@ -0,0 +1,4 @@
+module LuckRemover
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/luck_remover/application_helper.rb

@@ -0,0 +1,4 @@
+module LuckRemover
+  module ApplicationHelper
+  end
+end

data/app/jobs/luck_remover/application_job.rb

@@ -0,0 +1,4 @@
+module LuckRemover
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/luck_remover/application_mailer.rb

@@ -0,0 +1,6 @@
+module LuckRemover
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/luck_remover/application_record.rb

@@ -0,0 +1,5 @@
+module LuckRemover
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/luck_remover/goal.rb

@@ -0,0 +1,32 @@
+require "cs133"
+
+module LuckRemover
+  class Goal < ApplicationRecord
+    belongs_to :owner, polymorphic: true
+
+    scope :for_owner, ->(owner) { where(owner: owner) }
+
+    enum :direction, { at_least: "at_least", at_most: "at_most" }, validate: true
+    enum :period, { week: "week", month: "month" }, validate: true
+
+    validate :metric_is_registered
+
+    def standing(now: Time.current)
+      value = LuckRemover.metric(metric_key).read(range: current_period(now)).value
+      Standing.new(value: value, target: target, direction: direction)
+    end
+
+    private
+
+    def current_period(now)
+      range = month? ? Cs133::Range.this_month(zone: Time.zone, now: now) : Cs133::Range.last_weeks(1, zone: Time.zone, now: now).first
+      range.to_range
+    end
+
+    def metric_is_registered
+      return if LuckRemover.metrics.registered?(metric_key.to_s)
+
+      errors.add(:metric_key, "#{metric_key} is not a registered goal metric")
+    end
+  end
+end

data/app/models/luck_remover/standing.rb

@@ -0,0 +1,7 @@
+module LuckRemover
+  Standing = Data.define(:value, :target, :direction) do
+    def met?
+      direction.to_s == "at_most" ? value <= target : value >= target
+    end
+  end
+end

data/app/views/layouts/luck_remover/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Luck remover</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "luck_remover/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+LuckRemover::Engine.routes.draw do
+end

data/db/migrate/20261022212722_create_luck_remover_goals.rb

@@ -0,0 +1,14 @@
+class CreateLuckRemoverGoals < ActiveRecord::Migration[8.1]
+  def change
+    create_table :luck_remover_goals do |t|
+      t.references :owner, polymorphic: true, null: false
+      t.string :name
+      t.string :metric_key
+      t.decimal :target
+      t.string :direction
+      t.string :period
+
+      t.timestamps
+    end
+  end
+end

data/lib/luck_remover/engine.rb

@@ -0,0 +1,5 @@
+module LuckRemover
+  class Engine < ::Rails::Engine
+    isolate_namespace LuckRemover
+  end
+end

data/lib/luck_remover/metric_registry.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module LuckRemover
+  class DuplicateMetricError < StandardError; end
+
+  class MetricRegistry
+    def initialize
+      @stats = {}
+    end
+
+    def register(stat)
+      key = stat.key.to_sym
+      raise DuplicateMetricError, "A goal metric is already registered under #{key}" if registered?(key)
+
+      @stats[key] = stat
+    end
+
+    def registered?(key)
+      @stats.key?(key.to_sym)
+    end
+
+    def fetch(key)
+      @stats.fetch(key.to_sym)
+    end
+  end
+end

data/lib/luck_remover/version.rb

@@ -0,0 +1,3 @@
+module LuckRemover
+  VERSION = "0.1.0"
+end

data/lib/luck_remover.rb

@@ -0,0 +1,22 @@
+require "readout"
+require "luck_remover/version"
+require "luck_remover/engine"
+require "luck_remover/metric_registry"
+
+module LuckRemover
+  def self.metrics
+    @metrics ||= MetricRegistry.new
+  end
+
+  def self.register_metric(stat)
+    metrics.register(stat)
+  end
+
+  def self.metric(key)
+    metrics.fetch(key)
+  end
+
+  def self.reset_metrics!
+    @metrics = MetricRegistry.new
+  end
+end

data/lib/tasks/luck_remover_tasks.rake

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

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: luck_remover
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Schneider
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: readout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: cs133
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: LuckRemover stores goals that name a registered readout Stat, a target,
+  a direction and a period, and reports whether the current period met each one.
+email:
+- tylercschneider@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/luck_remover/application.css
+- app/controllers/luck_remover/application_controller.rb
+- app/helpers/luck_remover/application_helper.rb
+- app/jobs/luck_remover/application_job.rb
+- app/mailers/luck_remover/application_mailer.rb
+- app/models/luck_remover/application_record.rb
+- app/models/luck_remover/goal.rb
+- app/models/luck_remover/standing.rb
+- app/views/layouts/luck_remover/application.html.erb
+- config/routes.rb
+- db/migrate/20261022212722_create_luck_remover_goals.rb
+- lib/luck_remover.rb
+- lib/luck_remover/engine.rb
+- lib/luck_remover/metric_registry.rb
+- lib/luck_remover/version.rb
+- lib/tasks/luck_remover_tasks.rake
+homepage: https://github.com/DYB-Development/luck_remover
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DYB-Development/luck_remover
+  source_code_uri: https://github.com/DYB-Development/luck_remover
+  changelog_uri: https://github.com/DYB-Development/luck_remover/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: A Rails engine for goals set against an app's own metrics.
+test_files: []