trmnl_preview 0.3.2 → 0.4.0

data/lib/trmnlp/config/project.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+
+module TRMNLP
+  class Config
+    class Project
+      attr_reader :paths
+
+      def initialize(paths)
+        @paths = paths
+        reload!
+      end
+
+      def reload!
+        if paths.trmnlp_config.exist?
+          @config = YAML.load_file(paths.trmnlp_config)
+        else
+          @config = {}
+        end
+      end
+
+      def user_filters = @config['custom_filters'] || []
+
+      def live_render? = !watch_paths.empty?
+
+      def watch_paths
+        (@config['watch'] || []).map { |watch_path| paths.expand(watch_path) }.uniq
+      end
+
+      def custom_fields = @config['custom_fields'] || {}
+
+      def user_data_overrides = @config['variables'] || {}
+
+      # for interpolating custom_fields into polling_* options
+      def with_custom_fields(value)
+        custom_fields_with_env = custom_fields.transform_values { |v| with_env(v) }
+        Liquid::Template.parse(value).render(custom_fields_with_env)
+      end
+
+      private
+
+      # for interpolating ENV vars into custom_fields
+      def with_env(value)
+        Liquid::Template.parse(value).render({ 'env' => ENV.to_h })
+      end
+    end
+  end
+end

data/lib/trmnlp/config.rb

@@ -0,0 +1,15 @@
+require_relative 'config/app'
+require_relative 'config/plugin'
+require_relative 'config/project'
+
+module TRMNLP
+  class Config
+    attr_reader :app, :project, :plugin
+
+    def initialize(path)
+      @app = App.new(path)
+      @project = Project.new(path)
+      @plugin = Plugin.new(path, @project)
+    end
+  end
+end

data/lib/trmnlp/context.rb

@@ -0,0 +1,211 @@
+require 'erb'
+require 'faraday'
+require 'filewatcher'
+require 'json'
+require 'liquid'
+
+require_relative 'config'
+require_relative 'custom_filters'
+require_relative 'paths'
+
+module TRMNLP
+  class Context
+    attr_reader :config, :paths
+    
+    def initialize(root_dir)
+      @paths = Paths.new(root_dir)
+      @config = Config.new(paths)
+    end
+
+    def validate!
+      raise Error, "not a plugin directory (did not find #{paths.trmnlp_config})" unless paths.valid?
+    end
+
+    def start_filewatcher
+      @filewatcher_thread ||= Thread.new do
+        loop do
+          begin
+            Filewatcher.new(config.project.watch_paths).watch do |changes|
+              config.project.reload!
+              config.plugin.reload!
+              new_user_data = user_data
+
+              views = changes.map { |path, _change| File.basename(path, '.liquid') }
+              views.each do |view|
+                @view_change_callback.call(view, new_user_data) if @view_change_callback
+              end
+            end
+          rescue => e
+            puts "Error during live render: #{e}"
+          end
+        end
+      end
+    end
+
+    def on_view_change(&block)
+      @view_change_callback = block
+    end
+
+    def user_data
+      merged_data = base_trmnl_data
+
+      if config.plugin.static?
+        merged_data.merge!(config.plugin.static_data)
+      elsif paths.user_data.exist?
+        merged_data.merge!(JSON.parse(paths.user_data.read))
+      end
+
+      # Praise be to ActiveSupport
+      merged_data.deep_merge!(config.project.user_data_overrides)
+    end
+
+    def poll_data
+      return unless config.plugin.polling?
+
+      data = {}
+
+      if config.plugin.polling_urls.empty?
+        raise Error, "config must specify polling_url or polling_urls"
+      end
+
+      config.plugin.polling_urls.each.with_index do |url, i|
+        verb = config.plugin.polling_verb.upcase
+
+        print "#{verb} #{url}... "
+
+        conn = Faraday.new(url:, headers: config.plugin.polling_headers)
+
+        case verb
+        when 'GET'
+          response = conn.get
+        when 'POST'
+          response = conn.post do |req|
+            req.body = config.plugin.polling_body
+          end
+        end
+
+        puts "received #{response.body.length} bytes (#{response.status} status)"
+        if response.status == 200
+          json = wrap_array(JSON.parse(response.body))
+        else
+          json = {}
+          puts response.body
+        end
+        
+        if config.plugin.polling_urls.count == 1
+          # For a single polling URL, we just return the JSON directly
+          data = json
+          break
+        else
+          # Multiple URLs are namespaced by index
+          data["IDX_#{i}"] = json
+        end
+      end
+
+      write_user_data(data)
+
+      data
+    rescue StandardError => e
+      puts "error: #{e.message}"
+      {}
+    end
+
+    def put_webhook(payload)
+      data = wrap_array(JSON.parse(payload))
+      write_user_data(data)
+    rescue
+      puts "webhook error: #{e.message}"
+    end
+
+    def render_template(view)
+      template_path = paths.template(view)
+      return "Missing template: #{template_path}" unless template_path.exist?
+
+      user_template = Liquid::Template.parse(template_path.read, environment: liquid_environment)
+      user_template.render(user_data)
+    rescue StandardError => e
+      e.message
+    end
+
+    def render_full_page(view)
+      template = paths.render_template.read
+      
+      ERB.new(template).result(TemplateBinding.new(self, view).get_binding do
+        render_template(view)
+      end)
+    end
+
+    def screen_classes
+      classes = 'screen'
+      classes << ' screen--no-bleed' if config.plugin.no_screen_padding == 'yes'
+      classes << ' dark-mode' if config.plugin.dark_mode == 'yes'
+      classes
+    end
+
+    private 
+
+    # bindings must match the `GET /render/{view}.html` route in app.rb
+    class TemplateBinding
+      def initialize(context, view)
+        @screen_classes = context.screen_classes
+        @view = view
+      end
+
+      def get_binding = binding
+    end
+
+    def wrap_array(json)
+      json.is_a?(Array) ? { data: json } : json
+    end
+
+    def base_trmnl_data
+      {
+        'trmnl' => {
+          'user' => {
+            'name' => 'name',
+            'first_name' => 'first_name',
+            'last_name' => 'last_name',
+            'locale' => 'en',
+            'time_zone' => 'Eastern Time (US & Canada)',
+            'time_zone_iana' => 'America/New_York',
+            'utc_offset' => -14400
+          },
+          'device' => {
+            'friendly_id' => 'ABC123',
+            'percent_charged' => 85.0,
+            'wifi_strength' => 90,
+            'height' => 480,
+            'width' => 800
+          },
+          'system' => {
+            'timestamp_utc' => Time.now.utc.to_i,
+          },
+          'plugin_settings' => {
+            'instance_name' => 'instance_name',
+            'strategy' => config.plugin.strategy,
+            'dark_mode' => config.plugin.dark_mode,
+            'polling_headers' => config.plugin.polling_headers_encoded,
+            'polling_url' => config.plugin.polling_url_text,
+            'custom_fields_values' => config.project.custom_fields
+          }
+        }
+      }
+    end
+
+    def liquid_environment
+      @liquid_environment ||= Liquid::Environment.build do |env|
+        env.register_filter(CustomFilters)
+
+        config.project.user_filters.each do |module_name, relative_path|
+          require paths.root_dir.join(relative_path)
+          env.register_filter(Object.const_get(module_name))
+        end
+      end
+    end
+
+    def write_user_data(data)
+      paths.create_cache_dir
+      paths.user_data.write(JSON.generate(data))
+    end
+  end
+end

data/lib/{trmnl_preview → trmnlp}/custom_filters.rb

@@ -1,7 +1,8 @@
 require 'active_support'
 
-module TRMNLPreview
+module TRMNLP
   module CustomFilters
+    # TODO: sync up with core
     def number_with_delimiter(*args)
       ActiveSupport::NumberHelper.number_to_delimited(*args)
     end

data/lib/trmnlp/paths.rb

@@ -0,0 +1,50 @@
+require 'xdg'
+
+module TRMNLP
+  class Paths
+    attr_reader :root_dir
+    
+    def initialize(root_dir)
+      @root_dir = Pathname.new(root_dir)
+      @xdg = XDG.new
+    end
+
+    # --- directories ---
+    
+    def src_dir = root_dir.join('src')
+
+    def build_dir = root_dir.join('_build')
+    def create_build_dir = build_dir.mkpath
+
+    def app_config_dir = xdg.config_home.join('trmnlp')
+
+    def cache_dir = xdg.cache_home.join('trmnl')
+    def create_cache_dir = cache_dir.mkpath
+
+    def valid? = trmnlp_config.exist?
+
+    # --- files ---
+
+    def trmnlp_config = root_dir.join('.trmnlp.yml')
+
+    def plugin_config = src_dir.join('settings.yml')
+      
+    def template(view) = src_dir.join("#{view}.liquid")
+      
+    def app_config = app_config_dir.join('config.yml')
+
+    def user_data = cache_dir.join('data.json')
+
+    def render_template = Pathname.new(__dir__).join('..', '..', 'web', 'views', 'render_html.erb')
+    
+    def src_files = src_dir.glob('*').select(&:file?)
+
+    # --- utilities ---
+
+    def expand(path) = Pathname.new(path).expand_path(root_dir)
+
+    private
+
+    attr_reader :xdg
+  end
+end

data/lib/{trmnl_preview → trmnlp}/screen_generator.rb

@@ -3,7 +3,7 @@ require 'mini_magick'
 require 'puppeteer-ruby'
 require 'base64'
 
-module TRMNLPreview
+module TRMNLP
   class ScreenGenerator
 
     def initialize(html, opts = {})

data/lib/trmnlp/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TRMNLP
+  VERSION = "0.4.0".freeze
+end

data/lib/trmnlp.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TRMNLP; end
+
+require_relative "trmnlp/config"
+require_relative "trmnlp/context"
+require_relative "trmnlp/version"
+
+module TRMNLP
+  VIEWS = %w{full half_horizontal half_vertical quadrant}
+
+  class Error < StandardError; end
+end

data/trmnl_preview.gemspec

@@ -1,33 +1,36 @@
 # frozen_string_literal: true
 
-require_relative "lib/trmnl_preview/version"
+require_relative "lib/trmnlp/version"
 
 Gem::Specification.new do |spec|
   spec.name = "trmnl_preview"
-  spec.version = TRMNLPreview::VERSION
+  spec.version = TRMNLP::VERSION
   spec.authors = ["Rockwell Schrock"]
   spec.email = ["rockwell@schrock.me"]
 
   spec.summary = "Local web server to preview TRMNL plugins"
   spec.description = "Automatically rebuild and preview TRNML plugins in multiple views"
-  spec.homepage = "https://github.com/schrockwell/trmnl_preview"
+  spec.homepage = "https://github.com/usetrmnl/trmnlp"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/schrockwell/trmnl_preview"
+  spec.metadata["source_code_uri"] = "https://github.com/usetrmnl/trmnlp"
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile Dockerfile])
-    end
+    [
+      'bin/**/*',
+      'lib/**/*',
+      'web/**/*',
+      'CHANGELOG.md',
+      'LICENSE.txt',
+      'README.md',
+      'trmnl_preview.gemspec'
+    ].flat_map { |glob| Dir[glob] }
   end
-  spec.bindir = "exe"
+  spec.bindir = "bin"
   spec.executables = ["trmnlp"]
   spec.require_paths = ["lib"]
 
@@ -48,8 +51,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mini_magick', '~> 4.12.0'
 
   # Utilities
-  spec.add_dependency "toml-rb", "~> 3.0"
   spec.add_dependency "filewatcher", "~> 2.1"
+  spec.add_dependency "faraday", "~> 2.1"
+  spec.add_dependency "faraday-multipart", "~> 1.1"
+  spec.add_dependency "xdg", "~> 9.1"
+  spec.add_dependency "rubyzip", "~> 2.3.0"
+  spec.add_dependency "thor", "~> 1.3"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/web/public/index.js

@@ -8,8 +8,11 @@ trmnlp.connectLiveRender = function () {
   };
 
   ws.onmessage = function (msg) {
-    if (msg.data === "reload") {
+    const payload = JSON.parse(msg.data);
+
+    if (payload.type === "reload") {
       trmnlp.setIframeSrc(trmnlp.iframe.src);
+      trmnlp.userData.textContent = JSON.stringify(payload.user_data, null, 2);
     }
   };
 
@@ -42,6 +45,7 @@ document.addEventListener("DOMContentLoaded", function () {
   trmnlp.iframe = document.querySelector("iframe");
   trmnlp.caseSelect = document.querySelector(".select-case");
   trmnlp.formatSelect = document.querySelector(".select-format");
+  trmnlp.userData = document.getElementById("user-data");
   trmnlp.isLiveReloadEnabled =
     document.querySelector("meta[name='live-reload']").content === "true";
 

data/web/views/index.erb

@@ -41,6 +41,8 @@
             <iframe width="800" height="480"></iframe>
             <div class="case-overlay"></div>
         </div>
+
+        <pre id="user-data"><%= @user_data %></pre>
     </main>
 </body>
 </html>

data/web/views/render_html.erb

@@ -11,7 +11,7 @@
     <!-- End Inter font -->
   </head>
   <body class="environment trmnl">
-    <div class="screen">
+    <div class="<%= @screen_classes %>">
       <div class="view view--<%= @view %>">
         <%= yield %>
       </div>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Rockwell Schrock
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -136,21 +136,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.12.0
 - !ruby/object:Gem::Dependency
-  name: toml-rb
+  name: filewatcher
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: filewatcher
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -163,6 +163,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  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: xdg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Automatically rebuild and preview TRNML plugins in multiple views
 email:
 - rockwell@schrock.me
@@ -171,23 +227,30 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".ruby-version"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- config.example.toml
-- docs/preview.png
-- exe/trmnlp
-- lib/trmnl_preview.rb
-- lib/trmnl_preview/app.rb
-- lib/trmnl_preview/cmd/build.rb
-- lib/trmnl_preview/cmd/serve.rb
-- lib/trmnl_preview/cmd/usage.rb
-- lib/trmnl_preview/cmd/version.rb
-- lib/trmnl_preview/context.rb
-- lib/trmnl_preview/custom_filters.rb
-- lib/trmnl_preview/screen_generator.rb
-- lib/trmnl_preview/version.rb
+- bin/trmnlp
+- lib/trmnlp.rb
+- lib/trmnlp/api_client.rb
+- lib/trmnlp/app.rb
+- lib/trmnlp/cli.rb
+- lib/trmnlp/commands.rb
+- lib/trmnlp/commands/base.rb
+- lib/trmnlp/commands/build.rb
+- lib/trmnlp/commands/login.rb
+- lib/trmnlp/commands/pull.rb
+- lib/trmnlp/commands/push.rb
+- lib/trmnlp/commands/serve.rb
+- lib/trmnlp/config.rb
+- lib/trmnlp/config/app.rb
+- lib/trmnlp/config/plugin.rb
+- lib/trmnlp/config/project.rb
+- lib/trmnlp/context.rb
+- lib/trmnlp/custom_filters.rb
+- lib/trmnlp/paths.rb
+- lib/trmnlp/screen_generator.rb
+- lib/trmnlp/version.rb
 - trmnl_preview.gemspec
 - web/public/black-case.jpg
 - web/public/clear-case.jpg
@@ -196,13 +259,13 @@ files:
 - web/public/white-case.jpg
 - web/views/index.erb
 - web/views/render_html.erb
-homepage: https://github.com/schrockwell/trmnl_preview
+homepage: https://github.com/usetrmnl/trmnlp
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/schrockwell/trmnl_preview
-  source_code_uri: https://github.com/schrockwell/trmnl_preview
+  homepage_uri: https://github.com/usetrmnl/trmnlp
+  source_code_uri: https://github.com/usetrmnl/trmnlp
 rdoc_options: []
 require_paths:
 - lib

data/.ruby-version

@@ -1 +0,0 @@
-3.4.1

data/config.example.toml

@@ -1,14 +0,0 @@
-# strategy = "polling" ==> the data will be fetched once, at server start-up
-# strategy = "webhook" ==> POST new data to /webhook
-strategy = "polling"
-
-# Poll URL (required for polling strategy)
-url = "https://example.com/data.json"
-
-# Automatically re-render the view when Liquid templates change (default: true)
-live_render = true
-
-# Polling headers (optional, for polling strategy)
-[polling_headers]
-authorization = "bearer 123"
-content-type = "application/json"

data/exe/trmnlp

@@ -1,14 +0,0 @@
-#! /usr/bin/env ruby
-
-require_relative '../lib/trmnl_preview'
-
-case ARGV[0].to_s.downcase
-when 'serve'
-  require_relative '../lib/trmnl_preview/cmd/serve'
-when 'build'
-  require_relative '../lib/trmnl_preview/cmd/build'
-when 'version'
-  require_relative '../lib/trmnl_preview/cmd/version'
-else
-  require_relative '../lib/trmnl_preview/cmd/usage'
-end