shimmer 0.0.9 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 166c374942cdbfe22b8a1274633247cb95964439bcd959ca8cdb59a774767f50
-  data.tar.gz: 4e64bb6dc30433b6521c6283e5ad9e1232cdadd6b993a45ba4c27999eebb5c36
+  metadata.gz: '038bb182d1dad60da8ef884f677bf291baed9ffb2e4a14959cd20e55c43f7ff0'
+  data.tar.gz: d5f6c1489a4b285202c2d93d3c9bfd7e8a5ac4b3a17688452e3315782b694511
 SHA512:
-  metadata.gz: 803fcbb251147f224eaa42ce9b5bdca8a2e7d73488e32b7ef01f91abdcff01674b0238b8a0fc0ae2299d69855938a0fe817a9f1b8e1becdfba6cfbc36b8b1595
-  data.tar.gz: 545e5378acb4c46a72fa8604f6e881921d65723008e28561aa688d7a1d83729b23bf7f4b1b0ae1d76328fde2cda0a04f4c8176cc167aa632aeee60e5bcfa465f
+  metadata.gz: f10bade660c8ef17b62388e7ea9ac5d9b7bf40c658e744a1b9050a70bbabb7e2a360d1d10fdceb6fbffa43a002d94113efb3a794d8c233ad75387840f62d60bd
+  data.tar.gz: fbdba908476796302ef9db666285fe57e39a69ae095374d11291cf2ea43c7bfe3bc1c5a6d74c23f2d46e815806ff6f95fe3b1c594834196d7169fe171b605f8a

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_from: config/rubocop_base.yml
+
+# Allow controllers created in this library to inherit directly from ActionController::Base.
+Rails/ApplicationController:
+  Enabled: false
+
+# Allow jobs created in this library to inherit directly from ActiveJob::Base.
+Rails/ApplicationJob:
+  Enabled: false

data/.solargraph.yml

@@ -1,4 +1,4 @@
-plugins:
-  - solargraph-standardrb
 reporters:
-  - standardrb
+  - rubocop
+formatter:
+  - rubocop

data/.vscode/settings.json

@@ -1,3 +1,8 @@
 {
-  "solargraph.useBundler": true
+  "solargraph.useBundler": false,
+  "solargraph.formatting": true,
+  "[ruby]": {
+    "editor.formatOnSave": false,
+    "editor.defaultFormatter": "castwide.solargraph"
+  },
 }

data/Gemfile

@@ -4,7 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in shimmer.gemspec
 gemspec
-
-gem "rake", "~> 13.0"
-gem "standard"
-gem "solargraph-standardrb"

data/Gemfile.lock

@@ -6,29 +6,23 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     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)
+    concurrent-ruby (1.1.10)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
-    racc (1.6.0)
+    rack (2.2.3)
     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)
@@ -44,34 +38,23 @@ GEM
     rubocop-performance (1.12.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.14.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
     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)
+    standardrb (1.0.1)
+      standard
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
-    webrick (1.7.0)
-    yard (0.9.27)
-      webrick (~> 1.7.0)
 
 PLATFORMS
   x86_64-darwin-21
@@ -79,9 +62,13 @@ PLATFORMS
 
 DEPENDENCIES
   rake (~> 13.0)
+  rubocop
+  rubocop-performance
+  rubocop-rails
+  rubocop-rake
+  rubocop-rspec
   shimmer!
-  solargraph-standardrb
-  standard
+  standardrb
 
 BUNDLED WITH
    2.2.32

data/README.md

@@ -4,6 +4,21 @@ Shimmer is a collection of Rails extensions that bring advanced UI features into
 
 ## Features
 
+### Rubocop Base Configuration
+
+*Shimmer* offers an opiniated *Rubocop* base configuration. This configuration inherits itself from *StandardRB* and aim at remaining as close to it as possible. Why not only use *StandardRB*, since it is so fast and prevent bikeshedding? Well, sadly, it does not solve all problems and using *Rubocop* still integrates a lot easier in most toolsets. However, the idea is to still prevent bikeshedding our *Rubocop* configuration by making sure that every exception to what's configured in *StandardRB* is justified (with a comment over its configuration block in `./config/rubocop_base.yml`), reviewed, debated, and agreed upon before being merged.
+
+#### Use Shared Configuration In Projects
+
+Typically, a `.rubocop.yml` file in projects using *Shimmer* looks like this.
+
+```yml
+inherit_gem:
+  shimmer: config/rubocop_base.yml
+```
+
+Then, if there are specific cops you want to use in the specific project you are working on, you still can easily add them. But at least, the base configuration is shared between projects and is itself as close to *StandardRB* as possible.
+
 ### Static File Serving
 
 `ActiveStorage` is great, but serving of files, especially behind a CDN, can be complicated to get right. This can be fixed easily:

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/solargraph

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'solargraph' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("solargraph", "solargraph")

data/config/rubocop_base.yml

@@ -0,0 +1,32 @@
+AllCops:
+  NewCops: disable
+  Exclude:
+    - '**/vendor/bundle/**/*'
+    - '**/bin/**/*'
+    - '**/db/schema.rb'
+    - '**/node_modules/**/*'
+
+require:
+  - standard
+  - rubocop-rails
+  - rubocop-rake
+
+inherit_gem:
+  standard: config/base.yml
+
+# String literals should never be mutable.
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+# Constants should never be mutable.
+Style/MutableConstant:
+  Enabled: true
+  EnforcedStyle: strict
+
+# Allow `.update_all`.
+Rails/SkipsModelValidations:
+  Enabled: false
+
+# Allow Rake tasks to not require the full Rails app to be loaded.
+Rails/RakeEnvironment:
+  Enabled: false

data/lib/shimmer/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shimmer
   class Railtie < Rails::Railtie
     rake_tasks do

data/lib/shimmer/tasks/db.rake

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 namespace :db do
-  desc "Downloads the app database from heroku to local db"
+  desc "Downloads the app database from Heroku and imports it to the local database"
   task pull_data: :environment do
     config = if Rails.version.to_f >= 7
       ActiveRecord::Base.connection_db_config.configuration_hash.with_indifferent_access
@@ -18,6 +18,7 @@ namespace :db do
     sh "RAILS_ENV=test rails db:create"
   end
 
+  desc "Downloads the app assets from Heroku to directory `storage`."
   task pull_assets: :environment do
     config = JSON.parse(`heroku config --json`)
     ENV["AWS_DEFAULT_REGION"] = config.fetch("AWS_REGION")

data/lib/shimmer/utils/file_proxy.rb

@@ -45,7 +45,7 @@ module Shimmer
     end
 
     def resizeable
-      resize.present? && !blob.content_type.include?("svg")
+      resize.present? && blob.content_type.exclude?("svg")
     end
 
     def variant

data/lib/shimmer/utils/localizable.rb

@@ -45,7 +45,6 @@ module Shimmer
             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

data/lib/shimmer/utils/remote_navigation.rb

@@ -81,15 +81,19 @@ module Shimmer
       queued_updates.push turbo_stream.remove(id)
     end
 
-    def open_modal(path, id: nil, size: nil, close: true)
+    def open_modal(url, id: nil, size: nil, close: true)
       run_javascript "ui.modal.open(#{{url: url, id: id, size: size, close: close}.to_json})"
     end
 
-    def close_modal
-      run_javascript "ui.modal.close()"
+    def close_modal(id = nil)
+      if id.present?
+        run_javascript "ui.modal.close('#{id}')"
+      else
+        run_javascript "ui.modal.close()"
+      end
     end
 
-    def open_popover(path, selector:, placement: nil)
+    def open_popover(url, selector:, placement: nil)
       run_javascript "ui.popover.open(#{{url: url, selector: selector, placement: placement}.to_json})"
     end
 

data/lib/shimmer/version.rb

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

data/lib/shimmer.rb

@@ -2,10 +2,10 @@
 
 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 }
+Dir["#{File.expand_path("../lib/shimmer/middlewares", __dir__)}/*"].sort.each { |e| require e }
+Dir["#{File.expand_path("../lib/shimmer/controllers", __dir__)}/*"].sort.each { |e| require e }
+Dir["#{File.expand_path("../lib/shimmer/jobs", __dir__)}/*"].sort.each { |e| require e }
+Dir["#{File.expand_path("../lib/shimmer/utils", __dir__)}/*"].sort.each { |e| require e }
 
 module Shimmer
   class Error < StandardError; end

data/src/index.ts

@@ -16,14 +16,22 @@ declare global {
   }
 }
 
+function createRemoteDestination(): void {
+  if (document.getElementById("shimmer")) {
+    return;
+  }
+  const root = document.createElement("div");
+  root.id = "shimmer";
+  document.body.append(root);
+}
+
 export async function start({
   application,
 }: {
   application: Application;
 }): Promise<void> {
-  const root = document.createElement("div");
-  root.id = "shimmer";
-  document.body.append(root);
+  window.addEventListener("turbo:load", createRemoteDestination);
+  createRemoteDestination();
   application.register("remote-navigation", RemoteNavigationController);
   window.ui = {
     modal: new ModalPresenter(),

data/src/modal.ts

@@ -1,4 +1,4 @@
-import { createElement, nextFrame, getHTML } from "./util";
+import { createElement, nextFrame, getHTML, guid, wait } from "./util";
 
 export interface ModalOptions {
   id?: string;
@@ -15,7 +15,7 @@ export class ModalPresenter {
   }
 
   async open(options: ModalOptions): Promise<void> {
-    const id = (options.id = options.id ?? "default-modal");
+    const id = (options.id = options.id ?? guid());
     (this.modals[id] = new Modal({ presenter: this, id })).open(options);
     this.updateBlindStatus();
   }
@@ -44,30 +44,41 @@ export class ModalPresenter {
 }
 
 export class Modal {
-  private readonly root: HTMLDivElement;
-  private readonly frame: HTMLDivElement;
-  private readonly closeButton: HTMLDivElement;
+  id: string;
+  private presenter: ModalPresenter;
+  private root?: HTMLDivElement;
 
   constructor({ presenter, id }: { presenter: ModalPresenter; id: string }) {
-    this.root = createElement(document.body, "modal");
-    const content = createElement(this.root, "modal__content");
-    this.closeButton = createElement(content, "modal__close");
-    this.closeButton.addEventListener("click", () => {
-      presenter.close({ id });
-    });
-    this.frame = createElement(content, "modal__frame");
+    this.presenter = presenter;
+    this.id = id;
   }
 
   async open({ size, url, close }: ModalOptions): Promise<void> {
+    const root = createElement(document.body, "modal");
+    this.root = root;
+    const content = createElement(root, "modal__content");
+    const closeButton = createElement(content, "modal__close");
+    closeButton.addEventListener("click", () => {
+      this.presenter.close({ id: this.id });
+    });
+    const frame = createElement(content, "modal__frame");
     await nextFrame();
-    this.closeButton.style.display = close ?? true ? "block" : "none";
-    this.root.classList.add("modal--open");
-    this.root.classList.add("modal--loading");
-    this.root.classList.toggle("modal--small", size === "small");
-    this.frame.innerHTML = await getHTML(url);
+    closeButton.style.display = close ?? true ? "block" : "none";
+    root.classList.add("modal--open");
+    root.classList.add("modal--loading");
+    root.classList.toggle("modal--small", size === "small");
+    frame.innerHTML = await getHTML(url);
+    root.classList.remove("modal--loading");
   }
 
   async close(): Promise<void> {
-    this.root.classList.remove("modal--open");
+    const root = this.root;
+    if (!root) {
+      return;
+    }
+    root.classList.remove("modal--open");
+    await wait(1);
+    root.remove();
+    this.root = undefined;
   }
 }

data/src/util.ts

@@ -29,3 +29,18 @@ export function createElement(
   parent.append(element);
   return element;
 }
+
+export function guid(): string {
+  function s4(): string {
+    return Math.floor((1 + Math.random()) * 0x10000)
+      .toString(16)
+      .substring(1);
+  }
+  return [s4() + s4(), s4(), s4(), s4(), s4() + s4() + s4()].join("-");
+}
+
+export function wait(seconds: number): Promise<void> {
+  return new Promise((res) => {
+    setTimeout(res, seconds * 1000);
+  });
+}

metadata

@@ -1,15 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: shimmer
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.12
 platform: ruby
 authors:
 - Jens Ravens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
-dependencies: []
+date: 2022-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  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: rubocop
+  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: rubocop-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: rubocop-performance
+  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: rubocop-rspec
+  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: rubocop-rake
+  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: 
 email:
 - jens@nerdgeschoss.de
@@ -20,6 +118,7 @@ files:
 - ".editorconfig"
 - ".eslintrc.js"
 - ".prettierrc"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".solargraph.yml"
 - ".vscode/settings.json"
@@ -31,7 +130,10 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rubocop
 - bin/setup
+- bin/solargraph
+- config/rubocop_base.yml
 - lib/shimmer.rb
 - lib/shimmer/controllers/files_controller.rb
 - lib/shimmer/controllers/sitemaps_controller.rb