jets 1.9.32 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d10f05b816286dec593e0c9ca8581e2676508bd0654f482d820daed75f5d530
-  data.tar.gz: 478a8b35bab50653e88310fec4433cb9bed0f083080c0263d44fcb03fb5df0c0
+  metadata.gz: 90b750940941cb6ebaa69fc6a0cda74dc858db9f646a2c90b5a90e1b037518d8
+  data.tar.gz: b591655943debcf36b60618e11745d172658dd3fe7415a9ab46c6e4e2adf4c27
 SHA512:
-  metadata.gz: da638c5d9a3b9f2e4dd2b1061230d03082e942e2a5f0f574d6ef098759e948401d61b518384f985a520e23910cd30f347caf26364b4e0850865356524b1938a9
-  data.tar.gz: b1e6cf71f5bfac26f35f508ca7370a6acf80cead9282a11e25c114fb8f6bb9d4d411cd324c2721f6e9896f94eb34b6196be9fdb629375a03f2048b1d7e3fe58c
+  metadata.gz: 694c37c3c6331c565441ae486643969bdebc914ec193ca8fdec5d36fb928915aee9ede4c8fbe689b06fef1a52f6bd8072188b4796c247e16e9b9bb810163dfbb
+  data.tar.gz: b28b1b16569a58d06e647a3d05ac8ecdb9d0ba7e615870d82273d6911da31386ae7c86593a97ee41933ed6aa592eae3b92b407ad5b8cb5d2a11fa0f3c98fd0fd

data/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
+## [2.0.0]
+- #318 Major Routing upgrade
+- Routing Upgrades: nested resources, namespace, scope, singular resource
+- Name routes helpers
+- Forgery protection
+- Generators upgrades: scaffold, controller, model, job, etc
+- Autoload Rake tasks in lib/tasks.
+- Update upgrading docs
+
 ## [1.9.32]
 - #317 fix jets deploy when no /tmp/jets exists yet
 

data/lib/jets/application/defaults.rb

@@ -139,6 +139,12 @@ class Jets::Application
       # So tried to defined this in the jets/mailer.rb Turbine only but jets new requires it
       # config.action_mailer = ActiveSupport::OrderedOptions.new
 
+      config.helpers = ActiveSupport::OrderedOptions.new
+      config.helpers.host = nil # nil by default. Other examples: https://myurl.com:8888
+
+      config.controllers = ActiveSupport::OrderedOptions.new
+      config.controllers.default_protect_from_forgery = true
+
       config
     end
 

data/lib/jets/cli.rb

@@ -76,6 +76,15 @@ class Jets::CLI
   def thor_args
     args = @given_args.clone
 
+    # jets generate is a special command requires doesn't puts out the help menu automatically when
+    # `jets generate` is called without additional args.  We'll take it over early and fix it here.
+    autocomplete_command = Jets::Commands::Base.autocomplete(args[0])
+    generate = autocomplete_command == "generate"
+    if generate && (args.size == 1 || help_flags.include?(args.last))
+      puts Jets::Generator.help
+      exit
+    end
+
     help_args = args & help_flags
     unless help_args.empty?
       # Allow using help flags at the end of the command to trigger help menu

data/lib/jets/commands/help/generate.md

@@ -1,22 +1,28 @@
 This piggy backs off of the [rails scaffold generator](https://guides.rubyonrails.org/command_line.html#rails-generate).
 
-## Example
+## General options
 
-    $ jets generate scaffold post title:string body:text published:boolean
-          invoke  active_record
-          create    db/migrate/20180817052529_create_posts.rb
-          create    app/models/post.rb
-          invoke  resource_route
-           route    resources :posts
-          invoke  scaffold_controller
-          create    app/controllers/posts_controller.rb
-          invoke    erb
-          create      app/views/posts
-          create      app/views/posts/index.html.erb
-          create      app/views/posts/edit.html.erb
-          create      app/views/posts/show.html.erb
-          create      app/views/posts/new.html.erb
-          create      app/views/posts/_form.html.erb
-          invoke    helper
-          create      app/helpers/posts_helper.rb
-    $
+    -h, [--help]     # Print generator's options and usage
+    -p, [--pretend]  # Run but do not make any changes
+    -f, [--force]    # Overwrite files that already exist
+    -s, [--skip]     # Skip files that already exist
+    -q, [--quiet]    # Suppress status output
+
+Please choose a generator below.
+
+Jets:
+
+    application_record
+    controller
+    helper
+    job
+    migration
+    model
+    resource
+    scaffold
+    scaffold_controller
+    task
+
+ActiveRecord:
+
+    active_record:application_record

data/lib/jets/commands/main.rb

@@ -51,7 +51,7 @@ module Jets::Commands
     desc "routes", "Print out your application routes"
     long_desc Help.text(:routes)
     def routes
-      puts Jets::Router.routes_help
+      puts Jets::Router.help(Jets::Router.routes)
     end
 
     desc "console", "REPL console with Jets environment loaded"
@@ -97,13 +97,13 @@ module Jets::Commands
     end
 
     desc "generate [type] [args]", "Generates things like scaffolds"
-    long_desc Help.text(:generate)
+    long_desc Jets::Generator.help
     def generate(generator, *args)
       Jets::Generator.invoke(generator, *args)
     end
 
     desc "degenerate [type] [args]", "Destroys things like scaffolds"
-    long_desc Help.text(:degenerate)
+    long_desc Jets::Generator.help
     def degenerate(generator, *args)
       Jets::Generator.revoke(generator, *args)
     end

data/lib/jets/commands/rake_tasks.rb

@@ -17,6 +17,9 @@ class Jets::Commands::RakeTasks
       Jets::Commands::Db::Tasks.load!
       load_webpacker_tasks
 
+      # custom project rake tasks
+      Dir.glob("#{Jets.root}/lib/tasks/*.rake").each { |r| load r }
+
       @@loaded = true
     end
 

data/lib/jets/commands/templates/skeleton/app/views/layouts/application.html.erb.tt

@@ -5,6 +5,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
   <meta name="theme-color" content="#000000">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <%%= csrf_meta_tags %>
   <title>Jets App</title>
   <%%= javascript_pack_tag "application" %>
   <%%= stylesheet_pack_tag "theme" %>

data/lib/jets/commands/templates/skeleton/config/application.rb.tt

@@ -64,4 +64,8 @@ Jets.application.configure do
   # local testing environment you may want to log these messages to 'test.log' file to keep your
   # testing suite output readable.
   # config.logger = Jets::Logger.new($strerr)
+
+<% if @options[:mode] == 'api' -%>
+  config.controllers.default_protect_from_forgery = false
+<% end -%>
 end

data/lib/jets/commands/templates/webpacker/app/javascript/src/jets/crud.js

@@ -66,9 +66,12 @@ $(function() {
     node.hide(); // immediately hide element
 
     var resource = link.attr("href");
+    var token = $('meta[name=csrf-token]').attr('content');
+    var data = { authenticity_token: token };
     var request = $.ajax({
       url: resource,
       method: "DELETE",
+      data: data,
       dataType: "json"
     });
 

data/lib/jets/commands/upgrade.rb

@@ -9,138 +9,71 @@ module Jets::Commands
 
     def run
       puts "Upgrading to Jets structure to latest version"
-      environment_configs
-      update_routes
-      update_mode_setting
-      update_config_ru
-      remove_ruby_lazy_load
-      update_webpack_binstubs
-      add_dynomite_to_gemfile
+      Version1.new.run
+      # version 2 upgrades
+      inject_csrf_meta_tags
+      update_crud_js
+      update_config_application_rb
       puts "Upgrade complete."
     end
 
-    def environment_configs
-      path = File.expand_path("templates/skeleton/config/environments", File.dirname(__FILE__))
-      puts "path #{path}"
-      Dir.glob("#{path}/*").each do |src|
-        config_file = "config/environments/#{File.basename(src)}"
-        dest = "#{Jets.root}/#{config_file}"
+    def inject_csrf_meta_tags
+      layout = "app/views/layouts/application.html.erb"
+      return unless File.exist?(layout)
 
-        puts "src #{src}"
-        puts "dest #{dest}"
-        unless File.exist?(dest)
-          puts "Create: #{config_file}"
-          FileUtils.mkdir_p(File.dirname(dest))
-          FileUtils.cp(src, dest)
-        end
-      end
-    end
-
-    def update_routes
-      routes_file = "#{Jets.root}/config/routes.rb"
-      return unless File.exist?(routes_file)
-
-      lines = IO.readlines(routes_file)
-      deprecated_code = 'root "jets/welcome#index"'
-      return unless lines.detect { |l| l.include?(deprecated_code) }
+      lines = IO.readlines(layout)
+      csrf_meta_tags = lines.find { |l| l =~ /<%= csrf_meta_tags %>/ }
+      return if csrf_meta_tags
 
-      puts "Update: config/routes.rb"
+      puts "Update: #{layout} with csrf_meta_tags helper"
       lines.map! do |line|
-        if line.include?(deprecated_code)
-          %Q|  root "jets/public#show"\n| # assume 2 spaces for simplicity
+        if line.include?("<head>")
+          # add csrf_meta_tags helper
+          "#{line}  <%= csrf_meta_tags %>\n"
         else
           line
         end
       end
 
       content = lines.join
-      IO.write(routes_file, content)
+      IO.write(layout, content)
     end
 
-    def update_mode_setting
-      application_file = "#{Jets.root}/config/application.rb"
-      lines = IO.readlines(application_file)
-      deprecated_code = 'config.api_generator'
-      return unless lines.detect { |l| l.include?(deprecated_code) }
-
-      puts "Update: config/application.rb"
-      lines.map! do |line|
-        if line.include?(deprecated_code)
-          mode = Jets.config.api_generator ? 'api' : 'html'
-          %Q|  config.mode = "#{mode}"\n| # assume 2 spaces for simplicity
-        else
-          line
-        end
-      end
-
-      content = lines.join
-      IO.write(application_file, content)
-    end
+    def update_crud_js
+      src = File.expand_path("templates/webpacker/app/javascript/src/jets/crud.js", File.dirname(__FILE__))
+      dest = "app/javascript/src/jets/crud.js"
+      return unless File.exist?(dest)
 
-    def update_config_ru
-      src = "#{Jets.root}/config.ru"
-      return unless File.exist?(src)
-      config_ru = File.read(src)
-      return if config_ru.include?("Jets.boot")
+      lines = IO.readlines(dest)
+      csrf = lines.find { |l| l =~ /csrf-token/ }
+      return if csrf
 
-      src = File.expand_path("templates/skeleton/config.ru", File.dirname(__FILE__))
-      dest = src
-      puts "Update: config.ru"
+      FileUtils.mkdir_p(File.dirname(dest))
       FileUtils.cp(src, dest)
+      puts "Update: #{dest}"
     end
 
-    def remove_ruby_lazy_load
-      app_config = "#{Jets.root}/config/application.rb"
-      remove_ruby_lazy_load_for(app_config)
-      Dir.glob("#{Jets.root}/config/environments/*.rb").each do |env_config|
-        remove_ruby_lazy_load_for(env_config)
-      end
-    end
-
-    def remove_ruby_lazy_load_for(path)
-      lines = IO.readlines(path)
-      new_lines = lines.reject do |l|
-        l =~ %r{config.ruby.lazy_load}
-      end
-      return unless lines != new_lines
-
-      content = new_lines.join("")
-      IO.write(path, content)
-      puts "Update: #{path}"
-    end
-
-    def update_webpack_binstubs
-      return unless File.exist?("bin/webpack")
-      lines = IO.readlines("bin/webpack")
-      already_upgraded = lines.detect { |l| l =~ /WebpackRunner/ }
-      return if already_upgraded
-
-      update_project_file("bin/webpack")
-      update_project_file("bin/webpack-dev-server")
-      puts "Updated webpack binstubs."
-    end
-
-    def add_dynomite_to_gemfile
-      return unless File.exist?("app/models/application_item.rb")
+    def update_config_application_rb
+      app_rb = "config/application.rb"
+      lines = IO.readlines(app_rb)
+      api_mode = lines.find { |l| l =~ /config\.mode/ && l =~ /api/ }
+      return unless api_mode
 
-      lines = IO.readlines("Gemfile")
-      dynomite_found = lines.detect { |l| l =~ /dynomite/ }
-      return if dynomite_found
+      forgery = lines.find { |l| l =~ /default_protect_from_forgery/ }
+      return if forgery
 
-      File.open('Gemfile', 'a') do |f|
-        f.puts 'gem "dynomite"'
+      lines.map! do |line|
+        if line =~ /^end/
+          # add default_protect_from_forgery = false
+          "  config.controllers.default_protect_from_forgery = false\n#{line}"
+        else
+          line
+        end
       end
-      puts "Updated Gemfile: add dynomite gem"
-    end
 
-  private
-    def update_project_file(relative_path)
-      templates = File.expand_path("upgrade/templates", File.dirname(__FILE__))
-      src = "#{templates}/#{relative_path}"
-      dest = relative_path
-      FileUtils.mkdir_p(File.dirname(dest))
-      FileUtils.cp(src, dest)
-      puts "Update: #{dest}"
+      content = lines.join
+      IO.write(app_rb, content)
+      puts "Update: #{app_rb} with default_protect_from_forgery"
     end
   end
 end

data/lib/jets/commands/upgrade/version1.rb

@@ -0,0 +1,136 @@
+class Jets::Commands::Upgrade
+  class Version1
+    def run
+      environment_configs
+      update_routes
+      update_mode_setting
+      update_config_ru
+      remove_ruby_lazy_load
+      update_webpack_binstubs
+      add_dynomite_to_gemfile
+    end
+
+    def environment_configs
+      path = File.expand_path("templates/skeleton/config/environments", File.dirname(__FILE__))
+      Dir.glob("#{path}/*").each do |src|
+        config_file = "config/environments/#{File.basename(src)}"
+        dest = "#{Jets.root}/#{config_file}"
+
+        puts "src #{src}"
+        puts "dest #{dest}"
+        unless File.exist?(dest)
+          puts "Create: #{config_file}"
+          FileUtils.mkdir_p(File.dirname(dest))
+          FileUtils.cp(src, dest)
+        end
+      end
+    end
+
+    def update_routes
+      routes_file = "#{Jets.root}/config/routes.rb"
+      return unless File.exist?(routes_file)
+
+      lines = IO.readlines(routes_file)
+      deprecated_code = 'root "jets/welcome#index"'
+      return unless lines.detect { |l| l.include?(deprecated_code) }
+
+      puts "Update: config/routes.rb"
+      lines.map! do |line|
+        if line.include?(deprecated_code)
+          %Q|  root "jets/public#show"\n| # assume 2 spaces for simplicity
+        else
+          line
+        end
+      end
+
+      content = lines.join
+      IO.write(routes_file, content)
+    end
+
+    def update_mode_setting
+      application_file = "#{Jets.root}/config/application.rb"
+      lines = IO.readlines(application_file)
+      deprecated_code = 'config.api_generator'
+      return unless lines.detect { |l| l.include?(deprecated_code) }
+
+      puts "Update: config/application.rb"
+      lines.map! do |line|
+        if line.include?(deprecated_code)
+          mode = Jets.config.api_generator ? 'api' : 'html'
+          %Q|  config.mode = "#{mode}"\n| # assume 2 spaces for simplicity
+        else
+          line
+        end
+      end
+
+      content = lines.join
+      IO.write(application_file, content)
+    end
+
+    def update_config_ru
+      src = "#{Jets.root}/config.ru"
+      return unless File.exist?(src)
+      config_ru = File.read(src)
+      return if config_ru.include?("Jets.boot")
+
+      src = File.expand_path("templates/skeleton/config.ru", File.dirname(__FILE__))
+      dest = src
+      puts "Update: config.ru"
+      FileUtils.cp(src, dest)
+    end
+
+    def remove_ruby_lazy_load
+      app_config = "#{Jets.root}/config/application.rb"
+      remove_ruby_lazy_load_for(app_config)
+      Dir.glob("#{Jets.root}/config/environments/*.rb").each do |env_config|
+        remove_ruby_lazy_load_for(env_config)
+      end
+    end
+
+    def remove_ruby_lazy_load_for(path)
+      lines = IO.readlines(path)
+      new_lines = lines.reject do |l|
+        l =~ %r{config.ruby.lazy_load}
+      end
+      return unless lines != new_lines
+
+      content = new_lines.join("")
+      IO.write(path, content)
+      puts "Update: #{path}"
+    end
+
+    def update_webpack_binstubs
+      return unless File.exist?("bin/webpack")
+      lines = IO.readlines("bin/webpack")
+      already_upgraded = lines.detect { |l| l =~ /WebpackRunner/ }
+      return if already_upgraded
+
+      update_project_file("bin/webpack")
+      update_project_file("bin/webpack-dev-server")
+      puts "Updated webpack binstubs."
+    end
+
+    def add_dynomite_to_gemfile
+      return unless File.exist?("app/models/application_item.rb")
+
+      lines = IO.readlines("Gemfile")
+      dynomite_found = lines.detect { |l| l =~ /dynomite/ }
+      return if dynomite_found
+
+      File.open('Gemfile', 'a') do |f|
+        f.puts 'gem "dynomite"'
+      end
+      puts "Updated Gemfile: add dynomite gem"
+    end
+
+  private
+    def update_project_file(relative_path)
+      templates = File.expand_path("upgrade/templates", File.dirname(__dir__))
+      src = "#{templates}/#{relative_path}"
+      dest = relative_path
+      FileUtils.mkdir_p(File.dirname(dest))
+      FileUtils.cp(src, dest)
+      puts "Update: #{dest}"
+    end
+  end
+end