super 0.0.10 → 0.0.15

data/lib/super/pagination.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Pagination
     include Enumerable
@@ -53,7 +55,7 @@ module Super
     end
 
     def to_partial_path
-      "super_pagination"
+      "pagination"
     end
 
     private
@@ -80,46 +82,4 @@ module Super
       end
     end
   end
-
-  class Controls
-    module Optional
-      # Specifies how many records to show per page
-      #
-      # @param action [ActionInquirer]
-      # @param query_params [Hash]
-      # @return [ActiveRecord::Relation]
-      def records_per_page(action:, query_params:)
-        Super.configuration.index_records_per_page
-      end
-    end
-
-    module Steps
-      # Sets up pagination
-      #
-      # @param action [ActionInquirer]
-      # @param records [ActiveRecord::Relation]
-      # @param query_params [Hash]
-      # @return [Pagination]
-      def initialize_pagination(action:, records:, query_params:)
-        Pagination.new(
-          total_count: records.size,
-          limit: records_per_page(action: action, query_params: query_params),
-          query_params: query_params,
-          page_query_param: :page
-        )
-      end
-
-      # Paginates
-      #
-      # @param action [ActionInquirer]
-      # @param records [ActiveRecord::Relation]
-      # @param pagination [Pagination]
-      # @return [ActiveRecord::Relation]
-      def paginate_records(action:, records:, pagination:)
-        records
-          .limit(pagination.limit)
-          .offset(pagination.offset)
-      end
-    end
-  end
 end

data/lib/super/panel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "super/partial/resolving"
 
 module Super
@@ -24,7 +26,7 @@ module Super
     end
 
     def to_partial_path
-      "super_panel"
+      "panel"
     end
   end
 end

data/lib/super/partial.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Partial
     def self.render(partialish, template:)

data/lib/super/partial/resolving.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Partial
     module Resolving

data/lib/super/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   module Plugin
     class Registry

data/lib/super/query/form_object.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Super
+  class Query
+    class FormObject
+      def initialize(model:, params:, namespace:, current_path:)
+        @model = model
+        @all_params = params.dup
+        @namespace = namespace
+        @params = params[namespace] || ActionController::Parameters.new
+        @path = current_path
+        @addons = {}
+      end
+
+      attr_reader :namespace
+      attr_reader :path
+      attr_reader :addons
+
+      def add(klass, namespace:, **additional_initialization_arguments)
+        instance = klass.new(
+          model: @model,
+          params: params_dig(namespace),
+          **additional_initialization_arguments
+        )
+
+        addons[namespace] = instance
+      end
+
+      def apply_changes(records)
+        addons.each_value do |addon|
+          records = addon.apply_changes(records)
+        end
+
+        records
+      end
+
+      def to_partial_path
+        "query"
+      end
+
+      private
+
+      def params_dig(*keys)
+        @params.dig(*keys) || ActionController::Parameters.new
+      end
+    end
+  end
+end

data/lib/super/reset.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Super
+  module Reset
+    extend ActiveSupport::Concern
+
+    included do
+      undef_method :index
+      undef_method :show
+      undef_method :new
+      undef_method :create
+      undef_method :edit
+      undef_method :update
+      undef_method :destroy
+    end
+  end
+end

data/lib/super/schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   # The Schema is a general purpose container for describing the "schema"
   # for various purposes. It primarily exists to provide a cohesive user-facing

data/lib/super/schema/common.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Schema
     module Common

data/lib/super/schema/guesser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Schema
     class Guesser

data/lib/super/sort.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Super
+  module Sort
+    class FormObject
+      DIRECTIONS = ["asc", "desc"]
+
+      def initialize(model:, params:, default:, sortable_columns:)
+        @model = model
+        @params = params.dup
+        @default = default
+        @sortable_columns = sortable_columns.map(&:to_s)
+
+        @params.permit!
+      end
+
+      attr_reader :sortable_columns
+
+      def to_partial_path
+        "sort"
+      end
+
+      def exprs
+        sanitized_expr_params.map { |ordering| Expression.new(**ordering) }
+      end
+
+      def new_expr
+        Expression.new(a: nil, d: :desc)
+      end
+
+      class Expression
+        attr_accessor :a # attribute
+        attr_accessor :d # direction
+
+        def initialize(a:, d:)
+          @a = a
+          @d = d.to_s
+        end
+
+        def with_index(index)
+          @index = index
+          self
+        end
+
+        # This is for `fields_for` to work
+        def id
+          @index
+        end
+
+        def persisted?
+          false
+        end
+      end
+
+      def persisted?
+        false
+      end
+
+      def apply_changes(query)
+        exprs.each do |expr|
+          query = query.order(expr.a => expr.d)
+        end
+
+        query
+      end
+
+      private
+
+      # Stringifies the values
+      def sanitized_expr_params
+        seen = {}
+        normalized_expr_params
+          .each do |p|
+            p[:a] = p[:a].presence&.to_s&.strip
+            p[:d] = p[:d].presence&.to_s&.strip
+          end
+          .select { |p| p[:a].present? && DIRECTIONS.include?(p[:d]) }
+          .select { |p| @sortable_columns.include?(p[:a]) }
+          .select do |p|
+            next false if seen.key?(p[:a])
+
+            seen[p[:a]] = true
+            true
+          end
+      end
+
+      # Symbolizes the keys
+      def normalized_expr_params
+        from_params = @params[:exprs]
+
+        return default_as_query if from_params.nil?
+
+        if from_params.is_a?(Array)
+          return from_params.map(&:to_h).map(&:symbolize_keys)
+        end
+
+        from_params.to_h.values.map(&:symbolize_keys)
+      end
+
+      def default_as_query
+        @default.map do |attribute_name, direction|
+          {
+            a: attribute_name,
+            d: direction,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/super/useful/builder.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Super
+  module Useful
+    module Builder
+      def builder(method_name)
+        alias_method("original_#{method_name}", method_name)
+
+        define_method(method_name) do |*args|
+          send("original_#{method_name}", *args)
+          self
+        end
+      end
+
+      def builder_with_block(method_name)
+        alias_method("original_#{method_name}", method_name)
+
+        define_method(method_name) do |*args, &block|
+          send("original_#{method_name}", *args, &block)
+          self
+        end
+      end
+    end
+  end
+end

data/lib/super/useful/enum.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Super
+  module Useful
+    class Enum
+      def initialize(*choices)
+        @choices = choices.flatten.map { |choice| [choice, nil] }.to_h
+      end
+
+      def case(chosen)
+        Case.new(@choices, chosen)
+      end
+
+      class Case
+        def initialize(choices, chosen)
+          if !choices.key?(chosen)
+            raise Error::Enum::ImpossibleValue,
+              "`#{chosen}` isn't in: #{choices.keys.map(&:inspect).join(", ")}"
+          end
+
+          @choices = choices
+          @chosen = chosen
+          @whens = {}
+        end
+
+        def when(*keys, &block)
+          if !block_given?
+            raise Error::ArgumentError, "must receive block"
+          end
+
+          keys.each do |key|
+            if !@choices.key?(key)
+              raise Error::Enum::ImpossibleValue, "`#{key.inspect}` is not a possibility"
+            end
+
+            @whens[key] = block
+          end
+
+          self
+        end
+
+        def result
+          if @choices.size != @whens.size
+            missing_keys = @choices.keys - @whens.keys
+            raise Error::Enum::UndefinedCase, "Unset cases: #{missing_keys.join(", ")}"
+          end
+
+          @whens[@chosen].call(@value)
+        end
+
+        private
+
+        def matching_possibilities_and_checks?
+          if @whens.size == @choices.size
+            return true
+          end
+
+          false
+        end
+      end
+    end
+  end
+end

data/lib/super/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
-  VERSION = "0.0.10"
+  VERSION = "0.0.15"
 end

data/lib/super/view_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   module ViewHelper
     module_function

data/lib/tasks/super/cheat.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :super do
+  task :cheat do
+    require "super/cheat"
+    cheat = Super::Cheat.new
+    cheat.controls
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.15
 platform: ruby
 authors:
 - Zach Ahn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-17 00:00:00.000000000 Z
+date: 2021-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -198,6 +198,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - engineering@zachahn.com
@@ -206,11 +220,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
-- CONTRIBUTING.md
 - LICENSE
 - README.md
-- Rakefile
-- STABILITY.md
 - app/assets/config/super_manifest.js
 - app/assets/javascripts/super/application.js
 - app/assets/stylesheets/super/application.css
@@ -218,45 +229,38 @@ files:
 - app/helpers/super/form_builder_helper.rb
 - app/views/layouts/super/application.html.erb
 - app/views/super/application/_collection_header.html.erb
+- app/views/super/application/_display_actions.html.erb
+- app/views/super/application/_display_index.html.erb
 - app/views/super/application/_display_rich_text.html.erb
+- app/views/super/application/_display_show.html.erb
 - app/views/super/application/_filter.html.erb
 - app/views/super/application/_filter_type_select.html.erb
 - app/views/super/application/_filter_type_text.html.erb
 - app/views/super/application/_filter_type_timestamp.html.erb
 - app/views/super/application/_flash.html.erb
+- app/views/super/application/_form.html.erb
+- app/views/super/application/_form_field.html.erb
 - app/views/super/application/_form_field__destroy.html.erb
-- app/views/super/application/_form_field_checkbox.html.erb
-- app/views/super/application/_form_field_rich_text_area.html.erb
 - app/views/super/application/_form_field_select.html.erb
-- app/views/super/application/_form_field_text.html.erb
 - app/views/super/application/_form_fieldset.html.erb
 - app/views/super/application/_form_has_many.html.erb
 - app/views/super/application/_form_has_one.html.erb
+- app/views/super/application/_layout.html.erb
 - app/views/super/application/_member_header.html.erb
-- app/views/super/application/_super_layout.html.erb
-- app/views/super/application/_super_pagination.html.erb
-- app/views/super/application/_super_panel.html.erb
-- app/views/super/application/_super_schema_display_actions.html.erb
-- app/views/super/application/_super_schema_display_index.html.erb
-- app/views/super/application/_super_schema_display_show.html.erb
-- app/views/super/application/_super_schema_form.html.erb
+- app/views/super/application/_pagination.html.erb
+- app/views/super/application/_panel.html.erb
+- app/views/super/application/_query.html.erb
+- app/views/super/application/_sort.html.erb
+- app/views/super/application/_sort_expression.html.erb
 - app/views/super/application/edit.html.erb
 - app/views/super/application/index.html.erb
 - app/views/super/application/new.html.erb
 - app/views/super/application/nothing.html.erb
 - app/views/super/application/show.html.erb
 - app/views/super/feather/README.md
-- app/views/super/feather/_chevron_down.html
+- app/views/super/feather/_x.html
 - config/locales/en.yml
 - config/routes.rb
-- docs/README.md
-- docs/action_text.md
-- docs/cheat.md
-- docs/faq.md
-- docs/installation.md
-- docs/quick_start.md
-- docs/webpacker.md
-- docs/yard_customizations.rb
 - frontend/super-frontend/dist/application.css
 - frontend/super-frontend/dist/application.js
 - lib/generators/super/action_text/USAGE
@@ -276,13 +280,15 @@ files:
 - lib/super.rb
 - lib/super/action_inquirer.rb
 - lib/super/assets.rb
+- lib/super/badge.rb
+- lib/super/cheat.rb
 - lib/super/client_error.rb
 - lib/super/compatibility.rb
 - lib/super/configuration.rb
 - lib/super/controls.rb
 - lib/super/controls/optional.rb
-- lib/super/controls/required.rb
 - lib/super/controls/steps.rb
+- lib/super/controls/view.rb
 - lib/super/display.rb
 - lib/super/display/guesser.rb
 - lib/super/display/schema_types.rb
@@ -292,7 +298,6 @@ files:
 - lib/super/filter/form_object.rb
 - lib/super/filter/guesser.rb
 - lib/super/filter/operator.rb
-- lib/super/filter/plugin.rb
 - lib/super/filter/schema_types.rb
 - lib/super/form.rb
 - lib/super/form/builder.rb
@@ -302,21 +307,33 @@ files:
 - lib/super/form/strong_params.rb
 - lib/super/layout.rb
 - lib/super/link.rb
-- lib/super/navigation/automatic.rb
+- lib/super/link_builder.rb
+- lib/super/navigation.rb
 - lib/super/pagination.rb
 - lib/super/panel.rb
 - lib/super/partial.rb
 - lib/super/partial/resolving.rb
 - lib/super/plugin.rb
+- lib/super/query/form_object.rb
+- lib/super/reset.rb
 - lib/super/schema.rb
 - lib/super/schema/common.rb
 - lib/super/schema/guesser.rb
+- lib/super/sort.rb
+- lib/super/useful/builder.rb
+- lib/super/useful/enum.rb
 - lib/super/version.rb
 - lib/super/view_helper.rb
+- lib/tasks/super/cheat.rake
 homepage:
 licenses:
 - LGPL-3.0-only
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/zachahn/super/issues
+  changelog_uri: https://github.com/zachahn/super/blob/main/CHANGELOG.md
+  documentation_uri: https://superadministration.github.io/
+  homepage_uri: https://github.com/zachahn/super
+  source_code_uri: https://github.com/zachahn/super
 post_install_message:
 rdoc_options: []
 require_paths: