vue_cli-rails 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 106196baec28c9e822399c81c0aaa74e3ebc975ed6058ab4526bbd7afed75a9f
-  data.tar.gz: 3759ecd67ae31aac6c0cba11c779e7b2c2b43a3c4a1faa27b751d54b5b7066d3
+  metadata.gz: d94627f882ae1d49750c10af029d0198758192e2a1c48a28d3acb03d390191e9
+  data.tar.gz: f91614fdaa017c41077bb29fc18990d6032d236ca815fa72bafacac16b8c86de
 SHA512:
-  metadata.gz: 1f96e3c8b417e714682deda2cfea327658326d1030ead03cc724b3e7d4544ba9813dcc6652196252cdebceb9a3cf90e1130f004770b9b8a3d8c0c76d97e93cb2
-  data.tar.gz: 9a161f5257422c9a07b8a86430bcc2d0c3860e43a39925cb100e7fb7f5eb03df85d7e607324efe00fdc02de1b39c96bbc10ff1006e65de65d9a6a2e21ba23450
+  metadata.gz: 99c4c3dc1c9141ad7a58879b42a70ebefa9cd53e64c822bbfea7af4d270dc39bebf75065e5977c9e5d2e116042c2e4301c3666b19098a29f36112007cd895c07
+  data.tar.gz: 9de90b5be774639d27c19753ffa2d4b0dd1a0dc9a7dd98752ce5700170a47bb8899a49d2525653261d3940cb507fd27e87e9ff12beb17724df561b844aabab66

data/.gitignore

@@ -6,6 +6,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+node_modules
+/test/vcdr
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -1,7 +1,49 @@
 ---
 sudo: false
 language: ruby
-cache: bundler
+cache:
+  bundler: true
+  yarn: true
+
 rvm:
-  - 2.4.5
-before_install: gem install bundler -v 1.17.3
+  - 2.3
+  - 2.4
+  - 2.5
+
+env:
+  - RAILS_VERSION=4.2
+  - RAILS_VERSION=5.2
+
+matrix:
+  exclude:
+    - rvm: 2.5
+      env: RAILS_VERSION=4.2
+
+gemfile:
+  - test/Gemfile-rails.$RAILS_VERSION
+
+before_install:
+  - gem update --system
+
+install:
+  - nvm install --lts
+  - node -v
+  - yarn global add @vue/cli
+  - gem install rspec
+
+before_script:
+  - sh -c 'cd test && ./install.rb'
+
+script:
+  - sh -c 'cd test && rspec ./vcr_spec.rb'
+
+jobs:
+  include:
+    - stage: gem release
+      rvm: 2.3
+      script: echo "Deploying to rubygems.org ..."
+      deploy:
+        provider: rubygems
+        gem: vue_cli-rails
+        api_key: $RUBYGEMS_API_KEY
+        on: release

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [0.4.1] - Released on 2019-03-18
+
+- Better hint than crashing when run Rails server with `vue_cli-rails` but `rake vue:create` have not been called
+- Keep settings of `vue.config.js` like `lintOnSave` generated by Vue
+- Added tasks `vue:lint`, `vue:test[unit]` and `vue:test[e2e]`
+- Added travis tests
+
 ## [0.4.0] - Released on 2019-03-17
 
 - Breaking change: changed `render_vue(entry_point)` to `render(vue: entry_point)`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vue_cli-rails (0.4.0)
+    vue_cli-rails (0.4.1)
       activesupport (>= 4.2)
       rack-proxy (>= 0.6)
       railties (>= 4.2)

data/README.md

@@ -1,5 +1,7 @@
 # VueCli::Rails
 
+[![Build Status](https://travis-ci.com/eGust/vue_cli-rails.svg?branch=master)](https://travis-ci.com/eGust/vue_cli-rails)
+
 Let's make cool boy Vue even cooler on Rails!
 
 ## Installation
@@ -21,8 +23,6 @@ And then execute:
 - Node >= [8.9+](https://cli.vuejs.org/guide/installation.html)
 - Optional: `yarn`
 
-> The auto-testing for CI still WIP. Sorry I can't guarantee it works for now.
-
 ## Features
 
 - Feel free to use `yarn` or `npm`.
@@ -357,7 +357,7 @@ You can check the full list on [Vue CLI official website](https://cli.vuejs.org/
   - [ ] integrity - N/A
   - [ ] chainWebpack - directly edit `vue.config.js`
 
-## Trouble-shooting
+## Trouble Shooting & Known Issues
 
 - My dev server can't find assets
 
@@ -413,6 +413,22 @@ You can check the full list on [Vue CLI official website](https://cli.vuejs.org/
 
     Alternatively you can turn off CSRF token and set [SameSite cookie](https://gist.github.com/will/05cb64dc343296dec4d58b1abbab7aaf) if all your clients no longer use IE. [Modern browsers](https://caniuse.com/#feat=same-site-cookie-attribute) can handle `SameSite` flag to [prevent CSRF attacks](http://www.sjoerdlangkemper.nl/2016/04/14/preventing-csrf-with-samesite-cookie-attribute/).
 
+- Mocha tests not working
+
+    This is an known issue.
+
+- TypeScript can not find my aliases
+
+    This is an known issue. TS is still using `tsconfig.json` rather than a `.js` or `.ts` file. You must manually update it for now. I will try to find a way out.
+
+- My `yarn test:...`/`npm run test:...` not working properly
+
+    The test requires setting `RAILS_ENV=test`. You can invoke `rake vue:test[unit]` `rake vue:test[e2e]` instead.
+
+- Got errors like `command "..." does not exist` for `rake vue:lint/test`
+
+    This rake task simply invokes `vue-cli-service test:...`. Those commands will be generated by some vue plugins. It won't be available unless you got correct plugin installed.
+
 <details><summary>Q & A</summary>
 
 ## Q&A

data/lib/helpers/scripts/vue_create.rb

@@ -17,6 +17,7 @@ class VueCreate
     check_node!
     FileUtils.chdir(@root)
     @pending_install = false
+    @pending_fixes = []
     begin
       package_manager?
       install_vue_cli
@@ -29,6 +30,7 @@ class VueCreate
       generate_vue_yml
       ensure_entry_point!
       fix_jest_config!
+      eslint_fix!
       puts 'vue:create finished!'
     ensure
       FileUtils.chdir(@pwd)
@@ -195,11 +197,22 @@ class VueCreate
   def copy_config
     puts 'Copying configuration files...'
     FileUtils.cp(@src_dir.join('vue.rails.js'), "#{@root}/")
-    if @root.join('vue.config.js').exist?
-      puts 'Detected `vue.config.js`!'
-      return if @input.gets('  Do you want to overwrite vue.config.js?', 'yN') == 'n'
+
+    src_cfg = @src_dir.join('vue.config.js')
+    dst_cfg = @root.join('vue.config.js')
+    config = src_cfg.read
+    if dst_cfg.exist?
+      if dst_cfg.size > 500
+        puts 'Detected `vue.config.js`!'
+        return if @input.gets('  Do you want to overwrite vue.config.js?', 'yN') == 'n'
+      else
+        old_cfg = %x`node -e "console.log(JSON.stringify(require('./vue.config.js'),null,2))"`
+        config = config.sub('const oldConfig = {};', "const oldConfig = #{old_cfg};")
+      end
     end
-    FileUtils.cp(@src_dir.join('vue.config.js'), "#{@root}/")
+
+    dst_cfg.write(config)
+    @pending_fixes << dst_cfg.to_s
   end
 
   def generate_vue_yml
@@ -242,10 +255,15 @@ class VueCreate
       module.exports = #{JSON.pretty_generate(jest_config)}_MODULE_NAME_MAPPER_;
     JS
     jest_file.write(jest.sub(/\n?}_MODULE_NAME_MAPPER_/, ",\n  moduleNameMapper\n}"))
+    @pending_fixes << jest_file.to_s
+  rescue => e
+    STDERR.puts e.message
+  end
 
+  def eslint_fix!
     dev_deps = JSON.parse(@pack.read)['devDependencies']
     return unless dev_deps['eslint'].present?
-    @pm.exec('eslint', jest_file.to_s, '--fix')
+    @pm.exec('eslint', @pending_fixes.map { |fn| "'#{fn}'" }.join(' '), '--fix')
   rescue => e
     STDERR.puts e.message
   end

data/lib/source/vue.config.js

@@ -5,13 +5,17 @@
 const railsConfig = require('./vue.rails');
 
 const {
+  mode,
   manifest,
   pickUpSettings,
   // isProd,
   // getSettings, // (keys: string[]) => Object. Returns all available settings by default
 } = railsConfig;
 
+const oldConfig = {};
+
 module.exports = {
+  ...oldConfig,
   ...pickUpSettings`
     outputDir
     publicPath
@@ -35,21 +39,24 @@ module.exports = {
       // clear entry points if there is any
       .entryPoints
       .clear()
-      .end()
-      .plugins
-      // disable copy plugin
-      .delete('copy')
-      // disable generating html
-      .delete('html')
-      .delete('preload')
-      .delete('prefetch')
       .end();
-    if (manifest) {
+    if (mode !== 'test') {
       config
-        .plugin('manifest')
-        .use(manifest.plugin)
-        .init(Plugin => new Plugin(manifest.options))
+        .plugins
+        // disable copy plugin
+        .delete('copy')
+        // disable generating html
+        .delete('html')
+        .delete('preload')
+        .delete('prefetch')
         .end();
+      if (manifest) {
+        config
+          .plugin('manifest')
+          .use(manifest.plugin)
+          .init(Plugin => new Plugin(manifest.options))
+          .end();
+      }
     }
     /* [DO NOT EDIT!] end */
 

data/lib/source/vue.rails.js

@@ -44,14 +44,16 @@ module.exports = (() => {
       },
     };
 
+  const mode = env.RAILS_ENV || env.NODE_ENV || 'development';
+  env.RAILS_ENV = mode;
+  env.NODE_ENV = mode;
   try {
     /* eslint-disable global-require,import/no-extraneous-dependencies */
     const yaml = require('js-yaml');
     const { readdirSync, lstatSync } = require('fs');
     /* eslint-enable global-require,import/no-extraneous-dependencies */
 
-    const railsEnv = env.RAILS_ENV || 'development';
-    const config = yaml.safeLoad(readFileSync(resolve('config', 'vue.yml'), 'utf8'))[railsEnv];
+    const config = yaml.safeLoad(readFileSync(resolve('config', 'vue.yml'), 'utf8'))[mode];
     const root = resolve(__dirname);
     const pop = (config.public_output_path || 'vue_assets').replace(/(^\/+|\/+$)/g, '');
     const {
@@ -96,7 +98,7 @@ module.exports = (() => {
     }
 
     settings = {
-      env: railsEnv,
+      env: mode,
       root,
       manifestOutput: manifestOutput && resolve(root, manifestOutput),
 
@@ -145,7 +147,7 @@ module.exports = (() => {
     /* eslint-disable-next-line global-require,import/no-extraneous-dependencies */
     const { execSync } = require('child_process');
 
-    console.error(e);
+    console.error(mode, e);
     settings = JSON.parse(execSync('bundle exec rake vue:json_config', {
       cwd: __dirname,
       encoding: 'utf8',
@@ -165,6 +167,7 @@ module.exports = (() => {
   const isProd = settings.env === 'production';
 
   return {
+    mode,
     isProd,
     manifest: {
       /* eslint-disable-next-line global-require,import/no-extraneous-dependencies */

data/lib/tasks/vue.rake

@@ -29,6 +29,20 @@ namespace :vue do
     ::Rake::Task['assets:precompile'].invoke if args.with_rails_assets
   end
 
+  desc 'Run JavaScript Lint: alias of vue-cli-service lint'
+  task :lint do
+    VueCli::Rails::Configuration.instance.node_env.exec('vue-cli-service lint')
+  end
+
+  desc 'Run JavaScript unit or e2e tests (default unit-test)'
+  task :test, [:unit_e2e] => :environment do |_t, args|
+    test = (args.unit_e2e || 'unit').downcase
+    abort('Only support test[unit] or test[e2e]') unless %w[unit e2e].include?(test)
+    STDERR.puts('WARN: Mocha and E2E tests may not work properly.')
+    VueCli::Rails::Configuration.instance.node_env
+      .exec("vue-cli-service test:#{test}", env: { 'RAILS_ENV' => 'test' })
+  end
+
   desc 'Install Node way to run Rails dev server alongside webpack-dev-server'
   task node_dev: :environment do
     require_relative '../helpers/scripts/vue_command'

data/lib/vue_cli/rails/configuration.rb

@@ -103,6 +103,16 @@ module VueCli
       class << self
         attr_reader :dev_server_url, :entry_points
 
+        def check!
+          return if ::Rails.root.join('config/vue.yml').exist?
+          abort <<~ERROR
+            [ERROR] Failed to load vue_cli-rails!
+              Cannot find config file: config/vue.yml
+              Please call below command to initialize Vue:
+                #{::Rails.version.to_i > 4 ? 'rails' : 'bundle exec rake'} vue:create
+          ERROR
+        end
+
         def instance
           @instance ||= new
         end

data/lib/vue_cli/rails/engine.rb

@@ -5,6 +5,7 @@ module VueCli
     class Engine < ::Rails::Engine
       initializer 'vue_cli' do |app|
         if defined?(::Rails::Server)
+          Configuration.check!
           is_dev = ::Rails.env.development?
 
           if is_dev

data/lib/vue_cli/rails/version.rb

@@ -1,5 +1,5 @@
 module VueCli
   module Rails
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.4.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vue_cli-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - James Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-16 00:00:00.000000000 Z
+date: 2019-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,7 +129,6 @@ files:
 - lib/helpers/lib/cmd.rb
 - lib/helpers/lib/common.rb
 - lib/helpers/lib/input_loop.rb
-- lib/helpers/scripts/install_rails.rb
 - lib/helpers/scripts/vue_command.rb
 - lib/helpers/scripts/vue_create.rb
 - lib/source/app/assets/vue/components/HelloWorld.vue

data/lib/helpers/scripts/install_rails.rb

@@ -1,45 +0,0 @@
-#!/usr/bin/env ruby
-require_relative 'common'
-
-ver = ENV['RAILS_VERSION']
-abort('RAILS_VERSION not found!') if ver.blank?
-
-versions = %x`gem list -r -a -e rails`.scan(/\b((\d+\.)+\d+)\b/).map { |m| m[0] }
-ver = versions.find { |v| v.start_with?(ver) }
-abort("Version #{ver} not found!") if ver.blank?
-
-run("gem install rails -v #{ver}")
-
-RAILS_NEW_SCRIPT = {
-  '5' => {
-    args: %w[
-      database=sqlite3
-      skip-yarn
-      skip-git
-      skip-keeps
-      skip-sprockets
-      skip-spring
-      skip-listen
-      skip-turbolinks
-      skip-javascript
-      skip-test
-      skip-bundle
-    ],
-    keep_gems: /^\s*gem\s+['"](rails|puma|bootsnap)/,
-    append: "gem 'sqlite3', '~> 1.3.10'",
-  },
-}
-
-require 'pathname'
-require 'fileutils'
-
-scirpt = RAILS_NEW_SCRIPT[ver[0]]
-run("rails new test_vcr #{scirpt[:args].map { |a| "--#{a}" }.join(' ')}")
-FileUtils.chdir('test_vcr')
-
-root = Pathname.new(FileUtils.pwd)
-gemfile = root.join('Gemfile').read.split("\n")
-  .reject(&:empty?).reject { |s| s =~ /^\s*#/ }
-  .reject { |s| s =~ /^\s*gem/ && s !~ scirpt[:keep_gems] }
-root.join('Gemfile').write("#{(gemfile + [scirpt[:append]]).join("\n")}\n")
-run('bundle install')