thredded_create_app 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0192d6123fe66987a3b0523882845a74a0379d69'
-  data.tar.gz: e1316bc7fa77e70e737c32b7b3cfa185468e8816
+  metadata.gz: a0516299291ce7b4cfd720cadd5f34ad94893402
+  data.tar.gz: 5c4f3936a075560f5df3b1c6a2c754bacd9ef729
 SHA512:
-  metadata.gz: e5f9e0f3e35da8d736e87fa27b0db927b1aa9744b22cdda52ffe086fcc82e894da22638d007fee06147d1fb66137394111fd9fe63cc955c19e9d8533975a8a64
-  data.tar.gz: 8455840cf1f18b09036f4b160d54a43768e2ce262350acc6b6ff5a07d403d5a361fe09badc454a612aa5eac6b35045a04af8ff4631929d61a8157911bca2c143
+  metadata.gz: 7cebe5537c3c942aa0704b5e55351e922b3b19502b0f3486ce6a8762ed9ffe67156370b710dedac8fe2004f578e8dceb3b19a5b5307f1089dc9cdbf415043e3b
+  data.tar.gz: bc6209c773afd635ff952185dfa275b951ade1aa6711521a94707610e9702dd47854be51fef1f8f317373ba0aab4ebba60cae66d1729fb9a96b627c7254682b8

data/README.md

@@ -189,20 +189,27 @@ The app is now deployed, but you'll also need to set up emailing.
 
 The easiest way to do this is via the Mailgun Heroku add-on.
 
-1. Enable the Mailgun add-on:
+1. Set the `APP_HOST` environment variable on Heroku so that the app knows its
+   domain.
+
+   ```bash
+   heroku config:set APP_HOST='e.g. myapp.herokuapp.com'
+   ```
+
+2. Enable the Mailgun add-on:
 
    ```bash
    heroku addons:create mailgun:starter # Enable Mailgun with the free plan
    ```
 
-2. Copy the following snippet into `config/environments/production.rb`:
+3. Copy the following snippet into `config/environments/production.rb`:
 
    ```ruby
    config.action_mailer.perform_deliveries = true
    config.action_mailer.raise_delivery_errors = true
    config.action_mailer.delivery_method = :smtp
    config.action_mailer.smtp_settings = {
-       domain: '[SET ME] myapp.herokuapp.com',
+       domain: Settings.hostname,
        port: ENV['MAILGUN_SMTP_PORT'],
        address: ENV['MAILGUN_SMTP_SERVER'],
        user_name: ENV['MAILGUN_SMTP_LOGIN'],
@@ -213,7 +220,10 @@ The easiest way to do this is via the Mailgun Heroku add-on.
 
    Set the `domain` in the snippet above to your domain.
 
-3. Commit and push to Heroku.
+4. Commit and push to Heroku.
+
+By default, emails are send from `no-reply@`. You can configure this in
+`config/settings.yml`.
 
 ### Performance
 

data/lib/thredded_create_app/generator.rb

@@ -4,6 +4,7 @@ require 'fileutils'
 require 'shellwords'
 require 'thredded_create_app/tasks/base'
 require 'thredded_create_app/tasks/create_rails_app'
+require 'thredded_create_app/tasks/add_rails_config'
 require 'thredded_create_app/tasks/add_simple_form'
 require 'thredded_create_app/tasks/add_devise'
 require 'thredded_create_app/tasks/add_roadie'
@@ -63,6 +64,7 @@ module ThreddedCreateApp
     def tasks
       @tasks ||= [
         Tasks::CreateRailsApp,
+        Tasks::AddRailsConfig,
         (Tasks::AddSimpleForm if @options[:simple_form]),
         Tasks::AddDevise,
         Tasks::AddRailsEmailPreview,

data/lib/thredded_create_app/tasks/add_devise.rb

@@ -20,6 +20,7 @@ module ThreddedCreateApp
         run_generator 'devise:install'
         run_generator 'devise User'
         setup_views
+        setup_emails
         setup_after_sign_in_behaviour
         git_commit 'Setup Devise'
       end
@@ -65,6 +66,19 @@ module ThreddedCreateApp
                   optional: true
         end
       end
+
+      def setup_emails
+        replace 'config/initializers/devise.rb',
+                /# config\.parent_mailer = .*/,
+                <<~'RUBY'.chomp
+                  config.parent_mailer = 'ApplicationMailer'
+                RUBY
+        replace 'config/initializers/devise.rb',
+                /( *)config\.mailer_sender = .*/,
+                '\1' + <<~'RUBY'.chomp
+                  config.mailer_sender = %("#{I18n.t('brand.name')}" <#{Settings.email_sender}>)
+                RUBY
+      end
     end
   end
 end

data/lib/thredded_create_app/tasks/add_rails_config.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'thredded_create_app/tasks/base'
+module ThreddedCreateApp
+  module Tasks
+    class AddRailsConfig < Base
+      def summary
+        'Add the config gem'
+      end
+
+      def before_bundle
+        add_gem 'config'
+      end
+
+      def after_bundle
+        run_generator 'config:install'
+        git_commit 'Add Rails Config configuration (rails g config:install)'
+        inject_into_file 'config/initializers/config.rb',
+                         before: /\A/,
+                         content: config_initializer_header
+      end
+
+      private
+
+      def config_initializer_header
+        <<~'RUBY'
+          # frozen_string_literal: true
+
+          # This file *must* be named "config.rb". It is loaded manually by the config
+          # gem before everything else, so you can use the Settings constant even in
+          # config/application.rb and config/environments/*.
+        RUBY
+      end
+    end
+  end
+end

data/lib/thredded_create_app/tasks/add_roadie.rb

@@ -13,7 +13,7 @@ module ThreddedCreateApp
         add_gem 'plain-david' # for plain text email generation
       end
 
-      def after_bundle
+      def after_bundle # rubocop:disable Metrics/AbcSize
         inject_into_file 'app/mailers/application_mailer.rb',
                          after: "ActionMailer::Base\n",
                          content: "  include Roadie::Rails::Automatic\n"
@@ -56,7 +56,7 @@ module ThreddedCreateApp
         <<~'RUBY'
           # Set the default URL options for both Roadie and ActionMailer:
           config.roadie.url_options = config.action_mailer.default_url_options = {
-            host: ENV['APP_HOST'] || '[SET ME] myapp.herokuapp.com',
+            host: Settings.hostname,
             protocol: 'https',
           }
         RUBY

data/lib/thredded_create_app/tasks/add_thredded.rb

@@ -26,8 +26,8 @@ module ThreddedCreateApp
         git_commit 'Configure Thredded (routes, assets, behaviour, tests)'
         add_admin_column_to_users
         git_commit 'Add the admin column to users'
-        add_thredded_email_styles
-        git_commit 'Configure Thredded email styles with Roadie'
+        setup_thredded_emails
+        git_commit 'Configure Thredded emails and email styles with Roadie'
         configure_rails_email_preview
         git_commit 'Configure RailsEmailPreview with Thredded and Roadie'
         run 'bundle exec rails thredded:install:emoji'
@@ -79,7 +79,7 @@ module ThreddedCreateApp
              Dir['db/migrate/*_add_admin_to_users.rb'][0]
       end
 
-      def add_thredded_email_styles
+      def setup_thredded_emails
         File.write 'app/assets/stylesheets/email.scss', <<~'SCSS', mode: 'a'
           @import "variables";
           @import "thredded-variables";
@@ -87,8 +87,13 @@ module ThreddedCreateApp
         SCSS
 
         replace 'config/initializers/thredded.rb',
-                "# Thredded.parent_mailer = 'ActionMailer::Base'",
+                /# Thredded\.parent_mailer = .*/,
                 "Thredded.parent_mailer = 'ApplicationMailer'"
+        replace 'config/initializers/thredded.rb',
+                /# Thredded\.email_from = .*/,
+                <<~'RUBY'.chomp
+                  Thredded.email_from = %("#{I18n.t('brand.name')}" <#{Settings.email_sender}>)
+                RUBY
 
         add_precompile_asset 'email.css'
 

data/lib/thredded_create_app/tasks/base.rb

@@ -11,13 +11,14 @@ module ThreddedCreateApp
     class Base
       include ThreddedCreateApp::Logging
 
-      attr_reader :app_name, :app_path, :gems
+      attr_reader :app_name, :app_hostname, :app_path, :gems
 
       def initialize(app_path:, verbose: false, **_args)
         @app_path = app_path
         @app_name = File.basename(File.expand_path(app_path))
-        @verbose  = verbose
-        @gems     = []
+        @app_hostname = "#{@app_name.tr(' ', '_').downcase}.com"
+        @verbose = verbose
+        @gems = []
       end
 
       def summary

data/lib/thredded_create_app/tasks/setup_app_skeleton/config/settings.yml.erb

@@ -0,0 +1,3 @@
+<%% hostname = ENV['APP_HOST'] || '<%= app_hostname %>' %>
+hostname: <%%= hostname.inspect %>
+email_sender: <%%= (ENV['SMTP_USER'] || "no-reply@#{hostname}").inspect %>

data/lib/thredded_create_app/tasks/setup_app_skeleton/initializers/02_i18n.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Manually initialize i18n so that it can be used in the initializers
+I18n::Railtie.initialize_i18n(Rails.application)
+I18n.backend.send(:init_translations) unless I18n.backend.initialized?

data/lib/thredded_create_app/tasks/setup_app_skeleton.rb

@@ -24,16 +24,17 @@ module ThreddedCreateApp
       end
 
       def after_bundle
+        add_config_vars
+        add_i18n
+        add_seeds
         add_favicon_and_touch_icons
         add_javascripts
         add_styles
         add_user_page
         add_home_page
-        add_i18n
         add_app_layout
         copy 'setup_app_skeleton/spec/features/homepage_spec.rb',
              'spec/features/homepage_spec.rb'
-        add_seeds
         git_commit 'Set up basic app navigation and styles'
       end
 
@@ -94,9 +95,19 @@ module ThreddedCreateApp
         add_precompile_asset 'night.css'
       end
 
+      def add_config_vars
+        copy_template 'setup_app_skeleton/config/settings.yml.erb',
+                      'config/settings.yml'
+        replace 'app/mailers/application_mailer.rb',
+                /default from: .*/,
+                'default from: Settings.email_sender'
+      end
+
       def add_i18n
-        copy_template 'setup_app_skeleton/en.yml.erb',
+        copy_template 'setup_app_skeleton/config/locales/en.yml.erb',
                       'config/locales/en.yml'
+        copy_template 'setup_app_skeleton/initializers/02_i18n.rb',
+                      'config/initializers/02_i18n.rb'
         inject_into_file'config/application.rb',
                         before: / *end\nend\n\z/,
                         content: indent(4, <<~'RUBY')
@@ -186,7 +197,7 @@ module ThreddedCreateApp
       end
 
       def admin_email
-        "admin@#{app_name.tr(' ', '_').downcase}.com"
+        "admin@#{app_hostname}"
       end
 
       def admin_password

data/lib/thredded_create_app/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ThreddedCreateApp
-  VERSION = '0.1.14'
+  VERSION = '0.1.15'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thredded_create_app
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-26 00:00:00.000000000 Z
+date: 2017-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.44'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Generates a Rails app with Thredded installed.
 email:
 - glex.spb@gmail.com
@@ -114,6 +128,7 @@ files:
 - lib/thredded_create_app/tasks/add_display_name_to_users.rb
 - lib/thredded_create_app/tasks/add_display_name_to_users/add_display_name_to_users.rb
 - lib/thredded_create_app/tasks/add_memcached_support.rb
+- lib/thredded_create_app/tasks/add_rails_config.rb
 - lib/thredded_create_app/tasks/add_rails_email_preview.rb
 - lib/thredded_create_app/tasks/add_rails_email_preview/_rails_email_preview-custom.scss
 - lib/thredded_create_app/tasks/add_roadie.rb
@@ -140,9 +155,11 @@ files:
 - lib/thredded_create_app/tasks/setup_app_skeleton/_header.html.erb
 - lib/thredded_create_app/tasks/setup_app_skeleton/application.body.html.erb
 - lib/thredded_create_app/tasks/setup_app_skeleton/application_helper_methods.rb
-- lib/thredded_create_app/tasks/setup_app_skeleton/en.yml.erb
+- lib/thredded_create_app/tasks/setup_app_skeleton/config/locales/en.yml.erb
+- lib/thredded_create_app/tasks/setup_app_skeleton/config/settings.yml.erb
 - lib/thredded_create_app/tasks/setup_app_skeleton/home_show.html.erb.erb
 - lib/thredded_create_app/tasks/setup_app_skeleton/images/brightness.svg
+- lib/thredded_create_app/tasks/setup_app_skeleton/initializers/02_i18n.rb
 - lib/thredded_create_app/tasks/setup_app_skeleton/javascripts/app.js
 - lib/thredded_create_app/tasks/setup_app_skeleton/javascripts/app/monkey-patch-turbolinks.js
 - lib/thredded_create_app/tasks/setup_app_skeleton/javascripts/app/theme.js