Repository files navigation

Statusable

Gem VersionCI Actions

Statusable adds a has_statuses macro for defining common status-related methods for use with ActiveRecord objects / Relations.

Installation

Add this line to your application's Gemfile:

gem"statusable"

And then execute:

$ bundle

Or install it yourself:

$ gem install statusable

Configuration

First, add a status column to your model. Or pick any other name you may want instead of status... the column name is configurable. (See Advanced Usage.)

# db/migrate/<version>_add_status_to_jobs.rbdefchangeadd_column:jobs,:status,:string,null: false,default: "Initializing"add_index:jobs,:statusend

Next, include Statusable::HasStatuses either into your model or into ApplicationRecord, per your preference.

classJob < ApplicationRecordincludeStatusable::HasStatusesend

Finally, call the has_statuses macro in your model, along with an array of your desired status names. See below for Basic Usage and Advanced Usage.

Basic Usage

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted])end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model.

# The following are equivalent:job=Job.new(status: "Pending")job=Job.new(status: Job.status_pending)job=Job.new;job.set_status_pending# Check current status:job.status_pending?# => truejob.status?("Pending")# => truejob.not_status_running?# => truejob.not_status?("Running")# => true# Set status without saving:job.set_status_running# => #<Job:0x000000012fc3b060 id: nil, status: "Running", created_at: nil, updated_at: nil>job.status_running?# => true# Set status and save:job.set_status_running!# => #<Job:0x000000012fc3b560 id: 1, status: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.status_pending# => "Pending"job.status_pending# => "Pending"Job.status_options# => ["Pending", "Running", "Completed"]job.status_options# => ["Pending", "Running", "Completed"]Job.humanized_statuses_list# => "Pending, Running, or Completed"job.humanized_statuses_list# => "Pending, Running, or Completed"# Named scopes:Job.for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" IN ('Pending', 'Running')Job.not_for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.not_for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" NOT IN ('Pending', 'Running')Job.for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.not_for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.by_status_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status"Job.by_status_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status" DESCJob.group_by_status.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."status"# Validation:# By default, we don't validate on presence, but this can be changed.# See the Advanced Usage section.job.status=niljob.validate;job.errors[:status]# => []job.status="Invalid Status"job.validate;job.errors[:status]# => ["must be one of Pending, Running, or Completed"]

Advanced Usage

The column name is customizable, as is whether or not to validate on presence or inclusion. Validating on inclusion means: ensuring that the current status value is included in the list of possible status values.

Defaults:

  • col_name = "status"
  • validate_presence = false
  • validate_inclusion = true

Note: Be sure that the column name in your migration matches whatever you choose for col_name, below.

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted],col_name: "lifecycle_state",validate_presence: true,validate_inclusion: true)end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model--the same ones shown in Basic Usage. However, the "status" name varies, and this time we include a presence validation:

# The following are equivalent:job=Job.new;job.set_lifecycle_state_pending# Check current status:job.lifecycle_state_pending?# => truejob.lifecycle_state?("Pending")# => truejob.not_lifecycle_state_running?# => truejob.not_lifecycle_state?("Running")# => true# Set status without saving:job.set_lifecycle_state_running# => #<Job:0x000000012fc3b060 id: nil, lifecycle_state: "Running", created_at: nil, updated_at: nil>job.lifecycle_state_running?# => true# Set status and save:job.set_lifecycle_state_running!# => #<Job:0x000000012fc3b560 id: 1, lifecycle_state: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.lifecycle_state_pending# => "Pending"job.lifecycle_state_pending# => "Pending"Job.lifecycle_state_options# => ["Pending", "Running", "Completed"]job.lifecycle_state_options# => ["Pending", "Running", "Completed"]Job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"# Named scopes:Job.for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" IN ('Pending', 'Running')Job.not_for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.not_for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" NOT IN ('Pending', 'Running')Job.for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.not_for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.by_lifecycle_state_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state"Job.by_lifecycle_state_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state" DESCJob.group_by_lifecycle_state.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."lifecycle_state"# Validation:job.lifecycle_state=niljob.validate;job.errors[:lifecycle_state]# => ["can't be blank"]job.lifecycle_state="Invalid lifecycle_state"job.validate;job.errors[:lifecycle_state]# => ["must be one of Pending, Running, or Completed"]

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/statusable.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. Or, run rake to run the tests plus linters as well as yard (to confirm proper YARD documentation practices). 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.

Testing

To test this gem:

rake

Linters

rubocop
reek
npx prettier . --check
npx prettier . --write

Releases

To release a new version of this gem to RubyGems:

  1. Update the version number in version.rb
  2. Update the release date, etc. in CHANGELOG.md
  3. Run bundle to update Gemfile.lock with the latest version info
  4. Commit the changes. e.g. Bump to vX.Y.Z
  5. Run 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.

License

The gem is available as open source under the terms of the MIT License.

About

Adds a `has_statuses` macro for defining common status-related ActiveRecord / Relation methods.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Repository files navigation

Statusable

Gem VersionCI Actions

Statusable adds a has_statuses macro for defining common status-related methods for use with ActiveRecord objects / Relations.

Installation

Add this line to your application's Gemfile:

gem"statusable"

And then execute:

$ bundle

Or install it yourself:

$ gem install statusable

Configuration

First, add a status column to your model. Or pick any other name you may want instead of status... the column name is configurable. (See Advanced Usage.)

# db/migrate/<version>_add_status_to_jobs.rbdefchangeadd_column:jobs,:status,:string,null: false,default: "Initializing"add_index:jobs,:statusend

Next, include Statusable::HasStatuses either into your model or into ApplicationRecord, per your preference.

classJob < ApplicationRecordincludeStatusable::HasStatusesend

Finally, call the has_statuses macro in your model, along with an array of your desired status names. See below for Basic Usage and Advanced Usage.

Basic Usage

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted])end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model.

# The following are equivalent:job=Job.new(status: "Pending")job=Job.new(status: Job.status_pending)job=Job.new;job.set_status_pending# Check current status:job.status_pending?# => truejob.status?("Pending")# => truejob.not_status_running?# => truejob.not_status?("Running")# => true# Set status without saving:job.set_status_running# => #<Job:0x000000012fc3b060 id: nil, status: "Running", created_at: nil, updated_at: nil>job.status_running?# => true# Set status and save:job.set_status_running!# => #<Job:0x000000012fc3b560 id: 1, status: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.status_pending# => "Pending"job.status_pending# => "Pending"Job.status_options# => ["Pending", "Running", "Completed"]job.status_options# => ["Pending", "Running", "Completed"]Job.humanized_statuses_list# => "Pending, Running, or Completed"job.humanized_statuses_list# => "Pending, Running, or Completed"# Named scopes:Job.for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" IN ('Pending', 'Running')Job.not_for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.not_for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" NOT IN ('Pending', 'Running')Job.for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.not_for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.by_status_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status"Job.by_status_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status" DESCJob.group_by_status.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."status"# Validation:# By default, we don't validate on presence, but this can be changed.# See the Advanced Usage section.job.status=niljob.validate;job.errors[:status]# => []job.status="Invalid Status"job.validate;job.errors[:status]# => ["must be one of Pending, Running, or Completed"]

Advanced Usage

The column name is customizable, as is whether or not to validate on presence or inclusion. Validating on inclusion means: ensuring that the current status value is included in the list of possible status values.

Defaults:

  • col_name = "status"
  • validate_presence = false
  • validate_inclusion = true

Note: Be sure that the column name in your migration matches whatever you choose for col_name, below.

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted],col_name: "lifecycle_state",validate_presence: true,validate_inclusion: true)end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model--the same ones shown in Basic Usage. However, the "status" name varies, and this time we include a presence validation:

# The following are equivalent:job=Job.new;job.set_lifecycle_state_pending# Check current status:job.lifecycle_state_pending?# => truejob.lifecycle_state?("Pending")# => truejob.not_lifecycle_state_running?# => truejob.not_lifecycle_state?("Running")# => true# Set status without saving:job.set_lifecycle_state_running# => #<Job:0x000000012fc3b060 id: nil, lifecycle_state: "Running", created_at: nil, updated_at: nil>job.lifecycle_state_running?# => true# Set status and save:job.set_lifecycle_state_running!# => #<Job:0x000000012fc3b560 id: 1, lifecycle_state: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.lifecycle_state_pending# => "Pending"job.lifecycle_state_pending# => "Pending"Job.lifecycle_state_options# => ["Pending", "Running", "Completed"]job.lifecycle_state_options# => ["Pending", "Running", "Completed"]Job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"# Named scopes:Job.for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" IN ('Pending', 'Running')Job.not_for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.not_for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" NOT IN ('Pending', 'Running')Job.for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.not_for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.by_lifecycle_state_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state"Job.by_lifecycle_state_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state" DESCJob.group_by_lifecycle_state.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."lifecycle_state"# Validation:job.lifecycle_state=niljob.validate;job.errors[:lifecycle_state]# => ["can't be blank"]job.lifecycle_state="Invalid lifecycle_state"job.validate;job.errors[:lifecycle_state]# => ["must be one of Pending, Running, or Completed"]

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/statusable.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. Or, run rake to run the tests plus linters as well as yard (to confirm proper YARD documentation practices). 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.

Testing

To test this gem:

rake

Linters

rubocop
reek
npx prettier . --check
npx prettier . --write

Releases

To release a new version of this gem to RubyGems:

  1. Update the version number in version.rb
  2. Update the release date, etc. in CHANGELOG.md
  3. Run bundle to update Gemfile.lock with the latest version info
  4. Commit the changes. e.g. Bump to vX.Y.Z
  5. Run 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.

License

The gem is available as open source under the terms of the MIT License.

About

Adds a `has_statuses` macro for defining common status-related ActiveRecord / Relation methods.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Statusable

Gem VersionCI Actions

Statusable adds a has_statuses macro for defining common status-related methods for use with ActiveRecord objects / Relations.

Installation

Add this line to your application's Gemfile:

gem"statusable"

And then execute:

$ bundle

Or install it yourself:

$ gem install statusable

Configuration

First, add a status column to your model. Or pick any other name you may want instead of status... the column name is configurable. (See Advanced Usage.)

# db/migrate/<version>_add_status_to_jobs.rbdefchangeadd_column:jobs,:status,:string,null: false,default: "Initializing"add_index:jobs,:statusend

Next, include Statusable::HasStatuses either into your model or into ApplicationRecord, per your preference.

classJob < ApplicationRecordincludeStatusable::HasStatusesend

Finally, call the has_statuses macro in your model, along with an array of your desired status names. See below for Basic Usage and Advanced Usage.

Basic Usage

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted])end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model.

# The following are equivalent:job=Job.new(status: "Pending")job=Job.new(status: Job.status_pending)job=Job.new;job.set_status_pending# Check current status:job.status_pending?# => truejob.status?("Pending")# => truejob.not_status_running?# => truejob.not_status?("Running")# => true# Set status without saving:job.set_status_running# => #<Job:0x000000012fc3b060 id: nil, status: "Running", created_at: nil, updated_at: nil>job.status_running?# => true# Set status and save:job.set_status_running!# => #<Job:0x000000012fc3b560 id: 1, status: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.status_pending# => "Pending"job.status_pending# => "Pending"Job.status_options# => ["Pending", "Running", "Completed"]job.status_options# => ["Pending", "Running", "Completed"]Job.humanized_statuses_list# => "Pending, Running, or Completed"job.humanized_statuses_list# => "Pending, Running, or Completed"# Named scopes:Job.for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" IN ('Pending', 'Running')Job.not_for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.not_for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" NOT IN ('Pending', 'Running')Job.for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.not_for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.by_status_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status"Job.by_status_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status" DESCJob.group_by_status.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."status"# Validation:# By default, we don't validate on presence, but this can be changed.# See the Advanced Usage section.job.status=niljob.validate;job.errors[:status]# => []job.status="Invalid Status"job.validate;job.errors[:status]# => ["must be one of Pending, Running, or Completed"]

Advanced Usage

The column name is customizable, as is whether or not to validate on presence or inclusion. Validating on inclusion means: ensuring that the current status value is included in the list of possible status values.

Defaults:

  • col_name = "status"
  • validate_presence = false
  • validate_inclusion = true

Note: Be sure that the column name in your migration matches whatever you choose for col_name, below.

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted],col_name: "lifecycle_state",validate_presence: true,validate_inclusion: true)end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model--the same ones shown in Basic Usage. However, the "status" name varies, and this time we include a presence validation:

# The following are equivalent:job=Job.new;job.set_lifecycle_state_pending# Check current status:job.lifecycle_state_pending?# => truejob.lifecycle_state?("Pending")# => truejob.not_lifecycle_state_running?# => truejob.not_lifecycle_state?("Running")# => true# Set status without saving:job.set_lifecycle_state_running# => #<Job:0x000000012fc3b060 id: nil, lifecycle_state: "Running", created_at: nil, updated_at: nil>job.lifecycle_state_running?# => true# Set status and save:job.set_lifecycle_state_running!# => #<Job:0x000000012fc3b560 id: 1, lifecycle_state: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.lifecycle_state_pending# => "Pending"job.lifecycle_state_pending# => "Pending"Job.lifecycle_state_options# => ["Pending", "Running", "Completed"]job.lifecycle_state_options# => ["Pending", "Running", "Completed"]Job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"# Named scopes:Job.for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" IN ('Pending', 'Running')Job.not_for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.not_for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" NOT IN ('Pending', 'Running')Job.for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.not_for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.by_lifecycle_state_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state"Job.by_lifecycle_state_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state" DESCJob.group_by_lifecycle_state.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."lifecycle_state"# Validation:job.lifecycle_state=niljob.validate;job.errors[:lifecycle_state]# => ["can't be blank"]job.lifecycle_state="Invalid lifecycle_state"job.validate;job.errors[:lifecycle_state]# => ["must be one of Pending, Running, or Completed"]

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/statusable.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. Or, run rake to run the tests plus linters as well as yard (to confirm proper YARD documentation practices). 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.

Testing

To test this gem:

rake

Linters

rubocop
reek
npx prettier . --check
npx prettier . --write

Releases

To release a new version of this gem to RubyGems:

  1. Update the version number in version.rb
  2. Update the release date, etc. in CHANGELOG.md
  3. Run bundle to update Gemfile.lock with the latest version info
  4. Commit the changes. e.g. Bump to vX.Y.Z
  5. Run 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.

License

The gem is available as open source under the terms of the MIT License.

About

Adds a `has_statuses` macro for defining common status-related ActiveRecord / Relation methods.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Statusable

Gem VersionCI Actions

Statusable adds a has_statuses macro for defining common status-related methods for use with ActiveRecord objects / Relations.

Installation

Add this line to your application's Gemfile:

gem"statusable"

And then execute:

$ bundle

Or install it yourself:

$ gem install statusable

Configuration

First, add a status column to your model. Or pick any other name you may want instead of status... the column name is configurable. (See Advanced Usage.)

# db/migrate/<version>_add_status_to_jobs.rbdefchangeadd_column:jobs,:status,:string,null: false,default: "Initializing"add_index:jobs,:statusend

Next, include Statusable::HasStatuses either into your model or into ApplicationRecord, per your preference.

classJob < ApplicationRecordincludeStatusable::HasStatusesend

Finally, call the has_statuses macro in your model, along with an array of your desired status names. See below for Basic Usage and Advanced Usage.

Basic Usage

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted])end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model.

# The following are equivalent:job=Job.new(status: "Pending")job=Job.new(status: Job.status_pending)job=Job.new;job.set_status_pending# Check current status:job.status_pending?# => truejob.status?("Pending")# => truejob.not_status_running?# => truejob.not_status?("Running")# => true# Set status without saving:job.set_status_running# => #<Job:0x000000012fc3b060 id: nil, status: "Running", created_at: nil, updated_at: nil>job.status_running?# => true# Set status and save:job.set_status_running!# => #<Job:0x000000012fc3b560 id: 1, status: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.status_pending# => "Pending"job.status_pending# => "Pending"Job.status_options# => ["Pending", "Running", "Completed"]job.status_options# => ["Pending", "Running", "Completed"]Job.humanized_statuses_list# => "Pending, Running, or Completed"job.humanized_statuses_list# => "Pending, Running, or Completed"# Named scopes:Job.for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" IN ('Pending', 'Running')Job.not_for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.not_for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" NOT IN ('Pending', 'Running')Job.for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.not_for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.by_status_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status"Job.by_status_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status" DESCJob.group_by_status.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."status"# Validation:# By default, we don't validate on presence, but this can be changed.# See the Advanced Usage section.job.status=niljob.validate;job.errors[:status]# => []job.status="Invalid Status"job.validate;job.errors[:status]# => ["must be one of Pending, Running, or Completed"]

Advanced Usage

The column name is customizable, as is whether or not to validate on presence or inclusion. Validating on inclusion means: ensuring that the current status value is included in the list of possible status values.

Defaults:

  • col_name = "status"
  • validate_presence = false
  • validate_inclusion = true

Note: Be sure that the column name in your migration matches whatever you choose for col_name, below.

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted],col_name: "lifecycle_state",validate_presence: true,validate_inclusion: true)end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model--the same ones shown in Basic Usage. However, the "status" name varies, and this time we include a presence validation:

# The following are equivalent:job=Job.new;job.set_lifecycle_state_pending# Check current status:job.lifecycle_state_pending?# => truejob.lifecycle_state?("Pending")# => truejob.not_lifecycle_state_running?# => truejob.not_lifecycle_state?("Running")# => true# Set status without saving:job.set_lifecycle_state_running# => #<Job:0x000000012fc3b060 id: nil, lifecycle_state: "Running", created_at: nil, updated_at: nil>job.lifecycle_state_running?# => true# Set status and save:job.set_lifecycle_state_running!# => #<Job:0x000000012fc3b560 id: 1, lifecycle_state: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.lifecycle_state_pending# => "Pending"job.lifecycle_state_pending# => "Pending"Job.lifecycle_state_options# => ["Pending", "Running", "Completed"]job.lifecycle_state_options# => ["Pending", "Running", "Completed"]Job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"# Named scopes:Job.for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" IN ('Pending', 'Running')Job.not_for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.not_for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" NOT IN ('Pending', 'Running')Job.for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.not_for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.by_lifecycle_state_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state"Job.by_lifecycle_state_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state" DESCJob.group_by_lifecycle_state.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."lifecycle_state"# Validation:job.lifecycle_state=niljob.validate;job.errors[:lifecycle_state]# => ["can't be blank"]job.lifecycle_state="Invalid lifecycle_state"job.validate;job.errors[:lifecycle_state]# => ["must be one of Pending, Running, or Completed"]

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/statusable.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. Or, run rake to run the tests plus linters as well as yard (to confirm proper YARD documentation practices). 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.

Testing

To test this gem:

rake

Linters

rubocop
reek
npx prettier . --check
npx prettier . --write

Releases

To release a new version of this gem to RubyGems:

  1. Update the version number in version.rb
  2. Update the release date, etc. in CHANGELOG.md
  3. Run bundle to update Gemfile.lock with the latest version info
  4. Commit the changes. e.g. Bump to vX.Y.Z
  5. Run 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.

License

The gem is available as open source under the terms of the MIT License.

About

Adds a `has_statuses` macro for defining common status-related ActiveRecord / Relation methods.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Repository files navigation

Statusable

Gem VersionCI Actions

Statusable adds a has_statuses macro for defining common status-related methods for use with ActiveRecord objects / Relations.

Installation

Add this line to your application's Gemfile:

gem"statusable"

And then execute:

$ bundle

Or install it yourself:

$ gem install statusable

Configuration

First, add a status column to your model. Or pick any other name you may want instead of status... the column name is configurable. (See Advanced Usage.)

# db/migrate/<version>_add_status_to_jobs.rbdefchangeadd_column:jobs,:status,:string,null: false,default: "Initializing"add_index:jobs,:statusend

Next, include Statusable::HasStatuses either into your model or into ApplicationRecord, per your preference.

classJob < ApplicationRecordincludeStatusable::HasStatusesend

Finally, call the has_statuses macro in your model, along with an array of your desired status names. See below for Basic Usage and Advanced Usage.

Basic Usage

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted])end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model.

# The following are equivalent:job=Job.new(status: "Pending")job=Job.new(status: Job.status_pending)job=Job.new;job.set_status_pending# Check current status:job.status_pending?# => truejob.status?("Pending")# => truejob.not_status_running?# => truejob.not_status?("Running")# => true# Set status without saving:job.set_status_running# => #<Job:0x000000012fc3b060 id: nil, status: "Running", created_at: nil, updated_at: nil>job.status_running?# => true# Set status and save:job.set_status_running!# => #<Job:0x000000012fc3b560 id: 1, status: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.status_pending# => "Pending"job.status_pending# => "Pending"Job.status_options# => ["Pending", "Running", "Completed"]job.status_options# => ["Pending", "Running", "Completed"]Job.humanized_statuses_list# => "Pending, Running, or Completed"job.humanized_statuses_list# => "Pending, Running, or Completed"# Named scopes:Job.for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" IN ('Pending', 'Running')Job.not_for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.not_for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" NOT IN ('Pending', 'Running')Job.for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.not_for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.by_status_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status"Job.by_status_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status" DESCJob.group_by_status.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."status"# Validation:# By default, we don't validate on presence, but this can be changed.# See the Advanced Usage section.job.status=niljob.validate;job.errors[:status]# => []job.status="Invalid Status"job.validate;job.errors[:status]# => ["must be one of Pending, Running, or Completed"]

Advanced Usage

The column name is customizable, as is whether or not to validate on presence or inclusion. Validating on inclusion means: ensuring that the current status value is included in the list of possible status values.

Defaults:

  • col_name = "status"
  • validate_presence = false
  • validate_inclusion = true

Note: Be sure that the column name in your migration matches whatever you choose for col_name, below.

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted],col_name: "lifecycle_state",validate_presence: true,validate_inclusion: true)end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model--the same ones shown in Basic Usage. However, the "status" name varies, and this time we include a presence validation:

# The following are equivalent:job=Job.new;job.set_lifecycle_state_pending# Check current status:job.lifecycle_state_pending?# => truejob.lifecycle_state?("Pending")# => truejob.not_lifecycle_state_running?# => truejob.not_lifecycle_state?("Running")# => true# Set status without saving:job.set_lifecycle_state_running# => #<Job:0x000000012fc3b060 id: nil, lifecycle_state: "Running", created_at: nil, updated_at: nil>job.lifecycle_state_running?# => true# Set status and save:job.set_lifecycle_state_running!# => #<Job:0x000000012fc3b560 id: 1, lifecycle_state: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.lifecycle_state_pending# => "Pending"job.lifecycle_state_pending# => "Pending"Job.lifecycle_state_options# => ["Pending", "Running", "Completed"]job.lifecycle_state_options# => ["Pending", "Running", "Completed"]Job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"# Named scopes:Job.for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" IN ('Pending', 'Running')Job.not_for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.not_for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" NOT IN ('Pending', 'Running')Job.for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.not_for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.by_lifecycle_state_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state"Job.by_lifecycle_state_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state" DESCJob.group_by_lifecycle_state.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."lifecycle_state"# Validation:job.lifecycle_state=niljob.validate;job.errors[:lifecycle_state]# => ["can't be blank"]job.lifecycle_state="Invalid lifecycle_state"job.validate;job.errors[:lifecycle_state]# => ["must be one of Pending, Running, or Completed"]

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/statusable.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. Or, run rake to run the tests plus linters as well as yard (to confirm proper YARD documentation practices). 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.

Testing

To test this gem:

rake

Linters

rubocop
reek
npx prettier . --check
npx prettier . --write

Releases

To release a new version of this gem to RubyGems:

  1. Update the version number in version.rb
  2. Update the release date, etc. in CHANGELOG.md
  3. Run bundle to update Gemfile.lock with the latest version info
  4. Commit the changes. e.g. Bump to vX.Y.Z
  5. Run 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.

License

The gem is available as open source under the terms of the MIT License.

About

Adds a `has_statuses` macro for defining common status-related ActiveRecord / Relation methods.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Statusable

Gem VersionCI Actions

Statusable adds a has_statuses macro for defining common status-related methods for use with ActiveRecord objects / Relations.

Installation

Add this line to your application's Gemfile:

gem"statusable"

And then execute:

$ bundle

Or install it yourself:

$ gem install statusable

Configuration

First, add a status column to your model. Or pick any other name you may want instead of status... the column name is configurable. (See Advanced Usage.)

# db/migrate/<version>_add_status_to_jobs.rbdefchangeadd_column:jobs,:status,:string,null: false,default: "Initializing"add_index:jobs,:statusend

Next, include Statusable::HasStatuses either into your model or into ApplicationRecord, per your preference.

classJob < ApplicationRecordincludeStatusable::HasStatusesend

Finally, call the has_statuses macro in your model, along with an array of your desired status names. See below for Basic Usage and Advanced Usage.

Basic Usage

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted])end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model.

# The following are equivalent:job=Job.new(status: "Pending")job=Job.new(status: Job.status_pending)job=Job.new;job.set_status_pending# Check current status:job.status_pending?# => truejob.status?("Pending")# => truejob.not_status_running?# => truejob.not_status?("Running")# => true# Set status without saving:job.set_status_running# => #<Job:0x000000012fc3b060 id: nil, status: "Running", created_at: nil, updated_at: nil>job.status_running?# => true# Set status and save:job.set_status_running!# => #<Job:0x000000012fc3b560 id: 1, status: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.status_pending# => "Pending"job.status_pending# => "Pending"Job.status_options# => ["Pending", "Running", "Completed"]job.status_options# => ["Pending", "Running", "Completed"]Job.humanized_statuses_list# => "Pending, Running, or Completed"job.humanized_statuses_list# => "Pending, Running, or Completed"# Named scopes:Job.for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" IN ('Pending', 'Running')Job.not_for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.not_for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" NOT IN ('Pending', 'Running')Job.for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.not_for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.by_status_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status"Job.by_status_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status" DESCJob.group_by_status.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."status"# Validation:# By default, we don't validate on presence, but this can be changed.# See the Advanced Usage section.job.status=niljob.validate;job.errors[:status]# => []job.status="Invalid Status"job.validate;job.errors[:status]# => ["must be one of Pending, Running, or Completed"]

Advanced Usage

The column name is customizable, as is whether or not to validate on presence or inclusion. Validating on inclusion means: ensuring that the current status value is included in the list of possible status values.

Defaults:

  • col_name = "status"
  • validate_presence = false
  • validate_inclusion = true

Note: Be sure that the column name in your migration matches whatever you choose for col_name, below.

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted],col_name: "lifecycle_state",validate_presence: true,validate_inclusion: true)end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model--the same ones shown in Basic Usage. However, the "status" name varies, and this time we include a presence validation:

# The following are equivalent:job=Job.new;job.set_lifecycle_state_pending# Check current status:job.lifecycle_state_pending?# => truejob.lifecycle_state?("Pending")# => truejob.not_lifecycle_state_running?# => truejob.not_lifecycle_state?("Running")# => true# Set status without saving:job.set_lifecycle_state_running# => #<Job:0x000000012fc3b060 id: nil, lifecycle_state: "Running", created_at: nil, updated_at: nil>job.lifecycle_state_running?# => true# Set status and save:job.set_lifecycle_state_running!# => #<Job:0x000000012fc3b560 id: 1, lifecycle_state: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.lifecycle_state_pending# => "Pending"job.lifecycle_state_pending# => "Pending"Job.lifecycle_state_options# => ["Pending", "Running", "Completed"]job.lifecycle_state_options# => ["Pending", "Running", "Completed"]Job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"# Named scopes:Job.for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" IN ('Pending', 'Running')Job.not_for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.not_for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" NOT IN ('Pending', 'Running')Job.for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.not_for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.by_lifecycle_state_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state"Job.by_lifecycle_state_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state" DESCJob.group_by_lifecycle_state.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."lifecycle_state"# Validation:job.lifecycle_state=niljob.validate;job.errors[:lifecycle_state]# => ["can't be blank"]job.lifecycle_state="Invalid lifecycle_state"job.validate;job.errors[:lifecycle_state]# => ["must be one of Pending, Running, or Completed"]

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/statusable.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. Or, run rake to run the tests plus linters as well as yard (to confirm proper YARD documentation practices). 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.

Testing

To test this gem:

rake

Linters

rubocop
reek
npx prettier . --check
npx prettier . --write

Releases

To release a new version of this gem to RubyGems:

  1. Update the version number in version.rb
  2. Update the release date, etc. in CHANGELOG.md
  3. Run bundle to update Gemfile.lock with the latest version info
  4. Commit the changes. e.g. Bump to vX.Y.Z
  5. Run 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.

License

The gem is available as open source under the terms of the MIT License.

About

Adds a `has_statuses` macro for defining common status-related ActiveRecord / Relation methods.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Statusable

Gem VersionCI Actions

Statusable adds a has_statuses macro for defining common status-related methods for use with ActiveRecord objects / Relations.

Installation

Add this line to your application's Gemfile:

gem"statusable"

And then execute:

$ bundle

Or install it yourself:

$ gem install statusable

Configuration

First, add a status column to your model. Or pick any other name you may want instead of status... the column name is configurable. (See Advanced Usage.)

# db/migrate/<version>_add_status_to_jobs.rbdefchangeadd_column:jobs,:status,:string,null: false,default: "Initializing"add_index:jobs,:statusend

Next, include Statusable::HasStatuses either into your model or into ApplicationRecord, per your preference.

classJob < ApplicationRecordincludeStatusable::HasStatusesend

Finally, call the has_statuses macro in your model, along with an array of your desired status names. See below for Basic Usage and Advanced Usage.

Basic Usage

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted])end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model.

# The following are equivalent:job=Job.new(status: "Pending")job=Job.new(status: Job.status_pending)job=Job.new;job.set_status_pending# Check current status:job.status_pending?# => truejob.status?("Pending")# => truejob.not_status_running?# => truejob.not_status?("Running")# => true# Set status without saving:job.set_status_running# => #<Job:0x000000012fc3b060 id: nil, status: "Running", created_at: nil, updated_at: nil>job.status_running?# => true# Set status and save:job.set_status_running!# => #<Job:0x000000012fc3b560 id: 1, status: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.status_pending# => "Pending"job.status_pending# => "Pending"Job.status_options# => ["Pending", "Running", "Completed"]job.status_options# => ["Pending", "Running", "Completed"]Job.humanized_statuses_list# => "Pending, Running, or Completed"job.humanized_statuses_list# => "Pending, Running, or Completed"# Named scopes:Job.for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" IN ('Pending', 'Running')Job.not_for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.not_for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" NOT IN ('Pending', 'Running')Job.for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.not_for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.by_status_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status"Job.by_status_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status" DESCJob.group_by_status.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."status"# Validation:# By default, we don't validate on presence, but this can be changed.# See the Advanced Usage section.job.status=niljob.validate;job.errors[:status]# => []job.status="Invalid Status"job.validate;job.errors[:status]# => ["must be one of Pending, Running, or Completed"]

Advanced Usage

The column name is customizable, as is whether or not to validate on presence or inclusion. Validating on inclusion means: ensuring that the current status value is included in the list of possible status values.

Defaults:

  • col_name = "status"
  • validate_presence = false
  • validate_inclusion = true

Note: Be sure that the column name in your migration matches whatever you choose for col_name, below.

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted],col_name: "lifecycle_state",validate_presence: true,validate_inclusion: true)end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model--the same ones shown in Basic Usage. However, the "status" name varies, and this time we include a presence validation:

# The following are equivalent:job=Job.new;job.set_lifecycle_state_pending# Check current status:job.lifecycle_state_pending?# => truejob.lifecycle_state?("Pending")# => truejob.not_lifecycle_state_running?# => truejob.not_lifecycle_state?("Running")# => true# Set status without saving:job.set_lifecycle_state_running# => #<Job:0x000000012fc3b060 id: nil, lifecycle_state: "Running", created_at: nil, updated_at: nil>job.lifecycle_state_running?# => true# Set status and save:job.set_lifecycle_state_running!# => #<Job:0x000000012fc3b560 id: 1, lifecycle_state: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.lifecycle_state_pending# => "Pending"job.lifecycle_state_pending# => "Pending"Job.lifecycle_state_options# => ["Pending", "Running", "Completed"]job.lifecycle_state_options# => ["Pending", "Running", "Completed"]Job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"# Named scopes:Job.for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" IN ('Pending', 'Running')Job.not_for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.not_for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" NOT IN ('Pending', 'Running')Job.for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.not_for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.by_lifecycle_state_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state"Job.by_lifecycle_state_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state" DESCJob.group_by_lifecycle_state.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."lifecycle_state"# Validation:job.lifecycle_state=niljob.validate;job.errors[:lifecycle_state]# => ["can't be blank"]job.lifecycle_state="Invalid lifecycle_state"job.validate;job.errors[:lifecycle_state]# => ["must be one of Pending, Running, or Completed"]

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/statusable.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. Or, run rake to run the tests plus linters as well as yard (to confirm proper YARD documentation practices). 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.

Testing

To test this gem:

rake

Linters

rubocop
reek
npx prettier . --check
npx prettier . --write

Releases

To release a new version of this gem to RubyGems:

  1. Update the version number in version.rb
  2. Update the release date, etc. in CHANGELOG.md
  3. Run bundle to update Gemfile.lock with the latest version info
  4. Commit the changes. e.g. Bump to vX.Y.Z
  5. Run 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.

License

The gem is available as open source under the terms of the MIT License.

About

Adds a `has_statuses` macro for defining common status-related ActiveRecord / Relation methods.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Repository files navigation

Statusable

Gem VersionCI Actions

Statusable adds a has_statuses macro for defining common status-related methods for use with ActiveRecord objects / Relations.

Installation

Add this line to your application's Gemfile:

gem"statusable"

And then execute:

$ bundle

Or install it yourself:

$ gem install statusable

Configuration

First, add a status column to your model. Or pick any other name you may want instead of status... the column name is configurable. (See Advanced Usage.)

# db/migrate/<version>_add_status_to_jobs.rbdefchangeadd_column:jobs,:status,:string,null: false,default: "Initializing"add_index:jobs,:statusend

Next, include Statusable::HasStatuses either into your model or into ApplicationRecord, per your preference.

classJob < ApplicationRecordincludeStatusable::HasStatusesend

Finally, call the has_statuses macro in your model, along with an array of your desired status names. See below for Basic Usage and Advanced Usage.

Basic Usage

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted])end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model.

# The following are equivalent:job=Job.new(status: "Pending")job=Job.new(status: Job.status_pending)job=Job.new;job.set_status_pending# Check current status:job.status_pending?# => truejob.status?("Pending")# => truejob.not_status_running?# => truejob.not_status?("Running")# => true# Set status without saving:job.set_status_running# => #<Job:0x000000012fc3b060 id: nil, status: "Running", created_at: nil, updated_at: nil>job.status_running?# => true# Set status and save:job.set_status_running!# => #<Job:0x000000012fc3b560 id: 1, status: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.status_pending# => "Pending"job.status_pending# => "Pending"Job.status_options# => ["Pending", "Running", "Completed"]job.status_options# => ["Pending", "Running", "Completed"]Job.humanized_statuses_list# => "Pending, Running, or Completed"job.humanized_statuses_list# => "Pending, Running, or Completed"# Named scopes:Job.for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" IN ('Pending', 'Running')Job.not_for_status("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.not_for_status(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" NOT IN ('Pending', 'Running')Job.for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" = 'Pending'Job.not_for_status_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."status" != 'Pending'Job.by_status_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status"Job.by_status_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."status" DESCJob.group_by_status.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."status"# Validation:# By default, we don't validate on presence, but this can be changed.# See the Advanced Usage section.job.status=niljob.validate;job.errors[:status]# => []job.status="Invalid Status"job.validate;job.errors[:status]# => ["must be one of Pending, Running, or Completed"]

Advanced Usage

The column name is customizable, as is whether or not to validate on presence or inclusion. Validating on inclusion means: ensuring that the current status value is included in the list of possible status values.

Defaults:

  • col_name = "status"
  • validate_presence = false
  • validate_inclusion = true

Note: Be sure that the column name in your migration matches whatever you choose for col_name, below.

classJob < ApplicationRecordincludeStatusable::HasStatuseshas_statuses(%w[PendingRunningCompleted],col_name: "lifecycle_state",validate_presence: true,validate_inclusion: true)end

This adds a number of methods, named_scopes, and even ActiveModel validations to the model--the same ones shown in Basic Usage. However, the "status" name varies, and this time we include a presence validation:

# The following are equivalent:job=Job.new;job.set_lifecycle_state_pending# Check current status:job.lifecycle_state_pending?# => truejob.lifecycle_state?("Pending")# => truejob.not_lifecycle_state_running?# => truejob.not_lifecycle_state?("Running")# => true# Set status without saving:job.set_lifecycle_state_running# => #<Job:0x000000012fc3b060 id: nil, lifecycle_state: "Running", created_at: nil, updated_at: nil>job.lifecycle_state_running?# => true# Set status and save:job.set_lifecycle_state_running!# => #<Job:0x000000012fc3b560 id: 1, lifecycle_state: "Running", created_at: "...", updated_at: "..."># Get status names/lists:Job.lifecycle_state_pending# => "Pending"job.lifecycle_state_pending# => "Pending"Job.lifecycle_state_options# => ["Pending", "Running", "Completed"]job.lifecycle_state_options# => ["Pending", "Running", "Completed"]Job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"job.humanized_lifecycle_states_list# => "Pending, Running, or Completed"# Named scopes:Job.for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" IN ('Pending', 'Running')Job.not_for_lifecycle_state("Pending").to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.not_for_lifecycle_state(%w[PendingRunning]).to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" NOT IN ('Pending', 'Running')Job.for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" = 'Pending'Job.not_for_lifecycle_state_pending.to_sql# => SELECT "jobs".* FROM "jobs" WHERE "jobs"."lifecycle_state" != 'Pending'Job.by_lifecycle_state_asc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state"Job.by_lifecycle_state_desc.to_sql# => SELECT "jobs".* FROM "jobs" ORDER BY "jobs"."lifecycle_state" DESCJob.group_by_lifecycle_state.to_sql# => SELECT "jobs".* FROM "jobs" GROUP BY "jobs"."lifecycle_state"# Validation:job.lifecycle_state=niljob.validate;job.errors[:lifecycle_state]# => ["can't be blank"]job.lifecycle_state="Invalid lifecycle_state"job.validate;job.errors[:lifecycle_state]# => ["must be one of Pending, Running, or Completed"]

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/statusable.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. Or, run rake to run the tests plus linters as well as yard (to confirm proper YARD documentation practices). 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.

Testing

To test this gem:

rake

Linters

rubocop
reek
npx prettier . --check
npx prettier . --write

Releases

To release a new version of this gem to RubyGems:

  1. Update the version number in version.rb
  2. Update the release date, etc. in CHANGELOG.md
  3. Run bundle to update Gemfile.lock with the latest version info
  4. Commit the changes. e.g. Bump to vX.Y.Z
  5. Run 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.

License

The gem is available as open source under the terms of the MIT License.

About

Adds a `has_statuses` macro for defining common status-related ActiveRecord / Relation methods.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages