orthoses-audited 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56165b93e88edf59b260e62f2e61dd57c0281b9f44a05df4514b06e207c1fd8e
+  data.tar.gz: 7f96f86474a86c5feab8c5db1a554f20349bda706a6df93b40c13a1b5b601d4d
+SHA512:
+  metadata.gz: f25624d44dc7e3b429b9d2d07a3a0d3a41ed0e92c408f81a3b81a87706d45ccf222ff10c971dcd20aed54c491a134d8fb3e9d120d04d9c988ed210ab1606d2d3
+  data.tar.gz: b45c6d773b50c16e708b89acbd06ed15949684dcc4ccc3a8079e3422273f31091316a50b0ba025bd187c0086bcea29233d8be12025b888389e8f3c2f8205f7a3

data/.github/workflows/main.yml

@@ -0,0 +1,33 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.2'
+          - '3.3'
+          - '3.4'
+          - '4.0'
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+      - name: Remove Gemfile.lock for CI
+        run: rm Gemfile.lock
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@8a836efbcebe5de0fe86b48a775b7a31b5c70c93 # v1.277.0
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run the default task
+        run: |
+          bundle exec rbs collection update
+          bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-12-30
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"orthoses-audited" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["yakiyaki_ikayaki@yahoo.co.jp"](mailto:"yakiyaki_ikayaki@yahoo.co.jp").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 masatoshi_moritsuka
+
+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,52 @@
+# Orthoses::Audited
+
+[Orthoses](https://github.com/ksss/orthoses) extension for [Audited](https://github.com/collectiveidea/audited).
+Orthoses::Audited automatically generates RBS for methods added by Audited.
+
+```rb
+User.first!.revisions #=> Array[User]
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add orthoses-audited
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install orthoses-audited
+```
+
+## Usage
+
+audited depends on rails.
+orthoses-audited is strongly recommended to use with [orthoses-rails](https://github.com/ksss/orthoses-rails).
+
+```rb
+use Orthoses::Audited
+use Orthoses::Audited, audit_class: 'CustomAudit'
+```
+
+- `audit_class` is optional. You can specify custom `Audit` model. Default is `Audited::Audit`.
+
+## 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.
+
+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/sanfrecce-osaka/orthoses-audited. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sanfrecce-osaka/orthoses-audited/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Orthoses::Audited project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sanfrecce-osaka/orthoses-audited/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/Steepfile

@@ -0,0 +1,7 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature 'sig'
+  check 'lib'
+  configure_code_diagnostics(D::Ruby.strict)
+end

data/lib/orthoses/audited/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Orthoses
+  class Audited
+    VERSION = '0.1.0'
+  end
+end

data/lib/orthoses/audited.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'orthoses'
+require_relative 'audited/version'
+
+module Orthoses
+  class Audited
+    def initialize(loader, audit_class: 'Audited::Audit')
+      @loader = loader
+      @audit_class = audit_class
+    end
+
+    def call
+      include = CallTracer::Lazy.new
+      store = include.trace('Audited::Auditor::ClassMethods#audited') do
+        @loader.call
+      end
+
+      include.captures.each do |capture|
+        base_name = Utils.module_name(capture.method.receiver) or next
+        sig = 'extend Audited::Auditor::ClassMethods'
+        if !store['ActiveRecord::Base'].body.include?(sig)
+          store['ActiveRecord::Base'] << sig
+        end
+        store[base_name] << 'extend Audited::Auditor::AuditedClassMethods'
+        store[base_name] << "include Audited::Auditor::AuditedInstanceMethods[#{base_name}, #{@audit_class}, #{@audit_class}::ActiveRecord_Relation]"
+        store[base_name] << 'attr_accessor audit_version: Integer?'
+        store[base_name] << 'attr_accessor audit_comment: String?'
+        store["#{base_name}::ActiveRecord_Relation"] << 'include Audited::Auditor::AuditedClassMethods'
+        store["#{base_name}::ActiveRecord_Associations_CollectionProxy"] << 'include Audited::Auditor::AuditedClassMethods'
+      end
+      store
+    end
+  end
+end

data/rbs_collection.lock.yaml

@@ -0,0 +1,336 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: actionpack
+  version: '7.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: actionview
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activemodel
+  version: '7.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activerecord
+  version: '8.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activesupport
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: audited
+  version: '5.8'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: base64
+  version: 0.3.0
+  source:
+    type: rubygems
+- name: bigdecimal
+  version: '4.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: cgi
+  version: '0.5'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: connection_pool
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: csv
+  version: '3.3'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: delegate
+  version: '0'
+  source:
+    type: stdlib
+- name: diff-lcs
+  version: '1.5'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: digest
+  version: '0'
+  source:
+    type: stdlib
+- name: erb
+  version: '0'
+  source:
+    type: stdlib
+- name: ffi
+  version: 1.17.3
+  source:
+    type: rubygems
+- name: fileutils
+  version: '0'
+  source:
+    type: stdlib
+- name: forwardable
+  version: '0'
+  source:
+    type: stdlib
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: io-console
+  version: '0'
+  source:
+    type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: listen
+  version: '3.9'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: minitest
+  version: '5.25'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: 0.3.0
+  source:
+    type: rubygems
+- name: nokogiri
+  version: '1.11'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: openssl
+  version: '0'
+  source:
+    type: stdlib
+- name: optparse
+  version: '0'
+  source:
+    type: stdlib
+- name: orthoses
+  version: 1.20.2
+  source:
+    type: rubygems
+- name: parser
+  version: '3.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: pp
+  version: '0'
+  source:
+    type: stdlib
+- name: prettyprint
+  version: '0'
+  source:
+    type: stdlib
+- name: prism
+  version: 1.7.0
+  source:
+    type: rubygems
+- name: rack
+  version: '2.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rails-dom-testing
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rails-html-sanitizer
+  version: '1.6'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: railties
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rake
+  version: '13.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rbs
+  version: 3.10.0
+  source:
+    type: rubygems
+- name: rdoc
+  version: '0'
+  source:
+    type: stdlib
+- name: securerandom
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: socket
+  version: '0'
+  source:
+    type: stdlib
+- name: stringio
+  version: '0'
+  source:
+    type: stdlib
+- name: strscan
+  version: '0'
+  source:
+    type: stdlib
+- name: tempfile
+  version: '0'
+  source:
+    type: stdlib
+- name: thor
+  version: '1.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: tzinfo
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f2826d40140e8d87f43a44375bb277ba7b7b2e19
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,19 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+# gems:
+#   # If you want to avoid installing rbs files for gems, you can specify them here.
+#   - name: GEM_NAME
+#     ignore: true

data/sig/orthoses/audited.rbs

@@ -0,0 +1,16 @@
+module Orthoses
+  class Audited
+    interface _Loader
+      def call: () -> Store
+    end
+
+    VERSION: String
+
+    @loader: _Loader
+    @audit_class: String
+
+    def initialize: (_Loader loader, ?audit_class: String) -> void
+
+    def call: () -> Store
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: orthoses-audited
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- masatoshi_moritsuka
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: audited
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: orthoses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Orthoses middleware audited
+email:
+- yakiyaki_ikayaki@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- lib/orthoses/audited.rb
+- lib/orthoses/audited/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- sig/orthoses/audited.rbs
+homepage: https://github.com/sanfrecce-osaka/orthoses-audited
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sanfrecce-osaka/orthoses-audited
+  source_code_uri: https://github.com/sanfrecce-osaka/orthoses-audited
+  changelog_uri: https://github.com/sanfrecce-osaka/orthoses-audited
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Orthoses middleware for audited
+test_files: []