dradis-plugins 4.5.0 → 4.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4339c131aa207ace140362e142a78fdcff456be73ea28613305e1b2d4c95c9c2
-  data.tar.gz: e9c6f6ca411e7475ed8a36c9bf47946de8518106d9c10d332773c4488f44e11b
+  metadata.gz: 5d385ebd646d7e8827ff888c7ac8d72594e5c76b2e7e1d9b819d878a4f7fcbb8
+  data.tar.gz: 7295528af5c762c08cf94d05978181fec7ba65de17358932557c75c252d17eca
 SHA512:
-  metadata.gz: 6b23de36437861bf0e659a71edf7e747c19aa04736017c71254224747533dd56aa460da39e365020db79879d6287adae8fa02babaf6f1a36069946afd7277c28
-  data.tar.gz: 960e7ceb874626d3daba375a75fc41c988d5b68984a81d01d328507c1471aee5610621b5ad7d9de847c196e699226f35a038aecc2b7fa65d3e18abfd55571455
+  metadata.gz: 48bf16edf79e4bec72dcba64fc57bf5f7fda88f8c656bfafa5d948a8822c67565c663f2b632e2f41d323e292b3fcf0c70c521f63f9025c0fac9dab51e542cbe8
+  data.tar.gz: 72617d3db6285dbb639369fbc707c66a9b8af00427da56aada7fd166dbd686059a86fb4dacfca8267c41a60b90702662fbd66ab6c8d18cae50c30161ad81a01e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+
+v4.6.0 (November 2022)
+  - Added engine enable/disable functionality
+
 v4.5.0 (August 2022)
   - No changes
 

data/lib/dradis/plugins/base.rb

@@ -39,6 +39,20 @@ module Dradis
         def provides?(feature)
           @features.include?(feature)
         end
+
+        def enabled?
+          ActiveRecord::Type::Boolean.new.cast(self.settings.enabled)
+        end
+
+        def enable!
+          self.settings.update_settings(enabled: true)
+          Dradis::Plugins::clear_enabled_list
+        end
+
+        def disable!
+          self.settings.update_settings(enabled: false)
+          Dradis::Plugins::clear_enabled_list
+        end
       end
     end
   end

data/lib/dradis/plugins/gem_version.rb

@@ -7,8 +7,8 @@ module Dradis
 
     module VERSION
       MAJOR = 4
-      MINOR = 5
-      TINY  = 0
+      MINOR = 6
+      TINY  = 1
       PRE   = nil
 
       STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/lib/dradis/plugins/settings.rb

@@ -5,7 +5,7 @@ module Dradis::Plugins
     def initialize(namespace)
       @namespace = namespace
       @dirty_options ||= {}
-      @default_options ||= HashWithIndifferentAccess.new
+      @default_options ||= { enabled: true }.with_indifferent_access
     end
 
     def respond_to?(name)
@@ -13,7 +13,7 @@ module Dradis::Plugins
     end
 
     def all
-      @default_options.map do |key, value|
+      @default_options.except(:enabled).map do |key, value|
         {
           name: key.to_sym,
           value: value = dirty_or_db_setting_or_default(key.to_sym),

data/lib/dradis/plugins.rb

@@ -11,10 +11,19 @@ module Dradis
         @@extensions
       end
 
+      # Returns an array of modules representing currently enabled engines
+      def enabled_list
+        @@enabled_list ||= @@extensions.select(&:enabled?)
+      end
+
+      def clear_enabled_list
+        @@enabled_list = nil
+      end
+
       # Filters the list of plugins and only returns those that provide the
-      # requested feature.
+      # requested feature and enabled
       def with_feature(feature)
-        @@extensions.select do |plugin|
+        enabled_list.select do |plugin|
           # engine = "#{plugin}::Engine".constantize
           plugin.provides?(feature)
         end

data/spec/engine_spec.rb

@@ -0,0 +1,34 @@
+require 'rails_helper'
+
+class TestEngine < ::Rails::Engine
+  include ::Dradis::Plugins::Base
+  addon_settings :test_engine do
+  end
+end
+
+describe Dradis::Plugins::Base do
+  before(:each) do
+    TestEngine::settings.reset_defaults!
+  end
+
+  describe '#enabled?' do
+    it 'returns default value' do
+      expect(TestEngine.enabled?).to eq(false)
+    end
+  end
+  describe '#enable!' do
+    it 'sets enabled to true' do
+      expect { TestEngine.enable! }.to change {
+        TestEngine.enabled?
+      }.from(false).to(true)
+    end
+  end
+  describe '#disable!' do
+    it 'sets enabled to false' do
+      TestEngine.enable!
+      expect { TestEngine.disable! }.to change {
+        TestEngine.enabled?
+      }.from(true).to(false)
+    end
+  end
+end

data/spec/settings_spec.rb

@@ -1,7 +1,7 @@
 #
 # This spec must be ran from Dradis root dir
 #
-require 'spec_helper'
+require 'rails_helper'
 
 class TestEngine < ::Rails::Engine
   include ::Dradis::Plugins::Base
@@ -19,6 +19,7 @@ describe Dradis::Plugins::Settings do
   end
 
   it "sets and return default values" do
+    expect(TestEngine::settings.enabled).to eq(false)
     expect(TestEngine::settings.host).to eq('localhost')
     expect(TestEngine::settings.port).to eq(80)
   end
@@ -41,7 +42,6 @@ describe Dradis::Plugins::Settings do
   it "saves to db and returns persisted values" do
     expect(TestEngine::settings.host).to eq('localhost')
     TestEngine::settings.host = '127.0.0.1'
-    expect_any_instance_of(TestEngine::settings::send(:configuration_class)).to receive(:update_attribute)
     expect(TestEngine::settings.save).to eq( { host: '127.0.0.1'} )
     expect(TestEngine::settings.host).to eq('127.0.0.1')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dradis-plugins
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.1
 platform: ruby
 authors:
 - Daniel Martin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,7 @@ files:
 - lib/dradis/plugins/upload/field_processor.rb
 - lib/dradis/plugins/upload/importer.rb
 - lib/dradis/plugins/version.rb
+- spec/engine_spec.rb
 - spec/internal/log/test.log
 - spec/lib/dradis/plugins/content_service/boards_spec.rb
 - spec/lib/dradis/plugins/content_service/issues_spec.rb
@@ -112,7 +113,7 @@ homepage: http://dradisframework.org
 licenses:
 - GPL-2
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,11 +128,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Plugin manager for the Dradis Framework project.
 test_files:
+- spec/engine_spec.rb
 - spec/internal/log/test.log
 - spec/lib/dradis/plugins/content_service/boards_spec.rb
 - spec/lib/dradis/plugins/content_service/issues_spec.rb