solder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: caab8b73cfc913261226022ae6e2e0d67fd6643164fa5d2b9058d7a8eb298cb1
+  data.tar.gz: a03a6323c422e4ee59cc89ccbc3b6431b3b82f755378ca7057d5868fde4e181a
+SHA512:
+  metadata.gz: 1dc4b63179b081c60def903eae5ee336209a8c90eebe8136c43f2f5f3dd1f932a9b1b2745c672cf3c80f421243433f1228f6db36acc29bd838f0fba11b63c62e
+  data.tar.gz: 2d02e8e58009e38c21568c5d8aaa3dc97bfa6f42682865b4d2c13dba549dc76c4913670460dcf4a4ea0ac1c1cedb14138baf97133fcc13d349405a229671f5ee

data/README.md

@@ -0,0 +1,43 @@
+# 🧑‍🏭 Solder
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+### Persistence
+
+Uses the active Rails cache store, possibly more adapters to come
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "solder"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install solder
+```
+
+## Dependencies
+
+### Ruby
+- Rails
+
+### Javascript
+
+- Stimulus
+- @rails/request.js
+- Turbo
+
+## 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("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/solder_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/solder .css

data/app/assets/stylesheets/solder/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/solder/application_controller.rb

@@ -0,0 +1,4 @@
+module Solder
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/solder/ui_state_controller.rb

@@ -0,0 +1,25 @@
+module Solder
+  class UiStateController < ApplicationController
+    before_action :set_ui_state, only: :show
+
+    def show
+      render json: @ui_state.to_json
+    end
+
+    def update
+      Rails.cache.write "solder/#{params[:key]}", JSON.parse(params[:attributes])
+
+      head :ok
+    end
+
+    private
+
+    def ui_state_params
+      params.permit(:attributes, :key)
+    end
+
+    def set_ui_state
+      @ui_state = Rails.cache.read "solder/#{params[:key]}"
+    end
+  end
+end

data/app/controllers/solder/ui_state_controller.rb~

@@ -0,0 +1,25 @@
+module Solder
+  class UiStateController < ApplicationController
+    before_action :set_ui_state
+
+    def show
+      render json: @ui_state.value
+    end
+
+    def update
+      @ui_state.value = JSON.parse(params[:attributes])
+
+      head :ok
+    end
+
+    private
+
+    def ui_state_params
+      params.permit(:attributes, :key)
+    end
+
+    def set_ui_state
+      @ui_state = Kredis.json params[:key]
+    end
+  end
+end

data/app/helpers/solder/application_helper.rb

@@ -0,0 +1,15 @@
+module Solder
+  module ApplicationHelper
+    def solder_key(name)
+      key = cache_fragment_name(name, skip_digest: true)
+        .flatten
+        .compact
+        .map(&:cache_key)
+        .join(":")
+
+      key += ":#{caller(1..1).first}"
+
+      ActiveSupport::Digest.hexdigest(key)
+    end
+  end
+end

data/app/helpers/solder/application_helper.rb~

@@ -0,0 +1,14 @@
+module Solder
+  module ApplicationHelper
+    def solder_key(name)
+      key = cache_fragment_name(name, skip_digest: true)
+        .flatten
+        .compact
+        .map(&:cache_key)
+        .join(":")
+      key += ":#{caller(1..1).first}"
+
+      ActiveSupport::Digest.hexdigest(key)
+    end
+  end
+end

data/app/jobs/solder/application_job.rb

@@ -0,0 +1,4 @@
+module Solder
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/solder/application_mailer.rb

@@ -0,0 +1,6 @@
+module Solder
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/solder/application_record.rb

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

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Solder</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "solder/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Solder::Engine.routes.draw do
+  patch "ui_state/update"
+  get "ui_state/show"
+end

data/config/routes.rb~

@@ -0,0 +1,4 @@
+Solder::Engine.routes.draw do
+  get 'ui_state/update'
+  get 'ui_state/show'
+end

data/lib/solder/engine.rb

@@ -0,0 +1,22 @@
+module Solder
+  class Engine < ::Rails::Engine
+    isolate_namespace Solder
+
+    initializer "solder.check_caching" do |app|
+      unless app.config.action_controller.perform_caching && app.config.cache_store != :null_store
+        puts <<~WARN
+          🧑‍🏭 Solder uses the Rails cache store to provide UI state persistence. Therefore, please make sure caching is enabled in your environment.
+
+          To enable caching in development, run:
+            rails dev:cache
+        WARN
+
+        exit false
+      end
+    end
+
+    config.after_initialize do
+      ::ApplicationHelper.include helpers
+    end
+  end
+end

data/lib/solder/engine.rb~

@@ -0,0 +1,16 @@
+module Solder
+  class Engine < ::Rails::Engine
+    isolate_namespace Solder
+
+    initializer "solder.check_caching" do
+      unless Rails.application.config.action_controller.perform_caching && Rails.application.config.cache_store != :null_store
+        puts <<~WARN
+            Solder uses the Rails cache store to provide UI state persistence. Therefore, please make sure caching is enabled in your environment.Engine
+
+          To enable caching in development, run:
+            rails dev:cache
+        WARN
+      end
+    end
+  end
+end

data/lib/solder/version.rb

@@ -0,0 +1,3 @@
+module Solder
+  VERSION = "0.1.0"
+end

data/lib/solder.rb

@@ -0,0 +1,6 @@
+require "solder/version"
+require "solder/engine"
+
+module Solder
+  # Your code goes here...
+end

data/lib/tasks/solder_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :solder do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: solder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Rubisch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: solargraph-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simplistic UI State Management for Rails Apps using Hotwire and Caching
+email:
+- julian@julianrubisch.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/solder_manifest.js
+- app/assets/stylesheets/solder/application.css
+- app/controllers/solder/application_controller.rb
+- app/controllers/solder/ui_state_controller.rb
+- app/controllers/solder/ui_state_controller.rb~
+- app/helpers/solder/application_helper.rb
+- app/helpers/solder/application_helper.rb~
+- app/jobs/solder/application_job.rb
+- app/mailers/solder/application_mailer.rb
+- app/models/solder/application_record.rb
+- app/views/layouts/solder/application.html.erb
+- config/routes.rb
+- config/routes.rb~
+- lib/solder.rb
+- lib/solder/engine.rb
+- lib/solder/engine.rb~
+- lib/solder/version.rb
+- lib/tasks/solder_tasks.rake
+homepage: https://github.com/julianrubisch/solder
+licenses: []
+metadata:
+  homepage_uri: https://github.com/julianrubisch/solder
+  source_code_uri: https://github.com/julianrubisch/solder
+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.3.26
+signing_key:
+specification_version: 4
+summary: Simplistic UI State Management for Rails Apps using Hotwire and Caching
+test_files: []