warped 0.1.0 → 1.0.0

data/lib/warped/controllers/sortable/ui.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/core_ext/object/blank"
+
+module Warped
+  module Controllers
+    module Sortable
+      module Ui
+        extend ActiveSupport::Concern
+
+        include Sortable
+
+        included do
+          helper_method :attribute_name, :sorted?, :sorted_field?, :sortable_field?, :sort_url_params
+        end
+
+        # @see Sortable#sort
+        def sort(...)
+          @sorted = true
+
+          super
+        end
+
+        # @param parameter_name [String]
+        # @return [Boolean]
+        def sorted_field?(parameter_name)
+          current_action_sort_value.parameter_name == parameter_name.to_s
+        end
+
+        # @param parameter_name [String]
+        # @return [Boolean] Whether the parameter_name is sortable.
+        def sortable_field?(parameter_name)
+          current_action_sorts.any? { |sort| sort.parameter_name == parameter_name.to_s }
+        end
+
+        # @return [Boolean] Whether the current action is sorted.
+        def sorted?
+          @sorted ||= false
+        end
+
+        # @return [Hash] The sort_url_params
+        def sort_url_params(**options)
+          url_params = {
+            sort_key: current_action_sort_value.parameter_name,
+            sort_direction: current_action_sort_value.direction
+          }
+          url_params.merge!(options)
+        end
+      end
+    end
+  end
+end

data/lib/warped/controllers/sortable.rb

@@ -2,6 +2,7 @@
 
 require "active_support/concern"
 require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/object/blank"
 
 module Warped
   module Controllers
@@ -35,7 +36,7 @@ module Warped
     #   class UsersController < ApplicationController
     #     include Sortable
     #
-    #     sortable_by :name, :created_at, 'accounts.referrals_count' => 'referrals'
+    #     sortable_by :name, :created_at, 'accounts.referrals_count' => { alias_name: 'referrals' }
     #
     #     def index
     #       scope = sort(User.joins(:account))
@@ -55,60 +56,79 @@ module Warped
       extend ActiveSupport::Concern
 
       included do
-        class_attribute :sort_fields, default: []
-        class_attribute :mapped_sort_fields, default: {}
-        class_attribute :default_sort_key, default: :id
-        class_attribute :default_sort_direction, default: :desc
+        class_attribute :sorts, default: []
+        class_attribute :default_sort, default: Sort.new("id")
+        class_attribute :default_sort_direction, default: "desc"
+
+        attr_reader :current_action_sorts
+
+        helper_method :current_action_sorts, :current_action_sort_value, :default_sort, :default_sort_direction
+
+        rescue_from Sort::DirectionError, with: :render_invalid_sort_direction
       end
 
       class_methods do
         # @param keys [Array<Symbol,String>]
         # @param mapped_keys [Hash<Symbol,String>]
         def sortable_by(*keys, **mapped_keys)
-          self.sort_fields = keys.map(&:to_s)
-          self.mapped_sort_fields = mapped_keys.with_indifferent_access
+          self.sorts = keys.map do |field|
+            Warped::Sort.new(field)
+          end
+
+          self.sorts += mapped_keys.map do |field, opts|
+            Warped::Sort.new(field, alias_name: opts[:alias_name])
+          end
+
+          return if self.sorts.any? { |sort| sort.name == default_sort.name }
+
+          self.sorts.push(default_sort)
         end
       end
 
       # @param scope [ActiveRecord::Relation] The scope to sort.
-      # @param sort_key [String, Symbol] The sort key.
-      # @param sort_direction [String, Symbol] The sort direction.
+      # @param sort_conditions [Array<Warped::Sort::Base>|nil] The sort conditions.
       # @return [ActiveRecord::Relation]
-      def sort(scope, sort_key: self.sort_key, sort_direction: self.sort_direction)
-        return scope unless sort_key && sort_direction
-
-        validate_sort_key!
+      def sort(scope, sort_conditions: nil)
+        action_sorts = sort_conditions.presence || sorts
+        @current_action_sorts = action_sorts
 
-        Queries::Sort.call(scope, sort_key:, sort_direction:)
+        Queries::Sort.call(scope, sort_key: current_action_sort_value.name,
+                                  sort_direction: current_action_sort_value.direction)
       end
 
-      protected
+      # @return [Warped::Sort::Value] The current sort value.
+      def current_action_sort_value
+        @current_action_sort_value ||= begin
+          sort_obj = current_action_sorts.find do |sort|
+            params[:sort_key] == sort.parameter_name
+          end
 
-      # @return [Symbol] The sort direction.
-      def sort_direction
-        @sort_direction ||= params[:sort_direction] || default_sort_direction
+          if sort_obj.present?
+            Sort::Value.new(sort_obj, params[:sort_direction] || default_sort_direction)
+          else
+            Sort::Value.new(default_sort, default_sort_direction)
+          end
+        end
       end
 
-      def sort_key
-        @sort_key ||= mapped_sort_fields.key(params[:sort_key]).presence ||
-                      params[:sort_key] ||
-                      default_sort_key
+      protected
+
+      # @param exception [Sort::DirectionError]
+      def render_invalid_sort_direction(exception)
+        render json: { error: exception.message }, status: :bad_request
       end
 
       private
 
-      def validate_sort_key!
-        return if valid_sort_key?
+      # @return [Warped::Sort] The current sort object.
+      def current_sort
+        @current_sort ||= begin
+          sort_obj = sorts.find do |sort|
+            params[:sort_key] == sort.parameter_name
+          end
 
-        possible_values = sort_fields + mapped_sort_fields.values
-        message = "Invalid sort key: #{sort_key}, must be one of #{possible_values}"
-        raise ActionController::BadRequest, message
-      end
-
-      def valid_sort_key?
-        sort_key == default_sort_key ||
-          sort_fields.include?(sort_key) ||
-          mapped_sort_fields[sort_key].present?
+          sort_obj.presence || Warped::Sort.new(default_sort_key)
+        end
       end
     end
   end

data/lib/warped/controllers/tabulatable/ui.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Warped
+  module Controllers
+    module Tabulatable
+      module Ui
+        extend ActiveSupport::Concern
+
+        include Tabulatable
+        include Filterable::Ui
+        include Pageable::Ui
+        include Searchable::Ui
+        include Sortable::Ui
+
+        included do
+          helper_method :tabulation, :tabulate_url_params, :tabulate_query
+        end
+
+        # @return [Hash]
+        def tabulation
+          {
+            filters:,
+            current_filters:,
+            sorts:,
+            current_sorts:,
+            search_term:,
+            search_param:,
+            pagination:
+          }
+        end
+
+        # @param options [Hash] Additional hash of options to include in the tabulation url_params
+        # @return [Hash] The tabulation url_params
+        def tabulate_url_params(**options)
+          base = paginate_url_params
+          base.merge!(search_url_params)
+          base.merge!(sort_url_params)
+          base.merge!(filter_url_params)
+          base.merge!(options)
+
+          base.tap(&:compact_blank!)
+        end
+
+        # @param options [Hash] Additional hash of options to include in the tabulation query
+        # @return [String] The tabulation query string
+        def tabulate_query(**options)
+          tabulate_url_params(**options).to_query
+        end
+      end
+    end
+  end
+end

data/lib/warped/controllers/tabulatable.rb

@@ -13,12 +13,12 @@ module Warped
     #   class UsersController < ApplicationController
     #     include Tabulatable
     #
-    #     tabulatable_by :name, :email, :age, 'posts.created_at', 'posts.id' => 'post_id'
+    #     tabulatable_by :email, :age, 'posts.created_at', 'posts.id' => { alias_name: 'post_id', kind: :integer }
     #
     #     def index
     #       users = User.left_joins(:posts).group(:id)
     #       users = tabulate(users)
-    #       render json: users, meta: tabulate_info
+    #       render json: users, meta: tabulation
     #     end
     #   end
     #
@@ -31,35 +31,32 @@ module Warped
     #   class PostsController < ApplicationController
     #     include Tabulatable
     #
-    #     tabulatable_by :title, :content, :created_at, user: 'users.name'
-    #     filterable_by :created_at, user: 'users.name'
+    #     tabulatable_by :title, :content, :created_at, user: { alias_name: 'users.name' }
+    #     filterable_by :created_at, user: { alias_name: 'users.name' }
     #
     #     def index
     #       posts = Post.left_joins(:user).group(:id)
     #       posts = tabulate(posts)
-    #       render json: posts, meta: tabulate_info
+    #       render json: posts, meta: tabulation
     #     end
     #   end
     module Tabulatable
       extend ActiveSupport::Concern
 
-      included do
-        include Filterable
-        include Sortable
-        include Searchable
-        include Pageable
+      include Filterable
+      include Sortable
+      include Searchable
+      include Pageable
 
+      included do
         class_attribute :tabulate_fields, default: []
-        class_attribute :mapped_tabulate_fields, default: []
+        class_attribute :mapped_tabulate_fields, default: {}
       end
 
       class_methods do
         def tabulatable_by(*keys, **mapped_keys)
-          self.tabulate_fields = keys
-          self.mapped_tabulate_fields = mapped_keys.to_a
-
-          filterable_by(*keys, **mapped_keys) if filter_fields.empty? && mapped_filter_fields.empty?
-          sortable_by(*keys, **mapped_keys) if sort_fields.empty? && mapped_sort_fields.empty?
+          filterable_by(*keys, **mapped_keys) if filters.empty?
+          sortable_by(*keys, **mapped_keys) if sorts.empty?
         end
       end
 
@@ -75,17 +72,6 @@ module Warped
         scope = sort(scope)
         paginate(scope)
       end
-
-      # @return [Hash]
-      def tabulate_info
-        {
-          filters: filter_conditions(*filter_fields, *mapped_filter_fields),
-          sorts: sort_conditions(*sort_fields, *mapped_sort_fields),
-          search_term:,
-          search_param:,
-          page_info:
-        }
-      end
     end
   end
 end

data/lib/warped/emails/components/align.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Warped
+  module Emails
+    class Align < Base
+      variant do
+        base { ["text-align: #{@align}"] }
+      end
+
+      def initialize(align: :left)
+        super()
+        @align = align
+        raise ArgumentError, "Invalid alignment: #{align}" unless %i[left center right].include?(align)
+      end
+
+      def template
+        tag.div(content, style:)
+      end
+    end
+  end
+end

data/lib/warped/emails/components/base.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/delegation"
+require "action_view/helpers"
+
+module Warped
+  module Emails
+    ##
+    # Base class for all email components
+    #
+    # This class provides a number of helper methods for building email components.
+    #
+    # == Usage
+    #
+    # To create a new component, you can subclass this class and implement the +template+ method.
+    #
+    #   class MyComponent < Warped::Emails::Base
+    #     def template
+    #       content_tag(:div, "Hello, World!")
+    #     end
+    #   end
+    #
+    # You can then render the component using the +render+ method in your mailer views
+    #
+    #   <%= render MyComponent.new %>
+    #
+    # == Variants
+    #
+    # Components can define variants using the +variant+ method. Variants are different styles for the component that
+    # can be used to change the appearance of the component.
+    #
+    #   class MyComponent < Warped::Emails::Base
+    #     variant do
+    #       base { "color: red;" }
+    #       size do
+    #         sm { "font-size: 12px;" }
+    #         md { "font-size: 16px;" }
+    #         lg { "font-size: 20px;" }
+    #       end
+    #     end
+    #
+    #     default_variant size: :md
+    #
+    #     def initialize(size: nil)
+    #       super()
+    #       @size = size
+    #     end
+    #
+    #     def template
+    #       content_tag(:div, style: style())
+    #     end
+    #   end
+    #
+    # You can then specify the variant to use using the +style+ method in your component
+    #
+    #   <%= render MyComponent.new %>            # => <div style="color: red; font-size: 16px;"></div>
+    #   <%= render MyComponent.new(size: :lg) %> # => <div style="color: red; font-size: 20px;"></div>
+    #
+    # The variant blocks can return either a string or an array of strings. If an array is returned,
+    # the strings will be joined with a semi-colon.
+    #
+    # The +default_variant+ method can be used to specify the default variant to use if none is specified.
+    #
+    # The +style+ method can be used to apply the variant styles to the component, or to apply additional styles on
+    # top of the variant styles.
+    #
+    # == Slots
+    #
+    # Components can define slots using the +slot+ method. Slots are placeholders for content that can be passed
+    # in from the outside.
+    #
+    #   class MyComponent < Warped::Emails::Base
+    #     slot :title
+    #
+    #     def template
+    #       content_tag(:div, title)
+    #     end
+    #   end
+    #
+    # You can then pass content to the slot using the +with_<slot_name>+ method in your mailer views
+    #   <%= render MyComponent.new do |my_component| %>
+    #     <% my_component.with_title("Hello, World!") %>
+    #   <% end %>
+    class Base
+      include ActionView::Helpers::CaptureHelper
+      include Slottable
+      include Styleable
+
+      attr_reader :view_context
+
+      delegate :capture, :tag, :content_tag, to: :view_context
+      delegate_missing_to :view_context
+
+      def template
+        raise NotImplementedError
+      end
+
+      def content
+        @content_block
+      end
+
+      def helpers
+        return view_context if view_context.present?
+
+        raise ArgumentError, "helpers cannot be used during initialization, as it depends on the view context"
+      end
+
+      def render_in(view_context, &block)
+        @view_context = view_context
+
+        @content_block = capture { block.call(self) } if block_given?
+        template
+      end
+    end
+  end
+end

data/lib/warped/emails/components/button.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Warped
+  module Emails
+    class Button < Base
+      variant do
+        base do
+          ["font-weight: 400",
+           "color: #333",
+           "text-decoration: none",
+           "display: inline-block",
+           "padding: 10px 20px",
+           "border-radius: 4px",
+           "border: 1px solid #ccc",
+           "background-color: #f4f4f4",
+           "color: #fff"]
+        end
+
+        type do
+          primary { ["background-color: #3498db", "border-color: #3498db"] }
+          success { ["background-color: #2ecc71", "border-color: #2ecc71"] }
+          warning { ["background-color: #f39c12", "border-color: #f39c12"] }
+          danger  { ["background-color: #e74c3c", "border-color: #e74c3c"] }
+        end
+
+        size do
+          sm { ["font-size: 13px", "padding: 6px 16px", "line-height: 16px"] }
+          md { ["font-size: 16px", "padding: 8px 24px", "line-height: 20px"] }
+          lg { ["font-size: 19px", "padding: 16px 28px", "line-height: 24px"] }
+        end
+      end
+
+      default_variant type: :primary, size: :md
+
+      def initialize(text = nil, href, type: :primary, size: :md)
+        super()
+        @text = text
+        @href = href
+        @type = type
+        @size = size
+      end
+
+      def text
+        content.presence || @text
+      end
+
+      def template
+        style = style(type:, size:)
+
+        tag.a(text, href:, style:)
+      end
+
+      private
+
+      attr_reader :href, :type, :size
+    end
+  end
+end

data/lib/warped/emails/components/divider.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Warped
+  module Emails
+    class Divider < Base
+      variant do
+        base { "border: none; border-top: 1px solid #ddd; margin: 20px 0;" }
+      end
+
+      def template
+        tag.hr(style:)
+      end
+    end
+  end
+end

data/lib/warped/emails/components/heading.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Warped
+  module Emails
+    class Heading < Base
+      variant do
+        base { ["font-weight: 400"] }
+
+        level do
+          h1 { ["font-size: 45px", "line-height: 50px"] }
+          h2 { ["font-size: 40px", "line-height: 45px"] }
+          h3 { ["font-size: 35px", "line-height: 40px"] }
+          h4 { ["font-size: 30px", "line-height: 35px"] }
+          h5 { ["font-size: 25px", "line-height: 30px"] }
+          h6 { ["font-size: 20px", "line-height: 25px"] }
+        end
+
+        align do
+          left   { "text-align: left" }
+          center { "text-align: center" }
+          right  { "text-align: right" }
+        end
+
+        color do
+          regular     { "color: #14181F" }
+          placeholder { "color: #8B939F" }
+          info        { "color: #1C51A4" }
+          success     { "color: #60830D" }
+          warning     { "color: #82620F" }
+          error       { "color: #AB2816" }
+        end
+
+        weight do
+          regular  { "font-weight: 400" }
+          bold     { "font-weight: 700" }
+        end
+      end
+
+      default_variant level: :h1, align: :center, color: :regular, weight: :regular
+
+      def initialize(text = nil, level: nil, align: nil, color: nil, weight: nil)
+        super()
+        @text = text
+        @level = level
+        @align = align
+        @color = color
+        @weight = weight
+      end
+
+      def text
+        content.presence || @text
+      end
+
+      def template
+        style = style(level:, align:, color:, weight:)
+
+        tag.send(level, text, style:)
+      end
+
+      private
+
+      attr_reader :level, :align, :color, :weight
+    end
+  end
+end

data/lib/warped/emails/components/layouts/columns.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Warped
+  module Emails
+    module Layouts
+      class Columns < Base
+        variant do
+          base { ["display: inline"] }
+        end
+
+        variant :col do
+          base do
+            [
+              "width: #{(100 / cols.size.to_f).round(4)}%",
+              "display: inline-block",
+              "vertical-align: top",
+              "text-align: center"
+            ]
+          end
+        end
+
+        slots_many :cols
+
+        def template
+          tag.div(style:) do
+            capture do
+              cols.map do |col|
+                concat tag.div(col, style: style(:col))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/warped/emails/components/layouts/cta.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Warped
+  module Emails
+    module Layouts
+      class Cta < Base
+        variant :card do
+          base do
+            [
+              "border-collapse: unset", "width: 100%", "border-spacing: 0",
+              "border-radius: 8px", "border: 2px solid #ddd", "padding: 20px"
+            ]
+          end
+        end
+
+        slots_one :title
+        slots_one :body
+        slots_one :button
+
+        def template
+          tag.table(style: style(:card)) do
+            tag.tbody do
+              tag.tr do
+                tag.td(style:) do
+                  concat title
+                  concat render(Spacer.new)
+                  concat body
+                  concat render(Spacer.new)
+                  concat button
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end