Merge pull request #178 from prograils/cleanup_making_lit_zeitwerk_and_classic_compatible

Cleanup making lit zeitwerk and classic compatible

Author: mlitwiniuk

.travis.yml

@@ -1,7 +1,11 @@
 language: ruby
+jobs:
+  exclude:
+    - rvm: 3.0.1
+      gemfile: gemfiles/rails_5.2.gemfile
 rvm:
   - 2.7.3
-  - 3.0.0
+  - 3.0.1
 gemfile:
   - gemfiles/rails_5.2.gemfile
   - gemfiles/rails_6.0.gemfile

README.md

@@ -22,9 +22,14 @@ Highly inspired by Copycopter by thoughtbot.
 9. (On request) stores paths where translation keys were called
 10. (On request) is able to show all translation keys used to render current page
 
+
 ### Screenshots
 
-Check wiki: [Screenshots](https://github.com/prograils/lit/wiki/Screenshots)
+[Feature overview on YouTube](https://www.youtube.com/watch?v=_T9Kg05VvLI)
+
+![lit live translation](https://prograils-com-stuff.s3.amazonaws.com/lit/lit-front.gif)
+
+Check wiki for more: [Screenshots](https://github.com/prograils/lit/wiki/Screenshots)
 
 ### Installation
 
@@ -199,31 +204,32 @@ Also applies to upgrading from `0.4.pre.alpha` versions.
 
 1. Add `Lit::FrontendHelper` to your `ApplicationController`
 
-	```ruby
-	helper Lit::FrontendHelper
-	```
+```ruby
+helper Lit::FrontendHelper
+```
 
 2. In you layout file include lit assets
 
-	```erb
-	<% if admin_user_signed_in? %>
-	  <%= lit_frontend_assets %>
-	<% end %>
-	```
+```erb
+<% if admin_user_signed_in? %>
+  <%= lit_frontend_assets %>
+<% end %>
+```
 
 3. You're good to go - now log in to lit (if required) and open your frontend in separate tab (to have session persisted). On the bottom-right of your page you should see "Enable / disable lit highlight" - after enabling it you'll be able to click and translate phrases directly in your frontend
 
 4. Once enabled, all translations called via `t` helper function be rendered inside `<span />` tag, what may break your layout (ie if you're using translated values as button values or as placeholders, etc). To avoid that add `skip_lit: true` to `t()` call or use `I18n.t`.
 
 5. This feature requires jQuery! (at least for now)
 
+
 ### Storing request info
 
-1. Include `Lit::Concerns::RequestInfoStore` concern in your `ApplicationController`
+1. Include `Lit::RequestInfoStore` concern in your `ApplicationController`
 
-	```ruby
-	include Lit::Concerns::RequestInfoStore
-	```
+```ruby
+include Lit::RequestInfoStore
+```
 
 2. In lit initializer (`lit.rb`) set `store_request_info` config to true
 
@@ -238,25 +244,31 @@ Lit.store_request_info = true
 
 1. Add `Lit::FrontendHelper` in your `ApplicationController`
 
-	```ruby
-	include Lit::FrontendHelper
-	```
+```ruby
+helper Lit::FrontendHelper
+```
 
-2. Include `Lit::Concerns::RequestKeysStore` concern in your `ApplicationController`
+2. Include `Lit::RequestKeysStore` concern in your `ApplicationController`
 
-	```ruby
-	include Lit::Concerns::RequestKeysStore
-	```
+```ruby
+include Lit::RequestKeysStore
+```
 
-3. On the bottom of you layout file call `lit_translations_info` helper function
+3. Enable storing of request keys in lit initializer `config/initializers/lit.rb`
 
-	```erb
-	<%= lit_translations_info %>
-	```
+```ruby
+Lit.store_request_keys = true
+```
+
+4. On the bottom of you layout file call `lit_translations_info` helper function
+
+```erb
+<%= lit_translations_info %>
+```
 
-4. From now on you'll be able to see all translation keys that were used to render current page. This feature works great with on-site live translations!
+5. From now on you'll be able to see all translation keys that were used to render current page. This feature works great with on-site live translations!
 
-5. Lit authorized user must be signed in for this feature to work! This feature requires jQuery!
+6. Lit authorized user must be signed in for this feature to work! This feature requires jQuery!
 
 
 

app/assets/stylesheets/lit/lit_frontend.css

@@ -1,9 +1,11 @@
 .lit-key-generic {
 }
-.lit-key-highlight{
-  text-decoration: underline wavy red !important;
+.lit-key-highlight {
+  text-decoration: underline !important;
+  text-decoration-color: red !important;
+  text-decoration-style: wavy !important;
 }
-#lit_button_wrapper{
+#lit_button_wrapper {
   position: fixed;
   bottom: 20px;
   right: 20px;
@@ -15,16 +17,15 @@
   cursor: pointer;
   color: white;
 }
-#lit_button_wrapper.lit-highlight-enabled{
+#lit_button_wrapper.lit-highlight-enabled {
   background-color: lightgreen;
 }
-#lit_textarea{
+#lit_textarea {
   position: absolute;
   padding: 0 0 1px 0;
   margin: 0 0 0 0;
   border: 0;
   border-bottom: 1px solid red;
-
 }
 .lit-translations-info.collapsed {
   position: fixed;
@@ -38,7 +39,7 @@
   cursor: pointer;
   color: white;
 }
-.lit-translations-info.expanded{
+.lit-translations-info.expanded {
   position: absolute;
   display: block;
   width: 80%;
@@ -52,16 +53,16 @@
   z-index: 90;
 }
 
-.lit-translations-info.collapsed span.lit-open-button{
+.lit-translations-info.collapsed span.lit-open-button {
   display: block;
 }
-.lit-translations-info.expanded span.lit-open-button{
+.lit-translations-info.expanded span.lit-open-button {
   display: none;
 }
-.lit-translations-info.collapsed span.lit-close-button{
+.lit-translations-info.collapsed span.lit-close-button {
   display: none;
 }
-.lit-translations-info.expanded span.lit-close-button{
+.lit-translations-info.expanded span.lit-close-button {
   display: block;
   position: fixed;
   right: 10%;
@@ -71,16 +72,16 @@
   background-color: white;
   padding: 10px 10px 5px;
 }
-.lit-translations-info.collapsed ul.lit-translations-list{
+.lit-translations-info.collapsed ul.lit-translations-list {
   display: none;
 }
-.lit-translations-info.expanded ul.lit-translations-list{
+.lit-translations-info.expanded ul.lit-translations-list {
 }
 
-.lit-translations-info.expanded ul.lit-translations-list li{
+.lit-translations-info.expanded ul.lit-translations-list li {
   margin: 5px;
 }
 
-.lit-translations-info.expanded #lit_textarea{
+.lit-translations-info.expanded #lit_textarea {
   padding: 2px;
 }

app/controllers/lit/concerns/request_info_store.rb

@@ -1,18 +1,3 @@
-module Lit
-  module RequestInfoStore
-    extend ::ActiveSupport::Concern
-    included do
-      before_action :store_request_path
-    end
-
-    private
-
-    def store_request_path
-      Thread.current[:lit_current_request_path] = request&.path
-    end
-  end
-end
-
 module Lit::Concerns::RequestInfoStore
   extend ActiveSupport::Concern
 

app/controllers/lit/concerns/request_keys_store.rb

@@ -1,18 +1,3 @@
-module Lit
-  module RequestKeysStore
-    extend ::ActiveSupport::Concern
-    included do
-      before_action :init_request_keys
-    end
-
-    private
-
-    def init_request_keys
-      Thread.current[:lit_request_keys] = {}
-    end
-  end
-end
-
 module Lit::Concerns::RequestKeysStore
   extend ActiveSupport::Concern
 

app/controllers/lit/request_info_store.rb

@@ -0,0 +1,10 @@
+module Lit::RequestInfoStore
+  extend ::ActiveSupport::Concern
+  included { before_action :store_request_path }
+
+  private
+
+  def store_request_path
+    Thread.current[:lit_current_request_path] = request&.path
+  end
+end

app/controllers/lit/request_keys_store.rb

@@ -0,0 +1,10 @@
+module Lit::RequestKeysStore
+  extend ::ActiveSupport::Concern
+  included { before_action :init_request_keys }
+
+  private
+
+  def init_request_keys
+    Thread.current[:lit_request_keys] = {}
+  end
+end