{"id":15432064,"url":"https://github.com/kortirso/commento","last_synced_at":"2026-05-03T19:34:45.799Z","repository":{"id":185379603,"uuid":"673495792","full_name":"kortirso/commento","owner":"kortirso","description":"Commento provides DSL for Ruby on Rails application for working with database comments.","archived":false,"fork":false,"pushed_at":"2024-09-13T09:28:07.000Z","size":55,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-04-28T02:49:14.723Z","etag":null,"topics":["comments","ruby","ruby-on-rails"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kortirso.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-08-01T18:56:47.000Z","updated_at":"2024-09-13T09:27:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"5ad0b012-ee40-456a-b127-6d77374af2be","html_url":"https://github.com/kortirso/commento","commit_stats":{"total_commits":16,"total_committers":1,"mean_commits":16.0,"dds":0.0,"last_synced_commit":"3ac8c0f670c4fb90bd09853b6909a9ef86fed9fc"},"previous_names":["kortirso/commento"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/kortirso/commento","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kortirso%2Fcommento","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kortirso%2Fcommento/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kortirso%2Fcommento/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kortirso%2Fcommento/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kortirso","download_url":"https://codeload.github.com/kortirso/commento/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kortirso%2Fcommento/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32582840,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["comments","ruby","ruby-on-rails"],"created_at":"2024-10-01T18:25:01.605Z","updated_at":"2026-05-03T19:34:45.783Z","avatar_url":"https://github.com/kortirso.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Commento\n\nCommento provides DSL for Ruby on Rails application for working with database comments.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n```ruby\ngem 'commento'\n```\n\nAnd then execute:\n```bash\n$ bundle install\n```\n\n## Gem configuration\n\n### Initializer\n\nAdd configuration line to config/initializers/commento.rb:\n\n#### ActiveRecord\n\n```ruby\nrequire 'commento/adapters/active_record'\n\nCommento.configure do |config|\n  config.adapter = Commento::Adapters::ActiveRecord.new\n  config.include_folders = %w[app lib] # folder for searching commento comments\n  config.exclude_folders = ['app/assets'] # folder for excluding searching commento comments\n  config.skip_table_names = %w[ar_internal_metadata schema_migrations] # ignoring tables\n  config.skip_column_names = %w[id uuid created_at updated_at] # ignoring columns\nend\n```\n\n## Rake tasks\n\n### Generating reports\n\nYou can generate different types of reports (right now only html) with rake task\n\n```bash\nrails \"commento:generate_report[html]\"\n```\n\n### Health check\n\nYou can check amount of missing comments for tables and columns with console report\n\n```bash\nrails commento:health\n```\n\n\u003cimg width=\"727\" alt=\"Снимок экрана 2024-09-13 в 10 11 12\" src=\"https://github.com/user-attachments/assets/f0b8fbf8-6a6a-4c7b-b6b6-2a0de6d19f45\"\u003e\n\n### Generating migration for adding comments to tables and columns\n\nYou can generate migration with adding comments for table and columns\n\n```bash\nrails g commento:active_record\n```\n\n## Usage\n\nCommento provides helpers for models for setting and getting comments.\n\n### Models configuration\n\nUpdate your application model\n\n```ruby\nclass ApplicationRecord \u003c ActiveRecord::Base\n  include Commento::Helpers\nend\n```\n\n### Set table's comment\n\n```ruby\nUser.set_table_comment('Users table')\n```\n\nor reset comment by skiping value\n```ruby\nUser.set_table_comment\n```\n\n### Read table's comment\n\n```ruby\nUser.fetch_table_comment\n```\n\n### Set column's comment\n\n```ruby\nUser.set_column_comment(:email, 'Required field for user authentication')\n```\n\nor reset comment by skiping value\n```ruby\nUser.set_column_comment(:email)\n```\n\n### Read column's comment\n\n```ruby\nUser.fetch_column_comment(:email)\n```\n\n## License\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkortirso%2Fcommento","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkortirso%2Fcommento","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkortirso%2Fcommento/lists"}