sail 3.2.3 → 3.5.1

data/app/controllers/sail/settings_controller.rb

@@ -10,15 +10,12 @@ module Sail
   class SettingsController < ApplicationController
     before_action :set_locale, only: :index
     after_action :log_update, only: %i[update reset], if: -> { Sail.configuration.enable_logging && @successful_update }
-
-    # rubocop:disable AbcSize
     def index
       @settings = Setting.by_query(s_params[:query]).ordered_by(s_params[:order_field])
-      @number_of_pages = (@settings.count.to_f / settings_per_page).ceil
-      @settings = @settings.paginated(s_params[:page], settings_per_page)
+      @number_of_pages = (@settings.count.to_f / Sail::ConstantCollection::SETTINGS_PER_PAGE).ceil
+      @settings = @settings.paginated(s_params[:page], Sail::ConstantCollection::SETTINGS_PER_PAGE)
       fresh_when(@settings)
     end
-    # rubocop:enable AbcSize
 
     def update
       respond_to do |format|
@@ -65,14 +62,6 @@ module Sail
 
     private
 
-    def settings_per_page
-      if params[:monitor_mode] == Sail::ConstantCollection::TRUE
-        Sail::ConstantCollection::MINIMAL_SETTINGS_PER_PAGE
-      else
-        Sail::ConstantCollection::SETTINGS_PER_PAGE
-      end
-    end
-
     def s_params
       params.permit(:page, :query, :name,
                     :value, :positive, :negative,

data/app/helpers/sail/application_helper.rb

@@ -9,5 +9,9 @@ module Sail
     def formatted_date(setting)
       DateTime.parse(setting.value).utc.strftime(Sail::ConstantCollection::INPUT_DATE_FORMAT)
     end
+
+    def settings_container_class(number_of_pages)
+      number_of_pages.zero? ? "empty" : ""
+    end
   end
 end

data/app/models/sail/setting.rb

@@ -11,7 +11,7 @@ module Sail
     class UnexpectedCastType < StandardError; end
 
     FULL_RANGE = (0...100).freeze
-    AVAILABLE_MODELS = Dir[Rails.root.join("app", "models", "*.rb")]
+    AVAILABLE_MODELS = Dir[Rails.root.join("app/models/*.rb")]
                        .map { |dir| dir.split("/").last.camelize.gsub(".rb", "") }.freeze
 
     has_many :entries, dependent: :destroy
@@ -21,7 +21,7 @@ module Sail
     validates :name, presence: true, uniqueness: { case_sensitive: false }
     enum cast_type: %i[integer string boolean range array float
                        ab_test cron obj_model date uri throttle
-                       locales].freeze
+                       locales set].freeze
 
     validate :value_is_within_range, if: -> { range? }
     validate :value_is_true_or_false, if: -> { boolean? || ab_test? }
@@ -32,11 +32,7 @@ module Sail
 
     after_initialize :instantiate_caster
 
-    scope :paginated, lambda { |page, per_page|
-      select(:name, :description, :group, :value, :cast_type, :updated_at)
-        .offset(page.to_i * per_page)
-        .limit(per_page)
-    }
+    scope :paginated, ->(page, per_page) { offset(page.to_i * per_page).limit(per_page) }
 
     scope :by_query, lambda { |query|
       if cast_types.key?(query) || query == Sail::ConstantCollection::STALE
@@ -44,7 +40,7 @@ module Sail
       elsif select(:id).by_group(query).exists?
         by_group(query)
       elsif query.to_s.include?(Sail::ConstantCollection::RECENT)
-        recently_updated(query.delete("recent ").strip)
+        recently_updated(query.delete("recent ").strip.to_i)
       else
         by_name(query)
       end

data/app/views/layouts/sail/application.html.erb

@@ -21,16 +21,12 @@
     <button id="btn-guide" type="button" class="nav-button">
       <%= I18n.t("sail.guide") %>
     </button>
-
-    <% if params[:monitor_mode] == Sail::ConstantCollection::TRUE %>
-      <%= link_to(I18n.t("sail.regular_mode"), settings_path, method: :get, class: "nav-button", id: "btn-regular-mode") %>
-    <% else %>
-      <%= link_to(I18n.t("sail.monitor_mode"), settings_path(monitor_mode: "true"), method: :get, class: "nav-button", id: "btn-monitor-mode") %>
-    <% end %>
   </nav>
 
   <div class="clearfix"></div>
   <%= yield %>
+
+  <%= hidden_field_tag(:auto_search_enabled, Sail.configuration.enable_search_auto_submit) %>
 </div>
 </body>
 </html>

data/app/views/sail/profiles/_profile.html.erb

@@ -1,31 +1,43 @@
-<div id="<%= profile.name %>" class="profile-entry">
-  <% if profile.active? %>
+<div id="<%= profile.name %>" class="profile-entry flex-container space-between">
+  <div>
+    <% if profile.active? %>
     <span class="active-indicator <%= profile.dirty? ? "yellow" : "green" %>"
           title="<%= profile.dirty? ? I18n.t("sail.dirty_profile_tooltip") : I18n.t("sail.clean_profile_tooltip") %>">
       ⬤
     </span>
 
-    <% unless Sail.instrumenter.profile(profile.name).zero? %>
+      <% unless Sail.instrumenter.profile(profile.name).zero? %>
       <span class="errors-indicator" title="<%= I18n.t("sail.profile_error_tooltip") %>">
         <%= I18n.t("sail.profile_errors", count: Sail.instrumenter.profile(profile.name)) %>
       </span>
+      <% end %>
     <% end %>
-  <% end %>
+  </div>
 
-  <span class="entry-name"><%= profile.name.titleize %></span>
+  <div>
+    <span class="entry-name"><%= profile.name.titleize %></span>
+  </div>
 
-  <%= form_tag(profile_path(name: profile.name), method: :delete, remote: true, class: "inline-form") do %>
-    <button class="btn-sail"><%= I18n.t("sail.delete") %></button>
-  <% end %>
+  <div>
+    <div class="flex-container space-between buttons">
+      <div>
+        <%= form_tag(profile_path(name: profile.name), method: :delete, remote: true) do %>
+          <button class="btn-sail"><%= I18n.t("sail.delete") %></button>
+        <% end %>
+      </div>
 
-  <%= form_tag(switch_profile_path(name: profile.name), method: :put, remote: true, class: "inline-form") do %>
-    <button class="btn-sail" type="submit"><%= I18n.t("sail.activate") %></button>
-  <% end %>
+      <div>
+        <%= form_tag(switch_profile_path(name: profile.name), method: :put, remote: true) do %>
+          <button class="btn-sail" type="submit"><%= I18n.t("sail.activate") %></button>
+        <% end %>
+      </div>
 
-  <%= form_tag(profiles_path, method: :post, remote: true, class: "inline-form") do %>
-    <input type="hidden" name="name" value="<%= profile.name %>">
-    <button class="btn-sail" type="submit"><%= I18n.t("sail.save") %></button>
-  <% end %>
-
-  <div class="clearfix"></div>
+      <div>
+        <%= form_tag(profiles_path, method: :post, remote: true) do %>
+          <input type="hidden" name="name" value="<%= profile.name %>">
+          <button class="btn-sail" type="submit"><%= I18n.t("sail.save") %></button>
+        <% end %>
+      </div>
+    </div>
+  </div>
 </div>

data/app/views/sail/settings/_guide_modal.html.erb

@@ -12,7 +12,6 @@
       </div>
     </summary>
 
-    <p>
       <div class="items-container">
         <ul>
           <li><%= I18n.t("sail.by_setting_name_html").html_safe %></li>
@@ -21,8 +20,9 @@
           <li><%= I18n.t("sail.by_stale_html").html_safe %></li>
           <li><%= I18n.t("sail.by_recent_html").html_safe %></li>
         </ul>
+
+        <p><%= I18n.translate("sail.click_title") %></p>
       </div>
-    </p>
   </details>
   <div class="clearfix"></div>
 

data/app/views/sail/settings/_setting.html.erb

@@ -1,60 +1,90 @@
 <% cache setting, expires_in: Sail.configuration.cache_life_span do %>
   <div class="card">
-    <h3 class="title">
-      <%= setting.display_name %>
-
-      <span class="relevancy-score" title="<%= I18n.t("sail.relevancy_tooltip") %>"><%= setting.relevancy %></span>
-      <div class="clearfix"></div>
-    </h3>
-    <hr/>
-
-    <%= form_tag(reset_setting_path(name: setting.name), method: :put, remote: true) do %>
-      <button class="refresh-button" title="<%= I18n.t("sail.refresh_tooltip") %>">
-        <%= image_tag("sail/refresh.svg", alt: I18n.t("sail.refresh_tooltip")) %>
-      </button>
-    <% end %>
-
-    <div class="label-container">
-      <%= link_to(setting.cast_type, settings_path(query: setting.cast_type), method: :get, class: "tag type-label") %>
-    </div>
+    <div class="front">
+      <h3 class="title card-title"><%= setting.display_name %></h3>
+      <hr/>
 
-    <% if setting.group.present? %>
-      <div class="label-container">
-        <%= link_to(setting.group, settings_path(query: setting.group), method: :get, class: "tag group-label") %>
-      </div>
-    <% end %>
+      <div class="flex-container-vertical">
+        <div>
+          <div class="flex-container space-between">
+            <div>
+              <%= form_tag(reset_setting_path(name: setting.name), method: :put, remote: true) do %>
+                <button class="refresh-button" title="<%= I18n.t("sail.refresh_tooltip") %>">
+                  <%= image_tag("sail/reset.svg", alt: I18n.t("sail.refresh_tooltip")) %>
+                </button>
+              <% end %>
+            </div>
 
-    <div class="clear-xs"></div>
+            <div>
+              <span class="relevancy-score" title="<%= I18n.t("sail.relevancy_tooltip") %>"><%= setting.relevancy %></span>
+            </div>
+          </div>
+        </div>
 
-    <% if setting.stale? %>
-      <div class="label-container">
-        <%= link_to(I18n.t("sail.stale"), settings_path(query: Sail::ConstantCollection::STALE), method: :get, class: "tag stale-label", title: I18n.t("sail.stale_tooltip", days: Sail.configuration.days_until_stale)) %>
-      </div>
-    <% end %>
-
-    <p class="setting-description" title="<%= setting.description %>">
-      <label for="<%= "input_for_#{setting.name}" %>"><%= setting.description %></label>
-    </p>
-
-    <%= form_tag(setting_path(name: setting.name), method: :put, remote: true) do %>
-      <div class="card-body-container">
-        <div class="card-body">
-          <% if setting.boolean? || setting.ab_test? %>
-            <label class="switch">
-              <input id="<%= "input_for_#{setting.name}" %>" type="checkbox" name="value" <%= setting.value == "true" ? "checked" : "" %>>
-              <span class="slider round"></span>
-            </label>
-          <% elsif setting.range? %>
-            <input id="<%= "input_for_#{setting.name}" %>" type="range" min="0" max="99" value="<%= setting.value %>" name="value" class="value-slider">
-          <% elsif setting.date? %>
-            <input id="<%= "input_for_#{setting.name}" %>" type="datetime-local" value="<%= formatted_date(setting) %>" name="value" class="date-picker">
-          <% else %>
-            <input id="<%= "input_for_#{setting.name}" %>" type="text" name="value" class="value-input" value="<%= setting.value %>"/>
-          <% end %>
+        <div>
+          <div class="flex-container justify-end padded">
+            <div>
+              <%= link_to(setting.cast_type, settings_path(query: setting.cast_type), method: :get, class: "tag type-label") %>
+            </div>
+
+            <% if setting.group.present? %>
+              <div>
+                <%= link_to(setting.group, settings_path(query: setting.group), method: :get, class: "tag group-label") %>
+              </div>
+            <% end %>
+
+            <% if setting.stale? %>
+              <div>
+                <%= link_to(I18n.t("sail.stale"), settings_path(query: Sail::ConstantCollection::STALE), method: :get, class: "tag stale-label", title: I18n.t("sail.stale_tooltip", days: Sail.configuration.days_until_stale)) %>
+              </div>
+            <% end %>
+          </div>
+        </div>
 
-          <button type="submit" class="btn-value-submit"><%= I18n.t('sail.save') %></button>
+        <div>
+          <%= form_tag(setting_path(name: setting.name), method: :put, remote: true) do %>
+            <div class="flex-container space-between align-bottom">
+              <% if setting.boolean? || setting.ab_test? %>
+                <div>
+                  <label class="switch">
+                    <input id="<%= "input_for_#{setting.name}" %>" type="checkbox" name="value" <%= setting.value == "true" ? "checked" : "" %>>
+                    <span class="slider round"></span>
+                  </label>
+                </div>
+              <% elsif setting.range? %>
+                <div class="flex-grow">
+                  <input id="<%= "input_for_#{setting.name}" %>" type="range" min="0" max="99" value="<%= setting.value %>" name="value" class="value-slider">
+                </div>
+              <% else %>
+                <div>
+                  <input id="<%= "input_for_#{setting.name}" %>" type="text" name="value" class="value-input" value="<%= setting.value %>"/>
+                </div>
+              <% end %>
+
+              <div class="submit-container">
+                <button id="btn-submit-<%= setting.name %>" type="submit" class="btn-value-submit"><%= I18n.t("sail.save") %></button>
+
+                <span id="success-<%= setting.name %>" class="notice success">
+                  <%= image_tag("sail/checkmark.svg") %>
+                </span>
+
+                <span id="alert-<%= setting.name %>" class="notice alert">
+                  <%= image_tag("sail/error.svg") %>
+                </span>
+              </div>
+            </div>
+          <% end %>
         </div>
       </div>
-    <% end %>
+    </div>
+
+    <div class="back">
+      <h3 class="title card-title"><%= setting.display_name %></h3>
+      <hr/>
+
+      <p class="setting-description" title="<%= setting.description %>">
+        <label for="<%= "input_for_#{setting.name}" %>"><%= setting.description %></label>
+      </p>
+    </div>
   </div>
 <% end %>

data/app/views/sail/settings/index.html.erb

@@ -1,19 +1,10 @@
 <div id="settings-dashboard">
-  <% cache [@settings, params[:monitor_mode]] do %>
-    <span id="notice-success" class="notice success"><%= I18n.t("sail.updated") %></span>
-    <span id="notice-alert" class="notice alert"><%= I18n.t("sail.failed") %></span>
+  <% cache @settings do %>
+    <%= render(partial: "search") %>
 
-    <% unless params[:monitor_mode] == Sail::ConstantCollection::TRUE %>
-      <%= render(partial: "search") %>
-    <% end %>
-
-    <div id="settings-container">
+    <div id="settings-container" class="<%= settings_container_class(@number_of_pages) %>">
       <% if @number_of_pages > 0 %>
-        <% if params[:monitor_mode] == Sail::ConstantCollection::TRUE %>
-          <%= render(partial: "setting_minimal", collection: @settings) %>
-        <% else %>
-          <%= render(partial: "setting", collection: @settings) %>
-        <% end%>
+        <%= render(partial: "setting", collection: @settings) %>
       <% else %>
         <h1><%= I18n.t("sail.no_settings") %></h1>
       <% end %>
@@ -25,13 +16,26 @@
       <div class="clearfix"></div>
 
       <div class="page-links">
-        <%= link_to("", settings_path(page: [params[:page].to_i - 1, 0].max, monitor_mode: params[:monitor_mode]), method: :get, id: "angle-left-link", title: I18n.t("sail.previous_page")) %>
+        <%= link_to("", settings_path(page: [params[:page].to_i - 1, 0].max, query: params[:query]), method: :get, id: "angle-left-link", title: I18n.t("sail.previous_page")) %>
+        <%= link_to(1, settings_path(page: 0, query: params[:query]), method: :get, class: params[:page].to_i.zero? || params[:page].blank? ? "active" : "") %>
+
+        <% if params[:page].to_i - Sail::ConstantCollection::MAX_PAGES > 1 %>
+          ●●●
+        <% end %>
+
+        <% ([params[:page].to_i - Sail::ConstantCollection::MAX_PAGES, 1].max...[@number_of_pages - 1, params[:page].to_i + Sail::ConstantCollection::MAX_PAGES].min).each do |page| %>
+          <%= link_to(page + 1, settings_path(page: page, query: params[:query]), method: :get, class: params[:page].to_i == page || params[:page].blank? && page.zero? ? "active" : "") %>
+        <% end %>
+
+        <% if params[:page].to_i + Sail::ConstantCollection::MAX_PAGES < @number_of_pages - 1 %>
+          ●●●
+        <% end %>
 
-        <% (0...@number_of_pages).each do |page| %>
-          <%= link_to(page + 1, settings_path(page: page, monitor_mode: params[:monitor_mode]), method: :get, class: params[:page].to_i == page || params[:page].blank? && page.zero? ? "active" : "") %>
+        <% if @number_of_pages > 1 %>
+          <%= link_to(@number_of_pages, settings_path(page: @number_of_pages - 1, query: params[:query]), method: :get, class: params[:page].to_i == @number_of_pages - 1 ? "active" : "") %>
         <% end %>
 
-        <%= link_to("", settings_path(page: [params[:page].to_i + 1, @number_of_pages - 1].min, monitor_mode: params[:monitor_mode]), method: :get, id: "angle-right-link", title: I18n.t("sail.next_page")) %>
+        <%= link_to("", settings_path(page: [params[:page].to_i + 1, @number_of_pages - 1].min, query: params[:query]), method: :get, id: "angle-right-link", title: I18n.t("sail.next_page")) %>
       </div>
     </div>
   <% end %>

data/app/views/sail/settings/update.js.erb

@@ -1,8 +1,12 @@
-var notice = document.getElementById("<%= @successful_update ? "notice-success" : "notice-alert" %>");
-notice.style.display = "block";
+var notice = document.getElementById("<%= @successful_update ? "success-#{@setting.name}" : "alert-#{@setting.name}" %>");
+var submit = document.getElementById("btn-submit-<%= @setting.name %>");
+
+submit.style.display = "none";
+notice.style.display = "inline-block";
 
 setTimeout(function () {
     notice.style.display = "none";
+    submit.style.display = "inline-block";
 }, 1500);
 
 if ("<%= @successful_update %>" === "true") {

data/config/locales/en.yml

@@ -4,8 +4,6 @@ en:
     save: SAVE
     activate: ACTIVATE
     delete: DELETE
-    updated: Updated!
-    failed: Failed!
     search_placeholder: Setting name, group, cast type, stale or recent x
     search_tooltip: "When searching for recently updated settings, x is the number of hours since the update (e.g.: recent 2)"
     main_app: Main app
@@ -33,6 +31,7 @@ en:
     by_cast_type_html: "<b>By cast type:</b> will find all settings with the same type (must be exact match)"
     by_stale_html: "<b>By stale:</b> will find settings that are stale (haven't been updated recently)"
     by_recent_html: "<b>By recent:</b> will find settings updated in the last X hours (e.g.: recent 50)"
+    click_title: Click a setting's title to view its description.
     profiles_can_be_used: Profiles can be used to configure many states of settings. They save the values of all settings in a given moment.
     profile_configuring: Configure settings as desired and create a new profile. Activate profiles to change the value of all settings at once.
     relevancy_score: Relevancy Score
@@ -40,8 +39,6 @@ en:
     available_groups_and_types: Available groups and types
     groups_are: "The groups currently used are:"
     types_are: "The cast types currently used are:"
-    regular_mode: Regular mode
-    monitor_mode: Monitor mode
     how_to_find_settings: How to find settings you are looking for
     how_to_profiles: How to organize your settings in profiles
     how_to_relevancy_score: What is the relevancy score and how to use it

data/lib/generators/sail/install/install_generator.rb

@@ -33,8 +33,12 @@ module Sail
                            migration_version: migration_version
       end
 
+      def create_config_file
+        template "sail.yml", "config/sail.yml"
+      end
+
       def migration_version
-        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if Rails.version.start_with?("5")
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
       end
     end
   end

data/lib/generators/sail/install/templates/sail.yml.tt

@@ -0,0 +1,5 @@
+name_of_setting:
+  description: Describe what the setting does
+  value: 'true'
+  cast_type: boolean
+  group: feature_flags

data/lib/generators/sail/update/update_generator.rb

@@ -46,7 +46,7 @@ module Sail
       end
 
       def migration_version
-        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if Rails.version.start_with?("5")
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
       end
     end
   end