RubyGems - hot-glue - Versions diffs - 0.2.5 → 0.2.6 - Mend

hot-glue 0.2.5 → 0.2.6

Files changed (9) hide show

checksums.yaml +4 -4
data/Gemfile.lock +1 -1
data/README.md +172 -86
data/app/views/layouts/_flash_notices.erb +12 -0
data/lib/generators/hot_glue/install_generator.rb +34 -11
data/lib/generators/hot_glue/templates/capybara_login.rb +8 -0
data/lib/generators/hot_glue/templates/controller.rb.erb +2 -0
data/lib/hotglue/version.rb +1 -1
metadata +4 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31420297af512f9e5153ff91ff0b15baec2650080938b9a1def230de42dae0a3
-  data.tar.gz: cf430cad34867b7113f48a56e06b7b195a476ae1090da28f06796b10a7eccf94
+  metadata.gz: 2000db5bcae078cadbe8afc0bc3d53750d0baa453ca5e627962b3a6b2b6615e1
+  data.tar.gz: 6ce4745eb0e6a67cd37ede9db75eca2d7bddee4bb241c236aebd12c7d0a30502
 SHA512:
-  metadata.gz: 87ccaa42b5ab50ca222ff8c437bc348ab0f40d3c9d9c70f130ff47c2b8fea4ad51e267d6d21a377aa1f9d0bd47493a12b85296ce7b9e49081bd4ea841200ea54
-  data.tar.gz: b64d5bd42d2f571e4a1297b36fcdebe5d65907f63ab87c9f906fcf9576b223ab434e7348023bdd91a5f84ef517cd3576ba2e97ad0ae0f2dcfe108d93a6df2bf0
+  metadata.gz: 126bb570bf44f4a2d3fd36731bf5eca31d416f74eda2b8e1e60ff9ceec0cfc1cff5c03cc2f185b37a354f7c7a6e7c4812fa5187286c731d5702b0d77dadc5103
+  data.tar.gz: 91cd67558e8910b5369886634eadc6b98a7be6d6b629e829f1cd81656579e86b015fa671f5636848f69be3af36aa0be551b19fef86117a45563d9ba35e49c2ab

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hot-glue (0.2.4)
+    hot-glue (0.2.5)
       ffaker (~> 2.16)
       haml-rails (~> 2.0)
       kaminari (~> 1.2)

data/README.md CHANGED Viewed

@@ -54,119 +54,163 @@ Instantly get a simple CRUD interface
 ![hot-glue-4](https://user-images.githubusercontent.com/59002/116405517-c2b2e300-a7fd-11eb-8423-d43e3afc9fa6.gif)
-## TO INSTALL (RAILS 7)
-- Install Turbo `rails turbo:install` (?)
-- Add `gem 'hot-glue'` to your Gemfile
-- `bundle install`
-- `rails generate hot_glue:install --markup=erb` for ERB
-- or `rails generate hot_glue:install --markup=haml` for HAML
-- Add to your `application.html.erb`
+## ADD HOTWIRE
 ```
-  <%= render partial: 'layouts/flash_notices' %>
+yarn add @hotwired/turbo-rails
 ```
-- Or for Haml add to your `application.haml`
+or `npm install @hotwired/turbo-rails`
+## ADD HOT-GLUE GEM
+- Add `gem 'hot-glue'` to your Gemfile & `bundle install`
+## ADD RSPEC, FACTORY-BOT, AND FFAKER
+add these 3 gems to your gemfile inside :development and :test groups
 ```
-    = render partial: 'layouts/flash_notices'
+gem 'rspec-rails'
+gem 'factory_bot_rails'
+gem 'ffaker'
 ```
-## TO INSTALL (RAILS 6)
+## RUN THE RSPEC INSTALLER
+- run `rails generate rspec:install`
+## RUN HOT-GLUE INSTALL
+### FOR ERB:
+`rails generate hot_glue:install --markup=erb`
+### FOR HAML:
+`rails generate hot_glue:install --markup=haml`
+## FOR RAILS 6 ONLY: SWITCH FROM TurblLinks to Turbo-Rails  (SKIP THIS STEP FOR RAILS 7)
+(THIS WAS AUTOMATICALLY DONE BY THE HOT GLUE INSTALLATION -- CONFIRM CHANGES ONLY)
 - Add `gem 'turbo-rails'` to your Gemfile & `bundle install`
 - Then install it with `rails turbo:install`
 - The Turbo install has switched your action cable settings from 'async' to Redis, so be sure to start a redis server
-- Add `gem 'hot-glue'` to your Gemfile & `bundle install`
-- in `javascript/packs/application.js` remove this line:
-`import Turbolinks from "turbolinks"`
+- in `app/javascript/packs/application.js` remove this line
+```
+import Turbolinks from "turbolinks"
+```
+and replace it with
+```
+import { Turbo } from "@hotwired/turbo-rails"
+```
-- in the same file (`javascript/packs/application.js`) add this line:
-`import { Turbo } from "@hotwired/turbo-rails"`
-- Run the hot-glue install generator
+Also replace
+```
+Turbolinks.start()
+```
+with:
+```
+Turbo.start()
+```
-FOR ERB:
-`rails generate hot_glue:install --markup=erb`
-FOR HAML:
-`rails generate hot_glue:install --markup=haml`
+## Modify `application.html.erb`
+(THIS WAS AUTOMATICALLY DONE BY THE HOT GLUE INSTALLATION -- CONFIRM CHANGES ONLY)
+Note: if you have some kind of non-standard application layout, like one at a different file
+or if you have modified your opening <body> tag, this may not have been automatically applied by the installer.
-- Add to your `application.html.erb`
+- This was added to your `application.html.erb`
 ```
   <%= render partial: 'layouts/flash_notices' %>
 ```
+## Modify `rails_helper.rb`
+(THIS WAS AUTOMATICALLY DONE BY THE HOT GLUE INSTALLATION)
+Note: if you have some kind of non-standard rails_helper.rb, like one that does not use the standard ` do |config|` syntax after your `RSpec.configure`
+this may not have been automatically applied by the installer.
-## Rspec setup
-  - add `gem 'rspec-rails'` to your gemfile inside :development and :test
-  - add `gem 'factory_bot_rails'` to your gemfile inside :development and :test
-  - more info:
-      https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#rspec
+- configure Rspec to work with Factory Bot inside of `rails_helper.rb`
+  ```
+  RSpec.configure do |config|
+      // ... more rspec configuration (not shown)
+      config.include FactoryBot::Syntax::Methods
+  end
+  ```
-  - add `gem 'ffaker'` to your Gemfile inside the  :development and :test groups
-  -
-  - run `rails generate rspec:install`
-  - configure Rspec to work with Factory Bot inside of `rails_helper.rb`
-    ```
-    RSpec.configure do |config|
-        // ... more rspec configuration (not shown)
-        config.include FactoryBot::Syntax::Methods
-    end
-    ```
-  - add to rails_helper.rb (inside the existing Rspec.configure block)
-  -  ````
-config.include FactoryBot::Syntax::Methods
-````
-  - also add to rails_helper.rb (outside of the Rspec.configure block)
-    ```
-    Capybara.register_driver :headless_chrome_desktop do |app|
-      options = Selenium::WebDriver::Chrome::Options.new
-      options.add_argument('--headless')
-      options.add_argument('--disable-gpu')
-      options.add_argument('--window-size=1280,1200')
+## CAPYBARA: SWITCH FROM RACK-TEST TO HEADLESS CHROME
+(THIS WAS AUTOMATICALLY DONE BY THE HOT GLUE INSTALLATION)
+- By default Capybara is installed with :rack_test as its driver.
+- This does not support Javascript, and the code from Hot Glue IS NOT fallback compatible-- it will not work on non-Javascript browsers.
+- From the [Capybara docs](https://github.com/teamcapybara/capybara#drivers):
+```
+By default, Capybara uses the :rack_test driver, which is fast but limited: it does not support JavaScript
+```
+- To fix this, you must switch to a Javascript-supporting Capybara driver. You can choose one of:
+-
+```
+Capybara.default_driver = :selenium
+```
+```
+Capybara.default_driver = :selenium_chrome
+```
+By default, the installer should have added this option to your `rails_helper.rb` file:
+```
+Capybara.default_driver = :selenium_chrome_headless
+```
+Alternatively, can define your own driver like so:
+  ```
+  Capybara.register_driver :my_headless_chrome_desktop do |app|
+    options = Selenium::WebDriver::Chrome::Options.new
+    options.add_argument('--headless')
+    options.add_argument('--disable-gpu')
+    options.add_argument('--window-size=1280,1200')
-      driver = Capybara::Selenium::Driver.new(app,
-                                              browser: :chrome,
-                                              options: options)
+    driver = Capybara::Selenium::Driver.new(app,
+                                            browser: :chrome,
+                                            options: options)
-      driver
-    end
-    Capybara.default_driver = :headless_chrome_desktop
+    driver
+  end
+  Capybara.default_driver = :my_headless_chrome_desktop
-    ```
+  ```
+## Add User Authentication if you are using Access Control
+(THIS WAS AUTOMATICALLY DONE BY THE HOT GLUE INSTALLATION)
   - for a quick Capybara login, create a support helper in `spec/support/` and log-in as your user
-    ```
-    def login_as(account)
-      visit '/accounts/sign_in'
-      within("#new_account") do
-      fill_in 'Email', with: account.email
-      fill_in 'Password', with: 'password'
-      end
-      click_button 'Log in'
-    end
-    ```
+  - in the default code, the devise login would be for an object called account and lives at the route `/accounts/sign_in`
+  - modify the generated code (it was installed by the installed) for your devise login
+     ```
+     def login_as(account)
+       visit '/accounts/sign_in'
+       within("#new_account") do
+       fill_in 'Email', with: account.email
+       fill_in 'Password', with: 'password'
+       end
+       click_button 'Log in'
+     end
+     ```
+## Install Bootstrap using Sprockets (IMPORTANT: YOU DO NOT NEED JQUERY)
-## Install Bootstrap using Sprockets (IMPORTANT: YOU DO NOT NEED JQUERY*)
 Bootstrap with Sprockets for Rails 5 or 7 default — Rails 6 custom
-      - use twbs/bootstrap-rubygem gem
-      - see README for bootstrap-rubygem to install
-Bootstrap with Webpack for FOR RAILS 7 :
-- add to Gemfile
-- gem 'bootstrap', '~> 5.1.0'
+- add `gem 'bootstrap-rubygem'` to your gemfile
+- replace `application.css` with a new file (delete old contents) `application.scss`
+```
+@import "bootstrap";
+```
+- see README at github.com/twbs/bootstrap-rubygem to install
+## Bootstrap with Webpack for FOR RAILS 7 ONLY :
+- add to Gemfile
+- gem 'bootstrap', '~> 5.1.0'
 - completely delete the file `app/assets/application.css`
 - create new file where it was `app/assets/application.scss` with this contents (do not keep the contents of the old application.css file):
 ```
 // Custom bootstrap variables must be set or imported *before* bootstrap.
 @import "bootstrap";
@@ -174,7 +218,7 @@ Bootstrap with Webpack for FOR RAILS 7 :
 * You do not need jQuery for HotGlue to work *
-### Bootstrap with Webpack RAILS 6 ONLY:
+## Bootstrap with Webpack RAILS 6 ONLY:
 - change `stylesheet_link_tag` to `stylesheet_pack_tag` in your application layout
   - run `yarn add bootstrap`
   - create a new file at `app/javascript/require_bootstrap.scss` with this content
@@ -186,14 +230,53 @@ Bootstrap with Webpack for FOR RAILS 7 :
     ```
     import 'require_bootstrap'
     ```
+## RAILS 6 ONLY : Install Devise or implement your own authentication
+(or only use --gd mode, see below)
+  Add to your Gemfile `gem 'devise'`
+```
+rails generate devise:install
+```
+IMPORTNAT: Follow the instructions the Devise installer gives you, *Except Step 3*, you can skip this step:
+```
+ 3. Ensure you have flash messages in app/views/layouts/application.html.erb.
+     For example:
+       <p class="notice"><%= notice %></p>
+       <p class="alert"><%= alert %></p>
+```
+You can also skip Devise Step 4, which is optional:
+```
+  4. You can copy Devise views (for customization) to your app by running:
+       rails g devise:views
+     * Not required *
+```
+## RAILS 7: Devise is not yet supported on Rails 7
+## install font-awesome
+I recommend https://github.com/tomkra/font_awesome5_rails
+or https://github.com/FortAwesome/font-awesome-sass
+## For Enum support, I recommend activerecord-pgenum
+Instructions for Rails are here:
+https://jasonfleetwoodboldt.com/courses/stepping-up-rails/enumerated-types-in-rails-and-postgres/
-## Install Devise or implement your own authentication
-  (or only use --gd mode, see below)
-## install font-awesome. I recommend https://github.com/tomkra/font_awesome5_rails or https://github.com/FortAwesome/font-awesome-sass
 ### First Argument
@@ -492,7 +575,10 @@ Obviously, the created controller will always have this base controller as its s
 # VERSION HISTORY
-#### 2021-10-09 - v-0.2.5 - this version is all about developer happyness:
+#### 2021-10-11 - v0.2.6 - many additional automatic fixes for default Rails installation 6 or 7 for the generate hot_glue:install command
+#### 2021-10-10 - v0.2.5 - this version is all about developer happyness:
                             - significant fixes for the behavioral (system) specs. they now create new & update interactions
                             for (almost) all field types
                             - the install generator now checks your layouts/application.html.erb for `render partial: 'layouts/flash_messages' ` and adds it if it isn't there already

data/app/views/layouts/_flash_notices.erb ADDED Viewed

@@ -0,0 +1,12 @@
+<%= turbo_frame_tag "flash_notices" do %>
+  <% unless notice.nil? %>
+    <div class="alert alert-notice alert-dismissible">
+      <%= notice %>
+    </div>
+  <% end %>
+  <% unless alert.nil? %>
+    <div class="alert alert-danger alert-dismissible">
+      <%= alert %>
+    </div>
+  <% end %>
+<% end %>

data/lib/generators/hot_glue/install_generator.rb CHANGED Viewed

@@ -23,33 +23,56 @@ module HotGlue
         copy_file "confirmable.js", "#{'spec/dummy/' if Rails.env.test?}app/javascript/controllers/confirmable.js"
       end
+      if Rails.version.split(".")[0].to_i == 6
+        app_js_contents = File.read("app/javascript/packs/application.js")
+        if app_js_contents.include?("import Turbolinks from \"turbolinks\"")
+          app_js_contents.gsub!("import Turbolinks from \"turbolinks\"", "import { Turbo } from \"@hotwired/turbo-rails\"")
+          puts "  HOTGLUE --> fixed packs/application.js: swapping old Turbolinks syntas for new Turbo-Rails syntax [ import { Turbo } from \"@hotwired/turbo-rails\" ] "
+        end
+        if app_js_contents.include?("Turbolinks.start()")
+          app_js_contents.gsub!("Turbolinks.start()", "Turbo.start()")
+          puts "  HOTGLUE --> fixed packs/application.js: swapping old Turbolinks syntas for new Turbo-Rails syntax[ Turbolinks.start() ] "
+        end
+        File.write("app/javascript/packs/application.js", app_js_contents)
+      end
       rails_helper_contents = File.read("spec/rails_helper.rb")
+      if !rails_helper_contents.include?("Capybara.default_driver =")
+        rails_helper_contents << "\nCapybara.default_driver = :selenium_chrome_headless "
+        puts "  HOTGLUE --> added to spec/rails_helper.rb: `Capybara.default_driver = :selenium_chrome_headless`  "
+      end
       if !rails_helper_contents.include?("include FactoryBot::Syntax::Methods")
         rails_helper_contents.gsub!("RSpec.configure do |config|", "RSpec.configure do |config| \n
   config.include FactoryBot::Syntax::Methods
 ")
-        File.write("spec/rails_helper.rb", rails_helper_contents)
-        puts "  HOTGLUE --> add to spec/rails_helper.rb: `config.include FactoryBot::Syntax::Methods`  "
+        puts "  HOTGLUE --> added to spec/rails_helper.rb: `config.include FactoryBot::Syntax::Methods`  "
+      end
+      if ! rails_helper_contents.include?("require 'support/capybara_login.rb'")
+        rails_helper_contents.gsub!("require 'rspec/rails'","require 'rspec/rails' \nrequire 'support/capybara_login.rb'")
+        puts "  HOTGLUE --> added to spec/rails_helper.rb: `require 'support/capybara_login.rb'`  "
       end
+      File.write("spec/rails_helper.rb", rails_helper_contents)
       application_layout_contents = File.read("app/views/layouts/application.html.erb")
       if !application_layout_contents.include?("render partial: 'layouts/flash_notices'")
         application_layout_contents.gsub!("<body>", "<body>\n
-<%= render partial: 'flash_notices' %>
+<%= render partial: 'layouts/flash_notices' %>
 ")
         File.write("app/views/layouts/application.html.erb", application_layout_contents)
-        puts "  HOTGLUE --> add to app/views/layouts/application.html.erb: `<%= render partial: 'layouts/flash_notices' %>`  "
+        puts "  HOTGLUE --> added to app/views/layouts/application.html.erb: `<%= render partial: 'layouts/flash_notices' %>`  "
       end
-      #
-      # TODO>: look for   config.include FactoryBot::Syntax::Methods
-      # inside of spec/rails_Helper.rb and inject it if it is not there
-      # rspec_file = File.read("spec/rails_helper.rb")
-      #
-      # "RSpec.configure do |config|"
+      if !File.exists?("spec/support/capybara_login.rb")
+        copy_file "capybara_login.rb", "#{'spec/dummy/' if Rails.env.test?}spec/support/capybara_login.rb"
+      end
     end
   end
 end

data/lib/generators/hot_glue/templates/capybara_login.rb ADDED Viewed

@@ -0,0 +1,8 @@
+def login_as(account)
+  visit '/accounts/sign_in'
+  within("#new_account") do
+    fill_in 'Email', with: account.email
+    fill_in 'Password', with: 'password'
+  end
+  click_button 'Log in'
+end

data/lib/generators/hot_glue/templates/controller.rb.erb CHANGED Viewed

@@ -7,6 +7,8 @@ class <%= controller_class_name %> < <%= controller_descends_from %>
   before_action :<%= arg %>
     <% } %><% end %>
   before_action :load_<%= singular_name %>, only: [:show, :edit, :update, :destroy]
+  after_action -> { flash.discard }, if: -> { request.format.symbol ==  :turbo_stream }
   helper :hot_glue
   include HotGlue::ControllerHelper

data/lib/hotglue/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module HotGlue
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot-glue
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-09 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -118,6 +118,7 @@ files:
 - app/assets/config/manifest.js
 - app/helpers/hot_glue/controller_helper.rb
 - app/helpers/hot_glue_helper.rb
+- app/views/layouts/_flash_notices.erb
 - bin/rails
 - config/database.yml
 - db/migrate/20210306212711_create_abcs.rb
@@ -134,6 +135,7 @@ files:
 - lib/generators/hot_glue/markup_templates/slim.rb
 - lib/generators/hot_glue/scaffold_generator.rb
 - lib/generators/hot_glue/templates/base_controller.rb.erb
+- lib/generators/hot_glue/templates/capybara_login.rb
 - lib/generators/hot_glue/templates/confirmable.js
 - lib/generators/hot_glue/templates/controller.rb.erb
 - lib/generators/hot_glue/templates/erb/_errors.erb