redmine_plugin_kit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1ca2a8bc5bffe81e35eb4a4f5429914b90a47af862c234de0f19af6e767ef85
+  data.tar.gz: 2db5c0fe2c3ffc6737f7022d695539299a7602da4066dab747ef31a1a46daff0
+SHA512:
+  metadata.gz: b4ea61b8eb25d27514dec076749921f7a0153f72f2844de446b657dee25001ab7bd2f97211afd7525fa0fe19f4fdbacb3b432607a52ae8f2cb3362e814d8e128
+  data.tar.gz: 6f65d73453e5a4db73737c6c17ba5bebc0273067915490560b8121f4121538954f5b216a12aaf8789e4dd88da29eb7c1ad525bfb6edef84497024bbe640aac99

data/.github/workflows/rubocop.yml

@@ -0,0 +1,29 @@
+name: Run Rubocop
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Install package dependencies
+      run: >
+        sudo apt-get install --yes --quiet pandoc
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+        bundler-cache: true
+
+    - name: Setup gems
+      run: |
+        bundle install --jobs 4 --retry 3
+
+    - name: Run RuboCop
+      run: |
+        bundle exec rubocop -S

data/.github/workflows/tests.yml

@@ -0,0 +1,47 @@
+name: Tests
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    name: ${{ matrix.redmine }} ${{ matrix.db }} ruby-${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: ['2.7', '2.6', '3.0']
+      fail-fast: false
+
+    steps:
+      - name: Checkout redmine_plugin_kit
+        uses: actions/checkout@v2
+        with:
+          path: redmine_plugin_kit
+
+      - name: Update package archives
+        run: sudo apt-get update --yes --quiet
+
+      - name: Install package dependencies
+        run: >
+          sudo apt-get install --yes --quiet
+          build-essential
+          cmake
+          libicu-dev
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Install Ruby dependencies
+        working-directory: redmine_plugin_kit
+        run: |
+          bundle install --jobs=4 --retry=3
+
+      - name: Run tests
+        env:
+          RAILS_ENV: test
+        working-directory: redmine_plugin_kit
+        run: rake test RUBYOPT="-W0"

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.buildpath
+coverage/
+tmp/
+Gemfile.lock
+.project
+.settings/
+._*
+*.gem

data/.rubocop.yml

@@ -0,0 +1,116 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
+
+Rails:
+  Enabled: true
+
+AllCops:
+  TargetRubyVersion: 2.6
+  TargetRailsVersion: 5.2
+  NewCops: enable
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: true
+  CountKeywordArgs: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+Layout/LineLength:
+  Max: 140
+
+Metrics/MethodLength:
+  Max: 60
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 25
+
+Style/ExpandPathArguments:
+  Enabled: true
+  Exclude:
+    - redmine_plugin_kit.gemspec
+    - test/**/*
+
+Rails/ApplicationJob:
+  Enabled: false
+
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+Rails/ContentTag:
+  Enabled: true
+  Exclude:
+    - app/helpers/additional_tags_issues_helper.rb
+
+Rails/ApplicationRecord:
+  Enabled: false
+
+Rails/CreateTableWithTimestamps:
+  Enabled: false
+
+Rails/HelperInstanceVariable:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Performance/ChainArrayAllocation:
+  Enabled: true
+
+Style/AutoResourceCleanup:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Exclude:
+    - '/**/*.rsb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/OptionHash:
+  Enabled: true
+  SuspiciousParamNames:
+    - options
+    - api_options
+    - opts
+    - args
+    - params
+    - parameters
+    - settings
+
+Style/ReturnNil:
+  Enabled: true
+
+Style/UnlessLogicalOperators:
+  Enabled: true
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  AllowParenthesesInMultilineCall: true
+  AllowParenthesesInChaining: true
+  EnforcedStyle: omit_parentheses
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: true
+  Exclude:
+    - 'test/**/*'

data/LICENSE

@@ -0,0 +1,339 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/README.md

@@ -0,0 +1,30 @@
+# Redmine Plugin Kit
+
+This gem can be used for [Redmine](https://www.redmine.org/) Plugin for loading customizations.
+
+In an ideal world, all plugins would use this gem as base. Or even better: this gem comes to Redmine core itself.
+
+If you are a Redmine developer, feel free and offer PRs with your Improvements.
+
+## Features
+
+- Loader for plugin customizations
+- Deface support for Redmine plugins
+
+## Why this gem?
+
+1. a standard process for load patches, hooks or helper for plugins
+2. deface is ready to use and does not require any additional plugin (e.g. redmine_base_deface). It is easier for a plugin user, to install one plugin (instead of two). This makes also sure, that all plugins uses the same deface version.
+
+## Requirements
+
+- Redmine `>= 4.1.0` (including upcoming)
+- Ruby `>= 2.6` (only maintained ruby versions are supported)
+
+## Installation
+
+Add Gem to your Gemfile:
+
+```ruby
+gem 'redmine_plugin_kit'
+```

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  files = FileList['test/**/*test.rb']
+  t.test_files = files
+  t.verbose = true
+end
+
+task default: :test

data/config/initializers/deface.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Rails.application.paths['app/overrides'] ||= []
+Dir.glob(Rails.root.join('plugins/*/app/overrides')).each do |dir|
+  Rails.application.paths['app/overrides'] << dir unless Rails.application.paths['app/overrides'].include? dir
+end

data/lib/redmine_plugin_kit/debug.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RedminePluginKit
+  class Debug
+    class << self
+      def log(message = 'running')
+        return if Rails.env.production?
+
+        Rails.logger.debug { "#{Time.current.strftime '%H:%M:%S'} DEBUG [#{caller_locations(1..1).first.label}]: #{raw_msg message}" }
+      end
+
+      def msg(message = 'running')
+        return if Rails.env.production?
+
+        log message
+        puts raw_msg(message) # rubocop: disable Rails/Output
+      end
+
+      private
+
+      def raw_msg(message)
+        message.is_a?(String) ? message : message.inspect
+      end
+    end
+  end
+end

data/lib/redmine_plugin_kit/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RedminePluginKit
+  class Engine < Rails::Engine
+    config.paths.add 'app/overrides', eager_load: true
+  end
+end

data/lib/redmine_plugin_kit/helpers/global_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RedminePluginKit
+  module Helpers
+    module GlobalHelper
+      def link_to_external(name, link, **options)
+        options[:class] ||= 'external'
+        options[:class] = "#{options[:class]} external" if options[:class].exclude? 'external'
+        options[:rel] ||= 'noopener noreferrer'
+
+        link_to name, link, **options
+      end
+
+      def link_to_url(url, **options)
+        return if url.blank?
+
+        parts = url.split '://'
+        name = if parts.count.positive?
+                 parts.shift
+                 parts.join
+               else
+                 url
+               end
+
+        link_to_external name, url, **options
+      end
+    end
+  end
+end

data/lib/redmine_plugin_kit/loader.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+module RedminePluginKit
+  class Loader
+    class ExistingControllerPatchForHelper < StandardError; end
+
+    attr_accessor :plugin_id, :debug
+
+    class << self
+      def to_prepare(*args, &block)
+        if Rails.version > '6.0'
+          # INFO: https://www.redmine.org/issues/36245
+          Rails.logger.info 'after_plugins_loaded hook should be used instead'
+        else
+          # ActiveSupport::Reloader.to_prepare(*args, &block)
+          Rails.configuration.to_prepare(*args, &block)
+        end
+      end
+
+      # same as in init.rb, but in future with more functionality - or for debugging
+      def persisting
+        yield
+      end
+
+      def after_initialize(&block)
+        Rails.application.config.after_initialize(&block)
+      end
+
+      # required multiple times because of this bug: https://www.redmine.org/issues/33290
+      def redmine_database_ready?(with_table = nil)
+        ActiveRecord::Base.connection
+      rescue ActiveRecord::NoDatabaseError
+        false
+      else
+        with_table.nil? || ActiveRecord::Base.connection.table_exists?(with_table)
+      end
+
+      def plugin_dir(plugin_id:)
+        if Gem.loaded_specs[plugin_id].nil?
+          File.join Redmine::Plugin.directory, plugin_id
+        else
+          Gem.loaded_specs[plugin_id].full_gem_path
+        end
+      end
+    end
+
+    def initialize(plugin_id:, debug: false)
+      self.plugin_id = plugin_id
+      self.debug = debug
+
+      apply_reset
+    end
+
+    def default_settings
+      cached_settings_name = "@default_settings_#{plugin_id}"
+      cached_settings = instance_variable_get cached_settings_name
+      if cached_settings.nil?
+        data = yaml_config_load 'settings.yml', with_erb: true
+        instance_variable_set cached_settings_name, data.symbolize_keys
+      else
+        cached_settings
+      end
+    end
+
+    def yaml_config_load(yaml_file, with_erb: false)
+      file_to_load = File.read File.join(plugin_dir, 'config', yaml_file)
+      file_to_load = ERB.new(file_to_load).result if with_erb
+
+      YAML.safe_load(file_to_load) || {}
+    end
+
+    def apply_reset
+      @patches = []
+      @helpers = []
+      @global_helpers = []
+    end
+
+    def plugin_dir
+      @plugin_dir ||= self.class.plugin_dir plugin_id: plugin_id
+    end
+
+    # use_app: false => :plugin_dir/lib/:plugin_id directory
+    def require_files(spec, use_app: false, reverse: false, ignore_autoload: false)
+      dir = if use_app
+              File.join plugin_dir, 'app', spec
+            else
+              File.join plugin_dir, 'lib', plugin_id, spec
+            end
+
+      files = Dir[dir].sort
+
+      files.reverse! if reverse
+      files.each do |f|
+        Rails.autoloaders.main.ignore << f if Rails.version > '6.0' && ignore_autoload
+        require f
+      end
+    end
+
+    def incompatible?(plugins = [])
+      plugins.each do |plugin|
+        raise "\n\033[31m#{plugin_id} plugin cannot be used with #{plugin} plugin.\033[0m" if Redmine::Plugin.installed? plugin
+      end
+    end
+
+    def load_model_hooks!
+      target = plugin_id.camelize.constantize
+      target::Hooks::ModelHook
+    end
+
+    def load_view_hooks!
+      target = plugin_id.camelize.constantize
+      target::Hooks::ViewHook
+    end
+
+    def load_macros!
+      require_files File.join('wiki_macros', '**/*_macro.rb')
+    end
+
+    def load_custom_field_format!(reverse: false)
+      require_files File.join('custom_field_formats', '**/*_format.rb'),
+                    reverse: reverse,
+                    ignore_autoload: true
+    end
+
+    def add_patch(patch)
+      if patch.is_a? Array
+        @patches += patch
+      else
+        @patches << patch
+      end
+    end
+
+    def add_helper(helper)
+      if helper.is_a? Array
+        @helpers += helper
+      else
+        @helpers << helper
+      end
+    end
+
+    def add_global_helper(helper)
+      if helper.is_a? Array
+        @global_helpers += helper
+      else
+        @global_helpers << helper
+      end
+    end
+
+    def apply!
+      validate_apply
+
+      apply_patches!
+      apply_helpers!
+      apply_global_helpers!
+
+      # reset patches and helpers
+      apply_reset
+
+      true
+    end
+
+    private
+
+    def validate_apply
+      return if @helpers.none? || @patches.none?
+
+      controller_patches = @patches.select do |p|
+        if p.is_a? String
+          true unless p == p.chomp('Controller')
+        else
+          c = p[:target].to_s
+          true unless c == c.chomp('Controller')
+        end
+      end
+
+      @helpers.each do |h|
+        helper_controller = if h.is_a? String
+                              "#{h}Controller"
+                            else
+                              c = h[:controller]
+                              if c.is_a? String
+                                "#{c}Controller"
+                              else
+                                c.to_s
+                              end
+                            end
+
+        if controller_patches.include? helper_controller
+          raise ExistingControllerPatchForHelper, "Do not add helper to #{helper_controller} if patch exists (#{plugin_id})"
+        end
+      end
+    end
+
+    def apply_patches!
+      patches = @patches.map do |p|
+        if p.is_a? String
+          { target: p.constantize, patch: p }
+        else
+          patch = p[:patch] || p[:target].to_s
+          { target: p[:target], patch: patch }
+        end
+      end
+
+      patches.uniq!
+      Rails.logger.debug { "patches for #{plugin_id}: #{patches.inspect}" } if debug
+
+      patches.each do |patch|
+        patch_module = if patch[:patch].is_a? String
+                         "#{plugin_id.camelize}::Patches::#{patch[:patch]}Patch".constantize
+                       else
+                         # if module specified (if not string), use it
+                         patch[:patch]
+                       end
+
+        target = patch[:target]
+        target.include patch_module unless target.included_modules.include? patch_module
+      end
+    end
+
+    def apply_helpers!
+      helpers = @helpers.map do |h|
+        if h.is_a? String
+          { controller: "#{h}Controller".constantize, helper: "#{plugin_id.camelize}#{h}Helper".constantize }
+        else
+          c = h[:controller].is_a?(String) ? "#{h[:controller]}Controller".constantize : h[:controller]
+          helper = if h[:helper]
+                     h[:helper]
+                   else
+                     helper_name = if h[:controller].is_a? String
+                                     h[:controller]
+                                   else
+                                     h[:controller].to_s.chomp 'Controller'
+                                   end
+                     "#{plugin_id.camelize}#{helper_name}Helper".constantize
+                   end
+          { controller: c, helper: helper }
+        end
+      end
+
+      helpers.uniq!
+      Rails.logger.debug { "helpers for #{plugin_id}: #{helpers.inspect}" } if debug
+
+      helpers.each do |h|
+        target = h[:controller]
+        target.send :helper, h[:helper]
+      end
+    end
+
+    def apply_global_helpers!
+      global_helpers = @global_helpers.uniq
+      Rails.logger.debug { "global helpers for #{plugin_id}: #{global_helpers.inspect}" } if debug
+
+      global_helpers.each do |h|
+        ActionView::Base.include h
+      end
+    end
+  end
+end

data/lib/redmine_plugin_kit/plugin_base.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RedminePluginKit
+  module PluginBase
+    def self.included(receiver)
+      receiver.extend ClassMethods
+    end
+
+    module ClassMethods
+      def setup!(existing_loader = nil)
+        init_loader existing_loader
+        raise "no loader for #{plugin_id}" if loader.nil?
+
+        setup
+      end
+
+      def plugin_id
+        to_s.underscore
+      end
+
+      def loader
+        @loader ||= RedminePluginKit::Loader.new plugin_id: plugin_id
+      end
+
+      # support with default setting as fall back
+      def setting(value)
+        if settings.key? value
+          settings[value]
+        else
+          loader.default_settings[value]
+        end
+      end
+
+      def setting?(value)
+        RedminePluginKit.true? setting(value)
+      end
+
+      private
+
+      def init_loader(existing_loader)
+        @loader = existing_loader
+      end
+
+      def settings
+        Setting[:"plugin_#{plugin_id}"]
+      end
+    end
+  end
+end

data/lib/redmine_plugin_kit/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RedminePluginKit
+  VERSION = '1.0.0'
+end

data/lib/redmine_plugin_kit.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'deface'
+
+require 'redmine_plugin_kit/version'
+require 'redmine_plugin_kit/debug'
+require 'redmine_plugin_kit/engine'
+require 'redmine_plugin_kit/plugin_base'
+require 'redmine_plugin_kit/loader'
+
+require 'redmine_plugin_kit/helpers/global_helper'
+
+ActionView::Base.include RedminePluginKit::Helpers::GlobalHelper if defined?(ActionView::Base)
+
+module RedminePluginKit
+  class << self
+    def true?(value)
+      return false if value.is_a? FalseClass
+      return true if value.is_a?(TrueClass) || value.to_i == 1 || value.to_s.casecmp('true').zero?
+
+      false
+    end
+
+    # false if false or nil
+    def false?(value)
+      !true?(value)
+    end
+
+    def textarea_cols(text, min: 8, max: 20)
+      [[min, text.to_s.length / 50].max, max].min
+    end
+  end
+end

data/lib/tasks/redmine_plugin_kit.rake

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+namespace :redmine_plugin_kit do
+  desc <<-DESCRIPTION
+  Drop plugin settings.
+
+  Example:
+    bundle exec rake redmine_plugin_kit:drop_settings RAILS_ENV=production plugin="redmine_plugin_example"
+  DESCRIPTION
+  task drop_settings: :environment do
+    plugin = ENV['plugin']
+
+    if plugin.blank?
+      puts 'Parameter plugin is required.'
+      exit 2
+    end
+
+    Setting.where(name: "plugin_#{plugin}".to_sym).destroy_all
+    Setting.clear_cache
+    puts "Setting for plugin #{plugin} has been dropped."
+  end
+
+  desc <<-DESCRIPTION
+  Set settings.
+
+  Example for value:
+    bundle exec rake redmine_plugin_kit:setting_set RAILS_ENV=production name="additionals" setting="open_external_urls" value="1"
+  Example for list of value:
+    bundle exec rake redmine_plugin_kit:setting_set RAILS_ENV=production setting="default_projects_modules" value="issue_tracking,time_tracking,wiki"
+  DESCRIPTION
+  task setting_set: :environment do
+    name = ENV['name'] ||= 'redmine'
+    setting = ENV['setting']
+    value = if ENV['values'].present?
+              ENV['values'].split ','
+            else
+              ENV['value']
+            end
+
+    if name.blank? || setting.blank? || value.blank?
+      puts 'Parameters setting and value are required.'
+      exit 2
+    end
+
+    if name == 'redmine'
+      Setting[setting.to_sym] = value
+    else
+      plugin_name = "plugin_#{name}".to_sym
+      plugin_settings = Setting[plugin_name]
+      plugin_settings[setting] = value
+      Setting[plugin_name] = plugin_settings
+    end
+  end
+
+  desc <<-DESCRIPTION
+  Get settings.
+
+  Example for plugin setting:
+    bundle exec rake redmine_plugin_kit:setting_get RAILS_ENV=production name="additionals" setting="open_external_urls"
+  Example for redmine setting:
+    bundle exec rake redmine_plugin_kit:setting_get RAILS_ENV=production name="redmine" setting="app_title"
+  Example for redmine setting:
+    bundle exec rake redmine_plugin_kit:setting_get RAILS_ENV=production setting="app_title"
+  DESCRIPTION
+  task setting_get: :environment do
+    name = ENV['name'] ||= 'redmine'
+    setting = ENV['setting']
+
+    if setting.blank?
+      puts 'Parameters setting is required'
+      exit 2
+    end
+
+    if name == 'redmine'
+      puts Setting.send(setting)
+    else
+      plugin_name = "plugin_#{name}".to_sym
+      plugin_settings = Setting[plugin_name]
+      puts plugin_settings[setting]
+    end
+  end
+end

data/redmine_plugin_kit.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/redmine_plugin_kit/version'
+lib = File.expand_path '../lib', __FILE__
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redmine_plugin_kit'
+  spec.version       = RedminePluginKit::VERSION
+  spec.authors       = ['AlphaNodes']
+  spec.email         = ['alex@alphanodes.com']
+  spec.metadata      = { 'rubygems_mfa_required' => 'true' }
+
+  spec.summary       = 'Redmine plugin kit'
+  spec.description   = 'Redmine plugin kit as base of Redmine plugins'
+  spec.homepage      = 'https://github.com/alphanodes/redmine_plugin_kit'
+  spec.license       = 'GPL-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match %r{^((test|spec|features)/|Gemfile)}
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename f }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6'
+
+  spec.add_dependency 'deface', '1.8.1'
+  spec.add_runtime_dependency 'rails'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rails'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: redmine_plugin_kit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- AlphaNodes
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Redmine plugin kit as base of Redmine plugins
+email:
+- alex@alphanodes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- Rakefile
+- config/initializers/deface.rb
+- lib/redmine_plugin_kit.rb
+- lib/redmine_plugin_kit/debug.rb
+- lib/redmine_plugin_kit/engine.rb
+- lib/redmine_plugin_kit/helpers/global_helper.rb
+- lib/redmine_plugin_kit/loader.rb
+- lib/redmine_plugin_kit/plugin_base.rb
+- lib/redmine_plugin_kit/version.rb
+- lib/tasks/redmine_plugin_kit.rake
+- redmine_plugin_kit.gemspec
+homepage: https://github.com/alphanodes/redmine_plugin_kit
+licenses:
+- GPL-2.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Redmine plugin kit
+test_files: []