Sha256: 63e574393bd74607ab31f1ccfa43ce9846131055c99bcacf8485cc71585e7300

Contents?: true

Size: 996 Bytes

Versions: 95

Compression:

Stored size: 996 Bytes

Contents

# frozen_string_literal: true

require "active_support/concern"

module Primer
  # :nodoc:
  module Status
    # DSL to allow components to register their status.
    #
    # Example:
    #
    # class MyComponent < ViewComponent::Base
    #   include Primer::Status::Dsl
    #   status :beta
    # end
    module Dsl
      extend ActiveSupport::Concern

      STATUSES = {
        alpha: :alpha,
        beta: :beta,
        stable: :stable,
        deprecated: :deprecated,
        experimental: :experimental
      }.freeze

      class UnknownStatusError < StandardError; end

      included do
        class_attribute :component_status, instance_writer: false, default: STATUSES[:alpha]
      end

      class_methods do
        def status(status = nil)
          return component_status if status.nil?

          raise UnknownStatusError, "status #{status} does not exist" if STATUSES[status].nil?

          self.component_status = STATUSES[status]
        end
      end
    end
  end
end

Version data entries

95 entries across 95 versions & 2 rubygems

Version Path
primer_view_components-0.36.5 app/lib/primer/status/dsl.rb
primer_view_components-0.36.4 app/lib/primer/status/dsl.rb
primer_view_components-0.36.3 app/lib/primer/status/dsl.rb
primer_view_components-0.36.2 app/lib/primer/status/dsl.rb
primer_view_components-0.36.1 app/lib/primer/status/dsl.rb
primer_view_components-0.36.0 app/lib/primer/status/dsl.rb
primer_view_components-0.35.2 app/lib/primer/status/dsl.rb
primer_view_components-0.35.1 app/lib/primer/status/dsl.rb
primer_view_components-0.35.0 app/lib/primer/status/dsl.rb
primer_view_components-0.34.0 app/lib/primer/status/dsl.rb
primer_view_components-0.33.0 app/lib/primer/status/dsl.rb
primer_view_components-0.32.0 app/lib/primer/status/dsl.rb
primer_view_components-0.31.0 app/lib/primer/status/dsl.rb
primer_view_components-0.30.0 app/lib/primer/status/dsl.rb
primer_view_components-0.29.0 app/lib/primer/status/dsl.rb
primer_view_components-0.28.0 app/lib/primer/status/dsl.rb
primer_view_components-0.27.0 app/lib/primer/status/dsl.rb
primer_view_components-0.26.1 app/lib/primer/status/dsl.rb
primer_view_components-0.26.0 app/lib/primer/status/dsl.rb
primer_view_components-0.25.1 app/lib/primer/status/dsl.rb