shimmer 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 419d4bba740070b286202f099a64f31929b029505bc3411a9db8b922d51e0eec
-  data.tar.gz: 5f75ac2e0c8ac3fc82335efe2dd8bd98270f9506433bfa0e894369e952fb6aef
+  metadata.gz: bfbc6b047d278bdb23bcb528277c436b79bc625b577d1d8c94c113644fdcbcf3
+  data.tar.gz: 5002fecacde7a232259b2f0bd8652f8ab2e1a544758efe42db324f4e99907b27
 SHA512:
-  metadata.gz: ec203c95a4fc2088731aa269c0c27577fbd59fa4070d972d6ad066d469b6203b54fb8ffafedb4295d7387e981d6a50a87ca981f8c92c9f5c624d45aed851b906
-  data.tar.gz: cdae8b03095d4f3c7f38f5ccbe47864ab41ade50bf1e2d45fe3da2e112e2a11e3d733ed73d2b581a833be9d6f5f263795aff008ccfcd5da51d45c52227a560c9
+  metadata.gz: e6a8c5ed0339cb8ae2f924b0d4eeb97554388e479ff37cfa76a688db62d4bcb7303385567c2cf673c983c656fc49bdd808189a188dca52bb30cff4725be02292
+  data.tar.gz: 7c027ab85b75df7b495539486f702f054d794fb393b18b3676f4c99e083fe822b8cd22c313a649ab509ea8f3428d08a533a65e7ef000bd33be04f35dbb6f0fba

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shimmer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jens Ravens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-22 00:00:00.000000000 Z
+date: 2021-12-28 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: