Suspenders 3.0.0

.github/workflows/main.yml

@@ -1,55 +1,35 @@
 name: CI
 
 on:
-  workflow_dispatch:
   push:
     branches:
       - main
+
   pull_request:
-    paths-ignore:
-      - 'docs/**'
-      - '**.md'
 
 jobs:
-  test:
-
+  lint:
     runs-on: ubuntu-latest
 
-    services:
-      postgres:
-        image: postgres
-        env:
-          POSTGRES_USER: postgres
-          POSTGRES_PASSWORD: postgres
-        ports:
-          - 5432:5432
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+
+    - name: Lint
+      run: bin/rails standard
+
+  test:
+    runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Set git configuration
-        run: |
-          git config --global init.defaultBranch main
-          git config --global user.name 'GitHub Actions'
-          git config --global user.email 'microsoft@example.com'
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: false
-
-      - name: Install dependencies
-        run: bundle install
-
-      - name: Run tests
-        run: bin/rake
-        env:
-          DATABASE_URL: "postgresql://postgres:postgres@localhost:5432/dummy_app_test"
-          DEBUG: 1
-          SPEC_OPTS: "--no-color -f d"
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+
+    - name: Run tests
+      run: bin/rails test

.gitignore

@@ -1,5 +1,10 @@
-*.gem
-*.swp
-Gemfile.lock
-/.bundle
-/tmp
+/.bundle/
+/doc/
+/log/*.log
+/pkg/
+/tmp/
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-*
+/test/dummy/log/*.log
+/test/dummy/storage/
+/test/dummy/tmp/

.ruby-version

@@ -1 +1 @@
-3.2.2
+3.3.0

CONTRIBUTING.md

@@ -1,59 +1,70 @@
 # Contributing
 
-We love pull requests from everyone. By participating in this project, you
-agree to abide by the thoughtbot [code of conduct].
+We love contributions from everyone.
+By participating in this project,
+you agree to abide by the thoughtbot [code of conduct].
 
-[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
+  [code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
 
-Fork the repo:
+We expect everyone to follow the code of conduct
+anywhere in thoughtbot's project codebases,
+issue trackers, chatrooms, and mailing lists.
 
-    git clone git@github.com:thoughtbot/suspenders.git
+## Contributing Code
 
-Set up your machine:
+Fork the repo.
 
-    ./bin/setup
+Run the setup script.
 
-Make sure the tests pass:
+```
+./bin/setup
+```
 
-    rake
+Make sure the tests pass:
 
-Make your change. Write tests. Follow our [style guide][style]. Make the tests
-pass:
+```
+bin/rails test
+```
 
-[style]: https://github.com/thoughtbot/guides/blob/main/ruby/README.md
+Make sure there are no linting violations:
 
-    rake
+```
+bin/rails standard
+```
 
-Mention how your changes affect the project to other developers and users in
-the `NEWS.md` file.
+Make your change, with new passing tests.
 
-Write a [good commit message][commit].
-Push to your fork.
-[Submit a pull request][pr].
+Mention how your changes affect the project to other developers and users in the
+`NEWS.md` file.
 
-[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
-[pr]: https://github.com/thoughtbot/suspenders/compare/
+Push to your fork. Write a [good commit message][commit]. Submit a pull request.
 
-If [Hound] catches style violations, fix them.
+  [commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
 
-[hound]: https://houndci.com
+Others will give constructive feedback.
+This is a time for discussion and improvements,
+and making the necessary changes will be required before we can
+merge the contribution.
 
-Wait for us. We try to at least comment on pull requests within one business
-day. We may suggest changes.
+## Testing Generators
 
-## Generators
+There is a smaller dummy application at `test/dummy`. This application is used
+as a mounting point for the engine, to make testing the engine extremely simple.
 
-All new contributions must be within the generator framework, as described in
-[our goals](GOALS.md).
+There are a number of [assertions][] and [helpers][] that make testing
+generators easier.
 
-## Versions
+[assertions]: https://api.rubyonrails.org/classes/Rails/Generators/Testing/Assertions.html
+[helpers]: https://api.rubyonrails.org/classes/Rails/Generators/Testing/Behavior.html
 
-To update the Ruby version, change `.ruby-version`.
+## Publishing to RubyGems
 
-If you see this error while running tests:
+When the gem is ready to be shared as a formal release, it can be
+[published][published] to RubyGems.
 
-```
-Your Ruby version is XXX, but your Gemfile specified YYY (Bundler::RubyVersionMismatch)
-```
+  [published]: https://guides.rubyonrails.org/plugins.html#publishing-your-gem
 
-Try removing the `tmp/` directory and re-running the tests.
+1. Bump the version number in `Suspenders::VERSION`
+2. Run `bundle exec rake build`
+3. Run `bundle exec rake install`
+4. Run `bundle exec rake release`