make_it_so 0.4.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 949efd8fd6f8be81fbd78b38d2db7aa56aa1c427
-  data.tar.gz: eb3c702c131873e182246d57368836423e3ed9bb
+SHA256:
+  metadata.gz: 62d0d492e8ebf31a42c217e5294c22c11e8e27fda46526c9ed9466e63e3cbc0a
+  data.tar.gz: 4d9e66ac27776841fb882234c0da8dc98458836a9f44650c0a82dd6a284fb813
 SHA512:
-  metadata.gz: 445f44e631fb2f8a7af9f5d4bb6b92c8952ade88ccc99712a751059bfe8fae71f472c9ce65422baffff8d0c95c53f4dcff7c0af4b7566c468e24f7781f12d402
-  data.tar.gz: 47503825241b5a8c3f032b993541ba7771c7c3b2cbf483fb6488359484b30aa96e7fc14032cbf3ec319db9ee82a39cef461d312aaa5e6a827e4f3c25a6dd2543
+  metadata.gz: 4a56507b200ab5a6b5237b1b33abc919d8e7cb871e5b9533862024b6c47c02c983d155d04d91e7b819cb405a1ad04f783067802c0490b54d40c0c9c4bfb8353d
+  data.tar.gz: ebf9b7057c86b84dd9d1fa8ffcb7ab9837306efe1e81ebddac6f6a4ad4855024baafa76e12e935aaef7f8ec15e38f1541a3ec06e9701d7d4936079ee60ee36c4

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+- add @types/jest for VSCode intellisense
+
+## [0.5.1] - 2019-10-08
+
+- skip bootsnap by default
+- added prerequisite rails version check
+- adjust webpacker routines to run `after_bundle`
+- only stop spring if it is being installed
+
+## [0.5.0] - 2019-09-02
+
+### Added
+
+- `react-router` is now installed by default
+
+### Changed
+
+- `--karma` and `--jest` options have been removed in favor of a `--js-test-lib` param. 
+- The default behavior of `make_it_so` now generates `jest` as the default test lib instead of `karma`
+- `foundation-rails` was updated to v6.5
+- `modernizr` was removed
+- Development runtime was upgraded to ruby v2.6.3
+
+[Unreleased]:https://github.com/LaunchAcademy/make_it_so/compare/v0.5.0...HEAD
+[0.5.1]:https://github.com/LaunchAcademy/make_it_so/compare/v0.5.0...v0.5.1
+[0.5.0]:https://github.com/LaunchAcademy/make_it_so/compare/v0.4.5...v0.5.0

data/Gemfile

@@ -1,10 +1,27 @@
 source 'https://rubygems.org'
 
-ruby '2.4.2'
+require_relative 'lib/make_it_so/rails'
+
+ruby '2.7.3'
 
 # Specify your gem's dependencies in make_it_so.gemspec
 gemspec
 
 group :development do
   gem 'pry'
+  gem 'solargraph'
+
+  [
+    'rails',
+    'activejob',
+    'actionmailer'
+  ].each do |gem_name|
+    gem gem_name, MakeItSo::Rails::VERSION
+  end
+
+  gem 'sprockets-rails', '3.2.2'
+  gem 'listen'
+  gem 'rspec-rails'
+  gem 'devise'
+  gem 'webpacker'
 end

data/README.md

@@ -30,8 +30,9 @@ make_it_so rails <app_name>
 Then run:
 
 ```ruby
-rake db:create
-rake db:migrate
+yarn install
+bundle exec rake db:create
+bundle exec rake db:migrate
 ```
 
 By default, the generator will create a Rails app with the following options activated:
@@ -41,7 +42,7 @@ By default, the generator will create a Rails app with the following options act
 - Postgres
 - Foundation
 - React
-- Karma
+- Jest
 
 To take advantage of view-specific javascript, inject a script tag at the end of the body tag. Javascript should always be the last thing loaded on the page. In view logic you can do the following:
 
@@ -53,7 +54,7 @@ var widget = new Something.Widget('foo');
 <% end %>
 ```
 
-There is experimental support for a `--jest` flag that will use Jest for client side testing instead of karma/jasmine.
+Using the `--js-test-lib` flag, it is also possible to set up a Karma/Jasmine test framework instead of Jest (`--js-test-lib karma`) or to omit either framework (`--js-test-lib false`).
 
 ### Sinatra
 

data/lib/generators/rails_app_generator.rb

@@ -42,20 +42,27 @@ module MakeItSo
       default: true,
       desc: 'Skip spring gem'
 
-    class_option :react,
+    class_option :skip_active_storage,
       type: :boolean,
       default: true,
-      desc: 'Generate React setup'
+      desc: "Skip Active Storage"
 
-    class_option :karma,
+    class_option :react,
       type: :boolean,
       default: true,
-      desc: 'Generate karma testing setup'
+      desc: 'Generate React setup'
 
-    class_option :jest,
+    class_option :js_test_lib,
+      type: :string,
+      default: "jest",
+      desc: 
+        "Generate Jest testing framework (default), Karma/Jasmine ('karma'), or no framework ('false')"
+      
+    class_option :skip_bootsnap,
       type: :boolean,
-      default: false,
-      desc: 'Generate jest testing setup'
+      default: true,
+      desc:
+        "Skip bootsnap"
 
     def initialize(*args)
       super
@@ -101,13 +108,13 @@ module MakeItSo
         build 'react'
       end
 
-      if options[:jest]
+      if options[:js_test_lib] == "jest"
         build 'jest'
-      elsif options[:karma]
+      elsif options[:js_test_lib] == "karma"
         build 'karma'
       end
 
-      if options[:react] || options[:jest] || options[:karma]
+      if options[:react] || options[:js_test_lib]
         build 'yarn_install'
       end
     end

data/lib/make_it_so.rb

@@ -11,6 +11,9 @@ end
 require "make_it_so/version"
 
 require "make_it_so/rails"
+require 'make_it_so/rails/app_builder'
+
+require "make_it_so/rails/prerequisite_check"
 
 require "make_it_so/command_line_interface"
 require "generators/rails_app_generator"

data/lib/make_it_so/command_line_interface.rb

@@ -4,9 +4,11 @@ module MakeItSo
     desc "rails <app_name>",
       "generates a rails application based on your specifications"
     option :devise, type: :boolean
-    option :jest, type: :boolean
+    option :js_test_lib, default: "jest"
     def rails(app_name)
-      MakeItSo::RailsAppGenerator.start(ARGV[1..-1])
+      if MakeItSo::Rails::PrerequisiteCheck.new.check
+        MakeItSo::RailsAppGenerator.start(ARGV[1..-1])
+      end
     end
 
     desc "sinatra <app_name>",

data/lib/make_it_so/rails.rb

@@ -1,6 +1,5 @@
-require 'make_it_so/rails/app_builder'
-
 module MakeItSo
   module Rails
+    VERSION="5.2.5"
   end
 end

data/lib/make_it_so/rails/app_builder.rb

@@ -50,41 +50,42 @@ module MakeItSo
       def react
         @generator.gem 'webpacker', '~> 3.3'
 
-        rake 'webpacker:install'
-        rake 'webpacker:install:react'
-        remove_file 'app/javascript/packs/application.js'
-        remove_file 'app/javascript/packs/hello_react.jsx'
-
-        unparsed_json = snippet('react_dependencies.json')
-        parsed_json = JSON.parse(unparsed_json)
-
-        modify_json(package_json_file) do |json|
-          ["dependencies", "devDependencies"].each do |key|
-            json[key] ||= {}
-            json[key].merge!(parsed_json[key])
+        after_bundle do
+          rake 'webpacker:install'
+          rake 'webpacker:install:react'
+          remove_file 'app/javascript/packs/application.js'
+          remove_file 'app/javascript/packs/hello_react.jsx'
+
+          unparsed_json = snippet('react_dependencies.json')
+          parsed_json = JSON.parse(unparsed_json)
+
+          modify_json(package_json_file) do |json|
+            ["dependencies", "devDependencies"].each do |key|
+              json[key] ||= {}
+              json[key].merge!(parsed_json[key])
+            end
+
+            json["scripts"] ||= {}
+            json["scripts"]["start"] = "./bin/webpack-dev-server"
+
+            json["dependencies"].delete("babel-preset-react")
           end
 
-          json["scripts"] ||= {}
-          json["scripts"]["start"] = "./bin/webpack-dev-server"
-        end
+          inside 'app/javascript/packs' do
+            copy_file 'new_application.js', 'application.js'
+            remove_file 'new_application.js'
+          end
 
-        inside 'app/javascript/packs' do
-          copy_file 'new_application.js', 'application.js'
-          remove_file 'new_application.js'
         end
       end
 
       def karma
         after_bundle do
-          unparsed_json = snippet('js_testing_deps.json')
-          parsed_json = JSON.parse(unparsed_json)
+          add_test_dependency_snippets(
+            ["js_karma_jasmine_testing_deps.json", "js_enzyme_testing_deps.json"]
+          )
 
-          modify_json(package_json_file) do |json|
-            json["devDependencies"] ||= {}
-            json["devDependencies"].merge!(parsed_json["devDependencies"])
-            json["scripts"] ||= {}
-            json["scripts"]["test"] = "node_modules/.bin/karma start karma.conf.js"
-          end
+          create_enzyme_config
 
           template 'karma.conf.js'
           inside 'spec/javascript' do
@@ -95,54 +96,24 @@ module MakeItSo
           append_to_file '.gitignore' do
             "coverage/*\n"
           end
+
+          remove_file '.babelrc'
+          remove_file 'babel.config.js'
+          template 'babel.config.js'
         end
       end
 
       def jest
         after_bundle do
-          unparsed_json = snippet('js_jest_testing_deps.json')
-          parsed_json = JSON.parse(unparsed_json)
-
-          run 'mkdir -p spec/javascript/support'
-          inside 'spec/javascript/support' do
-            template 'enzyme.js'
-          end
+          add_test_dependency_snippets(
+            ["js_jest_testing_deps.json", "js_enzyme_testing_deps.json"]
+          )
 
-          modify_json(package_json_file) do |json|
-            json["devDependencies"] ||= {}
-            json["devDependencies"].merge!(parsed_json["devDependencies"])
-            json["scripts"] ||= {}
-            json["scripts"]["test"] = "node_modules/.bin/jest"
-            json["scripts"]["test:dev"] = "node_modules/.bin/jest --notify --watch"
-            json["jest"] ||= {}
-            json["jest"].merge!({
-              "automock": false,
-              "roots": [
-                "spec/javascript"
-              ],
-              "moduleDirectories": [
-                "node_modules",
-                "app/javascript"
-              ],
-              "setupFiles": [
-                "./spec/javascript/support/enzyme.js"
-              ],
-              "testURL": "http://localhost/"
-            })
-          end
+          create_enzyme_config
 
-          run 'touch .babelrc'
-          modify_json(File.join(destination_root, '.babelrc')) do |json|
-            json["env"] ||= {}
-            json["env"]["test"] ||= {}
-            json["env"]["test"].merge!({
-              "env": {
-                "test": {
-                  "presets": ["react", "env"],
-                }
-              }
-            })
-          end
+          remove_file '.babelrc'
+          remove_file 'babel.config.js'
+          template 'babel.config.js'
         end
       end
 
@@ -161,14 +132,16 @@ module MakeItSo
       end
 
       def rspec_dependency
-        @generator.gem 'rspec-rails', group: [:development, :test]
+        @generator.gem 'rspec-rails', '3.8.2', group: [:development, :test]
         @generator.gem 'capybara', group: [:development, :test]
         @generator.gem 'launchy', group: [:development, :test]
 
         after_bundle do
-          #stop spring in case it is running - it will hang
-          #https://github.com/rails/rails/issues/13381
-          run 'spring stop'
+          if !options[:skip_spring]
+            #stop spring in case it is running - it will hang
+            #https://github.com/rails/rails/issues/13381
+            run 'spring stop'
+          end
           generate 'rspec:install'
           inside 'spec' do
             empty_directory 'support'
@@ -188,7 +161,11 @@ module MakeItSo
         @generator.gem 'factory_bot', group: [:development, :test]
         after_bundle do
           inside 'spec' do
-            uncomment_lines 'rails_helper.rb', /spec\/support\/\*\*\/\*.rb/
+            insert_into_file 'rails_helper.rb',
+              after: rails_helper_insertion_hook do
+
+              "require File.join(File.dirname(__FILE__), 'support/factory_bot')\n"
+            end
 
             inside 'support' do
               template 'factory_bot.rb'
@@ -230,8 +207,16 @@ module MakeItSo
           group: [:development, :test],
           require: false
         after_bundle do
-          inside 'spec/support' do
-            template 'shoulda.rb'
+          inside 'spec' do
+            insert_into_file 'rails_helper.rb',
+              after: rails_helper_insertion_hook do
+
+              "require File.join(File.dirname(__FILE__), 'support/shoulda')\n"
+            end
+
+            inside 'support' do
+              template 'shoulda.rb'
+            end
           end
         end
       end
@@ -247,7 +232,7 @@ module MakeItSo
           #note: temporary fix that can be removed once devise progresses #beyond v4.4.3
           # https://github.com/plataformatec/devise/pull/4869/files
           inside 'config/initializers' do
-            insert_into_file 'devise.rb', 
+            insert_into_file 'devise.rb',
               after: "Devise.setup do |config|" do
                 "  config.secret_key = Rails.application.secret_key_base\n"
             end
@@ -274,29 +259,60 @@ module MakeItSo
       end
 
       def foundation_dependency
-        @generator.gem 'foundation-rails', '~> 5.0'
+        @generator.gem 'foundation-rails', '~> 6.5'
 
         after_bundle do
           generate 'foundation:install foundation'
-          # foundation-rails generates an application layout so we
-          # must remove it
-          # there is a pull request open to skip this:
-          # https://github.com/zurb/foundation-rails/pull/108
+          # foundation install always messes with the JS manifest
           remove_file 'app/views/layouts/foundation.html.erb'
 
           inside 'app/assets/javascripts' do
-            insert_into_file 'application.js',
-              "//= require foundation\n",
-              after: "//= require jquery_ujs\n"
+            remove_file 'application.js'
+            template 'application.foundation.js', 'application.js'
           end
+          # foundation-rails generates an application layout so we
+          # must remove it
+          remove_file 'app/views/layouts/foundation.html.erb'
+
+
         end
       end
 
       protected
-      PACKAGE_PATH = 'package.json'
-      WEBCONFIG_PATH = 'webpack.config.js'
 
-      protected
+      PACKAGE_PATH = "package.json"
+      WEBCONFIG_PATH = "webpack.config.js"
+
+      def add_test_dependency_snippets(snippet_paths)
+        snippet_paths.each do |snippet_path|
+          snippet = snippet(snippet_path)
+          parsed_snippet = JSON.parse(snippet)
+          keys = parsed_snippet.keys
+
+          modify_json(package_json_file) do |json|
+            keys.each do |key|
+              json[key] ||= {}
+              json[key].merge!(parsed_snippet[key])
+            end
+          end
+        end
+      end
+
+      def create_enzyme_config
+        run 'mkdir -p spec/javascript/support'
+        devDependencies = parsed_package_json["devDependencies"].keys
+        enzymeAdapter = devDependencies.select{ |d| d =~ /^enzyme-adapter-react-[0-9]*/ }[0]
+
+        inside 'spec/javascript/support' do
+          template 'enzyme.js'
+          gsub_file 'enzyme.js', 'ADAPTER NAME GOES HERE', enzymeAdapter
+        end
+
+        inside 'app/javascript/react/components' do
+          template "example.test.js"
+        end
+      end
+
       def parsed_package_json
         @package_json ||= parse_json_file(package_json_file)
       end