myrails 6.0.0 → 7.0.0

data/lib/myrails/modules/assets.rb

@@ -2,15 +2,41 @@ module Install
   module Assets
     def self.included(thor)
       thor.class_eval do
-
-        def install_assets
+        
+        desc 'remove_css_manifest', 'delete application.css stylesheet'
+        def remove_css_manifest
           run "rm app/assets/stylesheets/application.css"
+        end
+        
+        desc 'generate_sass_manifest', 'create applicatin.css.sass manifest'
+        def generate_sass_manifest
           copy_file 'rails/app/assets/stylesheets/application.css.sass', 'app/assets/stylesheets/application.css.sass'
+        end
+        
+        desc 'generate_js_manifest', 'create application.js manifest'
+        def generate_js_manifest
           copy_file 'rails/app/assets/javascripts/application.js', 'app/assets/javascripts/application.js'
+        end
+        
+        desc 'generate_animate_css', 'create animate.css file'
+        def generate_animate_css
           copy_file 'rails/app/assets/stylesheets/animate.scss', 'app/assets/stylesheets/animate.scss'
+        end
+        
+        desc 'generate_will_paginate', 'create will paginate css'
+        def generate_will_paginate
           copy_file 'rails/app/assets/stylesheets/will_paginate.scss', 'app/assets/stylesheets/will_paginate.scss'
         end
         
+        desc 'setup_assets', 'install CSS librarys and configure CSS & JS manifests'
+        def setup_assets
+          remove_css_manifest
+          generate_sass_manifest
+          generate_js_manifest
+          generate_animate_css
+          generate_will_paginate
+        end
+        
       end
     end
   end

data/lib/myrails/modules/bootstrap.rb

@@ -1,16 +1,19 @@
 module Layout
   module Bootstrap
+    
     def self.included(thor)
       thor.class_eval do
+        
+        desc 'choose_bootstrap_theme', 'Select a bootswatch.com bootstrap theme'
         def choose_bootstrap_theme
-          themes = Dir[File.join(@templates, 'rails', 'app','assets', 'stylesheets', 'bootstrap', 'bootstrap_themes', '*')]
+          themes = Dir[File.join("#{__dir__}", '..', 'templates', 'rails', 'app','assets', 'stylesheets', 'bootstrap', 'bootstrap_themes', '*')]
 
           themes.each_with_index do |theme, index|
             say "[#{index}] #{File.basename(theme,'.*')}"
           end
 
-          idx = ask("Choose a color theme (by number) for the application. Default: 'spacelab'")
-          idx = idx.empty? ? themes.index{|theme| theme if theme.include?('spacelab')} : idx.to_i
+          idx = ask "Choose a color theme (by number) for the application. Default: ", :yellow, 
+          default: themes.index{|theme| theme if theme.include?('spacelab')}
 
           copy_file(themes[idx], "app/assets/stylesheets/#{File.basename(themes[idx])}")
 
@@ -20,16 +23,17 @@ module Layout
           end
         end
 
+        desc 'choose_bootstrap_footer', 'Select a bootstrap footer template'
         def choose_bootstrap_footer
-          footers = Dir[File.join(@templates, 'rails', 'app', 'views','layout', 'bootstrap', 'footers', '*.haml')]
-          footers_css = Dir[File.join(@templates, 'rails', 'app', 'views', 'layout', 'bootstrap', 'footers', 'css', '*')]
+          footers = Dir[File.join("#{__dir__}", '..', 'templates', 'rails', 'app', 'views','layout', 'bootstrap', 'footers', '*.haml')]
+          footers_css = Dir[File.join("#{__dir__}", '..', 'templates', 'rails', 'app', 'views', 'layout', 'bootstrap', 'footers', 'css', '*')]
 
           footers.each_with_index do |footer, index|
             say "[#{index}] #{File.basename(footer,'.html.*')}"
           end
 
-          idx = ask("Chose a footer theme (by number) for the application. Deault: 'footer-distributed (Basic)'")
-          idx = idx.empty? ? footers.index{|footer| footer if footer.include?('footer-distributed.html.haml')} : idx.to_i
+          idx = ask "Chose a footer theme (by number) for the application. Deault: ", :yellow, default: footers.index{|footer| footer if footer.include?('footer-distributed.html.haml')}
+
           copy_file footers[idx], "app/views/layouts/_footer.html.haml"
           copy_file footers_css[idx], "app/assets/stylesheets/#{File.basename(footers_css[idx])}"
 
@@ -38,19 +42,18 @@ module Layout
     CODE
           end
         end
-
+        
+        desc 'copy_bootstrap_files', 'generate layout navigation and flash messages'
         def copy_bootstrap_files
           template 'rails/app/views/layout/bootstrap/application.html.haml', 'app/views/layouts/application.html.haml'
           template 'rails/app/views/layout/bootstrap/_nav.html.haml', 'app/views/layouts/_nav.html.haml'
           copy_file 'rails/app/views/layout/bootstrap/_info_messages.html.haml', 'app/views/layouts/_info_messages.html.haml'
           copy_file 'rails/app/views/layout/bootstrap/_success_message.html.haml', 'app/views/layouts/_success_message.html.haml'
           copy_file 'rails/app/views/layout/bootstrap/_error_messages.html.haml', 'app/views/layouts/_error_messages.html.haml'
-          # copy_file 'rails/app/views/layout/bootstrap/_footer.html.haml', 'app/views/layouts/_footer.html.haml'
         end
 
-        desc 'install_bootstrap', 'Generate Bootrap css theme'
-        def install_bootstrap
-          @templates = "#{__dir__}/../templates"
+        desc 'setup_bootstrap', 'Generate layout using Bootrap CSS Framework'
+        def setup_bootstrap
 
           insert_into_file 'Gemfile', after: "gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]\n" do <<-CODE
 gem 'bootstrap-sass', '~> 3.3.1'
@@ -68,6 +71,7 @@ CODE
   //= require bootstrap-sprockets
   CODE
           end
+          
           run 'bundle install'
           choose_bootstrap_theme
           choose_bootstrap_footer

data/lib/myrails/modules/capistrano.rb

@@ -2,7 +2,8 @@ module Install
   module Capistrano
     def self.included(thor)
       thor.class_eval do
-
+        
+        desc 'add_capistrano_gems', 'Add campistrano to Gemfile and install'
         def add_capistrano_gems
           insert_into_file 'Gemfile', after: "group :development do\n" do <<-CODE
   gem 'capistrano', '~> 3.6', group: :development
@@ -13,7 +14,8 @@ CODE
 
           run 'bundle install'
         end
-
+        
+        desc 'configure_capfile', 'Add required libraries to capistrano capfile'
         def configure_capfile
           gsub_file 'Capfile', '# require "capistrano/rvm"', 'require "capistrano/rvm"'
 
@@ -23,6 +25,7 @@ CODE
           end
         end
 
+        desc 'configure_deploy', 'Add default options to capistrano deploy file'
         def configure_deploy
           gsub_file 'config/deploy.rb', '# ask :branch, `git rev-parse --abbrev-ref HEAD`.chomp', 'ask :branch, `git rev-parse --abbrev-ref HEAD`.chomp'
           gsub_file 'config/deploy.rb', '# set :deploy_to, "/var/www/my_app_name"', 'set :deploy_to, "/var/www/#{fetch(:application)}"'
@@ -35,14 +38,14 @@ set :ssh_options, {forward_agent: true}
           end
         end
 
+        desc 'copy_templates', 'Add capistrano templates used to manage the remote server'
         def copy_templates
-          puts __dir__
-          Dir["#{__dir__}/../templates/capistrano/**/*"].each do |file|
-            puts file
+          Dir[File.join("#{__dir__}", "..", "templates","capistrano","**","*")].each do |file|
             copy_file file, "#{file.gsub(__dir__+'/../templates/capistrano/', '')}" unless File.directory? file
           end
         end
 
+        desc 'configure_env_files', 'Configure capistrano environemnt specific information'
         def configure_env_files
           insert_into_file 'config/deploy/production.rb', before: "# role-based syntax" do <<-CODE
 set :fqdn,'domain.com'
@@ -55,6 +58,7 @@ set :fqdn,'domain.com'
           end
         end
 
+        desc 'add_tasks', 'Add custom deploy tasks to capistrano deploy file'
         def add_tasks
           insert_into_file 'config/deploy.rb', after: "# set :ssh_options, verify_host_key: :secure\n" do <<-CODE
   namespace :deploy do
@@ -94,7 +98,8 @@ set :fqdn,'domain.com'
             end
         end
 
-        def install_capistrano
+        desc 'setup_capistrano', 'Run all capistrano setup actions in order'
+        def setup_capistrano
           add_capistrano_gems
           run 'bundle exec cap install'
           configure_capfile

data/lib/myrails/modules/database_generator.rb

@@ -0,0 +1,33 @@
+module Database
+  module Generators
+    def self.included(thor)
+      thor.class_eval do
+        
+        desc 'db <OPTION>', 'Execute without options to see HELP.'
+        def db(*opts)
+          item = opts[0]
+                  
+          option = {
+            mysql_switch: 'Switch DB from SQLITE3 to MySQL'
+          }
+          
+          unless item
+            say 'ERROR: "myrails db" was called with no arguments'
+            say 'Usage: "myrails db <OPTION> <NAME>"'
+            say "Available Options:\n"
+            option.each{|k,v| say "* #{k}: #{v}"}
+            exit
+          end
+          
+          case item
+          when 'mysql_switch'
+            mysql_switch
+          else
+            say "Unknown Action!"
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/myrails/modules/database_generator_actions.rb

@@ -0,0 +1,18 @@
+module Database
+  module Generator
+    module Actions
+      def self.included(thor)
+        thor.class_eval do
+          
+          desc 'mysql_switch', 'Convert a rails database configuration from sqlite3 to mysql2'
+          def mysql_switch
+            gsub_file 'Gemfile', "gem 'sqlite3'", "gem 'mysql2'"
+            run 'bundle install'
+            copy_file 'db/mysql_database.yml', 'config/database.yml'
+          end
+          
+        end
+      end
+    end
+  end
+end

data/lib/myrails/modules/devise.rb

@@ -3,6 +3,7 @@ module Install
     def self.included(thor)
       thor.class_eval do
 
+        desc 'add_gem', 'Add devise to Gemfile and run bundler'
         def add_gem
           insert_into_file 'Gemfile', after: "gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]\n" do <<-CODE
   gem 'devise'
@@ -11,13 +12,15 @@ CODE
           run 'bundle update'
         end
 
+        desc 'add_rspec_config', 'Add RSpec support file for feature and controller tests'
         def add_rspec_config
           copy_file 'spec/support/configs/devise.rb', 'spec/support/configs/devise.rb'
         end
 
+        desc 'configure_devise', 'Genreate devise with a given model name'
         def configure_devise
-          @devise_model = ask("What would you like to call the devise model? Default: user")
-          @devise_model = @devise_model.empty? ? 'user' : @devise_model
+          @devise_model = ask "What would you like to call the devise model? Default: ", :yellow, default: 'user'
+          # @devise_model = @devise_model.empty? ? 'user' : @devise_model
           run 'rails generate devise:install'
           run 'rake db:migrate'
           run "rails generate devise #{@devise_model}"
@@ -32,6 +35,7 @@ CODE
           add_additional_fields
         end
 
+        desc 'configure_ui_controller', 'Add code to not prompt for a login if there is a ui_controller'
         def configure_ui_controller
           if File.exist?('app/controllers/ui_controller.rb')
             inject_into_file 'app/controllers/ui_controller.rb', after: "class UiController < ApplicationController\n" do <<-CODE
@@ -41,8 +45,9 @@ CODE
           end
         end
 
+        desc 'add_additional_fields', 'Ask if you want to include additional devise fields like first_name & last_name'
         def add_additional_fields
-          if yes?('Will you be needing registration params override? Answer "yes" if you will be adding attributes to the user model')
+          if yes? "Will you be needing registration params override? Explicitly answer 'yes' / 'no' if you will be adding attributes to your #{@devise_model} model", :yellow
             inject_into_file 'app/controllers/application_controller.rb',  after: "before_action :authenticate_#{@devise_model}!\n" do <<-CODE
     # Before action include additional registration params
     # (see #configure_permitted_parameters)
@@ -59,8 +64,9 @@ CODE
             end
           end
         end
-
-        def install_devise
+        
+        desc 'setup_devise', 'Run devise setup actions in order'
+        def setup_devise
           add_gem
           add_rspec_config
           configure_devise

data/lib/myrails/modules/dotenv.rb

@@ -2,25 +2,49 @@ module Install
   module DotEnv
     def self.included(thor)
       thor.class_eval do
-
-        desc 'install_dotenv', 'Install dotenv gem'
-        def install_dotenv
+        
+        desc 'add_dotenv_gem', 'Add dotenv gem to Gemfile and run bundler'
+        def add_dotenv_gem
           insert_into_file 'Gemfile', after: "gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]\n" do <<-CODE
-  gem 'dotenv-rails', groups: [:development, :test]
-  CODE
+gem 'dotenv-rails', groups: [:development, :test]
+CODE
           end
 
           run 'bundle install'
-
+        end
+        
+        desc 'require_dotenv', 'Add dotenv to config.ru'
+        def require_dotenv
           inject_into_file 'config.ru', after: "require_relative 'config/environment'\n" do <<-CODE
   require 'dotenv'
   Dotenv.load
   CODE
           end
+        end
+        
+        desc 'create_dev_dotenv', 'Generate deveopment env file'
+        def create_dev_dotenv
           copy_file 'rails/env.config', '.env.development'
+        end
+        
+        desc 'create_test_dotenv', 'Generate test env file'
+        def create_test_dotenv
           copy_file 'rails/env.config', '.env.test'
+        end
+        
+        desc 'create_prod_dotenv', 'Generate production env file'
+        def create_prod_dotenv
           run 'touch .env.production'
         end
+        
+        desc 'setup_dotenv', 'Install dotenv gem'
+        def setup_dotenv
+          add_dotenv_gem
+          require_dotenv
+          create_dev_dotenv
+          create_test_dotenv
+          create_prod_dotenv
+        end
 
       end
     end

data/lib/myrails/modules/draper.rb

@@ -0,0 +1,29 @@
+module Install
+  module Draper
+    def self.included(thor)
+      thor.class_eval do
+        
+        desc 'add_draper_gem', 'Add draper gem to Gemfile and run bundler'
+        def add_draper_gem
+          insert_into_file 'Gemfile', after: "gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]\n" do <<-CODE
+gem 'draper'
+CODE
+          end
+        
+          run 'bundle install'
+        end
+        
+        desc 'create_draper_application_decorator', 'Generate draper application decorator'
+        def create_draper_application_decorator
+          copy_file 'rails/app/decorators/application_decorator.rb', 'app/decorators/application_decorator.rb'
+        end
+        
+        desc 'setup_draper', 'Install draper gem'
+        def setup_draper
+          add_draper_gem
+          create_draper_application_decorator
+        end
+      end
+    end
+  end
+end

data/lib/myrails/modules/engine_generator_actions.rb

@@ -0,0 +1,117 @@
+module Engine
+  module Generator
+    module Actions
+      def self.included(thor)
+        thor.class_eval do
+
+          desc 'new_engine', 'Generate a full or mountable engine. default: mountable'
+          def new_engine
+            type = ask 'Type (mountable or full)? Default: ', :yellow, default: 'mountable'
+            run "rails plugin new #{@name} --dummy-path=spec/dummy --skip-test-unit --#{type}"
+          end
+        
+          desc 'gemspec_setup', 'Generate gemspec info for a rails engine'
+          def gemspec_setup
+            @email = ask 'What email address would you like to use for this rails engine?:', :yellow
+            @author = ask 'Who is the author of this rails engine?', :yellow
+            
+            gsub_file "#{@name}.gemspec", "s.authors     = [\"TODO: Your name\"]", "s.authors     = [\"#{@author}\"]"
+            gsub_file "#{@name}.gemspec", "s.email       = [\"TODO: Your email\"]", "s.email       = [\"#{@email}\"]"
+            gsub_file "#{@name}.gemspec", 's.homepage    = "TODO"', 's.homepage    = "http://TBD.com"'
+            gsub_file "#{@name}.gemspec", "s.summary     = \"TODO: Summary of #{@name.camelize}.\"", "s.summary     = \"Summary of #{@name.camelize}.\""
+            gsub_file "#{@name}.gemspec", "s.description = \"TODO: Description of #{@name.camelize}.\"", "s.description = \"Description of #{@name.camelize}.\""
+
+            inject_into_file "#{@name}.gemspec", after: "s.license     = \"MIT\"\n" do <<-CODE
+  s.test_files = Dir["spec/**/*"]
+CODE
+            end
+            
+            gem_setup
+          end
+
+          desc 'gem_setup', 'Generate gem dependencies for a rails engine'
+          def gem_setup
+            inject_into_file "#{@name}.gemspec", after: "s.add_development_dependency \"sqlite3\"\n" do <<-CODE
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'factory_bot_rails'
+  s.add_development_dependency  "faker"
+  s.add_development_dependency  "byebug"
+  s.add_development_dependency  'rails-controller-testing'
+  s.add_development_dependency  'pundit-matchers'
+  s.add_development_dependency  "simplecov"
+  s.add_development_dependency  "shoulda-matchers"
+  s.add_development_dependency  "database_cleaner"
+  s.add_dependency 'pundit'
+  s.add_dependency 'bootstrap-sass'
+  s.add_dependency 'autoprefixer-rails'
+  s.add_dependency "haml-rails"
+  s.add_dependency "font-awesome-rails"
+  s.add_dependency 'record_tag_helper'
+CODE
+            end
+
+            run 'bundle'
+          end
+
+          desc 'rake_setup', 'Generate custom rake file for rails engine'
+          def rake_setup
+            run 'cp Rakefile Rakefile.bak'
+            copy_file 'engines/rakefile', 'Rakefile'
+          end
+
+          desc 'rspec_setup', 'Install and configure rspec for a rails engine'
+          def rspec_setup
+            run 'rails g rspec:install'
+
+            gsub_file 'spec/rails_helper.rb', "# Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }", "Dir[File.join(__dir__, 'support', '**', '*.rb')].each { |f| require f }"
+
+            gsub_file 'spec/rails_helper.rb', "require File.expand_path('../../config/environment', __FILE__)", "require_relative 'dummy/config/environment'"
+
+            inject_into_file 'spec/rails_helper.rb', after: "require 'rspec/rails'\n" do <<-CODE
+    require 'shoulda/matchers'
+    require 'factory_bot'
+    require 'database_cleaner'
+              CODE
+            end
+
+            inject_into_file 'spec/rails_helper.rb', after: "RSpec.configure do |config|\n" do <<-CODE
+        config.mock_with :rspec
+        config.infer_base_class_for_anonymous_controllers = false
+        config.order = "random"
+            CODE
+            end
+
+            Dir["#{__dir__}/../templates/spec/support/**/*"].each do |file|
+              unless File.directory? file
+                copy_file file, "spec/support/#{File.basename(file)}"
+              end
+            end
+          end
+
+          desc 'engin_setup', 'Configure a rails engine after its generated'
+          def engine_setup
+            inject_into_file "lib/#{@name}/engine.rb", after: "class Engine < ::Rails::Engine\n" do <<-CODE
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_bot, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+CODE
+            end
+          end
+
+          desc 'auto_setup', 'Configure rails engine for development with RSpec, Capybara and FactoryBot'
+          def auto_setup
+            engine_setup unless Dir["lib/#{@name}/engine.rb"].empty?
+            gemspec_setup
+            rake_setup
+            rspec_setup
+          end
+
+        end
+      end
+    end
+  end
+end