grape-slack-bot 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b53a91399f6f62b4e41344291c542bc21fd0ba9a8fc0439cbdcedf582b136f2
-  data.tar.gz: 8e1f65196522cb4289d34fb74ffe7aeab067cd1998587ffeccbe460dea687f94
+  metadata.gz: 34be79021e713fec3adb16eaf1006303d01fb3e5da025daba80aa28ee6400bd8
+  data.tar.gz: 7c978813cafc6cb78c97d8db3001e90a9f5961eac73269e0c748e0b4fedcebc5
 SHA512:
-  metadata.gz: ceccba665b1446c26bb0168af5e4d80336e2bf48eb7d58d7b293073041298587980f697372f97a9f5e26852f0753e59f4bd6933d2ece99936535df35917f4786
-  data.tar.gz: 015ca10566222e5472c36736a97b382775008b8d8fb98eb1e1ee6a9d8ed79d211b2e765d78ff328a707bcb3998800a8d51d22d2950b7bfe6909f12bff421fea2
+  metadata.gz: 1c55b60b6ea73f8528daee36229b9556f8c1fbe885caebd135181d561ed73629e5ebe4784ff2e7cdb9f3d581acc758db493112571f1d0c0eea8824e1613bd6ee
+  data.tar.gz: ed3c34753a2affe1dc01031ebc43af4fd5dea85279cf09cab6272893f81930f5099de57716dbf2cd0f4d5a63166175721bfe657234ead03ba094186f62f8babf

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 1.2.1
+
+* Extract `SlackBot::Logger` to separate file
+
+# 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

@@ -8,24 +8,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/logger.rb

@@ -0,0 +1,8 @@
+module SlackBot
+  class Logger
+    def info(*args, **kwargs)
+      puts args.inspect if args.any?
+      puts kwargs.inspect if kwargs.any?
+    end
+  end
+end

data/lib/slack_bot.rb

@@ -1,3 +1,4 @@
+require 'slack_bot/logger'
 require 'slack_bot/dev_console'
 
 require 'slack_bot/config'
@@ -21,5 +22,5 @@ require 'slack_bot/pager'
 require 'slack_bot/grape_extension'
 
 module SlackBot
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.1'.freeze
 end

data/spec/slack_bot/dev_console_spec.rb

@@ -0,0 +1,95 @@
+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
+
+  describe '.log_input' 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_input('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_input('test')
+      end
+    end
+  end
+
+  describe '.log_output' 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_output('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_output('test')
+      end
+    end
+  end
+
+  describe '.log_check' 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_check('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_check('test')
+      end
+    end
+  end
+end

data/spec/slack_bot/logger_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe SlackBot::Logger do
+  describe '#info' do
+    it 'prints the args' do
+      expect { subject.info('test') }.to output(%(["test"]\n)).to_stdout
+    end
+
+    it 'prints the kwargs' do
+      expect { subject.info(test: 'test') }.to output(%({:test=>"test"}\n)).to_stdout
+    end
+  end
+end

data/spec/slack_bot/pager_spec.rb

@@ -1,5 +1,51 @@
 require 'spec_helper'
 
 describe SlackBot::Pager do
+  let(:args) do
+    instance_double(SlackBot::Args)
+  end
+  before do
+    allow(args).to receive(:[]).with(:page).and_return(1)
+    allow(args).to receive(:[]).with(:per_page).and_return(10)
+  end
 
+  describe '#total_count' do
+    it 'returns the count of the source cursor' do
+      source_cursor = double(count: 10)
+      pager = described_class.new(source_cursor, args: args)
+      expect(pager.total_count).to eq(10)
+    end
+  end
+
+  describe '#pages_count' do
+    it 'returns the count of the source cursor divided by the limit' do
+      source_cursor = double(count: 10)
+      pager = described_class.new(source_cursor, args: args, limit: 5)
+      expect(pager.pages_count).to eq(2)
+    end
+
+    it 'returns the count of the source cursor divided by the limit' do
+      source_cursor = double(count: 11)
+      pager = described_class.new(source_cursor, args: args, limit: 5)
+      expect(pager.pages_count).to eq(3)
+    end
+  end
+
+  describe '#offset' do
+    it 'returns the offset based on the page and limit' do
+      source_cursor = double(count: 10)
+      pager = described_class.new(source_cursor, args: args, limit: 5, page: 2)
+      expect(pager.offset).to eq(5)
+    end
+  end
+
+  describe '#cursor' do
+    it 'returns the cursor with the limit and offset' do
+      source_cursor = double(count: 10)
+      expect(source_cursor).to receive(:limit).with(5).and_return(source_cursor)
+      expect(source_cursor).to receive(:offset).with(5).and_return(source_cursor)
+      pager = described_class.new(source_cursor, args: args, limit: 5, page: 2)
+      expect(pager.cursor).to eq(source_cursor)
+    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.1
 platform: ruby
 authors:
 - Andrei Makarov
@@ -174,6 +174,7 @@ files:
 - lib/slack_bot/event.rb
 - lib/slack_bot/grape_extension.rb
 - lib/slack_bot/interaction.rb
+- lib/slack_bot/logger.rb
 - lib/slack_bot/menu_options.rb
 - lib/slack_bot/pager.rb
 - lib/slack_bot/view.rb
@@ -182,9 +183,11 @@ 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
+- spec/slack_bot/logger_spec.rb
 - spec/slack_bot/menu_options_spec.rb
 - spec/slack_bot/pager_spec.rb
 - spec/slack_bot/view_spec.rb
@@ -223,9 +226,11 @@ 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
+- spec/slack_bot/logger_spec.rb
 - spec/slack_bot/menu_options_spec.rb
 - spec/slack_bot/pager_spec.rb
 - spec/slack_bot/view_spec.rb