myrails 6.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8450b1df8a8d157e8f7dbe333953599cb38350e97f57fad2105c6d121ed48e4a
-  data.tar.gz: a06d4fef3fdfac38da6c9e1edb3295fc99abdfe0ce0995bb7851bb02c6efd957
+  metadata.gz: d6fd730074c6669bfd1c5bd8689479314e5dfd576f8ae35ce3e83ab33ce34166
+  data.tar.gz: a2d148e81059221440ca418b6efcf1e461ba0c194906a2280bac87b526b9f382
 SHA512:
-  metadata.gz: 136f26e0eaf3bb7c1d227c91be28497f100e936751372547c01fd35bf5d36a032954ef413d774d99d8b201b136b1a3c9a043f0f6194cab019cea836acdc5192b
-  data.tar.gz: 89eb02894b6d8757220d786dd050df8192755dc838a66f869c7efcdd63b0f02b0cf034220838cc9382689dd87e14d221284dd5e00cb320cd5c8bdadbcf681a2f
+  metadata.gz: 9614cb17e78b3c439617ffe053606453ed29e26b0b0a8a3e2db0de28c016a71ba0d53bbd929c7883d64eb6496399dd1a9d44fc482b21f3e3c3a1f34cd76d48d6
+  data.tar.gz: 15e0c1974ec3ed82c6371c27f871715e7ae0cead5fded1a00e6f79ac2be4fc017fb1d078385c99a83601e5b8a303b3c900cff0ee763ff6a2efeed68bde53950f

data/README.md

@@ -1,30 +1,34 @@
-# Myrails
+# MyRails
 
-This gem was created to make generating rails related files and other rails gem files (that I use) a lot easier. It is a thor backed gem that was designed with rails 5 in mind but most of it "should" work with rails 4.
+A library for generating rails related templates and configuring some standard gems (that I use) a lot easier. This was designed with Rails 5 in mind but most of it "should" work with rails 4. An example of the design differences is, a generated model inherit from `ApplicatinoRecord` instead of `ActiveRecord::Base`
 
-This gem is not endorsed by the rails core team. I wrote it as a convenience for generating files that I would otherwise have written by hand.
+This library is not endorsed by the Rails core team. I wrote it as a convenience for generating code that I would otherwise have written by hand or would have had to manage with code snippets (I use more than one editor)
 
 ## Disclaimer
 
-`user at your own risk!` I am not held responsible for using this gem. If you are not usre it will work for you, install it on a vagrant vm and give it a try there. You can use even use the Vagrantfile that is in this repo to take care of configuring a useable vm.
+`Use at your own risk!` I am not responsible for any issues that come from using this library. If you are not sure it will work for you, install it on a vagrant vm and give it a try there. You can even use the Vagrantfile that is in this repo to take care of configuring a useable vm.
+
+This does not work with the windows environment
 
 ## Notes
 
-Use 1.1.1 if you are primarily developing in rails 3 & 4
+Use v1.1.1 if you are primarily developing in rails 3 & 4
 
-Use the latest version if are primarily developing in rails 5
+Use the latest version if you are primarily developing in rails 5
 
-## Examples
+## Requirements
 
-Here is an example of the gem works:
+Ruby 2.2 and above
 
-Lets say I use pundit. With this gem I am able to run the following:
+## Examples
+
+A gem I use often is pundit. With this library I can generate a policy along with an RSpec pundit matcher file to test the policy with. I am able to run the following:
 
 ```ruby
-myrails policy --name=article
+myrails kickstart policy article
 ```
 
-which outputs:
+which outputs something like:
 
 ```
 create  app/policies/article_policy.rb
@@ -44,39 +48,34 @@ with corresponding files:
         └── article_policy_spec.rb
 ```
 
-Inside app/policies/articles_policy.rb is boiler plate code like:
+Inside app/policies/articles_policy.rb is boiler plate code (something like):
 
-```
+```ruby
 class ArticlePolicy < ApplicationPolicy
-  # Allow all users to access new article
+
   def new?
     true
   end
 
-  # Allows owner to edit Article
   def edit?
     user == record.user
   end
 
-  # Allows all users to create Article
   alias_method :create?, :new?
 
-  # Allows all users to view Article
   alias_method :show?, :new?
 
-  # Allows owner to update an Article
   alias_method :update?, :edit?
 
-  # Allows owner to remove an Article
   alias_method :destroy?, :edit?
 end
 ```
 
-Inside the spec/policies/articles_policy_spec.rb is boiler plate code like:
+Inside the spec/policies/articles_policy_spec.rb is boiler plate code (something like):
 
-```
-# Use with Pundit Matches: https://github.com/chrisalley/pundit-matchers
+```ruby
 require 'rails_helper'
+
 describe ArticlePolicy do
   subject { ArticlePolicy.new(user, article) }
 
@@ -107,15 +106,17 @@ end
 
 ## Installation
 
-In your terminal:
+In the terminal:
 
-```ruby
-# For development in rails 3 & 4 primarily
+### For use with Rails 3 & 4
 
+```ruby
 gem install myrails -v 1.1.1
+```
 
-# For development in rails 5 primarily
+### For use with Rails 5
 
+```ruby
 gem install myrails
 ```
 
@@ -123,17 +124,34 @@ gem install myrails
 
 Simply type `myrails` to see the help menu
 
+The current options available are:
+
+* db - Rails database options
+* engine (aliase e) - Rails engine options
+* install (aliase i) - Rails gems and configuration options
+* kickstart (aliase ks) - Rails template generation options
+* spec (aliase s) - RSpec template generation options
+* setup_sendgrid - Install sendgrid initializer with mail interceptor
+
+Every option also has a help menu. For instance, specifying `myrails kickstart` will display something like:
+
 ```ruby
-# Example for generating a presenter class
-myrails presenter --name=post
+ERROR: "myrails kickstart" was called with no arguments
+Usage: "myrails kickstart <OPTION> <NAME>"
+Available Options:
+* 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
 ```
-This generates a PostPresenter class in app/presenters that inherits from app/presenters/base_presenter.rb to be used in views. This also generates a spec/presenters/post_presenter_spec.rb file for testing.
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`.
+To install this gem onto your local machine, run `bundle exec rake build` then `bundle exec rake install`.
 
 ## Releasing
 To release a new version,

data/lib/myrails.rb

@@ -6,160 +6,84 @@ require_relative 'myrails/modules/bootstrap'
 require_relative 'myrails/modules/material'
 require_relative 'myrails/modules/ui'
 require_relative 'myrails/modules/assets'
-require_relative 'myrails/modules/application'
+require_relative 'myrails/modules/application_generators'
+require_relative 'myrails/modules/application_generator_actions'
 require_relative 'myrails/modules/capistrano'
-require_relative 'myrails/modules/database'
+require_relative 'myrails/modules/database_generator'
+require_relative 'myrails/modules/database_generator_actions'
 require_relative 'myrails/modules/devise'
 require_relative 'myrails/modules/dotenv'
-require_relative 'myrails/modules/engine'
+require_relative 'myrails/modules/draper'
+require_relative 'myrails/modules/engine_generators'
+require_relative 'myrails/modules/engine_generator_actions'
 require_relative 'myrails/modules/figaro'
-require_relative 'myrails/modules/footnotes'
 require_relative 'myrails/modules/heroku'
 require_relative 'myrails/modules/pundit'
 require_relative 'myrails/modules/rails_generators'
+require_relative 'myrails/modules/rails_generator_actions'
 require_relative 'myrails/modules/rspec_generators'
+require_relative 'myrails/modules/rspec_generator_actions'
 require_relative 'myrails/modules/rspec'
+
 module Myrails
   class Myrails < Thor
     include Thor::Actions
+    
     source_root "#{__dir__}/myrails/templates"
+    
     TEMPLATES = source_root
-    ENVIRONMENTS = %w(development test production)
 
     no_tasks do
       include Install::Gems
       include Install::Ui
-      include Install::ApplicationHelper
       include Install::RSpec
       include Install::Devise
       include Install::Pundit
-      include Install::Footnotes
       include Install::DotEnv
       include Install::Heroku
       include Install::Capistrano
       include Install::Assets
       include Install::Figaro
+      include Install::Draper
       include Layout::Bootstrap
       include Layout::Material
-
-      desc 'install_layout', 'Generate common layout files'
-      def install_layout
-        answer = ask 'Would you like to use [B]ootstrap or [M]aterial'
-
-        run 'rm app/views/layouts/application.html.erb'
-
-        install_assets
-
-        if answer =~ /^B|b/
-          install_bootstrap
-        elsif answer =~ /^M|m/
-          install_material
-        end
-
-        insert_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::Base\n" do <<-CODE
-  add_flash_types :error, :success
-CODE
-        end
-      end
-
-      desc 'git_init', "Initialize git with some files automatically ignored"
-      def git_init
-        run 'git init'
-        run 'echo /coverage >> .gitignore'
-        run 'echo /config/application.yml >> .gitignore'
-        run 'git add --all'
-        run "git commit -m 'initial commit'"
-      end
-
-      desc 'base_install', 'Run the most common actions in the right order'
-      def base_install
-        install_gems
-        install_application_helper
-        install_assets
-        install_layout
-        install_css
-        install_footer
-        install_ui
-        install_pundit
-        install_rspec
-        install_footnotes
-        config_env
-        install_figaro
-        git_init
-        say 'Dont forget to run config_env'
-      end
-
-    end
-    # end of no_tasks
+      include Rails::Generator::Actions
+      include RSpec::Generator::Actions
+      include Engine::Generator::Actions
+      include Database::Generator::Actions
+      include Application::Generator::Actions
+      
+    end # end of no_tasks
+    
+    
     include Rails::Generators
     include RSpec::Generators
-    include Rails::Engines
-    include Rails::Database
-
-    desc 'install NAME', 'Install customizations to configure application quickly. Type `myrails install` for options'
-    def install(name=nil)
-      options = {
-        application_helper: 'Overwrite default application helper with a custom helper',
-        gems: 'Install default gem set',
-        layout: 'Generate assets and custom styles using either Boostrap or Material',
-        ui: 'Generate UI resource',
-        pundit: 'Install and configure Pundit gem',
-        rspec: 'Install and configure Rspec gem',
-        footnotes: 'Install and configure Footnotes gem',
-        base: 'Run through all options listed in this list',
-        git: 'Generate git directory and ignore default files',
-        heroku: 'Generate needed setup for Heroku deployment',
-        devise: 'Generate and configure Devise gem',
-        dotenv: 'Generate and configure Dotenv gem (Do not use if figaro is already installed)',
-        capistrano: 'Generate capistrano with default deployment',
-        figaro: 'Generate and configure Figaro Gem (Do not use if dotenv is already installed)',
-        env_config: 'Configure environment files with default hosts etc.'
-      }
-      unless name
-        say 'ERROR: "myrails install" was called with no arguments'
-        say 'Usage: "myrails install NAME"'
-        say "Available Options:\n"
-        options.each{|k,v| say "* #{k}: #{v}"}
-        exit
-      end
-
-      case name
-      when 'application_helper'
-        install_application_helper
-      when 'gems'
-        install_gems
-      when 'layout'
-        install_layout
-      when 'ui'
-        install_ui
-      when 'pundit'
-        install_pundit
-        install_rails_helper
-      when 'rspec'
-        install_rspec
-      when 'footnotes'
-        install_footnotes
-      when 'base'
-        base_install
-      when 'git'
-        git_init
-      when 'heroku'
-        install_heroku
-      when 'devise'
-        install_devise
-      when 'dotenv'
-        install_dotenv
-      when 'capistrano'
-        install_capistrano
-      when 'figaro'
-        install_figaro
-      when 'env_config'
-        config_env
-      else
-        say "Unknown Action! #{name}"
+    include Engine::Generators
+    include Database::Generators
+    include Application::Generators
+    
+    # Moved here because it envokes draper kickstart method for some reason.
+    # Will address later.
+    desc 'setup_sendgrid', 'Generate sendgrid initializer and mail interceptor'
+    def setup_sendgrid
+      environments = %w(development test production)
+  
+      @email = ask 'What email address would you like to use?', :yellow
+  
+      raise ArgumentError, 'Email address required' unless @email
+  
+      copy_file 'rails/config/initializers/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
       end
     end
-
     
   end
 end

data/lib/myrails/modules/application_generator_actions.rb

@@ -0,0 +1,61 @@
+module Application
+  module Generator
+    module Actions
+      def self.included(thor)
+        thor.class_eval do
+          
+          desc 'setup_application_helper', 'overwrite rails application helper with some default code'
+          def setup_application_helper
+            copy_file 'rails/app/helpers/application_helper.rb', 'app/helpers/application_helper.rb'
+          end
+        
+          desc 'setup_layout', 'Generate JS and CSS files with a choice of CSS Framework'
+          def setup_layout
+            answer = ask 'Would you like to use [B]ootstrap or [M]aterial? Default: ', :yellow, default: 'M'
+
+            run 'rm app/views/layouts/application.html.erb'
+
+            setup_assets
+
+            if answer =~ /^B|b/
+              setup_bootstrap
+            elsif answer =~ /^M|m/
+              setup_material
+            end
+
+            insert_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::Base\n" do <<-CODE
+      add_flash_types :error, :success
+    CODE
+            end
+          end
+        
+          desc 'setup_git', "Initialize git with some files set to be ignored"
+          def setup_git
+            run 'git init' unless File.exist?('.git')
+            run 'echo /coverage >> .gitignore'
+            run 'echo /config/application.yml >> .gitignore'
+            run 'git add --all'
+            run "git commit -m 'initial commit'"
+          end
+        
+          desc 'base_setup', 'Run the most common setup actions in the right order'
+          def base_setup
+            setup_gems
+            setup_application_helper
+            setup_layout
+            setup_ui
+            setup_pundit
+            setup_draper
+            setup_rspec
+            config_env
+            setup_figaro
+            setup_git
+            say 'Dont forget to run setup config/application.yml with initial values.'
+          end
+
+        
+        end
+      end
+    end
+  end
+end

data/lib/myrails/modules/application_generators.rb

@@ -0,0 +1,80 @@
+module Application
+  module Generators
+    def self.included(thor)
+      thor.class_eval do
+        
+        desc 'install NAME', 'Install customizations to configure application quickly. Type `myrails install` for options'
+        def install(name=nil)
+          options = {
+            app_helper: 'Overwrite default application helper with a custom helper',
+            base: 'Run through all options listed in this list',
+            capistrano: 'Generate capistrano with default deployment',
+            devise: 'Generate and configure Devise gem',
+            dotenv: 'Generate and configure Dotenv gem (Do not use if figaro is already installed)',
+            draper: 'Generate and configure Draper gem',
+            env_config: 'Configure environment files with default hosts etc.',
+            figaro: 'Generate and configure Figaro Gem (Do not use if dotenv is already installed)',
+            gems: 'Install default gem set',
+            git: 'Generate git directory and ignore default files',
+            heroku: 'Generate needed setup for Heroku deployment',
+            layout: 'Generate assets and custom styles using either Boostrap or Material',
+            pundit: 'Install and configure Pundit gem',
+            rspec: 'Install and configure Rspec gem',
+            # sendgrid: 'Install and configure ActionMailer to use sendgrid',
+            ui: 'Generate UI resource'
+          }
+      
+          unless name
+            say 'ERROR: "myrails install" was called with no arguments'
+            say 'Usage: "myrails install NAME"'
+            say "Available Options:\n"
+            options.each{|k,v| say "* #{k}: #{v}"}
+            exit
+          end
+
+          case name
+          when 'app_helper'
+            setup_application_helper
+          when 'gems'
+            setup_gems
+          when 'layout'
+            setup_layout
+          when 'ui'
+            setup_ui
+          when 'pundit'
+            setup_pundit
+            setup_rails_helper
+          when 'rspec'
+            setup_rspec
+          when 'base'
+            base_setup
+          when 'git'
+            setup_git
+          when 'heroku'
+            setup_heroku
+          when 'devise'
+            setup_devise
+          when 'dotenv'
+            setup_dotenv
+          when 'capistrano'
+            setup_capistrano
+          when 'figaro'
+            setup_figaro
+          when 'env_config'
+            config_env
+          when 'draper',
+            setup_draper
+          # when 'sendgrid'
+          #   setup_sendgrid
+          else
+            say "Unknown Action! #{name}"
+          end
+        end
+        
+        desc 'i', 'Install shortcut'
+        alias_method :i, :install
+        
+      end
+    end
+  end
+end