rails_statusable 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96d51d3a333e9cce3825d523385659351d6db61274b2a86bd0bf8dd00ca9e5cc
+  data.tar.gz: 31866bfbcc30ffdbf408c5f7fafb5a00a641f16b73466465efb3d329dbaf1134
+SHA512:
+  metadata.gz: ee37eac7ec574eb7f21c1bba64dbf2d3f78b0ee04857c7b17edbc856acba033b82426ff4b769186ef32fd4c1672697384b4cbcd68b5ca33ca246f482bdc24933
+  data.tar.gz: 522b0b535342d68867c3bc3bf8043ffd35dfa763e36f197eb8562173ee88ccf8b81d91dce2fdf66e8bed94455eea99ccd349dfddd313c464a30275d949ebc568

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright aric.zheng
+
+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,36 @@
+# rails_statusable
+> A Rails plugin for flexible, model-specific status fields with dynamic methods.
+
+## Usage
+```rb
+class Post < ApplicationRecord
+    include RailsStatusable
+    statusable statuses: %w[draft published archived], default: 'draft'
+end
+
+# install migration
+rails generate rails_statusable:install
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_statusable"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails_statusable
+```
+
+## Resources
+- https://chat.qwen.ai/c/6c5e5633-c893-4b29-982b-0d3a4f9f38b9
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"

data/app/assets/stylesheets/rails_statusable/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/rails_statusable/application_controller.rb

@@ -0,0 +1,4 @@
+module RailsStatusable
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/rails_statusable/application_helper.rb

@@ -0,0 +1,4 @@
+module RailsStatusable
+  module ApplicationHelper
+  end
+end

data/app/jobs/rails_statusable/application_job.rb

@@ -0,0 +1,4 @@
+module RailsStatusable
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/rails_statusable/application_mailer.rb

@@ -0,0 +1,6 @@
+module RailsStatusable
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/rails_statusable/application_record.rb

@@ -0,0 +1,5 @@
+module RailsStatusable
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/rails_statusable/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails statusable</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "rails_statusable/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+RailsStatusable::Engine.routes.draw do
+end

data/lib/generators/rails_statusable/install_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+require 'rails/generators/active_record/migration'
+
+module RailsStatusable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Generates a migration to add status column to specified table"
+
+      def create_migration_file
+        migration_template "migration.rb", "db/migrate/add_status_to_#{table_name}.rb"
+      end
+
+      private
+
+      def table_name
+        @table_name ||= ask("Enter the table name to add status field to (e.g., posts):")
+      end
+
+      # Implement the required method for Rails::Generators::Migration
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+    end
+  end
+end

data/lib/generators/rails_statusable/templates/migration.rb

@@ -0,0 +1,6 @@
+class AddStatusTo<%= table_name.camelize %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :<%= table_name %>, :status, :string
+    add_index :<%= table_name %>, :status
+  end
+end

data/lib/rails_statusable/configuration.rb

@@ -0,0 +1,9 @@
+module RailsStatusable
+  class Configuration
+    attr_accessor :default_statuses
+
+    def initialize
+      @default_statuses = %w[draft published archived]
+    end
+  end
+end

data/lib/rails_statusable/engine.rb

@@ -0,0 +1,5 @@
+module RailsStatusable
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsStatusable
+  end
+end

data/lib/rails_statusable/version.rb

@@ -0,0 +1,3 @@
+module RailsStatusable
+  VERSION = "1.0.1"
+end

data/lib/rails_statusable.rb

@@ -0,0 +1,77 @@
+require "rails_statusable/engine"
+
+module RailsStatusable
+  extend ActiveSupport::Concern
+
+  class << self
+    def configure(&block)
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def config
+      configuration
+    end
+  end
+
+  included do
+    extend ClassMethods
+  end
+
+  module ClassMethods
+    def statusable(options = {})
+      class_attribute :status_config
+      self.status_config = {
+        field: options[:field] || :status,
+        statuses: options[:statuses] || RailsStatusable.config.default_statuses,
+        default: options[:default] || RailsStatusable.config.default_statuses.first
+      }
+
+      # Add validation for the status field
+      validates status_config[:field], inclusion: { 
+        in: status_config[:statuses],
+        message: "%{value} is not a valid status" 
+      }
+
+      # Set default value
+      after_initialize :set_default_status
+
+      # Generate dynamic methods for each status
+      status_config[:statuses].each do |status|
+        define_status_method(status)
+      end
+
+      # Add scope methods for querying
+      status_config[:statuses].each do |status|
+        scope "by_#{status}", -> { where(status_config[:field] => status) }
+      end
+    end
+
+    private
+
+    def define_status_method(status_name)
+      method_name = "#{status_name}?"
+      
+      define_method(method_name) do
+        send(self.class.status_config[:field]).to_s.downcase == status_name.to_s.downcase
+      end
+
+      # Define setter method
+      setter_method_name = "#{status_name}!"
+      define_method(setter_method_name) do
+        send("#{self.class.status_config[:field]}=", status_name)
+      end
+    end
+  end
+
+  private
+
+  def set_default_status
+    if send(self.class.status_config[:field]).blank?
+      send("#{self.class.status_config[:field]}=", self.class.status_config[:default])
+    end
+  end
+end

data/lib/tasks/rails_statusable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_statusable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: rails_statusable
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- aric.zheng
+bindir: bin
+cert_chain: []
+date: 2025-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: Rails plugin that adds configurable status fields to models with dynamic
+  methods like draft?, published?, etc.
+email:
+- 1290657123@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/rails_statusable/application.css
+- app/controllers/rails_statusable/application_controller.rb
+- app/helpers/rails_statusable/application_helper.rb
+- app/jobs/rails_statusable/application_job.rb
+- app/mailers/rails_statusable/application_mailer.rb
+- app/models/rails_statusable/application_record.rb
+- app/views/layouts/rails_statusable/application.html.erb
+- config/routes.rb
+- lib/generators/rails_statusable/install_generator.rb
+- lib/generators/rails_statusable/templates/migration.rb
+- lib/rails_statusable.rb
+- lib/rails_statusable/configuration.rb
+- lib/rails_statusable/engine.rb
+- lib/rails_statusable/version.rb
+- lib/tasks/rails_statusable_tasks.rake
+homepage: https://github.com/afeiship/rails_statusable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/afeiship/rails_statusable
+  source_code_uri: https://github.com/afeiship/rails_statusable
+  changelog_uri: https://github.com/afeiship/rails_statusable/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: A Rails plugin for flexible, model-specific status fields with dynamic methods.
+test_files: []