timber 2.1.0.rc3 → 2.1.0.rc4

data/lib/timber/cli/installers/rails.rb

@@ -1,11 +1,5 @@
-begin
-  require "lograge"
-rescue Exception
-end
-
-require "timber/cli/config_file"
-require "timber/cli/file_helper"
 require "timber/cli/installer"
+require "timber/cli/installers/config_file"
 require "timber/cli/io/messages"
 
 module Timber
@@ -14,106 +8,113 @@ module Timber
       class Rails < Installer
         # Runs the installer.
         def run(app)
-          # Ask all of the questions up front. This allows us to to apply the
-          # changes as a neat task list when done.
-          development_preference = get_development_preference
+          install_initializer(app)
+          install_development_environment(app)
+          install_test_environment(app)
 
-          api_key_storage_preference = if get_delivery_strategy(app) == :http
-            get_api_key_storage_preference
-          else
-            nil
+          if !app.development? && !app.test?
+            install_app_environment(app)
           end
+        end
 
-          should_logrageify = logrageify?
-
-          io.puts ""
-          io.puts IO::Messages.separator
-          io.puts ""
-
-          # Create the initializer
-          initializer
-
-          if should_logrageify
-            logrageify!
+        private
+          def install_initializer(app)
+            initializer_path = File.join("config", "initializers", "timber.rb")
+            installer = ConfigFile.new(io, api)
+            installer.run(app, initializer_path)
           end
 
-          environment_file_paths.each do |environment_file_path|
-            environment = File.split(environment_file_path).last.gsub(/\.rb$/, "").to_sym
-
-            case environment
-            when :development
-              setup_development_environment(environment_file_path, development_preference)
-            when :test
-              setup_test_environment(environment_file_path)
+          # Determines the development preference
+          def get_development_preference(app)
+            if app.development?
+              return :send
             else
-              setup_other_environment(app, environment_file_path, api_key_storage_preference)
-            end
-          end
-
-          true
-        end
-
-        private
-          def logrageify?
-            if defined?(::Lograge)
               io.puts ""
               io.puts IO::Messages.separator
               io.puts ""
-              io.puts "We noticed you have lograge installed. Would you like to configure "
-              io.puts "Timber to function similarly?"
-              io.puts "(This silences template renders, sql queries, and controller calls."
-              io.puts "You can always do this later in config/initialzers/timber.rb)"
+              io.puts "Would you like to temporarily send development logs to this Timber app?"
+              io.puts "(Logs will still go to STDOUT, but this provides an easy way to kick the "
+              io.puts "tires. Once you're done testing, you can disable this in "
+              io.puts "#{IO::ANSI.colorize("config/environments/development.rb", :yellow)})"
               io.puts ""
-              io.puts "y) Yes, configure Timber like lograge", :blue
-              io.puts "n) No, use the Rails logging defaults", :blue
+              io.puts "y) Yes, send development logs to Timber", :blue
+              io.puts "n) No, just print development logs to STDOUT", :blue
               io.puts ""
 
-              case io.ask_yes_no("Enter your choice:", event_prompt: "Logrageify?")
+              case io.ask_yes_no("Enter your choice:", event_prompt: "Send dev logs to Timber?")
               when :yes
-                true
+                :send
               when :no
-                false
+                :dont_send
               end
-            else
-              false
             end
           end
 
-          def logrageify!
-            task_message = "Logrageifying in #{initializer.path}"
-            io.task(task_message) do
-              initializer.logrageify!
+          def install_development_environment(app)
+            environment_file_path = get_environment_file_path("development")
+            if environment_file_path
+              if already_installed?(environment_file_path)
+                io.task_complete("Timber::Logger already installed #{environment_file_path}")
+                return :already_installed
+              end
+
+              development_preference = get_development_preference(app)
+
+              case development_preference
+              when :send
+                api_key_code = get_api_key_code(:inline)
+
+                logger_code = <<-CODE
+  # Install the Timber.io logger
+  send_logs_to_timber = true # <---- set to false to stop sending dev logs to Timber.io
+
+  log_device = send_logs_to_timber ? Timber::LogDevices::HTTP.new(#{api_key_code}) : STDOUT
+  logger = Timber::Logger.new(log_device)
+  logger.level = config.log_level
+  config.logger = #{config_set_logger_code}
+CODE
+
+                install_logger(environment_file_path, logger_code)
+                return :http
+
+              else
+                install_stdout(environment_file_path)
+                return :stdout
+              end
             end
-            true
           end
 
-          # Determines the development preference
-          def get_development_preference
-            io.puts ""
-            io.puts IO::Messages.separator
-            io.puts ""
-            io.puts "Would you like to temporarily send development logs to Timber?"
-            io.puts "(Logs will still go to STDOUT, but this provides an easy way to kick the "
-            io.puts "tires. Once you're done testing, you can disable this in "
-            io.puts "#{IO::ANSI.colorize("config/environments/development.rb", :yellow)})"
-            io.puts ""
-            io.puts "y) Yes, send development logs to Timber", :blue
-            io.puts "n) No, just print development logs to STDOUT", :blue
-            io.puts ""
+          def install_test_environment(app)
+            environment_file_path = get_environment_file_path("test")
+            if environment_file_path
+              if already_installed?(environment_file_path)
+                io.task_complete("Timber::Logger already installed #{environment_file_path}")
+                return :already_installed
+              end
 
-            case io.ask_yes_no("Enter your choice:", event_prompt: "Send dev logs to Timber?")
-            when :yes
-              :send
-            when :no
-              :dont_send
+              # Tests should not be logged by default.
+              install_nil(environment_file_path)
+              :nil
             end
           end
 
-          def initializer
-            @initializer ||= begin
-              initializer_path = File.join("config", "initializers", "timber.rb")
-              task_message = "Creating #{initializer_path}"
-              io.task(task_message) { ConfigFile.new(initializer_path) }
+          def install_app_environment(app)
+            environment_file_path = get_environment_file_path(app.environment) || get_environment_file_path("production")
+            if environment_file_path
+              if already_installed?(environment_file_path)
+                io.task_complete("Timber::Logger already installed #{environment_file_path}")
+                return :already_installed
+              end
+
+              case get_delivery_strategy(app)
+              when :http
+                api_key_storage_preference = get_api_key_storage_preference
+                install_http(environment_file_path, api_key_storage_preference)
+                :http
+              when :stdout
+                install_stdout(environment_file_path)
+                :stdout
+              end
             end
           end
 
@@ -124,66 +125,14 @@ module Timber
               "ActiveSupport::TaggedLogging.new(logger)" : "logger"
           end
 
-          # Traverses the config/environments directory and returns an array of
-          # symbols representing the various environments.
-          def environment_file_paths
-            path = File.join("config", "environments", "*.rb")
-            Dir[path]
-          end
-
-          def setup_development_environment(environment_file_path, development_preference)
-            if already_configured?(environment_file_path)
-              message = "Installing the Timber::Logger in #{environment_file_path}"
-              io.puts IO::Messages.task_complete(message), :green
-              return true
-            end
-
-            case development_preference
-            when :send
-              extra_comment = <<-NOTE
-  # Note: When you are done testing, simply instantiate the logger like this:
-  #
-  #   logger = Timber::Logger.new(STDOUT)
-  #
-  # Be sure to remove the "log_device =" and "logger =" lines below.
-NOTE
-              extra_comment = extra_comment.rstrip
-              install_http(environment_file_path, :inline, extra_comment: extra_comment)
-            when :dont_send
-              install_stdout(environment_file_path)
-            end
-          end
-
-          def setup_test_environment(environment_file_path)
-            if already_configured?(environment_file_path)
-              message = "Installing the Timber::Logger in #{environment_file_path}"
-              io.puts IO::Messages.task_complete(message), :green
-              return true
-            end
-
-            # Tests should not be logged by default.
-            install_nil(environment_file_path)
-          end
-
-          def setup_other_environment(app, environment_file_path, api_key_storage_preference)
-            if already_configured?(environment_file_path)
-              message = "Installing the Timber::Logger in #{environment_file_path}"
-              io.puts IO::Messages.task_complete(message), :green
-              return true
-            end
-
-            case get_delivery_strategy(app)
-            when :http
-              install_http(environment_file_path, api_key_storage_preference)
-            when :stdout
-              install_stdout(environment_file_path)
-            end
+          def get_environment_file_path(environment)
+            path = File.join("config", "environments", "#{environment}.rb")
+            file_helper.exists?(path) ? path : nil
           end
 
           def install_nil(environment_file_path)
             logger_code = <<-CODE
-  # Install the Timber.io logger but silence all logs (log to nil). We install the
-  # logger to ensure the Rails.logger object exposes the proper API.
+  # Install the Timber.io logger, but do not send logs.
   logger = Timber::Logger.new(nil)
   logger.level = config.log_level
   config.logger = #{config_set_logger_code}
@@ -194,12 +143,11 @@ CODE
 
           # Installs the Timber logger using the HTTP transport strategy in the
           # specified environment file.
-          def install_http(environment_file_path, api_key_storage_type, options = {})
+          def install_http(environment_file_path, api_key_storage_type)
             api_key_code = get_api_key_code(api_key_storage_type)
-            extra_comment = options[:extra_comment] ? "\n  #{options[:extra_comment]}" : nil
 
             logger_code = <<-CODE
-  # Install the Timber.io logger, send logs over HTTP.#{extra_comment}
+  # Install the Timber.io logger, send logs over HTTP.
   log_device = Timber::LogDevices::HTTP.new(#{api_key_code})
   logger = Timber::Logger.new(log_device)
   logger.level = config.log_level
@@ -223,15 +171,15 @@ CODE
             install_logger(environment_file_path, logger_code)
           end
 
-          # Determines if the environment is already configured.
-          def already_configured?(environment_file_path)
+          # Determines if the environment is already installed.
+          def already_installed?(environment_file_path)
             environment_file_contents = get_environment_file_contents(environment_file_path)
             logger_installed?(environment_file_contents)
           end
 
           # Convenience method for getting the current environment file contents.
           def get_environment_file_contents(environment_file_path)
-            FileHelper.read(environment_file_path)
+            file_helper.read(environment_file_path)
           end
 
           # Determines if the Timber logger is already installed in the environment
@@ -249,8 +197,7 @@ CODE
             io.task(task_message) do
               if !logger_installed?(current_contents)
                 new_contents = current_contents.sub(/\nend/, "\n\n#{logger_code}\nend")
-                FileHelper.write(environment_file_path, new_contents)
-                api.event(:file_written, path: environment_file_path)
+                file_helper.write(environment_file_path, new_contents)
               end
             end
 

data/lib/timber/cli/installers/root.rb

@@ -33,20 +33,10 @@ module Timber
             run_sub_installer(app)
             send_test_messages
             confirm_log_delivery
-
-            assist_with_git
-
+            wrap_up(app)
             api.event(:success)
-
             collect_feedback
-
-            io.puts ""
-            io.puts IO::Messages.separator
-            io.puts ""
-            io.puts IO::Messages.free_data
-            io.puts ""
-
-            true
+            free_data
 
           when :no
             io.puts ""
@@ -55,8 +45,6 @@ module Timber
             io.puts "    #{IO::Messages.edit_app_url(app)}", :blue
             io.puts ""
             io.puts "exiting..."
-
-            false
           end
         end
 
@@ -111,48 +99,68 @@ module Timber
             end
           end
 
-          def assist_with_git
+          def wrap_up(app)
+            if app.development? || app.test?
+              development_note
+            else
+              assist_with_commit_and_deploy
+            end
+          end
+
+          def development_note
             io.puts ""
             io.puts IO::Messages.separator
             io.puts ""
-            io.puts "Last step! We need to commit these changes via git:"
+            io.puts "All done! Simply run your application locally and you'll see logs"
+            io.puts "show up in Timber. Enjoy!"
             io.puts ""
-            io.puts IO::Messages.git_commands
+            io.puts "When you're ready to move to production/staging, create a"
+            io.puts "production/staging app in Timber and follow the instructions shown."
+            io.puts ""
+            io.ask_to_proceed
+          end
+
+          def assist_with_commit_and_deploy
+            io.puts ""
+            io.puts IO::Messages.separator
             io.puts ""
 
             if OSHelper.has_git?
-              case io.ask_yes_no("We can run these commands for you. Shall we?", event_prompt: "Run git commands?")
+              case io.ask_yes_no("All done! Would you like to commit these changes?", event_prompt: "Run git commands?")
               when :yes
                 io.puts ""
 
                 task_message = "Committing changes via git"
-                io.write IO::Messages.task_start(task_message)
+                io.task_start(task_message)
 
                 committed = OSHelper.git_commit_changes
 
                 if committed
-                  io.puts IO::Messages.task_complete(task_message), :green
+                  io.task_complete(task_message)
                 else
-                  io.puts IO::Messages.task_failed(task_message), :red
+                  io.task_failed(task_message)
 
                   io.puts ""
                   io.puts "Bummer, it looks like we couldn't access the git command.", :yellow
-                  io.puts "No problem though, just copy and paste the above commands to", :yellow
-                  io.puts "run them manually.", :yellow
+                  io.puts "No problem though, just run these commands yourself:", :yellow
+                  io.puts ""
+                  io.puts IO::Messages.git_commands
                 end
               when :no
                 io.puts ""
-                io.puts "No problem. Just copy and paste the above commands to run them manually."
+                io.puts "No problem. Here's the commands for reference when you're ready:"
+                io.puts ""
+                io.puts IO::Messages.git_commands
               end
             else
               io.puts ""
-              io.puts "Finally, commit your changes:"
+              io.puts "All done! Commit your changes:"
               io.puts ""
               io.puts IO::Messages.git_commands
             end
 
             io.puts ""
-            io.puts "=> Reminder: git push and deploy 🚀 to see logs in staging/production", :yellow
+            io.puts "=> Reminder: remember to deploy 🚀 to see logs in staging/production", :yellow
           end
 
           def collect_feedback
@@ -182,7 +190,15 @@ module Timber
               io.puts ""
               io.puts "Thank you! We take feedback seriously and will work to improve this."
             end
-        end
+          end
+
+          def free_data
+            io.puts ""
+            io.puts IO::Messages.separator
+            io.puts ""
+            io.puts IO::Messages.free_data
+            io.puts ""
+          end
       end
     end
   end

data/lib/timber/cli/io.rb

@@ -76,15 +76,27 @@ module Timber
       end
 
       def task(message, &block)
-        write IO::Messages.task_start(message), :blue
+        task_start(message)
         result = yield
-        puts IO::Messages.task_complete(message), :green
+        task_complete(message)
         result
       rescue Exception => e
-        puts IO::Messages.task_failed(message), :red
+        task_failed(message)
         raise e
       end
 
+      def task_start(message)
+        write IO::Messages.task_start(message), :blue
+      end
+
+      def task_complete(message)
+        puts IO::Messages.task_complete(message), :green
+      end
+
+      def task_failed(message)
+        puts IO::Messages.task_failed(message), :red
+      end
+
       def write(message, color = nil)
         if color
           message = ANSI.colorize(message, color)