mecha 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4bfaaf4d0c582b9c4cd4745fe762809bc8ba211
-  data.tar.gz: e4422a8542e9f4203479df2d5998b580ee102f85
+  metadata.gz: c526cbf04a8f81ffdd132898d44e472033a92b29
+  data.tar.gz: 32bccefa978e04eb9aa0d1f92c6968d0502328f4
 SHA512:
-  metadata.gz: 9ee898f6a81fd948fcd5923d853d5f33468cc1b3915450b2afafd8d7e1cc68fa723680fb8b775f03634f165fe6e9171f00a603a3baf7ec08aed7b8e4b09a043e
-  data.tar.gz: '072928907be9afdd4d0199cafd24a22c08c7a71dabaca0e336f9d030cd1ef47fb1a8a2cfdd6ccf6bcb9b0e37aa311c908fbf3343335f92f8bcbbd5836c2fbd96'
+  metadata.gz: cbca63bf136c703e82ee24b68c71e53531839f2868a11f158cf6c906a67d15c38a114373005898df4ae1b322f47855ea911e3463f99a8106a9a7e39c88ea7bce
+  data.tar.gz: 7dcb1dfcd668c395a772e761e14d2bb26bfa49ea68b3a7f2d552e6111d4e261da19bcf93b2d16e577d9913a403ae0866c7cddb4dd7b90ea5dd8c0356de4667a9

data/.ruby-version

@@ -1 +1 @@
-2.4.0
+2.4.1

data/README.md

@@ -22,22 +22,42 @@ gem install mecha
 mecha <projectname> --devise --bitbucket-pipelines --sentry
 ```
 
-This will create a Rails app with name `<projectname>` and add all our defaults. It configures the app to use sass, remove turbolinks and coffescript, configure Guard, Rubocop and Simplecov. Also, installs Factory Girl, Faker, Timecop, Capibara, Poltergeist, Database Rewinder.
+This will create a Rails app with name `<projectname>` and add all our defaults. It configures the app to use sass, remove Turbolinks and CoffeeScript, configure Guard, Rubocop and Simplecov. Also, installs Factory Girl, Faker, Timecop, Capybara, Poltergeist, Database Rewinder.
 
 ### Available Generators
 
+**Danger**
+
+`--danger` installs and add config for [Danger](http://danger.systems/ruby/). If SimpleCov is installed `danger-simplecov_json` gem is also installed.
+
 **Devise**
 
-`--devise` installs Devise, generates `User`, i18n files and the internatinalized views for english and brazillian portuguese.
+`--devise` installs Devise, generates `User`, i18n files and the internationalized views for English and Brazilian Portuguese.
 
 **Bitbucket Pipelines**
 
 `--bitbucket-pipelines` generates the `bitbucket-pipelines.yml` and a special database config for it.
 
+**Pronto**
+
+`--pronto` installs and add config for [Pronto](https://github.com/prontolabs/pronto). If SimpleCov is installed `pronto-simplecov` gem is also installed.
+
+**RSpec**
+
+`--rspec` installs RSpec and adds configs for tests.
+
 **Sentry**
 
-`--sentry` installs sentry and adds configs to `application.rb` and `application_controller.rb`. Remember to create an environment
-variable with you dsn key. `ENV['DNS']`.
+`--sentry` installs Sentry and adds configs to `application.rb` and `application_controller.rb`. Remember to create an environment
+variable with you DSN key. `ENV['DNS']`.
+
+**Simplecov**
+
+`--simplecov` installs Simplecov and adds configs to `test/test_helper.rb`.
+
+**Heroku**
+
+`--heroku` configure Heroku Pipeline with staging and production environments, and `--org` if you want to configure the project in a Heroku Org.
 
 ## Development
 

data/TODO.md

@@ -0,0 +1,9 @@
+# TODO
+
+## Add Font Awesome Generator
+
+https://github.com/bokmann/font-awesome-rails
+
+## Add Bootstrap Sass Generator
+
+https://github.com/twbs/bootstrap-sass

data/lib/mecha/generators/app/app_builder.rb

@@ -32,17 +32,26 @@ module Mecha
       private
 
       def config_autoload_paths
-        "config.autoload_paths += %W(\#{config.root}/lib \#{config.root}/app/uploaders \#{config.root}/services)"
+        <<-DOC
+    config.autoload_paths += [
+      Rails.root.join('app', 'constants'),
+      Rails.root.join('app', 'presenters'),
+      Rails.root.join('app', 'services'),
+      Rails.root.join('app', 'uploaders'),
+      Rails.root.join('app', 'validators'),
+      Rails.root.join('lib')
+    ]
+        DOC
       end
 
       def config_generators
         <<-DOC
-config.generators do |g|
-      g.view_specs    false
-      g.routing_specs false
-      g.stylesheets   false
-      g.javascripts   false
-      g.helper        false
+    config.generators do |generator|
+      generator.view_specs    false
+      generator.routing_specs false
+      generator.stylesheets   false
+      generator.javascripts   false
+      generator.helper        false
     end
         DOC
       end

data/lib/mecha/generators/app/app_generator.rb

@@ -6,7 +6,6 @@ module Mecha
   module Generators
     class AppGenerator < Rails::Generators::AppGenerator
       class_option :database, type: :string, default: 'postgresql'
-      class_option :skip_action_cable, type: :boolean, default: true
       class_option :skip_coffee, type: :boolean, default: true
       class_option :skip_turbolinks, type: :boolean, default: true
 
@@ -14,6 +13,16 @@ module Mecha
       source_paths << File.join(File.dirname(__FILE__), 'templates')
       source_root File.join(File.dirname(__FILE__), 'templates')
 
+      def say_warking
+        message = <<-MESSAGE.strip_heredoc
+
+          Please install PostgreSQL `brew install postgres` and NodeJS `brew install nodejs`.
+
+        MESSAGE
+
+        say message
+      end
+
       protected
 
       def get_builder_class

data/lib/mecha/generators/app/templates/Gemfile.erb

@@ -1,30 +1,33 @@
 source 'https://rubygems.org'
-ruby '<%= Mecha::RUBY_VERSION %>'
 
 git_source(:github) do |repo_name|
   repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
   "https://github.com/#{repo_name}.git"
 end
 
-gem 'rails', '<%= Mecha::RAILS_VERSION %>'
+ruby '<%= RUBY_VERSION %>'
+
+gem 'rails', '~> <%= Mecha::RAILS_VERSION %>'
 
 gem 'pg', '~> 0.18.4'
-gem 'puma', '~> 3.8.0'
+gem 'puma', '~> 3.10.0'
 
 gem 'jquery-rails', '~> 4.3.1'
 gem 'sass-rails'
 gem 'uglifier', '~> 3.1.12'
 
 group :development, :test do
-  gem 'byebug', platform: :mri
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+  gem 'capybara', '~> 2.13'
   gem 'dotenv-rails'
   gem 'pry'
   gem 'pry-byebug'
+  gem 'selenium-webdriver'
 end
 
 group :development do
-  gem 'listen'
+  gem 'listen', '>= 3.0.5', '< 3.2'
   gem 'spring'
-  gem 'spring-watcher-listen'
-  gem 'web-console'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+  gem 'web-console', '>= 3.3.0'
 end

data/lib/mecha/generators/app/templates/README.md.erb

@@ -8,13 +8,23 @@
 
 ## Dependencies
 
-- Ruby <%= Mecha::RUBY_VERSION %>
+- Ruby >= <%= Mecha::RUBY_VERSION %>
 - PostgreSQL 9.6.1
-- PhantomJS 1.8.1
+
+### MacOS
 
 ```sh
 brew update
-brew install postgres phantomjs
+brew install postgres
+gem install bundler
+```
+
+### Ubuntu
+
+```sh
+apt-get update
+apt-get postgresql postgresql-contrib postgresql-server-dev-all cmake
+gem install bundler
 ```
 
 ## Setup

data/lib/mecha/generators/app/templates/gitignore.erb

@@ -1,4 +1,8 @@
 # See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
 
 # Ignore bundler config.
 /.bundle
@@ -17,6 +21,9 @@
 !/tmp/.keep
 <% end -%>
 
+/node_modules
+/yarn-error.log
+
 # Ignore Byebug command history file.
 .byebug_history
 

data/lib/mecha/generators/bitbucket_pipelines/bitbucket_pipelines_generator.rb

@@ -8,7 +8,6 @@ module Mecha
       class_option :database, type: 'string', default: 'postgresql', aliases: '-d'
 
       def copy_bitbucket_pipelines
-        puts(options)
         template("config/databases/#{options[:database]}.bitbucket.yml.erb", 'config/database.bitbucket.yml')
         template('bitbucket-pipelines.yml.erb', 'bitbucket-pipelines.yml')
       end

data/lib/mecha/generators/cpf_cnpj/cpf_cnpj_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module Mecha
+  module Generators
+    class CpfCnpjGenerator < Rails::Generators::Base
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      def add_gem
+        gem 'cpf_cnpj'
+      end
+
+      def validator_files
+        directory('app/validators', 'app/validators')
+      end
+    end
+  end
+end

data/lib/mecha/generators/cpf_cnpj/templates/app/validators/cnpj_format_validator.rb

@@ -0,0 +1,6 @@
+class CnpjFormatValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if CNPJ.valid?(value)
+    record.errors.add(attribute, :invalid)
+  end
+end

data/lib/mecha/generators/danger/danger_generator.rb

@@ -0,0 +1,37 @@
+require 'rails/generators'
+
+module Mecha
+  module Generators
+    class DangerGenerator < Rails::Generators::Base
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      class_option :simplecov, type: 'boolean', default: false
+
+      def copy_danger
+        template('Dangerfile', 'Dangerfile')
+
+        message = <<-MESSAGE.strip_heredoc
+
+          Review your Dangerfile and change the checks for your needs. Also, config the needed environment variables
+          in your CI:
+
+          DANGER_GITHUB_API_TOKEN: XXX
+
+          Take a look in the project documentation http://danger.systems/."
+
+        MESSAGE
+
+        say message
+      end
+
+      def add_danger_gems
+        gem_group :development, :test do
+          gem 'danger'
+          gem 'danger-github_ext'
+          gem 'danger-simplecov_json' if options[:simplecov]
+          gem 'danger-todoist'
+        end
+      end
+    end
+  end
+end

data/lib/mecha/generators/danger/templates/Dangerfile

@@ -0,0 +1,68 @@
+# MESSAGE CHECKLIST
+
+message = <<-MESSAGE
+## Hello, hitchhiker. Not that anyone cares about what I say, but please, ensure you did check these things:
+
+- [ ] Run all tests locally
+- [ ] If you introduced front-end changes, are there desktop and mobile screenshots attached?
+- [ ] Review the added i18n texts and ensure you added i18n keys for all needed cases
+- [ ] Do manual tests in the pages affected by the changes you're introducing in this PR
+- [ ] Fix all FIXME and remove all TODO comments
+- [ ] [Rails Security Checklist](https://github.com/brunofacca/zen-rails-security-checklist)
+- [ ] [Rails Style Guide](https://github.com/bbatsov/rails-style-guide)
+- [ ] [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide)
+
+MESSAGE
+
+markdown(message)
+
+# GIT & GITHUB
+
+## Make it more obvious that a pr is a work in progress and shouldn't be merged yet
+warn('PR is classed as Work in Progress') if github.pr_title.include?('WIP')
+
+## Warn when there is a big pr
+warn('Big PR') if git.lines_of_code > 500
+
+## If these are all empty something has gone wrong, better to raise it in a comment
+if git.modified_files.empty? && git.added_files.empty? && git.deleted_files.empty?
+  raise('This PR has no changes at all, this is likely an issue during development.')
+end
+
+# DATABASE
+
+added_migration = git.added_files.include?('db/migrate/*.rb')
+has_schema_changes = git.modified_files.include?('db/schema.rb')
+
+## Added migrations and didn't update schema.rb
+if added_migration && !has_schema_changes
+  warn('Run `db:migrate` and commit changes of `schema.rb` file!')
+end
+
+# TODOS
+
+todoist.warn_for_todos
+todoist.print_todos_table
+
+# TESTS
+
+has_app_changes = !git.modified_files.grep(/(lib|app)/).empty?
+has_test_changes = !git.modified_files.grep(/(spec|test)/).empty?
+
+## Changed the code, but didn't added or updated a test case?
+if has_app_changes && !has_test_changes
+  message = <<-MESSAGE
+I think you ought to know I'm feeling very depressed with the fact that you didn't add any test case.
+That's OK as long as you're refactoring existing code.
+  MESSAGE
+
+  warn(message.strip)
+end
+
+<% if options[:simplecov] %>
+
+# CODE COVERAGE
+
+simplecov.report('coverage/coverage.json')
+
+<% end %>

data/lib/mecha/generators/devise/devise_generator.rb

@@ -9,8 +9,8 @@ module Mecha
       source_paths << Rails::Generators::AppGenerator.source_root << File.join(File.dirname(__FILE__), 'templates')
 
       def install_devise
-        gem('devise', '~> 4.2')
-        gem('devise-i18n', '~> 1.1.2')
+        gem('devise', '~> 4.3.0')
+        gem('devise-i18n', '~> 1.3.0')
         bundle_command('install')
 
         stop_spring
@@ -48,6 +48,22 @@ module Mecha
         )
       end
 
+      def config_routes
+        routes = <<-ROUTES.strip_heredoc
+          devise_for :users
+
+          authenticated :user do
+            root '/', as: :authenticated_root
+          end
+
+          devise_scope :user do
+            root 'devise/sessions#new'
+          end
+        ROUTES
+
+        inject_into_file('config/routes.rb', routes, after: "Rails.application.routes.draw do\n")
+      end
+
       private
 
       def stop_spring

data/lib/mecha/generators/guard/guard_generator.rb

@@ -11,10 +11,10 @@ module Mecha
 
       def add_development_gems
         gem_group :development do
-          gem 'guard'
-          gem 'guard-minitest'
+          gem 'guard', require: false
+          gem 'guard-minitest', require: false
           gem 'guard-rails', require: false
-          gem 'guard-rubocop'
+          gem 'guard-rubocop', require: false
         end
       end
     end

data/lib/mecha/generators/guard/templates/Guardfile

@@ -13,6 +13,49 @@ guard :minitest, spring: 'bin/rails test' do
   watch(%r{^test/test_helper\.rb$}) { 'test' }
 end
 
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+  end
+end
+
 guard :rubocop do
   watch(/.+\.rb$/)
   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }

data/lib/mecha/generators/heroku/heroku_generator.rb

@@ -0,0 +1,99 @@
+require 'rails/generators'
+
+module Mecha
+  module Generators
+    class HerokuAppGenerator < Rails::Generators::Base
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      class_option :org, type: :string, default: '', desc: 'Configure the Apps in as projects of your Heroku Org'
+
+      def create_app_manifest
+      end
+
+      def create_pipeline
+        # run_heroku("heroku pipelines:create #{pipeline_name} -a #{staging_name}", 'staging')
+        # run_heroku("heroku pipelines:create #{pipeline_name} -a #{production_name}", 'production')
+      end
+
+      def create_staging_app
+        run_heroku("create #{staging_name}", 'staging')
+        add_to_pipeline(staging_name)
+      end
+
+      def create_production_app
+        run_heroku("create #{production_name}", 'production')
+        add_to_pipeline(production_name)
+      end
+
+      def config_git_remote
+        run('git config heroku.remote staging')
+      end
+
+      def set_rails_secrets
+        # %w(staging production).each do |environment|
+        #   run_toolbelt_command(
+        #     "config:add SECRET_KEY_BASE=#{generate_secret}",
+        #     environment,
+        #   )
+        # end
+      end
+
+      def set_heroku_application_host
+        # %w(staging production).each do |environment|
+        #   run_toolbelt_command(
+        #     "config:add APPLICATION_HOST=#{heroku_app_name}-#{environment}.herokuapp.com",
+        #     environment,
+        #   )
+        # end
+      end
+
+      def set_backup_schedule
+        # %w(staging production).each do |environment|
+        #   run_toolbelt_command(
+        #     "pg:backups:schedule DATABASE_URL --at '10:00 UTC'",
+        #     environment,
+        #   )
+        # end
+      end
+
+      def app_readme
+#         After setting up, you can run the application using [Heroku Local]:
+
+#     % heroku local
+
+# [Heroku Local]: https://devcenter.heroku.com/articles/heroku-local
+      end
+
+      def add_config_to_setup_file_to_setup_apps_after_they_are_created
+      end
+
+      private
+
+      def staging_name
+        "#{app_name.dasherize}-staging"
+      end
+
+      def production_name
+        app_name.dasherize
+      end
+
+      def pipeline_name
+        app_name.dasherize
+      end
+
+      def name
+        app_name.dasherize
+      end
+
+      def add_to_pipeline(app)
+        run_heroku("pipelines:add -a #{app} #{pipeline_name}", 'staging')
+      end
+
+      def run_heroku(command, environment)
+        org_param = options[:org].present? ? " --org #{options[:org]}" : ''
+        params = "--remote #{environment} #{org_param}"
+        run("heroku #{command} #{params}")
+      end
+    end
+  end
+end

data/lib/mecha/generators/heroku/templates/app.json

@@ -0,0 +1,21 @@
+{
+  "name": "<%= app_name.humanize %>",
+  "description": "<%= app_name.humanize %> Heroku Manifest",
+  "website": "http://rubyonrails.org",
+  "success_url": "/welcome",
+  "addons": ["heroku-postgresql:hobby-dev", "papertrail"],
+  "env": {
+    "RAILS_ENV": "production",
+    "COOKIE_SECRET": {
+            "description": "This gets generated",
+            "generator": "secret"
+    },
+    "SETUP_BY": {
+            "description": "Who initiated this setup",
+            "value": ""
+    }
+  },
+  "scripts": {
+    "postdeploy": "bundle exec rake db:migrate"
+  }
+}

data/lib/mecha/generators/i18n/i18n_generator.rb

@@ -15,10 +15,8 @@ module Mecha
         CONFIG.each { |config| application(config) }
       end
 
-      def create_defaults_locales
-        copy_file('config/locales/pt-BR.yml', 'config/locales/rails/pt-BR.yml')
-        copy_file('config/locales/en.yml', 'config/locales/rails/en.yml')
-        remove_file('config/locales/en.yml')
+      def add_i18n_gem
+        gem 'rails-i18n', '~> 5.0.4'
       end
 
       def create_models_locales

data/lib/mecha/generators/pronto/pronto_generator.rb

@@ -0,0 +1,74 @@
+require 'rails/generators'
+
+module Mecha
+  module Generators
+    class ProntoGenerator < Rails::Generators::Base
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      class_option :simplecov, type: 'boolean', default: false
+
+      def copy_reek
+        copy_file('reek', '.reek')
+      end
+
+      def copy_flayignore
+        copy_file('flayignore', '.flayignore')
+      end
+
+      def add_pronto_gems
+        gem_group :development, :test do
+          gem 'brakeman', require: false
+          gem 'bullet', require: false
+          gem 'fasterer', require: false
+          gem 'flay', require: false
+          gem 'rails_best_practices', require: false
+          gem 'reek', require: false
+
+          gem 'pronto'
+          gem 'pronto-brakeman', require: false
+          gem 'pronto-fasterer', require: false
+          gem 'pronto-flay', require: false
+          gem 'pronto-rails_best_practices', require: false
+          gem 'pronto-rails_schema', require: false
+          gem 'pronto-reek', require: false
+          gem 'pronto-rubocop', require: false
+          gem('pronto-simplecov', require: false) if options[:simplecov]
+        end
+      end
+
+      def add_bullet_config
+        config = <<-CONFIG.strip_heredoc
+          config.after_initialize do
+            Bullet.enable = true
+            Bullet.alert = false
+            Bullet.bullet_logger = true
+            Bullet.console = true
+            Bullet.rails_logger = true
+            Bullet.add_footer = true
+          end
+        end
+        CONFIG
+
+        application(config, env: 'development')
+      end
+
+      def say_config_message
+        message = <<-MESSAGE.strip_heredoc
+
+          If you want to use Pronto in your CI, please config the needed environment variables. Bellow is an example:
+
+          PRONTO_GITHUB_ACCESS_TOKEN: XXX
+          PRONTO_PULL_REQUEST_ID: "$(echo $CIRCLE_PULL_REQUEST | grep -o -E '[0-9]+')"
+          PRONTO_GITHUB_SLUG: "${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME}"
+          PRONTO_FORMAT: "%{msg} [%{runner}:%{level}]"
+          PRONTO_VERBOSE: true
+
+          Take a look in the project documentation https://github.com/prontolabs/pronto
+
+        MESSAGE
+
+        say message
+      end
+    end
+  end
+end