cybele 1.9.2 → 2.0.0

data/lib/cybele/helpers.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    private
+
+    # Change relative_path file content
+    # @param [String] relative_path
+    # @param [String] find
+    # @param [String] replace
+    # Example:
+    # replace_in_file 'app/controllers/application_controller.rb',
+    #                 'respond_to :html',
+    #                 'respond_to :html, :js, :json'
+    def replace_in_file(relative_path, find, replace)
+      path = File.join(destination_root, relative_path)
+      contents = IO.read(path)
+      raise "#{find.inspect} not found in #{relative_path}" unless contents.gsub!(find, replace)
+      File.open(path, 'w') { |file| file.write(contents) }
+    end
+
+    # Read template file content
+    # @param [String] template_file
+    # Example:
+    # template_content('error_pages/error_method.erb')
+    def template_content(template_file)
+      File.read(File.expand_path(find_in_source_paths(template_file)))
+    end
+
+    # Change <%= app_name %> string with app_name
+    # @param [Array] files
+    # Example:
+    # configure_app_name(%w[config/settings.yml])
+    def configure_app_name(files)
+      files.each do |file|
+        gsub_file file, /<%= app_name %>/, app_name
+      end
+    end
+
+    # Add template content to app_file
+    # @param [String] app_file
+    # @param [String] template_file
+    # Example:
+    # append_template_to_file('env.sample', 'basic_authentication/no_basic_authentication.erb')
+    def append_template_to_file(app_file, template_file)
+      append_file(app_file, template_content(template_file))
+    end
+
+    # Add template content to multiple app_files
+    # @param [Hash] files
+    # { app_file => template_file }
+    # Example:
+    # append_template_to_files('config/settings.yml' => 'paperclip/paperclip_settings.yml.erb')
+    def append_template_to_files(files)
+      files.each do |app_file, template_file|
+        append_file(app_file, template_content(template_file))
+      end
+    end
+
+    # Remove app files
+    # @param [Array] app_files
+    # %w[app_file]
+    # Example:
+    # remove_files(%w[app/views/welcome/index.html.erb])
+    def remove_files(app_files)
+      app_files.each do |app_file|
+        remove_file app_file, force: true
+      end
+    end
+
+    # Create app file from templates
+    # @param [Hash] files
+    # { template_file => app_file }
+    # Example:
+    # files_to_template('dotenv/env.sample.erb' => 'env.sample')
+    def files_to_template(files)
+      files.each do |template_file, app_file|
+        template template_file, app_file, force: true
+      end
+    end
+
+    # Copy template file to app directory
+    # @param [Hash] files
+    # { template_file => app_file }
+    # Example:
+    # copy_file 'config/locales/tr.yml', 'config/locales/tr.yml'
+    def copy_files(files)
+      files.each do |template_file, app_file|
+        copy_file template_file, app_file
+      end
+    end
+
+    # Copy directory to app directory
+    # @param [Hash] dirs
+    # { template_dir => app_dir }
+    # Example:
+    # dirs_to_directory('app_files/app/views/hq' => 'app/views/hq')
+    def dirs_to_directory(dirs)
+      dirs.each do |template_dir, app_dir|
+        directory template_dir, app_dir
+      end
+    end
+  end
+end

data/lib/cybele/helpers/app_files/assets_files.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    module AppFiles
+      module AssetsFiles
+        def customize_assets_files
+          javascript_files
+          stylesheet_files
+        end
+
+        def javascript_files
+          # Javascript Assets files
+          remove_file 'app/assets/javascripts/application.js', force: true
+
+          template 'app_files/app/assets/javascripts/application.js',
+                   'app/assets/javascripts/application.js',
+                   force: true
+
+          template 'app_files/app/assets/javascripts/hq/application.js',
+                   'app/assets/javascripts/hq/application.js',
+                   force: true
+        end
+
+        def stylesheet_files
+          # Css Assets files
+          remove_file 'app/assets/stylesheets/application.css', force: true
+
+          template 'app_files/app/assets/stylesheets/application.sass',
+                   'app/assets/stylesheets/application.sass',
+                   force: true
+
+          template 'app_files/app/assets/stylesheets/hq/application.sass',
+                   'app/assets/stylesheets/hq/application.sass',
+                   force: true
+
+          copy_file 'app_files/app/assets/stylesheets/hq/_sidebar.sass',
+                    'app/assets/stylesheets/hq/_sidebar.sass'
+        end
+      end
+    end
+  end
+end

data/lib/cybele/helpers/app_files/controller_files.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    module AppFiles
+      module ControllerFiles
+        def customize_controller_files
+          # Controller concern files
+          directory 'app_files/app/controllers/concerns', 'app/controllers/concerns'
+
+          # Hq controller files
+          directory 'app_files/app/controllers/hq', 'app/controllers/hq'
+
+          # User controller files
+          directory 'app_files/app/controllers/user', 'app/controllers/user'
+
+          # Welcome controller
+          copy_file 'app_files/app/controllers/welcome_controller.rb', 'app/controllers/welcome_controller.rb'
+        end
+      end
+    end
+  end
+end

data/lib/cybele/helpers/app_files/helper_files.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    module AppFiles
+      module HelperFiles
+        def customize_helper_files
+          # Helper files
+          remove_file 'app/helpers/application_helper.rb', force: true
+          template 'app_files/app/helpers/application_helper.rb.erb', 'app/helpers/application_helper.rb'
+        end
+      end
+    end
+  end
+end

data/lib/cybele/helpers/app_files/mailer_files.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    module AppFiles
+      module MailerFiles
+        def customize_mailer_files
+          # Model files
+          remove_file 'app/mailers/application_mailer.rb', force: true
+          directory 'app_files/app/mailers', 'app/mailers'
+        end
+      end
+    end
+  end
+end

data/lib/cybele/helpers/app_files/model_files.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    module AppFiles
+      module ModelFiles
+        def customize_model_files
+          # Model files
+          remove_file 'app/models/admin.rb', force: true
+          remove_file 'app/models/user.rb', force: true
+          directory 'app_files/app/models', 'app/models'
+        end
+      end
+    end
+  end
+end

data/lib/cybele/helpers/app_files/vendor_files.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    module AppFiles
+      module VendorFiles
+        def customize_vendor_files
+          # javascript and stylesheet files in vendor
+          directory 'app_files/app/vendor/assets', 'vendor/assets'
+        end
+      end
+    end
+  end
+end

data/lib/cybele/helpers/app_files/view_files.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    module AppFiles
+      module ViewFiles
+        def customize_view_files_with_option
+          # View files with option
+          dirs_to_directory(
+            'app_files/app/views/hq' => 'app/views/hq',
+            'app_files/app/views/user' => 'app/views/user',
+            'app_files/app/views/layouts/hq' => 'app/views/layouts/hq',
+            'app_files/app/views/layouts/partials' => 'app/views/layouts/partials',
+            'app_files/app/views/welcome' => 'app/views/welcome',
+            'app_files/public' => 'public'
+          )
+          replace_erb_with_haml
+        end
+
+        def customize_default_view_files
+          # Default view files
+          dirs_to_directory(
+            'app_files/app/views/admin_mailer' => 'app/views/admin_mailer',
+            'app_files/app/views/user_mailer' => 'app/views/user_mailer'
+          )
+        end
+
+        private
+
+        def remove_erb_files(template_files)
+          remove_file 'app/views/layouts/mailer.html.erb',
+                      force: true
+          remove_files(template_files)
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/LineLength
+        def replace_erb_with_haml
+          template_files = %w[
+            app/views/welcome/index.html.haml.erb
+            app/views/layouts/mailer.html.haml.erb
+            app/views/layouts/application.html.haml.erb
+            app/views/layouts/partials/_navbar.html.haml.erb
+            app/views/layouts/hq/application.html.haml.erb
+            app/views/layouts/hq/login.html.haml.erb
+          ]
+          remove_erb_files(template_files)
+          files_to_template(
+            'app_files/app/views/welcome/index.html.haml.erb' => 'app/views/welcome/index.html.haml',
+            'app_files/app/views/layouts/mailer.html.haml.erb' => 'app/views/layouts/mailer.html.haml',
+            'app_files/app/views/layouts/application.html.haml.erb' => 'app/views/layouts/application.html.haml',
+            'app_files/app/views/layouts/partials/_navbar.html.haml.erb' => 'app/views/layouts/partials/_navbar.html.haml',
+            'app_files/app/views/layouts/hq/application.html.haml.erb' => 'app/views/layouts/hq/application.html.haml',
+            'app_files/app/views/layouts/hq/login.html.haml.erb' => 'app/views/layouts/hq/login.html.haml'
+          )
+        end
+        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/LineLength
+      end
+    end
+  end
+end

data/lib/cybele/helpers/app_files/view_gems.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    module AppFiles
+      module ViewGems
+        def add_required_view_gems
+          files = %w[
+            app_files/bootstrap_Gemfile.erb
+            app_files/breadcrumb_Gemfile.erb
+            app_files/jquery_Gemfile.erb
+          ]
+          files.each do |file|
+            append_template_to_file('Gemfile', file)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cybele/helpers/audited.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    module Audited
+      def configure_audited
+        # Generate Audited
+        generate 'audited:install'
+      end
+    end
+  end
+end

data/lib/cybele/helpers/basic_authentication.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    module BasicAuthentication
+      def configure_basic_authentication
+        create_basic_authentication_files
+        add_to_settings_yml
+        add_to_dotenv_files
+        include_basic_authentication_module
+        configure_app_name(['config/settings.yml'])
+      end
+
+      private
+
+      def create_basic_authentication_files
+        # Concern file
+        template 'basic_authentication/basic_authentication.rb',
+                 'app/controllers/concerns/basic_authentication.rb',
+                 force: true
+      end
+
+      def add_to_settings_yml
+        # Add basic authentication settings to the config/settings.yml file
+        append_template_to_file 'config/settings.yml',
+                                'basic_authentication/basic_authentication_settings.yml.erb'
+      end
+
+      def add_to_dotenv_files
+        # Add basic authentication env to the all env files
+        append_template_to_file('.env.sample', 'basic_authentication/no_basic_authentication.erb')
+        append_template_to_file('.env.local', 'basic_authentication/no_basic_authentication.erb')
+        append_template_to_file('.env.staging', 'basic_authentication/yes_basic_authentication.erb')
+        append_template_to_file('.env.production', 'basic_authentication/no_basic_authentication.erb')
+      end
+
+      def include_basic_authentication_module
+        inject_into_file 'app/controllers/application_controller.rb',
+                         template_content('basic_authentication/include_module.erb'),
+                         after: 'class ApplicationController < ActionController::Base'
+      end
+    end
+  end
+end

data/lib/cybele/helpers/devise.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Cybele
+  module Helpers
+    module Devise
+      def generate_devise_settings
+        generate 'devise:install'
+        gsub_file 'config/initializers/filter_parameter_logging.rb', /:password/,
+                  ':password, :password_confirmation'
+        gsub_file 'config/initializers/devise.rb',
+                  /please-change-me-at-config-initializers-devise@example.com/, "no-reply@#{app_name}.com"
+        inject_into_file 'config/initializers/devise.rb', after: "# config.mailer = 'Devise::Mailer'\n" do
+          template_content('devise/devise_mailer.rb.erb')
+        end
+      end
+
+      def generate_devise_models
+        generate 'devise User name:string surname:string is_active:boolean time_zone:string'
+        generate 'devise Admin name:string surname:string is_active:boolean time_zone:string'
+        configure_devise_locale_files
+        devise_seeds
+        configure_app_name(%w[db/seeds.rb])
+        add_default_value_to_migrations
+      end
+
+      def generate_devise_views
+        directory 'devise/devise_views', 'app/views/devise'
+      end
+
+      def add_devise_authenticate_admin
+        inject_into_file 'app/controllers/hq/application_controller.rb',
+                         template_content('devise/devise_authenticate_admin.rb.erb'),
+                         after: 'class Hq::ApplicationController < ApplicationController'
+      end
+
+      def add_devise_strong_parameter
+        inject_into_file 'app/controllers/application_controller.rb',
+                         template_content('devise/devise_strong_parameter.rb.erb'),
+                         after: 'protect_from_forgery with: :exception'
+
+        inject_into_file 'app/controllers/application_controller.rb',
+                         template_content('devise/devise_before_action_strong_parameter.rb.erb'),
+                         after: 'class ApplicationController < ActionController::Base'
+      end
+
+      private
+
+      def configure_devise_locale_files
+        remove_file 'config/locales/devise.en.yml', force: true
+        copy_file 'config/locales/devise.en.yml', 'config/locales/devise.en.yml'
+        copy_file 'config/locales/devise.tr.yml', 'config/locales/devise.tr.yml'
+      end
+
+      def devise_seeds
+        inject_into_file 'db/seeds.rb', after: "#   Character.create(name: 'Luke', movie: movies.first)\n" do
+          template_content('devise/seeds.rb.erb')
+        end
+      end
+
+      def add_default_value_to_migrations
+        Dir.glob('db/migrate/*devise_create*.rb') do |file|
+          replace_in_file file, 't.boolean :is_active', 't.boolean :is_active, default: true'
+        end
+      end
+    end
+  end
+end