myrails 6.0.0 → 7.0.0

data/lib/myrails/modules/engine_generators.rb

@@ -0,0 +1,66 @@
+module Engine
+  module Generators
+    def self.included(thor)
+      thor.class_eval do
+        
+        desc 'engine <OPTION> <NAME>', 'Execute without options to see HELP. Generate and configure a rails engine'
+        def engine(*opts)
+          item = opts[0]
+          
+          file = Dir['*.gemspec'].first
+          
+          @name = if file
+                    File.basename(file, '.gemspec') 
+                  else
+                    opts[1]
+                  end
+                  
+          option = {
+            # base_install: 'Generate a new mountable rails engine with a set of gems and a rake and rspec default configuration',
+            auto_setup: 'Run all of the setup options listed',
+            engine_setup: 'Generate default configuration in Rails::Engine. Requires the name of the engine as the argument',
+            gemspec_setup: 'Setup gempsec file with default information',
+            new: 'Generate clean a full or mountable rails gem',
+            rake_setup: 'Setup rake to run rspec as the default test framework along with other configs',
+            rspec_setup: 'Configure RSpec to work with a rails engine'
+          }
+          
+          unless item
+            say 'ERROR: "myrails engine" was called with no arguments'
+            say 'Usage: "myrails engine <OPTION> <NAME>"'
+            say "Available Options:\n"
+            option.each{|k,v| say "* #{k}: #{v}"}
+            exit
+          end
+          
+          raise ArgumentError, "NAME must be specified for #{item} option. Ex: `myrails engine <OPTION> <NAME>`" unless @name
+          
+          case item
+          # when 'base_install'
+          #   base_install
+          when 'auto_setup'
+            auto_setup
+          when 'engine_setup'
+            engine_setup
+          when 'gem_setup'
+            gem_setup
+          when 'gemspec_setup'
+            gemspec_setup
+          when 'new'
+            new_engine
+          when 'rake_setup'
+            rake_setup
+          when 'rspec_setup'
+            rspec_setup
+          else
+            say "Unknown Action! #{@name}"
+          end
+        end
+        
+        desc 'e', 'Engine shortcut'
+        alias_method :e, :engine
+        
+      end
+    end
+  end
+end

data/lib/myrails/modules/figaro.rb

@@ -2,17 +2,33 @@ module Install
   module Figaro
     def self.included(thor)
       thor.class_eval do
-
-        def install_figaro
+        
+        desc 'add_figaro', 'Add Figaro gem to Gemfile and run bundler'
+        def add_figaro
           insert_into_file 'Gemfile', after: "gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]\n" do <<-CODE
   gem "figaro"
   CODE
           end
 
           run 'bundle install'
+        end
+        
+        desc 'generate_figaro', 'Run Figaro installer'
+        def generate_figaro
           run 'bundle exec figaro install'
+        end
+        
+        desc 'generate_example', 'Create example application.yml file'
+        def generate_example
           copy_file 'rails/config/application.example.yml', 'config/application.example.yml'
         end
+        
+        desc 'setup_figaro', 'Install and configure figaro gem'
+        def setup_figaro
+          add_figaro
+          generate_figaro
+          generate_example
+        end
 
       end
     end

data/lib/myrails/modules/gems.rb

@@ -2,7 +2,8 @@ module Install
   module Gems
     def self.included(thor)
       thor.class_eval do
-
+        
+        desc 'add_test_group', 'Add test group gems to Gemfile'
         def add_test_group
           insert_into_file 'Gemfile', before: "group :development, :test do" do <<-CODE
 group :test do
@@ -18,6 +19,7 @@ CODE
           end
         end
 
+        desc 'add_development_test_gems', 'Add test and development group gems to Gemfile'
         def add_development_test_gems
           insert_into_file 'Gemfile', after: "group :development, :test do\n" do <<-CODE
   gem 'faker'
@@ -28,6 +30,7 @@ CODE
           end
         end
 
+        desc 'add_rails_gems', 'Add commonly used gems to Gemfile'
         def add_rails_gems
           insert_into_file 'Gemfile', after: "gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]\n" do <<-CODE
 gem 'haml-rails'
@@ -41,6 +44,7 @@ CODE
           end
         end
 
+        desc 'add_private_section', 'Add private section to appliation controller'
         def add_private_section
           insert_into_file 'app/controllers/application_controller.rb', before: 'end' do <<-CODE
   private
@@ -48,7 +52,8 @@ CODE
           end
         end
 
-        def install_gems
+        desc 'setup_gems', 'Install development, test and prodution gems'
+        def setup_gems
           add_test_group
           add_development_test_gems
           add_rails_gems

data/lib/myrails/modules/heroku.rb

@@ -3,20 +3,39 @@ module Install
     def self.included(thor)
       thor.class_eval do
 
-      desc 'install_heroku', 'setup application for use with heroku using sqlite3 for development'
-      def install_heroku
-        insert_into_file 'Gemfile', before: "group :development, :test do\n" do <<-CODE
-group :production do
-  gem 'pg'
-  gem 'rails_12factor'
-end
+        desc 'add_heroku_gems', 'Add gems for heroku to Gemfile'
+        def add_heroku_gems
+          insert_into_file 'Gemfile', before: "group :development, :test do\n" do <<-CODE
+  gem 'pg', group: :production
+  gem 'rails_12factor', group: :production
 
-CODE
+  CODE
           end
+          run 'bundle install'
+        end
+        
+        desc 'create_sqlite3_config', 'Generate SQLITE3 database config'
+        def create_sqlite3_config
           copy_file 'db/sqlite3_database.yml', 'config/database.yml'
+        end
+        
+        desc 'create_heroku_procfile', 'Generate a procfile for use with heroku'
+        def create_heroku_procfile
           copy_file 'heroku/Procfile', 'Procfile'
+        end
+        
+        desc 'create_heroku_puma_config', 'Generate a puma config for use with heroku'
+        def create_heroku_puma_config
           copy_file 'heroku/puma.rb', 'config/puma.rb'
-      end
+        end
+        
+        desc 'install_heroku', 'setup application for use with heroku using sqlite3 for development'
+        def setup_heroku
+          add_heroku_gems
+          create_sqlite3_config
+          create_heroku_procfile
+          create_heroku_puma_config
+        end
 
       end
     end

data/lib/myrails/modules/material.rb

@@ -2,26 +2,27 @@ module Layout
   module Material
     def self.included(thor)
       thor.class_eval do
-        def copy_material_files
-          Dir["#{__dir__}/myrails/templates/rails/app/views/layout/material/**/*"].each do |file|
+        desc 'generate_material_files', 'Generate material layout files'
+        def generate_material_files
+          Dir[File.join("#{__dir__}", "..", "templates", "rails", "app", "views", "layout", "material", "**", "*")].each do |file|
             copy_file file, "app/views/layouts/#{File.basename(file)}"
           end
         end
-
-        desc 'install_material', 'Generate Material css theme'
-        def install_material
-          @templates = "#{__dir__}/../templates"
+        
+        desc 'add_material_gem', 'Add materialize sass and icons gem to Gemfile and run bundler'
+        def add_material_gem
 
           insert_into_file 'Gemfile', after: "gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]\n" do <<-CODE
-  gem 'materialize-sass'
-  gem 'material_icons'
-  CODE
+gem 'materialize-sass'
+gem 'material_icons'
+CODE
           end
 
           run 'bundle install'
-
-          copy_material_files
-
+        end
+        
+        desc 'setup_application_sass', 'add materialize to sass manifest'
+        def setup_materialize_css
           insert_into_file 'app/assets/stylesheets/application.css.sass', before: '@import trix' do <<-CODE
 @import "materialize/components/color"
 $primary-color: color("grey", "darken-3") !default
@@ -30,12 +31,21 @@ $secondary-color: color("grey", "base") !default
 @import material_icons
 CODE
           end
-
+        end
+        
+        desc 'add_materialize_js', 'add materialize to js manifest'
+        def setup_materialize_js
           insert_into_file 'app/assets/javascripts/application.js', before: "//= require trix" do <<-CODE
 //= require materialize
   CODE
           end
         end
+        desc 'install_material', 'Generate Material css theme'
+        def setup_material
+          generate_material_files
+          setup_materialize_css
+          setup_materialize_js
+        end
 
       end
     end

data/lib/myrails/modules/pundit.rb

@@ -3,20 +3,36 @@ module Install
     def self.included(thor)
       thor.class_eval do
 
-        def add_pundit_gems
+        desc 'add_pundit_gem', 'Add Pundit gem to Gemfile'
+        def add_pundit_gem
           insert_into_file 'Gemfile', after: "gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]\n" do <<-CODE
 gem 'pundit'
 CODE
           end
-
+        end
+        
+        
+        desc 'add_pundit_matcher_gem', 'Add Pundit Matcher gfem to Gemfile'
+        def add_pundit_matcher_gem
           insert_into_file 'Gemfile', after: "group :test do\n" do <<-CODE
   gem 'pundit-matchers'
 CODE
           end
+        end
+        
+        desc 'add_pundit_gems', 'Add pundit and pundit-matches to Gemfile and run bundler'
+        def add_pundit_gems
+          add_pundit_gem
+          add_pundit_matcher_gem          
           run 'bundle update'
         end
+        desc 'generate_pundit_files', 'Run pundit generator'
+        def generate_pundit_files
+          run 'rails g pundit:install'
+        end
 
-        def enable_pundit
+        desc 'include_pundit', 'Add Pundit to the application controller'
+        def include_pundit
           inject_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::Base\n" do <<-CODE
   # Add pundit authorization
   include Pundit
@@ -25,7 +41,10 @@ CODE
   rescue_from Pundit::NotAuthorizedError, with: :user_not_authorized
 CODE
           end
-
+        end
+        
+        desc 'add_pundit_rescue_notice', 'Add notice to gracefully rescue from Pundit error'
+        def add_pundit_rescue_notice
           inject_into_file 'app/controllers/application_controller.rb', after: "private\n" do <<-CODE
   # Method to gracefully let a user know they are are not authorized
   #
@@ -37,11 +56,16 @@ CODE
 CODE
           end
         end
+        
+        def enable_pundit
+          include_pundit
+          add_pundit_rescue_notice
+        end
 
         desc 'install_pundit', 'Install pundit gem and generate pundit files and application controller code'
-        def install_pundit
+        def setup_pundit
           add_pundit_gems
-          run 'rails g pundit:install'
+          generate_pundit_files
           enable_pundit
         end
 

data/lib/myrails/modules/rails_generator_actions.rb

@@ -0,0 +1,110 @@
+module Rails
+  module Generator
+    module Actions
+      
+      ENVIRONMENTS = %w(development test production)
+      
+      def self.included(thor)
+        
+        thor.class_eval do
+          
+          desc 'model', "Generates a rails model with the given name along with its related spec file and namespace prefix for table creation. Use '/' to create a namespaced model"
+          def model
+            template 'rails/app/models/model.rb', "app/models/#{@name.downcase}.rb"
+            template 'rails/app/models/namespace_model.rb', "app/models/#{@name.split("/").first.singularize.downcase}.rb" if @name.include?("/")
+            template 'spec/model.rb', "spec/models/#{@name.downcase}_spec.rb"
+          end
+
+          desc 'controller', "Generates a rails controller with the given name along with related spec file. Use '/' to create a namespaced controller"
+          def controller
+            template 'rails/app/controllers/controller.rb', "app/controllers/#{@name.downcase.pluralize}_controller.rb"
+            if @name.include?("/")
+              parent, child = name.split("/")
+              template 'rails/app/controllers/namespace_controller.rb', "app/controllers/#{parent}/#{parent.downcase}_controller.rb"
+            end
+            
+            template 'spec/controller.rb', "spec/controllers/#{@name.downcase.pluralize}_controller_spec.rb"
+            run "mkdir -p app/views/#{@name.downcase.pluralize}"
+          end
+
+          desc 'policy', "Generates a pundit policy with the given name and a related spec file. Use '/' to create a namespaced policy"
+          def policy
+            template 'rails/app/policies/pundit.rb', "app/policies/#{@name.downcase}_policy.rb"
+            template 'spec/pundit.rb', "spec/policies/#{@name.downcase}_policy_spec.rb"
+          end
+        
+          desc 'decorator', 'Generates draper decoration with given name and related spec file'
+          def decorator
+            copy_file 'rails/app/decorators/application_decorator.rb', 'app/decorators/application_decorator.rb'
+            template 'rails/app/decorators/decoration.rb', "app/decorators/#{@name.downcase}_decoration.rb"
+            copy_file 'spec/support/configs/decorator_presenter.rb', 'spec/support/configs/decorator_presenter.rb'
+            template 'spec/decorator_spec.rb', "spec/decorators/#{@name.downcase}_decorator_spec.rb"
+          end
+        
+          desc 'factory', "Generates a factory_bot factory in the spec/factories directory. Use '/' to create a namespaced factory"
+          def factory
+            template 'spec/factory.rb', "spec/factories/#{@name.downcase}.rb"
+          end
+
+          desc 'config_env', 'Add code to environment files. Host refers to url options. Name option referes to controller and mailer default_url_options'
+          def config_env
+            ENVIRONMENTS.each do |environment|
+              case environment
+              when 'development'
+                inject_into_file 'config/environments/development.rb', after: "config.action_mailer.raise_delivery_errors = false\n" do <<-CODE
+      config.action_mailer.delivery_method = :letter_opener
+      config.action_mailer.perform_deliveries = false
+      config.action_mailer.default_url_options = { host: ENV.fetch('DEFAULT_HOST') }
+      config.action_controller.default_url_options = { host: ENV.fetch('DEFAULT_HOST') }
+      CODE
+                end
+              when 'test'
+                inject_into_file 'config/environments/test.rb', after: "config.action_mailer.delivery_method = :test\n" do <<-CODE
+      config.action_mailer.default_url_options = { host: ENV.fetch('DEFAULT_HOST') }
+      config.action_controller.default_url_options = { host: ENV.fetch('DEFAULT_HOST') }
+      CODE
+                end
+              when 'production'
+                inject_into_file 'config/environments/production.rb', after: "config.active_record.dump_schema_after_migration = false\n" do <<-CODE
+      config.action_mailer.default_url_options = { host: ENV.fetch('DEFAULT_HOST') }
+      config.action_controller.default_url_options = { host: ENV.fetch('DEFAULT_HOST') }
+      config.assets.compile = true
+      CODE
+                end
+              end
+            end
+          end
+
+          desc 'new_ui NAME', 'Create a new ui view'
+          def new_ui
+            run "touch app/views/ui/#{@name.downcase}.html.haml"
+            say "DON'T FORGET: Restart the rails app"
+          end
+          
+        end
+        
+      end
+      
+    end
+  end
+end
+
+
+
+#         desc 'presenter', "Generates a presenter class with the given name and a related spec file. Use '/' to create a namespaced presenter"
+#         option :name, required: true
+#         def presenters
+#           inject_into_file 'app/helpers/application_helper.rb', after: "module ApplicationHelper\n" do <<-CODE
+#   def present(object, klass = nil)
+#     klass ||= "#{object.class}Presenter".constantize
+#     presenter = klass.new(object, self)
+#     yield presenter if block_given?
+#     presenter
+#   end
+#
+# CODE
+#           copy_file 'rails/app/presenters/base.rb', 'app/presenters/base_presenter.rb'
+#           template 'rails/app/presenters/presenter.rb', "app/presenters/#{options[:name].downcase}_presenter.rb"
+#           copy_file 'spec/support/configs/decorator_presenter.rb', 'spec/support/configs/decorator_presenter.rb'
+#           template 'rails/app/presenters/presenter_spec.rb', "spec/presenters/#{options[:name].downcase}_presenter_spec.rb"
+#         end

data/lib/myrails/modules/rails_generators.rb

@@ -1,102 +1,56 @@
 module Rails
   module Generators
+    # ENVIRONMENTS = %w(development test production)
+    
     def self.included(thor)
       thor.class_eval do
-
-        desc 'model', "Generates a rails model with the given name along with its related spec file and namespace prefix for table creation. Use '/' to create a namespaced model"
-        option :name, required: true
-        def model
-          template 'rails/app/models/model.rb', "app/models/#{options[:name].downcase}.rb"
-          template 'rails/app/models/namespace_model.rb', "app/models/#{options[:name].split("/").first.singularize.downcase}.rb" if options[:name].include?("/")
-          template 'spec/model.rb', "spec/models/#{options[:name].downcase}_spec.rb"
-        end
-
-        desc 'controller', "Generates a rails controller with the given name along with related spec file. Use '/' to create a namespaced controller"
-        option :name, required: true
-        def controller
-          template 'rails/app/controllers/controller.rb', "app/controllers/#{options[:name].downcase.pluralize}_controller.rb"
-          if options[:name].include?("/")
-            parent, child = options[:name].split("/")
-            template 'rails/app/controllers/namespace_controller.rb', "app/controllers/#{parent}/#{parent.downcase}_controller.rb"
-          end
-          template 'spec/controller.rb', "spec/controllers/#{options[:name].downcase.pluralize}_controller_spec.rb"
-          run "mkdir -p app/views/#{options[:name].downcase.pluralize}"
-        end
-
-        desc 'policy', "Generates a pundit policy with the given name and a related spec file. Use '/' to create a namespaced policy"
-        option :name, required: true
-        def policy
-          template 'rails/app/policies/pundit.rb', "app/policies/#{options[:name].downcase}_policy.rb"
-          template 'spec/pundit.rb', "spec/policies/#{options[:name].downcase}_policy_spec.rb"
-        end
-
-        desc 'presenter', "Generates a presenter class with the given name and a related spec file. Use '/' to create a namespaced presenter"
-        option :name, required: true
-        def presenters
-          copy_file 'rails/app/presenters/base.rb', 'app/presenters/base_presenter.rb'
-          template 'rails/app/presenters/presenter.rb', "app/presenters/#{options[:name].downcase}_presenter.rb"
-          copy_file 'rails/app/presenters/presenter_config.rb', 'spec/support/configs/presenter.rb'
-          template 'rails/app/presenters/presenter_spec.rb', "spec/presenters/#{options[:name].downcase}_presenter_spec.rb"
-        end
-
-        desc 'factory', "Generates a factory_bot factory in the spec/factories directory. Use '/' to create a namespaced factory"
-        option :name, required: true
-        def factory
-          template 'spec/factory.rb', "spec/factories/#{options[:name].downcase}.rb"
-        end
-
-        desc 'sendgrid', 'Generate sendgrid initializer and mail interceptor'
-        option :email, required: true
-        def sendgrid
-          copy_file 'rails/app/mailers/sendgrid.rb', 'config/initializers/sendgrid.rb'
-          template 'rails/app/mailers/dev_mail_interceptor.rb', 'app/mailers/dev_mail_interceptor.rb'
-          ENVIRONMENTS.each do |environment|
-            unless environment == 'production'
-              inject_into_file "config/environments/#{environment}.rb", after: "Rails.application.configure do\n" do <<-CODE
-      ActionMailer::Base.register_interceptor(DevMailInterceptor)
-                CODE
-              end
-            end
+        desc 'kickstart <OPTION> <NAME>', 'Execute without options to see HELP. Generate a rails template with a given name'
+        def kickstart(*opts)
+          item, @name = opts
+          
+          option = {
+            controller: 'Generate rails controller with corresponding RSpec file',
+            decorator: 'Generate draper decorator with corresponding RSpec file',
+            factory: 'Generate factory[girl|bot] factory',
+            model: 'Generate rails model with corresponding RSpec file',
+            policy: 'Generate pundit policy with corresponding RSpec file',
+            ui: 'Generate a ui file for mocking front end'
+          }
+          
+          unless item
+            say 'ERROR: "myrails kickstart" was called with no arguments'
+            say 'Usage: "myrails kickstart <OPTION> <NAME>"'
+            say "Available Options:\n"
+            option.each{|k,v| say "* #{k}: #{v}"}
+            exit
           end
-        end
-
-        desc 'config_env', 'Add code to environment files. Host refers to url options. Name option referes to controller and mailer default_url_options'
-        option :name, required: true
-        def config_env
-          ENVIRONMENTS.each do |environment|
-            case environment
-            when 'development'
-              inject_into_file 'config/environments/development.rb', after: "config.action_mailer.raise_delivery_errors = false\n" do <<-CODE
-    config.action_mailer.delivery_method = :letter_opener
-    config.action_mailer.perform_deliveries = false
-    config.action_mailer.default_url_options = { host: ENV['DEFAULT_HOST'] }
-    config.action_controller.default_url_options = { host: ENV['DEFAULT_HOST'] }
-    CODE
-              end
-            when 'test'
-              inject_into_file 'config/environments/test.rb', after: "config.action_mailer.delivery_method = :test\n" do <<-CODE
-    config.action_mailer.default_url_options = { host: ENV['DEFAULT_HOST'] }
-    config.action_controller.default_url_options = { host: ENV['DEFAULT_HOST'] }
-    CODE
-              end
-            when 'production'
-              inject_into_file 'config/environments/production.rb', after: "config.active_record.dump_schema_after_migration = false\n" do <<-CODE
-    config.action_mailer.default_url_options = { host: ENV['DEFAULT_HOST'] }
-    config.action_controller.default_url_options = { host: ENV['DEFAULT_HOST'] }
-    config.assets.compile = true
-    CODE
-              end
-            end
+          
+          raise ArgumentError, "NAME must be specified for #{item} option. Ex: `myrails kickstart <OPTION> <NAME>`" unless @name
+          
+          case item
+          when 'model'
+            model
+          when 'controller'
+            controller
+          when 'policy'
+            policy
+          when 'ui'
+            new_ui
+          when 'policy'
+            policy
+          when 'decorator'
+            decorator
+          when 'factory'
+            factory
+          else
+            say "Unknown Action! #{@name}"
           end
         end
-
-        desc 'new_ui NAME', 'Create a new ui view'
-        def new_ui(name)
-          run "touch app/views/ui/#{name}.html.haml"
-          say "DON'T FORGET: Restart Powify App"
-        end
-
-      end
-    end
-  end
-end
+        
+        desc 'ks', 'Kickstart shortcut'
+        alias_method :ks, :kickstart
+        
+      end # end thor.class_eval
+    end # end self.included
+  end # end module Generators
+end # end module Rails