fino-rails 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85ebcc30e5d56f11028e8686d129ef231c6c71b64eb9eb006cf350bfb371c8cb
-  data.tar.gz: c8e9f6b72f04f989f4c62e6e07b8078002efe218b3a418ab154ebe4f2da32609
+  metadata.gz: 44247d542938f2d6d30fcd1cce04f9536a29db60f737b8ab53ec65f322c7ae64
+  data.tar.gz: 19d1dcbf0364a5637c14db14937f1533a996cb1a72f951f526a2d16fd75c380d
 SHA512:
-  metadata.gz: d60f10d74c947905d15b558142995c0d057005881aa5311420cb0536364cb5c57a818558112e95acda138a9e3ec8324fb1017257565da1a6adec11979150c76f
-  data.tar.gz: e9d36e230c613175cfdd9b63a3068a556765101e33a179c758cc337ce59f243de46d0ce8b127a671109362b02a3c70b46e9e2bcfe6d2fa95e001498bddf3f1f3
+  metadata.gz: 2068d0fa5051c0e358c690a9aafc838a61cea5d4b62b5cc0096fec08d805172dfb1c66b4cadfd6bcdc9385f046d6f6e7cb1067922814f7e38c18c6fbfc0a3a4e
+  data.tar.gz: 02a17fc345a7e4e6e776ac6f357ccb7633637e4fc2662f0ec5944aa944a4d27f6b83b1d829838f91b1eb5eb5812b25404a797b3ad06b0bec8bf79a08108b3711

data/lib/fino/rails/app/controllers/fino/rails/archive_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Fino::Rails::ArchiveController < Fino::Rails::ApplicationController
+  def index
+    @archived_setting_keys = Fino.library.persisted_keys - Fino.settings.map(&:key)
+  end
+end

data/lib/fino/rails/app/views/fino/rails/archive/index.html.erb

@@ -0,0 +1,33 @@
+<div class="p-3">
+  <div class="border-b border-gray-200 pb-3 sm:flex sm:items-center sm:justify-between">
+    <h3 class="text-base font-semibold text-gray-900">Archive</h3>
+
+    <% if !@archived_setting_keys.empty? %>
+      <div class="mt-3 flex gap-2 sm:mt-0 sm:ml-4">
+        <%= link_to "Clear all", :back, class: "rounded-md bg-indigo-600 px-3 py-2 text-sm font-semibold text-white shadow-xs hover:bg-indigo-500 focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-indigo-600" %>
+      </div>
+    <% end %>
+  </div>
+
+  <div class="container mx-auto pt-3">
+    <% if @archived_setting_keys.empty? %>
+      <div class="outline outline-gray-200 rounded-xl">
+        <div class="p-3 text-center">
+          <h1 class="text-gray-900 font-semibold text-lg">There are no archived settings</h1>
+          <p class="text-gray-500">Setting becomes archived when you remove its definition from Fino configuration block</p>
+        </div>
+      </div>
+    <% else %>
+      <div class="outline outline-gray-200 rounded-xl">
+        <ul role="list" class="space-y-1 divide-y divide-gray-200">
+          <% @archived_setting_keys.each do |key| %>
+            <li class="text-sm/6 text-gray-900 font-semibold px-4 py-6 flex justify-between items-center">
+              <%= key %>
+              <%= link_to "Clear", :back, class: "inline-flex items-center rounded-md bg-white px-3 py-2 text-sm font-semibold text-gray-900 shadow-xs inset-ring inset-ring-gray-300 hover:bg-gray-50" %>
+            </li>
+          <% end %>
+        </ul>
+      </div>
+    <% end %>
+  </div>
+</div>

data/lib/fino/rails/app/views/fino/rails/common/_sidebar.html.erb

@@ -12,6 +12,10 @@
           </svg>
           Dashboard
         <% end %>
+
+        <%= link_to archive_index_path, class: "flex gap-x-3 rounded-md p-2 text-sm/6 font-semibold #{current_page?(:archive_index) ? 'text-indigo-600' : 'text-gray-700'} hover:bg-gray-100 hover:text-indigo-600" do %>
+          Archive
+        <% end %>
       </div>
 
       <div>

data/lib/fino/rails/app/views/fino/rails/dashboard/index.html.erb

@@ -23,8 +23,6 @@
                         <h2 class="min-w-0 text-sm/6 font-semibold text-gray-900">
                           <span class="whitespace-nowrap"><%= setting.name %></span>
                         </h2>
-
-                        <%= setting_type_label(setting) %>
                       </div>
 
                       <div>
@@ -43,6 +41,13 @@
                           <div class="truncate text-xl font-semibold text-gray-800">
                             "<%= setting.value %>"
                           </div>
+                        <% when Fino::Settings::Numeric %>
+                          <div class="truncate text-xl font-semibold text-gray-800">
+                            <span><%= setting.value %></span>
+                            <% if setting.unit.present? %>
+                              <span class="text-base font-medium text-gray-600"><%= setting.unit.short_name %></span>
+                            <% end %>
+                          </div>
                         <% else %>
                           <div class="truncate text-xl font-semibold text-gray-800">
                             <%= setting.value %>

data/lib/fino/rails/app/views/fino/rails/settings/_setting.html.erb

@@ -36,6 +36,13 @@
           <div class="truncate text-xl font-semibold text-gray-800">
             "<%= setting.value %>"
           </div>
+        <% when Fino::Settings::Numeric %>
+          <div class="truncate text-xl font-semibold text-gray-800">
+            <%= setting.value %>
+            <% if setting.unit.present? %>
+              <span class="text-base font-medium text-gray-600"><%= setting.unit.short_name %></span>
+            <% end %>
+          </div>
         <% else %>
           <div class="truncate text-xl font-semibold text-gray-800">
             <%= setting.value %>

data/lib/fino/rails/app/views/fino/rails/settings/types/_float.html.erb

@@ -1,3 +1,5 @@
+<% setting = local_assigns[:setting] %>
+
 <div class="<%= local_assigns[:wrapper_class] || 'flex items-center rounded-md bg-white pl-3 outline-1 -outline-offset-1 outline-gray-300 focus-within:outline-2 focus-within:-outline-offset-2 focus-within:outline-indigo-600' %>">
   <%= form.number_field field_name,
                        {
@@ -6,4 +8,10 @@
                          step: 0.1,
                          class: local_assigns[:input_class] || "block min-w-0 grow bg-white py-1.5 pr-3 pl-1 text-base text-gray-900 placeholder:text-gray-400 focus:outline-none sm:text-sm/6"
                        }.merge(field_name_attr ? { name: field_name_attr } : {}) %>
-</div>
+
+  <% if setting.unit.present? %>
+    <div class="shrink-0 text-base text-gray-500 select-none sm:text-sm/6 dark:text-gray-400 pr-3">
+      <%= setting.unit.short_name %>
+    </div>
+  <% end %>
+</div>

data/lib/fino/rails/app/views/fino/rails/settings/types/_integer.html.erb

@@ -1,3 +1,5 @@
+<% setting = local_assigns[:setting] %>
+
 <div class="<%= local_assigns[:wrapper_class] || 'flex items-center rounded-md bg-white pl-3 outline-1 -outline-offset-1 outline-gray-300 focus-within:outline-2 focus-within:-outline-offset-2 focus-within:outline-indigo-600' %>">
   <%= form.number_field field_name,
                        {
@@ -6,4 +8,10 @@
                          step: 1,
                          class: local_assigns[:input_class] || "block min-w-0 grow bg-white py-1.5 pr-3 pl-1 text-base text-gray-900 placeholder:text-gray-400 focus:outline-none sm:text-sm/6"
                        }.merge(field_name_attr ? { name: field_name_attr } : {}) %>
-</div>
+
+  <% if setting.unit.present? %>
+    <div class="shrink-0 text-base text-gray-500 select-none sm:text-sm/6 dark:text-gray-400 pr-3">
+      <%= setting.unit.short_name %>
+    </div>
+  <% end %>
+</div>

data/lib/fino/rails/config/routes.rb

@@ -3,8 +3,12 @@
 Fino::Rails::Engine.routes.draw do
   root to: "dashboard#index"
 
-  get ":section", to: "sections#show", as: :settings_section
+  resources :archive, only: %i[index]
 
-  get ":section/:setting", to: "settings#edit", as: :edit_setting
-  put ":section/:setting", to: "settings#update", as: :update_setting
+  scope "settings" do
+    get ":section", to: "sections#show", as: :settings_section
+
+    get ":section/:setting", to: "settings#edit", as: :edit_setting
+    put ":section/:setting", to: "settings#update", as: :update_setting
+  end
 end

data/lib/fino/rails/generators/install/USAGE

@@ -0,0 +1,12 @@
+Description:
+    Installs Fino Rails integration by creating an initializer file with default configuration.
+    If fino-solid is installed, it will also run the fino:solid:install generator to create the database migration.
+
+Example:
+    bin/rails generate fino:rails:install
+
+    This will create:
+        config/initializers/fino.rb
+
+    If fino-solid is installed, it will also create:
+        db/migrate/[timestamp]_create_fino_settings.rb

data/lib/fino/rails/generators/install/install_generator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Fino
+  module Rails
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        def copy_initializer
+          template "fino.rb.tt", "config/initializers/fino.rb"
+        end
+
+        def install_solid_adapter
+          return unless fino_solid_available?
+
+          generate "fino:solid:install"
+        end
+
+        private
+
+        def fino_solid_available?
+          require "fino-solid"
+          true
+        rescue LoadError
+          false
+        end
+
+        def fino_redis_available?
+          require "fino-redis"
+          true
+        rescue LoadError
+          false
+        end
+      end
+    end
+  end
+end

data/lib/fino/rails/generators/install/templates/fino.rb.tt

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+Rails.application.configure do
+  # Configure fino-rails within this block
+
+  # Whether fino calls should be instrumented. You can implement custom subscribers by subscribing to `fino` namespace
+  config.fino.instrument = Rails.env.development?
+
+  # Fino Rails provides a default log subscriber that logs executed queries and cache hits/misses by subscribing to
+  # `fino` instrumentation namespace
+  #
+  config.fino.log = config.fino.instrument
+
+  # If setting was read from the adapter within Rails request, it will be cached for the duration of that request to
+  # avoid multiple calls to the adapter
+  #
+  config.fino.cache_within_request = true
+
+  # Whether fino should preload all registered settings in the beginning of each request by single adapter call.
+  # Can be set to:
+  #
+  # 1. false - do not preload settings
+  # 2. true - preload all settings before each request
+  # 3. Callable accepting rack request object and returning boolean - preload settings conditionally, e.g:
+  #
+  #    ->(request) {
+  #      case request.path
+  #      when "request/using/all/settings"
+  #        true
+  #      when "request/not/using/settings"
+  #        false
+  #      when "request/using/specific/settings"
+  #        [
+  #          :api_rate_limit,
+  #          openai: [:model, :temperature]
+  #        ]
+  #      end
+  #    }
+  #
+  config.fino.preload_before_request = false
+end
+
+Fino.configure do
+<%- if fino_redis_available? -%>
+  adapter do
+    Fino::Redis::Adapter.new(
+      Redis.new(**Rails.application.config_for(:redis))
+    )
+  end
+<%- elsif fino_solid_available? -%>
+  adapter do
+    Fino::Solid::Adapter.new
+  end
+<%- else -%>
+  adapter do
+    raise "No Fino adapter configured. Use `bundle add fino-solid` for a quick start"
+  end
+<%- end -%>
+
+  # Allows to cache settings between requests
+  #
+  # Memory cache adapter provided out of the box should be used with care as may lead to inconsistencies between
+  # running application instances, but might lead to performance improvements by reducing amount of calls to the adapter
+  #
+  # cache { Fino::Cache::Memory.new(expires_in: 1.minute) }
+
+  settings do
+    # Configure settings within this block
+
+    # Supported data types:
+    #   - string
+    #   - integer
+    #   - float
+    #   - boolean
+
+    # setting :maintenance_mode,
+    #         :boolean,
+    #         default: false,
+    #         description: <<~DESC.strip
+    #           Enable maintenance mode for the system. Users will see a maintenance page when this is enabled
+    #         DESC
+    #
+    # setting :api_rate_limit,
+    #         :integer,
+    #         default: 1000,
+    #         description: "Maximum API requests per minute per user to prevent abuse"
+    #
+    # section :openai, label: "OpenAI" do
+    #   setting :model,
+    #           :string,
+    #           default: "gpt-5",
+    #           description: "OpenAI model"
+    #
+    #   setting :temperature,
+    #           :float,
+    #           default: 0.7,
+    #           description: "Model temperature"
+    # end
+    #
+    # section :feature_toggles, label: "Feature Toggles" do
+    #   setting :new_ui, :boolean, default: true, description: "Enable the new user interface"
+    #   setting :beta_functionality, :boolean, default: false, description: "Enable beta functionality for testing"
+    # end
+  end
+end

data/lib/fino/rails.rb

@@ -26,3 +26,4 @@ module Fino
 end
 
 require "fino/rails/engine"
+require "fino/rails/generators/install/install_generator"

data/lib/fino/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Fino
-  VERSION = "1.3.1"
+  VERSION = "1.5.0"
   REQUIRED_RUBY_VERSION = ">= 3.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fino-rails
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Egor Iskrenkov
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -49,11 +49,13 @@ files:
 - lib/fino/rails.rb
 - lib/fino/rails/app/assets/stylesheets/fino.css
 - lib/fino/rails/app/controllers/fino/rails/application_controller.rb
+- lib/fino/rails/app/controllers/fino/rails/archive_controller.rb
 - lib/fino/rails/app/controllers/fino/rails/dashboard_controller.rb
 - lib/fino/rails/app/controllers/fino/rails/sections_controller.rb
 - lib/fino/rails/app/controllers/fino/rails/settings_controller.rb
 - lib/fino/rails/app/helpers/fino/rails/application_helper.rb
 - lib/fino/rails/app/helpers/fino/rails/settings_helper.rb
+- lib/fino/rails/app/views/fino/rails/archive/index.html.erb
 - lib/fino/rails/app/views/fino/rails/common/_flash.html.erb
 - lib/fino/rails/app/views/fino/rails/common/_sidebar.html.erb
 - lib/fino/rails/app/views/fino/rails/common/_topbar.html.erb
@@ -69,6 +71,9 @@ files:
 - lib/fino/rails/app/views/layouts/fino/rails/application.html.erb
 - lib/fino/rails/config/routes.rb
 - lib/fino/rails/engine.rb
+- lib/fino/rails/generators/install/USAGE
+- lib/fino/rails/generators/install/install_generator.rb
+- lib/fino/rails/generators/install/templates/fino.rb.tt
 - lib/fino/rails/instrumentation/log_subscriber.rb
 - lib/fino/rails/instrumentation/pipe.rb
 - lib/fino/rails/preloading/middleware.rb