practical 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da7aaa72d992ff3aaf4a43ed5c374c6ff1652843075713e08fa95ab1244d88bf
+  data.tar.gz: 6c935a7c4cc3ac3538aa78c2f100b6b009b3113577b53bfba7b39efed5a3878d
+SHA512:
+  metadata.gz: 88fd0246800371d155ccba2fc6337127a82e31e5ba41fb793bef3558149307914f095cb3e4fa620d86ca34a097f44fcf9278491667dc21bcd10856f04f453f2e
+  data.tar.gz: d7c98265992ff1ed00a0e9c6562bcebe239e749e4364345c5a364224c6835226909ae7e39802941867d6daa063e26739e02adb74556c5148927fa22ba682953c

data/README.md

@@ -0,0 +1,37 @@
+# `practical`: The Practical Framework
+
+_This gem is currently being open-sourced from a private repo, while also being singificantly reorganized. Its 3.0 release will be live soon!_
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/practical. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/practical/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Practical project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/practical/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/app/components/practical/views/base_component.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class Practical::Views::BaseComponent < ViewComponent::Base
+  include Practical::Views::ElementHelper
+  delegate :safe_join, :icon_set, to: :helpers
+end

data/app/components/practical/views/button_component.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Practical::Views::ButtonComponent < Practical::Views::BaseComponent
+  include Practical::Views::Button::Styling
+  attr_accessor :type, :appearance, :color_variant, :size, :options
+
+  def initialize(type:, appearance: nil, color_variant: nil, size: nil, options: {})
+    @type = type
+    @options = options
+    initialize_style_utilities(appearance: appearance, color_variant: color_variant, size: size)
+  end
+
+  def call
+    defaults = {
+      type: type,
+      class: css_classes_from_style_utilities
+    }
+
+    if type.to_sym == :submit
+      defaults[:data] = { disable: true }
+    end
+
+    finalized_options = mix(defaults, options)
+
+    tag.button(content, **finalized_options)
+  end
+end

data/app/components/practical/views/datatable/filter_applied.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Practical::Views::Datatable::FilterApplied
+  extend ActiveSupport::Concern
+
+  def dialog_button_appearance
+    if custom_filters_applied?
+      return "filled outlined"
+    else
+      return "outlined"
+    end
+  end
+
+  def custom_filters_applied?
+    datatable_form.filters.to_h.compact != datatable_form.class.default_payload[:filters]
+  end
+
+  def filter_icon
+    if custom_filters_applied?
+      icon_set.filters_icon
+    else
+      icon_set.apply_filters_icon
+    end
+  end
+end

data/app/components/practical/views/datatable/filter_section_component.html.erb

@@ -0,0 +1,9 @@
+<section class="datatable-filters wa-cluster wa-callout wa-neutral wa-outlined wa-align-items-center wa-size-s">
+  <%= open_filters_button %>
+
+  <section class="wa-cluster">
+    <% applied_filters.each do |applied_filter| %>
+      <%= applied_filter %>
+    <% end %>
+  </section>
+</section>

data/app/components/practical/views/datatable/filter_section_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class Practical::Views::Datatable::FilterSectionComponent < Practical::Views::BaseComponent
+  renders_one :open_filters_button
+  renders_many :applied_filters,  "AppliedFilterComponent"
+
+  class Practical::Views::Datatable::FilterSectionComponent::AppliedFilterComponent < Practical::Views::BaseComponent
+    renders_one :title
+
+    def call
+      tag.section(class: "wa-stack wa-gap-0") do
+        safe_join([
+          tag.strong(title),
+          content
+        ])
+      end
+    end
+  end
+end

data/app/components/practical/views/datatable/sort_link_component.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class Practical::Views::Datatable::SortLinkComponent < Practical::Views::BaseComponent
+  attr_accessor :url, :datatable_form, :sort_key, :options
+
+  def initialize(url:, datatable_form:, sort_key:, options: {})
+    self.url = url
+    self.datatable_form = datatable_form
+    self.sort_key = sort_key
+    self.options = options
+  end
+
+  def call
+    tag.a(**mix({href: url}, options)) {
+      safe_join([
+        render(icon),
+        content
+      ])
+    }
+  end
+
+  def icon
+    case sort_direction
+    when "desc"
+      return icon_set.descending_icon
+    when "asc"
+      return icon_set.ascending_icon
+    else
+      return icon_set.sort_icon
+    end
+  end
+
+  def sort_direction
+    datatable_form.sort_direction_for(key: sort_key)
+  end
+
+  def self.inverted_sort_direction(datatable_form:, sort_key:)
+    datatable_form.inverted_sort_direction_for(key: sort_key)
+  end
+
+  def self.merged_payload(datatable_form:, sort_key:)
+    datatable_form.merged_payload(sort_key: sort_key,
+                                  sort_direction: inverted_sort_direction(datatable_form: datatable_form,
+                                                                          sort_key: sort_key
+                                                                        )
+                                 )
+  end
+end

data/app/components/practical/views/datatable.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Practical::Views::Datatable
+  extend ActiveSupport::Concern
+
+  def sort_link_for(key:, &block)
+    component = Practical::Views::Datatable::SortLinkComponent.new(
+      url: sort_url_for(key: key),
+      datatable_form: datatable_form,
+      sort_key: key,
+      options: {class: "wa-flank wa-gap-2xs"}
+    )
+
+    render(component, &block)
+  end
+
+  def inverted_sort_direction(datatable_form:, sort_key:)
+    datatable_form.inverted_sort_direction_for(key: sort_key)
+  end
+
+  def merged_payload(datatable_form:, sort_key:)
+    datatable_form.merged_payload(sort_key: sort_key,
+                                  sort_direction: inverted_sort_direction(datatable_form: datatable_form,
+                                                                          sort_key: sort_key
+                                                                        )
+                                 )
+  end
+
+  def pagination_component
+    return Practical::Views::Navigation::PaginationComponent.new(
+      pagy: pagy,
+      request: request,
+      i18n_key: "pagy.item_name"
+    )
+  end
+end

data/app/components/practical/views/flash_messages_component.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+class Practical::Views::FlashMessagesComponent < Practical::Views::BaseComponent
+  def call
+    tag.aside(class: 'notification-messages wa-stack') do
+      safe_join([
+        alert_toast,
+        notice_toast,
+        success_toast,
+      ])
+    end
+  end
+
+  def success_toast
+    render_toast(
+      color_variant: :success,
+      data: helpers.flash[:success],
+      default_icon: icon_set.success_icon
+    )
+  end
+
+  def notice_toast
+    render_toast(
+      color_variant: :neutral,
+      data: helpers.flash[:notice],
+      default_icon: icon_set.info_icon
+    )
+  end
+
+  def alert_toast
+    render_toast(
+      color_variant: :warning,
+      data: helpers.flash[:alert],
+      default_icon: icon_set.alert_icon
+    )
+  end
+
+  def render_toast(color_variant:, data:, default_icon:)
+    return nil if data.nil?
+
+    case data
+    when String
+      message = data
+      icon = default_icon
+    when Hash
+      data = data.with_indifferent_access
+      message = data[:message]
+      icon = data[:icon]
+    end
+
+
+    component = Practical::Views::ToastComponent.new(color_variant: color_variant)
+
+    render component do |component|
+      if icon.present? && icon.is_a?(Hash)
+        icon = Practical::Views::IconComponent.new(**icon.to_h.symbolize_keys)
+        component.with_icon do
+          render icon
+        end
+      end
+
+      message
+    end
+  end
+end

data/app/components/practical/views/form/error_list_component.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Practical::Views::Form::ErrorListComponent < Practical::Views::BaseComponent
+  attr_reader :errors
+
+  def initialize(errors:)
+    @errors = errors
+  end
+
+  def call
+    tag.ul(class: 'error-list') {
+      safe_join(errors.map{|error| render Practical::Views::Form::ErrorListItemComponent.new(error: error) })
+    }
+  end
+end

data/app/components/practical/views/form/error_list_item_component.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Practical::Views::Form::ErrorListItemComponent < Practical::Views::BaseComponent
+  attr_reader :error
+
+  def initialize(error:)
+    @error = error
+  end
+
+  def before_render
+    error.options[:has_been_rendered] = true
+  end
+
+  def call
+    tag.li(class: 'wa-flank', data: {"error-type": error.type}) {
+      render(icon_set.error_list_icon) +
+      tag.span(error.message)
+    }
+  end
+end

data/app/components/practical/views/form/error_list_item_template_component.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Practical::Views::Form::ErrorListItemTemplateComponent < Practical::Views::BaseComponent
+  def call
+    tag.template(id: 'error-list-item-template') {
+      render Practical::Views::Form::ErrorListItemComponent.new(error: ActiveModel::Error.new(nil, nil, nil))
+    }
+  end
+end

data/app/components/practical/views/form/fallback_errors_section_component.html.erb

@@ -0,0 +1,7 @@
+<%= tag.section(**finalized_options) do %>
+  <header>
+    <strong><%= blurb %></strong>
+  </header>
+
+  <%= render Practical::Views::Form::ErrorListComponent.new(errors: remaining_errors) %>
+<% end %>

data/app/components/practical/views/form/fallback_errors_section_component.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Practical::Views::Form::FallbackErrorsSectionComponent < Practical::Views::BaseComponent
+  attr_reader :f, :blurb
+  def initialize(f:, blurb:, options:)
+    @f = f
+    @blurb = blurb
+    @options = options
+  end
+
+  def finalized_options
+    mix({
+      class: ["error-section", "fallback-error-section", "wa-callout", "wa-danger"]
+    }, @options)
+  end
+
+  def remaining_errors
+    return [] if f.object.try(:errors).blank?
+    return f.object.errors.reject{|error| error.options[:has_been_rendered] }
+  end
+end

data/app/components/practical/views/form/field_errors_component.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Practical::Views::Form::FieldErrorsComponent < Practical::Views::BaseComponent
+  attr_reader :f, :object_method, :options
+
+  def initialize(f:, object_method:, options:)
+    @f = f
+    @object_method = object_method
+    @options = options
+  end
+
+  def call
+    id = f.field_errors_id(object_method)
+    classes = ["error-section", "wa-callout", "wa-danger"]
+    errors = f.errors_for(object_method)
+
+    if errors.blank?
+      classes << ["no-server-errors"]
+      errors = []
+    end
+
+    finalized_options = mix({id: id, class: classes}, options)
+
+    return label(object_method, nil, finalized_options) {
+      render Practical::Views::Form::ErrorListComponent.new(errors: errors)
+    }
+  end
+end

data/app/components/practical/views/form/field_title_component.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Practical::Views::Form::FieldTitleComponent < Practical::Views::BaseComponent
+  attr_accessor :options
+  renders_one :icon
+
+  def initialize(options: {})
+    self.options = options
+  end
+
+  def flank_class
+    return "wa-flank" if icon?
+  end
+
+  def call
+    tag.section(**mix({class: [flank_class, "field-title"]}, options)) {
+      safe_join([
+        (icon if icon?),
+        tag.div{ content }
+      ])
+    }
+  end
+end

data/app/components/practical/views/form/fieldset_title_component.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Practical::Views::Form::FieldsetTitleComponent < Practical::Views::BaseComponent
+  attr_accessor :options
+  renders_one :icon
+
+  def initialize(options: {})
+    self.options = options
+  end
+
+  def call
+    tag.span(**mix({}, options)) {
+      safe_join([
+        (icon if icon?),
+        " ",
+        tag.span{ content }
+      ])
+    }
+  end
+end

data/app/components/practical/views/form/input_component.html.erb

@@ -0,0 +1,7 @@
+<section class='wa-stack wa-gap-3xs'>
+  <%= tag.label(**label_options) do %>
+    <%= label %>
+    <%= field %>
+  <% end %>
+  <%= f.field_errors(object_method) %>
+</section>

data/app/components/practical/views/form/input_component.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Practical::Views::Form::InputComponent < Practical::Views::BaseComponent
+  attr_accessor :f, :object_method, :label_options
+
+  renders_one :label
+  renders_one :field
+
+  def initialize(f:, object_method:, label_options: {})
+    self.f = f
+    self.object_method = object_method
+    self.label_options = label_options
+  end
+
+  def field_errors_id
+    f.field_errors_id(object_method)
+  end
+
+  def field_options(**options)
+    mix({"aria-describedby": field_errors_id}, options)
+  end
+end

data/app/components/practical/views/form/option_label_component.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Practical::Views::Form::OptionLabelComponent < Practical::Views::BaseComponent
+  renders_one :title
+  renders_one :description
+  attr_accessor :options
+
+  def initialize(options: {})
+    self.options = options
+  end
+
+
+  def call
+    tag.section(**mix({class: "wa-stack wa-size-s wa-gap-0"}, options)) {
+      safe_join([
+        tag.span(title),
+        tag.small(description, class: "wa-quiet"),
+      ])
+    }
+  end
+end

data/app/components/practical/views/form/practical_editor_component.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Practical::Views::Form::PracticalEditorComponent < Practical::Views::BaseComponent
+  attr_accessor :input_id, :aria_describedby_id, :direct_upload_url, :options
+
+  def initialize(input_id:, aria_describedby_id:, direct_upload_url:, options: {})
+    self.input_id = input_id
+    self.aria_describedby_id = aria_describedby_id
+    self.direct_upload_url = direct_upload_url
+    self.options = options
+  end
+
+  def finalized_options
+    mix({
+      input: input_id,
+      serializer: :json,
+      data: {direct_upload_url: direct_upload_url}
+    }, options)
+  end
+
+  def call
+    tag.practical_editor(**finalized_options) {
+      tag.div("slot": :editor, "aria-describedby": aria_describedby_id)
+    }
+  end
+end

data/app/components/practical/views/form/required_radio_collection_wrapper_component.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Practical::Views::Form::RequiredRadioCollectionWrapperComponent < Practical::Views::BaseComponent
+  attr_reader :f, :object_method, :options
+  def initialize(f:, object_method:, options:)
+    @f = f
+    @object_method = object_method
+    @options = options
+  end
+
+  def finalized_options
+    mix({
+      "fieldset": f.field_id(object_method),
+      "field-name": f.field_name(object_method),
+      "errors-element": f.field_id(object_method, :errors),
+      "errors-element-aria": f.field_id(object_method, :errors_aria),
+    }, options)
+  end
+
+  def call
+    content_tag(:"required-radio-collection", content, **finalized_options)
+  end
+end

data/app/components/practical/views/form_wrapper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Practical::Views::FormWrapper
+  extend ActiveSupport::Concern
+
+  def generic_errors_id
+    dom_id(form, :generic_errors)
+  end
+
+  def wrapped_form_with(**options, &block)
+    finalized_options = mix({
+      html: {
+        "aria-describedby": generic_errors_id,
+      }
+    }, options)
+    helpers.application_form_with(
+      **finalized_options,
+      &block
+    )
+  end
+end

data/app/components/practical/views/icon_component.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class Practical::Views::IconComponent < Practical::Views::BaseComponent
+  include ActiveModel::Serializers::JSON
+
+  attr_accessor :name, :family, :variant, :fixed_width, :label, :options
+
+  def attributes=(hash)
+    hash.each do |key, value|
+      public_send("#{key}=", value)
+    end
+  end
+
+  def attributes
+    { "name" => nil, "family" => nil, "variant" => nil, "fixed_width" => nil, "label" => nil, "options" => nil }
+  end
+
+  def initialize(name:, family:, variant: nil, fixed_width: true, label: nil, options: {})
+    self.name = name
+    self.family = family
+    self.variant = variant
+    self.fixed_width = fixed_width
+    self.label = label
+    self.options = options
+  end
+
+  def call
+    tag.wa_icon(**mix({
+      "name": name,
+      "family": family,
+      "variant": variant,
+      "fixed-width": fixed_width,
+      "label": label
+    }, options))
+  end
+end

data/app/components/practical/views/icon_for_file_extension_component.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class Practical::Views::IconForFileExtensionComponent < Practical::Views::BaseComponent
+  attr_reader :extension
+
+  def initialize(extension:)
+    raise ArgumentError unless self.class.supported_extension?(extension: extension)
+    @extension = extension.to_sym
+  end
+
+  def call
+    case extension
+    when :csv
+      render_icon(method_name: :csv_icon)
+    when :pdf
+      render_icon(method_name: :pdf_icon)
+    when :doc, :docx
+      render_icon(method_name: :doc_icon)
+    when :xls, :xlsx
+      render_icon(method_name: :xls_icon)
+    when :heic
+      render_icon(method_name: :heic_icon)
+    when :missing
+      render_icon(method_name: :missing_file_icon)
+    else
+      render_icon(method_name: :txt_icon)
+    end
+  end
+
+  def render_icon(method_name:)
+    render icon_set.public_send(method_name)
+  end
+
+  def self.supported_extension?(extension:)
+    supported_extensions.include?(extension.to_sym)
+  end
+
+  def self.supported_extensions
+    %i(
+       csv
+       pdf
+       docx
+       xlsx
+       doc
+       xls
+       heic
+       missing
+       txt
+       rtf
+       numbers
+    ).freeze
+  end
+end