code42template 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25f9b6b6283c1adf734c7de322de2cad8a852a2b
-  data.tar.gz: 542e7cfd66f20c16858cab5a6fb45a1360326d7c
+  metadata.gz: 00d1971ef9751231515417d56a4d31b697fb4b8a
+  data.tar.gz: 57ad678ed7bbae98a4b387bc7f4335a18ad7b069
 SHA512:
-  metadata.gz: 4d469c1365c42a9e90dad4acd623984f85f1ee14d406c9f8ad596b713b0011cb33847a82ba34039571824a6520b83f1c60d6a635735be9725e6fcec7ed6b1010
-  data.tar.gz: 98b2e35b070cdadbbf7f7976df6b2e8a8b3dfa5723cc2eca0b1aae609419af9d39ce1efddc31bc68a4596de2f9caaa00c7e0d4303ff3150f89d82f857e9536bd
+  metadata.gz: 95a90e46ed2da02596cef3366348216a1645bc1da6bd2ea7af69f0ec4c1a717772bec972c5e852ab52c973366669452c486365c3dd22c52e5120ee21d1ab06ff
+  data.tar.gz: d26fe21edbcc2bfd180d67839d83af39b32318e413d9090132f07529d4a18097c60827ed3a430fc0e19338a7e4d9566b27c4c22fc7c5672f2b7fb0a34e8f85a2

data/.travis.yml

@@ -1,11 +1,10 @@
 language: ruby
-rvm: 2.3.0
-cache: bundler
-sudo: false
+rvm:
+  - 2.3.1
 before_install:
-  - "echo '--colour' > ~/.rspec"
-  - git config --global user.name 'Travis CI'
-  - git config --global user.email 'travis-ci@example.com'
-install: bundle install
-notifications:
-  email: false
+  - nvm install 6.2.0
+install:
+  - bundle install --jobs=3 --retry=3
+  - npm install
+script:
+  - bundle exec rspec

data/NEWS.md

@@ -54,3 +54,12 @@
 * Improve bin/setup script
 * Do not remove comments from generated files anymore
 * Improve README
+
+2.1.0 (October 10 2016)
+
+* Fix bin/setup script regarding Heroku - it does not try to join as a collaborator anymore
+* Fix health rake task regarding rspec
+* Add eslint / eslint configuration
+* Add sinon - needs "import sinon from 'sinon';" manual require in tests
+* Make it possible to generate an app without ActiveRecord
+* Configure Travis CI

data/README.md

@@ -154,6 +154,7 @@ tasks:
 - `bundle-audit` and `brakeman` check if your app does not have basic
   security holes.
 - `rubocop` makes sure your code adheres to style guidelines.
+- `eslint` makes sure your JavaScript code conforms to fine standards
 
 ### Continuous integration
 
@@ -237,6 +238,20 @@ output a URL where you can run all tests:
 
         npm test:browser
 
+#### JavaScript: eslint
+
+To run eslint over all JS files issue the following command:
+
+        npm run lint
+
+#### JavaScript: sinon
+
+The template comes with `sinon` already pre-configured. Sinon is a popular
+mocking and stubbing tool for JavaScript. To import it in a test file use the
+following ES6 import instruction:
+
+        import sinon from 'sinon';
+
 ### Application server
 
 We use [puma](https://github.com/puma/puma) as our application server, which

data/lib/code42template/adapters/heroku.rb

@@ -46,11 +46,19 @@ module Code42Template
       end
 
       def set_heroku_remotes
-        remotes = <<~SHELL
-          #{command_to_join_heroku_app('staging')}
-          #{command_to_join_heroku_app('production')}
+        staging_app_name = heroku_app_name_for('staging')
+        production_app_name = heroku_app_name_for('production')
 
-          git config heroku.remote staging
+        remotes = <<~SHELL
+          `git remote add staging git@heroku.com:#{staging_app_name}.git 2> /dev/null`
+          `git remote add production git@heroku.com:#{production_app_name}.git 2> /dev/null`
+          `git config heroku.remote staging`
+
+          puts
+          puts 'If you already have access, try joining this app as a collaborator with the following commands:'
+          puts
+          puts "heroku join --app #{staging_app_name}"
+          puts "heroku join --app #{production_app_name}"
         SHELL
 
         @app_builder.append_file 'bin/setup', remotes
@@ -141,19 +149,6 @@ module Code42Template
 
       private
 
-      def command_to_join_heroku_app(environment)
-        heroku_app_name = heroku_app_name_for(environment)
-
-        <<~SHELL
-        if heroku join --app #{heroku_app_name} &> /dev/null; then
-          git remote add #{environment} git@heroku.com:#{heroku_app_name}.git || true
-          printf 'You are a collaborator on the "#{heroku_app_name}" Heroku app\n'
-        else
-          printf 'Ask for access to the "#{heroku_app_name}" Heroku app\n'
-        fi
-        SHELL
-      end
-
       def heroku_app_name
         @app_builder.app_name.dasherize
       end

data/lib/code42template/app_builder.rb

@@ -96,6 +96,7 @@ module Code42Template
 
     def copy_dotfiles
       directory("dotfiles", ".")
+      copy_file 'test_env_eslintrc', 'spec/javascripts/.eslintrc'
     end
 
     def setup_continuous_integration

data/lib/code42template/generators/app_generator.rb

@@ -59,6 +59,8 @@ module Code42Template
     end
 
     def setup_database
+      return if options['skip_active_record']
+
       say 'Setting up database'
 
       if 'postgresql' == options[:database]
@@ -156,6 +158,7 @@ module Code42Template
 
     def setup_dotfiles
       build :copy_dotfiles
+      build :copy_eslint_config
     end
 
     def setup_default_directories

data/lib/code42template/version.rb

@@ -5,5 +5,5 @@ module Code42Template
   RUBY_VERSION = Pathname(__dir__).join('..', '..', '.ruby-version').read.strip
   NODE_VERSION = "6.2.0"
 
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/spec/features/new_project_spec.rb

@@ -20,21 +20,16 @@ RSpec.describe "Create a new project with default configuration" do
 
   it "ensures project specs pass" do
     copy_file 'smoke_test.rb', 'spec/models/smoke_test_spec.rb'
-    copy_file 'feature_smoke_test.rb', 'spec/models/feature_smoke_spec.rb'
     copy_file 'routes.rb', 'config/routes.rb'
-    copy_file 'home_controller.rb', 'app/controllers/home_controller.rb'
-    copy_file 'index.html.erb', 'app/views/home/index.html.erb'
 
     Dir.chdir(project_path) do
       Bundler.with_clean_env do
-        expect(`rake health`).to include(
-          '3 examples, 0 failures', # rspec
+        expect(`NO_NPM_TEST=true rake health`).to include(
+          '1 example, 0 failures', # rspec
           'LOC (100.0%) covered.', # simplecov
           'no offenses detected', # rubocop
           'Security Warnings | 0', # brakeman
-          'No vulnerabilities found', # bundler-audit
-          '1 passing', # mocha
-          'TOTAL: 1 SUCCESS' # karma
+          'No vulnerabilities found' # bundler-audit
         )
       end
     end
@@ -47,9 +42,11 @@ RSpec.describe "Create a new project with default configuration" do
   end
 
   it "copies dotfiles" do
-    %w[.env .rspec .codeclimate.yml].each do |dotfile|
+    %w[.env .rspec .codeclimate.yml .eslintrc .eslintignore].each do |dotfile|
       expect(File).to exist("#{project_path}/#{dotfile}")
     end
+
+    expect(File).to exist("#{project_path}/spec/javascripts/.eslintrc")
   end
 
   it 'copies rspec configuration' do

data/templates/application.js

@@ -1 +1 @@
-(() => console.log('I am alive!'))()
+// This is where you should bootstrap your JS app

data/templates/dotfiles/.eslintignore

@@ -0,0 +1,6 @@
+public
+node_modules
+coverage
+webpack.config.*
+karma.conf.js
+app/assets/javascripts/cable.js

data/templates/dotfiles/.eslintrc

@@ -0,0 +1,16 @@
+{
+    "extends": "airbnb-base",
+    "env": {
+        "mocha": true
+    },
+    "settings": {
+        "import/resolver": {
+            "webpack": {
+                "config": "config/webpack.config.js"
+            }
+        }
+    },
+    "globals": {
+        "window": true
+    }
+}

data/templates/health.rake

@@ -11,9 +11,11 @@ if Rails.env.development? || Rails.env.test?
   desc 'Checks app health: runs tests, security checks and rubocop'
   task :health do
     rails_helper = Rails.root / 'spec/rails_helper.rb'
+    rspec_env = { 'COVERAGE' => 'true', 'RAILS_ENV' => 'test' }
 
-    run_command "bundle exec rspec -r#{rails_helper}", 'COVERAGE' => 'true'
-    run_command 'npm run test'
+    run_command "bundle exec rspec -r#{rails_helper}", rspec_env
+    run_command 'npm run test' unless ENV['NO_NPM_TEST']
+    run_command 'npm run lint'
     run_command 'bundle exec bundle-audit update'
     run_command 'bundle exec bundle-audit check'
     run_command 'bundle exec brakeman -z'

data/templates/package.json

@@ -15,6 +15,10 @@
   },
   "devDependencies": {
     "chai": "^3.5.0",
+    "eslint": "^3.5.0",
+    "eslint-config-airbnb-base": "^7.1.0",
+    "eslint-import-resolver-webpack": "^0.6.0",
+    "eslint-plugin-import": "^1.15.0",
     "karma": "^0.13.22",
     "karma-chai": "^0.1.0",
     "karma-chrome-launcher": "^1.0.1",
@@ -26,9 +30,11 @@
     "karma-webpack": "^1.7.0",
     "mocha": "^2.4.5",
     "mocha-loader": "^0.7.1",
-    "mocha-webpack": "^0.4.0"
+    "mocha-webpack": "^0.4.0",
+    "sinon": "^1.17.5"
   },
   "scripts": {
+    "lint": "eslint .",
     "test": "npm run test:unit && npm run test:integration",
     "test:unit": "NODE_ENV=test NODE_PATH='./app/assets/javascripts' mocha-webpack",
     "test:unit:watch": "npm run test:unit -- --watch",

data/templates/puma.rb

@@ -24,5 +24,5 @@ environment ENV.fetch("RACK_ENV", "development")
 on_worker_boot do
   # Worker specific setup for Rails 4.1+
   # See: https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#on-worker-boot
-  ActiveRecord::Base.establish_connection
+  ActiveRecord::Base.establish_connection if defined? ActiveRecord
 end

data/templates/rails_helper.rb

@@ -21,7 +21,11 @@ end
 
 if ENV['COVERAGE']
   %w(Controller Record Mailer Job).each do |klass|
-    Object.const_get "Application#{klass}"
+    begin
+      Object.const_get "Application#{klass}"
+    # rubocop:disable Lint/HandleExceptions
+    rescue NameError
+    end
   end
 end
 
@@ -29,7 +33,7 @@ require 'spec_helper'
 require 'rspec/rails'
 require 'capybara/poltergeist'
 
-ActiveRecord::Migration.maintain_test_schema!
+ActiveRecord::Migration.maintain_test_schema! if defined? ActiveRecord
 
 Capybara.javascript_driver = :poltergeist
 Capybara.default_driver = :rack_test
@@ -39,21 +43,23 @@ RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
   config.filter_rails_from_backtrace!
 
-  config.before :suite do
-    DatabaseCleaner.clean_with :truncation
-  end
+  if defined? ActiveRecord
+    config.before :suite do
+      DatabaseCleaner.clean_with :truncation
+    end
 
-  config.before :each do
-    DatabaseCleaner.strategy = :transaction
-  end
+    config.before :each do
+      DatabaseCleaner.strategy = :transaction
+    end
 
-  config.before :each, type: :feature do
-    DatabaseCleaner.strategy = :truncation
-  end
+    config.before :each, type: :feature do
+      DatabaseCleaner.strategy = :truncation
+    end
 
-  config.around :each do |example|
-    DatabaseCleaner.start
-    example.run
-    DatabaseCleaner.clean
+    config.around :each do |example|
+      DatabaseCleaner.start
+      example.run
+      DatabaseCleaner.clean
+    end
   end
 end

data/templates/test_env_eslintrc

@@ -0,0 +1,6 @@
+{
+    "rules": {
+        "no-unused-expressions": 0,
+        "import/no-extraneous-dependencies": [2, { "devDependencies": true }]
+    }
+}

data/templates/webpack.config.js

@@ -24,11 +24,15 @@ var config = {
   module: {
     loaders: [
       { test: /\.js$/, exclude: /node_modules/, loader: 'babel-loader' },
-      { test: /\.json$/,   loader: 'json-loader' }
+      { test: /\.json$/,   loader: 'json-loader' },
+      { test: /sinon\.js$/, loader: "imports?define=>false,require=>false"}
     ]
   },
   resolve: {
-    root: path.join(__dirname, '..', 'app', 'assets', 'javascripts')
+    root: path.join(__dirname, '..', 'app', 'assets', 'javascripts'),
+    alias: {
+      sinon: 'sinon/pkg/sinon'
+    }
   },
   plugins: [
     // must match config.webpack.manifest_filename

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code42template
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - codeminer42
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-27 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,6 +107,8 @@ files:
 - templates/dotfiles/.babelrc
 - templates/dotfiles/.codeclimate.yml
 - templates/dotfiles/.env
+- templates/dotfiles/.eslintignore
+- templates/dotfiles/.eslintrc
 - templates/dotfiles/.rspec
 - templates/dotfiles/.rubocop.yml
 - templates/feature_helper.rb.erb
@@ -126,6 +128,7 @@ files:
 - templates/spec/javascripts/integration/smoke.spec.js
 - templates/spec/javascripts/unit/smoke.spec.js
 - templates/spec_helper.rb
+- templates/test_env_eslintrc
 - templates/travis.yml.erb
 - templates/webpack.config.js
 - templates/webpack.config.test.browser.js