kazan 0.1.0

data/lib/kazan/generators/app_generator.rb

@@ -0,0 +1,177 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Kazan
+  class AppGenerator < Rails::Generators::AppGenerator
+    hide!
+
+    class_option :database, type: :string, aliases: '-d', default: 'postgresql',
+      desc: "Configure for selected database (options: #{DATABASES.join("/")})"
+
+    class_option :skip_test, type: :string, default: '--skip-test-unit'
+    class_option :skip_action_cable, type: :string, default: '--skip-action-cable'
+
+    class_option :sidekiq, type: :string, default: ''
+    class_option :clockwork, type: :string, default: ''
+    class_option :static, type: :string, default: ''
+
+    def finish_template
+      invoke :customization
+      super
+    end
+
+    def customization
+      invoke :setup_ruby
+      invoke :setup_gems
+      invoke :setup_secrets
+      invoke :setup_puma
+      invoke :setup_development_environment
+      invoke :setup_test_environment
+      invoke :setup_production_environment
+      invoke :setup_database
+
+      unless options[:api]
+        invoke :setup_assets
+        invoke :setup_helpers
+      end
+
+      invoke :setup_clockwork if options[:clockwork]
+      invoke :setup_sidekiq if options[:sidekiq]
+      invoke :setup_static if options[:static]
+
+      invoke :setup_error_pages
+      invoke :setup_bundler_audit
+      invoke :setup_spring
+      invoke :setup_empty_directories
+      invoke :setup_project_repository
+      invoke :outro
+    end
+
+    def setup_ruby
+      say 'Setup ruby'
+      build :ruby_version
+    end
+
+    def setup_gems
+      say 'Setup gems'
+      build :gemfile_api if options[:api]
+    end
+
+    def setup_secrets
+      say 'Setup secrets'
+      build :dotenvs
+      build :settings
+    end
+
+    def setup_puma
+      say 'Setup puma'
+      build :puma_config
+    end
+
+    def setup_development_environment
+      say 'Setup development environment'
+      build :exception_on_delivery_errors
+      build :exception_on_unpermitted_parameters
+      build :exception_on_missing_translations
+      build :letter_opener_config
+      build :bullet_config
+      build :foreman_config
+      build :rails_generators_config
+
+      unless options[:api]
+        build :quiet_assets_config
+      end
+    end
+
+    def setup_test_environment
+      say 'Setup test environment'
+      build :exception_on_missing_assets_in_test
+      build :spec_translations_config
+      build :spec_action_mailer_config
+      build :spec_database_cleaner_config
+      build :spec_shoulda_matchers_config
+      build :spec_factory_girl_config
+      build :rspec_config
+      build :rspec_replace_config
+    end
+
+    def setup_production_environment
+      say 'Setup production environment'
+      build :smtp_config
+      build :rack_timeout_config
+      build :rack_canonical_host_config
+      build :rack_deflater_config
+      build :rollbar_config
+    end
+
+    def setup_database
+      say 'Setup database'
+      build :postgres_config if options[:database] == 'postgresql'
+      build :database_tables
+    end
+
+    def setup_assets
+      say 'Setup assets'
+      build :shared_views_directory
+      build :shared_flash
+      build :shared_javascript
+      build :shared_styles
+      build :assets_config
+    end
+
+    def setup_helpers
+      build :simple_form_config
+      build :rack_mini_profiler_config
+    end
+
+    def setup_clockwork
+    end
+
+    def setup_sidekiq
+    end
+
+    def setup_static
+      say 'Setup static'
+
+      build :stylesheets_gems
+      build :stylesheets_manifest
+      build :refils
+      build :bitters
+    end
+
+    def setup_error_pages
+      say 'Customizing the 500/404/422 pages'
+      build :static_pages
+    end
+
+    def setup_bundler_audit
+      say 'Setup bundler audit'
+      build :bundler_audit_config
+    end
+
+    def setup_spring
+      say 'Setup spring binstubs'
+      build :spring
+    end
+
+    def setup_empty_directories
+      say 'Setup empty directories'
+      build :empty_directories
+    end
+
+    def setup_project_repository
+      say 'Setup git reposirory'
+      build :init_commit
+    end
+
+    def outro
+      say 'Last preparation'
+    end
+
+    protected
+
+    def get_builder_class
+      Kazan::AppBuilder
+    end
+  end
+end

data/lib/kazan/generators/clockwork_generator.rb

@@ -0,0 +1,7 @@
+require 'rails/generators'
+
+module Kazan
+  class ClockworkGenerator < Rails::Generators::Base
+
+  end
+end

data/lib/kazan/generators/sidekiq_generator.rb

@@ -0,0 +1,7 @@
+require 'rails/generators'
+
+module Kazan
+  class SidekiqGenerator < Rails::Generators::Base
+
+  end
+end

data/lib/kazan/version.rb

@@ -0,0 +1,5 @@
+module Kazan
+  VERSION = '0.1.0'.freeze
+  RAILS_VERSION = '~> 5.0.0'.freeze
+  RUBY_PROJECT_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip.freeze
+end

data/lib/kazan.rb

@@ -0,0 +1,5 @@
+require "kazan/version"
+require "kazan/generators/app_generator"
+require "kazan/actions"
+require "kazan/app_builder"
+

data/spec/kazan_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Kazan do
+  describe 'version' do
+    subject { Kazan::VERSION }
+
+    it { is_expected.not_to be_nil }
+  end
+
+  describe 'rails version' do
+    subject { Kazan::RUBY_PROJECT_VERSION }
+
+    it { is_expected.not_to be nil }
+  end
+
+  describe 'ruby version' do
+    subject { Kazan::RAILS_VERSION }
+
+    it { is_expected.not_to be_nil }
+  end
+end

data/spec/project_spec.rb

@@ -0,0 +1,222 @@
+require 'spec_helper'
+
+RSpec.describe 'Project with configuration' do
+  before(:all) do
+    setup_app_dependencies
+    run_app_generator
+  end
+
+  after(:all) do
+    drop_app_database
+  end
+
+  BINSTUBS = [
+    'rake',
+    'rails',
+    'rspec'
+  ]
+
+  SETTINGS = [
+    'Gemfile',
+    'Procfile',
+    'README.md',
+    # 'browserList',
+    '.ruby-version',
+    '.gitignore',
+    '.env.development.example',
+    '.env.production',
+  ]
+
+  CONFIGS = [
+    'database.yml',
+    'database.yml.example',
+    'puma.rb',
+    'settings.yml',
+    'smtp.rb'
+  ]
+
+  INITIALIZERS = [
+    'bullet.rb',
+    'errors.rb',
+    'json_encoding.rb',
+    'rollbar.rb'
+  ]
+
+  GEMS = [
+    'annotate',
+    'autoprefixer-rails',
+    'awesome_print',
+    'better_errors',
+    'bullet',
+    'bundler-audit',
+    'capybara',
+    'config',
+    'database_cleaner',
+    'dotenv',
+    'factory_girl_rails',
+    'faker',
+    'flutie',
+    'foreman',
+    'formulaic',
+    'jquery-rails',
+    'launchy',
+    'letter_opener',
+    'normalize-rails',
+    'pg',
+    'pry-byebug',
+    'pry-rails',
+    'puma',
+    'rack-mini-profiler',
+    'rack-canonical-host',
+    'rack-timeout',
+    'recipient_interceptor',
+    'rails',
+    'rails-i18n',
+    'rollbar',
+    'rspec-rails',
+    'sass-rails',
+    'simplecov',
+    'shoulda-matchers',
+    'sprockets', '>= 3.0.0',
+    'sprockets-es6',
+    'timecop',
+    'webmock',
+    'web-console',
+    'uglifier'
+  ]
+
+  RSPEC = [
+    'rails_helper.rb',
+    'spec_helper.rb'
+  ]
+
+  SUPPORTS = [
+    'action_mailer.rb',
+    'database_cleaner.rb',
+    'i18n.rb',
+    'shoulda_matchers.rb'
+  ]
+
+  VIEWS = [
+    '_flashes.html.erb',
+    '_javascript.html.erb',
+    '_styles.html.erb'
+  ]
+
+  describe 'spring bin' do
+    subject { File }
+
+    it { is_expected.to exist("#{project_path}/bin/spring") }
+  end
+
+  BINSTUBS.each do |bin_stub|
+    describe bin_stub do
+      subject { IO.read("#{project_path}/bin/#{bin_stub}") }
+
+      it { is_expected.to match(/spring/) }
+    end
+  end
+
+  SETTINGS.each do |config|
+    describe config do
+      subject { load_file config }
+
+      it { is_expected.to be_truthy}
+    end
+  end
+
+  CONFIGS.each do |config|
+    describe config do
+      subject { load_file "config/#{config}" }
+
+      it { is_expected.to be_truthy }
+    end
+  end
+
+  INITIALIZERS.each do |initializer|
+   describe initializer do
+     subject { load_file "config/initializers/#{initializer}" }
+
+     it { is_expected.to be_truthy }
+   end
+  end
+
+  # describe 'simple_from.rb' do
+    # subject { load_file 'config/initializers/simple_form.rb' }
+
+     # it { is_expected.to be_truthy }
+   # end
+
+  RSPEC.each do |helper|
+    describe helper do
+      subject { load_file "spec/#{helper}" }
+
+      it { is_expected.to be_truthy }
+    end
+  end
+
+  SUPPORTS.each do |support|
+    describe support do
+      subject { load_file "spec/support/#{support}" }
+
+      it { is_expected.to be_truthy }
+    end
+  end
+
+  VIEWS.each do |view|
+    describe view do
+      subject { load_file "app/views/layouts/shared/#{view}" }
+
+      it { is_expected.to be_truthy }
+    end
+  end
+
+  describe 'Gemfile' do
+    subject { load_file 'Gemfile' }
+
+    GEMS.each do |gem|
+      it { is_expected.to include gem }
+    end
+  end
+
+  describe 'Rakefile' do
+    subject { load_file 'Rakefile' }
+
+    it { is_expected.to match(/bundler:audit/) }
+  end
+
+  describe 'application.rb' do
+    subject { load_file 'config/application.rb' }
+
+    it { is_expected.to match(/action_on_unpermitted_parameters = :raise/) }
+    it { is_expected.to match(/config.generators/) }
+    it { is_expected.to match(/config.assets.quiet = true/) }
+  end
+
+  describe 'environments/development.rb' do
+    subject { load_file 'config/environments/development.rb' }
+
+    it { is_expected.to be_truthy }
+    it { is_expected.to match(/raise_delivery_errors = true/) }
+    it { is_expected.to match(/action_mailer.default_url_options/) }
+    it { is_expected.to match(/action_mailer.delivery_method/) }
+    it { is_expected.to match(/raise_on_missing_translations = true/) }
+  end
+
+  describe 'environments/test.rb' do
+    subject { load_file 'config/environments/test.rb' }
+
+    it { is_expected.to be_truthy }
+    it { is_expected.to match(/config.assets.raise_runtime_errors = true/) }
+    it { is_expected.to match(/raise_on_missing_translations = true/) }
+  end
+
+  describe 'environments/staging.rb' do
+  end
+
+  describe 'environments/production.rb' do
+    subject { load_file 'config/environments/production.rb' }
+
+    it { is_expected.to be_truthy }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+
+Dir['./spec/support/**/*.rb'].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include KazanSpecHelpers
+end

data/spec/support/hooks.rb

@@ -0,0 +1,15 @@
+RSpec.configure do |config|
+  config.before(:all) do
+    create_temp_directory
+  end
+
+  config.before(:each) do
+  end
+
+  config.after(:each) do
+  end
+
+  config.after(:all) do
+    remove_temp_project_directory
+  end
+end

data/spec/support/kazan_spec_helpers.rb

@@ -0,0 +1,71 @@
+require 'rails'
+
+module KazanSpecHelpers
+  APP_NAME = 'kazan_spec_app'
+
+  def create_temp_directory
+    FileUtils.mkdir_p(temp_path)
+  end
+
+  def remove_temp_project_directory
+    FileUtils.rm_rf(project_path)
+  end
+
+  def run_app_generator(arguments = nil)
+    arguments = "--path=#{root_path} #{arguments}"
+    Dir.chdir(temp_path) do
+      Bundler.with_clean_env do
+        `
+        #{bin_path} #{APP_NAME} #{arguments}
+        `
+      end
+    end
+  end
+
+  def setup_app_dependencies
+    if File.exist?(project_path)
+      Dir.chdir(project_path) do
+        Bundler.with_clean_env do
+          `bundle check || bundle install`
+        end
+      end
+    end
+  end
+
+  def drop_app_database
+    if File.exist?(project_path)
+      Dir.chdir(project_path) do
+        Bundler.with_clean_env do
+          `rake db:drop`
+        end
+      end
+    end
+  end
+
+  def project_path
+    @temp_project_path ||= Pathname.new("#{temp_path}/#{APP_NAME}")
+  end
+
+  def temp_project_name
+    APP_NAME.humanize
+  end
+
+  def load_file(file_name)
+    IO.read("#{project_path}/#{file_name}")
+  end
+
+  private
+
+  def temp_path
+    @temp_path ||= Pathname.new("#{root_path}/temp")
+  end
+
+  def bin_path
+    File.join(root_path, 'bin', 'kazan')
+  end
+
+  def root_path
+    File.expand_path('../../../', __FILE__)
+  end
+end
+

data/templates/Gemfile.api.erb

@@ -0,0 +1,53 @@
+source "https://rubygems.org"
+ruby "<%= Kazan::RUBY_PROJECT_VERSION %>"
+
+gem 'rails', "<%= Kazan::RAILS_VERSION %>"
+gem 'rails-i18n'
+gem 'dotenv-rails'
+gem 'config'
+
+gem 'pg'
+
+gem 'rollbar'
+
+gem 'recipient_interceptor'
+gem 'rack-canonical-host'
+gem 'puma'
+
+group :development do
+  gem 'annotate'
+  gem 'better_errors'
+  gem 'foreman', '~> 0.78.0'
+  gem 'letter_opener'
+  gem 'listen'
+  gem 'spring'
+  gem 'spring-commands-rspec'
+  gem 'web-console'
+end
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'bullet'
+  gem 'bundler-audit', '>= 0.5.0', require: false
+  gem 'faker'
+  gem 'factory_girl_rails'
+  gem 'pry-byebug'
+  gem 'pry-rails'
+  gem 'rspec-rails', '~> 3.5.0.beta4'
+end
+
+group :test do
+  gem 'database_cleaner'
+  gem 'shoulda-matchers'
+  gem 'simplecov', require: false
+  gem 'timecop'
+  gem 'webmock'
+end
+
+group :development, :staging do
+  gem 'rack-mini-profiler', require: false
+end
+
+group :staging, :production do
+  gem 'rack-timeout'
+end

data/templates/Gemfile.erb

@@ -0,0 +1,68 @@
+source 'https://rubygems.org'
+ruby "<%= Kazan::RUBY_PROJECT_VERSION %>"
+
+gem 'rails', "<%= Kazan::RAILS_VERSION %>"
+gem 'rails-i18n'
+gem 'dotenv-rails'
+gem 'config'
+
+gem 'pg'
+
+gem 'autoprefixer-rails'
+gem 'normalize-rails', '~> 3.0.0'
+gem 'sass-rails', '~> 5.0'
+
+gem 'jquery-rails'
+gem 'sprockets', '>= 3.0.0'
+gem 'sprockets-es6'
+gem 'uglifier'
+
+gem 'flutie'
+gem 'simple_form'
+
+gem 'rollbar'
+
+gem 'recipient_interceptor'
+gem 'rack-canonical-host'
+gem 'puma'
+
+group :development do
+  gem 'annotate'
+  gem 'better_errors'
+  gem 'foreman', '~> 0.78.0'
+  gem 'letter_opener'
+  gem 'listen'
+  gem 'spring'
+  gem 'spring-commands-rspec'
+  gem 'web-console'
+end
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'bullet'
+  gem 'bundler-audit', '>= 0.5.0', require: false
+  gem 'faker'
+  gem 'factory_girl_rails'
+  gem 'pry-byebug'
+  gem 'pry-rails'
+  gem 'rspec-rails', '~> 3.5.0.beta4'
+end
+
+group :test do
+  gem 'capybara'
+  gem 'database_cleaner'
+  gem 'formulaic'
+  gem 'launchy'
+  gem 'shoulda-matchers'
+  gem 'simplecov', require: false
+  gem 'timecop'
+  gem 'webmock'
+end
+
+group :development, :staging do
+  gem 'rack-mini-profiler', require: false
+end
+
+group :staging, :production do
+  gem 'rack-timeout'
+end

data/templates/Procfile.erb

@@ -0,0 +1 @@
+server: rails server

data/templates/README.md.erb

@@ -0,0 +1,16 @@
+<%= app_name.humanize %>
+
+## Requirements
+
+Ensure that you have installed:
+
+- Ruby "<%= Kazan::RUBY_PROJECT_VERSION %>"
+- Rails "<%= Kazan::RAILS_VERSION %>"
+
+## Getting started
+
+After you have cloned this repo, run this setup script to set up your machine
+with the necessary dependencies to run and test this app:
+
+  $ ./bin/setup
+

data/templates/_flashes.html.erb

@@ -0,0 +1,7 @@
+<% if flash.any? %>
+  <div class="flashes">
+    <% user_facing_flashes.each do |key, value| -%>
+      <div class="flash-<%= key %>"><%= value %></div>
+    <% end -%>
+  </div>
+<% end %>