vue_cli-rails 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3d2c392a2c8770db70caa24b770aa90f3e1df54
-  data.tar.gz: c4cbc9443eeda1d9fad9834d30b02e8a492d5cb4
+  metadata.gz: 0a44cb706df2f61b2e5101a4a9573404f02675c9
+  data.tar.gz: a79ae21785870da2ccfed2d6d5a3531eb6e8d311
 SHA512:
-  metadata.gz: 32cf498f71dee9a13a68d91a748ca940e38de76d7e59501903ec60defc54866b3299d0d442c004e5478e00ff6e9c0146a2e8ea9ecfa35671876501ffc69336e5
-  data.tar.gz: 61c43a19b5aa1192943b140e4a9246d1080ba08ff29ac58c55fc1a47f08597c9cbf163a04316bcc29b9ebafcfea35519e300431c27b8e8b49e08796a97cf364b
+  metadata.gz: 9818770c03f196e790c7958ae97275078132863e47c2984d8ae55b1015b2fb220856094a8a11d0d9eba23e6a0a1e70a54deec63d30aff022adbabe6d481281e4
+  data.tar.gz: 490f5bc397ce60f69302a2272bcf516ecdcff0fa639c312d49ce3827bcc6481d930bdd2f10def1e1f21421608899572c8f9e9047eb8d06118640e4ccfcd62627

data/README.md

@@ -1,6 +1,8 @@
 # VueCli::Rails
 
-Get `vue-cli` working on Rails
+Get `vue-cli` working on Rails.
+
+Currently, I am still actively developing this gem. It's usable but lacks of documentation. I will update it once the main features are ready and well-tested.
 
 ## Installation
 
@@ -15,18 +17,16 @@ And then execute:
     $ bundle install
     $ bundle exec rake vue:create
 
-Add those lines to your `config/routes.rb`:
+Follow the steps and copy demo codes, than you can add lines below to your `config/routes.rb`:
 
 ```ruby
   get 'vue/foo' => 'vue#foo'
   get 'vue/bar' => 'vue#bar'
 ```
 
-> Currently `rake vue:create` will overwrite all files, please be careful!
-
 ## Usage
 
-This gem is fully depends on `vue-cli`. You can do everything with [`vue.config.js`](https://cli.vuejs.org/config/) just don't break `manifest` plugin which required by `vue_cli-rails`.
+This gem is fully depends on `vue-cli`. You can do anything with [`vue.config.js`](https://cli.vuejs.org/config/) just don't break `manifest` plugin which required by `vue_cli-rails`.
 
 When you starting `rails server` with development mode, `vue-cli-service serve` will be running at the same time.
 

data/lib/source/vue.config.js

@@ -1,8 +1,3 @@
-// Please do NOT edit settings required by vue_cli-rails
-/* [DO NOT EDIT!] begin */
-const WebpackAssetsManifest = require('webpack-assets-manifest');
-/* [DO NOT EDIT!] end */
-
 // const CompressionWebpackPlugin = require('compression-webpack-plugin');
 // const { BundleAnalyzerPlugin } = require('webpack-bundle-analyzer');
 
@@ -13,7 +8,7 @@ const {
   outputDir,
   devServer,
   publicPath,
-  manifestOutput,
+  manifest,
   isProd,
 } = require('./vue.rails');
 
@@ -21,6 +16,7 @@ module.exports = {
   outputDir,
   publicPath,
   devServer,
+  css,
   chainWebpack: (config) => {
     config
       // clear entry points if there is any
@@ -29,14 +25,8 @@ module.exports = {
       .end()
       /* [DO NOT EDIT!] begin */
       .plugin('manifest')
-      .use(WebpackAssetsManifest)
-      .init(Plugin => new Plugin({
-        integrity: false,
-        entrypoints: true,
-        writeToDisk: true,
-        publicPath: true,
-        output: manifestOutput,
-      }))
+      .use(manifest.plugin)
+      .init(Plugin => new Plugin(manifest.options))
       .end()
       /* [DO NOT EDIT!] end */
       .plugins
@@ -73,7 +63,6 @@ module.exports = {
       */
     }
   },
-  css,
   configureWebpack: {
     entry,
     resolve: {

data/lib/source/vue.rails.js

@@ -4,6 +4,7 @@ module.exports = (() => {
   let settings = {};
 
   /* eslint-disable global-require,import/no-extraneous-dependencies */
+  const WebpackAssetsManifest = require('webpack-assets-manifest');
   try {
     const yaml = require('js-yaml');
     const { readFileSync, readdirSync, lstatSync } = require('fs');
@@ -56,8 +57,22 @@ module.exports = (() => {
   }
   /* eslint-enable global-require,import/no-extraneous-dependencies */
 
+  const assets = {};
+  const manifest = {
+    plugin: WebpackAssetsManifest,
+    assets,
+    options: {
+      assets,
+      entrypoints: true,
+      writeToDisk: true,
+      publicPath: true,
+      output: settings.manifestOutput,
+    },
+  };
+
   return {
     ...settings,
+    manifest,
     isProd: settings.env === 'production',
   };
 })();

data/lib/source/vue.yml

@@ -1,6 +1,6 @@
 default: &default
   package_manager: #PACKAGE_MANAGER
-  manifestOutput: app/assets/vue/manifest.dev.json
+  manifestOutput: tmp/manifest.dev.json
   public_output_path: vue_assets
   alias:
     '@': app/assets/vue

data/lib/tasks/vue.rake

@@ -1,28 +1,94 @@
 namespace :vue do
   desc 'Run vue-cli create and regenerate configuration'
-  task :create, [:package_manager] do |_t, args|
+  task :create do
     pm = VueCli::Rails::NodeEnv.new
-    pm.use!(args.package_manager)
-    root = ::Rails.root
+    abort('Cannot find node.js') unless pm.node?
 
-    # generate config/vue.yml
-    FileUtils.chdir root
-    # `vue create .` and dependencies
-    pm.exec('vue create', '', "-n -m #{pm.package_manager} .")
-    pm.add '-D webpack-assets-manifest js-yaml'
-    FileUtils.rm_rf root.join('src')
+    get_input = ->(message, list = 'Yn') {
+      list = list.chars
+      default = list.find { |c| c.upcase == c }
+      list = list.map { |c| c == default ? c : c.downcase }.uniq
+      valid = "[#{list.join('')}]"
+      list = list.map(&:downcase)
+      print "#{message} #{valid}"
+      loop do
+        r = STDIN.gets.chop.downcase
+        break default if r == ''
+        break r if list.include?(r)
+        print "  [INVALID!] Please retry: #{valid}:"
+      end
+    }
+
+    # 1. package manager
+    yarn = pm.yarn_version
+    npm = pm.npm_version
+    if yarn
+      if npm
+        input = get_input.call('Which package manager to use (Y=Yarn, N=npm)?')
+        pm.use!(input == 'n' ? :npm : :yarn)
+      else
+        pm.use!(:yarn)
+      end
+    elsif npm
+      pm.use!(:npm)
+    else
+      abort('Cannot find npm or yarn')
+    end
+    puts "Using package manager: #{pm.package_manager}"
 
-    # dirs under `app`
     src_dir = Pathname.new(__FILE__).dirname.join('..', 'source')
-    FileUtils.cp_r(src_dir.join('app'), root)
-    binding.pry
-    Dir[src_dir.join('vue.*.js')].each do |fn|
-      FileUtils.cp(fn, "#{root}/")
+    root = ::Rails.root
+    FileUtils.chdir root
+
+    # 2. vue create .
+    input = 'y'
+    pack = root.join('package.json')
+    if pack.exist?
+      puts 'Detected `package.json`!'
+      input = get_input.call('  Do you want to rerun `vue create?`', 'yN')
+    end
+    pm.exec('vue create', '', "-n -m #{pm.package_manager} .") if input == 'y'
+
+    # 3. dev-dependencies
+    package = JSON.parse(pack.read)
+    dev_deps = package['devDependencies']
+    dd = %w[webpack-assets-manifest js-yaml].find_all do |dep|
+      !dev_deps.key?(dep)
+    end
+    pm.add "-D #{dd.join(' ')}" if dd.any?
+
+    # 4. remove `src` folder
+    src = root.join('src')
+    if src.exist? && src.directory?
+      puts 'Detected `src` folder (should be generated by vue-cli)'
+      input = get_input.call('  Do you want to delete src folder?')
+      FileUtils.rm_rf root.join('src') if input == 'y'
+    end
+
+    # 5. copy sample codes
+    input = get_input.call('Do you want to copy demo code?', 'yN')
+    FileUtils.cp_r(src_dir.join('app'), root) if input == 'y'
+
+    # 6. config files
+    FileUtils.cp(src_dir.join('vue.rails.js'), "#{root}/")
+    input = 'y'
+    if root.join('vue.config.js').exist?
+      puts 'Detected `vue.config.js`!'
+      input = get_input.call('  Do you want to overwrite vue.config.js?', 'yN')
     end
+    FileUtils.cp(src_dir.join('vue.config.js'), "#{root}/") if input == 'y'
 
-    yml = src_dir.join('vue.yml').read
-    yml = yml.sub('#PACKAGE_MANAGER', pm.package_manager.to_s)
-    root.join('config', 'vue.yml').write(yml)
+    # 7. generate config/vue.yml
+    yml_dest = root.join('config', 'vue.yml')
+    if yml_dest.exist?
+      puts 'Detected `config/vue.yml`!'
+      input = get_input.call('  Do you want to overwrite config/vue.yml?')
+    end
+    if input == 'y'
+      yml = src_dir.join('vue.yml').read
+      yml = yml.sub('#PACKAGE_MANAGER', pm.package_manager.to_s)
+      yml_dest.write(yml)
+    end
   end
 
   desc 'Add pug template support: formats=pug,sass,less,stylus'

data/lib/vue_cli/rails/helper.rb

@@ -4,14 +4,14 @@ module VueCli
       def vue_entry(name)
         @config ||= VueCli::Rails::Configuration.instance
 
-        entry = @config.manifest_data['entrypoints']&.fetch(name)
+        entry = (@config.manifest_data['entrypoints'] || {})[name]
         return nil if entry.blank?
 
         assets = []
-        entry['css']&.each do |css|
+        (entry['css'] || []).each do |css|
           assets << stylesheet_link_tag(css)
         end
-        entry['js']&.each do |js|
+        (entry['js'] || []).each do |js|
           assets << javascript_include_tag(js)
         end
 

data/lib/vue_cli/rails/node_env.rb

@@ -4,29 +4,24 @@ module VueCli
       NODE_BIN_LIST = %i[node yarn npm npx vue].freeze
 
       def initialize
-        h = {}
-        NODE_BIN_LIST.each do |bin|
-          h[bin] = get_version_of(bin)
-        end
-        @versions = h
+        @versions = {}
         yield(self) if block_given?
       end
 
       NODE_BIN_LIST.each do |bin|
         define_method :"#{bin}_version" do
-          @versions[bin]
+          get_version_of(bin)
         end
 
         define_method :"#{bin}?" do
-          @versions[bin].present?
+          get_version_of(bin).present?
         end
       end
 
       def use!(pm)
-        @pm = (pm || (yarn? ? 'yarn' : 'npm')).to_sym
-        unless (@pm == :npm || @pm == :yarn) && self.try(:"#{@pm}?")
-          raise(VueCli::Rails::Error, "Unknown package manager: #{@pm}")
-        end
+        @pm = pm.to_sym
+        raise(ArgumentError, "Unsupported manager: #{@pm}") unless %i[npm yarn].include?(@pm)
+        raise(VueCli::Rails::Error, "Not installed: #{@pm}") unless self.try(:"#{@pm}?")
       end
 
       def package_manager
@@ -65,10 +60,11 @@ module VueCli
       private
 
       def get_version_of(bin)
-        r = `#{bin} --version`.strip.presence
-        return nil if r.nil?
+        return @versions[bin] if @versions.key?(bin)
 
-        r.start_with?('v') ? r[1..-1] : r
+        r = `#{bin} --version`.strip.presence
+        @versions[bin] = r && r.start_with?('v') ? r[1..-1] : r
+        @versions[bin]
       end
 
       def version_ge?(v1, v2)

data/lib/vue_cli/rails/version.rb

@@ -1,5 +1,5 @@
 module VueCli
   module Rails
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vue_cli-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - James Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-24 00:00:00.000000000 Z
+date: 2019-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport