fino 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c47c47b3ab49c1eac2959185f67a6cc62e952936c7693f1e1d3d95843afaae88
-  data.tar.gz: da1f3fea78b8d9adbf58a3209c87e6c8acd717371dafe7618f9a2522e744fc0d
+  metadata.gz: 23a8486cb9d7c402ff499051da385a911437dd8a4d9a49df5712ef3e439f0b0d
+  data.tar.gz: cdd83bdb9542a59f4c0e4f409e76231a40028acf25e2293de84e45873c296b26
 SHA512:
-  metadata.gz: bbadb8e1f7f954e7c1f0d9d1a0d7f6455236e67c6dfdaad87a02b9659b3a130f4c7be93cad53f9c486fad6cecd335a308e696ee82b91b1404f2a7fa31048c15c
-  data.tar.gz: '0797cdb045a602b6f9b79ce8f772f7085c857d9addb3d664d74f3a3790676afe046b4c5d81ad4d6b2865b4c244b6debc7bc2ac6ed87cb255adf66fea4a57d9be'
+  metadata.gz: 59315d14709d165cfe989d66324ca823f8fb13cd8c140246d6bb9542876d49446a9b52654ac15b34b39a7bdb8f9b79bba9e4d065ab8e9d35e2150a3862f32e7d
+  data.tar.gz: a9fc49c4e631b8a6812ff51401597591886a42e6a354feed62bdd8e308a1ebef66469485fdc83e647ad53e1a057d5860411e5ff4c15193b6a57fe72b7910b041

data/lib/fino/adapter.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module Fino::Adapter
-  def read(setting_definition)
+  def read(setting_key)
     raise NotImplementedError
   end
 
-  def read_multi(setting_definitions)
+  def read_multi(setting_keys)
     raise NotImplementedError
   end
 
@@ -13,6 +13,10 @@ module Fino::Adapter
     raise NotImplementedError
   end
 
+  def read_persisted_setting_keys
+    raise NotImplementedError
+  end
+
   def fetch_value_from(raw_adapter_data)
     raise NotImplementedError
   end

data/lib/fino/definition/setting.rb

@@ -28,13 +28,11 @@ class Fino::Definition::Setting
   end
 
   def default
-    return @default if defined?(@default)
-
-    @default = options[:default]
+    defined?(@default) ? @default : @default = options[:default]
   end
 
   def description
-    options[:description]
+    defined?(@description) ? @description : @description = options[:description]
   end
 
   def path

data/lib/fino/library.rb

@@ -81,6 +81,10 @@ class Fino::Library
     pipeline.read_multi(setting_definitions)
   end
 
+  def persisted_keys
+    adapter.read_persisted_setting_keys
+  end
+
   private
 
   attr_reader :configuration
@@ -97,7 +101,11 @@ class Fino::Library
   end
 
   def storage
-    Fino::Pipe::Storage.new(configuration.adapter_builder_block.call)
+    Fino::Pipe::Storage.new(adapter)
+  end
+
+  def adapter
+    @adapter ||= configuration.adapter_builder_block.call
   end
 
   def cache

data/lib/fino/pipe/storage.rb

@@ -8,11 +8,11 @@ class Fino::Pipe::Storage
   end
 
   def read(setting_definition)
-    to_setting(setting_definition, adapter.read(setting_definition))
+    to_setting(setting_definition, adapter.read(setting_definition.key))
   end
 
   def read_multi(setting_definitions)
-    setting_definitions.zip(adapter.read_multi(setting_definitions)).map do |definition, raw_data|
+    setting_definitions.zip(adapter.read_multi(setting_definitions.map(&:key))).map do |definition, raw_data|
       to_setting(definition, raw_data)
     end
   end

data/lib/fino/settings/float.rb

@@ -2,6 +2,7 @@
 
 class Fino::Settings::Float
   include Fino::Setting
+  include Fino::Settings::Numeric
 
   self.type_identifier = :float
 

data/lib/fino/settings/integer.rb

@@ -2,6 +2,7 @@
 
 class Fino::Settings::Integer
   include Fino::Setting
+  include Fino::Settings::Numeric
 
   self.type_identifier = :integer
 

data/lib/fino/settings/numeric.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Fino::Settings::Numeric
+  module Unit
+    class Generic
+      attr_reader :name, :short_name
+
+      def initialize(name, short_name = nil)
+        @name = name
+        @short_name = short_name || name
+      end
+    end
+
+    class Milliseconds < Generic
+      def initialize = super("Milliseconds", "ms")
+    end
+
+    module_function
+
+    def for(identifier)
+      case identifier
+      when :ms
+        Milliseconds.new
+      else
+        Generic.new(identifier.to_s.capitalize)
+      end
+    end
+  end
+
+  def unit
+    return unless (identifier = definition.options[:unit])
+
+    @unit ||= Unit.for(identifier)
+  end
+
+  private
+
+  def inspectable_attributes
+    additional_attributes = {}
+    additional_attributes[:unit] = unit.short_name if unit
+
+    super.merge(additional_attributes)
+  end
+end

data/lib/fino/solid/adapter.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Fino
+  module Solid
+    class Adapter
+      include Fino::Adapter
+
+      SCOPE_PREFIX = "s"
+      VARIANT_PREFIX = "v"
+      VALUE_KEY = "v"
+
+      def read(setting_key)
+        setting = Fino::Solid::Setting.find_by(key: setting_key)
+        setting&.data || {}
+      end
+
+      def read_multi(setting_keys)
+        settings_by_key = Fino::Solid::Setting.where(key: setting_keys).index_by(&:key)
+
+        setting_keys.map { |key| settings_by_key[key]&.data || {} }
+      end
+
+      def write(setting_definition, value, overrides, variants)
+        serialize_value = ->(raw_value) { setting_definition.type_class.serialize(raw_value) }
+
+        data = { VALUE_KEY => serialize_value.call(value) }
+
+        overrides.each do |scope, scope_value|
+          data["#{SCOPE_PREFIX}/#{scope}/#{VALUE_KEY}"] = serialize_value.call(scope_value)
+        end
+
+        variants.each do |variant|
+          next if variant.value == Fino::AbTesting::Variant::CONTROL_VALUE
+
+          data["#{VARIANT_PREFIX}/#{variant.percentage}/#{VALUE_KEY}"] = serialize_value.call(variant.value)
+        end
+
+        Fino::Solid::Setting.upsert(
+          { key: setting_definition.key, data: data },
+          unique_by: :key
+        )
+      end
+
+      def read_persisted_setting_keys
+        Fino::Solid::Setting.pluck(:key)
+      end
+
+      def clear(setting_key)
+        Fino::Solid::Setting.where(key: setting_key).delete_all > 0
+      end
+
+      def fetch_value_from(raw_adapter_data)
+        raw_adapter_data.key?(VALUE_KEY) ? raw_adapter_data.delete(VALUE_KEY) : Fino::EMPTINESS
+      end
+
+      def fetch_raw_overrides_from(raw_adapter_data)
+        raw_adapter_data.each_with_object({}) do |(key, value), memo|
+          next unless key.start_with?("#{SCOPE_PREFIX}/")
+
+          scope = key.split("/", 3)[1]
+          memo[scope] = value
+        end
+      end
+
+      def fetch_raw_variants_from(raw_adapter_data)
+        raw_adapter_data.each_with_object([]) do |(key, value), memo|
+          next unless key.start_with?("#{VARIANT_PREFIX}/")
+
+          percentage = key.split("/", 3)[1]
+
+          memo << { percentage: percentage.to_f, value: value }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Fino
+  module Solid
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        include ::ActiveRecord::Generators::Migration
+
+        source_root File.expand_path("templates", __dir__)
+
+        def copy_migration
+          migration_template "create_fino_settings.rb.tt", File.join(db_migrate_path, "create_fino_settings.rb")
+        end
+
+        private
+
+        def db_migrate_path
+          "db/migrate"
+        end
+      end
+    end
+  end
+end

data/lib/fino/solid/railtie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Fino
+  module Solid
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/fino/solid/record.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Fino
+  module Solid
+    class Record < ActiveRecord::Base
+      self.abstract_class = true
+
+      connects_to(**Fino::Solid.connects_to) if Fino::Solid.connects_to
+    end
+  end
+end

data/lib/fino/solid/setting.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Fino
+  module Solid
+    class Setting < Record
+      self.table_name = "fino_settings"
+
+      serialize :data, coder: JSON
+
+      validates :key, presence: true, uniqueness: true
+    end
+  end
+end

data/lib/fino/solid.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+module Fino
+  module Solid
+    mattr_accessor :connects_to
+
+    class << self
+      def configure(&block)
+        instance_eval(&block)
+      end
+    end
+  end
+end
+
+require "fino/solid/record"
+require "fino/solid/setting"
+require "fino/solid/adapter"
+require "fino/solid/railtie" if defined?(Rails::Railtie)
+
+require "fino/solid/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

data/lib/fino-solid.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "fino"
+require "fino/solid"

data/lib/fino.rb

@@ -91,6 +91,11 @@ Zeitwerk::Loader.for_gem.tap do |l|
       root_relative_path.call("lib/fino/redis.rb"),
       root_relative_path.call("lib/fino/redis/"),
 
+      # Fino Solid
+      root_relative_path.call("lib/fino-solid.rb"),
+      root_relative_path.call("lib/fino/solid.rb"),
+      root_relative_path.call("lib/fino/solid/"),
+
       # Other
       root_relative_path.call("lib/fino/metadata.rb"),
       root_relative_path.call("lib/fino/railtie.rb")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fino
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Egor Iskrenkov
@@ -31,6 +31,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/fino-solid.rb
 - lib/fino.rb
 - lib/fino/ab_testing/experiment.rb
 - lib/fino/ab_testing/variant.rb
@@ -57,8 +58,15 @@ files:
 - lib/fino/settings/boolean.rb
 - lib/fino/settings/float.rb
 - lib/fino/settings/integer.rb
+- lib/fino/settings/numeric.rb
 - lib/fino/settings/section.rb
 - lib/fino/settings/string.rb
+- lib/fino/solid.rb
+- lib/fino/solid/adapter.rb
+- lib/fino/solid/generators/install/install_generator.rb
+- lib/fino/solid/railtie.rb
+- lib/fino/solid/record.rb
+- lib/fino/solid/setting.rb
 - lib/fino/version.rb
 homepage: https://github.com/eiskrenkov/fino
 licenses: