preflex 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7bfaa76370b12382b4e911acf713b5e29432f0989301039c3b42ed96a2efe4d
+  data.tar.gz: 9d76ddac8cb8753d2f86dac792168337fe8e69c2062c087feafde3d16859f0ab
+SHA512:
+  metadata.gz: b21919439815819dd2f77c46d36c234a6534d009addfba13a37736a2ea683b92b18d135e6f07c7b739f7d0cbbd0fd8d99559c625ae7a236a7fa9c4d11e94f919
+  data.tar.gz: 471c5d55662b128ee78d715eac741f8fb8186cd0d1e95f16da05869e4df1274aa977b00341122b8151d092edd4005534c0d03c4833ef9e139de20bb4d403f7aa

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Owais
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Preflex
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "preflex"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install preflex
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("../example/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/concerns/preflex/set_current_context.rb

@@ -0,0 +1,13 @@
+module Preflex::SetCurrentContext
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :preflex_set_current_context
+  end
+
+  protected
+
+    def preflex_set_current_context
+      Preflex::Current.controller_instance = self
+    end
+end

data/app/controllers/preflex/application_controller.rb

@@ -0,0 +1,4 @@
+module Preflex
+  class ApplicationController < Preflex.base_controller_class_for_update
+  end
+end

data/app/controllers/preflex/preferences_controller.rb

@@ -0,0 +1,16 @@
+module Preflex
+  class PreferencesController < ApplicationController
+    # POST /preferences
+    #  Params:
+    #     klass
+    #     name
+    #     value
+    def update
+      klass = params[:klass].constantize
+      raise "Expected #{params[:klass]} to be a subclass of Preflex::Preference" unless klass < Preflex::Preference
+
+      klass.set(params[:name], params[:value])
+      head :ok
+    end
+  end
+end

data/app/helpers/preflex/preferences_helper.rb

@@ -0,0 +1,78 @@
+module Preflex
+  module PreferencesHelper
+    extend self
+
+    # PREFLEX_PREFERENCE_JS = File.read(Preferences::Preflex::Engine.root.join("app", "static", "preflex_preference.js"))
+    def script_tag(*preference_klasses)
+      return ''.html_safe if preference_klasses.empty?
+
+      base = <<~JS
+        const CSRF_TOKEN = "#{Preflex::Current.controller_instance.send(:form_authenticity_token)}"
+        const UPDATE_PATH = "#{Preflex::Engine.routes.url_helpers.preferences_path}"
+        class PreflexPreference {
+          constructor(klass, data) {
+            this.klass = klass
+            this.localStorageKey = `PreflexPreference-${klass}`
+
+            this.data = data
+            this.dataLocal = JSON.parse(localStorage.getItem(this.localStorageKey) || '{}')
+          }
+
+          get(name) {
+            this.ensurePreferenceExists(name)
+
+            const fromServer = this.data[name]
+            const fromServerUpdatedAt = this.data[`${name}_updated_at_epoch`] || 0
+
+            const fromLocal = this.dataLocal[name]
+            const fromLocalUpdatedAt = this.dataLocal[`${name}_updated_at_epoch`] || 0
+
+            if(fromLocalUpdatedAt > fromServerUpdatedAt) {
+              this.updateOnServer(name, fromLocal)
+              return fromLocal
+            }
+
+            return fromServer
+          }
+
+          set(name, value) {
+            this.ensurePreferenceExists(name)
+
+            this.dataLocal[name] = value
+            this.dataLocal[`${name}_updated_at_epoch`] = Date.now()
+
+            localStorage.setItem(this.localStorageKey, JSON.stringify(this.dataLocal))
+            this.updateOnServer(name, value)
+            document.dispatchEvent(new CustomEvent('preflex:preference-updated', { detail: { name, value } }))
+          }
+
+          updateOnServer(name, value) {
+            fetch(UPDATE_PATH, {
+              method: 'POST',
+              headers: {
+                "Content-Type": "application/json",
+                "X-CSRF-TOKEN": CSRF_TOKEN
+              },
+              body: JSON.stringify({ klass: this.klass, name, value })
+            })
+          }
+
+          ensurePreferenceExists(name) {
+            if(!this.data.hasOwnProperty(name)) {
+              throw new Error(`Preference ${name} was not defined.`)
+            }
+          }
+        }
+      JS
+
+      js = [base]
+      js += preference_klasses.map do |klass|
+        raise 'Expected #{klass} to be a sub-class of Preflex::Preference' unless klass < Preflex::Preference
+
+        "window['#{klass.name}'] = new PreflexPreference('#{klass.name}', #{klass.current.data_for_js});"
+      end
+
+      "<script>#{js.join("\n")}</script>".html_safe
+    end
+  end
+end

data/app/models/preflex/application_record.rb

@@ -0,0 +1,5 @@
+module Preflex
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/preflex/current.rb

@@ -0,0 +1,6 @@
+module Preflex
+  class Current < ActiveSupport::CurrentAttributes
+    attribute :controller_instance
+    attribute :preference_cache
+  end
+end

data/app/models/preflex/preference.rb

@@ -0,0 +1,73 @@
+module Preflex
+  class Preference < ApplicationRecord
+    self.store_attribute_unset_values_fallback_to_default = true
+
+    store :data, coder: JSON
+
+    def get(name)
+      name = name.to_sym
+      self.class.ensure_preference_exists(name)
+
+      send(name)
+    end
+
+    def set(name, value)
+      name = name.to_sym
+      self.class.ensure_preference_exists(name)
+
+      send("#{name}=", value)
+      send("#{name}_updated_at_epoch=", (Time.current.to_f * 1000).round)
+      save!
+    end
+
+    def data_for_js
+      data.to_json
+    end
+
+    def self.preference(name, type, default: nil, private: false)
+      name = name.to_sym
+
+      @preferences ||= Set.new
+      @preferences.add(name)
+
+      store_attribute(:data, name, type, default: default)
+      store_attribute(:data, "#{name}_updated_at_epoch".to_sym, :integer, default: 0)
+    end
+
+    def self.current_owner(controller_instance)
+      raise '
+        Please define a class method called owner that returns the owner of this preference.
+        You can use `controller_instance` to refer to things like current_user/etc.
+        You can return either:
+          an ActiveRecord object persisted in the DB
+          or any object that responds to `id` - returning a unique id
+          or a string that uniquely identifies the owner
+        Example:
+          def self.current_owner(controller_instance)
+            controller_instance.current_user
+          end
+      '
+    end
+
+    def self.for(owner)
+      owner = "#{owner.class.name}-#{owner.id}" if owner.respond_to?(:id)
+      PreferenceCache.for(self, owner.to_s)
+    end
+
+    def self.current
+      self.for(current_owner(Preflex::Current.controller_instance))
+    end
+
+    def self.get(name)
+      current.get(name)
+    end
+
+    def self.set(name, value)
+      current.set(name, value)
+    end
+
+    def self.ensure_preference_exists(name)
+      raise "Preference #{name} was not defined. Make sure you define it (e.g. `preference :#{name}, :integer, default: 10`)" unless @preferences&.include?(name)
+    end
+  end
+end

data/app/models/preflex/preference_cache.rb

@@ -0,0 +1,20 @@
+module Preflex
+  class PreferenceCache
+    def initialize
+      @cache = {}
+    end
+
+    def for(klass, owner)
+      @cache[klass] ||= {}
+      @cache[klass][owner] ||= klass.find_or_initialize_by(owner: owner)
+    end
+
+    def self.for(klass, owner)
+      self.current.for(klass, owner)
+    end
+
+    def self.current
+      Preflex::Current.preference_cache ||= new
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Preflex::Engine.routes.draw do
+  post 'preferences' => 'preferences#update', as: :preferences
+end

data/db/migrate/20240211162939_create_preflex_preferences.rb

@@ -0,0 +1,11 @@
+class CreatePreflexPreferences < ActiveRecord::Migration[7.1]
+  def change
+    create_table :preflex_preferences do |t|
+      t.string :type
+      t.string :owner, limit: 500
+      t.text :data, limit: 16.megabytes - 1
+      t.index ['type', 'owner']
+      t.timestamps
+    end
+  end
+end

data/lib/preflex/engine.rb

@@ -0,0 +1,12 @@
+require 'store_attribute'
+
+module Preflex
+  class Engine < ::Rails::Engine
+    isolate_namespace Preflex
+
+    config.to_prepare do
+      Preflex.base_controller_class.include(Preflex::SetCurrentContext)
+      Preflex.base_controller_class_for_update.include(Preflex::SetCurrentContext) unless Preflex.base_controller_class_for_update < Preflex.base_controller_class
+    end
+  end
+end

data/lib/preflex/version.rb

@@ -0,0 +1,3 @@
+module Preflex
+  VERSION = "0.2.0"
+end

data/lib/preflex.rb

@@ -0,0 +1,15 @@
+require "preflex/version"
+require "preflex/engine"
+
+module Preflex
+  mattr_accessor :base_controller_class
+  mattr_accessor :base_controller_class_for_update
+
+  def self.base_controller_class
+    (@@base_controller_class || '::ApplicationController').constantize
+  end
+
+  def self.base_controller_class_for_update
+    @@base_controller_class_for_update&.constantize || self.base_controller_class
+  end
+end

data/lib/tasks/preflex_tasks.rake

@@ -0,0 +1,4 @@
+desc "Configure preflex"
+task :preflex do
+  system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../template/install.rb",  __dir__)}"
+end

data/lib/template/install.rb

@@ -0,0 +1,47 @@
+say "🗄️ Running migration to create a table to store preferences..."
+rails_command("preflex:install:migrations")
+rails_command("db:migrate")
+
+say "🛠️ Setting up routes and a dummy initializer file"
+route "mount Preflex::Engine => '/preflex'"
+initializer 'preflex.rb', <<~RUBY
+  # If you have a custom base controller, uncomment the below line and set it here.
+  #Preflex.base_controller_class = '::ApplicationController'
+
+  # If you want to make it so that the controller that handles requests to update preferences(from the client-side) inherits from a different base controller, uncomment the below line and set it here.
+  #Preflex.base_controller_class_for_update = '::ApplicationController'
+RUBY
+
+create_example_preference = !no?("✨ Do you want to set up an example preference class? (Y/n)")
+
+file_name = nil
+if create_example_preference
+  name = ask("✨ What do you want to call this class? (E.g UserPreference, FeatureFlag, CustomerSettings, etc.)").presence || 'CustomerSettings'
+  file_name = "app/models/#{name.underscore}.rb"
+  file file_name, <<~RUBY
+    class #{name} < Preflex::Preference
+      preference :autoplay,        :boolean, default: true
+      preference :volume,          :integer, default: 75
+      preference :title,           :string,  default: 'Mr.'
+      preference :favorite_colors, :json,    default: ["red", "blue"]
+
+      def self.current_owner(controller_instance)
+        # You'd want to modify this to return the correct owner (whatever that is for you - can be an account/user/session/customer/etc - whatever you call it)
+        controller_instance.current_user
+      end
+    end
+  RUBY
+end
+
+say ""
+say ""
+say ""
+say "✅ ✅ ✅     All done    ✅ ✅ ✅"
+say ""
+say "You might want to take a look at #{file_name} and update it's `current_owner` method definition." if create_example_preference
+say "" if create_example_preference
+say "You can also change the base controller that preflex uses if warranted. Take a look at config/initializers/preflex.rb"
+say ""
+say "If you'd like to easily read and write preferences from the client side, just add `Preflex::PreferencesHelper.script_tag(*AllThePreferenceClassesYouHave)` (e.g `Preflex::PreferencesHelper.script_tag(UserPreference, CustomerSettings)`) to the head tag in your layout file (e.g app/views/layouts/application.html.erb) and read the docs at https://github.com/owaiswiz/preflex"
+
+def run_bundle; end;

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: preflex
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Owais
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: store_attribute
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: 'A simple but powerful Rails engine for storing preferences, feature
+  flags, etc. With support for reading/writing values client-side! '
+email:
+- owaiswiz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/concerns/preflex/set_current_context.rb
+- app/controllers/preflex/application_controller.rb
+- app/controllers/preflex/preferences_controller.rb
+- app/helpers/preflex/preferences_helper.rb
+- app/models/preflex/application_record.rb
+- app/models/preflex/current.rb
+- app/models/preflex/preference.rb
+- app/models/preflex/preference_cache.rb
+- config/routes.rb
+- db/migrate/20240211162939_create_preflex_preferences.rb
+- lib/preflex.rb
+- lib/preflex/engine.rb
+- lib/preflex/version.rb
+- lib/tasks/preflex_tasks.rake
+- lib/template/install.rb
+homepage: https://github.com/owaiswiz/preflex
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/owaiswiz/preflex
+  source_code_uri: https://github.com/owaiswiz/preflex
+  changelog_uri: https://github.com/owaiswiz/preflex/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A simple but powerful Rails engine for storing preferences, feature flags,
+  etc. With support for reading/writing values client-side!
+test_files: []