shimmer 0.0.1 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36dcc714d5d4ddff50af58d02889b9c193754c8a8c8a48b38e989f898805adc5
-  data.tar.gz: 3a3d6e7b848df467c7aa6ceb2f51071cd325f06da912dbc2926f0f7b7d986193
+  metadata.gz: f4c44b134bb61f78f82008a1907c738d358b48147ad6518211b7ffcef9fa4aab
+  data.tar.gz: 4b7eb93d01ed55818f0845498e3b33a531352dde7d72b491addded5a77f81ce5
 SHA512:
-  metadata.gz: 7716f31b96c8d62da7c94151b59a6006ef12ddd918314aceb3026094cfb414634285e583979e0bc6b0932e16d36e95b69199d0e83c03933148ceaaf3002eac0d
-  data.tar.gz: 64803d66f26ed93da2265b453493bfe768344273cabb9e0c077678d7c881d73eebdee1701801767adef198da8cda100cc72f5486687c56df2fdb8de865f84dac
+  metadata.gz: 49e8e4866c5d8bafc59d5ccbcac324afd214d2e83f31845a3ff207400059f25061629261ab494fbaf2d2ce1f8be575f978938f11b347d7e751606724e48b666d
+  data.tar.gz: 1e0892571dc244cd238be164c61d4c1b5480e38a994dc266c1d8e8652102a89efcf4ffa8686dd7d8d439dad8aad5080b2faadaa6b3b426f933567a36e16e7b7e

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/README.md

@@ -1,38 +1,196 @@
-# Shimmer
+# Shimmer - Because Ruby could be more shiny!
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shimmer`. To experiment with that code, run `bin/console` for an interactive prompt.
+Shimmer is a collection of Rails extensions that bring advanced UI features into your app and make your life easier as a developer.
 
-TODO: Delete this and the text above, and describe your gem
+## Features
+
+### 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:
+
+```ruby
+# use an image tag
+image_tag user.avatar, width: 300
+```
+
+This extension overrides `image_tag` and also supplies a matching `image_file_url` that automatically resizes your image and creates a static, cacheable url.
+
+### Modals
+
+Modals are the designer's best friend, but developers usually hate them for their complexity. Fear no more: Shimmer has you covered.
+
+```slim
+a href=modal_path(new_post_path) Create a new Post
+```
+
+This will open a modal on click and then asynchronously request the modal content from the controller. Modals can also be controlled via JavaScript via the global `ui` variable:
+
+```js
+ui.modal.open({ url: "/posts/new" });
+ui.modal.close();
+```
+
+### Popovers
+
+When modals are annoying to implement, popovers are even worse. Thankfully, Shimmer comes to the rescue:
+
+```slim
+a href=popover_path(new_post_path, placement: :left)
+```
+
+This will request `new_post_path` and display it left of the anchor thanks to PopperJS.
+
+### Remote Navigation
+
+Remote navigation takes Hotwire to the next level with built-in navigation actions, integrated with modals and popovers.
+
+```ruby
+def create
+  @post = current_user.posts.create! post_params
+  ui.navigate_to @post
+end
+```
+
+This will automatically close the current modal or popover and navigate via Turbo Drive to the post's url - no redirects necessary.
+
+The `ui` helper comes with several built-in functions:
+
+```ruby
+# run any kind of javascript upon request completion
+ui.run_javascript("alert('hello world')")
+
+# open or replace a modal's content (dependent on its ID)
+ui.open_modal(new_post_path, size: :small)
+
+# close an open modal
+ui.close_modal
+
+# same methods also available for popovers
+ui.open_popover(new_post_path, selector: "#user-profile", placement: :left)
+ui.close_popover
+
+# navigate via Turbo Drive
+ui.navigate_to(@post)
+
+# manipulate the page's content
+ui.append(@post, with: "comments/comment", comment: @comment)
+ui.prepend("#user-profile", with: "users/extra")
+ui.replace(@post)
+ui.remove(@post)
+```
+
+### Sitemaps
+
+Want to implement sitemaps, but the ephemeral filesystem of Heroku hates you? Here's a simple way to upload sitemaps:
+
+- install the sitemap gem and configure the `sitemap.rb` as usual
+- use the shimmer adapter to automatically upload your sitemap to your configured ActiveStorage adapter
+- use the shimmer controller to display the sitemap in your app
+- (optional) tell sidekiq scheduler to regularly update your sitemap
+
+```ruby
+# sitemap.rb
+SitemapGenerator::Sitemap.adapter = Shimmer::SitemapAdapter.new
+
+# routes.rb
+get "sitemaps/*path", to: "shimmer/sitemaps#show"
+
+# sidekiq.yml
+:schedule:
+  sitemap:
+    cron: '0 0 12 * * * Europe/Berlin' # every day at 16:00, Berlin time
+    class: Shimmer::SitemapJob
+```
+
+### Cloudflare Support
+
+As you might have noticed, Cloudflare SSL will cause some issues with your Rails app if you're not using SSL strict mode (https://github.com/rails/rails/issues/22965). If you can't switch to strict mode, go for the standard flexible mode instead and add this middleware to your stack:
+
+```ruby
+# application.rb
+config.middleware.use Shimmer::CloudflareProxy
+```
+
+### Heroku Database Helpers
+
+Can't reproduce an issue with your local test data and just want the production or staging data on your development machine? Here you go:
+
+```bash
+rails db:pull
+```
+
+This will drop your local database and pull in the database of your connected Heroku app (make sure you executed `heroku git:remote -a your_app` before to have the git remote). But what about assets you might ask? Easy - assets are pulled from S3 as well via the AWS CLI automatically (make sure your environment variables in Heroku are correctly named as `AWS_REGION`, `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`) and the database is updated to use your local filesystem instead.
+
+If you don't want the asset support, you can also only pull the database or only the assets:
+
+```bash
+rails db:pull_data
+rails db:pull_assets
+```
+
+### Localizable Routes with Browser Locale Support
+
+To localize a page via urls, this will help you tremendously.
+
+```ruby
+# routes.rb
+Rails.application.routes.draw do
+  scope "/(:locale)", locale: /#{I18n.available_locales.join("|")}/ do
+    get "login", to: "sessions#new"
+  end
+end
+```
+
+From now on you can prefix your routes with a locale like `/de/login` or `/en/login` and `I18n.locale` will automatically be set. If there is no locale in the url (it's optional), this will automatically use the browser's locale.
+
+You want to redirect from unlocalized paths? Add a before action to your controller:
+
+```ruby
+before_action :check_locale
+```
+
+Trying to figure out which key a certain translation on the page has? Append `?debug` to the url and `I18n.debug?` will be set - which leads to keys being printed on the page.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'shimmer'
+gem "shimmer"
 ```
 
 And then execute:
 
-    $ bundle install
+```bash
+$ bundle install
+```
 
-Or install it yourself as:
+Add some configuration to your project:
 
-    $ gem install shimmer
+```ruby
+# routes.rb
 
-## Usage
+resources :files, only: :show, controller: "shimmer/files"
 
-TODO: Write usage instructions here
+# application_controller.rb
+class ApplicationController < ActionController::Base
+  include Shimmer::Localizable
+  include Shimmer::RemoteNavigation
+end
+```
 
-## Development
+```ts
+// application.ts
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+import { start } from "@nerdgeschoss/shimmer";
+import { application } from "controllers/application";
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+start({ application });
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shimmer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/shimmer/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/nerdgeschoss/shimmer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nerdgeschoss/shimmer/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +198,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Shimmer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/shimmer/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Shimmer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nerdgeschoss/shimmer/blob/master/CODE_OF_CONDUCT.md).

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,58 @@
+# 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
+
+      I18n.class_eval do
+        thread_mattr_accessor :debug
+
+        class << self
+          alias_method :old_translate, :translate
+          def translate(key, options = {})
+            untranslated_scopes = ["number", "transliterate", "date", "datetime", "errors", "helpers", "support", "time", "faker"].map { |k| "#{k}." }
+            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
+    end
+  end
+end