railman 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc1920be3b4235bb10d818b3b348a794035d0298
-  data.tar.gz: bd8be02573c1b1757332c591117c5f95d16a93ea
+  metadata.gz: 2452bb4c3c783b6efe3694e9582281bbcd8bc5f9
+  data.tar.gz: 63fbcfea9787bb517762ccc91b06a183de7844ca
 SHA512:
-  metadata.gz: f3637c9323a23861e65e360f3ee69fbdde437ba4ed1ce370ebcf367b9b02891b3c5bb4f5dfcb3a009256fe396d3f992c726b84cc9dd0383d88a6f788e9ef5d61
-  data.tar.gz: 82c00e37a34acc67061c0112e2ff6627d6dbbeceab192aaa71bfb78927b32361cd60c33c546f81fc53e8c18a5a53a21d860a169a4a18ee65b4a8050759327e0f
+  metadata.gz: 4b0ecbc34ee75ad020c4516b20615515aeaad8ad67083d3f2b26bcd367f76581bb9397285fcc9bc8af9d7f5c688bcc70fb8fa9aedce93110289a0c4688375b74
+  data.tar.gz: 21daa85a4cbc6f3c4e6c154a94c83d64a92518bcc904aaf500fa26333a0f57a98d4ec28f37e4bfff7111c6c7bbd7f84076f0ba0c84318e823c451233ed46badc

data/lib/railman/cli.rb

@@ -17,6 +17,22 @@ module Railman
     desc "new APPNAME", "Create new rails application named APPNAME"
     def new(app_name)
       say "Create a new rails application named: #{app_name}", :green
+      apply_rails_template(app_name)
+      say "The rails application '#{app_name}' was successfully created.", :green
+      say "Please check the settings in .env", :blue
+    end
+
+    desc "upgrade APPNAME", "Upgrade the rails upplication named APPNAME"
+    def upgrade(app_name)
+      puts "TODO upgrade the rails application: #{app_name}"
+      apply_rails_template(app_name, false)
+      say "The rails application '#{app_name}' was successfully upgraded.", :green
+      say "Please check the settings in .env", :blue
+    end
+
+    private
+
+    def apply_rails_template(app_name, create = true)
       @app_name = app_name
       @class_name = Thor::Util.camel_case(app_name)
       @admin_email = ask("What is the adminitrator email address?")
@@ -42,16 +58,11 @@ module Railman
       Dir.chdir app_name do
         run "bundle install"
         run "chmod +x bin/*"
-        create_local_git_repository
-        create_remote_git_repository(@repository) if yes?("Do you want me to create bitbucket repository named #{app_name}? (y/n)")
+        if create
+          create_local_git_repository
+          create_remote_git_repository(@repository) if yes?("Do you want me to create bitbucket repository named #{app_name}? (y/n)")
+        end
       end
-      say "The rails application '#{app_name}' was successfully created.", :green
-      say "Please check the settings in .env", :blue
-    end
-
-    desc "update APPNAME", "Update the rails upplication named APPNAME"
-    def update(app_name)
-      puts "TODO update the rails application: #{app_name}"
     end
   end
 end

data/lib/railman/version.rb

@@ -1,3 +1,3 @@
 module Railman
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/templates/rails_app/.envrc

@@ -1,3 +1 @@
-if [ "$(type -t direnv_load)" = 'function' ]; then
-  PATH_add bin
-fi
+PATH_add bin

data/templates/rails_app/.gitignore

@@ -1,7 +1,14 @@
 .DS_Store
-/.idea
-/.bundle
-/log/*
+.idea
+.bundle
+log/*
 !/log/.keep
-/tmp
+tmp
 .env
+
+test/coverage
+test/reports
+test/screenshots
+
+.sass-cache
+public/assets

data/templates/rails_app/.simplecov

@@ -0,0 +1,27 @@
+require 'simplecov-rcov'
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+
+SimpleCov.start do
+  coverage_dir 'test/coverage'
+
+  load_profile 'rails'
+
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Models', 'app/models'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Libraries', 'lib'
+
+  add_filter 'db'
+  add_filter 'test'
+  add_filter 'config'
+  add_filter 'vendor'
+end
+
+

data/templates/rails_app/Eyefile.tt

@@ -38,4 +38,12 @@ Eye.application APP_NAME do
       stop_command 'kill -QUIT {PID}'
     end
   end
+
+  process :sidekiq do
+    start_command "./bin/sidekiq -e #{RAILS_ENV} -C ./config/sidekiq.yml"
+    pid_file "./tmp/pids/sidekiq.pid"
+    stdall "log/sidekiq.log"
+    daemonize true
+    stop_signals [:USR1, 0, :TERM, 10.seconds, :KILL]
+  end
 end

data/templates/rails_app/Gemfile

@@ -17,10 +17,14 @@ gem 'bootstrap_form', '2.3.0'    # form helper for twitter bootstrap
 gem 'bootstrap-datepicker-rails', '1.4.0'     # bootstrap-datepicker
 gem 'active_link_to', '1.0.3'    # automatically mark navigation link as active
 
-gem 'dalli'   # memcached client
-gem 'kgio'    # gives dalli 20-30% performance boost
+gem 'dalli', '2.7.6'  # memcached client
+gem 'kgio', '2.10.0'  # gives dalli 20-30% performance boost
+gem 'redis-session-store'   # store sessions in redis
 
-# todo add sidekiq for backgroud jobs
+gem 'sidekiq', '4.1.1'    # backgroud jobs
+gem 'sidekiq-scheduler', '2.0.6'  # scheduled background jobs
+gem 'redis-namespace', '1.5.2'    # share same redis instance for multiple applications
+gem 'sinatra', '1.4.6', :require => false    # for sidekiq-web
 
 gem 'unicorn', '4.8.3'  # use unicorn as production server
 gem 'unicorn-rails', '1.1.0'  # use unicorn as local server
@@ -33,18 +37,21 @@ group :development do
   gem 'better_errors'   # better error pages in development
   gem 'binding_of_caller'   # repl on the error page
   gem 'quiet_assets'    # less noise in development log
+  gem 'letter_opener', '1.4.1'    # for email tests in development
   # gem 'rack-mini-profiler'
   # gem 'flamegraph'    # mini-profiler flamegraph extension (?pp=flamegraph)
 end
 
 group :test do
   gem 'minitest-reporters', '1.1.7'   # generate xml for jenkins
+  gem 'minitest-screenshot-reporter', '0.0.2'   # generate screenshots on capybara errors
   gem 'simplecov', require: false     # generate coverage reports
   gem 'simplecov-rcov', '0.2.3', require: false   # generate coverage reports for jenkins
   gem 'capybara', '2.6.0'   # dsl for browser tests
   gem 'capybara_minitest_spec', '1.0.5'   # capybara rspec-style matchers (must_have...)
   gem 'selenium-webdriver', '2.49.0'      # use real browser for webtests
   gem 'poltergeist', '1.8.1'      # headless tests with phantom.js
+  gem 'database_cleaner', '1.5.2'     # cleanup test database after every integration test
 end
 
 # put additional application-specific gems to Gemfile.local

data/templates/rails_app/bin/sidekiq

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'sidekiq' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sidekiq', 'sidekiq')

data/templates/rails_app/bin/sidekiqctl

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'sidekiqctl' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sidekiq', 'sidekiqctl')

data/templates/rails_app/config/environments/development.rb

@@ -39,7 +39,10 @@ Rails.application.configure do
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
 
-  # TODO config.action_mailer.delivery_method = :letter_opener
+  config.action_mailer.delivery_method = :letter_opener
+
+  # Uncomment to test jobs with sidekiq locally. Start sidekiq with: sidekiq -C config/sidekiq.yml
+  # config.active_job.queue_adapter = :sidekiq
 
   config.action_mailer.default_url_options = { host: 'http://localhost:3000' }
 end

data/templates/rails_app/config/environments/production.rb

@@ -56,6 +56,7 @@ Rails.application.configure do
 
   # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
+  config.cache_store = :dalli_store, { namespace: ENV['APP_NAME'] }
 
   # Enable serving of images, stylesheets, and JavaScripts from an asset server.
   # config.action_controller.asset_host = 'http://assets.example.com'
@@ -88,10 +89,6 @@ Rails.application.configure do
   }
   config.action_mailer.default_url_options = { host: ENV['SMTP_DEFAULT_URL'] }
 
-  config.middleware.use ExceptionNotification::Rack,
-    email: {
-      email_prefix: ENV['EXCEPTION_NOTIFICATION_EMAIL_PREFIX'],
-      sender_address: ENV['EXCEPTION_NOTIFICATION_SENDER'],
-      exception_recipients: ENV['ADMIN_EMAIL']
-    }
+  # Use sidekiq as active job backend
+  config.active_job.queue_adapter = :sidekiq
 end

data/templates/rails_app/config/initializers/exception_notification.rb

@@ -0,0 +1,23 @@
+require 'exception_notification/rails'
+require 'exception_notification/sidekiq'
+
+ExceptionNotification.configure do |config|
+  # Ignore additional exception types.
+  # ActiveRecord::RecordNotFound, AbstractController::ActionNotFound and ActionController::RoutingError are already added.
+  # config.ignored_exceptions += %w{ActionView::TemplateError CustomError}
+
+  # Adds a condition to decide when an exception must be ignored or not.
+  # The ignore_if method can be invoked multiple times to add extra conditions.
+  config.ignore_if do |exception, options|
+    not Rails.env.production?
+  end
+
+  # Notifiers =================================================================
+
+  # Email notifier sends notifications by email.
+  config.add_notifier :email, {
+      :email_prefix         => ENV['EXCEPTION_NOTIFICATION_EMAIL_PREFIX'],
+      :sender_address       => ENV['EXCEPTION_NOTIFICATION_SENDER'],
+      :exception_recipients => ENV['ADMIN_EMAIL']
+  }
+end

data/templates/rails_app/config/initializers/session_store.rb.tt

@@ -1,3 +1,6 @@
 # Be sure to restart your server when you modify this file.
 
-Rails.application.config.session_store :cookie_store, key: '_<%= app_name %>_session'
+Rails.application.config.session_store :redis_session_store, {
+  key: "_<%= app_name %>_session",
+  redis: { key_prefix: "<%= app_name %>:", expire_after: 2.minutes }
+}

data/templates/rails_app/config/initializers/sidekiq.rb.tt

@@ -0,0 +1,19 @@
+require 'sidekiq/scheduler'
+
+# Configure Sidekiq Redis connection to use the '<%= app_name %>' namespace
+redis_config = { url: 'redis://localhost:6379', namespace: '<%= app_name %>' }
+
+Sidekiq.configure_server do |config|
+  config.redis = redis_config
+
+  #config.on(:startup) do
+  #  Sidekiq.schedule = YAML.load_file(File.expand_path("../../../config/scheduler.yml",__FILE__))
+  #  Sidekiq::Scheduler.reload_schedule!
+  #end
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = redis_config
+end
+
+

data/templates/rails_app/config/routes.rb

@@ -1,3 +1,20 @@
+require 'sidekiq/web'
+require 'sidekiq-scheduler/web'
+
+Sidekiq::Web.set :session_secret, Rails.application.secrets[:secret_token]
+Sidekiq::Web.set :sessions, Rails.application.config.session_options
+
+# used to authenticate the user in sidekiq-web
+class AdminConstraint
+  def matches?(request)
+    return false unless request.session[:user_id]
+    # todo user = User.find request.session[:user_id]
+    # todo user && user.admin?
+  end
+end
+
 Rails.application.routes.draw do
+  mount Sidekiq::Web => '/sidekiq' # todo , :constraints => AdminConstraint.new
+
   root 'home#index'
 end

data/templates/rails_app/config/scheduler.yml

@@ -0,0 +1,4 @@
+#recurring_hard_job:
+#  every: 10s
+#  class: "HardJob"
+#  queue: default

data/templates/rails_app/config/secrets.yml

@@ -16,7 +16,5 @@ development:
 test:
   secret_key_base: <%= ENV["SECRET_TOKEN"] %>
 
-# Do not keep production secrets in the repository,
-# instead read values from the environment.
 production:
   secret_key_base: <%= ENV["SECRET_TOKEN"] %>

data/templates/rails_app/config/sidekiq.yml

@@ -0,0 +1,14 @@
+# Configuration file for Sidekiq.
+# Options here can still be overridden by cmd line args.
+# Run with: sidekiq -C config/sidekiq.yml
+---
+:verbose: true
+#:pidfile: tmp/pids/sidekiq.pid
+:concurrency: 3
+:production:
+  :concurency: 10
+:timeout: 60
+:queues:
+  - paperclip
+  - default
+  - mailers

data/templates/rails_app/test/integration/homepage_test.rb.tt

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class HomepageTest < WebTest
+  test 'homepage' do
+    visit '/'
+    screenshot 'homepage'
+    must_have_content 'Welcome to: <%= @class_name %>'
+  end
+end

data/templates/rails_app/test/test_helper.rb

@@ -1,10 +1,66 @@
+require 'simplecov' if ENV['COVERAGE'] == 'true'
+
+# default rails test configuration
 ENV['RAILS_ENV'] ||= 'test'
 require File.expand_path('../../config/environment', __FILE__)
 require 'rails/test_help'
 
-class ActiveSupport::TestCase
+# use minitest-reporters to create xmls for jenkins and nicer terminal reporting
+require 'minitest/reporters'
+require 'minitest/reporters/screenshot_reporter'
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new,
+                          Minitest::Reporters::JUnitReporter.new,
+                          Minitest::Reporters::ScreenshotReporter.new]
+
+# default test class for unit tests
+class UnitTest < ActiveSupport::TestCase
   # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
   fixtures :all
+end
+
+# configure webtests with capybara and poltergeist (headless)
+require 'capybara/rails'
+require 'capybara_minitest_spec'
+require 'capybara/poltergeist'
+
+CAPYBARA_WINDOW_SIZE = [1024, 768]
+
+if ENV['HEADLESS'] == 'true'
+  # headless driver configuration
+  Capybara.register_driver :poltergeist do |app|
+    poltergeist_options = { debug: false, timeout: 30, js_errors: true, window_size: CAPYBARA_WINDOW_SIZE }
+    Capybara::Poltergeist::Driver.new(app, poltergeist_options)
+  end
+  Capybara.default_driver = :poltergeist
+else
+  # chrome browser driver configuration
+  Capybara.register_driver :selenium do |app|
+    Capybara::Selenium::Driver.new(app, :browser => :chrome)
+  end
+  Capybara.default_driver = :selenium
+  Capybara.current_session.driver.browser.manage.window.resize_to CAPYBARA_WINDOW_SIZE[0], CAPYBARA_WINDOW_SIZE[1]
+end
+Capybara.default_max_wait_time = 5   # how long should capybara wait for elements to appear on the page (ajax)
+
+# use database_cleaner to clean the database after every test with truncation, instead of using transactional fixtures
+require 'database_cleaner'
+DatabaseCleaner.strategy = :truncation
+
+# default test class for webtests
+class WebTest < ActionDispatch::IntegrationTest
+  include Capybara::DSL
+  extend Minitest::Spec::DSL
+  include Minitest::Reporters::Screenshot
+
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+
+  # disable transactional fixtures, as we use DatabaseCleaner
+  self.use_transactional_fixtures = false
 
-  # Add more helper methods to be used by all tests here...
+  # clean database after each test with database_cleaner
+  def after_teardown
+    super
+    DatabaseCleaner.clean
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: railman
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Igor Jancev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -165,6 +165,7 @@ files:
 - templates/rails_app/.envrc
 - templates/rails_app/.gitignore
 - templates/rails_app/.ruby-version
+- templates/rails_app/.simplecov
 - templates/rails_app/Capfile
 - templates/rails_app/Eyefile.tt
 - templates/rails_app/Gemfile
@@ -178,6 +179,7 @@ files:
 - templates/rails_app/app/controllers/concerns/.keep
 - templates/rails_app/app/controllers/home_controller.rb
 - templates/rails_app/app/helpers/application_helper.rb
+- templates/rails_app/app/jobs/.keep
 - templates/rails_app/app/mailers/.keep
 - templates/rails_app/app/models/.keep
 - templates/rails_app/app/models/concerns/.keep
@@ -190,6 +192,8 @@ files:
 - templates/rails_app/bin/rails
 - templates/rails_app/bin/rake
 - templates/rails_app/bin/setup
+- templates/rails_app/bin/sidekiq
+- templates/rails_app/bin/sidekiqctl
 - templates/rails_app/bin/spring
 - templates/rails_app/bin/unicorn
 - templates/rails_app/bin/unicorn_rails
@@ -206,18 +210,22 @@ files:
 - templates/rails_app/config/initializers/assets.rb
 - templates/rails_app/config/initializers/backtrace_silencers.rb
 - templates/rails_app/config/initializers/cookies_serializer.rb
+- templates/rails_app/config/initializers/exception_notification.rb
 - templates/rails_app/config/initializers/filter_parameter_logging.rb
 - templates/rails_app/config/initializers/inflections.rb
 - templates/rails_app/config/initializers/mime_types.rb
 - templates/rails_app/config/initializers/session_store.rb.tt
+- templates/rails_app/config/initializers/sidekiq.rb.tt
 - templates/rails_app/config/initializers/wrap_parameters.rb
 - templates/rails_app/config/locales/en.yml
 - templates/rails_app/config/locales/readme.txt
 - templates/rails_app/config/routes.rb
+- templates/rails_app/config/scheduler.yml
 - templates/rails_app/config/secrets.yml
 - templates/rails_app/config/server/letsencrypt.conf.tt
 - templates/rails_app/config/server/logrotate.conf.tt
 - templates/rails_app/config/server/nginx.conf.tt
+- templates/rails_app/config/sidekiq.yml
 - templates/rails_app/config/unicorn.rb.tt
 - templates/rails_app/db/seeds.rb
 - templates/rails_app/lib/assets/.keep
@@ -232,6 +240,7 @@ files:
 - templates/rails_app/test/fixtures/.keep
 - templates/rails_app/test/helpers/.keep
 - templates/rails_app/test/integration/.keep
+- templates/rails_app/test/integration/homepage_test.rb.tt
 - templates/rails_app/test/mailers/.keep
 - templates/rails_app/test/models/.keep
 - templates/rails_app/test/test_helper.rb