shimmer 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36dcc714d5d4ddff50af58d02889b9c193754c8a8c8a48b38e989f898805adc5
-  data.tar.gz: 3a3d6e7b848df467c7aa6ceb2f51071cd325f06da912dbc2926f0f7b7d986193
+  metadata.gz: 32060fa00134259da2eb2723aa0ba4e14a95bbd85f9b214797e76778f2c1500b
+  data.tar.gz: 18c942b4f19f582e7ae45a89aad5b03d6192201ea0849e14bf9e8f567dccc069
 SHA512:
-  metadata.gz: 7716f31b96c8d62da7c94151b59a6006ef12ddd918314aceb3026094cfb414634285e583979e0bc6b0932e16d36e95b69199d0e83c03933148ceaaf3002eac0d
-  data.tar.gz: 64803d66f26ed93da2265b453493bfe768344273cabb9e0c077678d7c881d73eebdee1701801767adef198da8cda100cc72f5486687c56df2fdb8de865f84dac
+  metadata.gz: 752d5f326fcf637ec3fa4d37e3cd6c5a9df88d7c408697ad7c3153b65f75ef1c8fc7f6cbeb8e29d44efe25b314a209a3bf615bd30146f704beb05cd1b156ca52
+  data.tar.gz: f8465c8a123e351a84e970fcbb6629e79a0b2759095c6378f248255cb41fdacdbb0dbce46e8751438c0737669d22e2eb8dfe8a9afb3574adfc0d0e031976b716

data/.editorconfig

@@ -0,0 +1,12 @@
+; EditorConfig is awesome: http://EditorConfig.org
+
+; top-most EditorConfig file
+root = true
+
+; Unix-style newlines with a newline ending every file
+[*]
+indent_style = spaces
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_size = 2

data/.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  env: {
+    browser: true,
+    es6: true,
+  },
+  parser: "@typescript-eslint/parser",
+  extends: [
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended",
+  ],
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: "module",
+  },
+  plugins: ["@typescript-eslint"],
+  rules: {
+    "no-console": 2,
+    "@typescript-eslint/explicit-function-return-type": [
+      "error",
+      {
+        allowExpressions: true,
+      },
+    ],
+  },
+};

data/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "trailingComma": "es5"
+}

data/.ruby-version

@@ -0,0 +1 @@
+3.0.3

data/.solargraph.yml

@@ -0,0 +1,4 @@
+plugins:
+  - solargraph-standardrb
+reporters:
+  - standardrb

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "solargraph.useBundler": true
+}

data/Gemfile

@@ -6,3 +6,5 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
+gem "standard"
+gem "solargraph-standardrb"

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    shimmer (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.0)
+    diff-lcs (1.4.4)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.12.5-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    solargraph (0.44.2)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    solargraph-standardrb (0.0.4)
+      solargraph (>= 0.39.1)
+      standard (>= 0.4.1)
+    standard (1.5.0)
+      rubocop (= 1.23.0)
+      rubocop-performance (= 1.12.0)
+    thor (1.1.0)
+    tilt (2.0.10)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  shimmer!
+  solargraph-standardrb
+  standard
+
+BUNDLED WITH
+   2.2.32

data/lib/shimmer/controllers/files_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Shimmer
+  class FilesController < ActionController::Base
+    def show
+      expires_in 1.year, public: true
+      request.session_options[:skip] = true # prevents a session cookie from being set (would prevent caching on CDNs)
+      proxy = FileProxy.restore(params.require(:id))
+      send_data proxy.file,
+        filename: proxy.filename.to_s,
+        type: proxy.content_type,
+        disposition: "inline"
+    end
+  end
+end

data/lib/shimmer/controllers/sitemaps_controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Shimmer
+  class SitemapsController < ActionController::Base
+    def show
+      path = "sitemaps/#{params.require(:path)}.gz"
+      send_data ActiveStorage::Blob.service.download(path)
+    end
+  end
+end

data/lib/shimmer/jobs/sitemap_job.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Shimmer
+  class SitemapJob < ActiveJob::Base
+    def perform
+      SitemapGenerator::Interpreter.run
+      SitemapGenerator::Sitemap.ping_search_engines
+    end
+  end
+end

data/lib/shimmer/middlewares/cloudflare.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# https://github.com/rails/rails/issues/22965
+module Shimmer
+  class CloudflareProxy
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      return @app.call(env) unless env["HTTP_CF_VISITOR"]
+
+      env["HTTP_X_FORWARDED_PROTO"] = JSON.parse(env["HTTP_CF_VISITOR"])["scheme"]
+      @app.call(env)
+    end
+  end
+end

data/lib/shimmer/railtie.rb

@@ -0,0 +1,8 @@
+module Shimmer
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/shimmer/tasks/db.rake

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+namespace :db do
+  desc "Downloads the app database from heroku to local db"
+  task pull_data: :environment do
+    config = ActiveRecord::Base.connection_db_config.config
+    # binding.pry
+    ENV["DISABLE_DATABASE_ENVIRONMENT_CHECK"] = "1"
+    Rake::Task["db:drop"].invoke
+    ENV["PGUSER"] = config["username"]
+    ENV["PGHOST"] = config["host"]
+    ENV["PGPORT"] = config["port"].to_s
+    sh "heroku pg:pull DATABASE_URL #{config["database"]} --app thefetishtraveller"
+    sh "rails db:environment:set"
+    sh "RAILS_ENV=test rails db:create"
+  end
+
+  task pull_assets: :environment do
+    config = JSON.parse(`heroku config --json`)
+    ENV["AWS_DEFAULT_REGION"] = config.fetch("AWS_REGION")
+    bucket = config.fetch("AWS_BUCKET")
+    ENV["AWS_ACCESS_KEY_ID"] = config.fetch("AWS_ACCESS_KEY_ID")
+    ENV["AWS_SECRET_ACCESS_KEY"] = config.fetch("AWS_SECRET_ACCESS_KEY")
+    storage_folder = Rails.root.join("storage")
+    download_folder = storage_folder.join("downloads")
+    FileUtils.mkdir_p download_folder
+    sh "aws s3 sync s3://#{bucket} #{storage_folder}/downloads"
+    download_folder.each_child do |file|
+      next if file.directory?
+
+      new_path = storage_folder.join file.basename.to_s.then { |e| [e[0..1], e[2..3], e] }.join("/")
+      FileUtils.mkdir_p(new_path.dirname)
+      FileUtils.cp(file, new_path)
+    end
+    # purge variants
+    ActiveStorage::VariantRecord.delete_all
+    ActiveStorage::Blob.update_all(service_name: :local)
+  end
+
+  desc "Download all app data, including assets"
+  task pull: [:pull_data, :pull_assets]
+end

data/lib/shimmer/tasks/lint.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+desc "Executes all linters and tests"
+task :lint do
+  sh "bundle exec standardrb --fix"
+  sh "yarn lint"
+  sh "i18n-tasks health"
+  sh "bin/rspec"
+end

data/lib/shimmer/utils/file_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module FileHelper
+    def image_tag(source, **options)
+      return nil if source.blank?
+
+      if source.is_a?(ActiveStorage::Variant) || source.is_a?(ActiveStorage::Attached) || source.is_a?(ActiveStorage::Attachment) || source.is_a?(ActionText::Attachment)
+        attachment = source
+        width = options[:width]
+        height = options[:height]
+        source = image_file_url(source, width: width, height: height)
+        options[:loading] = :lazy
+        options[:srcset] = "#{source} 1x, #{image_file_url(attachment, width: width.to_i * 2, height: height ? height.to_i * 2 : nil)} 2x" if options[:width].present?
+      end
+      super source, options
+    end
+
+    def image_file_url(source, width: nil, height: nil)
+      return if source.blank?
+      return source if source.is_a?(String)
+
+      blob = source.try(:blob) || source
+      Shimmer::FileProxy.new(blob_id: blob.id, width: width, height: height).url
+    end
+  end
+end

data/lib/shimmer/utils/file_proxy.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Shimmer
+  class FileProxy
+    attr_reader :blob_id, :resize
+
+    delegate :message_verifier, to: :class
+    delegate :content_type, :filename, to: :blob
+
+    class << self
+      def restore(id)
+        blob_id, resize = message_verifier.verified(id)
+        new blob_id: blob_id, resize: resize
+      end
+    end
+
+    def initialize(blob_id:, resize: nil, width: nil, height: nil)
+      @blob_id = blob_id
+      if !resize && width
+        resize = if height
+          "#{width}x#{height}>"
+        else
+          "#{width}x"
+        end
+      end
+      @resize = resize
+    end
+
+    class << self
+      def message_verifier
+        @message_verifier ||= ApplicationRecord.signed_id_verifier
+      end
+    end
+
+    def path
+      Rails.application.routes.url_helpers.file_path(id, locale: nil)
+    end
+
+    def url(protocol: Rails.env.production? ? :https : :http)
+      Rails.application.routes.url_helpers.file_url(id, locale: nil, protocol: protocol)
+    end
+
+    def blob
+      @blob ||= ActiveStorage::Blob.find(blob_id)
+    end
+
+    def resizeable
+      resize.present? && !blob.content_type.include?("svg")
+    end
+
+    def variant
+      @variantvariant ||= resizeable ? blob.representation(resize: resize).processed : blob
+    end
+
+    def file
+      @file ||= blob.service.download(variant.key)
+    end
+
+    private
+
+    def id
+      @id ||= message_verifier.generate([blob_id, resize])
+    end
+  end
+end

data/lib/shimmer/utils/localizable.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Localizable
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_locale
+
+      def default_url_options(options = {})
+        options = {locale: I18n.locale}.merge options
+        options[:debug] = true if I18n.debug?
+        options
+      end
+
+      def request_locale
+        request.env["HTTP_ACCEPT_LANGUAGE"].to_s[0..1].downcase.presence&.then { |e| e if I18n.available_locales.include?(e.to_sym) }
+      end
+
+      def set_locale
+        I18n.locale = url_locale || request_locale || I18n.default_locale
+        I18n.debug = params.key?(:debug)
+      end
+
+      def check_locale
+        redirect_to url_for(locale: I18n.locale) if params[:locale].blank? && request.get? && request.format.html?
+      end
+
+      def url_locale
+        params[:locale]
+      end
+    end
+  end
+end
+
+module I18n
+  UNTRANSLATED_SCOPES = ["number", "transliterate", "date", "datetime", "errors", "helpers", "support", "time", "faker"].map { |k| "#{k}." }
+
+  thread_mattr_accessor :debug
+
+  class << self
+    alias_method :old_translate, :translate
+    def translate(key, options = {})
+      key = key.to_s.downcase
+      untranslated = UNTRANSLATED_SCOPES.any? { |e| key.include? e }
+      key_name = [options[:scope], key].flatten.compact.join(".")
+      option_names = options.except(:count, :default, :raise, :scope).map { |k, v| "#{k}=#{v}" }.join(", ")
+      return "#{key_name} #{option_names}" if I18n.debug && !untranslated
+
+      options.reverse_merge!(default: old_translate(key, **options.merge(locale: :de))) if untranslated
+      old_translate(key, **options)
+    end
+    alias_method :t, :translate
+
+    def debug?
+      debug
+    end
+  end
+end

data/lib/shimmer/utils/remote_navigation.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module RemoteNavigation
+    extend ActiveSupport::Concern
+
+    included do
+      def ui
+        @ui ||= RemoteNavigator.new turbo_stream: turbo_stream
+      end
+
+      def default_render
+        return render_modal if shimmer_request?
+        return super unless ui.updates?
+
+        render turbo_stream: ui.queued_updates.join("\n")
+      end
+
+      helper_method :modal_path
+      def modal_path(url, id: nil, size: nil, close: false)
+        "javascript:ui.modal.open(#{{url: url, id: id, size: size, close: close}.to_json})"
+      end
+
+      helper_method :close_modal_path
+      def close_modal_path(id: nil)
+        "javascript:ui.modal.close(#{{id: id}.to_json})"
+      end
+
+      def shimmer_request?
+        request.headers["X-Shimmer"].present?
+      end
+
+      def render_modal
+        enforce_modal
+        render layout: false
+      end
+
+      def enforce_modal
+        raise "trying to render a modal from a regular request" unless shimmer_request?
+      end
+    end
+  end
+
+  class RemoteNavigator
+    attr_reader :turbo_stream
+
+    def initialize(turbo_stream:)
+      @turbo_stream = turbo_stream
+    end
+
+    def queued_updates
+      @queued_updates ||= []
+    end
+
+    def updates?
+      queued_updates.any?
+    end
+
+    def run_javascript(script)
+      queued_updates.push turbo_stream.append "shimmer", "<div class='hidden' data-controller='remote-navigation'>#{script}</div>"
+    end
+
+    def replace(id, with: id, **locals)
+      queued_updates.push turbo_stream.replace(id, partial: with, locals: locals)
+    end
+
+    def prepend(id, with:, **locals)
+      queued_updates.push turbo_stream.prepend(id, partial: with, locals: locals)
+    end
+
+    def append(id, with:, **locals)
+      queued_updates.push turbo_stream.append(id, partial: with, locals: locals)
+    end
+
+    def remove(id)
+      queued_updates.push turbo_stream.remove(id)
+    end
+
+    def open_modal(path)
+      run_javascript "ui.modal.open('#{path}')"
+    end
+
+    def close_modal
+      run_javascript "ui.modal.close()"
+    end
+
+    def navigate_to(path)
+      close_modal
+      path = polymorphic_path(path) unless path.is_a?(String)
+      run_javascript "Turbo.visit('#{path}')"
+    end
+  end
+end

data/lib/shimmer/utils/sitemap_adapter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Shimmer
+  class SitemapAdapter
+    def write(location, raw_data)
+      SitemapGenerator::FileAdapter.new.write(location, raw_data)
+      ActiveStorage::Blob.service.upload("sitemaps/#{location.path_in_public}", File.open(location.path))
+    end
+  end
+end

data/lib/shimmer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shimmer
-  VERSION = "0.0.1"
+  VERSION = "0.0.4"
 end

data/lib/shimmer.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 require_relative "shimmer/version"
+require_relative "shimmer/railtie" if defined?(Rails::Railtie)
+Dir["#{File.expand_path("../lib/shimmer/middlewares", __dir__)}/*"].each { |e| require e }
+Dir["#{File.expand_path("../lib/shimmer/controllers", __dir__)}/*"].each { |e| require e }
+Dir["#{File.expand_path("../lib/shimmer/jobs", __dir__)}/*"].each { |e| require e }
+Dir["#{File.expand_path("../lib/shimmer/utils", __dir__)}/*"].each { |e| require e }
 
 module Shimmer
   class Error < StandardError; end

data/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@nerdgeschoss/shimmer",
+  "version": "0.0.1",
+  "description": "Simple application development in Rails",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "yarn build:js && yarn build:types",
+    "build:js": "NODE_ENV=production rollup -c",
+    "build:types": "tsc --emitDeclarationOnly",
+    "format": "prettier --write \"src/**/*.{ts,css,scss,json,yml}\"",
+    "lint": "yarn lint:types && yarn lint:style",
+    "lint:types": "tsc --noEmit",
+    "lint:style": "eslint src/**/*.ts --max-warnings 0"
+  },
+  "contributors": [
+    "Jens Ravens"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@rails/request.js": "^0.0.6"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.6.0",
+    "@typescript-eslint/parser": "^5.6.0",
+    "esbuild": "^0.14.2",
+    "eslint": "^8.4.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "prettier": "^2.5.1",
+    "rollup": "^2.61.0",
+    "rollup-plugin-cleaner": "^1.0.0",
+    "rollup-plugin-esbuild": "^4.7.2",
+    "typescript": "^4.1.3"
+  },
+  "keywords": [
+    "rails",
+    "form",
+    "modal"
+  ],
+  "bugs": {
+    "url": "https://github.com/nerdgeschoss/shimmer/issues"
+  },
+  "homepage": "https://github.com/nerdgeschoss/shimmer#readme"
+}

data/rollup.config.js

@@ -0,0 +1,26 @@
+import esbuild from "rollup-plugin-esbuild";
+import cleaner from "rollup-plugin-cleaner";
+import pkg from "./package.json";
+
+export default {
+  input: "./src/index.ts",
+  external: ["@rails/request.js"],
+  plugins: [
+    cleaner({
+      targets: ["./dist/"],
+    }),
+    esbuild({
+      target: "es6",
+    }),
+  ],
+  output: [
+    {
+      file: pkg.main,
+      format: "cjs",
+    },
+    {
+      file: pkg.module,
+      format: "es",
+    },
+  ],
+};

data/src/index.ts

@@ -0,0 +1,17 @@
+declare global {
+  interface Window {
+    ui: typeof ui;
+  }
+}
+
+import { ModalPresenter } from "./modal";
+import "./touch";
+
+export const ui = {
+  modal: new ModalPresenter(),
+};
+
+window.ui = ui;
+
+export { registerServiceWorker } from "./serviceworker";
+export { currentLocale } from "./locale";

data/src/locale.ts

@@ -0,0 +1,3 @@
+export function currentLocale(): string {
+  return (document.documentElement.lang || "en") as string;
+}