barebones 1.0.0.4 → 1.0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b6ecd5ef7ad77d57f2486703bce4fa9af974bca
-  data.tar.gz: 5b569a61a5ea35a644f79416b11ea8b04b5713ba
+  metadata.gz: a90979ce5a764eaa7d3275ca4d5d29954fafea68
+  data.tar.gz: f840ebf7dc6fe6f4e4dbd252cdfa9c5381b4cbba
 SHA512:
-  metadata.gz: 7c74b24b09689accfb663d7a4e861272a9c8d4d04724c47ab7f3a21a8464ebd78c6f11bb202f837dd2f5403b688615c590b5c65f5a4732953df3407993fd07c7
-  data.tar.gz: 0ee003b10f8701b285ff7bde5c733e9ebd637b3d6abea54b2d1818fdfd61a55e364a90278e5d2dfa6574d85131a09d2a4ad1b814fcb238cf240a5b35e28b2b83
+  metadata.gz: 5fd239cfd5c8bff6a76df5a44e6bfc0338612c7be0200af21a7e6d470506cd72ea7637b7b59d77217029abc54c4adad040400bc8f7b254bc5d98422693cee3a6
+  data.tar.gz: e982e2ecda8dab616929b3246334e00fdba4713470e736250f5c3606a2010e12e747058fef1dc162777e01d7928bf3a7c50806089b782a1241a6918260c14cc9

data/README.md

@@ -5,7 +5,7 @@ Barebones is my personal base Rails application. After developing a
 couple of Rails applications, I thought that there were some common
 gems and patterns that would be nice to have out of the box.
 
-#Installation
+## Installation
 Install the gem:  
 
     gem install barebones
@@ -14,10 +14,11 @@ Then run:
 
     barebones [AppName]
 
-## Flags
+### Flags
 If you don't like using any of the below gems or configurations for whatever reason, you can skip them:
 * --skip-api
 * --skip-resque
+* --skip-sidekiq
 * --skip-minitest
 * --skip-factory-girl
 * --skip-carrierwave
@@ -26,53 +27,58 @@ For example:
 
     barebones [AppName] --skip-api --skip-minitest
 
-#Gemfile
+## Gemfile
 Barebones' [Gemfile](templates/Gemfile.erb) includes various preconfigured gems such as:
-##File Uploading
+### Webserver
+* [Puma](https://github.com/puma/puma) for our default concurrent webserver. Configured to spawn on free Heroku instances [out of the box](config/puma.rb).
+
+
+### File Uploading
 * [Carrierwave](https://github.com/carrierwaveuploader/carrierwave) for file uploading
 * [Fog](https://github.com/fog/fog) for AWS/Google cloud storage
 * [MiniMagick](https://github.com/minimagick/minimagick) for image cropping/resizing and all that good stuff
 
-##Background Processing
+### Background Processing
+* [Sidekiq](https://github.com/mperham/sidekiq) for background workers. This is the default option.
 * [Resque](https://github.com/resque/resque) for background workers
 * [Resque-Scheduler](https://github.com/resque/resque-scheduler) for queueing workers in the future
 
-##Database
+### Database
 * [Postgres](https://rubygems.org/gems/pg/versions/0.18.3)
 
-##Dev/Testing
+### Dev/Testing
 * [Byebug](https://github.com/deivid-rodriguez/byebug) for debugging
 * [Pry Byebug](https://github.com/deivid-rodriguez/pry-byebug) for debugging background jobs
 * [Web Console](https://github.com/rails/web-console) for debugging views
 * [Awesome Print](https://github.com/awesome-print/awesome_print) for pretty printing command line objects
 
-##Testing
+### Testing
 * [Minitest](https://github.com/blowmage/minitest-rails) for TDD/BDD
 * [Minitest Reporters](https://github.com/kern/minitest-reporters) for customizable Minitest output formats
 * [Minitest Around](https://github.com/splattael/minitest-around) for database setup/teardown
 * [Mocha](https://github.com/freerange/mocha) for mocking and stubbing
 * [Database Cleaner](https://github.com/DatabaseCleaner/database_cleaner) to ensure a clean state during tests
 
-##API
+### API
 * [Jbuilder](https://github.com/rails/jbuilder) for building JSON structures
 * [oj](https://github.com/ohler55/oj) for faster JSON parsing (and a faster Jbuilder)
 * [oj_mimic_json](https://github.com/ohler55/oj_mimic_json)
 * [MultiJSON](https://github.com/intridea/multi_json)
 
-#Design Patterns
+## Design Patterns
 * Services (Pre-made folder)
 * [Custom Decorator Class](templates/barebones_decorator.rb.erb) (A custom subclass of SimpleDelegator)
 
-#API
+## API
 * [Routes](templates/routes.rb.erb) with API subdomain and version namespacing
 * [ApiConstraints](templates/api_constraints.rb.erb) for API version control
 * [Configurations/Ping endpoint](templates/configs_controller.rb) to test that the API works :)
 
-#Dependencies
+## Dependencies
 Barebones requires the latest version of Ruby (2.3.1), Rails (5.0.0), and
 PostgreSQL (9.4) on your local machine.
  
-#License
+## License
 Barebones is copyright © 2015-2016 Danny Yu.  
 It is free software, and may be redistributed under the terms specified in the [LICENSE] file.
 

data/barebones.gemspec

@@ -3,7 +3,7 @@ require "date"
 
 Gem::Specification.new do |s|
   s.name        = "barebones"
-  s.version     = "1.0.0.4"
+  s.version     = "1.0.0.5"
   s.date        = Date.today.to_s
   s.licenses    = ['MIT']
   s.summary     = "Rails template generator"

data/lib/barebones/builders/app_builder.rb

@@ -37,6 +37,10 @@ module Barebones
       create_file ".ruby-version", "#{Barebones::RUBY_VERSION}"
     end
 
+    def set_gemset
+      create_file ".ruby-gemset", "#{app_name.parameterize.underscore}"
+    end
+
     def setup_autoload_paths
       application_class_end_line = "#{spaces(2)}end\nend"
       inject_into_file "config/application.rb", 
@@ -146,7 +150,7 @@ module Barebones
         
     end    
 
-    def configure_active_job
+    def configure_active_job_for_resque
       application_class_end_line = "#{spaces(2)}end\nend"
       inject_into_file "config/application.rb", 
         before: application_class_end_line do
@@ -155,14 +159,27 @@ module Barebones
       end
     end
 
+    def configure_active_job_for_sidekiq
+      application_class_end_line = "#{spaces(2)}end\nend"
+      inject_into_file "config/application.rb", 
+        before: application_class_end_line do
+          "\n#{spaces(4)}# Set ActiveJob to use Sidekiq\n"\
+          "#{spaces(4)}config.active_job.queue_adapter = :sidekiq\n"
+      end
+    end
+
     def configure_redis
-      template "redis.rb", "config/initializers/redis.rb"
+      template "redis.rb.erb", "config/initializers/redis.rb"
     end
 
     def configure_resque
       template "resque.rb", "config/initializers/resque.rb"
     end
 
+    def configure_sidekiq
+      template "sidekiq.rb", "config/initializers/sidekiq.rb"
+    end
+
     def create_test_job
       template "test_job.rb", "app/jobs/test_job.rb"
     end
@@ -175,5 +192,10 @@ module Barebones
       template "carrierwave.rb", "config/initializers/carrierwave.rb"
     end
 
+    def configure_puma
+      template "Procfile", "Procfile"
+      template "puma.rb", "config/puma.rb", force: true
+    end
+
   end
 end

data/lib/barebones/generators/app_generator.rb

@@ -9,8 +9,11 @@ module Barebones
     class_option :skip_api, type: :boolean, default: false, 
       desc: "Skip creating an API. Default is false."
 
-    class_option :skip_resque, type: :boolean, default: false,
-      desc: "Skip using Resque. Default is false."
+    class_option :skip_resque, type: :boolean, default: true,
+      desc: "Skip using Resque. Default is true."
+
+    class_option :skip_sidekiq, type: :boolean, default: false, 
+      desc: "Skip using Sidekiq. Default is false."
 
     class_option :skip_minitest, type: :boolean, default: false,
       desc: "Skip using Minitest. Default is false."
@@ -25,6 +28,7 @@ module Barebones
       say "Invoking customizations..."
       invoke :setup_ruby
       invoke :configure_app
+      invoke :setup_webserver
       invoke :setup_routes
       invoke :setup_api
       invoke :setup_secrets
@@ -36,11 +40,7 @@ module Barebones
     def setup_ruby
       say "Setting ruby version..."
       build :set_ruby_version
-    end
-
-    def setup_routes
-      say "Setting up custom routes..."
-      build :customize_routes
+      build :set_gemset
     end
 
     def configure_app
@@ -48,6 +48,16 @@ module Barebones
       build :setup_autoload_paths
     end
 
+    def setup_webserver
+      say "Setting up webserver..."
+      invoke :setup_puma
+    end
+
+    def setup_routes
+      say "Setting up custom routes..."
+      build :customize_routes
+    end
+
     def setup_api
       unless options[:skip_api]
         say "Setting up an API..."
@@ -86,6 +96,7 @@ module Barebones
       invoke :setup_minitest
       invoke :setup_factory_girl
       invoke :setup_resque
+      invoke :setup_sidekiq
       invoke :setup_carrierwave
     end
 
@@ -106,7 +117,7 @@ module Barebones
     def setup_resque
       unless options[:skip_resque]
         say "Setting up Resque/Redis gems..."
-        build :configure_active_job
+        build :configure_active_job_for_resque
         build :configure_redis
         build :configure_resque
         build :create_test_job
@@ -114,6 +125,16 @@ module Barebones
       end
     end
 
+    def setup_sidekiq
+      unless options[:skip_sidekiq]
+        say "Setting up Sidekiq/Redis gems..."
+        build :configure_active_job_for_sidekiq
+        build :configure_redis
+        build :configure_sidekiq
+        build :create_test_job
+      end
+    end
+
     def setup_carrierwave
       unless options[:setup_carrierwave]
         say "Setting up Carrierwave gem..."
@@ -121,6 +142,11 @@ module Barebones
       end
     end
 
+    def setup_puma
+      say "Setting up Puma..."
+      build :configure_puma
+    end
+
     def outro
       say "\e[34mSweet, we're done!\e[0m"
     end

data/lib/barebones/version.rb

@@ -1,4 +1,4 @@
 module Barebones
-  RAILS_VERSION = "~> 5.0.0"
-  RUBY_VERSION = "2.3.1"
+  RAILS_VERSION = "~> 5.1"
+  RUBY_VERSION = "2.4.1"
 end

data/templates/Gemfile.erb

@@ -1,53 +1,68 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-ruby "<%= Barebones::RUBY_VERSION %>"
+ruby '<%= Barebones::RUBY_VERSION %>'
 
 # Defaults
-gem "rails", "<%= Barebones::RAILS_VERSION %>"
-gem "sass-rails", "~> 5.0"
-gem "uglifier", ">= 1.3.0"
-gem "jquery-rails"
-gem "turbolinks", "~> 5"
-gem "jbuilder", "~> 2.5"
+gem 'rails', '<%= Barebones::RAILS_VERSION %>'
+gem 'puma'
+gem 'sass-rails', '~> 5.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'jquery-rails'
+gem 'turbolinks', '~> 5'
+gem 'jbuilder', '~> 2.5'
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 
 group :development, :test do
-  gem "byebug"
-  gem "pry-byebug"
-  gem "web-console", "~> 2.0"
-  gem 'listen', '~> 3.0.5'
-  gem "spring"
-  gem 'spring-watcher-listen', '~> 2.0.0'
-  gem "awesome_print"
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+  gem 'pry-byebug'
+  # Adds support for Capybara system testing and selenium driver
+  gem 'capybara', '~> 2.13'
+  gem 'selenium-webdriver'
+  gem 'awesome_print'
 <% unless options[:skip_minitest] %>
-  gem "minitest-rails"
-  gem "minitest-reporters"
-  gem "minitest-around"
-  gem "mocha"
-  gem "database_cleaner"
+  gem 'minitest-rails'
+  gem 'minitest-reporters'
+  gem 'minitest-around'
+  gem 'mocha'
+  gem 'database_cleaner'
 <% end %>
 <% unless options[:skip_factory_girl] %>
-  gem "factory_girl_rails", "~> 4.0"
+  gem 'factory_girl_rails', '~> 4.0'
 <% end %>
 end
 
+group :development do
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '>= 3.0.5', '< 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
 <% unless options[:skip_carrierwave] %>
 # File Uploads
-gem "fog"
-gem "mini_magick"
-gem "carrierwave"
+gem 'fog-aws'
+gem 'mini_magick'
+gem 'carrierwave'
 <% end %>
 
 <% unless options[:skip_resque] %>
 # Background Processing
-gem "resque"
-gem "resque-scheduler"
+gem 'resque'
+gem 'resque-scheduler'
 gem 'sinatra', github: 'sinatra/sinatra', branch: 'master'
 <% end %>
 
+<% unless options[:skip_sidekiq] %>
+# Background Processing
+gem 'sidekiq'
+<% end %>
+
 # Database
-gem "pg", "~> 0.18.4"
+gem 'pg', '~> 0.18.4'
 
 # Faster JSON Parsing
-gem "oj"
-gem "oj_mimic_json"
-gem "multi_json"
+gem 'oj'
+gem 'oj_mimic_json'
+gem 'multi_json'

data/templates/Procfile

@@ -0,0 +1 @@
+web: bundle exec puma -p ${PORT:-3000} -e ${RACK_ENV:-development} -C config/puma.rb

data/templates/puma.rb

@@ -0,0 +1,68 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum, this matches the default thread size of Active Record.
+#
+# threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }.to_i
+# threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests, default is 3000.
+#
+# port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+# environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory. If you use this option
+# you need to make sure to reconnect any threads in the `on_worker_boot`
+# block.
+#
+# preload_app!
+
+# The code in the `on_worker_boot` will be called if you are using
+# clustered mode by specifying a number of `workers`. After each worker
+# process is booted this block will be run, if you are using `preload_app!`
+# option you will want to use this block to reconnect to any threads
+# or connections that may have been created at application boot, Ruby
+# cannot share connections between processes.
+#
+# on_worker_boot do
+#   ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
+# end
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart
+
+# Custom
+workers Integer(ENV['WEB_CONCURRENCY'] || 2)
+threads_count = Integer(ENV['RAILS_MAX_THREADS'] || 5)
+threads threads_count, threads_count
+
+preload_app!
+
+rackup      DefaultRackup
+port        ENV['PORT']     || 3000
+environment ENV['RACK_ENV'] || 'development'
+
+on_worker_boot do
+  unless Rails.env.development?
+    # https://coderwall.com/p/fprnhg/free-background-jobs-on-heroku
+    @sidekiq_pid ||= spawn("bundle exec sidekiq -c 2")
+  end
+  # Worker specific setup for Rails 4.1+
+  # See: https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#on-worker-boot
+  ActiveRecord::Base.establish_connection
+end

data/templates/{redis.rb → redis.rb.erb}

@@ -1,4 +1,5 @@
-redis_db_0 = Redis.new(
+<% unless options[:skip_resque] %>
+$redis_db_0 = Redis.new(
   :url => Rails.application.secrets.redis_url,
   :port => Rails.application.secrets.redis_port,
   :db => Rails.application.secrets.redis_db,
@@ -8,6 +9,7 @@ $redis_default = Redis::Namespace.new(
   Rails.application.secrets.redis_namespace_default, 
   :redis => redis_db_0
 )
+<% end %>
 
 # http://www.rubydoc.info/github/redis/redis-rb/Redis/Client
 # :url => lambda { ENV["REDIS_URL"] },
@@ -23,4 +25,12 @@ $redis_default = Redis::Namespace.new(
 # :id => nil,
 # :tcp_keepalive => 0,
 # :reconnect_attempts => 1,
-# :inherit_socket => false
+# :inherit_socket => false
+
+<% unless options[:skip_sidekiq] %>
+$redis = Redis.new(
+  :url => Rails.application.secrets.redis_url,
+  :port => Rails.application.secrets.redis_port,
+  :db => Rails.application.secrets.redis_db,
+)
+<% end %>

data/templates/resque.rb

@@ -1 +1 @@
-Resque.redis = $redis_default
+Resque.redis = $redis_default

data/templates/secrets.yml.erb

@@ -8,6 +8,7 @@ development:
   redis_port: 6379
   redis_db: 0
   redis_namespace_default: "redis_default"
+  redis_provider: <%%= ENV["REDIS_PROVIDER"] %>
   # Carrierwave
   cw_access_key_id: 
   cw_secret_access_key: 
@@ -20,6 +21,7 @@ staging:
   redis_url: 
   redis_port: 
   redis_namespace_default: 
+  redis_provider: <%%= ENV["REDIS_PROVIDER"] %>
   # Carrierwave
   cw_access_key_id: 
   cw_secret_access_key: 
@@ -32,6 +34,7 @@ production:
   redis_url: 
   redis_port: 
   redis_namespace_default: 
+  redis_provider: <%%= ENV["REDIS_PROVIDER"] %>
   # Carrierwave
   cw_access_key_id: 
   cw_secret_access_key: 
@@ -44,6 +47,7 @@ test:
   redis_url: 
   redis_port: 
   redis_namespace_default: 
+  redis_provider: <%%= ENV["REDIS_PROVIDER"] %>
   # Carrierwave
   cw_access_key_id: 
   cw_secret_access_key: 

data/templates/sidekiq.rb

@@ -0,0 +1,7 @@
+Sidekiq.configure_server do |config|
+  config.redis = { url: Rails.application.secrets.redis_provider }
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = { url: Rails.application.secrets.redis_provider }
+end

data/templates/test_job.rb

@@ -4,6 +4,6 @@ class TestJob < ApplicationJob
   queue_as :default
  
   def perform
-    puts "Resque is working."
+    puts "ActiveJob is working."
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barebones
 version: !ruby/object:Gem::Version
-  version: 1.0.0.4
+  version: 1.0.0.5
 platform: ruby
 authors:
 - Danny Yu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-08 00:00:00.000000000 Z
+date: 2017-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.1'
 description: A personal Rails template generator.
 email: 
 executables:
@@ -42,6 +42,7 @@ files:
 - lib/barebones/text_format_helpers.rb
 - lib/barebones/version.rb
 - templates/Gemfile.erb
+- templates/Procfile
 - templates/README.md.erb
 - templates/api_application_controller.rb
 - templates/api_constraints.rb.erb
@@ -54,11 +55,13 @@ files:
 - templates/database.yml.erb
 - templates/layout.json.jbuilder
 - templates/multi_json.rb
-- templates/redis.rb
+- templates/puma.rb
+- templates/redis.rb.erb
 - templates/resque.rake
 - templates/resque.rb
 - templates/routes.rb.erb
 - templates/secrets.yml.erb
+- templates/sidekiq.rb
 - templates/test_job.rb
 homepage: https://github.com/dannyyu92/barebones
 licenses: