grape-slack-bot 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b53a91399f6f62b4e41344291c542bc21fd0ba9a8fc0439cbdcedf582b136f2
-  data.tar.gz: 8e1f65196522cb4289d34fb74ffe7aeab067cd1998587ffeccbe460dea687f94
+  metadata.gz: f84c93d79a89045d58deda55e64382c8ef74daf4975e0f47732b480c08619020
+  data.tar.gz: 6f3e952d9a8f85e48de8f045aab1c35f0d69e9ac39b8328c240f38c77c578ad0
 SHA512:
-  metadata.gz: ceccba665b1446c26bb0168af5e4d80336e2bf48eb7d58d7b293073041298587980f697372f97a9f5e26852f0753e59f4bd6933d2ece99936535df35917f4786
-  data.tar.gz: 015ca10566222e5472c36736a97b382775008b8d8fb98eb1e1ee6a9d8ed79d211b2e765d78ff328a707bcb3998800a8d51d22d2950b7bfe6909f12bff421fea2
+  metadata.gz: 458e378569349642ecf2433fd573d3ad40ef69def84a6253206ff5bcef2b9d983c24b0d1e53a30887de7a8203dcf733ba868bbbbc9b4e215ded1f71487c3dd12
+  data.tar.gz: dd5ef3106d1a1255cb788bef313d905ca986133bc5b3b3e53166c70b9727f8d3b996cce595f724e80b9d08ec4338ca91fbedcf135945878c01a61d32872375ef

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.2.0
+
+* Remove `Rails.logger` dependency, make logger configurable
+
 # 1.1.0
 
 * Set minimum ruby version requirement to 2.5.0

data/README.md

@@ -133,6 +133,7 @@ References:
 Create `app/api/slack_bot_api.rb`, it will contain bot configuration and endpoints setup:
 
 ```ruby
+SlackBot::DevConsole.logger = Rails.logger
 SlackBot::DevConsole.enabled = Rails.env.development?
 SlackBot::Config.configure do
   callback_storage Rails.cache

data/lib/slack_bot/dev_console.rb

@@ -1,4 +1,9 @@
 module SlackBot
+  class Logger
+    def info(*args, **kwargs)
+      puts args, kwargs
+    end
+  end
   class DevConsole
     def self.enabled=(value)
       @enabled = value
@@ -8,24 +13,32 @@ module SlackBot
       @enabled
     end
 
-    def self.log(message = nil, &)
+    def self.logger=(value)
+      @logger = value
+    end
+
+    def self.logger
+      @logger ||= Logger.new
+    end
+
+    def self.log(message = nil, &block)
       return unless enabled?
 
       message = yield if block_given?
-      Rails.logger.info(message)
+      logger.info(message)
     end
 
-    def self.log_input(message = nil, &)
+    def self.log_input(message = nil, &block)
       message = yield if block_given?
       log(">>> #{message}")
     end
 
-    def self.log_output(message = nil, &)
+    def self.log_output(message = nil, &block)
       message = yield if block_given?
       log("<<< #{message}")
     end
 
-    def self.log_check(message = nil, &)
+    def self.log_check(message = nil, &block)
       message = yield if block_given?
       log("!!! #{message}")
     end

data/lib/slack_bot.rb

@@ -21,5 +21,5 @@ require 'slack_bot/pager'
 require 'slack_bot/grape_extension'
 
 module SlackBot
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/spec/slack_bot/dev_console_spec.rb

@@ -0,0 +1,88 @@
+module SlackBot
+  class Logger
+    def info(*args, **kwargs)
+      puts args, kwargs
+    end
+  end
+  class DevConsole
+    def self.enabled=(value)
+      @enabled = value
+    end
+
+    def self.enabled?
+      @enabled
+    end
+
+    def self.logger=(value)
+      @logger = value
+    end
+
+    def self.logger
+      @logger ||= Logger.new
+    end
+
+    def self.log(message = nil, &block)
+      return unless enabled?
+
+      message = yield if block_given?
+      logger.info(message)
+    end
+
+    def self.log_input(message = nil, &block)
+      message = yield if block_given?
+      log(">>> #{message}")
+    end
+
+    def self.log_output(message = nil, &block)
+      message = yield if block_given?
+      log("<<< #{message}")
+    end
+
+    def self.log_check(message = nil, &block)
+      message = yield if block_given?
+      log("!!! #{message}")
+    end
+  end
+end
+
+require 'spec_helper'
+
+describe SlackBot::DevConsole do
+  let(:logger) { instance_double(SlackBot::Logger) }
+  before do
+    described_class.enabled = true
+    described_class.logger = logger
+  end
+
+  describe '.enabled=' do
+    it 'sets the enabled value' do
+      expect { described_class.enabled = false }.to change(described_class, :enabled?).from(true).to(false)
+    end
+  end
+
+  describe '.logger=' do
+    let(:new_logger) { instance_double(SlackBot::Logger) }
+    after { described_class.logger = logger }
+    it 'sets the logger' do
+      expect { described_class.logger = new_logger }.to change(described_class, :logger).from(logger).to(new_logger)
+    end
+  end
+
+  describe '.log' do
+    context 'when enabled' do
+      before { described_class.enabled = true }
+      it 'logs the message' do
+        expect(described_class.logger).to receive(:info).with('test')
+        described_class.log('test')
+      end
+    end
+
+    context 'when disabled' do
+      before { described_class.enabled = false }
+      it 'does not log the message' do
+        expect(described_class.logger).not_to receive(:info)
+        described_class.log('test')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-slack-bot
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrei Makarov
@@ -182,6 +182,7 @@ files:
 - spec/slack_bot/callback_spec.rb
 - spec/slack_bot/command_spec.rb
 - spec/slack_bot/config_spec.rb
+- spec/slack_bot/dev_console_spec.rb
 - spec/slack_bot/event_spec.rb
 - spec/slack_bot/grape_extension_spec.rb
 - spec/slack_bot/interaction_spec.rb
@@ -223,6 +224,7 @@ test_files:
 - spec/slack_bot/callback_spec.rb
 - spec/slack_bot/command_spec.rb
 - spec/slack_bot/config_spec.rb
+- spec/slack_bot/dev_console_spec.rb
 - spec/slack_bot/event_spec.rb
 - spec/slack_bot/grape_extension_spec.rb
 - spec/slack_bot/interaction_spec.rb