stat_power 0.1.0.alpha.2 → 0.1.0.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1c655045d40fab84f807e1092e00ab08829ff0d9066f1081c14e9a75d411d52
-  data.tar.gz: bd2eff9c48b33c0512ce887eb704b674c2a6b8f511b65733a6c230de82f7617a
+  metadata.gz: 2c69ef6117ff1e0bf73f795f855383722810e4e0153d33fe65e5baf803c6554b
+  data.tar.gz: 68e88eb27fff0e23651c8ae4f9a954eb14718703287b9aaf596b251dd0d742af
 SHA512:
-  metadata.gz: 1f941dc407c89a7f931511b9355a0495924d0edaf09c6b599190fa39a80668224330513072c1f7cfd2f7b05dbb39d01a0bd405ef1fe1d6a7132aaf06b57cc3d7
-  data.tar.gz: eddde39e8855abf2e9df24160968f28b8ba52884b6d4d3bcf954bd0c1231740ee99e7d67007ff05f50b15b6a80728ff8a41abc2b948a38e97c6b4519bff69a06
+  metadata.gz: d8882a7378d4e07735877624fdb21ac512b9e54f5bb42a0342374fcd18e922e85b36710fe9e05fcf92a8b2a5abea3711198bc3df678a7d5796735581bfa9b108
+  data.tar.gz: b5f799b202dc11cc3a7b0290a2d90ff1061771f43cc021e7626e6c256213ff95a8a597f09f5034ec9b1e7f9b070aef0ef8f940fec7734b52263f589349ac86d8

data/CHANGELOG.md

@@ -4,6 +4,42 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## 0.1.0.alpha.3 - 2026-09-20
+
+### Added
+
+- Contribution guide, code of conduct, and security policy
+- Issue templates, including a dedicated numerical-discrepancy report
+- Pull request template requiring independent numerical validation
+- `CODEOWNERS` and Dependabot configuration for Bundler and GitHub Actions
+- CodeQL analysis workflow
+- `bin/setup` and `bin/console` developer scripts
+- `rake verify` task running every check that CI runs
+- Steep type checking of `lib/` against `sig/`, now enforced in CI
+- SimpleCov line and branch coverage with an enforced minimum
+- `.gitattributes`, `.editorconfig`, and `.ruby-version` for reproducible
+  formatting and tooling across platforms
+
+### Changed
+
+- CI now runs lint, type check, and coverage as dedicated jobs, declares
+  least-privilege permissions, and cancels superseded runs
+- RuboCop runs with `NewCops: enable`
+- Gem metadata now includes a contact address, bug tracker, and versioned
+  source URI; maintainer-only files are no longer packaged
+
+### Fixed
+
+- **`sig/stat_power.rbs` shipped in 0.1.0.alpha.2 was not valid RBS.** The
+  block signature for `PowerCurve.generate` used an unparenthesized union
+  return type, so any consumer feeding the packaged signatures to `rbs` or
+  Steep hit a parse error at line 282. Runtime behaviour was unaffected;
+  0.1.0.alpha.1 was not affected, because it predates `PowerCurve`. `rbs
+  validate` accepts the malformed form, which is why it reached a release;
+  `steep check` now runs in CI and in the release gate.
+- `EffectSize::ChiSquare.association` computed column marginals by mutating an
+  accumulator array; it now uses `transpose`
+
 ## 0.1.0.alpha.2 - 2026-09-20
 
 ### Added

data/README.md

@@ -1,5 +1,11 @@
 # stat_power
 
+[![CI](https://github.com/DiogoRibeiro7/stat_power/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/DiogoRibeiro7/stat_power/actions/workflows/ci.yml)
+[![RubyGems](https://img.shields.io/gem/v/stat_power?include_prereleases)](https://rubygems.org/gems/stat_power)
+[![Gem Downloads](https://img.shields.io/gem/dt/stat_power)](https://rubygems.org/gems/stat_power)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.2-CC342D?logo=ruby&logoColor=white)](https://www.ruby-lang.org/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
 Native Ruby statistical power analysis and sample-size determination.
 
 > **Alpha release:** `stat_power` is under active development. The public API
@@ -17,13 +23,13 @@ gem install stat_power --prerelease
 or pin the exact alpha:
 
 ```bash
-gem install stat_power -v 0.1.0.alpha.2
+gem install stat_power -v 0.1.0.alpha.3
 ```
 
 With Bundler:
 
 ```ruby
-gem "stat_power", "0.1.0.alpha.2"
+gem "stat_power", "0.1.0.alpha.3"
 ```
 
 ## Status
@@ -112,29 +118,39 @@ freeze candidate.
 
 ## Development
 
-Install dependencies:
+Set up the checkout:
 
 ```bash
-bundle install
+bin/setup
 ```
 
-Run the test suite:
+Open a console with the library loaded:
 
 ```bash
-bundle exec rspec
+bin/console
 ```
 
-Run lint and signature validation:
+Run everything CI runs:
 
 ```bash
-bundle exec rubocop
-bundle exec rbs validate
+bundle exec rake verify
 ```
 
-Validate that the library loads:
+That is the same as running each check individually:
 
 ```bash
-ruby -Ilib -e 'require "stat_power"'
+bundle exec rspec          # specs
+bundle exec rubocop        # lint
+bundle exec rbs validate   # signature syntax
+bundle exec steep check    # lib/ type checked against sig/
+```
+
+Measure test coverage. Instrumentation roughly doubles the runtime, so it is
+opt-in; CI enforces a minimum in a dedicated job.
+
+```bash
+COVERAGE=1 bundle exec rspec
+open coverage/index.html
 ```
 
 Build the gem locally:
@@ -143,6 +159,29 @@ Build the gem locally:
 gem build stat_power.gemspec
 ```
 
+## Contributing
+
+Contributions are welcome. Because this is a numerical library, the bar is
+reproducibility: every statistical result must be justified by a published
+formula or an independently generated reference value.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the workflow, the shape a new
+power-analysis family is expected to take, and how to supply reference values.
+
+Participation is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+### Found a wrong number?
+
+If `stat_power` disagrees with `pwr`, R, G*Power or a textbook, that is the
+highest-priority class of bug here. Open an issue using the **Numerical
+discrepancy** template.
+
+## Security
+
+See [SECURITY.md](SECURITY.md) for supported versions and how to report a
+vulnerability privately. A numerically incorrect result is a bug, not a
+vulnerability; report those as ordinary issues.
+
 ## Mathematical conventions
 
 See [docs/mathematical_conventions.md](docs/mathematical_conventions.md).

data/lib/stat_power/distributions/noncentral_chi_square.rb

@@ -98,7 +98,7 @@ module StatPower
           break if mixture_converged?(weight_sum, lower_weight, upper_weight)
         end
 
-        [[total, 0.0].max, 1.0].min
+        total.clamp(0.0, 1.0)
       end
       private_class_method :poisson_mixture
 

data/lib/stat_power/distributions/noncentral_f.rb

@@ -110,7 +110,7 @@ module StatPower
           break if mixture_converged?(weight_sum, lower_weight, upper_weight)
         end
 
-        [[total, 0.0].max, 1.0].min
+        total.clamp(0.0, 1.0)
       end
       private_class_method :poisson_beta_mixture
 

data/lib/stat_power/distributions/noncentral_t.rb

@@ -48,7 +48,7 @@ module StatPower
           )
         end
 
-        [[result, 0.0].max, 1.0].min
+        result.clamp(0.0, 1.0)
       end
 
       # Survival function P(T > x).

data/lib/stat_power/effect_size/chi_square.rb

@@ -45,14 +45,7 @@ module StatPower
       def association(probabilities:)
         table = probability_table!(probabilities)
         row_totals = table.map(&:sum)
-        column_count = table.first.length
-        column_totals = Array.new(column_count, 0.0)
-
-        table.each do |row|
-          row.each_with_index do |value, column|
-            column_totals[column] += value
-          end
-        end
+        column_totals = table.transpose.map(&:sum)
 
         if row_totals.any?(&:zero?) || column_totals.any?(&:zero?)
           raise StatPower::DomainError,

data/lib/stat_power/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StatPower
-  VERSION = "0.1.0.alpha.2"
+  VERSION = "0.1.0.alpha.3"
 end

data/sig/stat_power.rbs

@@ -279,7 +279,7 @@ module StatPower
   module PowerCurve
     def self.generate: (
       sample_sizes: Enumerable[Numeric]
-    ) { (Float) -> Numeric | PowerResult | UnequalPowerResult | AnovaResult | F2Result | ChiSquareResult } -> Array[PowerCurvePoint]
+    ) { (Float) -> (Numeric | PowerResult | UnequalPowerResult | AnovaResult | F2Result | ChiSquareResult) } -> Array[PowerCurvePoint]
   end
 
   module SpecialFunctions

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stat_power
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.2
+  version: 0.1.0.alpha.3
 platform: ruby
 authors:
 - Diogo Ribeiro
@@ -13,6 +13,7 @@ dependencies: []
 description: Native Ruby tools for statistical power analysis, sample-size determination,
   effect-size calculations, and inverse power problems.
 email:
+- dfr@esmad.ipp.pt
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -20,7 +21,6 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
-- RELEASING.md
 - ROADMAP.md
 - docs/mathematical_conventions.md
 - docs/pwr_parity.md
@@ -63,7 +63,9 @@ homepage: https://github.com/DiogoRibeiro7/stat_power
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/DiogoRibeiro7/stat_power
+  homepage_uri: https://github.com/DiogoRibeiro7/stat_power
+  source_code_uri: https://github.com/DiogoRibeiro7/stat_power/tree/v0.1.0.alpha.3
+  bug_tracker_uri: https://github.com/DiogoRibeiro7/stat_power/issues
   changelog_uri: https://github.com/DiogoRibeiro7/stat_power/blob/main/CHANGELOG.md
   documentation_uri: https://github.com/DiogoRibeiro7/stat_power#readme
   rubygems_mfa_required: 'true'
@@ -80,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.4'
 requirements: []
 rubygems_version: 3.5.22
 signing_key:

data/RELEASING.md

@@ -1,113 +0,0 @@
-# Releasing stat_power
-
-This project uses prerelease versions until the public API is ready to stabilize.
-
-## RubyGems trusted publishing
-
-RubyGems Trusted Publishing allows GitHub Actions to publish without storing a
-long-lived RubyGems API key.
-
-The trusted publisher for `stat_power` must match:
-
-- Gem name: `stat_power`
-- Repository owner: `DiogoRibeiro7`
-- Repository name: `stat_power`
-- Workflow filename: `release.yml`
-- Environment: `release`
-
-The workflow is stored at `.github/workflows/release.yml`.
-
-## Alpha release checklist
-
-1. Ensure all CI jobs are green on `main`.
-2. Confirm `lib/stat_power/version.rb` contains the intended version.
-3. Move the release entries in `CHANGELOG.md` out of `Unreleased`.
-4. Build the gem locally:
-
-   ```bash
-   gem build stat_power.gemspec
-   ```
-
-5. Inspect the built package:
-
-   ```bash
-   gem specification stat_power-*.gem name version files --yaml
-   ```
-
-6. Install the built gem into a clean location:
-
-   ```bash
-   GEM_HOME="$(mktemp -d)" gem install stat_power-*.gem --no-document
-   ```
-
-7. Run a smoke test against the installed package:
-
-   ```bash
-   ruby -e 'require "stat_power"; puts StatPower::VERSION'
-   ```
-
-8. Confirm the RubyGems trusted publisher still matches
-   `.github/workflows/release.yml` and the `release` environment.
-
-9. Create and push the release tag. For the current release:
-
-   ```bash
-   VERSION=0.1.0.alpha.2
-   git checkout main
-   git pull --ff-only
-   git tag "v${VERSION}"
-   git push origin "v${VERSION}"
-   ```
-
-Pushing the tag triggers the release workflow. It validates that:
-
-- the tag matches `StatPower::VERSION`
-- the tagged commit is contained in `main`
-- the test suite passes
-- RuboCop passes
-- RBS signatures validate
-- the gem builds successfully
-
-The workflow requests short-lived RubyGems credentials through OIDC, pushes the
-already-built gem artifact with `gem push`, and creates a GitHub Release.
-Prerelease versions are marked as prereleases on GitHub automatically.
-
-## Retrying a failed release
-
-If a release tag already exists but the workflow fails before RubyGems accepts
-the gem, do not create a new version merely to retry the same artifact.
-
-1. Open **Actions → Release gem**.
-2. Choose **Run workflow**.
-3. Enter the existing tag, for example `v0.1.0.alpha.2`.
-4. Run the workflow from `main`.
-
-The manual dispatch checks out the existing tag and publishes that exact
-artifact while using the latest release workflow definition from `main`.
-
-Once a version appears on RubyGems.org, it is immutable and must not be reused.
-
-## After publishing
-
-Verify the public installation path:
-
-```bash
-gem install stat_power --prerelease
-```
-
-Then confirm:
-
-```bash
-ruby -e 'require "stat_power"; puts StatPower::VERSION'
-```
-
-For the current release the expected output is:
-
-```text
-0.1.0.alpha.2
-```
-
-## Failed releases after publication
-
-Once a version exists on RubyGems.org, do not overwrite or reuse that version.
-Increment the prerelease version and create a new tag.