draft_generators 0.0.3

data/lib/generators/draft/layout/layout_generator.rb

@@ -0,0 +1,66 @@
+module Draft
+  class LayoutGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    class_option :theme, type: :string, default: "none", desc: "Bootstrap theme"
+    class_option :layout_file, type: :string, default: "application", desc: "Layout filename"
+    class_option :skip_cdn, type: :boolean, default: false, desc: "Skip connecting CDN assets"
+
+    def generate_layout
+      if bootswatch?
+        log :insert, "Adding #{theme_name.capitalize} Bootswatch"
+      else
+        log :insert, "Adding Bootstrap"
+      end
+
+      log :insert, "Adding Font Awesome"
+      log :insert, "Adding navbar"
+      log :insert, "Adding alerts"
+      log :insert, "Adding sticky footer; you may need to add
+
+                padding-bottom: 70px
+
+              to the body of the document."
+
+      template "layout.html.erb", "app/views/layouts/#{options["layout_file"]}.html.erb"
+
+      template "_navbar.html.erb", "app/views/shared/_navbar.html.erb"
+
+      template "_flashes.html.erb", "app/views/shared/_flashes.html.erb"
+
+      unless skip_cdn?
+        template "_bootstrapcdn_assets.html.erb", "app/views/shared/_bootstrapcdn_assets.html.erb"
+      end
+    end
+
+  protected
+
+    def bootswatch?
+      if theme_name.present?
+        theme_name != "none"
+      end
+    end
+
+    def theme_name
+      options["theme"].downcase
+    end
+
+    def skip_cdn?
+      options["skip_cdn"]
+    end
+
+    def app_resources
+      route_names.reject { |name| /^rails_info.*/.match(name) || /^rails_mailers.*/.match(name) || name.pluralize != name }
+    end
+
+    def devise_routes
+      route_names.map do |name|
+        /new_(.*)_registration/.match(name)
+      end.compact
+    end
+
+    def route_names
+      @route_names ||= Rails.application.routes.routes.map(&:name).uniq.compact
+    end
+  end
+end

data/lib/generators/draft/layout/templates/_bootstrapcdn_assets.html.erb

@@ -0,0 +1,10 @@
+<% if bootswatch? -%>
+<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootswatch/4.0.0-beta.3/<%= theme_name %>/bootstrap.min.css">
+<% else -%>
+<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css">
+<% end -%>
+<link rel="stylesheet"href="https://use.fontawesome.com/releases/v5.0.6/css/all.css" >
+
+<script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js"></script>

data/lib/generators/draft/layout/templates/_flashes.html.erb

@@ -0,0 +1,23 @@
+<div class="row">
+  <div class="col-md-12">
+    <%% if notice.present? %>
+      <div class="alert alert-success alert-dismissable" role="alert">
+        <%%= notice %>
+
+        <button type="button" class="close" data-dismiss="alert" aria-label="Close">
+          <span aria-hidden="true">&times;</span>
+        </button>
+      </div>
+    <%% end %>
+
+    <%% if alert.present? %>
+      <div class="alert alert-warning alert-dismissable" role="alert">
+        <%%= alert %>
+
+        <button type="button" class="close" data-dismiss="alert" aria-label="Close">
+          <span aria-hidden="true">&times;</span>
+        </button>
+      </div>
+    <%% end %>
+  </div>
+</div>

data/lib/generators/draft/layout/templates/_navbar.html.erb

@@ -0,0 +1,75 @@
+<nav class="navbar navbar-expand-lg navbar-light bg-light mb-4">
+  <div class="container">
+    <a class="navbar-brand" href="/">
+      <%= Rails.application.class.parent_name %>
+    </a>
+
+    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#collapsible-nav-links" aria-controls="collapsible-nav-links" aria-expanded="false" aria-label="Toggle navigation">
+      <span class="navbar-toggler-icon"></span>
+    </button>
+
+    <div class="collapse navbar-collapse" id="collapsible-nav-links">
+      <ul class="navbar-nav mr-auto">
+        <li class="nav-item dropdown">
+          <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+            Resources
+          </a>
+          <div class="dropdown-menu" aria-labelledby="navbarDropdown">
+<% app_resources.each do |resource| -%>
+            <a href="/<%= resource %>" class="dropdown-item">
+              <%= resource.humanize.titleize %>
+            </a>
+<% end -%>
+          </div>
+        </li>
+      </ul>
+<% if devise_routes.any? -%>
+<% devise_routes.each do |devise_route| -%>
+      <ul class="navbar-nav">
+        <%% if current_<%= devise_route[1]%>.blank? %>
+          <li class="nav-item">
+            <a href="/<%= devise_route[1].pluralize %>/sign_in" class="nav-link">
+<% if devise_routes.size > 1 -%>
+              <%= devise_route[1].classify %> sign in
+<% else -%>
+              Sign in
+<% end -%>
+            </a>
+          </li>
+
+          <li class="nav-item">
+            <a href="/<%= devise_route[1].pluralize %>/sign_up" class="nav-link">
+<% if devise_routes.size > 1 -%>
+              <%= devise_route[1].classify %> sign up
+<% else -%>
+              Sign up
+<% end -%>
+            </a>
+          </li>
+        <%% else %>
+          <li class="nav-item">
+            <a href="/<%= devise_route[1].pluralize %>/edit" class="nav-link">
+<% if devise_routes.size > 1 -%>
+              <%= devise_route[1].classify %> edit profile
+<% else -%>
+              Edit profile
+<% end -%>
+            </a>
+          </li>
+
+          <li class="nav-item">
+            <a href="/<%= devise_route[1].pluralize %>/sign_out" data-method="delete" class="nav-link">
+<% if devise_routes.size > 1 -%>
+              <%= devise_route[1].classify %> sign out
+<% else -%>
+              Sign out
+<% end -%>
+            </a>
+          </li>
+        <%% end %>
+      </ul>
+<% end -%>
+<% end -%>
+    </div> <!-- .navbar-collapse -->
+  </div> <!-- .container -->
+</nav>

data/lib/generators/draft/layout/templates/layout.html.erb

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+    <%= Rails.application.class.parent_name %>
+  </title>
+
+<% unless skip_cdn? -%>
+  <%%= render "shared/bootstrapcdn_assets" %>
+
+<% end -%>
+  <%%= csrf_meta_tags %>
+  
+  <%%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+  <%%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/tempusdominus-bootstrap-4/5.0.0-alpha14/css/tempusdominus-bootstrap-4.min.css" />
+  <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/tempusdominus-bootstrap-4/5.0.0-alpha14/js/tempusdominus-bootstrap-4.min.js"></script>
+  <script src="//maps.google.com/maps/api/js?v=3.24&key=AIzaSyCOTPWiuvyyo6sKoIBzKA4-1ol-vTOIOlM"></script>
+  <script src="//cdn.rawgit.com/mahnunchik/markerclustererplus/master/dist/markerclusterer.min.js"></script>
+
+
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+  <meta charset="utf-8">
+  <style>
+    body { padding-bottom: 70px }
+  </style>
+</head>
+
+<body>
+  <%%= render "shared/navbar" %>
+
+  <div class="container">
+    <%%= render "shared/flashes" %>
+
+    <%%= yield %>
+  </div>
+
+</body>
+</html>

data/lib/generators/draft/model/USAGE

@@ -0,0 +1,14 @@
+Description:
+
+    Generates the files you need to get started saving information to a
+    database table:
+
+     - A Ruby script that will create the database table (called a "migration")
+     - A Ruby class that will serve as a translator for talking to the table
+        (called a "model")
+     - A file that will make it easy to manage the table using the Active Admin
+        gem
+
+    Examples:
+
+        rails generate draft:model photo source:string caption:text

data/lib/generators/draft/model/model_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+
+module Draft
+  class ModelGenerator < Rails::Generators::NamedBase
+    argument :attributes, type: :array, default: [],
+                          banner: "field[:type][:index] field[:type][:index]"
+    def generate_model
+      invoke "model"
+    end
+
+    def generate_active_admin
+      if Gem.loaded_specs.has_key? "activeadmin"
+        invoke "active_admin:resource", [singular_table_name]
+
+        permit_active_admin_params
+      end
+    end
+
+    private
+
+    def permit_active_admin_params
+      if File.exist?("app/admin/#{singular_table_name}.rb")
+        insert_code(singular_table_name)
+      elsif File.exist?("app/admin/#{plural_table_name}.rb")
+        insert_code(plural_table_name)
+      end
+    end
+
+    def insert_code(file_name)
+      sentinel = /.*ActiveAdmin.register.*do.*/
+      inside "app" do
+        inside "admin" do
+          insert_into_file "#{file_name}.rb", after: sentinel do
+            "\n  permit_params #{attributes_names.map { |name| ":#{name}" }.join(', ')}\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/draft/resource/USAGE

@@ -0,0 +1,11 @@
+Description:
+
+    Generates an entire database-backed CRUD resource with a web interface:
+
+     - the database table (migration to create it)
+     - the model to interact with it
+     - routes, controller, and views for users to CRUD
+
+Examples:
+
+    rails generate draft:resource post title body:text published:boolean

data/lib/generators/draft/resource/resource_generator.rb

@@ -0,0 +1,172 @@
+module Draft
+  class ResourceGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __FILE__)
+
+    argument :attributes, type: :array, default: [], banner: "field:type field:type"
+    class_option :skip_model, type: :boolean, default: false, desc: "Skip model, migration, and specs"
+    class_option :skip_controller, type: :boolean, default: false, desc: "Skip controller and routes"
+    class_option :read_only, type: :boolean, default: false, desc: "Only generates the index and show actions"
+    class_option :skip_validation_alerts, type: :boolean, default: false, desc: "Skip validation failure alerts"
+    class_option :skip_post, type: :boolean, default: false, desc: "Skip HTTP POST verb"
+    class_option :skip_redirect, type: :boolean, default: false, desc: "Skip redirecting after create, update, and destroy"
+    class_option :only_new_form, type: :boolean, default: false, desc: "Generate association new form"
+    class_option :new_form_name, type: :string, default: "", desc: "Partial name"
+    class_option :associated_table_name, type: :string, default: "", desc: "Associatiated table name"
+    class_option :with_sentinels, type: :boolean, default: false, desc: "Skip adding comments to generated files"
+
+    def generate_controller
+      return if skip_controller?
+
+      if read_only?
+        template "controllers/read_only_controller.rb", "app/controllers/#{plural_table_name.underscore}_controller.rb"
+      else
+        template "controllers/controller.rb", "app/controllers/#{plural_table_name.underscore}_controller.rb"
+      end
+    end
+
+    def generate_model
+      return if skip_model?
+      invoke "draft:model"
+    end
+
+    def create_root_folder
+      empty_directory File.join("app/views", "#{singular_table_name}_templates")
+    end
+
+    def generate_view_files
+      available_views.each do |view|
+        filename = view_filename_with_extensions(view)
+        template filename, File.join("app/views", "#{singular_table_name}_templates", File.basename(options[:new_form_name].presence || filename))
+      end
+    end
+
+    def generate_routes
+      return if skip_controller?
+
+      if read_only?
+        read_only_routes
+      else
+        golden_seven_routes
+      end
+    end
+
+    def generate_specs
+      # Hotfix to prevent specs during MSM Associations
+      return
+      # return if read_only? || skip_controller? || skip_model?
+
+      template "specs/crud_spec.rb", "spec/features/crud_#{plural_table_name.underscore}_spec.rb"
+      template "specs/factories.rb", "spec/factories/#{plural_table_name.underscore}.rb"
+    end
+
+  private
+
+    def golden_seven_routes
+      log :route, "RESTful routes"
+
+      route <<-RUBY.gsub(/^      /, "")
+
+        # Routes for the #{singular_table_name.humanize} resource:
+
+        # CREATE
+        get("/#{plural_table_name}/new", { :controller => "#{plural_table_name}", :action => "new_form" })
+        #{skip_post? ? "get" : "post"}("/create_#{singular_table_name}", { :controller => "#{plural_table_name}", :action => "create_row" })
+
+        # READ
+        get("/#{plural_table_name}", { :controller => "#{plural_table_name}", :action => "index" })
+        get("/#{plural_table_name}/:id_to_display", { :controller => "#{plural_table_name}", :action => "show" })
+
+        # UPDATE
+        get("/#{plural_table_name}/:prefill_with_id/edit", { :controller => "#{plural_table_name}", :action => "edit_form" })
+        #{skip_post? ? "get" : "post"}("/update_#{singular_table_name}/:id_to_modify", { :controller => "#{plural_table_name}", :action => "update_row" })
+
+        # DELETE
+        get("/delete_#{singular_table_name}/:id_to_remove", { :controller => "#{plural_table_name}", :action => "destroy_row" })
+
+        #------------------------------
+      RUBY
+    end
+
+    def read_only_routes
+      log :route, "Index and show routes"
+
+      route <<-RUBY.gsub(/^      /, "")
+      
+        # Routes for the #{singular_table_name.humanize} resource:
+
+        # READ
+        get("/#{plural_table_name}", { :controller => "#{plural_table_name}", :action => "index" })
+        get("/#{plural_table_name}/:id_to_display", { :controller => "#{plural_table_name}", :action => "show" })
+
+        #------------------------------
+      RUBY
+    end
+
+    def skip_controller?
+      options[:skip_controller] || options[:only_new_form]
+    end
+
+    def skip_model?
+      options[:skip_model] || options[:only_new_form]
+    end
+
+    def read_only?
+      options[:read_only]
+    end
+
+    def skip_validation_alerts?
+      options[:skip_validation_alerts]
+    end
+
+    def skip_post?
+      options[:skip_post]
+    end
+
+    def skip_redirect?
+      options[:skip_redirect]
+    end
+
+    def only_new_form?
+      options[:only_new_form]
+    end
+
+    def with_sentinels?
+      options[:with_sentinels]
+    end
+
+    def new_form_hidden_variable
+      "@#{options[:associated_table_name].singularize}.id"
+    end
+
+    def new_form_create_path
+      "create_#{singular_table_name}_from_#{options[:associated_table_name].singularize}"
+    end
+
+    def route(routing_code)
+      sentinel = /\.routes\.draw do(?:\s*\|map\|)?\s*$/
+
+      inside "config" do
+        insert_into_file "routes.rb", routing_code, after: sentinel
+      end
+    end
+
+    def available_views
+      if read_only?
+        %w(index show)
+      elsif skip_redirect?
+        %w(index show new_form create_row edit_form update_row destroy_row)
+      elsif only_new_form?
+        %w(association_new_form)
+      else
+        %w(index new_form new_form_with_errors edit_form edit_form_with_errors show)
+      end
+    end
+
+    def view_filename_with_extensions(name)
+      filename = [name, :html, :erb].compact.join(".")
+      folders = ["views"]
+      filename = File.join(folders, filename) if folders.any?
+      filename
+    end
+  end
+end