make_it_so 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dde582c517272c49eaf1cce483bc897a322fd122
-  data.tar.gz: b01be3897cccc71c1a1d0ed97de3d02efe58b596
+  metadata.gz: 13620dc1e25ca2ec8c8ce9287aead4d7d9163761
+  data.tar.gz: ce95d6d68d4523f64088db6472f636f91c39a10b
 SHA512:
-  metadata.gz: c77ad4e21bc38c48f1de992ea92b2fe4907b9503ab1d0a57c2f235dd2050fe909111163faf0a87b4019283a19a216af7c890d57aabf784806d34d55405904055
-  data.tar.gz: '0681af42be621f03fd0bc6b4b371257c7ba504e54f607280fa52fd06daeedc0e147e9c025bfd6aefa93a46a08136c58eb2af617eb1b2cf0d6c4a5db4bcfe33ca'
+  metadata.gz: 23c4bcd4f977f73fc2b0e1504e228fa3c612403017950575bbd13669cb96138a0137e27c7fbadc20e881914813babc66f85d4f56fc954e621a70877a3fed91be
+  data.tar.gz: ef357898432dbf513c5f569af5ad6b5cbfd244accc53b77555d8bc80747c1c70684a96d35968226508363e7ab9b886b689e05e782bdadede8bb74128131d8b3a

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+tags

data/lib/generators/rails_app_generator.rb

@@ -24,7 +24,7 @@ module MakeItSo
     class_option :foundation,
       type: :boolean,
       default: true,
-      desc: 'generate foundation support'
+      desc: 'Generate foundation support'
 
     # turbolinks is the devil
     class_option :skip_turbolinks,
@@ -32,6 +32,26 @@ module MakeItSo
       default: true,
       desc: 'Skip turbolinks gem'
 
+    class_option :skip_coffee,
+      type: :boolean,
+      default: true,
+      desc: 'Skip coffee gem'
+
+    class_option :skip_spring,
+      type: :boolean,
+      default: true,
+      desc: 'Skip spring gem'
+
+    class_option :react,
+      type: :boolean,
+      default: true,
+      desc: 'Generate React setup'
+
+    class_option :karma,
+      type: :boolean,
+      default: true,
+      desc: 'Generate karma testing setup'
+
     def initialize(*args)
       super
       if @options[:rspec]
@@ -58,7 +78,6 @@ module MakeItSo
         build 'factory_bot_rspec'
         build 'valid_attribute_rspec'
         build 'shoulda_rspec'
-        build 'teaspoon_jasmine'
       end
 
       if options[:devise]
@@ -68,6 +87,14 @@ module MakeItSo
       if options[:foundation]
         build 'foundation_dependency'
       end
+
+      if options[:react]
+        build 'react'
+      end
+
+      if options[:karma]
+        build 'karma'
+      end
     end
 
     protected

data/lib/make_it_so/rails/app_builder.rb

@@ -1,4 +1,5 @@
 require 'rails/generators/rails/app/app_generator'
+require 'json'
 
 module MakeItSo
   module Rails
@@ -36,6 +37,49 @@ module MakeItSo
         gsub_file 'Gemfile', both_lines, "\n"
       end
 
+      def react
+        self.gem 'webpacker', '~> 3.0.2'
+
+        after_bundle do
+          rake 'webpacker:install'
+          rake 'webpacker:install:react'
+
+          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
+          end
+
+          rake 'yarn:install'
+        end
+      end
+
+      def karma
+        after_bundle do
+          unparsed_json = snippet('js_testing_deps.json')
+          parsed_json = JSON.parse(unparsed_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
+
+          template 'karma.conf.js'
+          inside 'spec/javascript' do
+            template 'exampleTest.js'
+            template 'testHelper.js'
+          end
+
+          rake 'yarn:install'
+        end
+      end
+
       def rspec_dependency
         self.gem 'rspec-rails', group: [:development, :test]
         self.gem 'capybara', group: [:development, :test]
@@ -105,13 +149,6 @@ module MakeItSo
         end
       end
 
-      def teaspoon_jasmine
-        self.gem 'teaspoon-jasmine'
-        after_bundle do
-          generate 'teaspoon:install'
-        end
-      end
-
       def devise_dependency
         self.gem 'devise'
 
@@ -152,6 +189,29 @@ module MakeItSo
       end
 
       protected
+      PACKAGE_PATH = 'package.json'
+      WEBCONFIG_PATH = 'webpack.config.js'
+
+      protected
+      def parsed_package_json
+        @package_json ||= parse_json_file(package_json_file)
+      end
+
+      def package_json_file
+        File.join(destination_root, PACKAGE_PATH)
+      end
+
+      def modify_json(file, &block)
+        json = parse_json_file(file)
+        block.call(json)
+        File.write(file, JSON.pretty_generate(json))
+      end
+
+      def parse_json_file(file)
+        contents = File.read(file)
+        JSON.parse(contents)
+      end
+
       def rails_helper_insertion_hook
         "require 'rspec/rails'\n"
       end

data/lib/make_it_so/version.rb

@@ -1,3 +1,3 @@
 module MakeItSo
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/make_it_so.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "thor"
   spec.add_dependency "railties", "~> 5.1"
+  spec.add_dependency "json"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "appraisal"

data/snippets/rails/js_testing_deps.json

@@ -0,0 +1,18 @@
+{
+  "devDependencies": {
+    "enzyme": "~2.9.1",
+    "jasmine-ajax": "3.2.0",
+    "jasmine-core": "~2.4.1",
+    "jasmine-enzyme": "~3.4.0",
+    "karma": "~0.13.22",
+    "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"
+  }
+}
+

data/snippets/rails/react_dependencies.json

@@ -0,0 +1,12 @@
+{
+  "dependencies": {
+    "@rails/webpacker": "~3.0.2",
+    "babel-preset-react": "~6.24.1",
+    "prop-types": "~15.6.0",
+    "react": "~15.4.2",
+    "react-dom": "~15.4.2"
+  },
+  "devDependencies": {
+    "webpack-dev-server": "~2.4.2"
+  }
+}

data/spec/features/user_generates_rails_spec.rb

@@ -12,6 +12,7 @@ feature 'user generates rails app' do
   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
@@ -130,16 +131,6 @@ feature 'user generates rails app' do
           to include("require 'shoulda-matchers'")
       end
     end
-
-    context 'teaspoon' do
-      it 'includes teaspoon-jasmine in the Gemfile' do
-        expect(File.read(gemfile_path)).to include('teaspoon-jasmine')
-      end
-
-      it 'generates a spec/javascripts directory' do
-        expect(FileTest.exists?(join_paths(app_path, 'spec/javascripts'))).to eq(true)
-      end
-    end
   end
 
   context 'devise' do
@@ -187,4 +178,53 @@ feature 'user generates rails app' do
       expect(File.read(File.join(app_path, 'app/views/layouts/application.html.erb'))).to include('modernizr')
     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|
+        expect(json["dependencies"]["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|
+        expect(json["dependencies"]["react-dom"]).to_not be_nil
+      end
+    end
+  end
+
+  context 'karma' do
+    it 'creates a karma.config' do
+      karma_config = File.join(app_path, 'karma.conf.js')
+      expect(FileTest.exists?(karma_config)).to eq(true)
+    end
+
+    it 'creates a testHelper.js' do
+      test_helper = File.join(app_path, 'spec/javascript/testHelper.js')
+      expect(FileTest.exists?(test_helper)).to eq(true)
+    end
+
+    it 'includes karma in package.json' do
+      in_package_json?(File.join(app_path, 'package.json')) do |json|
+        expect(json["devDependencies"]["karma"]).to_not be_nil
+      end
+    end
+
+    it 'includes jasmine in package.json' do
+      in_package_json?(File.join(app_path, 'package.json')) do |json|
+        expect(json["devDependencies"]["jasmine-core"]).to_not be_nil
+      end
+    end
+
+    it 'includes react-addons-test-utils' do
+      in_package_json?(File.join(app_path, 'package.json')) do |json|
+        expect(json["devDependencies"]["react-addons-test-utils"]).to_not be_nil
+      end
+
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'bundler/setup'
 require 'rspec'
 require 'capybara/rspec'
+require 'json'
 
 Bundler.require(:default, :test)
 

data/spec/support/make_it_so_spec_helpers.rb

@@ -44,6 +44,12 @@ module MakeItSoSpecHelpers
     File.read(join_paths(app_path, 'Gemfile')).
       match(/gem.*#{Regexp.escape(gem_name)}/).present?
   end
+
+  def in_package_json?(path, &block)
+    contents = File.read(path)
+    json = JSON.parse(contents)
+    yield(json)
+  end
 end
 
 RSpec.configure do |config|

data/templates/rails/karma.conf.js

@@ -0,0 +1,94 @@
+var path = require('path');
+
+module.exports = function(config) {
+  config.set({
+    basePath: "",
+    // use the PhantomJS browser
+    browsers: ['PhantomJS'],
+
+    // use the Jasmine testing framework
+    frameworks: ['jasmine'],
+
+    // files that Karma will server to the browser
+    files: [
+      // use Babel polyfill to emulate a full ES6 environment in PhantomJS
+      'node_modules/babel-polyfill/dist/polyfill.js',
+      // entry file for Webpack
+      'spec/javascript/testHelper.js'
+    ],
+
+    // before serving test/testHelper.js to the browser
+    preprocessors: {
+      'spec/javascript/testHelper.js': [
+        // use karma-webpack to preprocess the file via webpack
+        'webpack',
+        // use karma-sourcemap-loader to utilize sourcemaps generated by webpack
+        'sourcemap'
+      ]
+    },
+
+    // webpack configuration used by karma-webpack
+    webpack: {
+      // generate sourcemaps
+      devtool: 'eval-source-map',
+      module: {
+        loaders: [
+          // use babel-loader to transpile the test and src folders
+          {
+            test: /\.jsx?$/,
+            exclude: /node_modules/,
+            loader: 'babel-loader'
+          },
+          {
+            test: /\.json$/,
+            include: [
+              /node_modules/,
+              path.resolve(__dirname, '..')
+            ],
+            loader: 'json-loader'
+          }
+        ]
+      },
+      resolve: {
+        modules: ['app/javascript', 'node_modules']
+      }
+    },
+
+    webpackMiddleware: {
+      // do not output webpack build information to the browser's console
+      noInfo: true
+    },
+
+    // test reporters that Karma should use
+    reporters: [
+      // use karma-spec-reporter to report results to the browser's console
+      'spec',
+      // use karma-coverage to report test coverage
+      'coverage'
+    ],
+
+    // karma-spec-reporter configuration
+    specReporter: {
+      // remove meaningless stack trace when tests do not pass
+      maxLogLines: 1,
+      // do not print information about tests that are passing
+      suppressPassed: true
+    },
+
+    // karma-coverage configuration
+    coverageReporter: {
+      // output coverage results to the coverage folder in the project's root
+      dir: 'coverage',
+      subdir: '.',
+      // output coverage results as html
+      type: 'html'
+    },
+    externals: {
+      cheerio: 'window',
+      'react/addons': true,
+      'react/lib/ExecutionEnvironment': true,
+      'react/lib/ReactContext': true,
+      'react/addons': true
+    }
+  })
+}

data/templates/rails/spec/javascript/exampleTest.js

@@ -0,0 +1,5 @@
+describe('example test', () => {
+  it('should pass', () => {
+    expect(true).toBe(true);
+  });
+});

data/templates/rails/spec/javascript/testHelper.js

@@ -0,0 +1,29 @@
+import { shallow, mount } from 'enzyme';
+import jasmineEnzyme from 'jasmine-enzyme';
+import React from 'react';
+import 'jasmine-ajax';
+
+Object.assign(global, {
+  jasmineEnzyme,
+  mount,
+  React,
+  shallow,
+});
+
+beforeEach(() => {
+  jasmineEnzyme();
+});
+
+// function to require all modules for a given context
+let requireAll = requireContext => {
+  requireContext.keys().forEach(requireContext);
+};
+
+// require all js files except testHelper.js in the test folder
+requireAll(require.context('./', true, /^((?!testHelper).)*\.jsx?$/));
+
+// require all js files except main.js in the src folder
+requireAll(require.context('../../app/javascript', true, /^((?!application).)*\.jsx?$/));
+
+// output to the browser's console when the tests run
+console.info(`TESTS RAN AT ${new Date().toLocaleTimeString()}`);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: make_it_so
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Dan Pickett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-10 00:00:00.000000000 Z
+date: 2017-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +154,8 @@ files:
 - lib/make_it_so/version.rb
 - make_it_so.gemspec
 - snippets/rails/application_generator.rb
+- snippets/rails/js_testing_deps.json
+- snippets/rails/react_dependencies.json
 - snippets/rails/user_factory.rb
 - spec/features/user_generates_gosu_spec.rb
 - spec/features/user_generates_rails_spec.rb
@@ -160,9 +176,12 @@ files:
 - templates/rails/app/controllers/homes_controller.rb
 - templates/rails/app/views/homes/index.html.erb
 - templates/rails/app/views/layouts/application.html.erb.tt
+- templates/rails/karma.conf.js
 - templates/rails/spec/features/user_signs_in_spec.rb
 - templates/rails/spec/features/user_signs_out_spec.rb
 - templates/rails/spec/features/user_signs_up_spec.rb
+- templates/rails/spec/javascript/exampleTest.js
+- templates/rails/spec/javascript/testHelper.js
 - templates/rails/spec/support/factory_bot.rb
 - templates/rails/spec/support/valid_attribute.rb
 - templates/sinatra/.gitignore