lazy_value 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef5939807537f53fd34ea59b921c2c35ad19b5cc0785ea85c5b02a83f16df684
-  data.tar.gz: bf4cf993c42ae4b6a9201265ef0e20484e058bbc732ce2c3fa66d8218a89850a
+  metadata.gz: ff43403a1c22e54f42ccc10e23553ca1185da22aa520bd19239863da25be47fe
+  data.tar.gz: 38e5f11b43ff1b07d08df7f4e1530ce86f967d5ec51c6af7601414f0d3d41c25
 SHA512:
-  metadata.gz: 53cc3085dc02b8b2369fefd8675fd9b581b0ee81ea7d0546f15280032bf5c651b7d16f872b21a62bb8d0afff7abb46929a2b0ca21063d1ccd285e7d97f9ce1bf
-  data.tar.gz: e9c31654fa08c9049207e4c6948c6344fe74a1708dab053a5a6a9a7230586aac3a8858bce6193d732c774c3eb4276881b07daf26dace27aac5a453ebf14858bb
+  metadata.gz: 64c8b7a444814282cfaf80acb512405f2194b7f18dd388104e4ff3fcff601eb1dfd891d82d296571fd33b3121f8ab58f4322583bf741089f1d282747b2e5cb3a
+  data.tar.gz: 3d90984bba75aced80822d571450179b59580a4f3bf8764973a966de332a590062f0501a13a610d596e4e6b808d0b8dad838817d337f6750b85dfd9d74676f5d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Igor Kasyanchuk
+
+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,129 @@
+# Lazy Value
+
+[![RailsJazz](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/my_other.svg?raw=true)](https://www.railsjazz.com)
+[![Listed on OpenSource-Heroes.com](https://opensource-heroes.com/badge-v1.svg)](https://opensource-heroes.com/o/railsjazz)
+
+![RailsLiveReload](docs/lazy_value.gif)
+
+Introducing a versatile value loader for your Ruby on Rails views, designed to optimize parallel loading of information on a page. This solution is perfect for scenarios where you need to display multiple stats, each taking 1-2 seconds to compute, thus causing a delay in page loading time.
+
+Functioning similarly to lazy Turbo frames, this value loader has no reliance on Turbo and eliminates the need for creating new actions to load data. Make your page loading experience smoother and more efficient with this practical solution.
+
+## Main Benefits
+
+1. Just 1 line of code
+2. No reliance on JavaScript dependencies, such as Turbo
+3. Easy to implement with a "Plug & Play" approach
+4. Compatible with Turbo Frames
+
+## Essential Information & Constraints
+
+1. Currently compatible with ERB only
+2. Each lazy value should be atomic and not rely on any external value or variable initialized in the controller/view
+3. Limit usage to one lazy_value_tag per line
+4. Carefully follow the provided format when adding this block; refer to the README for guidance
+
+## 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">
+        <h2 class="subtitle">Number 2</h2>
+        <%= lazy_value_tag do %>
+          <p class="title"><%= Project.pending.count %>%</p>
+        <% end %>
+    </div>
+</div>
+<div class="column is-one-quarter">
+    <div class="box has-text-centered">
+        <h2 class="subtitle">Number 3</h2>
+        <p class="title">
+          <%= lazy_value_tag { User.active.count } %>
+        </p>
+    </div>
+</div>
+```
+
+It also works with partials:
+
+```erb
+<div class="box">
+  <%= lazy_value_tag do %>
+    <strong>Random 5 users</strong>
+    <%= render "/home/users", users: User.limit(5).order("random()") %>
+  <% end %>
+</div>
+```
+
+And even compatible with Turbo.
+
+```erb
+<turbo-frame id="messages" target="_top">
+  This content is from lazy loaded turbo frame.
+
+  <%= lazy_value_tag do %>
+    <h3 class="title"><%= rand(1000) %></h3>
+  <% end %>
+
+  <%= lazy_value_tag do %>
+    <%= "I'm lazy loaded from the turbo frame" %>
+  <% end %>
+</turbo-frame>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "lazy_value"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+And that is it. Start using it.
+
+## How it works
+
+1. We call `lazy_value_tag` in the view
+2. We save location from where it was called (with `caller_locations.first`), file + line number.
+3. We encrypt this info using `ActiveSupport::MessageEncryptor`, creating span with spinner, and JS snippet that will call `/lazy_value/show?payload=`
+4. In the controller we decrypt our data and reading ERB file and detecting our snippet
+5. Depending on the block syntax we evaluate ERB or Ruby.
+6. We return from the controller HTML that will replace snippen on the page.
+
+## Testing
+
+`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.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+[<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/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require_relative "test/dummy/config/application"
+
+Rails.application.load_tasks

data/app/controllers/lazy_value/application_controller.rb

@@ -0,0 +1,39 @@
+module LazyValue
+  class ApplicationController < ActionController::Base
+    REGEXP = /<%= lazy_value_tag(?:.*?)do %>(.*?)<% end %>|<%= lazy_value_tag { (.+?) } %>/m
+    ERROR_MESSAGE = "Incorrect usage. Try to use \"lazy_value_tag do ... end\" or \"lazy_value_tag { ... }\""
+
+    def show
+      matches = code.match(REGEXP)
+      if matches.present? && matches[1].present?
+        render plain: ActionController::Base.render(inline: matches[1])
+      elsif matches.present? && matches[2].present?
+        render plain: eval(matches[2])
+      else
+        render plain: ERROR_MESSAGE
+      end
+    end
+
+    private
+
+    def payload
+      Base64.urlsafe_decode64(params[:payload])
+    end
+
+    def code
+      data = JSON.parse(LazyValue.cryptography.decrypt_and_verify(payload))
+      # some security checks
+      raise "Incorrect file path" if data["path"] !~ /^#{Rails.root}/ || data["path"].include?("..")
+      # I want to return only first found lazy_value_tag snippet
+      snippet = File.read(data["path"]).lines[data["lineno"]-1..-1]
+      result = []
+      times = 0
+      snippet.map do |line|
+        times += 1 if line =~ /<%= lazy_value_tag/
+        break if times > 1
+        result << line
+      end
+      result.join
+    end
+  end
+end

data/app/helpers/lazy_value/application_helper.rb

@@ -0,0 +1,59 @@
+module LazyValue
+  module ApplicationHelper
+    SPINNER = <<~SVG
+      <svg width="24" height="24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><style>.spinner_OSmW{transform-origin:center;animation:spinner_T6mA .75s step-end infinite}@keyframes spinner_T6mA{8.3%{transform:rotate(30deg)}16.6%{transform:rotate(60deg)}25%{transform:rotate(90deg)}33.3%{transform:rotate(120deg)}41.6%{transform:rotate(150deg)}50%{transform:rotate(180deg)}58.3%{transform:rotate(210deg)}66.6%{transform:rotate(240deg)}75%{transform:rotate(270deg)}83.3%{transform:rotate(300deg)}91.6%{transform:rotate(330deg)}100%{transform:rotate(360deg)}}</style><g class="spinner_OSmW"><rect x="11" y="1" width="2" height="5" opacity=".14"/><rect x="11" y="1" width="2" height="5" transform="rotate(30 12 12)" opacity=".29"/><rect x="11" y="1" width="2" height="5" transform="rotate(60 12 12)" opacity=".43"/><rect x="11" y="1" width="2" height="5" transform="rotate(90 12 12)" opacity=".57"/><rect x="11" y="1" width="2" height="5" transform="rotate(120 12 12)" opacity=".71"/><rect x="11" y="1" width="2" height="5" transform="rotate(150 12 12)" opacity=".86"/><rect x="11" y="1" width="2" height="5" transform="rotate(180 12 12)"/></g></svg>
+    SVG
+
+    def lazy_value_tag(*args, &block)
+      element_id = "lazy_value_#{SecureRandom.hex(8)}"
+      kaller = caller_locations.first
+
+      options = {}
+      args.each { |e| options.merge!(e) if e.is_a?(Hash) }
+      options[:class] = [options[:class], "lazy-value-tag"].compact_blank.join(" ")
+      options[:id] = element_id
+
+      data = LazyValue.cryptography.encrypt_and_sign(
+        {
+          path: kaller.path,
+          lineno: kaller.lineno
+        }.to_json
+      )
+
+      content_tag(:span, raw(SPINNER), options) + raw(js_code(data, element_id))
+    end
+
+    private
+    def js_code(data, element_id)
+      <<~html
+        <script>
+          var remoteServerURL = "/lazy_value/show?payload=#{Base64.urlsafe_encode64(data)}"
+
+          function fetchRemoteContent#{element_id}() {
+            var xhr = new XMLHttpRequest();
+
+            xhr.onreadystatechange = function() {
+                if (xhr.readyState === XMLHttpRequest.DONE) {
+                    if (xhr.status >= 200 && xhr.status < 400) {
+                        var data = xhr.responseText; // Use JSON.parse(xhr.responseText) if the response is in JSON format
+                        var contentContainer = document.getElementById('#{element_id}');
+                        contentContainer.nextElementSibling.remove();
+                        contentContainer.outerHTML = data;
+                        //contentContainer.innerHTML = data;
+                    } else {
+                        console.error('Error fetching remote content:', xhr.status);
+                    }
+                }
+            };
+
+            xhr.open('GET', remoteServerURL, true);
+            xhr.send();
+          }
+
+          fetchRemoteContent#{element_id}();
+        </script>
+      html
+    end
+
+  end
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+LazyValue::Engine.routes.draw do
+  get '/show' => 'application#show', as: :show
+end
+
+Rails.application.routes.draw do
+  mount_lazy_value_routes
+end

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/engine.rb

@@ -0,0 +1,11 @@
+module LazyValue
+  class Engine < ::Rails::Engine
+    isolate_namespace LazyValue
+
+    config.to_prepare do
+      ActiveSupport.on_load(:action_view) do
+        include LazyValue::ApplicationHelper
+      end
+    end
+  end
+end

data/lib/lazy_value/railtie.rb

@@ -0,0 +1,4 @@
+module LazyValue
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/lazy_value/routes.rb

@@ -0,0 +1,7 @@
+module ActionDispatch::Routing
+  class Mapper
+    def mount_lazy_value_routes(options = {})
+      mount LazyValue::Engine => '/lazy_value', :as => options[:as] || 'lazy_value'
+    end
+  end
+end

data/lib/lazy_value/version.rb

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

data/lib/lazy_value.rb

@@ -0,0 +1,30 @@
+require "lazy_value/version"
+require "lazy_value/routes"
+require "lazy_value/engine"
+
+module LazyValue
+  mattr_accessor :key
+  @@key = ENV["LAZY_VALUE_KEY"].presence || SecureRandom.hex(32)
+
+  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

data/lib/tasks/lazy_value_tasks.rake

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lazy_value
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  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
@@ -130,7 +130,22 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- 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
+- lib/lazy_value/routes.rb
+- lib/lazy_value/version.rb
+- lib/tasks/lazy_value_tasks.rake
 homepage: https://github.com/railsjazz.com/lazy_value
 licenses:
 - MIT