lazy_value 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39c7e1e0a2dc4c49d36a057f49ffb054a527ae09880e8967067e4ce5b864e2b5
-  data.tar.gz: ad44eab22f9afcd3198a957cc41f0f810d43066b7e1b3b6fcbef3da1981d837d
+  metadata.gz: ff43403a1c22e54f42ccc10e23553ca1185da22aa520bd19239863da25be47fe
+  data.tar.gz: 38e5f11b43ff1b07d08df7f4e1530ce86f967d5ec51c6af7601414f0d3d41c25
 SHA512:
-  metadata.gz: 32e9bdc1463df76ecd671811f876cfacd1d3961275f8506a6ca9b0fdfdd68a0fd2774b3d078a951d67ff8050216587712e2843955761e06f7eed31a7f4d51189
-  data.tar.gz: 5594961af3dbfb7b83f3266024f2c92e031ccd3c84973f27e015e1ce805febec3970e79ea09b7de1ef59964bded77791cb2fac7581a1af3b6b08ff4c04f6397f
+  metadata.gz: 64c8b7a444814282cfaf80acb512405f2194b7f18dd388104e4ff3fcff601eb1dfd891d82d296571fd33b3121f8ab58f4322583bf741089f1d282747b2e5cb3a
+  data.tar.gz: 3d90984bba75aced80822d571450179b59580a4f3bf8764973a966de332a590062f0501a13a610d596e4e6b808d0b8dad838817d337f6750b85dfd9d74676f5d

data/README.md

@@ -25,6 +25,17 @@ Functioning similarly to lazy Turbo frames, this value loader has no reliance on
 
 ## Usage
 
+It's strongly suggested to configure initializer (can be generated with `rails g lazy_value initializer`). You can put your credentials/secrets/env variable. It's needed to use the same encryption key between deploys or server instances.
+
+```ruby
+LazyValue.setup do |config|
+  config.salt = ENV["LAZY_VALUE_SALT"].presence || SecureRandom.random_bytes(ActiveSupport::MessageEncryptor.key_len)
+  config.key = ENV["LAZY_VALUE_KEY"].presence || SecureRandom.hex(32)
+end
+```
+
+And now you can use `lazy_value_tag` helper in your views:
+
 ```erb
 <div class="column is-one-quarter">
     <div class="box has-text-centered">
@@ -99,6 +110,13 @@ And that is it. Start using it.
 
 `bin/rails test:system`.
 
+## TODO
+
+- websockets options vs http
+- pass variables
+- change to modern JS?
+- use POST? (if payload might be too big)
+
 ## Contributing
 
 You are welcome to contribute.
@@ -109,4 +127,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 [<img src="https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/more_gems.png?raw=true"
 />](https://www.railsjazz.com/?utm_source=github&utm_medium=bottom&utm_campaign=rails_live_reload)
-

data/lib/generators/lazy_value/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate configuration file.
+
+Example:
+    rails generate lazy_value initializer
+
+    This will create:
+        config/lazy_value.rb

data/lib/generators/lazy_value/lazy_value_generator.rb

@@ -0,0 +1,6 @@
+class LazyValueGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  def copy_initializer
+    template 'template.rb', 'config/initializers/lazy_value.rb'
+  end
+end

data/lib/generators/lazy_value/templates/template.rb

@@ -0,0 +1,4 @@
+LazyValue.setup do |config|
+  config.key  = ENV["LAZY_VALUE_KEY"]
+  config.salt = ENV["LAZY_VALUE_SALT"]
+end

data/lib/lazy_value/version.rb

@@ -1,3 +1,3 @@
 module LazyValue
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/lazy_value.rb

@@ -3,13 +3,28 @@ require "lazy_value/routes"
 require "lazy_value/engine"
 
 module LazyValue
-  mattr_accessor :cryptography
+  mattr_accessor :key
+  @@key = ENV["LAZY_VALUE_KEY"].presence || SecureRandom.hex(32)
 
-  @@cryptography = begin
-    len   = ActiveSupport::MessageEncryptor.key_len
-    salt  = SecureRandom.random_bytes(len)
-    key   = ActiveSupport::KeyGenerator.new(SecureRandom.hex(32)).generate_key(salt, len)
-    ActiveSupport::MessageEncryptor.new(key)
+  mattr_accessor :salt
+  @@salt = ENV["LAZY_VALUE_SALT"].presence || SecureRandom.hex(8)
+
+  def self.setup
+    yield(self)
+  end
+
+  def self.cryptography
+    @cryptography ||= begin
+      ActiveSupport::MessageEncryptor.new(derived_key)
+    end
+  end
+
+  def self.derived_key
+    key_generator.generate_key(salt, 32)
+  end
+
+  def self.key_generator
+    ActiveSupport::KeyGenerator.new(key, iterations: 1000)
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lazy_value
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Igor Kasyanchuk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-16 00:00:00.000000000 Z
+date: 2023-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -137,6 +137,9 @@ files:
 - app/controllers/lazy_value/application_controller.rb
 - app/helpers/lazy_value/application_helper.rb
 - config/routes.rb
+- lib/generators/lazy_value/USAGE
+- lib/generators/lazy_value/lazy_value_generator.rb
+- lib/generators/lazy_value/templates/template.rb
 - lib/lazy_value.rb
 - lib/lazy_value/engine.rb
 - lib/lazy_value/railtie.rb