generapp 0.2.0 → 0.3.0

data/.rubocop_todo.yml

@@ -0,0 +1,47 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-01-15 16:49:41 -0500 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 109
+
+# Offense count: 8
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 104
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/generapp/generators/app_generator.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Style/ExtraSpacing:
+  Exclude:
+    - 'templates/config/puma.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/SingleSpaceBeforeFirstArg:
+  Exclude:
+    - 'templates/config/puma.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: MultiSpaceAllowedForOperators.
+Style/SpaceAroundOperators:
+  Exclude:
+    - 'templates/config/puma.rb'

data/CHANGELOG.md

@@ -1,3 +1,10 @@
 ### master
 
+### 0.2.0 - 2016-01-13
+
+* bug fixes
+    * fix configuration generation
+        
+### 0.1.0 - 2016-01-13
+
 Initial release

data/README.md

@@ -1,4 +1,5 @@
 # Generapp
+[![Gem Version](https://badge.fury.io/rb/generapp.svg)](https://badge.fury.io/rb/generapp)
 [![Build Status](https://travis-ci.org/koombea/generapp.svg)](https://travis-ci.org/koombea/generapp)
 [![Coverage Status](https://coveralls.io/repos/koombea/generapp/badge.svg?branch=master&service=github)](https://coveralls.io/github/koombea/generapp?branch=master)
 
@@ -63,6 +64,10 @@ Testing gems:
   RSpec matchers
 * [Timecop](https://github.com/ferndopolis/timecop-console) for testing time
 
+### Rails ERD
+
+If you plan to use Rails ERD you may need to install Graphviz ([instructions](http://voormedia.github.io/rails-erd/install.html))
+
 ## Contributing
 
 1. Fork it ( https://github.com/koombea/generapp/fork )

data/bin/generapp

@@ -9,6 +9,8 @@ end
 
 templates_root = Generapp.templates
 Generapp::Generators::AppGenerator.source_root templates_root
-Generapp::Generators::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+Generapp::Generators::AppGenerator.source_paths <<
+  Rails::Generators::AppGenerator.source_root <<
+  templates_root
 
 Generapp::Generators::AppGenerator.start

data/generapp.gemspec

@@ -28,6 +28,7 @@ Feel free to use it to jump start your project and don't waste any time configur
   spec.add_dependency 'bundler', '~> 1.3'
   spec.add_dependency 'rails', Generapp::RAILS_VERSION
   spec.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
+  spec.add_development_dependency 'rubocop', '~> 0.35', '>= 0.35'
   spec.add_development_dependency 'coveralls', '~>0.8.0', '>= 0.8.0'
   spec.add_development_dependency 'yard', '~> 0.8.7', '>= 0.8.0'
 end

data/lib/generapp/actions/configuration.rb

@@ -1,19 +1,10 @@
 module Generapp
-  module Actions
+  module Actions #:nodoc
+    # App configuration associated actions
     module Configuration
       def setup_default_rake_task
         append_file 'Rakefile' do
-          <<-EOS
-task(:default).clear
-task default: [:spec]
-
-if defined? RSpec
-  task(:spec).clear
-  RSpec::Core::RakeTask.new(:spec) do |t|
-    t.verbose = false
-  end
-end
-          EOS
+          rspec_task
         end
       end
 
@@ -29,6 +20,22 @@ end
       def generate_devise
         generate 'devise:install'
       end
+
+      protected
+
+      def rspec_task
+        <<-RUBY
+task(:default).clear
+task default: [:spec]
+
+if defined? RSpec
+  task(:spec).clear
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.verbose = false
+  end
+end
+        RUBY
+      end
     end
   end
 end

data/lib/generapp/actions/database.rb

@@ -1,5 +1,6 @@
 module Generapp
-  module Actions
+  module Actions #:nodoc
+    # App database associated actions
     module Database
       def use_postgres_config_template
         template 'config/postgresql_database.yml.erb',

data/lib/generapp/actions/develop.rb

@@ -1,28 +1,19 @@
-require 'generapp/actions/files'
 
 module Generapp
-  module Actions
+  module Actions #:nodoc
+    # App develop environment
+    # associated actions
     module Develop
-      include Files
-
       def raise_on_delivery_errors
-        replace_in_file 'config/environments/development.rb',
-                        'raise_delivery_errors = false', 'raise_delivery_errors = true'
+        gsub_file 'config/environments/development.rb',
+                  'raise_delivery_errors = false',
+                  'raise_delivery_errors = true'
       end
 
       def add_bullet_gem_configuration
-        config = <<-RUBY
-  config.after_initialize do
-    Bullet.enable = true
-    Bullet.bullet_logger = true
-    Bullet.rails_logger = true
-  end
-        RUBY
-
-        inject_into_file(
-            'config/environments/development.rb',
-            config,
-            after: "config.action_mailer.raise_delivery_errors = true\n")
+        inject_into_file 'config/environments/development.rb',
+                         bullet_configuration,
+                         after: "config.action_mailer.raise_delivery_errors = true\n"
       end
 
       def configure_dalli
@@ -32,14 +23,31 @@ module Generapp
 
         RUBY
 
-        inject_into_file(
-            'config/environments/development.rb',
-            config,
-            after: "config.action_mailer.raise_delivery_errors = true\n")
+        inject_into_file 'config/environments/development.rb',
+                         config,
+                         after: "config.action_mailer.raise_delivery_errors = true\n"
       end
 
       def configure_generators
-        config = <<-RUBY
+        inject_into_class 'config/application.rb',
+                          'Application',
+                          generapp_generators
+      end
+
+      def generate_annotate
+        copy_file 'tasks/auto_annotate_models.rake',
+                  'lib/tasks/auto_annotate_models.rake'
+      end
+
+      def add_secrets
+        copy_file 'config/application.yml', 'config/application.yml.example'
+        copy_file 'config/application.yml', 'config/application.yml'
+      end
+
+      protected
+
+      def generapp_generators
+        <<-RUBY
 
     config.generators do |g|
       g.assets false
@@ -54,18 +62,16 @@ module Generapp
     end
 
         RUBY
-
-        inject_into_class 'config/application.rb', 'Application', config
-      end
-
-      def generate_annotate
-        copy_file 'tasks/auto_annotate_models.rake',
-                  'lib/tasks/auto_annotate_models.rake'
       end
 
-      def add_secrets
-        copy_file 'config/application.yml', 'config/application.yml.example'
-        copy_file 'config/application.yml', 'config/application.yml'
+      def bullet_configuration
+        <<-RUBY
+  config.after_initialize do
+    Bullet.enable = true
+    Bullet.bullet_logger = true
+    Bullet.rails_logger = true
+  end
+        RUBY
       end
     end
   end

data/lib/generapp/actions/production.rb

@@ -1,5 +1,7 @@
 module Generapp
-  module Actions
+  module Actions #:nodoc
+    # App production environment
+    # associated actions
     module Production
       def configure_newrelic
         template 'config/newrelic.yml.erb', 'config/newrelic.yml'

data/lib/generapp/actions/test.rb

@@ -1,5 +1,7 @@
 module Generapp
-  module Actions
+  module Actions #:nodoc
+    # App test environment
+    # associated actions
     module Test
       def generate_rspec
         generate 'rspec:install'
@@ -27,8 +29,12 @@ module Generapp
       end
 
       def spec_folders
-        %w(spec/lib spec/controllers spec/helpers spec/support/matchers spec/support/mixins spec/support/shared_examples).each do |dir|
-          empty_directory_with_keep_file "#{dir}"
+        %w(spec/lib spec/controllers
+           spec/helpers
+           spec/support/matchers
+           spec/support/mixins
+           spec/support/shared_examples).each do |dir|
+          empty_directory_with_keep_file dir
         end
       end
 

data/lib/generapp/actions/views.rb

@@ -1,5 +1,7 @@
 module Generapp
-  module Actions
+  module Actions #:nodoc
+    # App views configuration
+    # associated actions
     module Views
       def create_shared_directory
         empty_directory_with_keep_file 'app/views/shared'

data/lib/generapp/app_builder.rb

@@ -1,12 +1,7 @@
 require 'rails/generators/rails/app/app_generator'
-require 'generapp/actions/develop'
-require 'generapp/actions/test'
-require 'generapp/actions/production'
-require 'generapp/actions/views'
-require 'generapp/actions/configuration'
-require 'generapp/actions/database'
 
 module Generapp
+  # Rails app builder customizations
   class AppBuilder < ::Rails::AppBuilder
     include Generapp::Actions::Develop
     include Generapp::Actions::Test
@@ -38,13 +33,13 @@ module Generapp
     end
 
     def init_git
-      run 'git init'
+      git :init
     end
 
     def setup_bundler_audit
       copy_file 'tasks/bundler_audit.rake',
                 'lib/tasks/bundler_audit.rake'
-      append_file 'Rakefile', %{\ntask default: "bundler:audit"\n}
+      append_file 'Rakefile', "\ntask default: 'bundler:audit'\n"
     end
 
     def setup_spring

data/lib/generapp/generators/app_generator.rb

@@ -2,18 +2,30 @@ require 'rails/generators'
 require 'rails/generators/rails/app/app_generator'
 
 module Generapp
-  module Generators
+  module Generators #:nodoc
+    # Rails App generator
     class AppGenerator < ::Rails::Generators::AppGenerator
-      class_option :database, type: :string, aliases: '-d', default: 'postgresql',
-                   desc: "Configure for selected database (options: #{DATABASES.join("/")})"
-
-      class_option :skip_test_unit, type: :boolean, aliases: '-T', default: true,
+      class_option :database,
+                   type: :string,
+                   aliases: '-d',
+                   default: 'postgresql',
+                   desc: "Configure for selected database (options: #{DATABASES.join('/')})"
+
+      class_option :skip_test_unit,
+                   type: :boolean,
+                   aliases: '-T',
+                   default: true,
                    desc: 'Skip Test::Unit files'
 
-      class_option :skip_turbolinks, type: :boolean, default: true,
+      class_option :skip_turbolinks,
+                   type: :boolean,
+                   default: true,
                    desc: 'Skip turbolinks gem'
 
-      class_option :skip_bundle, type: :boolean, aliases: '-B', default: true,
+      class_option :skip_bundle,
+                   type: :boolean,
+                   aliases: '-B',
+                   default: true,
                    desc: "Don't run bundle install"
 
       def finish_template
@@ -43,46 +55,37 @@ module Generapp
 
       def setup_development_environment
         say 'Setting up the development environment'
-        build :raise_on_delivery_errors
-        build :add_bullet_gem_configuration
-        build :configure_dalli
-        build :configure_generators
-        build :generate_annotate
-        build :add_secrets
+        Generapp::Actions::Develop.instance_methods(false).each do |action|
+          build action.to_sym
+        end
       end
 
       def setup_test_environment
         say 'Setting up the test environment'
-        build :generate_rspec
-        build :configure_rspec
-        build :enable_database_cleaner
-        build :enable_devise_tests
-        build :provide_shoulda_matchers_config
-        build :spec_folders
-        build :configure_coverage
-        build :configure_ci
+        Generapp::Actions::Test.instance_methods(false).each do |action|
+          build action.to_sym
+        end
       end
 
       def setup_production_environment
         say 'Setting up the production environment'
-        build :configure_newrelic
-        build :configure_rack_timeout
+        Generapp::Actions::Production.instance_methods(false).each do |action|
+          build action.to_sym
+        end
       end
 
       def create_generapp_views
         say 'Creating views'
-        build :create_shared_directory
-        build :create_shared_flashes
-        build :create_shared_javascripts
-        build :create_application_layout
+        Generapp::Actions::Views.instance_methods(false).each do |action|
+          build action.to_sym
+        end
       end
 
       def configure_app
         say 'Configuring app'
-        build :setup_default_rake_task
-        build :configure_puma
-        build :set_up_foreman
-        build :generate_devise
+        Generapp::Actions::Configuration.instance_methods(false).each do |action|
+          build action.to_sym
+        end
       end
 
       def setup_stylesheets

data/lib/generapp/version.rb

@@ -1,5 +1,13 @@
+# frozen_string_literal: true
+
+# Rails app generator with some minor modification and customizations
+# Allows to jump start a project
+# with some of Koombea's standards and practices
 module Generapp
+  # Default Rails Version
   RAILS_VERSION = '~> 4.2.0'.freeze
+  # Default Ruby Version
   RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
-  VERSION = '0.2.0'.freeze
+  # Gem Version
+  VERSION = '0.3.0'.freeze
 end

data/lib/generapp.rb

@@ -1,12 +1,23 @@
+# Rails app generator with some minor modification and customizations
+# Allows to jump start a project
+# with some of Koombea's standards and practices
 module Generapp
+  # Gem root folder
   def self.root
     File.dirname __dir__
   end
 
+  # Gem template folder
   def self.templates
     File.join root, 'templates'
   end
 end
 require 'generapp/version'
+require 'generapp/actions/configuration'
+require 'generapp/actions/database'
+require 'generapp/actions/develop'
+require 'generapp/actions/production'
+require 'generapp/actions/test'
+require 'generapp/actions/views'
 require 'generapp/app_builder'
 require 'generapp/generators/app_generator'

data/templates/Gemfile.erb

@@ -2,30 +2,30 @@ source 'https://rubygems.org'
 
 ruby '<%= Generapp::RUBY_VERSION %>'
 
-gem 'devise'
-gem 'dalli' # caching
-gem 'honeybadger', '~> 2.0'
-gem 'jquery-rails'
-gem 'newrelic_rpm'
-gem 'pg'
+gem 'devise' # User authentication
+gem 'dalli' # Caching
+gem 'honeybadger', '~> 2.0' # Error reporting
+gem 'jquery-rails' # jQuery
+gem 'newrelic_rpm' # Performance reports
+gem 'pg' # Postgres
 gem 'puma' # Use Puma as the app server
 gem 'rails', '<%= Generapp::RAILS_VERSION %>'
 gem 'sass-rails', '~>5.0'
 gem 'uglifier'
 
 group :development do
-  gem 'annotate'
+  gem 'annotate' # Schema model annotation
   gem 'better_errors'
   gem 'binding_of_caller'
-  gem 'bullet'
-  gem 'lol_dba', require: false
+  gem 'bullet' # N+1 queries reporter
+  gem 'lol_dba', require: false # Missing index reporter
   gem 'quiet_assets'
-  gem 'parallel_tests'
-  gem 'rails-erd'
+  gem 'rails-erd' # ER Diagrams
   gem 'spring'
 end
 
 group :development, :test do
+  gem 'brakeman', require: false
   gem 'bundler-audit', require: false
   gem 'factory_girl_rails'
   gem 'figaro' # Secrets
@@ -40,7 +40,7 @@ group :test do
   gem 'faker'
   gem 'shoulda-matchers'
   gem 'simplecov', require: false
-  gem 'timecop'
+  gem 'timecop' # Time manipulation
 end
 
 group :production do

data/templates/config/postgresql_database.yml.erb

@@ -16,5 +16,3 @@ production: &deploy
   url:  <%%= ENV['DATABASE_URL'] %>
   pool: <%%= ENV['DB_POOL'] || ENV['MAX_THREADS'] || 3 %>
   reaping_frequency: <%%= ENV['REAPING_FREQUENCY'] || nil %>
-
-staging: *deploy

data/templates/config/puma.rb

@@ -4,8 +4,8 @@ threads threads_count, threads_count
 
 preload_app!
 
-rackup      DefaultRackup
-port        ENV['PORT']     || 3000
+rackup DefaultRackup
+port ENV['PORT'] || 3000
 environment ENV['RACK_ENV'] || 'development'
 
 on_worker_boot do

data/templates/generapp_gitignore

@@ -15,6 +15,7 @@ public/uploads/*
 coverage/*
 ssl
 .bundle/*
+
 # Ignore Doc
 doc/*
 
@@ -34,11 +35,14 @@ backup*.dump
 .idea
 .idea/**/*
 
-#rbenv
+# rbenv
 .rbenv-gemsets
 
 # Ignore application configuration
 /config/application.yml
 
-#Ignore Vagrant
+# Ignore Vagrant
 .vagrant/
+
+# ER Diagram
+erd.pdf

data/templates/spec/rails_helper.rb

@@ -1,7 +1,16 @@
-require 'simplecov'
-
 # This file is copied to spec/ when you run 'rails generate rspec:install'
 ENV['RAILS_ENV'] ||= 'test'
+
+# Coverage
+require 'simplecov'
+# save to CircleCI's artifacts directory if we're on CircleCI
+if ENV['CIRCLE_ARTIFACTS']
+  dir = File.join(ENV['CIRCLE_ARTIFACTS'], 'coverage')
+  SimpleCov.coverage_dir(dir)
+end
+
+SimpleCov.start 'rails'
+
 require File.expand_path('../../config/environment', __FILE__)
 # Prevent database truncation if the environment is production
 abort('The Rails environment is running in production mode!') if Rails.env.production?

data/templates/tasks/auto_annotate_models.rake

@@ -5,32 +5,40 @@ if Rails.env.development?
   task :set_annotation_options do
     # You can override any of these by setting an environment variable of the
     # same name.
-    Annotate.set_defaults({
-                            'position_in_routes'      => 'after',
-                            'position_in_class'       => 'before',
-                            'position_in_test'        => 'before',
-                            'position_in_fixture'     => 'before',
-                            'position_in_factory'     => 'before',
-                            'position_in_serializer'  => 'before',
-                            'show_foreign_keys'       => 'true',
-                            'show_indexes'            => 'true',
-                            'simple_indexes'          => 'false',
-                            'model_dir'               => 'app/models',
-                            'include_version'         => 'false',
-                            'require'                 => '',
-                            'exclude_tests'           => 'true',
-                            'exclude_fixtures'        => 'true',
-                            'exclude_factories'       => 'false',
-                            'exclude_serializers'     => 'true',
-                            'ignore_model_sub_dir'    => 'false',
-                            'skip_on_db_migrate'      => 'false',
-                            'format_bare'             => 'true',
-                            'format_rdoc'             => 'false',
-                            'format_markdown'         => 'false',
-                            'sort'                    => 'false',
-                            'force'                   => 'false',
-                            'trace'                   => 'false',
-                          })
+    Annotate.set_defaults('routes'                  => 'true',
+                          'position_in_routes'      => 'after',
+                          'position_in_class'       => 'before',
+                          'position_in_test'        => 'before',
+                          'position_in_fixture'     => 'before',
+                          'position_in_factory'     => 'before',
+                          'position_in_serializer'  => 'before',
+                          'show_foreign_keys'       => 'true',
+                          'show_indexes'            => 'true',
+                          'simple_indexes'          => 'false',
+                          'model_dir'               => 'app/models',
+                          'root_dir'                => '',
+                          'include_version'         => 'false',
+                          'require'                 => '',
+                          'exclude_tests'           => 'true',
+                          'exclude_fixtures'        => 'true',
+                          'exclude_factories'       => 'false',
+                          'exclude_serializers'     => 'true',
+                          'exclude_scaffolds'       => 'true',
+                          'exclude_controllers'     => 'true',
+                          'exclude_helpers'         => 'true',
+                          'ignore_model_sub_dir'    => 'false',
+                          'ignore_columns'          => nil,
+                          'ignore_unknown_models'   => 'false',
+                          'hide_limit_column_types' => 'integer,boolean',
+                          'skip_on_db_migrate'      => 'false',
+                          'format_bare'             => 'true',
+                          'format_rdoc'             => 'false',
+                          'format_markdown'         => 'false',
+                          'sort'                    => 'false',
+                          'force'                   => 'false',
+                          'trace'                   => 'false',
+                          'wrapper_open'            => nil,
+                          'wrapper_close'           => nil)
   end
 
   Annotate.load_tasks

data/templates/tasks/bundler_audit.rake

@@ -1,8 +1,8 @@
 if Rails.env.development? || Rails.env.test?
-  require "bundler/audit/cli"
+  require 'bundler/audit/cli'
 
   namespace :bundler do
-    desc "Updates the ruby-advisory-db and runs audit"
+    desc 'Updates the ruby-advisory-db and runs audit'
     task :audit do
       %w(update check).each do |command|
         Bundler::Audit::CLI.start [command]