make_it_so 0.4.2 → 0.6.0

data/lib/make_it_so/rails/prerequisite_check.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+
+module MakeItSo
+  module Rails
+    class PrerequisiteCheck 
+      include Thor::Base
+      include Thor::Actions
+
+      def check
+        say "Checking Rails version...", :yellow
+        begin
+          require "rails"
+          puts ::Rails.version
+          if ::Rails.version != MakeItSo::Rails::VERSION
+            say "Rails versions check FAILED - execute the following", :red 
+            say "gem uninstall rails railties activejob actionmailer -a && gem install rails -v #{MakeItSo::Rails::VERSION}"
+            return false
+          else
+            say "Rails version MATCH", :green
+            return true
+          end
+        rescue LoadError => e
+          say "Rails not installed", :red
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/make_it_so/version.rb

@@ -1,3 +1,3 @@
 module MakeItSo
-  VERSION = "0.4.2"
+  VERSION = "0.6.0"
 end

data/make_it_so.gemspec

@@ -23,9 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activerecord", "~> 5.2"
   spec.add_dependency "json"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "appraisal"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "capybara"
 end

data/snippets/rails/js_enzyme_testing_deps.json

@@ -0,0 +1,6 @@
+{
+  "devDependencies": {
+    "enzyme": "~3.10.0",
+    "enzyme-adapter-react-16": "~1.14.0"
+  }
+}

data/snippets/rails/js_jest_testing_deps.json

@@ -1,10 +1,20 @@
 {
   "devDependencies": {
-    "babel-jest": "~23.4.0",
-    "enzyme": "~3.3.0",
-    "enzyme-adapter-react-15.4": "~1.0.6",
+    "babel-jest": "^24.9.0",
     "fetch-mock": "~5.13.1",
-    "jest": "~23.4.1",
-    "react-addons-test-utils": "~15.6.2"
+    "jest": "^24.9.0",
+    "@types/jest": "^24.9.0"
+  },
+  "scripts": {
+    "start": "./bin/webpack-dev-server",
+    "test": "node_modules/.bin/jest",
+    "test:dev": "node_modules/.bin/jest --notify --watch"
+  },
+  "jest": {
+    "automock": false,
+    "roots": ["spec/javascript", "app/javascript"],
+    "moduleDirectories": ["node_modules", "app/javascript"],
+    "setupFiles": ["./spec/javascript/support/enzyme.js"],
+    "testURL": "http://localhost/"
   }
 }

data/snippets/rails/{js_testing_deps.json → js_karma_jasmine_testing_deps.json}

@@ -1,18 +1,19 @@
 {
   "devDependencies": {
-    "enzyme": "~2.9.1",
-    "jasmine-ajax": "3.2.0",
+    "fetch-mock": "5",
+    "fetch-ponyfill": "^6.0.2",
     "jasmine-core": "~2.4.1",
-    "jasmine-enzyme": "~3.4.0",
+    "jasmine-enzyme": "~7.0.0",
     "karma": "~0.13.22",
+    "karma-chrome-launcher": "^3.1.0",
     "karma-coverage": "0.5.5",
     "karma-jasmine": "~0.3.8",
     "karma-phantomjs-launcher": "~1.0.4",
     "karma-sourcemap-loader": "0.3.7",
     "karma-spec-reporter": "0.0.26",
-    "karma-webpack": "2.0.1",
-    "phantomjs-prebuilt": "~2.1.14",
-    "react-addons-test-utils": "~15.6.2"
+    "karma-webpack": "2.0.1"
+  },
+  "scripts": {
+    "test": "node_modules/.bin/karma start karma.conf.js"
   }
 }
-

data/snippets/rails/react_dependencies.json

@@ -1,9 +1,20 @@
 {
   "dependencies": {
-    "babel-preset-react": "~6.24.1",
+    "@babel/core": "^7.5.5",
+    "@babel/plugin-proposal-class-properties": "^7.0.0",
+    "@babel/plugin-proposal-object-rest-spread": "^7.0.0",
+    "@babel/plugin-syntax-dynamic-import": "^7.0.0",
+    "@babel/plugin-transform-destructuring": "^7.6.0",
+    "@babel/plugin-transform-regenerator": "^7.4.5",
+    "@babel/plugin-transform-runtime": "^7.13.10",
+    "@babel/preset-env": "^7.5.5",
+    "@babel/preset-react": "^7.0.0",
+    "@babel/runtime": "^7.13.10",
+    "babel-loader": "^8.0.6",
     "prop-types": "~15.6.0",
-    "react": "~15.4.2",
-    "react-dom": "~15.4.2",
+    "react": "~16.8.0",
+    "react-dom": "~16.8.0",
+    "react-router-dom": "5.0.0",
     "redbox-react": "1.6.0"
   },
   "devDependencies": {

data/snippets/rails/user_factory.rb

@@ -1,5 +1,5 @@
   factory :user do
     sequence(:email) {|n| "user#{n}@example.com" }
-    password 'password'
-    password_confirmation 'password'
+    password { 'password' }
+    password_confirmation { 'password' }
   end

data/spec/features/rails/user_generates_rails_spec.rb

@@ -0,0 +1,410 @@
+require 'spec_helper'
+
+feature 'user generates rails app with default settings' do
+  def app_name
+    'dummy_rails'
+  end
+
+  def app_path
+    join_paths(tmp_path, app_name)
+  end
+
+  let(:css_manifest_path) {
+    join_paths(app_path, 'app/assets/stylesheets/application.css')
+  }
+
+  let(:gemfile_path) { join_paths(app_path, 'Gemfile')}
+  let(:package_json_path) { join_paths(app_path, 'package.json')}
+  let(:rails_spec_helper) { join_paths(app_path, 'spec/rails_helper.rb')}
+
+  before(:all) do
+    make_it_so!("rails #{app_name}")
+  end
+
+  scenario 'generates a rails app' do
+    expect(FileTest.exists?(join_paths(app_path, 'app/models'))).to eq(true)
+  end
+
+  scenario 'creates an application.js manifest' do
+    js_file = join_paths(app_path, 'app/assets/javascripts/application.js')
+    expect(FileTest.exists?(js_file)).to eq(true)
+  end
+
+  scenario 'creates an application.css manifest' do
+    expect(FileTest.exists?(css_manifest_path)).to eq(true)
+  end
+
+  scenario 'includes the flash in the layout' do
+    app_layout = File.join(app_path, 'app/views/layouts/application.html.erb')
+    expect(File.read(app_layout)).to include('flash')
+  end
+
+  scenario 'includes viewport meta tag in layout for mobile' do
+    app_layout = File.join(app_path, 'app/views/layouts/application.html.erb')
+    expect(File.read(app_layout)).to include('initial-scale=1.0')
+    expect(File.read(app_layout)).to include('viewport')
+  end
+
+  scenario 'skips active_storage' do
+    expect(FileTest.exists?(join_paths(app_path, 'config/storage.yml'))).to eq(false)
+  end
+
+  context 'pry-rails' do
+    it 'is added as a dependency' do
+      expect(File.read(gemfile_path)).to match(/gem(.*)pry-rails/)
+    end
+  end
+
+  context 'rspec' do
+    it 'eliminates test/unit' do
+      expect(FileTest.exists?(join_paths(app_path, 'test'))).to_not eq(true)
+    end
+
+    it 'inserts a spec_helper' do
+      spec_helper = join_paths(app_path, 'spec/spec_helper.rb')
+      expect(FileTest.exists?(spec_helper)).to eq(true)
+    end
+
+    context 'byebug' do
+      it 'removes the byebug dependency' do
+        expect(File.read(gemfile_path)).to_not match(/gem(.*)byebug/)
+      end
+    end
+
+    context 'capybara' do
+      it 'includes capybara as a Gemfile dependency' do
+        expect(File.read(gemfile_path)).to include('capybara')
+      end
+
+      it 'includes launchy as a Gemfile dependency' do
+        expect(File.read(gemfile_path)).to include('launchy')
+      end
+
+      it 'includes capybara in the rails_helper' do
+        expect(File.read(rails_spec_helper)).to match(/require \'capybara\/rspec\'/)
+      end
+    end
+
+    context 'factory_bot' do
+      it 'includes a factory_bot support file' do
+        fb_support_path = join_paths(app_path, 'spec/support/factory_bot.rb')
+        expect(FileTest.exists?(fb_support_path)).to eq(true)
+      end
+
+      it 'includes the factory_bot gem' do
+        expect(File.read(gemfile_path)).to include('factory_bot')
+      end
+
+      it 'requires the factory_bot support file' do
+        expect(File.read(rails_spec_helper)).
+          to include("\nrequire File.join(File.dirname(__FILE__), 'support/factory_bot')\n")
+      end
+    end
+
+    context 'valid_attribute' do
+      it 'includes the valid_attribute gem' do
+        expect(File.read(gemfile_path)).to include('valid_attribute')
+      end
+
+      it 'creates the valid_attribute support file' do
+        support_path = join_paths(app_path, 'spec/support/valid_attribute.rb')
+        expect(FileTest.exists?(support_path)).to eq(true)
+      end
+
+      it 'requires the valid_attribute support file' do
+        expect(File.read(rails_spec_helper)).
+          to match(/require(.*)support\/valid_attribute/)
+      end
+    end
+
+    context 'shoulda' do
+      it 'includes shoulda-matchers in the gemfile' do
+        expect(File.read(gemfile_path)).to include('shoulda-matchers')
+      end
+
+      it 'includes a shoulda file in the support directory' do
+        expect(FileTest.exists?(join_paths(app_path, 'spec/support/shoulda.rb')))
+      end
+
+      it 'requires the shoulda support file' do
+        expect(File.read(rails_spec_helper)).
+          to include("\nrequire File.join(File.dirname(__FILE__), 'support/shoulda')\n")
+      end
+    end
+
+    context 'database_cleaner' do
+      it 'includes database_cleaner in the gemfile' do
+        expect(File.read(gemfile_path)).to include('database_cleaner')
+      end
+
+      it 'creates the database_cleaner support file' do
+        support_path = join_paths(app_path, 'spec/support/database_cleaner.rb')
+        expect(FileTest.exists?(support_path)).to eq(true)
+      end
+    end
+  end
+
+  context 'devise' do
+    it 'adds devise as a dependency' do
+      expect(File.read(gemfile_path)).to include('devise')
+    end
+
+    it 'generates devise' do
+      devise_initializer = File.join(app_path, 'config/initializers/devise.rb')
+      expect(FileTest.exists?(devise_initializer)).to eq(true)
+    end
+
+    it 'generates devise views' do
+      devise_views = File.join(app_path, 'app/views/devise')
+      expect(FileTest.exists?(devise_views)).to eq(true)
+    end
+
+    it 'creates a user model' do
+      user_model = File.join(app_path, 'app/models/user.rb')
+      expect(FileTest.exists?(user_model)).to eq(true)
+    end
+
+    it 'creates a user_signs_up feature spec' do
+      feature_spec = File.join(app_path, 'spec/features/user_signs_up_spec.rb')
+      expect(FileTest.exists?(feature_spec)).to eq(true)
+    end
+
+    it 'creates a user_signs_in feature spec' do
+      feature_spec = File.join(app_path, 'spec/features/user_signs_in_spec.rb')
+      expect(FileTest.exists?(feature_spec)).to eq(true)
+    end
+
+    it 'creates a user_signs_out feature spec' do
+      feature_spec = File.join(app_path, 'spec/features/user_signs_out_spec.rb')
+      expect(FileTest.exists?(feature_spec)).to eq(true)
+    end
+  end
+
+  context 'foundation' do
+    it 'generates foundation' do
+      expect(File.read(css_manifest_path)).to include('foundation_and_overrides')
+    end
+
+    it 'does not include foundation.html.erb' do
+      foundation_html = File.join(app_path, 'app/views/layouts/foundation.html.erb')
+      expect(FileTest.exists?(foundation_html)).to eq(false)
+    end
+
+    it 'does not include modernizr in the layout' do
+      expect(read_file('app/views/layouts/application.html.erb')).to_not include('modernizr')
+    end
+
+     it 'adds the custom application.js manifest to the assets folder' do
+      file_subpath = "app/assets/javascripts/application.js"
+      generated_js_manifest = File.join(app_path, file_subpath)
+      expect(FileTest.exists?(generated_js_manifest)).to eq(true)
+    end 
+  end
+
+  context 'react' do
+    it 'generates a packs file' do
+      expect(FileTest.exists?(join_paths(app_path, 'app/javascript/packs/application.js'))).to eq(true)
+    end
+
+    it 'includes react in package.json' do
+      in_package_json?(File.join(app_path, 'package.json')) do |json|
+        react = json["dependencies"]["react"]
+        expect(major_version(react)).to be 16
+        expect(minor_version(react)).to be 8
+      end
+    end
+
+    it 'includes redbox-react in package.json' do
+      in_package_json?(File.join(app_path, 'package.json')) do |json|
+        expect(json["dependencies"]["redbox-react"]).to_not be_nil
+      end
+    end
+
+    it 'includes react-dom in package.json' do
+      in_package_json?(File.join(app_path, 'package.json')) do |json|
+        react_dom = json["dependencies"]["react-dom"]
+        expect(major_version(react_dom)).to be 16
+        expect(minor_version(react_dom)).to be 8
+      end
+    end
+
+    it 'includes react-router-dom in package.json' do
+      in_package_json?(File.join(app_path, 'package.json')) do |json|
+        expect(json["dependencies"]["react-router-dom"]).to_not be_nil
+      end
+    end
+  end
+
+  context 'dotenv' do
+    it 'adds dotenv-rails to Gemfile' do
+      expect(File.read(gemfile_path)).to match(/gem(.*)dotenv-rails/)
+    end
+
+    it 'adds .env to gitignore' do
+      expect(read_file('.gitignore')).to include(".env\n")
+    end
+
+    it 'creates a .env file' do
+      expect(FileTest.exists?(File.join(app_path, '.env'))).to eq(true)
+    end
+
+    it 'creates a .env.example file' do
+      expect(FileTest.exists?(File.join(app_path, '.env.example'))).to eq(true)
+    end
+  end
+
+  context 'babel' do
+    it 'includes necessary babel packages in package.json as dev dependencies' do
+      in_package_json?(File.join(app_path, 'package.json')) do |json|
+        expect(json["dependencies"]["@babel/core"]).to_not be_nil
+        expect(json["dependencies"]["@babel/preset-env"]).to_not be_nil
+        expect(json["dependencies"]["@babel/preset-react"]).to_not be_nil
+        expect(json["dependencies"]["babel-loader"]).to_not be_nil
+      end
+    end
+
+    it 'does not create .babelrc' do 
+      babelrc = File.join(app_path, '.babelrc')
+      expect(FileTest.exists?(babelrc)).to eq(false)
+    end
+
+    it 'sets necessary presets in babel.config.js' do
+      babel_config = read_file('babel.config.js')
+      expect(babel_config).to include("@babel/preset-env")
+      expect(babel_config).to include("@babel/preset-react")
+    end
+  end
+
+  context 'enzyme' do
+    it 'includes enzyme in package.json' do
+      in_package_json?(File.join(app_path, 'package.json')) do |json|
+        enzyme = json["devDependencies"]["enzyme"]
+        expect(major_version(enzyme)).to be 3
+        expect(minor_version(enzyme)).to be 10
+      end
+    end
+
+    it 'includes enzyme-adapter-react-16 in package.json' do
+      in_package_json?(File.join(app_path, 'package.json')) do |json|
+        adapter = json["devDependencies"]["enzyme-adapter-react-16"]
+        expect(major_version(adapter)).to be 1
+        expect(minor_version(adapter)).to be 14
+      end
+    end
+
+    it 'includes enzyme.js with correct Enzyme config' do
+      file_subpath = "spec/javascript/support/enzyme.js"
+      support_file = File.join(app_path, file_subpath)
+      expect(FileTest.exists?(support_file)).to eq(true)
+
+      enzyme = read_file(file_subpath)
+      expect(enzyme).to include('require("enzyme-adapter-react-16")')
+      expect(enzyme).to include("Enzyme.configure")
+      expect(enzyme).to include("enzyme-adapter-react-16")
+    end
+
+    it 'adds spec/javascript/support/enzyme.js to setup' do
+      in_package_json?(package_json_path) do |json|
+        expect(json["jest"]).to_not be_nil
+        expect(json["jest"]["setupFiles"]).to include('./spec/javascript/support/enzyme.js')
+      end
+    end 
+
+    it 'adds example.test.js to react components folder' do
+      file_subpath = "app/javascript/react/components/example.test.js"
+      example_test_file = File.join(app_path, file_subpath)
+      expect(FileTest.exists?(example_test_file)).to eq(true)
+    end 
+  end
+
+  context 'jest' do
+    it 'includes fetch-mock' do
+      in_package_json?(File.join(app_path, 'package.json')) do |json|
+        expect(json["devDependencies"]["fetch-mock"]).to_not be_nil
+      end
+    end
+
+    scenario 'adds jest as a dependency' do
+      in_package_json?(package_json_path) do |json|
+        expect(json["devDependencies"]["jest"]).to_not be_nil
+      end
+    end
+
+    scenario 'adds @types/jest as a dependency' do
+      in_package_json?(package_json_path) do |json|
+        expect(json["devDependencies"]["@types/jest"]).to_not be_nil
+      end
+    end
+
+    scenario 'adds enzyme as a dependency' do
+      in_package_json?(package_json_path) do |json|
+        expect(json["devDependencies"]["enzyme"]).to_not be_nil
+      end
+    end
+
+    scenario 'adds fetch-mock as a dependency' do
+      in_package_json?(package_json_path) do |json|
+        expect(json["devDependencies"]["fetch-mock"]).to_not be_nil
+      end
+    end
+
+    scenario 'adds jest as the test script in package.json' do
+      in_package_json?(package_json_path) do |json|
+        expect(json["scripts"]["test"]).to include("jest")
+      end
+    end
+
+    scenario 'adds spec/javascripts to roots' do
+      in_package_json?(package_json_path) do |json|
+        expect(json["jest"]).to_not be_nil
+        expect(json["jest"]["roots"]).to include("spec/javascript")
+      end
+    end
+
+    scenario 'adds node_modules to modules directory' do
+      in_package_json?(package_json_path) do |json|
+        expect(json["jest"]).to_not be_nil
+        expect(json["jest"]["moduleDirectories"]).to_not be_nil
+        expect(json["jest"]["moduleDirectories"]).to include("node_modules")
+      end
+    end
+
+    scenario 'adds app/javascript to modules directory' do
+      in_package_json?(package_json_path) do |json|
+        expect(json["jest"]).to_not be_nil
+        expect(json["jest"]["moduleDirectories"]).to_not be_nil
+        expect(json["jest"]["moduleDirectories"]).to include("app/javascript")
+      end
+    end
+
+    scenario 'adds testURL to jest configuration' do
+      in_package_json?(package_json_path) do |json|
+        expect(json["jest"]).to_not be_nil
+        expect(json["jest"]["testURL"]).to_not be_nil
+        expect(json["jest"]["testURL"]).to eq("http://localhost/")
+      end
+    end
+  end
+
+  it 'does not create a karma.config' do
+    karma_config = File.join(app_path, 'karma.conf.js')
+    expect(FileTest.exists?(karma_config)).to eq(false)
+  end
+
+  it 'does not create a testHelper.js' do
+    test_helper = File.join(app_path, 'spec/javascript/testHelper.js')
+    expect(FileTest.exists?(test_helper)).to eq(false)
+  end
+
+  it 'does not include karma in package.json' do
+    in_package_json?(File.join(app_path, 'package.json')) do |json|
+      expect(json["devDependencies"]["karma"]).to be_nil
+    end
+  end
+
+  it 'does not include jasmine in package.json' do
+    in_package_json?(File.join(app_path, 'package.json')) do |json|
+      expect(json["devDependencies"]["jasmine-core"]).to be_nil
+    end
+  end
+end