type_balancer_rails 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b638243aa1d2aa29637bf2696d7ce7e8625bed13c17bb73122ddb0d9f1356e6a
-  data.tar.gz: 4ac1aa33b569d4da75786e0a8a14ae35a5c2fb20fd3d86cdb1637ef630719809
+  metadata.gz: 57e73c24c2f2b4fab4f8cf8588cfe74a2be42f2392ff39195f7cb2021d8640f7
+  data.tar.gz: 2268520c561f4747aa76fd9913f8b33e05ba629ae7829a8bd863a2c58107c1e5
 SHA512:
-  metadata.gz: 7fd6d6bcd22be7a11c2bd9d5181253c31f0df27966d7c4a68258c3a7e9b6690a42c4e7e4320d2ed543c4155caf2ae7a79e361202bf37661f2f6f6282f98ff29f
-  data.tar.gz: 22503105265aa58554a3e839d431ca3e4ac8d15f39c2b90a3099175cdd383bbdf4deb0982c97886a50ea6da71057258e308e8e4467ced627980c689dfd205f85
+  metadata.gz: 7c8d71e437fc6ed17b3549581397e890b1d8e6ba0eb69161d9760d739dd0c32ba44765db7f7e2b215db6d96a59273064801bc8a0eea8f88f268745eb34c2f30a
+  data.tar.gz: db58f0c79fd64b464d5756e8636abcc6c79c4c7efdc1466ac7ea3578a0a498ede362eefd589779683fbb22488cf9dea5ec3759ac302b0024f0c8e1bd8dfba590

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--format documentation
+--exclude-pattern 'example/spec/**/*' 

data/.rubocop.yml

@@ -1,9 +1,11 @@
-require:
-  - rubocop-rspec
+plugins:
   - rubocop-rails
   - rubocop-capybara
   - rubocop-factory_bot
 
+require:
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 3.2
   NewCops: enable
@@ -17,6 +19,7 @@ AllCops:
     - 'db/schema.rb'
     - 'db/migrate/*.rb'
     - 'Gemfile.lock'
+    - 'example/**/*'
 
 Style/Documentation:
   Enabled: false
@@ -75,6 +78,9 @@ RSpec/SubjectStub:
 RSpec/StubbedMock:
   Enabled: false
 
+RSpec/ReceiveMessages:
+  Enabled: false
+
 RSpec/DescribeClass:
   Exclude:
     - 'spec/integration/**/*_spec.rb'
@@ -118,27 +124,6 @@ FactoryBot/FactoryNameStyle:
 FactoryBot/SyntaxMethods:
   Enabled: false
 
-RSpecRails/AvoidSetupHook:
-  Enabled: false
-
-RSpecRails/HaveHttpStatus:
-  Enabled: false
-
-RSpecRails/HttpStatus:
-  Enabled: false
-
-RSpecRails/InferredSpecType:
-  Enabled: false
-
-RSpecRails/MinitestAssertions:
-  Enabled: false
-
-RSpecRails/NegationBeValid:
-  Enabled: false
-
-RSpecRails/TravelAround:
-  Enabled: false
-
 Layout/LineLength:
   Max: 120
 

data/CHANGELOG.md

@@ -1,12 +1,24 @@
 ## [Unreleased]
 
-## [0.2.0] - 2024-04-27
+## [0.2.3] - 2025-04-29
+
+- Fixed issue with returning correctly balance items
+- Fixed RuboCop configuration and addressed violations
+- Reorganized CI workflow to properly handle example app tests as integration suite
+- Improved test organization and coverage
+- Added proper RuboCop configuration for example app with inheritance handling
+
+## [0.2.2] - 2025-04-27
+
+- Version sync release: Ensures the gem version and git tag match after a previous mismatch (v0.2.1 tag pointed to v0.2.0 code). No code changes from 0.2.1.
+
+## [0.2.0] - 2025-04-27
 
 - Refactored `balance_by_type` to only send `id` and type field to TypeBalancer for efficiency and clarity
 - Ensured robust ordering of returned records based on balanced ids (supports flat and nested balancer output)
 - Full TDD coverage for all new and refactored logic (unit and integration tests)
 - Added GitHub Actions workflow for automated gem releases on tag push
 
-## [0.1.0] - 2025-04-10
+## [0.1.0] - 2025-04-26
 
 - Initial release

data/README.md

@@ -28,6 +28,17 @@ $ gem install type_balancer_rails
 
 ## Usage
 
+To balance records by a given type field, use the following syntax:
+
+```ruby
+Post.balance_by_type(type_field: :media_type)
+Content.balance_by_type(type_field: :category)
+```
+
+> **Note:** Passing a symbol directly (e.g., `balance_by_type(:media_type)`) is not currently supported. Always use the options hash syntax as shown above.
+
+> **Note:** Type field values are automatically converted to strings, so you don't need to handle string conversion manually. For example, both `:article` and `"article"` as type values will work correctly.
+
 ### Basic Usage
 
 The gem adds a `balance_by_type` method to your ActiveRecord relations. Here's how to use it:
@@ -71,6 +82,10 @@ The `balance_by_type` method preserves the ActiveRecord query interface:
              .per(20)
 ```
 
+## Planned Enhancements
+
+- Support for passing a symbol directly to `balance_by_type`, e.g., `balance_by_type(:media_type)`, for more ergonomic usage. This is planned for a future version.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/example/.dockerignore

@@ -0,0 +1,51 @@
+# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files.
+
+# Ignore git directory.
+/.git/
+/.gitignore
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all environment files.
+/.env*
+
+# Ignore all default key files.
+/config/master.key
+/config/credentials/*.key
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/.keep
+
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/.keep
+
+# Ignore assets.
+/node_modules/
+/app/assets/builds/*
+!/app/assets/builds/.keep
+/public/assets
+
+# Ignore CI service files.
+/.github
+
+# Ignore Kamal files.
+/config/deploy*.yml
+/.kamal
+
+# Ignore development files
+/.devcontainer
+
+# Ignore Docker-related files
+/.dockerignore
+/Dockerfile*

data/example/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/example/.rubocop.yml

@@ -0,0 +1,132 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+inherit_mode:
+  override:
+    - Exclude
+    - Include
+
+plugins:
+  - rubocop-capybara
+  - rubocop-factory_bot
+
+require:
+  - rubocop-rspec
+
+# Overwrite or add rules to create your own house style
+#
+# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
+# Layout/SpaceInsideArrayLiteralBrackets:
+#   Enabled: false
+
+AllCops:
+  NewCops: enable
+  Include:
+    - '**/*.rb'
+    - '**/*.rake'
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'log/**/*'
+    - 'node_modules/**/*'
+
+RSpec/IncludeExamples:
+  Enabled: true
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/NoExpectationExample:
+  Enabled: false
+
+RSpec/SubjectStub:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/integration/**/*_spec.rb'
+
+RSpec/RepeatedExample:
+  Enabled: false
+
+RSpec/MultipleDescribes:
+  Enabled: false
+
+RSpec/RepeatedExampleGroupDescription:
+  Enabled: false
+
+Capybara/FindAllFirst:
+  Enabled: true
+
+Capybara/MatchStyle:
+  Enabled: true
+
+Capybara/NegationMatcher:
+  Enabled: true
+
+Capybara/NegationMatcherAfterVisit:
+  Enabled: true
+
+Capybara/RedundantWithinFind:
+  Enabled: true
+
+Capybara/SpecificActions:
+  Enabled: true
+
+Capybara/SpecificFinders:
+  Enabled: true
+
+Capybara/SpecificMatcher:
+  Enabled: true
+
+Capybara/RSpec/HaveSelector:
+  Enabled: true
+
+FactoryBot/AssociationStyle:
+  Enabled: true
+
+FactoryBot/ConsistentParenthesesStyle:
+  Enabled: true
+
+FactoryBot/ExcessiveCreateList:
+  Enabled: true
+
+FactoryBot/FactoryAssociationWithStrategy:
+  Enabled: true
+
+FactoryBot/FactoryNameStyle:
+  Enabled: true
+
+FactoryBot/IdSequence:
+  Enabled: true
+
+FactoryBot/RedundantFactoryOption:
+  Enabled: true
+
+FactoryBot/SyntaxMethods:
+  Enabled: true

data/example/Dockerfile

@@ -0,0 +1,72 @@
+# syntax=docker/dockerfile:1
+# check=error=true
+
+# This Dockerfile is designed for production, not development. Use with Kamal or build'n'run by hand:
+# docker build -t example .
+# docker run -d -p 80:80 -e RAILS_MASTER_KEY=<value from config/master.key> --name example example
+
+# For a containerized dev environment, see Dev Containers: https://guides.rubyonrails.org/getting_started_with_devcontainer.html
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
+ARG RUBY_VERSION=3.2.5
+FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base
+
+# Rails app lives here
+WORKDIR /rails
+
+# Install base packages
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y curl libjemalloc2 libvips sqlite3 && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development"
+
+# Throw-away build stage to reduce size of final image
+FROM base AS build
+
+# Install packages needed to build gems
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential git libyaml-dev pkg-config && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Install application gems
+COPY Gemfile Gemfile.lock ./
+RUN bundle install && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
+    bundle exec bootsnap precompile --gemfile
+
+# Copy application code
+COPY . .
+
+# Precompile bootsnap code for faster boot times
+RUN bundle exec bootsnap precompile app/ lib/
+
+# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+
+
+
+
+# Final stage for app image
+FROM base
+
+# Copy built artifacts: gems, application
+COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
+COPY --from=build /rails /rails
+
+# Run and own only the runtime files as a non-root user for security
+RUN groupadd --system --gid 1000 rails && \
+    useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash && \
+    chown -R rails:rails db log storage tmp
+USER 1000:1000
+
+# Entrypoint prepares the database.
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+# Start server via Thruster by default, this can be overwritten at runtime
+EXPOSE 80
+CMD ["./bin/thrust", "./bin/rails", "server"]

data/example/Gemfile

@@ -0,0 +1,77 @@
+source "https://rubygems.org"
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 8.0.2"
+# The modern asset pipeline for Rails [https://github.com/rails/propshaft]
+gem "propshaft"
+# Use sqlite3 as the database for Active Record
+gem "sqlite3", ">= 2.1"
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", ">= 5.0"
+# Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails]
+gem "importmap-rails"
+# Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev]
+gem "turbo-rails"
+# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
+gem "stimulus-rails"
+# Build JSON APIs with ease [https://github.com/rails/jbuilder]
+gem "jbuilder"
+
+# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
+# gem "bcrypt", "~> 3.1.7"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ windows jruby ]
+
+# Use the database-backed adapters for Rails.cache, Active Job, and Action Cable
+gem "solid_cache"
+gem "solid_queue"
+gem "solid_cable"
+
+# Reduces boot times through caching; required in config/boot.rb
+gem "bootsnap", require: false
+
+# Deploy this application anywhere as a Docker container [https://kamal-deploy.org]
+gem "kamal", require: false
+
+# Add HTTP asset caching/compression and X-Sendfile acceleration to Puma [https://github.com/basecamp/thruster/]
+gem "thruster", require: false
+
+# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
+# gem "image_processing", "~> 1.2"
+
+group :development, :test do
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri windows ], require: "debug/prelude"
+
+  # Static analysis for security vulnerabilities [https://brakemanscanner.org/]
+  gem "brakeman", require: false
+
+  gem "pry"
+
+  # Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/]
+  gem "rubocop-rails-omakase", require: false
+
+  gem 'type_balancer_rails', path: '..'
+end
+
+group :development do
+  # Use console on exceptions pages [https://github.com/rails/web-console]
+  gem "web-console"
+end
+
+gem "rspec-rails", "~> 7.1", :groups => [:development, :test]
+
+gem "database_cleaner-active_record", "~> 2.2", :group => :test
+
+group :test do
+  gem 'rails-controller-testing'
+  gem 'capybara'
+  gem 'launchy'
+end
+
+gem "rubocop-rspec", "~> 3.6", :groups => [:development, :test]
+
+gem "rubocop-capybara", "~> 2.22", :groups => [:development, :test]
+
+gem "rubocop-factory_bot", "~> 2.27", :groups => [:development, :test]