super 0.0.11 → 0.0.16

data/lib/super/pagination.rb

@@ -55,7 +55,7 @@ module Super
     end
 
     def to_partial_path
-      "super_pagination"
+      "pagination"
     end
 
     private
@@ -76,52 +76,10 @@ module Super
     module ControllerMethods
       def index
         super
-        @pagination = controls.initialize_pagination(action: action_inquirer, records: @records, query_params: request.GET)
-        @records = controls.paginate_records(action: action_inquirer, records: @records, pagination: @pagination)
+        @pagination = initialize_pagination
+        @records = paginate_records
         @view.mains.first.parts.push(:@pagination)
       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

@@ -26,7 +26,7 @@ module Super
     end
 
     def to_partial_path
-      "super_panel"
+      "panel"
     end
   end
 end

data/lib/super/reset.rb

@@ -0,0 +1,22 @@
+# 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
+
+      Super::SubstructureController.private_instance_methods(false).each do |imethod|
+        next if imethod == :navigation
+        undef_method imethod
+      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,5 +1,5 @@
 # frozen_string_literal: true
 
 module Super
-  VERSION = "0.0.11"
+  VERSION = "0.0.16"
 end

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.controller
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.16
 platform: ruby
 authors:
 - Zach Ahn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -220,61 +220,50 @@ 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
 - app/controllers/super/application_controller.rb
+- app/controllers/super/substructure_controller.rb
 - 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/_pagination.html.erb
+- app/views/super/application/_panel.html.erb
 - app/views/super/application/_query.html.erb
+- app/views/super/application/_site_footer.html.erb
+- app/views/super/application/_site_header.html.erb
 - app/views/super/application/_sort.html.erb
 - app/views/super/application/_sort_expression.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/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
@@ -294,14 +283,11 @@ 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
@@ -320,23 +306,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:

data/CONTRIBUTING.md

@@ -1,56 +0,0 @@
-# Contributing
-
-Thank you for thinking about contributing to Super!
-
-
-## General guidelines
-
-There are a few ground rules that to adhere to:
-
-* be friendly and patient,
-* be welcoming,
-* be considerate,
-* be respectful,
-* be careful in the words that you choose and be kind to others,
-* when we disagree, try to understand why.
-
-This isn't an exhaustive list of things that you can't do. Rather, take it in
-the spirit in which it's intended - a guide to make it easier to communicate and
-participate in the community.
-
-This applies to all spaces managed by the Super project.
-
-If you believe someone is violating the code of conduct, we ask that you report
-it by emailing: super+conduct at zachahn.com
-
-Offenders may be banned, asked to apologize, etc.
-
-(These guidelines are based on the [FreeBSD CoC][FreeBSD CoC], which in turn is
-based on [LLVM Project's draft CoC][LLVM CoC], which in turn is based on the
-[Django Project Code of Conduct][Django CoC], which is in turn based on wording
-from the Speak Up! project.)
-
-
-## Bug reports / issues
-
-1. Please tell us what version of Super, Ruby, and Rails you are using
-1. Please search the issues before posting your problem
-1. Please ask questions in a public place to benefit all Super users
-1. Please email security-related problems to super+security [at] zachahn.com
-
-
-## Feature requests / pull requests
-
-Contributors will need to sign a CLA. This isn't set up yet, so I won't be able
-to accept contributions.
-
-1. Please note that pull requests may be closed/denied for any reason.
-   Your feature may be better as its own repository. If so, I will link to your
-   project from the README!
-1. Please allow Super's contributors to modify your PR before merging.
-   It might make the process a bit smoother, but this isn't a necessity.
-
-
-[FreeBSD CoC]: https://www.freebsd.org/internal/code-of-conduct.html
-[LLVM CoC]: https://llvm.org/docs/CodeOfConduct.html
-[Django CoC]: https://www.djangoproject.com/conduct/

data/Rakefile

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-begin
-  require "bundler/setup"
-rescue LoadError
-  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
-end
-
-require "rdoc/task"
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title    = "Super"
-  rdoc.options << "--line-numbers"
-  rdoc.rdoc_files.include("README.md")
-  rdoc.rdoc_files.include("lib/**/*.rb")
-end
-
-require_relative "dummy_path"
-
-APP_RAKEFILE = File.expand_path("#{SUPER_DUMMY_PATH}/Rakefile", __dir__)
-load "rails/tasks/engine.rake"
-
-load "rails/tasks/statistics.rake"
-
-require "bundler/gem_tasks"
-
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.verbose = false
-end
-
-task default: :test

data/STABILITY.md

@@ -1,50 +0,0 @@
-# Stability
-
-The table below shows the current progress towards API stability and the release
-of version 1.0.
-
-Note though that it is neither a comprehensive list nor a guarantee of
-stability.
-
-
-<table>
-<thead>
-<tr><th>Feature</th><th>Status</th></tr>
-</thead>
-<tbody>
-<tr><td>UI</td>                                             <td>❌</td></tr>
-<tr><td>Frontend JS</td>                                    <td>❌</td></tr>
-<tr><td><code>Super::ActionInquirer</code></td>             <td>✅</td></tr>
-<tr><td><code>Super::ApplicationController</code></td>      <td>✅</td></tr>
-<tr><td><code>Super::Assets</code></td>                     <td>🚧</td></tr>
-<tr><td><code>Super::ClientError</code></td>                <td>✅</td></tr>
-<tr><td><code>Super::Compatability</code></td>              <td>🙈</td></tr>
-<tr><td><code>Super::Configuration</code></td>              <td>🚧</td></tr>
-<tr><td><code>Super::Controls::Optional</code></td>         <td>✅</td></tr>
-<tr><td><code>Super::Controls::Required</code></td>         <td>✅</td></tr>
-<tr><td><code>Super::Controls::Steps</code></td>            <td>🚧</td></tr>
-<tr><td><code>Super::Controls</code></td>                   <td>✅</td></tr>
-<tr><td><code>Super::Display</code></td>                    <td>🤔</td></tr>
-<tr><td><code>Super::Engine</code></td>                     <td>🙈</td></tr>
-<tr><td><code>Super::Error</code></td>                      <td>✅</td></tr>
-<tr><td><code>Super::Filter</code></td>                     <td>❌</td></tr>
-<tr><td><code>Super::Form</code></td>                       <td>🤔</td></tr>
-<tr><td><code>Super::Layout</code></td>                     <td>🤔</td></tr>
-<tr><td><code>Super::Link</code></td>                       <td>✅</td></tr>
-<tr><td><code>Super::Navigation</code></td>                 <td>🤔</td></tr>
-<tr><td><code>Super::Pagination</code></td>                 <td>🤔</td></tr>
-<tr><td><code>Super::Panel</code></td>                      <td>🤔</td></tr>
-<tr><td><code>Super::Partial</code></td>                    <td>🤔</td></tr>
-<tr><td><code>Super::Plugin</code></td>                     <td>✅</td></tr>
-<tr><td><code>Super::ViewHelper</code></td>                 <td>❌</td></tr>
-</tbody>
-</table>
-
-
-### Legend
-
-* ✅ Tentatively stable. Further changes will probably be additive
-* 🚧 Likely upcoming breaking changes
-* ❌ Planned upcoming breaking changes
-* 🤔 Undecided
-* 🙈 Private API