voyage 1.44.0.6 → 1.44.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0eaaf85bbe8db4e1ad19731f0cd98f8ad1fb2db
-  data.tar.gz: 04a3370b1789e18342f71442848498ef5bd19641
+  metadata.gz: f3069f490551d031bd77d95c0f11fafd36608a7c
+  data.tar.gz: 2cf4fe7cc391b8a195be17da2d72bf849d216cd1
 SHA512:
-  metadata.gz: 92f26dd7993995eb9a232811218299db77fc4dfe0bd028c73617e7a1b465a330926daefc743c2d524347f04ce8dd78c12d534402f9a773b238a03e5c699a17d6
-  data.tar.gz: 158df60d57f4a7aaf4933b0593bb45f7e3c9c5bc522f7b372d4697bf7ff76cab91109c17028b01f7e9d133aa8b3e03ed011644e2b2b0bc1e61942f212184f436
+  metadata.gz: aa91712c84e2ef27758b693e36ef471788611f97c99454285a2662bd596fae2fa7f24142bcf622f05b74a46b1ac3c8d8e8519bb6ffb8ff99eea752a1c7229201
+  data.tar.gz: c4812939c3c07301063aaf17baaa4cfee6af9c38b052baad26334f283df7077478c1600978cbfe4f30f580b2cb767c9ff9d6178bf6abeb16853a79f1e03a362f

data/TODO.md

@@ -0,0 +1,4 @@
+- [ ] Install, then run Rstrip gem with a config file. I have one in home directory.
+
+INTERCOM_SECURE_MODE_SECRET_KEY
+SEGMENT_KEY

data/lib/voyage/README.md

@@ -20,3 +20,29 @@ Everything else is a new file we want to add.
 ## Testing
 
 Test that the new generator works, manually for now. It'd be awesome to get some [aruba](https://github.com/cucumber/aruba) tests going to test the various command line options / generated app permutations that are possible. For example, with and without devise, which templating language we should use, etc.
+
+## Pushing a new release
+
+  * Bump the version file: `lib/voyage/version.rb`
+
+        VERSION = '1.44.0.6'.freeze
+
+  * Tag the current commits on master BEFORE squashing (in case we want to refer to that diff history). Add a good commit message with what was done.
+
+        git tag -a 1.44.0.6-voyage
+
+  * Squash all new commits (assumed 3 here) into the 2 main commits (for a total of 5)
+
+        git rebase -i HEAD~5
+
+  * Force push the changes to master
+
+        git push --force-with-lease --no-verify
+
+  * Build the gem
+
+        gem build suspenders.gemspec
+
+  * Publish to rubygems
+
+        gem push voyage-1.44.0.6.gem

data/lib/voyage/app_builder.rb

@@ -17,20 +17,24 @@ module Suspenders
 
     def update_gemset_in_gemfile
       replace_in_file 'Gemfile', '#ruby-gemset', "#ruby-gemset=#{app_name}"
+
+      # Remove commented out lines from template
+      gsub_file('Gemfile', /^\s{2}\n/, '')
     end
 
     def use_slim
       if @@accept_defaults || agree?('Would you like to use slim? (Y/n)')
         @@use_slim = true
         run 'gem install html2slim'
-        update_application_layout_for_slim
+        update_application_rb_for_slim
       else
         @@use_slim = false
+        gsub_file('Gemfile', /^gem 'slim-rails'\n/, '')
       end
     end
 
     def update_application_layout_for_slim
-      find = <<-RUBY.gsub(/^ {6}/, '')
+      find = <<-RUBY.gsub(/^ {4}/, '')
         <%#
           Configure default and controller-, and view-specific titles in
           config/locales/en.yml. For more see:
@@ -38,10 +42,10 @@ module Suspenders
         %>
       RUBY
 
-      replace = <<-RUBY.gsub(/^ {6}/, '')
-        <% # Configure default and controller-, and view-specific titles in
-      # config/locales/en.yml. For more see:
-      # https://github.com/calebthompson/title#usage %>
+      replace = <<-RUBY.gsub(/^ {8}/, '')
+          <% # Configure default and controller-, and view-specific titles in
+        # config/locales/en.yml. For more see:
+        # https://github.com/calebthompson/title#usage %>
       RUBY
 
       replace_in_file 'app/views/layouts/application.html.erb', find, replace
@@ -49,9 +53,6 @@ module Suspenders
       inside('lib') do # arbitrary, run in context of newly generated app
         run "erb2slim '../app/views/layouts' '../app/views/layouts'"
         run "erb2slim -d '../app/views/layouts'"
-
-        run "erb2slim '../app/views/application' '../app/views/application'"
-        run "erb2slim -d '../app/views/application'"
       end
 
       # strip trailing space after closing "> in application layout before
@@ -60,32 +61,23 @@ module Suspenders
 
       find = <<-RUBY.gsub(/^ {6}/, '')
         |  <body class="
+        = devise_controller? ? 'devise' : 'application'
         = body_class
         | ">
       RUBY
 
       replace = <<-RUBY.gsub(/^ {6}/, '')
-        body class="\#{body_class}"
+        body class="\#{devise_controller? ? 'devise' : 'application'} \#{body_class}"
       RUBY
 
       replace_in_file 'app/views/layouts/application.html.slim', find, replace
+    end
 
-      find = <<-RUBY.gsub(/^ {6}/, '')
-        = render "flashes"
-        = yield
-        = render "javascript"
-        = render "css_overrides"
-      RUBY
-
-      # Bump renders in to be nested within body
-      replace = <<-RUBY.gsub(/^ {6}/, '')
-          = render "flashes"
-          = yield
-          = render "javascript"
-          = render "css_overrides"
-      RUBY
-
-      replace_in_file 'app/views/layouts/application.html.slim', find, replace
+    def update_application_rb_for_slim
+      inject_into_file "config/application.rb", after: "     g.fixture_replacement :factory_girl, dir: 'spec/factories'\n" do <<-'RUBY'.gsub(/^ {2}/, '')
+        g.template_engine :slim
+        RUBY
+      end
     end
 
     # ------------
@@ -93,17 +85,20 @@ module Suspenders
     # ------------
     def install_devise
       if @@accept_defaults || agree?('Would you like to install Devise? (Y/n)')
+        @@use_devise = true
         bundle_command 'exec rails generate devise:install'
 
         if @@accept_defaults || agree?("Would you like to add first_name and last_name to the devise model? (Y/n)")
           adding_first_and_last_name = true
 
-          bundle_command "exec rails generate resource user first_name:string last_name:string"
+          bundle_command "exec rails generate resource user first_name:string last_name:string uuid:string"
 
           replace_in_file 'spec/factories/users.rb',
             'first_name "MyString"', 'first_name { Faker::Name.first_name }'
           replace_in_file 'spec/factories/users.rb',
             'last_name "MyString"', 'last_name { Faker::Name.last_name }'
+          replace_in_file 'spec/factories/users.rb',
+            'uuid "MyString"', 'uuid { SecureRandom.uuid }'
         end
 
         bundle_command "exec rails generate devise user"
@@ -118,12 +113,14 @@ module Suspenders
 
         customize_devise_views if adding_first_and_last_name
         customize_application_controller_for_devise(adding_first_and_last_name)
+        add_devise_registrations_controller
         customize_resource_controller_for_devise(adding_first_and_last_name)
-        add_views_for_devise_resource(adding_first_and_last_name)
+        add_admin_views_for_devise_resource(adding_first_and_last_name)
+        add_analytics_initializer
         authorize_devise_resource_for_index_action
         add_canard_roles_to_devise_resource
         update_devise_initializer
-        add_sign_in_and_sign_out_routes_for_devise
+        add_custom_routes_for_devise
         customize_user_factory(adding_first_and_last_name)
         generate_seeder_templates(using_devise: true)
         customize_user_spec
@@ -153,13 +150,67 @@ module Suspenders
     end
 
     def customize_application_controller_for_devise(adding_first_and_last_name)
+      inject_into_file 'app/controllers/application_controller.rb', before: "class ApplicationController < ActionController::Base" do <<-RUBY.gsub(/^ {8}/, '')
+        # rubocop:disable Metrics/ClassLength, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/LineLength
+        RUBY
+      end
+
       inject_into_file 'app/controllers/application_controller.rb', after: "  protect_from_forgery with: :exception" do <<-RUBY.gsub(/^ {6}/, '')
 
+        check_authorization unless: :devise_or_pages_controller?
+        impersonates :user
+
         before_action :configure_permitted_parameters, if: :devise_controller?
+        before_action :authenticate_user!, unless: -> { is_a?(HighVoltage::PagesController) }
+        before_action :add_layout_name_to_gon
+        before_action :detect_device_type
+
+        rescue_from CanCan::AccessDenied do |exception|
+          redirect_to root_path, alert: exception.message
+        end
+
+        # Example Traditional Event: analytics_track(user, 'Created Widget', { widget_name: 'foo' })
+        # Example Page View:         analytics_track(user, 'Page Viewed', { page_name: 'Terms and Conditions', url: '/terms' })
+        #
+        # NOTE: setup some defaults that we want to track on every event mixpanel_track
+        # NOTE: the identify step happens on every page load to keep intercom.io and mixpanel people up to date
+        def analytics_track(user, event_name, options = {})
+          return if user.tester?
+
+          sanitized_options = sanitize_hash_javascript(options)
+
+          segment_attributes = {
+            user_id: user.uuid,
+            event: event_name,
+            properties: {
+              browser:         "\#{browser.name rescue 'unknown'}",
+              browser_id:      "\#{browser.id rescue 'unknown'}",
+              browser_version: "\#{browser.version rescue 'unknown'}",
+              platform:        "\#{browser.platform rescue 'unknown'}",
+              roles:           "\#{user.roles.map(&:to_s).join(',') rescue ''}",
+              rails_env:       Rails.env.to_s,
+            }.merge(sanitized_options),
+          }
+
+          Analytics.track(segment_attributes)
+        end
 
         protected
 
-        # rubocop:disable Metrics/MethodLength
+        def devise_or_pages_controller?
+          devise_controller? || is_a?(HighVoltage::PagesController)
+        end
+
+        def sanitize_hash_javascript(hash)
+          hash.deep_stringify_keys
+              .deep_transform_keys { |k| sanitize_javascript(k) }
+              .transform_values    { |v| sanitize_javascript(v) }
+        end
+
+        def sanitize_javascript(value)
+          value.is_a?(String) ? ActionView::Base.new.escape_javascript(value) : value
+        end
+
         def configure_permitted_parameters
           devise_parameter_sanitizer.permit(
             :sign_up,
@@ -192,33 +243,79 @@ module Suspenders
             ],
           )
         end
-        # rubocop:enable Metrics/MethodLength
+
+        def add_layout_name_to_gon
+          gon.layout =
+            case devise_controller?
+            when true
+              'devise'
+            else
+              'application'
+            end
+        end
+
+        def detect_device_type
+          request.variant =
+            case request.user_agent
+            when /iPad/i
+              :tablet
+            when /iPhone/i
+              :phone
+            when /Android/i && /mobile/i
+              :phone
+            when /Android/i
+              :tablet
+            when /Windows Phone/i
+              :phone
+            end
+        end
         RUBY
       end
     end
 
+    def add_devise_registrations_controller
+      template '../templates/devise_registrations_controller.rb',
+               'app/controllers/devise_customizations/registrations_controller.rb'
+    end
+
+
+    def add_analytics_initializer
+      template '../templates/analytics_ruby_initializer.rb', 'config/initializers/analytics_ruby.rb'
+      template '../templates/analytics_alias.html.erb.erb', 'app/views/users/analytics_alias.html.erb'
+    end
+
     def customize_resource_controller_for_devise(adding_first_and_last_name)
       bundle_command 'exec rails generate controller users'
       run 'rm spec/controllers/users_controller_spec.rb'
 
-      inject_into_class "app/controllers/users_controller.rb", "UsersController" do <<-RUBY.gsub(/^ {6}/, '')
+      inject_into_class 'app/controllers/users_controller.rb', 'UsersController' do <<-RUBY.gsub(/^ {6}/, '')
         # https://github.com/CanCanCommunity/cancancan/wiki/authorizing-controller-actions
-        load_and_authorize_resource only: [:index, :show]
-        RUBY
-      end
+        # load_and_authorize_resource only: []
+        skip_authorization_check only: [:analytics_alias]
 
-      unless adding_first_and_last_name
-        inject_into_file 'config/routes.rb', after: '  devise_for :users' do <<-RUBY.gsub(/^ {8}/, '')
-          \n
-          resources :users
-          RUBY
+        def analytics_alias
+          # view file has JS that will identify the anonymous user through segment
+          # after registration via "after devise registration path"
         end
+        RUBY
       end
     end
 
-    def add_views_for_devise_resource(adding_first_and_last_name)
+    def add_admin_views_for_devise_resource(adding_first_and_last_name)
       config = { adding_first_and_last_name: adding_first_and_last_name }
-      template '../templates/users_index.html.slim.erb', 'app/views/users/index.html.slim', config
+      template '../templates/users_index.html.erb', 'app/views/admin/users/index.html.erb', config
+
+      if @@use_slim
+        inside('lib') do # arbitrary, run in context of newly generated app
+          run "erb2slim '../app/views/users' '../app/views/users'"
+          run "erb2slim -d '../app/views/users'"
+
+          run "erb2slim '../app/views/admin/users' '../app/views/admin/users'"
+          run "erb2slim -d '../app/views/admin/users'"
+        end
+      end
+
+      template '../templates/admin_users_controller.rb', 'app/controllers/admin/users_controller.rb'
     end
 
     def authorize_devise_resource_for_index_action
@@ -229,6 +326,25 @@ module Suspenders
         replace_in_file "spec/abilities/#{resource_name}_spec.rb", "require 'cancan/matchers'", "require_relative '../support/matchers/custom_cancan'"
       end
 
+      find = <<-RUBY.gsub(/^ {4}/, '')
+        it { is_expected.to be_able_to(:manage, user) }
+      RUBY
+      replace = <<-RUBY.gsub(/^ {4}/, '')
+        it { is_expected.to be_able_to(:manage, acting_user) }
+        it { is_expected.to_not be_able_to(:manage, user) }
+      RUBY
+      replace_in_file 'spec/abilities/users_spec.rb', find, replace
+
+      find = <<-RUBY.gsub(/^ {6}/, '')
+        can [:manage], User
+      RUBY
+      replace = <<-RUBY.gsub(/^ {6}/, '')
+        can [:manage], User do |u|
+          u == user
+        end
+      RUBY
+      replace_in_file 'app/abilities/users.rb', find, replace
+
       generate 'migration add_roles_mask_to_users roles_mask:integer'
       template '../templates/custom_cancan_matchers.rb', 'spec/support/matchers/custom_cancan.rb'
     end
@@ -236,11 +352,42 @@ module Suspenders
     def add_canard_roles_to_devise_resource
       inject_into_file 'app/models/user.rb', before: /^end/ do <<-RUBY.gsub(/^ {6}/, '')
 
+        before_create :generate_uuid
+
         # Permissions cascade/inherit through the roles listed below. The order of
         # this list is important, it should progress from least to most privelage
         ROLES = [:admin].freeze
         acts_as_user roles: ROLES
         roles ROLES
+
+        validates :email,
+                  presence: true,
+                  format: /\\A[-a-z0-9_+\\.]+\\@([-a-z0-9]+\\.)+[a-z0-9]{2,8}\\z/i,
+                  uniqueness: true
+
+        # NOTE: these password validations won't run if the user has an invite token
+        validates :password,
+                  presence: true,
+                  length: { within: 8..72 },
+                  confirmation: true,
+                  on: :create
+        validates :password_confirmation,
+                  presence: true,
+                  on: :create
+
+        def tester?
+          (email =~ /(example.com|headway.io)$/).present?
+        end
+
+        private
+
+        def generate_uuid
+          loop do
+            uuid = SecureRandom.uuid
+            self.uuid = uuid
+            break unless User.exists?(uuid: uuid)
+          end
+        end
         RUBY
       end
     end
@@ -254,23 +401,53 @@ module Suspenders
         "config.mailer_sender = 'user@example.com'"
     end
 
-    def add_sign_in_and_sign_out_routes_for_devise
-      inject_into_file 'config/routes.rb', before: /^end/ do <<-RUBY.gsub(/^ {6}/, '')
+    def add_custom_routes_for_devise
+      find = <<-RUBY.gsub(/^ {6}/, '')
+        devise_for :users
+        resources :users
+      RUBY
+
+      replace = <<-RUBY.gsub(/^ {6}/, '')
+        devise_for :users, controllers: {
+          registrations: 'devise_customizations/registrations',
+        }
+
+        resources :users do
+          member do
+            get 'analytics_alias'
+          end
+        end
+
+        namespace :admin do
+          resources :users do
+            member do
+              get 'impersonate'
+            end
+
+            collection do
+              get 'stop_impersonating'
+            end
+          end
+        end
+
         authenticated :user do
           # root to: 'dashboard#show', as: :authenticated_root
+          root to: 'high_voltage/pages#show', id: 'welcome', as: :authenticated_root
         end
 
         devise_scope :user do
           get 'sign-in',  to: 'devise/sessions#new'
           get 'sign-out', to: 'devise/sessions#destroy'
         end
-        RUBY
-      end
+      RUBY
+
+      replace_in_file 'config/routes.rb', find, replace
     end
 
     def customize_user_factory(adding_first_and_last_name)
       inject_into_file 'spec/factories/users.rb', before: /^  end/ do <<-'RUBY'.gsub(/^ {4}/, '')
-        password 'password'
+        password 'asdfjkl123'
+        password_confirmation 'asdfjkl123'
         sequence(:email) { |n| "user_#{n}@example.com" }
 
         trait :admin do
@@ -311,6 +488,26 @@ module Suspenders
             end
           end
         end
+
+        describe 'validations' do
+          it { is_expected.to validate_presence_of(:email) }
+          it { is_expected.to validate_presence_of(:password) }
+          it { is_expected.to validate_presence_of(:password_confirmation) }
+        end
+
+        context '#tester?' do
+          ['example.com', 'headway.io'].each do |domain|
+            it "an email including the \#{domain} domain is a tester" do
+              user = build(:user, email: "asdf@\#{domain}")
+              expect(user.tester?).to eq(true)
+            end
+          end
+
+          it 'an email including the gmail.com domain is NOT a tester' do
+            user = build(:user, email: 'asdf@gmail.com')
+            expect(user.tester?).to eq(false)
+          end
+        end
       RUBY
 
       replace_in_file 'spec/models/user_spec.rb', find, replace
@@ -318,11 +515,21 @@ module Suspenders
 
     def customize_application_js
       template '../templates/application.js', 'app/assets/javascripts/application.js', force: true
+
+      inject_into_file 'app/views/application/_javascript.html.erb', after: '<%= render "analytics" %>' do <<-RUBY.gsub(/^ {8}/, '')
+
+        <%= render "analytics_identify" %>
+      RUBY
+      end
     end
 
     def require_files_in_lib
-      create_file 'config/initializers/require_files_in_lib.rb',
-        "Dir[File.join(Rails.root, 'lib', '**', '*.rb')].each { |l| require l }\n"
+      create_file 'config/initializers/require_files_in_lib.rb' do <<-RUBY.gsub(/^ {8}/, '')
+        # rubocop:disable Rails/FilePath
+        Dir[File.join(Rails.root, 'lib', '**', '*.rb')].each { |l| require l }
+        # rubocop:enable Rails/FilePath
+        RUBY
+      end
     end
 
     def generate_ruby_version_and_gemset
@@ -352,6 +559,7 @@ module Suspenders
       end
     end
 
+
     # --------
     # TEMP FIX
     #   https://github.com/thoughtbot/bourbon/issues/993
@@ -372,55 +580,31 @@ module Suspenders
     # -------------------------
     def generate_refills
       if @@accept_defaults || agree?('Would you like to install default Refill components? (Y/n)')
+        @@add_refills = true
+
         bundle_command 'exec rails generate refills:import navigation'
         bundle_command 'exec rails generate refills:import footer'
 
-        convert_refill_views if @@use_slim
-        add_refills_to_layout
+        add_admin_links_to_navigation
+
         add_refills_to_stylesheets
+      else
+        @@add_refills = false
       end
     end
 
-    def convert_refill_views
-      inside('lib') do # arbitrary, run in context of newly generated app
-        run "erb2slim '../app/views/refills' '../app/views/refills'"
-        run "erb2slim -d '../app/views/refills'"
-      end
+    def add_admin_links_to_navigation
+      return unless @@use_devise
+      inject_into_file 'app/views/refills/_navigation.html.erb', after: '        <li class="nav-link"><a href="javascript:void(0)">Contact</a></li>'  do <<-RUBY
 
-      find = <<-RUBY.gsub(/^ {2}/, '')
-        |  <div class="flash-
-        = key
-        | ">
-        = value
-      RUBY
-
-      replace = <<-RUBY.gsub(/^ {2}/, '')
-        div class="flash-\#{key}"
-          = value
-      RUBY
-
-      replace_in_file 'app/views/application/_flashes.html.slim', find, replace
-    end
-
-    def add_refills_to_layout
-      if @@use_slim
-        inject_into_file 'app/views/layouts/application.html.slim', before: '    = yield' do <<-RUBY.gsub(/^ {8}/, '')
-            = render 'refills/navigation'
-            RUBY
-        end
-        inject_into_file 'app/views/layouts/application.html.slim', before: '    = render "javascript"' do <<-RUBY.gsub(/^ {8}/, '')
-            = render 'refills/footer'
-            RUBY
-        end
-      else
-        inject_into_file 'app/views/layouts/application.html.erb', before: '  <%= yield %>' do <<-RUBY.gsub(/^ {8}/, '')
-          <%= render 'refills/navigation' %>
-          RUBY
-        end
-        inject_into_file 'app/views/layouts/application.html.erb', before: '  <%= render "javascript" %>' do <<-RUBY.gsub(/^ {8}/, '')
-          <%= render 'refills/footer' %>
-          RUBY
-        end
+        <% if current_user && true_user.admin? %>
+          <% if current_user != true_user %>
+            <li class='nav-link'><%= link_to 'Stop Impersonating', stop_impersonating_admin_users_path %></li>
+          <% else %>
+            <li class="nav-link"><a href="/admin/users">Admin</a></li>
+          <% end %>
+        <% end %>
+        RUBY
       end
     end
 
@@ -451,6 +635,16 @@ module Suspenders
       end
 
       template "../templates/rails_helper.rb.erb", "spec/rails_helper.rb", force: true
+
+      %w(test development).each do |environment|
+        inject_into_file "config/environments/#{environment}.rb", after: /^end/ do <<-RUBY.gsub(/^ {10}/, '')
+
+          # NOTE: console can use create(:factory_name), or build(:factory_name) without
+          # needing to use FactoryGirl.create(:factory_name).
+          include FactoryGirl::Syntax::Methods
+          RUBY
+        end
+      end
     end
 
     def add_rubocop_config
@@ -507,6 +701,7 @@ module Suspenders
     ###############################
     def configure_generators
       config = <<-RUBY.gsub(/^ {4}/, '')
+
         config.generators do |g|
           g.helper false
           g.javascript_engine false
@@ -516,8 +711,8 @@ module Suspenders
           g.test_framework :rspec
           g.view_specs false
           g.fixture_replacement :factory_girl, dir: 'spec/factories'
-          g.template_engine :slim
         end
+
       RUBY
 
       inject_into_class 'config/application.rb', 'Application', config
@@ -527,6 +722,13 @@ module Suspenders
       create_file '.ruby-version', "#{Voyage::RUBY_VERSION}\n"
     end
 
+    def overwrite_application_layout
+      template '../templates/voyage_layout.html.erb.erb', 'app/views/layouts/application.html.erb', force: true, add_refills: @@add_refills
+      update_application_layout_for_slim if @@use_slim
+
+      template '../templates/analytics_identify.html.erb.erb', 'app/views/application/_analytics_identify.html.erb', force: true
+    end
+
     # --------------------------------
     # setup_test_environment overrides
     # --------------------------------

data/lib/voyage/generators/app_generator.rb

@@ -33,6 +33,7 @@ module Suspenders
       invoke :add_high_voltage_static_pages
       invoke :downgrade_neat_1_8_so_refills_media_mixin_works # this should be temporary until they get refills re-written to take advantage of Neat 2.0
       invoke :generate_refills
+      invoke :overwrite_application_layout
       invoke :generate_test_environment
       invoke :update_test_environment
       invoke :add_rubocop_config
@@ -90,6 +91,10 @@ module Suspenders
       build :generate_refills
     end
 
+    def overwrite_application_layout
+      build :overwrite_application_layout
+    end
+
     def generate_test_environment
       build :generate_test_environment
     end

data/lib/voyage/templates/Gemfile.erb

@@ -13,7 +13,8 @@ gem "normalize-rails", "~> 3.0.0"
 gem "pg"
 gem "puma"
 gem "rack-canonical-host"
-gem "rails", "<%= Voyage::RAILS_VERSION %>"
+# gem "rails", "<%= Voyage::RAILS_VERSION %>"
+gem 'rails', git: 'https://github.com/rails/rails.git', branch: '5-0-stable' # OMG Fix deprecation warnings...
 gem "recipient_interceptor"
 gem "sass-rails", "~> 5.0"
 gem "simple_form"
@@ -24,39 +25,47 @@ gem "title"
 gem "uglifier"
 
 # Customizations
-gem 'responders' # respond to json/html/js more easily in controllers
-gem 'slim-rails' # templating
 gem 'font-awesome-rails'
-gem 'dynamic_form' # for custom messages without the database column
-gem 'nested_form_fields' # Dynamically add and remove nested has_many association fields in a Ruby on Rails form
-gem 'devise'
+gem 'slim-rails'
 
-gem 'turbolinks'
+# Javascript Tweaks
+gem 'gon' # pass variables betwween rails and javascript. Several examples in the application_controller.rb
 gem 'jquery-turbolinks'
 gem 'jquery-ui-rails'
 gem 'nprogress-rails' # Show request progress when a link is clicked
-gem 'gon' # pass variables betwween rails and javascript. Several examples in the application_controller.rb
+gem 'responders' # respond to json/html/js more easily in controllers
+gem 'turbolinks'
 
-gem 'cancancan' # authorization library
+# Authentication / Authorization
 gem 'canard', git: 'https://github.com/jondkinney/canard.git', branch: 'feature/fixed-generators-and-rails-5' # ties into cancancan, adds roles for the user
+gem 'cancancan' # authorization library
+gem 'devise'
+gem 'pretender' # impersonate users as an admin
 
+# Database Tweaks
+gem 'dynamic_form' # for custom messages without the database column
 gem 'friendly_id' # slugs in the url auto-generated
-gem 'paper_trail'
+gem 'nested_form_fields' # Dynamically add and remove nested has_many association fields in a Ruby on Rails form
+# gem 'nondestructive_migrations' # data migrations go here, not in regular ActiveRecord migrations
+gem 'nondestructive_migrations', git: 'https://github.com/mfazekas/nondestructive_migrations.git', branch: 'fix-orm-warning'
+gem 'paper_trail' # version active record models and soft-delete by default
 gem 'settingslogic' # yaml settings (project wide, non-editable), this is implemented with the model Settings.rb
 
-# Want these here for debugging on production
-gem 'pry-byebug' # stepwise debugging inside pry
-gem 'pry-rails' # better REPL than irb
-gem 'pry-awesome_print' # make pry output legible
-gem 'pry-remote'
-
-gem 'nondestructive_migrations'
+# User Uploads
 gem 'carrierwave'
-gem 'mini_magick'
 gem 'fog'
+gem 'mini_magick'
+
+# Cron Jobs
 gem 'whenever', require: false # provides a clear syntax for writing and deploying cron jobs
 gem 'whenever-web'
 
+# Debugging (need at top level if we want pry-remote to work on a deployed prod server)
+gem 'pry-awesome_print' # make pry output legible
+gem 'pry-byebug' # stepwise debugging inside pry
+gem 'pry-rails' # better REPL than irb
+gem 'pry-remote' # Production debugging
+
 group :development do
   gem "listen"
   gem "spring"
@@ -65,13 +74,13 @@ group :development do
 
   # Customizations
   gem 'annotate' # annotate models automatically when rake db:migrate is called
-  gem 'rails-erd' # auto gen ERD Diagram of models in the app on rake db:migrate
-  gem 'zenflow', git: 'https://github.com/zencoder/zenflow.git'
   gem 'better_errors' # A better error page for rails when a local 500 (or similar) is thrown
   gem 'binding_of_caller' # REPL in better_errors to debug in the browser at the point at which it failed
-  gem 'meta_request' # for chrome rails console plugin found here: https://chrome.google.com/webstore/detail/railspanel/gjpfobpafnhjhbajcjgccbbdofdckggg?hl=en-US
   gem 'bitters', '~> 1.3'
+  gem 'meta_request' # for chrome rails console plugin found here: https://chrome.google.com/webstore/detail/railspanel/gjpfobpafnhjhbajcjgccbbdofdckggg?hl=en-US
+  gem 'rails-erd' # auto gen ERD Diagram of models in the app on rake db:migrate
   gem 'redcarpet' # used to render the readme inside a static welcome page from the high_voltage gem
+  gem 'zenflow', git: 'https://github.com/zencoder/zenflow.git'
 end
 
 group :development, :test do
@@ -86,11 +95,9 @@ group :development, :test do
 
   # Customizations
   gem 'faker' # provides auto generated names for factories, can be customized
-
+  gem 'letter_opener' # auto-open emails when they're sent
   gem 'rubocop'
   gem 'rubocop-rspec', require: false
-
-  gem 'letter_opener' # auto-open emails when they're sent
 end
 
 group :development, :staging do
@@ -109,12 +116,15 @@ group :test do
 
   # Customizations
   gem 'cadre' # highlights code coverage in vim
-
-  gem 'capybara'
-  gem 'poltergeist'
-  gem 'selenium-webdriver' # brew install chromedriver
+  gem 'capybara' # DSL for finding elements on a page during integration testing
+  gem 'poltergeist' # Headless browser, used in integration tests
+  gem 'selenium-webdriver' # `brew install chromedriver`, used for acceptance tests in an actual browser.
 end
 
 group :staging, :production do
   gem "rack-timeout"
 end
+
+group :production do
+  gem 'analytics-ruby', '~> 2.2.2', require: 'segment/analytics'
+end

data/lib/voyage/templates/README.md.erb

@@ -7,22 +7,27 @@ with the necessary dependencies to run and test this app:
 
     % ./bin/setup
 
-It assumes you have a machine equipped with Ruby, Postgres, etc. If not, set up
-your machine with [this script].
+It assumes you have a machine equipped with Ruby, Postgres, etc.
 
-[this script]: https://github.com/thoughtbot/laptop
+## Seeded Data
 
-After setting up, you can run the application using [Heroku Local]:
+Assuming that devise was opted in to, a user and admin have been seeded for you:
 
-    % heroku local
+    admin@example.com -> asdfjkl123
+    user_1@example.com -> asdfjkl123
 
-[Heroku Local]: https://devcenter.heroku.com/articles/heroku-local
+## Static Pages
 
-## Guidelines
+The HighVoltage gem is used.
 
-Use the following guides for getting things done, programming well, and
-programming in style.
+## Authorization
 
-* [Protocol](http://github.com/thoughtbot/guides/blob/master/protocol)
-* [Best Practices](http://github.com/thoughtbot/guides/blob/master/best-practices)
-* [Style](http://github.com/thoughtbot/guides/blob/master/style)
+This repo uses CanCanCan and Canard to authorize user action. `ApplicationController` defines the `check_authorization` method for non-devise non-high voltage controllers. If you want to skip authorization for a specific method in a controller, the following method can be used: `skip_authorization_check`
+
+## Rubocop
+
+Take a look at the `.rubocop.yml` file to see what styles are being enforced.
+
+## Annotations
+
+Model & spec files are automatically annotated each time `rake db:migrate` is run.

data/lib/voyage/templates/admin_users_controller.rb

@@ -0,0 +1,40 @@
+module Admin
+  class UsersController < ApplicationController
+    before_action :require_admin!, except: [:stop_impersonating]
+    skip_authorization_check
+
+    def index
+      @users = User.all
+    end
+
+    def impersonate
+      user = User.find(params[:id])
+      track_impersonation(user, 'Start')
+      impersonate_user(user)
+      redirect_to root_path
+    end
+
+    def stop_impersonating
+      track_impersonation(current_user, 'Stop')
+      stop_impersonating_user
+      redirect_to admin_users_path
+    end
+
+    private
+
+    def require_admin!
+      txt = 'You must be an admin to perform that action'
+      redirect_to root_path, notice: txt unless current_user.admin?
+    end
+
+    def track_impersonation(user, status)
+      analytics_track(
+        true_user,
+        "Impersonation #{status}",
+        impersonated_user_id: user.id,
+        impersonated_user_email: user.email,
+        impersonated_by_email: true_user.email,
+      )
+    end
+  end
+end

data/lib/voyage/templates/analytics_alias.html.erb.erb

@@ -0,0 +1,18 @@
+<%% goto = Rails.application.routes.url_helpers.authenticated_root_path %>
+
+<%% content_for :javascript do %>
+  <script type='text/javascript'>
+    $(document).ready(function() {
+      console.log('Aliased: 1st');
+
+      if (typeof analytics != 'undefined') {
+        analytics.alias('<%%= current_user.uuid %>');
+      }
+
+      console.log("Redirect to '<%%= goto %>' after alias & identify");
+
+      window.location.replace('<%%= goto %>');
+    });
+  </script>
+<%% end %>
+

data/lib/voyage/templates/analytics_identify.html.erb.erb

@@ -0,0 +1,42 @@
+<%% if current_user %>
+  <%% address = current_user.try(:address) %>
+  <%% address_attrs = {} %>
+  <%% address_attrs.merge!(
+    city: (address.city rescue 'unknown'),
+    country: 'United States',
+    postal_code: (address.zip rescue 'unknown'),
+    state: (address.state.name rescue 'unknown'),
+    street: ("#{address.line1} #{address.line2}" rescue 'unknown'),
+  ) if address.present? %>
+
+  <script type='text/javascript'>
+    $(document).ready(function() {
+      console.log('Identified: 2nd');
+
+      var analytics_attrs = {
+        email:       "<%%= current_user.email %>",
+        first_name:  "<%%= escape_javascript(current_user.first_name) %>",
+        last_name:   "<%%= escape_javascript(current_user.last_name) %>",
+        address:     "<%%= raw controller.send(:sanitize_hash_javascript, address_attrs).to_json %>",
+        created_at:  "<%%= current_user.created_at.iso8601 %>",
+        roles:       "<%%= current_user.roles.map(&:to_s).join(',') %>",
+        rails_env:   "<%%= Rails.env.to_s %>",
+      }
+
+      console.log(analytics_attrs);
+
+      if (typeof analytics != 'undefined') {
+        analytics.identify(
+          "<%%= current_user.uuid %>",
+          analytics_attrs, {
+          integrations: {
+              Intercom : {
+                user_hash: "<%%= OpenSSL::HMAC.hexdigest('sha256', ENV['INTERCOM_SECURE_MODE_SECRET_KEY'].to_s, current_user.uuid.to_s) %>",
+              }
+            }
+          }
+        );
+      }
+    });
+  </script>
+<%% end %>

data/lib/voyage/templates/analytics_ruby_initializer.rb

@@ -0,0 +1,15 @@
+if Rails.env.production?
+  require 'segment/analytics'
+
+  Analytics = Segment::Analytics.new(
+    write_key: ENV['SEGMENT_ANALYTICS_RUBY_KEY'],
+    on_error:  proc { |_status, msg| Rails.logger.info msg },
+  )
+else
+  Analytics = Struct.new('Analytics') do
+    def self.track(_segment_attributes)
+    end
+    def self.identify(_segment_attributes)
+    end
+  end
+end

data/lib/voyage/templates/devise_registrations_controller.rb

@@ -0,0 +1,17 @@
+module DeviseCustomizations
+  class RegistrationsController < Devise::RegistrationsController
+    def create
+      super
+    end
+
+    protected
+
+    def after_sign_up_path_for(resource)
+      if user_signed_in?
+        analytics_alias_user_path(resource)
+      else
+        new_user_session_path(resource)
+      end
+    end
+  end
+end

data/lib/voyage/templates/rubocop.yml

@@ -27,10 +27,19 @@ AllCops:
     - '.+'
   Exclude:
     - 'db/**/*'
-    - 'config/**/*'
+    - 'config/*'
+    - 'config/environments/*'
+    - 'config/locales/*'
+    - 'config/initializers/devise.rb'
+    - 'config/initializers/simple_form.rb'
+    - 'config/initializers/new_framework_defaults.rb'
+    - 'config/initializers/assets.rb'
+    - 'config/initializers/backtrace_silencers.rb'
+    - 'config/initializers/rack_mini_profiler.rb'
+    - 'config/initializers/wrap_parameters.rb'
     - 'bin/**/*'
   Include:
-    - '**/*.pryrc'
+    - 'Gemfile'
     - '.simplecov'
     - 'config/initializers/*'
 

data/lib/voyage/templates/seeder.rb.erb

@@ -18,8 +18,10 @@ module Seeder
     # Remove all users
     User.destroy_all
 
+    create(:user)
+
     # list user traits from factory_girl here
-    %w(admin another_role).each do |name|
+    %w(admin).each do |name|
       create(:user, name.to_sym)
     end
   end

data/lib/voyage/templates/seeds.rb.erb

@@ -14,7 +14,7 @@ puts
 
 dev_tables_to_seed =
   %w(
-    <%= config[:using_devise] ? 'admin_user' : 'factory_name' %>
+    <%= config[:using_devise] ? 'all_users' : 'factory_name' %>
   )
 
 production_tables_to_seed =

data/lib/voyage/templates/users_index.html.erb

@@ -0,0 +1,28 @@
+<h1>Listing Users</h1>
+
+<table>
+  <thead>
+    <tr><% if config[:adding_first_and_last_name] %>
+      <th>First Name</th>
+      <th>Last Name</th><% end %>
+      <th>Email</th>
+      <th></th>
+      <th></th>
+      <th></th>
+    </tr>
+  </thead>
+  <tbody>
+    <%% @users.each do |user| %>
+      <tr><% if config[:adding_first_and_last_name] %>
+        <td><%%= user.first_name %></td>
+        <td><%%= user.last_name %></td><% end %>
+        <td><%%= link_to user.email, impersonate_admin_user_path(user) %></td>
+        <td><%%= link_to 'Show', user %></td>
+        <td><%%= link_to 'Edit', edit_user_path(user) %></td>
+        <td><%%= link_to 'Destroy', user, data: { confirm: 'Are you sure?' }, method: :delete %></td>
+      </tr>
+    <%% end %>
+  </tbody>
+</table>
+
+<br />

data/lib/voyage/templates/voyage_layout.html.erb.erb

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="<%= I18n.locale %>">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="ROBOTS" content="NOODP" />
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
+    <meta name="apple-mobile-web-app-capable" content="yes" />
+    <meta name="mobile-web-app-capable" content="yes" />
+    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
+    <%%#
+      Configure default and controller-, and view-specific titles in
+      config/locales/en.yml. For more see:
+      https://github.com/calebthompson/title#usage
+    %>
+    <title><%%= title %></title>
+    <%%= stylesheet_link_tag :application, media: "all" %>
+    <link rel='apple-touch-icon' href='/assets/apple-touch-icon.png' />
+    <%%= csrf_meta_tags %>
+    <%%= favicon_link_tag 'favicon.ico' %>
+    <%%# Add gon here for gon use inside the compiled js before the page is fully loaded %>
+    <%%= Gon::Base.render_data %>
+  </head>
+  <body class="<%%= devise_controller? ? 'devise' : 'application' %> <%%= body_class %>">
+    <%%# Add gon here for turbolinks benefit %>
+    <%%= Gon::Base.render_data %>
+    <%%= render 'flashes' -%>
+    <%% if devise_controller? %>
+      <% if config[:add_refills] %><%%= render 'refills/navigation' %><% end %>
+      <%%= yield %>
+    <%% else %>
+      <div class='grid-offset'>
+        <div class='work-area'>
+          <% if config[:add_refills] %><%%= render 'refills/navigation' %><% end %>
+          <%%= yield %>
+        </div>
+      </div>
+    <%% end %>
+
+    <% if config[:add_refills] %><%%= render 'refills/footer' %><% end %>
+    <%%= render 'javascript' %>
+    <%%= render 'css_overrides' %>
+  </body>
+</html>

data/lib/voyage/version.rb

@@ -5,5 +5,5 @@ module Voyage
       .read("#{File.dirname(__FILE__)}/../../.ruby-version")
       .strip
       .freeze
-  VERSION = '1.44.0.6'.freeze
+  VERSION = '1.44.0.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voyage
 version: !ruby/object:Gem::Version
-  version: 1.44.0.6
+  version: 1.44.0.7
 platform: ruby
 authors:
 - thoughtbot, headway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-12 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bitters
@@ -87,6 +87,7 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
+- TODO.md
 - USAGE
 - bin/rake
 - bin/rspec
@@ -108,17 +109,23 @@ files:
 - lib/voyage/templates/Gemfile.erb
 - lib/voyage/templates/README.md.erb
 - lib/voyage/templates/about.html.erb
+- lib/voyage/templates/admin_users_controller.rb
+- lib/voyage/templates/analytics_alias.html.erb.erb
+- lib/voyage/templates/analytics_identify.html.erb.erb
+- lib/voyage/templates/analytics_ruby_initializer.rb
 - lib/voyage/templates/application.js
 - lib/voyage/templates/auto_annotate_models.rake
 - lib/voyage/templates/config_locales_en.yml.erb
 - lib/voyage/templates/controller_helpers.rb
 - lib/voyage/templates/custom_cancan_matchers.rb
+- lib/voyage/templates/devise_registrations_controller.rb
 - lib/voyage/templates/rails_helper.rb.erb
 - lib/voyage/templates/rubocop.yml
 - lib/voyage/templates/seeder.rb.erb
 - lib/voyage/templates/seeds.rb.erb
 - lib/voyage/templates/simplecov.rb
-- lib/voyage/templates/users_index.html.slim.erb
+- lib/voyage/templates/users_index.html.erb
+- lib/voyage/templates/voyage_layout.html.erb.erb
 - lib/voyage/templates/welcome.html.erb
 - lib/voyage/version.rb
 - spec/adapters/heroku_spec.rb

data/lib/voyage/templates/users_index.html.slim.erb

@@ -1,25 +0,0 @@
-h1 Listing Users
-
-table
-  thead
-    tr<% if config[:adding_first_and_last_name] %>
-      th First Name
-      th Last Name<% end %>
-      th Email
-      th
-      th
-      th
-
-  tbody
-    - @users.each do |user|
-      tr<% if config[:adding_first_and_last_name] %>
-        td= user.first_name
-        td= user.last_name<% end %>
-        td= user.email
-        td= link_to 'Show', user
-        td= link_to 'Edit', edit_user_path(user)
-        td= link_to 'Destroy', user, data: { confirm: 'Are you sure?' }, method: :delete
-
-br
-
-= link_to 'New User', signup_path