rockstart 0.1.0

data/lib/generators/rockstart/rockstart_generator.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+class RockstartGenerator < Rails::Generators::Base
+  desc "The quickest way for getting Rails Ready to Rock!"
+
+  class_option :devise, type: :boolean,
+                        desc: "Include Devise support",
+                        default: true
+
+  class_option :postgres, type: :boolean,
+                          desc: "Include Postgres support",
+                          default: Rockstart::Env.postgres_db?
+
+  class_option :pundit, type: :boolean,
+                        desc: "Include Pundit support",
+                        default: true
+
+  def generate_logging
+    generate "rockstart:logging"
+  end
+
+  def generate_rspec
+    generate "rockstart:rspec"
+  end
+
+  def generate_postgres
+    return unless options[:postgres]
+
+    generate "rockstart:postgres"
+  end
+
+  def generate_smtp_mailer
+    generate "rockstart:smtp_mailer"
+  end
+
+  def generate_scaffold_templates
+    generate "rockstart:scaffold_templates", devise_option, pundit_option
+  end
+
+  def generate_devise
+    return unless options[:devise]
+
+    generate "rockstart:devise", pundit_option
+  end
+
+  def generate_pundit
+    return unless options[:pundit]
+
+    generate "rockstart:pundit"
+  end
+
+  def generate_security
+    generate "rockstart:security"
+  end
+
+  def generate_docker
+    generate "rockstart:docker", postgres_option, devise_option
+  end
+
+  def generate_quality
+    generate "rockstart:quality"
+  end
+
+  private
+
+  def devise_option
+    options[:devise] ? "--devise" : "--no-devise"
+  end
+
+  def postgres_option
+    options[:postgres] ? "--postgres" : "--no-postgres"
+  end
+
+  def pundit_option
+    options[:pundit] ? "--pundit" : "--no-pundit"
+  end
+end

data/lib/generators/rockstart/rspec/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Installs RSpec with test libraries
+
+Example:
+    rails generate rockstart:rspec
+
+    This will create:
+        - installs rspec-rails

data/lib/generators/rockstart/rspec/rspec_generator.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+class Rockstart::RspecGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  def add_gems
+    gem "dotenv-rails", groups: %i[development test]
+    gem "factory_bot_rails", group: %i[development test]
+    gem "faker", group: %i[development test]
+    gem "rspec-rails", "~> 4.0.0", group: %i[development test]
+    gem "shoulda-matchers", group: :test
+    gem "simplecov", group: :test
+  end
+
+  def install_rspec_rails
+    Bundler.with_clean_env do
+      run "bundle install --quiet"
+
+      Dir.mktmpdir do |dir|
+        generate_rspec_install(dir)
+        template File.join(dir, ".rspec"), ".rspec"
+        directory File.join(dir, "spec"), "spec"
+      end
+    end
+  end
+
+  def add_dotenv_files
+    copy_file "dotenv.development", ".env.development"
+    copy_file "dotenv.test", ".env.test"
+  end
+
+  def add_rspec_support
+    directory "support", "spec/support"
+  end
+
+  def add_coverage_to_gitignore
+    append_file ".gitignore", "coverage/\n"
+  end
+
+  private
+
+  def generate_rspec_install(dir)
+    require "generators/rspec/install/install_generator"
+
+    initializer = ::Rspec::Generators::InstallGenerator.new(
+      report_stream: StringIO.new
+    )
+    initializer.destination_root = dir
+    initializer.invoke_all
+
+    prepend_simplecov_start(dir)
+    enable_support_directory(dir)
+  end
+
+  def prepend_simplecov_start(dir)
+    prepend_file File.join(dir, "spec", "spec_helper.rb"), <<~SIMPLECOV
+      # frozen_string_literal: true
+
+      require "simplecov"
+      SimpleCov.start("rails") do
+        add_filter "/lib/templates"
+      end
+
+    SIMPLECOV
+  end
+
+  def enable_support_directory(dir)
+    uncomment_lines File.join(dir, "spec", "rails_helper.rb"), /Dir.+spec.+support.+\.rb/
+  end
+end

data/lib/generators/rockstart/rspec/templates/dotenv.development

@@ -0,0 +1 @@
+APP_HOST=www.example.com

data/lib/generators/rockstart/rspec/templates/dotenv.test

@@ -0,0 +1 @@
+APP_HOST=localhost:3000

data/lib/generators/rockstart/rspec/templates/rspec_templates/model/model_spec.rb

@@ -0,0 +1,13 @@
+require "rails_helper"
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>, <%= type_metatag(:model) %> do
+  <%- for attribute in attributes -%>
+  # <%= attribute.name %>:<%= attribute.type %>
+  it { is_expected.to have_db_column(:<%= attribute.name %>) }
+  <%- if %w(email name title).include?(attribute.name) -%>
+  it { is_expected.to validate_presence_of(:<%= attribute.name %>) }
+  <%- end -%>
+  <%- end -%>
+end
+<% end -%>

data/lib/generators/rockstart/rspec/templates/support/factory_bot.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  # Allow direct use of FactoryBot methods
+  config.include FactoryBot::Syntax::Methods
+end

data/lib/generators/rockstart/rspec/templates/support/shoulda_matchers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Configure shoulda-matchers
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end

data/lib/generators/rockstart/rspec/templates/support/test_helpers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  # Allow direct use of t() and l() in specs
+  config.include AbstractController::Translation
+
+  # Allow have_selector matcher in request specs
+  config.include Capybara::RSpecMatchers, type: :request
+end

data/lib/generators/rockstart/scaffold_templates/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Overrides the default rails scaffold templates with pre-configured defaults
+
+Example:
+    rails generate rockstart:scaffold_templates
+
+    This will create:
+        Overrides rails scaffold_controller generator templates

data/lib/generators/rockstart/scaffold_templates/scaffold_templates_generator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class Rockstart::ScaffoldTemplatesGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  class_option :devise, type: :boolean,
+                        desc: "Include Devise support",
+                        default: true
+
+  class_option :pundit, type: :boolean,
+                        desc: "Include Pundit support",
+                        default: true
+
+  def copy_scaffold_templates
+    template "api_controller.rb.tt", "lib/templates/rails/scaffold_controller/api_controller.rb.tt"
+    template "controller.rb.tt", "lib/templates/rails/scaffold_controller/controller.rb.tt"
+  end
+
+  def copy_rspec_scaffold_templates
+    copy_file "rspec/scaffold/api_request_spec.rb",
+              "#{rspec_templates_dir}/scaffold/api_request_spec.rb"
+    copy_file "rspec/scaffold/request_spec.rb",
+              "#{rspec_templates_dir}/scaffold/request_spec.rb"
+  end
+
+  private
+
+  def devise?
+    options[:devise]
+  end
+
+  def pundit?
+    options[:pundit]
+  end
+
+  def rspec_templates_dir
+    @rspec_templates_dir ||= "lib/templates/rspec"
+  end
+end

data/lib/generators/rockstart/scaffold_templates/templates/api_controller.rb.tt

@@ -0,0 +1,96 @@
+<%% if namespaced? -%>
+require_dependency "<%%= namespaced_path %>/application_controller"
+
+<%% end -%>
+<%% module_namespacing do -%>
+class <%%= controller_class_name %>Controller < ApplicationController
+<%- if devise? -%>
+  before_action :authenticate_user!
+<%- end -%>
+  before_action :assign_<%%= singular_table_name %>, only: [:show, :update, :destroy]
+<%- if pundit? -%>
+  after_action :verify_authorized
+  after_action :verify_policy_scoped, except: [:new, :create]
+<%- end -%>
+
+  # GET <%%= route_url %>
+  def index
+<%- if pundit? -%>
+    authorize <%%= class_name %>
+    @<%%= plural_table_name %> = policy_scope(<%%= class_name %>)
+<%- else -%>
+    @<%%= plural_table_name %> = <%%= orm_class.all(class_name) %>
+<%- end -%>
+
+    render json: <%%= "@#{plural_table_name}" %>
+  end
+
+  # GET <%%= route_url %>/1
+  def show
+<%- if pundit? -%>
+    authorize @<%%= singular_table_name %>
+
+<%- end -%>
+    render json: <%%= "@#{singular_table_name}" %>
+  end
+
+  # POST <%%= route_url %>
+  def create
+    @<%%= singular_table_name %> = <%%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+<%- if pundit? -%>
+    authorize @<%%= singular_table_name %>
+<%- end -%>
+
+    if @<%%= orm_instance.save %>
+      render json: <%%= "@#{singular_table_name}" %>, status: :created, location: <%%= "@#{singular_table_name}" %>
+    else
+      render json: <%%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity
+    end
+  end
+
+  # PATCH/PUT <%%= route_url %>/1
+  def update
+<%- if pundit? -%>
+    authorize @<%%= singular_table_name %>
+
+<%- end -%>
+    if @<%%= orm_instance.update("#{singular_table_name}_params") %>
+      render json: <%%= "@#{singular_table_name}" %>
+    else
+      render json: <%%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE <%%= route_url %>/1
+  def destroy
+<%- if pundit? -%>
+    authorize @<%%= singular_table_name %>
+
+<%- end -%>
+    @<%%= orm_instance.destroy %>
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def assign_<%%= singular_table_name %>
+<%- if pundit? -%>
+      @<%%= singular_table_name %> = <%%= orm_class.find("policy_scope(#{class_name})", "params[:id]") %>
+<%- else -%>
+      @<%%= singular_table_name %> = <%%= orm_class.find(class_name, "params[:id]") %>
+<%- end -%>
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def <%%= "#{singular_table_name}_params" %>
+<%- if pundit? -%>
+      permitted_attributes(@<%%= singular_table_name %> || <%%= class_name %>)
+<%- else -%>
+      <%%- if attributes_names.empty? -%>
+      params.fetch(:<%%= singular_table_name %>, {})
+      <%%- else -%>
+      params.require(:<%%= singular_table_name %>).permit(<%%= permitted_params %>)
+      <%%- end -%>
+<%- end -%>
+    end
+end
+<%% end -%>

data/lib/generators/rockstart/scaffold_templates/templates/controller.rb.tt

@@ -0,0 +1,126 @@
+<%% if namespaced? -%>
+require_dependency "<%%= namespaced_path %>/application_controller"
+
+<%% end -%>
+<%% module_namespacing do -%>
+class <%%= controller_class_name %>Controller < ApplicationController
+<%- if pundit? -%>
+  include PunditErrorHandling
+
+<%- end -%>
+<%- if devise? -%>
+  before_action :authenticate_user!
+<%- end -%>
+  before_action :assign_<%%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
+<%- if pundit? -%>
+  after_action :verify_authorized
+  after_action :verify_policy_scoped, except: [:new, :create]
+<%- end -%>
+
+  # GET <%%= route_url %>
+  def index
+<%- if pundit? -%>
+    authorize <%%= class_name %>
+    @<%%= plural_table_name %> = policy_scope(<%%= class_name %>)
+<%- else -%>
+    @<%%= plural_table_name %> = <%%= orm_class.all(class_name) %>
+<%- end -%>
+  end
+
+  # GET <%%= route_url %>/1
+  def show
+<%- if pundit? -%>
+    authorize @<%%= singular_table_name %>
+<%- end -%>
+  end
+
+  # GET <%%= route_url %>/new
+  def new
+    @<%%= singular_table_name %> = <%%= orm_class.build(class_name) %>
+<%- if pundit? -%>
+    authorize @<%%= singular_table_name %>
+<%- end -%>
+  end
+
+  # GET <%%= route_url %>/1/edit
+  def edit
+<%- if pundit? -%>
+    authorize @<%%= singular_table_name %>
+<%- end -%>
+  end
+
+  # POST <%%= route_url %>
+  def create
+    @<%%= singular_table_name %> = <%%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+<%- if pundit? -%>
+    authorize @<%%= singular_table_name %>
+<%- end -%>
+
+    if @<%%= orm_instance.save %>
+      redirect_to <%%= redirect_resource_name %>, notice: <%%= "'#{human_name} was successfully created.'" %>
+    else
+      render :new
+    end
+  end
+
+  # PATCH/PUT <%%= route_url %>/1
+  def update
+<%- if pundit? -%>
+    authorize @<%%= singular_table_name %>
+
+<%- end -%>
+    if @<%%= orm_instance.update("#{singular_table_name}_params") %>
+      redirect_to <%%= redirect_resource_name %>, notice: <%%= "'#{human_name} was successfully updated.'" %>
+    else
+      render :edit
+    end
+  end
+
+  # DELETE <%%= route_url %>/1
+  def destroy
+<%- if pundit? -%>
+    authorize @<%%= singular_table_name %>
+
+<%- end -%>
+    @<%%= orm_instance.destroy %>
+    redirect_to <%%= index_helper %>_url, notice: <%%= "'#{human_name} was successfully destroyed.'" %>
+  end
+
+<%- if pundit? -%>
+  protected
+
+  def authentication_failed_redirect_path_for(_resource)
+    if @<%%= singular_table_name %> && policy(@<%%= singular_table_name %>).show?
+      @<%%= singular_table_name %>
+    elsif policy(<%%= class_name %>).index?
+      <%%= index_helper %>_url
+    else
+      super
+    end
+  end
+
+<%- end -%>
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def assign_<%%= singular_table_name %>
+<%- if pundit? -%>
+      @<%%= singular_table_name %> = <%%= orm_class.find("policy_scope(#{class_name})", "params[:id]") %>
+<%- else -%>
+      @<%%= singular_table_name %> = <%%= orm_class.find(class_name, "params[:id]") %>
+<%- end -%>
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def <%%= "#{singular_table_name}_params" %>
+<%- if pundit? -%>
+      permitted_attributes(@<%%= singular_table_name %> || <%%= class_name %>)
+<%- else -%>
+      <%%- if attributes_names.empty? -%>
+      params.fetch(:<%%= singular_table_name %>, {})
+      <%%- else -%>
+      params.require(:<%%= singular_table_name %>).permit(<%%= permitted_params %>)
+      <%%- end -%>
+<%- end -%>
+    end
+end
+<%% end -%>

data/lib/generators/rockstart/scaffold_templates/templates/rspec/scaffold/api_request_spec.rb

@@ -0,0 +1,139 @@
+<%- resource_path = name.underscore.pluralize -%>
+<%- permitted_params = attributes.map { |a| ":#{a.name}" }.join(", ") -%>
+# frozen_string_literal: true
+
+require "rails_helper"
+
+<% module_namespacing do -%>
+RSpec.describe "/<%= controller_class_name %>", <%= type_metatag(:request) %> do
+  # This should return the minimal set of values that should be in the headers
+  # in order to pass any filters (e.g. authentication) defined in
+  # <%= controller_class_name %>Controller, or in your router and rack
+  # middleware. Be sure to keep this updated too.
+  let(:valid_headers) do
+    {}
+  end
+
+<% unless options[:singleton] -%>
+  describe "GET /<%= resource_path %>" do
+    it "renders a successful response" do
+      create(:<%= file_name %>)
+      get <%= index_helper %>_url, headers: valid_headers, as: :json
+      expect(response).to be_successful
+    end
+  end
+<% end -%>
+
+  describe "GET /<%= resource_path %>/:id" do
+    it "renders a successful response" do
+      <%= file_name %> = create(:<%= file_name %>)
+      get <%= show_helper.tr('@', '') %>, as: :json
+      expect(response).to be_successful
+    end
+  end
+
+  describe "POST /<%= resource_path %>" do
+    context "with valid parameters" do
+      let(:valid_attributes) do
+        <%- if attributes.any? -%>
+        attributes_for(:<%= ns_file_name %>).slice(<%= permitted_params %>)
+        <%- else -%>
+        skip("Add a hash of attributes valid for your model")
+        <%- end -%>
+      end
+
+      it "creates a new <%= class_name %>" do
+        expect do
+          post <%= index_helper %>_url,
+               params: { <%= ns_file_name %>: valid_attributes }, headers: valid_headers, as: :json
+        end.to change(<%= class_name %>, :count).by(1)
+      end
+
+      it "renders a JSON response with the new <%= ns_file_name %>" do
+        post <%= index_helper %>_url,
+             params: { <%= ns_file_name %>: valid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:created)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+
+    context "with invalid parameters" do
+      let(:invalid_attributes) do
+        skip("Add a hash of attributes invalid for your model")
+      end
+
+      it "does not create a new <%= class_name %>" do
+        expect do
+          post <%= index_helper %>_url,
+               params: { <%= ns_file_name %>: invalid_attributes }, as: :json
+        end.to change(<%= class_name %>, :count).by(0)
+      end
+
+      it "renders a JSON response with errors for the new <%= ns_file_name %>" do
+        post <%= index_helper %>_url,
+             params: { <%= ns_file_name %>: invalid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.content_type).to eq("application/json")
+      end
+    end
+  end
+
+  describe "PATCH /<%= resource_path %>/:id" do
+    context "with valid parameters" do
+      let(:new_attributes) do
+        <%- if attributes.any? -%>
+        attributes_for(:<%= ns_file_name %>).slice(<%= permitted_params %>)
+        <%- else -%>
+        skip("Add a hash of attributes valid for your model")
+        <%- end -%>
+      end
+
+      it "updates the requested <%= ns_file_name %>" do
+        <%= file_name %> = create(:<%= file_name %>)
+        patch <%= show_helper.tr('@', '') %>,
+              params: { <%= singular_table_name %>: invalid_attributes }, headers: valid_headers, as: :json
+
+        <%= file_name %>.reload
+        <%- if attributes.any? -%>
+        <%- attributes.each do |attribute| -%>
+        expect(<%= file_name %>.<%= attribute.name %>).to eq(new_attributes[:<%= attribute.name %>])
+        <%- end -%>
+        <%- else -%>
+        skip("Add assertions for updated state")
+        <%- end -%>
+      end
+
+      it "renders a JSON response with the <%= ns_file_name %>" do
+        <%= file_name %> = create(:<%= file_name %>)
+        patch <%= show_helper.tr('@', '') %>,
+              params: { <%= singular_table_name %>: invalid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:ok)
+        expect(response.content_type).to eq("application/json")
+      end
+    end
+
+    context "with invalid parameters" do
+      let(:invalid_attributes) do
+        skip("Add a hash of attributes invalid for your model")
+      end
+
+      it "renders a JSON response with errors for the <%= ns_file_name %>" do
+        <%= file_name %> = create(:<%= file_name %>)
+        patch <%= show_helper.tr('@', '') %>,
+              params: { <%= singular_table_name %>: invalid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.content_type).to eq("application/json")
+      end
+    end
+  end
+
+  describe "DELETE /<%= resource_path %>/:id" do
+    it "destroys the requested <%= ns_file_name %>" do
+      <%= file_name %> = create(:<%= file_name %>)
+      expect do
+        delete <%= show_helper.tr('@', '') %>, headers: valid_headers, as: :json
+      end.to change(<%= class_name %>, :count).by(-1)
+    end
+  end
+end
+<% end -%>