├── .noexec.yaml ├── test ├── gems │ ├── gems │ │ ├── fake-gem-name-a-1.0.0 │ │ │ └── lib │ │ │ │ ├── fake-gem-name-a.rb │ │ │ │ └── plugins │ │ │ │ └── something │ │ │ │ ├── nested │ │ │ │ └── structure │ │ │ │ │ └── test.rb │ │ │ │ ├── math │ │ │ │ ├── decrease.rb │ │ │ │ └── increase.rb │ │ │ │ └── stats │ │ │ │ └── max.rb │ │ ├── fake-gem-name-v1a-1.0.0 │ │ │ └── lib │ │ │ │ ├── fake-gem-name-v1a.rb │ │ │ │ └── plugins │ │ │ │ └── v1test │ │ │ │ └── stats │ │ │ │ └── max.rb │ │ ├── fake-gem-name-v1b-1.0.0 │ │ │ └── lib │ │ │ │ ├── fake-gem-name-v1a.rb │ │ │ │ └── plugins │ │ │ │ └── v1test │ │ │ │ └── stats │ │ │ │ └── max.rb │ │ ├── fake-gem-name-v2a-1.0.0 │ │ │ └── lib │ │ │ │ ├── fake-gem-name-v2a.rb │ │ │ │ └── plugins │ │ │ │ └── v2test │ │ │ │ └── stats │ │ │ │ └── max.rb │ │ ├── fake-gem-name-v2b-1.0.0 │ │ │ └── lib │ │ │ │ ├── fake-gem-name-v2b.rb │ │ │ │ └── plugins │ │ │ │ └── v2test │ │ │ │ └── stats │ │ │ │ └── max.rb │ │ ├── fake-gem-name-latest-1.0.0 │ │ │ └── lib │ │ │ │ ├── fake-gem-name-latest.rb │ │ │ │ └── plugins │ │ │ │ └── latest │ │ │ │ └── version1 │ │ │ │ └── max.rb │ │ ├── fake-gem-name-latest-2.0.0 │ │ │ └── lib │ │ │ │ ├── fake-gem-name-latest.rb │ │ │ │ └── plugins │ │ │ │ └── latest │ │ │ │ └── version2 │ │ │ │ └── max.rb │ │ ├── fake-gem-name-activated-1.0.0 │ │ │ └── lib │ │ │ │ ├── fake-gem-name-activated.rb │ │ │ │ └── plugins │ │ │ │ └── activated │ │ │ │ └── version1 │ │ │ │ └── max.rb │ │ └── fake-gem-name-activated-2.0.0 │ │ │ └── lib │ │ │ ├── fake-gem-name-activated.rb │ │ │ └── plugins │ │ │ └── activated │ │ │ └── version1 │ │ │ └── max.rb │ ├── specifications │ │ ├── fake-gem-name-a-1.0.0.gemspec │ │ ├── fake-gem-name-v1a-1.0.0.gemspec │ │ ├── fake-gem-name-latest-1.0.0.gemspec │ │ ├── fake-gem-name-latest-2.0.0.gemspec │ │ ├── fake-gem-name-activated-1.0.0.gemspec │ │ ├── fake-gem-name-activated-2.0.0.gemspec │ │ ├── fake-gem-name-v1b-1.0.0.gemspec │ │ ├── fake-gem-name-v2a-1.0.0.gemspec │ │ └── fake-gem-name-v2b-1.0.0.gemspec │ └── load_path │ │ └── plugins │ │ └── load_path │ │ └── stats │ │ └── max.rb ├── plugins_test │ └── extensions │ │ ├── conversions_test.rb │ │ ├── plugins_map_test.rb │ │ ├── class_exist_test.rb │ │ ├── matching_test.rb │ │ ├── first_class_test.rb │ │ └── first_ask_test.rb ├── pluginator │ ├── name_converter_test.rb │ ├── group_test.rb │ ├── extendable_autodetect_test.rb │ └── autodetect_test.rb ├── test_helper.rb └── pluginator_test.rb ├── .gitignore ├── .travis.yml ├── Guardfile ├── lib ├── pluginator │ ├── rubygems_fixes.rb │ ├── version.rb │ ├── name_converter.rb │ ├── errors.rb │ ├── group.rb │ ├── extendable_autodetect.rb │ ├── autodetect │ │ ├── finder.rb │ │ └── formatted_finder.rb │ └── autodetect.rb ├── plugins │ └── pluginator │ │ └── extensions │ │ ├── class_exist.rb │ │ ├── plugins_map.rb │ │ ├── conversions.rb │ │ ├── first_class.rb │ │ ├── matching.rb │ │ └── first_ask.rb └── pluginator.rb ├── .rubocop.yml ├── Changelog.md ├── Gemfile ├── Rakefile ├── pluginator.gemspec ├── README.md ├── COPYING.LESSER └── COPYING /.noexec.yaml: -------------------------------------------------------------------------------- 1 | exclude: [rake,guard] 2 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-a-1.0.0/lib/fake-gem-name-a.rb: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-v1a-1.0.0/lib/fake-gem-name-v1a.rb: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-v1b-1.0.0/lib/fake-gem-name-v1a.rb: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-v2a-1.0.0/lib/fake-gem-name-v2a.rb: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-v2b-1.0.0/lib/fake-gem-name-v2b.rb: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-latest-1.0.0/lib/fake-gem-name-latest.rb: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-latest-2.0.0/lib/fake-gem-name-latest.rb: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-activated-1.0.0/lib/fake-gem-name-activated.rb: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-activated-2.0.0/lib/fake-gem-name-activated.rb: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /*.gem 2 | /Gemfile.lock 3 | /coverage 4 | /doc 5 | /.yardoc 6 | /test/gems/gems/pluginator-* 7 | /test/gems/specifications/pluginator-*.gemspec 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: ruby 2 | rvm: 3 | - jruby 4 | - ruby-head 5 | - 2.4.1 6 | - 1.9.3 7 | - 2.0.0 8 | - 2.1 9 | - 2.2 10 | - 2.3 11 | - rbx 12 | before_install: 13 | - 'gem update bundler' 14 | script: 15 | - NOEXEC_DISABLE=1 rake 16 | notifications: 17 | irc: 18 | channels: 19 | - "irc.freenode.org#rvm-test" 20 | email: 21 | recipients: 22 | - mpapis@gmail.com 23 | on_failure: change 24 | matrix: 25 | fast_finish: true 26 | allow_failures: 27 | - rvm: rbx 28 | -------------------------------------------------------------------------------- /Guardfile: -------------------------------------------------------------------------------- 1 | # A sample Guardfile 2 | # More info at https://github.com/guard/guard#readme 3 | 4 | guard :minitest, :include => %w[lib test], :bundler => false do 5 | watch(%r{^lib/plugins/pluginator/(.*/)?([^/]+)\.rb$}) { |m| 6 | "test/plugins_test/#{m[1]}#{m[2]}_test.rb" 7 | } 8 | watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { |m| 9 | "test/#{m[1]}#{m[2]}_test.rb" 10 | } 11 | watch(%r{^test/(.*)\/?(.*)_test\.rb$}) 12 | watch(%r{^test/test_helper\.rb$}) { "test" } 13 | end 14 | 15 | guard "yard" do 16 | watch(%r{^lib/.+\.rb}) 17 | end 18 | -------------------------------------------------------------------------------- /lib/pluginator/rubygems_fixes.rb: -------------------------------------------------------------------------------- 1 | unless Gem.respond_to? :find_files_from_load_path 2 | # older versions of rubygems od not have separate method for finding only on $LOAD_PATH 3 | # this is copy/paste from rubygems 2.0.0 code 4 | # :nocov: not testing as it runs only on old rubygems, it's not even our code 5 | module Gem 6 | def self.find_files_from_load_path(glob) 7 | $LOAD_PATH.map do |load_path| 8 | Dir["#{File.expand_path glob, load_path}#{Gem.suffix_pattern}"] 9 | end.flatten.select do |file| # rubocop:disable Style/MultilineBlockChain 10 | File.file? file.untaint 11 | end 12 | end 13 | end 14 | # :nocov: 15 | end 16 | -------------------------------------------------------------------------------- /test/gems/specifications/fake-gem-name-a-1.0.0.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # stub: fake-gem-name-a 1.0.0 ruby lib 3 | 4 | Gem::Specification.new do |s| 5 | s.name = "fake-gem-name-a" 6 | s.version = "1.0.0" 7 | 8 | s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= 9 | s.require_paths = ["lib"] 10 | s.authors = ["Michal Papis"] 11 | s.date = "2014-09-21" 12 | s.description = "Do nothing" 13 | s.email = ["mpapis@gmail.com"] 14 | s.files = Dir["../../gems/#{s.name}-#{s.version}/lib/**/*.rb"] 15 | s.homepage = "https://rvm.io" 16 | s.licenses = ["LGPL v3"] 17 | s.rubygems_version = "2.2.2" 18 | s.summary = "Do Nothing" 19 | 20 | s.installed_by_version = "2.2.2" if s.respond_to? :installed_by_version 21 | end 22 | -------------------------------------------------------------------------------- /test/gems/specifications/fake-gem-name-v1a-1.0.0.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # stub: fake-gem-name-v1a 1.0.0 ruby lib 3 | 4 | Gem::Specification.new do |s| 5 | s.name = "fake-gem-name-v1a" 6 | s.version = "1.0.0" 7 | 8 | s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= 9 | s.require_paths = ["lib"] 10 | s.authors = ["Michal Papis"] 11 | s.date = "2014-09-21" 12 | s.description = "Do nothing" 13 | s.email = ["mpapis@gmail.com"] 14 | s.files = Dir["../../gems/#{s.name}-#{s.version}/lib/**/*.rb"] 15 | s.homepage = "https://rvm.io" 16 | s.licenses = ["LGPL v3"] 17 | s.rubygems_version = "2.2.2" 18 | s.summary = "Do Nothing" 19 | 20 | s.installed_by_version = "2.2.2" if s.respond_to? :installed_by_version 21 | end 22 | -------------------------------------------------------------------------------- /test/gems/specifications/fake-gem-name-latest-1.0.0.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # stub: fake-gem-name-latest 1.0.0 ruby lib 3 | 4 | Gem::Specification.new do |s| 5 | s.name = "fake-gem-name-latest" 6 | s.version = "1.0.0" 7 | 8 | s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= 9 | s.require_paths = ["lib"] 10 | s.authors = ["Michal Papis"] 11 | s.date = "2014-09-21" 12 | s.description = "Do nothing" 13 | s.email = ["mpapis@gmail.com"] 14 | s.files = Dir["../../gems/#{s.name}-#{s.version}/lib/**/*.rb"] 15 | s.homepage = "https://rvm.io" 16 | s.licenses = ["LGPL v3"] 17 | s.rubygems_version = "2.2.2" 18 | s.summary = "Do Nothing" 19 | 20 | s.installed_by_version = "2.2.2" if s.respond_to? :installed_by_version 21 | end 22 | -------------------------------------------------------------------------------- /test/gems/specifications/fake-gem-name-latest-2.0.0.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # stub: fake-gem-name-latest 2.0.0 ruby lib 3 | 4 | Gem::Specification.new do |s| 5 | s.name = "fake-gem-name-latest" 6 | s.version = "2.0.0" 7 | 8 | s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= 9 | s.require_paths = ["lib"] 10 | s.authors = ["Michal Papis"] 11 | s.date = "2014-09-21" 12 | s.description = "Do nothing" 13 | s.email = ["mpapis@gmail.com"] 14 | s.files = Dir["../../gems/#{s.name}-#{s.version}/lib/**/*.rb"] 15 | s.homepage = "https://rvm.io" 16 | s.licenses = ["LGPL v3"] 17 | s.rubygems_version = "2.2.2" 18 | s.summary = "Do Nothing" 19 | 20 | s.installed_by_version = "2.2.2" if s.respond_to? :installed_by_version 21 | end 22 | -------------------------------------------------------------------------------- /test/gems/specifications/fake-gem-name-activated-1.0.0.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # stub: fake-gem-name-activated 1.0.0 ruby lib 3 | 4 | Gem::Specification.new do |s| 5 | s.name = "fake-gem-name-activated" 6 | s.version = "1.0.0" 7 | 8 | s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= 9 | s.require_paths = ["lib"] 10 | s.authors = ["Michal Papis"] 11 | s.date = "2014-09-21" 12 | s.description = "Do nothing" 13 | s.email = ["mpapis@gmail.com"] 14 | s.files = Dir["../../gems/#{s.name}-#{s.version}/lib/**/*.rb"] 15 | s.homepage = "https://rvm.io" 16 | s.licenses = ["LGPL v3"] 17 | s.rubygems_version = "2.2.2" 18 | s.summary = "Do Nothing" 19 | 20 | s.installed_by_version = "2.2.2" if s.respond_to? :installed_by_version 21 | end 22 | -------------------------------------------------------------------------------- /test/gems/specifications/fake-gem-name-activated-2.0.0.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # stub: fake-gem-name-activated 2.0.0 ruby lib 3 | 4 | Gem::Specification.new do |s| 5 | s.name = "fake-gem-name-activated" 6 | s.version = "2.0.0" 7 | 8 | s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= 9 | s.require_paths = ["lib"] 10 | s.authors = ["Michal Papis"] 11 | s.date = "2014-09-21" 12 | s.description = "Do nothing" 13 | s.email = ["mpapis@gmail.com"] 14 | s.files = Dir["../../gems/#{s.name}-#{s.version}/lib/**/*.rb"] 15 | s.homepage = "https://rvm.io" 16 | s.licenses = ["LGPL v3"] 17 | s.rubygems_version = "2.2.2" 18 | s.summary = "Do Nothing" 19 | 20 | s.installed_by_version = "2.2.2" if s.respond_to? :installed_by_version 21 | end 22 | -------------------------------------------------------------------------------- /test/gems/specifications/fake-gem-name-v1b-1.0.0.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # stub: fake-gem-name-v1b 1.0.0 ruby lib 3 | 4 | Gem::Specification.new do |s| 5 | s.name = "fake-gem-name-v1b" 6 | s.version = "1.0.0" 7 | 8 | s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= 9 | s.require_paths = ["lib"] 10 | s.authors = ["Michal Papis"] 11 | s.date = "2014-09-21" 12 | s.description = "Do nothing" 13 | s.email = ["mpapis@gmail.com"] 14 | s.files = Dir["../../gems/#{s.name}-#{s.version}/lib/**/*.rb"] 15 | s.homepage = "https://rvm.io" 16 | s.licenses = ["LGPL v3"] 17 | s.rubygems_version = "2.2.2" 18 | s.summary = "Do Nothing" 19 | s.metadata = { 20 | "plugins/v1test/stats/max.rb" => "1" 21 | } 22 | 23 | s.installed_by_version = "2.2.2" if s.respond_to? :installed_by_version 24 | end 25 | -------------------------------------------------------------------------------- /test/gems/specifications/fake-gem-name-v2a-1.0.0.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # stub: fake-gem-name-v2a 1.0.0 ruby lib 3 | 4 | Gem::Specification.new do |s| 5 | s.name = "fake-gem-name-v2a" 6 | s.version = "1.0.0" 7 | 8 | s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= 9 | s.require_paths = ["lib"] 10 | s.authors = ["Michal Papis"] 11 | s.date = "2014-09-21" 12 | s.description = "Do nothing" 13 | s.email = ["mpapis@gmail.com"] 14 | s.files = Dir["../../gems/#{s.name}-#{s.version}/lib/**/*.rb"] 15 | s.homepage = "https://rvm.io" 16 | s.licenses = ["LGPL v3"] 17 | s.rubygems_version = "2.2.2" 18 | s.summary = "Do Nothing" 19 | s.metadata = { 20 | "plugins/v2test/stats/max.rb" => "2" 21 | } 22 | 23 | s.installed_by_version = "2.2.2" if s.respond_to? :installed_by_version 24 | end 25 | -------------------------------------------------------------------------------- /test/gems/specifications/fake-gem-name-v2b-1.0.0.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # stub: fake-gem-name-v2b 1.0.0 ruby lib 3 | 4 | Gem::Specification.new do |s| 5 | s.name = "fake-gem-name-v2b" 6 | s.version = "1.0.0" 7 | 8 | s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= 9 | s.require_paths = ["lib"] 10 | s.authors = ["Michal Papis"] 11 | s.date = "2014-09-21" 12 | s.description = "Do nothing" 13 | s.email = ["mpapis@gmail.com"] 14 | s.files = Dir["../../gems/#{s.name}-#{s.version}/lib/**/*.rb"] 15 | s.homepage = "https://rvm.io" 16 | s.licenses = ["LGPL v3"] 17 | s.rubygems_version = "2.2.2" 18 | s.summary = "Do Nothing" 19 | s.metadata = { 20 | "plugins/v2test/stats/max.rb" => "1" 21 | } 22 | 23 | s.installed_by_version = "2.2.2" if s.respond_to? :installed_by_version 24 | end 25 | -------------------------------------------------------------------------------- /lib/pluginator/version.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | module Pluginator 21 | # Version of Pluginator 22 | VERSION = "1.5.0".freeze 23 | end 24 | -------------------------------------------------------------------------------- /.rubocop.yml: -------------------------------------------------------------------------------- 1 | Lint/ConditionPosition: 2 | Enabled: false 3 | Metrics/LineLength: 4 | Max: 111 5 | Style/AccessModifierIndentation: 6 | EnforcedStyle: outdent 7 | Style/AndOr: 8 | EnforcedStyle: conditionals 9 | Style/BlockComments: 10 | Enabled: false 11 | Style/ClassAndModuleChildren: 12 | Enabled: false 13 | Style/DoubleNegation: 14 | Enabled: false 15 | Style/EmptyLinesAroundClassBody: 16 | Enabled: false 17 | Style/EmptyLinesAroundModuleBody: 18 | Enabled: false 19 | Style/MultilineIfThen: 20 | Enabled: false 21 | Style/MultilineOperationIndentation: 22 | Enabled: false 23 | Style/PredicateName: 24 | NameWhitelist: 25 | - has_public_method? 26 | Style/SpaceAroundEqualsInParameterDefault: 27 | EnforcedStyle: no_space 28 | Style/SpaceInsideParens: 29 | Enabled: false 30 | Style/StringLiterals: 31 | EnforcedStyle: double_quotes 32 | Style/StringLiteralsInInterpolation: 33 | EnforcedStyle: double_quotes 34 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-a-1.0.0/lib/plugins/something/nested/structure/test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class Something::Nested::Structure::Test 21 | 22 | def self.action 23 | 42 24 | end 25 | end 26 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-a-1.0.0/lib/plugins/something/math/decrease.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class Something::Math::Decrease 21 | def self.type 22 | "decrease" 23 | end 24 | def self.action(number) 25 | number - 1 26 | end 27 | end 28 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-a-1.0.0/lib/plugins/something/math/increase.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class Something::Math::Increase 21 | def self.type 22 | "increase" 23 | end 24 | def self.action(number) 25 | number + 1 26 | end 27 | end 28 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-a-1.0.0/lib/plugins/something/stats/max.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class Something::Stats::Max 21 | 22 | def self.handles?(what) 23 | %w{ max maximum }.include?(what) 24 | end 25 | 26 | def self.action 27 | 42 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-v1a-1.0.0/lib/plugins/v1test/stats/max.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class V1test::Stats::Max 21 | 22 | def self.handles?(what) 23 | %w{ max maximum }.include?(what) 24 | end 25 | 26 | def self.action 27 | 41 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-v1b-1.0.0/lib/plugins/v1test/stats/max.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class V1test::Stats::Max 21 | 22 | def self.handles?(what) 23 | %w{ max maximum }.include?(what) 24 | end 25 | 26 | def self.action 27 | 42 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-v2a-1.0.0/lib/plugins/v2test/stats/max.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class V2test::Stats::Max 21 | 22 | def self.handles?(what) 23 | %w{ max maximum }.include?(what) 24 | end 25 | 26 | def self.action 27 | 41 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-v2b-1.0.0/lib/plugins/v2test/stats/max.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class V2test::Stats::Max 21 | 22 | def self.handles?(what) 23 | %w{ max maximum }.include?(what) 24 | end 25 | 26 | def self.action 27 | 42 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-latest-1.0.0/lib/plugins/latest/version1/max.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class Latest::Version1::Max 21 | 22 | def self.handles?(what) 23 | %w{ max maximum }.include?(what) 24 | end 25 | 26 | def self.action 27 | 42 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-latest-2.0.0/lib/plugins/latest/version2/max.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class Latest::Version2::Max 21 | 22 | def self.handles?(what) 23 | %w{ max maximum }.include?(what) 24 | end 25 | 26 | def self.action 27 | 42 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-activated-1.0.0/lib/plugins/activated/version1/max.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class Activated::Version1::Max 21 | 22 | def self.handles?(what) 23 | %w{ max maximum }.include?(what) 24 | end 25 | 26 | def self.action 27 | 41 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /test/gems/gems/fake-gem-name-activated-2.0.0/lib/plugins/activated/version1/max.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | class Activated::Version1::Max 21 | 22 | def self.handles?(what) 23 | %w{ max maximum }.include?(what) 24 | end 25 | 26 | def self.action 27 | 42 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /Changelog.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## 1.5.0 4 | date: 2017-06-12 5 | 6 | - add /lib prefix check, it can be changed with `prefix: "/(lib|local_lib)"` 7 | - allow dashes in directory names for plugin paths 8 | - fix older rubygems compatibility 9 | - updated ruby and rubygems versions 10 | 11 | ## 1.4.1 12 | date: 2017-05-23 13 | 14 | - fix compatibility with bundler 1.15 15 | 16 | ## 1.4.0 17 | date: 2017-05-14 18 | 19 | - reworked finding plugins, now also searches `$LOADED_FEATURES` 20 | 21 | ## 1.3.0 22 | date: 2014-10-20 23 | 24 | - simplified detection of gems/plugins to load, improved tests 25 | 26 | ## 1.2.0 27 | date: 2014-09-24 28 | 29 | - improved detection of gems/plugins to load, based on #6 30 | 31 | ## 1.1.0 32 | date: 2014-06-06 33 | 34 | - register only plugins that can be loaded from activated gems, fix #3 35 | 36 | ## 1.0.1 37 | date: 2013-12-25 38 | 39 | - divide first_ask code into smaller methods, remove duplication 40 | - add conversiosn helper class2name 41 | 42 | ## 1.0.0 43 | date: 2013-12-20 44 | 45 | - Stable version released 46 | -------------------------------------------------------------------------------- /test/gems/load_path/plugins/load_path/stats/max.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | module LoadPath 21 | module Stats 22 | class Max 23 | def self.handles?(what) 24 | %w{ max maximum }.include?(what) 25 | end 26 | 27 | def self.action 28 | 42 29 | end 30 | end 31 | end 32 | end 33 | -------------------------------------------------------------------------------- /lib/pluginator/name_converter.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | module Pluginator 21 | # a helper for handling name / file / class conversions 22 | module NameConverter 23 | private 24 | 25 | # full_name => class 26 | def name2class(name) 27 | klass = Kernel 28 | name.to_s.split(%r{/}).each do |part| 29 | klass = klass.const_get( 30 | part.capitalize.gsub(/[_-](.)/) { |match| match[1].upcase } 31 | ) 32 | end 33 | klass 34 | end 35 | 36 | end 37 | end 38 | -------------------------------------------------------------------------------- /test/plugins_test/extensions/conversions_test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "test_helper" 21 | require "plugins/pluginator/extensions/conversions" 22 | 23 | class ConversionsTester 24 | extend Pluginator::Extensions::Conversions 25 | end 26 | 27 | describe Pluginator::Extensions::Conversions do 28 | it :class2string do 29 | ConversionsTester.class2string("SomethingLong").must_match("something_long") 30 | end 31 | 32 | it :string2class do 33 | ConversionsTester.string2class("something_long").must_match("SomethingLong") 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | source "https://rubygems.org" 21 | 22 | #ruby=2.4.1 23 | 24 | gemspec 25 | 26 | group :development do 27 | # statistics only on MRI 2.4 - avoid problems on older rubies 28 | gem "redcarpet", :platforms => [:mri_24] 29 | gem "simplecov", :platforms => [:mri_24] 30 | gem "coveralls", :platforms => [:mri_24] 31 | gem "guard", :platforms => [:mri_24] 32 | gem "guard-minitest", :platforms => [:mri_24] 33 | gem "guard-yard", :platforms => [:mri_24] 34 | gem "yard", ">=0.8.7.5", :platforms => [:mri_24] 35 | end if RUBY_VERSION>='2.4.0' 36 | -------------------------------------------------------------------------------- /test/plugins_test/extensions/plugins_map_test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "test_helper" 21 | require "plugins/pluginator/extensions/plugins_map" 22 | 23 | class PluginsMapTester 24 | attr_accessor :plugins 25 | include Pluginator::Extensions::PluginsMap 26 | end 27 | 28 | describe Pluginator::Extensions::PluginsMap do 29 | it :creates_map do 30 | tester = PluginsMapTester.new 31 | tester.plugins = { "extensions" => [Pluginator::Extensions::PluginsMap] } 32 | expected = { "PluginsMap" => Pluginator::Extensions::PluginsMap } 33 | tester.plugins_map("extensions").must_equal( expected ) 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /test/pluginator/name_converter_test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "test_helper" 21 | require "pluginator/name_converter" 22 | 23 | class Converter 24 | extend Pluginator::NameConverter 25 | end 26 | class PuppetDebugger 27 | end 28 | 29 | describe Pluginator::NameConverter do 30 | describe "classes" do 31 | it :builds_class do 32 | Converter.send(:name2class, "Converter").must_equal(Converter) 33 | end 34 | 35 | it :builds_class_with_dash do 36 | Converter.send(:name2class, "puppet-debugger").must_equal(PuppetDebugger) 37 | end 38 | 39 | it :builds_class_with_underscore do 40 | Converter.send(:name2class, "puppet_debugger").must_equal(PuppetDebugger) 41 | end 42 | end 43 | end 44 | -------------------------------------------------------------------------------- /lib/plugins/pluginator/extensions/class_exist.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "plugins/pluginator/extensions/plugins_map" 21 | require "plugins/pluginator/extensions/conversions" 22 | 23 | module Pluginator::Extensions 24 | # Extension to check if plugin for given class name exist 25 | module ClassExist 26 | 27 | include PluginsMap 28 | include Conversions 29 | 30 | # Check if plugin for given name exists. 31 | # 32 | # @param type [String] name of type to search for plugins 33 | # @param klass [Symbol or String] name of the searched class 34 | # @return [Boolean] klass exists 35 | def class_exist?(type, klass) 36 | !!(plugins_map(type) || {})[string2class(klass)] 37 | end 38 | end 39 | end 40 | -------------------------------------------------------------------------------- /test/plugins_test/extensions/class_exist_test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "test_helper" 21 | require "plugins/pluginator/extensions/class_exist" 22 | require "plugins/something/stats/max" 23 | 24 | class ClassExistTester 25 | attr_accessor :plugins 26 | include Pluginator::Extensions::ClassExist 27 | end 28 | 29 | describe Pluginator::Extensions::ClassExist do 30 | subject do 31 | tester = ClassExistTester.new 32 | tester.plugins = { "stats" => [ 33 | Something::Stats::Max 34 | ] } 35 | tester 36 | end 37 | 38 | it :plugin_exists do 39 | subject.class_exist?("stats", "max").must_equal( true ) 40 | end 41 | 42 | it :plugin_missing do 43 | subject.class_exist?("stats", "min").must_equal( false ) 44 | end 45 | end 46 | -------------------------------------------------------------------------------- /lib/plugins/pluginator/extensions/plugins_map.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "plugins/pluginator/extensions/conversions" 21 | 22 | module Pluginator::Extensions 23 | # extend Pluginator with map of plugins: name => klass 24 | module PluginsMap 25 | include Conversions 26 | 27 | # provide extra map of plugins with symbolized names as keys 28 | # 29 | # @param type [String] name of type to generate the map for 30 | # @return [Hash] map of the names and plugin classes 31 | 32 | def plugins_map(type) 33 | @plugins_map ||= {} 34 | type = type.to_s 35 | @plugins_map[type] ||= Hash[ 36 | @plugins[type].map do |plugin| 37 | [class2name(plugin), plugin] 38 | end 39 | ] 40 | end 41 | end 42 | end 43 | -------------------------------------------------------------------------------- /test/pluginator/group_test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "test_helper" 21 | require "pluginator/group" 22 | 23 | describe Pluginator::Group do 24 | it :has_name do 25 | Pluginator::Group.new("something").group.must_equal("something") 26 | end 27 | 28 | describe "plugins list" do 29 | before do 30 | @group = Pluginator::Group.new("something") 31 | end 32 | 33 | it :adds_type do 34 | @group.register_plugin("type1", nil) 35 | @group.types.must_include("type1") 36 | @group.types.wont_include("type2") 37 | end 38 | 39 | it :adds_plugin do 40 | @group.register_plugin("type1", "test1") 41 | @group["type1"].must_include("test1") 42 | @group["type1"].wont_include("test2") 43 | end 44 | end 45 | end 46 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 3 | - Michal Papis 4 | - Jordon Bedwell 5 | 6 | This file is part of pluginator. 7 | 8 | pluginator is free software: you can redistribute it and/or modify 9 | it under the terms of the GNU Lesser General Public License as published 10 | by the Free Software Foundation, either version 3 of the License, or 11 | (at your option) any later version. 12 | 13 | pluginator is distributed in the hope that it will be useful, 14 | but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | GNU Lesser General Public License for more details. 17 | 18 | You should have received a copy of the GNU Lesser General Public License 19 | along with pluginator. If not, see . 20 | =end 21 | 22 | default_tasks = [] 23 | 24 | begin 25 | require "yard" 26 | YARD::Rake::YardocTask.new do |t| 27 | t.files = ["lib/**/*.rb"] 28 | t.stats_options = ["--list-undoc", "--compact"] 29 | end 30 | 31 | task :docs => [:yard] 32 | default_tasks << :yard 33 | rescue LoadError 34 | end 35 | 36 | require "rake/testtask" 37 | Rake::TestTask.new do |t| 38 | t.verbose = true 39 | t.libs.push("test") 40 | t.pattern = "test/**/*_test.rb" 41 | end 42 | default_tasks << :test 43 | 44 | begin 45 | require "rubocop/rake_task.rb" 46 | RuboCop::RakeTask.new do |t| 47 | t.patterns = %w[lib/] 48 | end 49 | unless ENV["CI"] 50 | default_tasks << :rubocop 51 | end 52 | rescue LoadError 53 | end 54 | 55 | task :default => default_tasks 56 | -------------------------------------------------------------------------------- /lib/pluginator.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "pluginator/extendable_autodetect" 21 | require "pluginator/rubygems_fixes" 22 | require "pluginator/version" 23 | 24 | # A simple plugin system based on Gem.find_files 25 | module Pluginator 26 | # Find plugins for the given group 27 | # 28 | # @param group [String] name of plugins group 29 | # @param options [Hash] options to pass to creating Pluginator instance 30 | # @option type [String] name of type to load 31 | # @option prefix [String] a prefix for finding plugins if forcing, 32 | # by default only `/lib` is checked, 33 | # regexp notation is allowed, for example `/(lib|local_lib)` 34 | # @option extend [Array|Symbol] list of extension to extend into pluginator instance 35 | # @return [Pluginator::ExtendableAutodetect] instance of Pluginator 36 | def self.find(group, options={}) 37 | Pluginator::ExtendableAutodetect.new(group, options) 38 | end 39 | end 40 | -------------------------------------------------------------------------------- /lib/plugins/pluginator/extensions/conversions.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | module Pluginator::Extensions 21 | # a placeholder for methods to convert strings 22 | module Conversions 23 | 24 | # converts class name to a file name 25 | # @param klass [String] class like string 26 | # @return [String] file like string 27 | 28 | def class2string(klass) 29 | klass.to_s.gsub(/([A-Z])/m) { |match| "_#{match.downcase}" }[1..-1] 30 | end 31 | 32 | # converts file name to a class name 33 | # @param str [String] file like string 34 | # @return [String] class like string 35 | 36 | def string2class(str) 37 | str.to_s.capitalize.gsub(/_(.)/) { |match| match[1].upcase } 38 | end 39 | 40 | # gets class name last part 41 | # @param klass [Class] class to read 42 | # @return [String] the class name only without nesting 43 | 44 | def class2name(klass) 45 | klass.name.split("::").last 46 | end 47 | 48 | end 49 | end 50 | -------------------------------------------------------------------------------- /lib/pluginator/errors.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | module Pluginator 21 | 22 | # base error for all Pluginator errors 23 | class PluginatorError < RuntimeError 24 | private 25 | 26 | def list_to_s(list) 27 | list.map { |plugin| plugin.to_s.inspect }.join(", ") 28 | end 29 | end 30 | 31 | # raised when plugin can not be found, generated by `*!` methods 32 | class MissingPlugin < PluginatorError 33 | # initialize new error 34 | # @param type [String] type of the loaded plugin 35 | # @param name [String] name of the loaded plugin 36 | # @param list [Array] list of available plugins 37 | def initialize(type, name, list) 38 | super("Can not find plugin #{name.inspect} in #{list_to_s(list)} for type #{type.inspect}.") 39 | end 40 | end 41 | 42 | # raised when type can not be found, generated by `*!` methods 43 | class MissingType < PluginatorError 44 | # initialize new error 45 | # @param type [String] type of the loaded plugin 46 | # @param list [Array] list of available types 47 | def initialize(type, list) 48 | super("Can not find type #{type.inspect} in #{list_to_s(list)}.") 49 | end 50 | end 51 | end 52 | -------------------------------------------------------------------------------- /test/pluginator/extendable_autodetect_test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "test_helper" 21 | require "pluginator/extendable_autodetect" 22 | 23 | describe Pluginator::ExtendableAutodetect do 24 | it :loads_existing_extensions_array do 25 | pluginator = Pluginator::ExtendableAutodetect.new("something", :extends => [:conversions]) 26 | pluginator.public_methods.map(&:to_sym).must_include(:class2string) 27 | pluginator.public_methods.map(&:to_sym).must_include(:string2class) 28 | pluginator.public_methods.map(&:to_sym).wont_include(:plugins_map) 29 | end 30 | 31 | it :loads_existing_extensions_symbol do 32 | pluginator = Pluginator::ExtendableAutodetect.new("something", :extends => :conversions) 33 | pluginator.public_methods.map(&:to_sym).must_include(:class2string) 34 | pluginator.public_methods.map(&:to_sym).must_include(:string2class) 35 | pluginator.public_methods.map(&:to_sym).wont_include(:plugins_map) 36 | end 37 | 38 | it :fails_to_load_missing_extension do 39 | lambda { 40 | Pluginator::ExtendableAutodetect.new("something", :extends => [:missing_conversions]) 41 | }.must_raise(Pluginator::MissingPlugin) 42 | end 43 | end 44 | -------------------------------------------------------------------------------- /lib/pluginator/group.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | module Pluginator 21 | # Initial data for pluginator, includes group name and plugins 22 | class Group 23 | # Group name used for plugins 24 | attr_reader :group 25 | 26 | # sets up new instance and initial configuration 27 | # @param group [String] name of the plugins group 28 | def initialize(group) 29 | setup_group(group) 30 | end 31 | 32 | # @param [String] type of plugins to select 33 | # @return [Array] list of plugins for type 34 | def [](type) 35 | @plugins[type.to_s] 36 | end 37 | 38 | # @return [Array] list of plugin types loaded 39 | def types 40 | @plugins.keys 41 | end 42 | 43 | # Register a new plugin, can be used to load custom plugins 44 | # 45 | # @param type [String] type for the klass 46 | # @param klass [Class] klass of the plugin to add 47 | def register_plugin(type, klass) 48 | type = type.to_s 49 | @plugins[type] ||= [] 50 | @plugins[type].push(klass) unless @plugins[type].include?(klass) 51 | end 52 | 53 | private 54 | 55 | def setup_group(group) 56 | @plugins = {} 57 | @group = group 58 | end 59 | end 60 | end 61 | -------------------------------------------------------------------------------- /pluginator.gemspec: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # -*- encoding: utf-8 -*- 3 | # stub: PLUGINATOR ruby lib 4 | 5 | =begin 6 | Copyright 2013-2017 7 | - Michal Papis 8 | - Jordon Bedwell 9 | 10 | This file is part of pluginator. 11 | 12 | pluginator is free software: you can redistribute it and/or modify 13 | it under the terms of the GNU Lesser General Public License as published 14 | by the Free Software Foundation, either version 3 of the License, or 15 | (at your option) any later version. 16 | 17 | pluginator is distributed in the hope that it will be useful, 18 | but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 | GNU Lesser General Public License for more details. 21 | 22 | You should have received a copy of the GNU Lesser General Public License 23 | along with pluginator. If not, see . 24 | =end 25 | 26 | lib = File.expand_path("../lib", __FILE__) 27 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 28 | require "pluginator/version" 29 | 30 | Gem::Specification.new do |s| 31 | s.email = ["mpapis@gmail.com", "envygeeks@gmail.com", "mose@mose.com", "johnogara@gmail.com"] 32 | s.authors = ["Michal Papis", "Jordon Bedwell", "Mose", "John O'Gara" ] 33 | s.name = "pluginator" 34 | s.version = Pluginator::VERSION.dup 35 | s.license = "LGPL v3" 36 | s.files = Dir["lib/**/*.rb", "*.md", "COPYING*"] 37 | s.required_ruby_version = ">= 1.9.3" 38 | s.required_rubygems_version = ">= 2.0.0" 39 | s.add_development_dependency("rake") 40 | s.add_development_dependency("rubocop") if RUBY_VERSION>="2.0.0" 41 | s.add_development_dependency("minitest") 42 | s.add_development_dependency("minitest-reporters") 43 | # s.add_development_dependency("smf-gem") 44 | s.homepage = "https://github.com/rvm/pluginator" 45 | s.summary = "Rubygems plugin system using Gem.find_files, $LOAD_PATH and $LOADED_FEATURES." 46 | end 47 | -------------------------------------------------------------------------------- /test/plugins_test/extensions/matching_test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "test_helper" 21 | require "plugins/pluginator/extensions/matching" 22 | 23 | class MatchingTester 24 | attr_accessor :plugins 25 | include Pluginator::Extensions::Matching 26 | end 27 | 28 | describe Pluginator::Extensions::Matching do 29 | before do 30 | @tester = MatchingTester.new 31 | @tester.plugins = { "extensions" => [ 32 | Pluginator::Extensions::PluginsMap, 33 | Pluginator::Extensions::Conversions, 34 | Pluginator::Extensions::Matching 35 | ] } 36 | end 37 | 38 | it :finds_existing_plugin do 39 | @tester.matching("extensions", ["plugins_map"]).must_equal( [Pluginator::Extensions::PluginsMap] ) 40 | end 41 | 42 | it :finds_existing_plugin_no_exception do 43 | @tester.matching!("extensions", ["plugins_map"]).must_equal( [Pluginator::Extensions::PluginsMap] ) 44 | end 45 | 46 | it :does_not_find_missing_plugin_no_exception do 47 | @tester.matching("extensions", ["plugins_map2"]).must_equal( [nil] ) 48 | end 49 | 50 | it :finds_existing_plugin do 51 | lambda { 52 | @tester.matching!("extensions", ["plugins_map2"]) 53 | }.must_raise(Pluginator::MissingPlugin) 54 | end 55 | end 56 | -------------------------------------------------------------------------------- /test/plugins_test/extensions/first_class_test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "test_helper" 21 | require "plugins/pluginator/extensions/first_class" 22 | require "plugins/something/stats/max" 23 | 24 | class FirstClassTester 25 | attr_accessor :plugins 26 | include Pluginator::Extensions::FirstClass 27 | end 28 | 29 | describe Pluginator::Extensions::FirstClass do 30 | before do 31 | @tester = FirstClassTester.new 32 | @tester.plugins = { "stats" => [ 33 | Something::Stats::Max 34 | ] } 35 | end 36 | 37 | it :finds_existing_plugin do 38 | @tester.first_class("stats", "max").must_equal( Something::Stats::Max ) 39 | end 40 | 41 | it :finds_proper_plugin do 42 | @tester.first_class("stats", "max").action.must_equal( 42 ) 43 | end 44 | 45 | it :finds_existing_plugin_no_exception do 46 | @tester.first_class!("stats", "max").must_equal( Something::Stats::Max ) 47 | end 48 | 49 | it :does_not_find_missing_plugin_no_exception do 50 | @tester.first_class("stats", "min").must_be_nil 51 | end 52 | 53 | it :does_not_find_missing_plugin_exception_plugin do 54 | lambda { 55 | @tester.first_class!("stats", "min") 56 | }.must_raise(Pluginator::MissingPlugin) 57 | end 58 | it :does_not_find_missing_plugin_exception_type do 59 | lambda { 60 | @tester.first_class!("stats2", "max") 61 | }.must_raise(Pluginator::MissingType) 62 | end 63 | end 64 | -------------------------------------------------------------------------------- /test/plugins_test/extensions/first_ask_test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "test_helper" 21 | require "plugins/pluginator/extensions/first_ask" 22 | require "plugins/something/stats/max" 23 | 24 | class FirstAskTester 25 | attr_accessor :plugins 26 | include Pluginator::Extensions::FirstAsk 27 | end 28 | 29 | describe Pluginator::Extensions::FirstAsk do 30 | before do 31 | @tester = FirstAskTester.new 32 | @tester.plugins = { "stats" => [ 33 | Something::Stats::Max 34 | ] } 35 | end 36 | 37 | it :finds_existing_plugin do 38 | @tester.first_ask("stats", "handles?", "max").must_equal( Something::Stats::Max ) 39 | end 40 | 41 | it :finds_proper_plugin do 42 | @tester.first_ask("stats", "handles?", "max").action.must_equal( 42 ) 43 | end 44 | 45 | it :finds_existing_plugin_no_exception do 46 | @tester.first_ask!("stats", "handles?", "max").must_equal( Something::Stats::Max ) 47 | end 48 | 49 | it :does_not_find_missing_plugin_no_exception do 50 | @tester.first_ask("stats", "handles?", "min").must_be_nil 51 | end 52 | 53 | it :does_not_find_missing_plugin_exception_plugin do 54 | lambda { 55 | @tester.first_ask!("stats", "handles?", "min") 56 | }.must_raise(Pluginator::MissingPlugin) 57 | end 58 | it :does_not_find_missing_plugin_exception_type do 59 | lambda { 60 | @tester.first_ask!("stats2", "handles?", "max") 61 | }.must_raise(Pluginator::MissingType) 62 | end 63 | end 64 | -------------------------------------------------------------------------------- /lib/plugins/pluginator/extensions/first_class.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "plugins/pluginator/extensions/plugins_map" 21 | require "plugins/pluginator/extensions/conversions" 22 | 23 | module Pluginator::Extensions 24 | # Extension to find first plugin whose class matches the string 25 | module FirstClass 26 | 27 | include PluginsMap 28 | include Conversions 29 | 30 | # Find first plugin whose class matches the given name. 31 | # 32 | # @param type [String] name of type to search for plugins 33 | # @param klass [Symbol|String] name of the searched class 34 | # @return [Class] The first plugin that matches the klass 35 | def first_class(type, klass) 36 | (plugins_map(type) || {})[string2class(klass)] 37 | end 38 | 39 | # Find first plugin whose class matches the given name. 40 | # Behaves like `first_class` but throws exceptions if can not find anything. 41 | # @param type [String] name of type to search for plugins 42 | # @param klass [Symbol|String] name of the searched class 43 | # @return [Class] The first plugin that matches the klass 44 | # @raise [Pluginator::MissingPlugin] when can not find plugin 45 | def first_class!(type, klass) 46 | @plugins[type] or raise Pluginator::MissingType.new(type, @plugins.keys) 47 | klass = string2class(klass) 48 | plugins_map(type)[klass] or 49 | raise Pluginator::MissingPlugin.new(type, klass, plugins_map(type).keys) 50 | end 51 | end 52 | end 53 | -------------------------------------------------------------------------------- /lib/plugins/pluginator/extensions/matching.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "plugins/pluginator/extensions/plugins_map" 21 | require "plugins/pluginator/extensions/conversions" 22 | 23 | module Pluginator::Extensions 24 | # Extension to select plugins that class name matches the list of string 25 | module Matching 26 | include PluginsMap 27 | include Conversions 28 | 29 | # Map array of names to available plugins. 30 | # 31 | # @param type [String] name of type to search for plugins 32 | # @param list [Array] list of plugin names to load 33 | # @return [Array] list of loaded plugins 34 | def matching(type, list) 35 | list.map do |plugin| 36 | (plugins_map(type) || {})[string2class(plugin)] 37 | end 38 | end 39 | 40 | # Map array of names to available plugins. 41 | # Behaves like `matching` but throws exceptions if can not find anything. 42 | # @param type [String] name of type to search for plugins 43 | # @param list [Array] list of plugin names to load 44 | # @return [Array] list of loaded plugins 45 | # @raise [Pluginator::MissingPlugin] when can not find plugin 46 | def matching!(type, list) 47 | @plugins[type] or raise Pluginator::MissingType.new(type, @plugins.keys) 48 | list.map do |plugin| 49 | plugin = string2class(plugin) 50 | plugins_map(type)[plugin] or 51 | raise Pluginator::MissingPlugin.new(type, plugin, plugins_map(type).keys) 52 | end 53 | end 54 | end 55 | end 56 | -------------------------------------------------------------------------------- /lib/pluginator/extendable_autodetect.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "pluginator/autodetect" 21 | 22 | module Pluginator 23 | # Container for all Pluginator extensions, 24 | # they are loaded in `ExtendableAutodetect` 25 | # @see ExtendableAutodetect#extend_plugins 26 | module Extensions 27 | end 28 | 29 | # Add extendability to Atudetect / Group 30 | # @see Autodetect 31 | # @see Group 32 | class ExtendableAutodetect < Autodetect 33 | 34 | # Automatically load plugins for given group (and type) 35 | # Extend instance with extensions if given. 36 | # 37 | # @param group [String] name of the plugins group 38 | # @param options [Hash] options to pass to creating Pluginator instance 39 | # @option type [String] name of type to load 40 | # @option extends [Array|Symbol] list of extension to extend into pluginator instance 41 | def initialize(group, options={}) 42 | super(group, options) 43 | extend_plugins(options[:extends] || []) 44 | end 45 | 46 | # Extend pluginator instance with given extensions 47 | # 48 | # @param extends [Array|Symbol] list of extension to extend into pluginator instance 49 | def extend_plugins(extends) 50 | extensions_matching(extends).each do |plugin| 51 | extend plugin 52 | end 53 | end 54 | 55 | private 56 | 57 | def pluginator_plugins 58 | @pluginator_plugins ||= begin 59 | plugins = Pluginator::Autodetect.new("pluginator") 60 | plugins.extend(Pluginator::Extensions::Matching) 61 | plugins 62 | end 63 | end 64 | 65 | def extensions_matching(extends) 66 | extends = [extends].flatten.map(&:to_s) 67 | pluginator_plugins.matching!("extensions", extends) 68 | end 69 | 70 | end 71 | end 72 | -------------------------------------------------------------------------------- /lib/plugins/pluginator/extensions/first_ask.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "plugins/pluginator/extensions/plugins_map" 21 | 22 | module Pluginator::Extensions 23 | # Extension to find first plugin that answers the question with true 24 | module FirstAsk 25 | 26 | include PluginsMap 27 | 28 | # Call a method on plugin and return first one that returns `true`. 29 | # 30 | # @param type [String] name of type to search for plugins 31 | # @param method_name [Symbol] name of the method to execute 32 | # @param params [Array] params to pass to the called method 33 | # @return [Class] The first plugin that method call returns true 34 | def first_ask(type, method_name, *params) 35 | @plugins[type] or return nil 36 | try_to_find(type, method_name, params) 37 | end 38 | 39 | # Call a method on plugin and return first one that returns `true`. 40 | # Behaves like `first_ask` but throws exceptions if can not find anything. 41 | # @param type [String] name of type to search for plugins 42 | # @param method_name [Symbol] name of the method to execute 43 | # @param params [Array] params to pass to the called method 44 | # @return [Class] The first plugin that method call returns true 45 | # @raise [Pluginator::MissingPlugin] when can not find plugin 46 | def first_ask!(type, method_name, *params) 47 | @plugins[type] or raise Pluginator::MissingType.new(type, @plugins.keys) 48 | try_to_find(type, method_name, params) or 49 | raise Pluginator::MissingPlugin.new(type, "first_ask: #{method_name}", plugins_map(type).keys) 50 | end 51 | 52 | private 53 | 54 | def try_to_find(type, method_name, params) 55 | @plugins[type].detect do |plugin| 56 | has_public_method?(plugin, method_name) and 57 | plugin.send(method_name.to_sym, *params) 58 | end 59 | end 60 | 61 | # need to use this trick because of old rubies support 62 | def has_public_method?(plugin, method_name) 63 | plugin.public_methods.map(&:to_sym).include?(method_name.to_sym) 64 | end 65 | 66 | end 67 | end 68 | -------------------------------------------------------------------------------- /lib/pluginator/autodetect/finder.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | module Pluginator 21 | class Autodetect 22 | 23 | # Find plugins 24 | class Finder 25 | 26 | attr_reader :loaded_plugins_path, :load_path_plugins_paths, :gem_plugins_paths 27 | 28 | # Automatically load plugins for given group (and type) 29 | # 30 | # @param force_prefix [String] a prefix for finding plugins if forcing, 31 | # by default only `/lib` is checked, 32 | # regexp notation is allowed, for example `/[lib|]` 33 | # @param group [String] name of the plugins group 34 | # @param force_type [String] name of the plugin type if forcing 35 | def initialize(force_prefix, group, force_type) 36 | @force_prefix = force_prefix 37 | @group = group 38 | @force_type = force_type 39 | @pattern = file_name_pattern 40 | find_paths 41 | end 42 | 43 | private 44 | 45 | # group => pattern 46 | def file_name_pattern 47 | "plugins/#{@group}/#{@force_type || "**"}/*.rb" 48 | end 49 | 50 | def find_paths 51 | @loaded_plugins_path = find_loaded_plugins 52 | @load_path_plugins_paths = find_load_path_plugins - @loaded_plugins_path 53 | @gem_plugins_paths = find_gem_plugins - @load_path_plugins_paths - @loaded_plugins_path 54 | end 55 | 56 | def find_loaded_plugins 57 | split_file_names( 58 | $LOADED_FEATURES 59 | ).compact 60 | end 61 | 62 | def find_load_path_plugins 63 | split_file_names( 64 | Gem.find_files_from_load_path(@pattern) 65 | ) 66 | end 67 | 68 | def find_gem_plugins 69 | split_file_names( 70 | Gem.find_files(@pattern, false) 71 | ) 72 | end 73 | 74 | def split_file_names(file_names) 75 | file_names.map do |file_name| 76 | split_file_name(file_name) 77 | end 78 | end 79 | 80 | # file_name => [ path, full_name, type ] 81 | def split_file_name(file_name) 82 | prefix = @force_prefix || "/lib" 83 | type = @force_type || ".*" 84 | match = file_name.match(%r{.*#{prefix}/(plugins/(#{@group}/(#{type})/[^/]*)\.rb)$}) 85 | match[-3..-1] if match 86 | end 87 | 88 | end 89 | end 90 | end 91 | -------------------------------------------------------------------------------- /test/test_helper.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 3 | - Michal Papis 4 | - Jordon Bedwell 5 | 6 | This file is part of pluginator. 7 | 8 | pluginator is free software: you can redistribute it and/or modify 9 | it under the terms of the GNU Lesser General Public License as published 10 | by the Free Software Foundation, either version 3 of the License, or 11 | (at your option) any later version. 12 | 13 | pluginator is distributed in the hope that it will be useful, 14 | but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | GNU Lesser General Public License for more details. 17 | 18 | You should have received a copy of the GNU Lesser General Public License 19 | along with pluginator. If not, see . 20 | =end 21 | 22 | require "rubygems" 23 | require "minitest" 24 | 25 | # fix lib in LOAD_PATH and load version for gems manipulation 26 | lib = File.expand_path("../../lib", __FILE__) 27 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 28 | require "pluginator/version" 29 | 30 | # remove old links in fake gem home 31 | `rm -f #{File.expand_path("../gems/specifications/pluginator-*.gemspec", __FILE__)}` 32 | `rm -f #{File.expand_path("../gems/gems/pluginator-*", __FILE__)}` 33 | 34 | # create new links in fake gem home 35 | File.symlink(File.expand_path("../../pluginator.gemspec", __FILE__), File.expand_path("../gems/specifications/pluginator-#{Pluginator::VERSION}.gemspec", __FILE__)) 36 | File.symlink(File.expand_path("../../", __FILE__), File.expand_path("../gems/gems/pluginator-#{Pluginator::VERSION}", __FILE__)) 37 | 38 | # register our own path with gems 39 | # duplicate from Gemfile for non bundler 40 | Gem.path << File.expand_path("../gems", __FILE__) 41 | Gem.refresh 42 | 43 | # register custom LOAD_PATH 44 | load_path = File.expand_path("../gems/load_path", __FILE__) 45 | $LOAD_PATH.push(load_path) 46 | 47 | # make sure pluginator is available as gem for tests of pluginator plugins 48 | #Gem::Specification.add_spec(Gem::Specification.load(File.expand_path("../gems/specifications/pluginator-#{Pluginator::VERSION}.gemspec", __FILE__))) 49 | gem "pluginator" 50 | 51 | if 52 | RUBY_VERSION.start_with?("2.4") && # check Gemfile 53 | $0 != "-e" # do not do that in guard 54 | then 55 | require "coveralls" 56 | require "simplecov" 57 | 58 | SimpleCov.start do 59 | formatter SimpleCov::Formatter::MultiFormatter.new([ 60 | SimpleCov::Formatter::HTMLFormatter, 61 | Coveralls::SimpleCov::Formatter, 62 | ]) 63 | command_name "Unit Tests" 64 | add_filter "/test/" 65 | end 66 | 67 | Coveralls.noisy = true unless ENV["CI"] 68 | end 69 | # Ensure all files are counted in 70 | Dir[lib+"/**/*.rb"].each{|file| require file } 71 | 72 | # We are removing paths from $LOAD_PATH, 73 | # disabling verbose to not get warnings 74 | # when the files are required again 75 | $VERBOSE = false 76 | 77 | module Something 78 | module Math; end 79 | module Stats; end 80 | module Nested 81 | module Structure; end 82 | end 83 | end 84 | module Activated 85 | module Version1; end 86 | end 87 | module Latest 88 | module Version1; end 89 | module Version2; end 90 | end 91 | module V1test 92 | module Stats; end 93 | end 94 | module V2test 95 | module Stats; end 96 | end 97 | 98 | require "minitest/autorun" unless $0=="-e" # skip in guard 99 | require "minitest/unit" 100 | require "minitest/reporters" 101 | Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new 102 | -------------------------------------------------------------------------------- /lib/pluginator/autodetect/formatted_finder.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "pluginator/autodetect/finder" 21 | 22 | module Pluginator 23 | class Autodetect 24 | 25 | # Categorize plugins 26 | # @see: Finder 27 | class FormattedFinder < Finder 28 | 29 | # Reformat plugin lists 30 | def initialize(force_prefix, group, force_type) 31 | super 32 | map_loaded_plugins 33 | map_gem_plugins 34 | end 35 | 36 | private 37 | 38 | def gem_has_method?(name) 39 | Gem.methods.map(&:to_sym).include?(name) 40 | end 41 | 42 | def map_loaded_plugins 43 | @loaded_plugins_path.map! do |_path, name, type| 44 | [name, type] 45 | end 46 | end 47 | 48 | def map_gem_plugins 49 | gem_specifications = find_gem_specifications 50 | @gem_plugins_paths.map! do |path, name, type| 51 | gemspec = gemspec_for_path(path, gem_specifications) 52 | [gemspec, path, name, type] if gemspec 53 | end.compact 54 | end 55 | 56 | def find_gem_specifications 57 | if 58 | gem_has_method?(:gemdeps) && Gem.gemdeps 59 | then 60 | # :nocov: only testable with using rubygems's gemdeps feature 61 | Gem.loaded_specs.values.to_a 62 | # :nocov: 63 | else 64 | specs = Gem::Specification._all.to_a 65 | specs = (Gem.loaded_specs.values.to_a + specs).uniq if gem_has_method?(:loaded_specs) 66 | specs 67 | end 68 | end 69 | 70 | def gemspec_for_path(path, specifications) 71 | gemspecs = gemspecs_for_path(path, specifications) 72 | case 73 | gemspecs.size 74 | when 0 75 | nil 76 | when 1 77 | gemspecs.first 78 | else 79 | find_latest_plugin_version(gemspecs, path) 80 | end 81 | end 82 | 83 | def gemspecs_for_path(path, specifications) 84 | specifications.reject do |spec| 85 | Dir.glob( File.join( spec.lib_dirs_glob, path ) ).empty? 86 | end 87 | end 88 | 89 | def find_latest_plugin_version(gemspecs, path) 90 | active_or_latest_gemspec(gemspecs_sorted_by_metadata_and_version(gemspecs, path)) 91 | end 92 | 93 | # find active or latest gem in given set 94 | def active_or_latest_gemspec(specifications) 95 | specifications.find(&:activated) || specifications.last 96 | end 97 | 98 | def gemspecs_sorted_by_metadata_and_version(gemspecs, path) 99 | gemspecs.sort_by do |spec| 100 | [calculate_plugin_version(spec.metadata, path), spec.name, spec.version] 101 | end 102 | end 103 | 104 | def calculate_plugin_version(metadata, path) 105 | ( (metadata || {})[path] || "0" ).to_i 106 | end 107 | 108 | end 109 | end 110 | end 111 | -------------------------------------------------------------------------------- /lib/pluginator/autodetect.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "pluginator/errors" 21 | require "pluginator/group" 22 | require "pluginator/name_converter" 23 | 24 | module Pluginator 25 | class Autodetect < Group 26 | end 27 | end 28 | 29 | require "pluginator/autodetect/formatted_finder" 30 | 31 | module Pluginator 32 | # Add autodetection capabilities to Group 33 | # @see Group, FormattedFinder 34 | class Autodetect 35 | 36 | # Automatically load plugins for given group (and type) 37 | # 38 | # @param group [String] name of the plugins group 39 | # @param options [Hash] options to pass to creating Pluginator instance 40 | # @option type [String] name of the plugin type 41 | # @option prefix [String] a prefix for finding plugins if forcing, 42 | # by default only `/lib` is checked, 43 | # regexp notation is allowed, for example `/(lib|local_lib)` 44 | 45 | def initialize(group, options={}) 46 | super(group) 47 | @force_prefix = options[:prefix] 48 | @force_type = options[:type] 49 | refresh 50 | end 51 | 52 | # Initiate another lookup for plugins 53 | # - does not clean the state 54 | # - does not resolve all gems, only the new ones 55 | # 56 | # Use it after gem list change, for example after `Gem.install("new_gem")` 57 | def refresh 58 | plugin_lists = FormattedFinder.new(@force_prefix, @group, @force_type) 59 | register_plugins(plugin_lists.loaded_plugins_path) 60 | load_plugins(plugin_lists.load_path_plugins_paths) 61 | activate_plugins(plugin_lists.gem_plugins_paths) 62 | end 63 | 64 | # Return the forced type 65 | def type 66 | @plugins[@force_type] unless @force_type.nil? 67 | end 68 | 69 | private 70 | 71 | include NameConverter 72 | 73 | def register_plugins(plugins_to_register) 74 | plugins_to_register.each do |name, type| 75 | register_plugin(type, name2class(name)) 76 | end 77 | end 78 | 79 | def load_plugins(plugins_to_load) 80 | plugins_to_load.each do |path, name, type| 81 | require path 82 | register_plugin(type, name2class(name)) 83 | end 84 | end 85 | 86 | def activate_plugins(plugins_to_activate) 87 | selected = active_or_latest_gems_matching(plugins_to_activate.map(&:first).compact) 88 | plugins_to_activate.each do |gemspec, path, name, type| 89 | next unless selected.include?(gemspec) 90 | gemspec.activate 91 | require path 92 | register_plugin(type, name2class(name)) 93 | end 94 | end 95 | 96 | # filter active / latest gem versions 97 | def active_or_latest_gems_matching(specifications) 98 | specifications.group_by(&:name).map do |_name, plugin_specifications| 99 | active_or_latest_gemspec(plugin_specifications.sort) 100 | end 101 | end 102 | 103 | # find active or latest gem in given set 104 | def active_or_latest_gemspec(specifications) 105 | specifications.find(&:activated) || specifications.last 106 | end 107 | 108 | end 109 | end 110 | -------------------------------------------------------------------------------- /test/pluginator/autodetect_test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "test_helper" 21 | require "pluginator/autodetect" 22 | 23 | def gem_file(path, options = {}) 24 | options.merge!({ 25 | :gem_name => "fake-gem-name-a", 26 | :gem_version => "1.0.0", 27 | }) 28 | File.expand_path( 29 | File.join( 30 | "../../gems/gems/#{options[:gem_name]}-#{options[:gem_version]}/lib", 31 | path 32 | ), 33 | __FILE__ 34 | ) 35 | end 36 | 37 | def gem_files(*paths) 38 | options = paths.last.is_a?(::Hash) ? paths.pop : {} 39 | paths.flatten.map{|path| gem_file(path, options) } 40 | end 41 | 42 | describe Pluginator::Autodetect do 43 | before do 44 | @math_parsed = [ 45 | ["plugins/something/math/increase.rb", "something/math/increase", "math"], 46 | ["plugins/something/math/decrease.rb", "something/math/decrease", "math"] 47 | ] 48 | @math_files = gem_files(@math_parsed.map(&:first)) 49 | @all_files = gem_files( 50 | "plugins/something/math/increase.rb", "plugins/something/math/decrease.rb", 51 | "plugins/something/nested/structure/test.rb", "plugins/something/stats/max.rb" 52 | ) 53 | end 54 | 55 | it :loads_plugins_automatically_for_group do 56 | pluginator = Pluginator::Autodetect.new("something") 57 | pluginator.types.must_include("stats") 58 | pluginator.types.must_include("math") 59 | pluginator.types.size.must_equal(3) 60 | plugins = pluginator["math"].map(&:to_s) 61 | plugins.size.must_equal(2) 62 | plugins.must_include("Something::Math::Increase") 63 | plugins.must_include("Something::Math::Decrease") 64 | plugins.wont_include("Something::Math::Add") 65 | end 66 | 67 | it :loads_plugins_automatically_for_group_type do 68 | pluginator = Pluginator::Autodetect.new("something", :type => "stats") 69 | pluginator.types.sort.must_equal(["stats"]) 70 | end 71 | 72 | it :makes_group_plugins_work do 73 | pluginator = Pluginator::Autodetect.new("something") 74 | pluginator.types.must_include("math") 75 | pluginator["math"].detect{|plugin| plugin.type == "increase" }.action(2).must_equal(3) 76 | pluginator["math"].detect{|plugin| plugin.type == "decrease" }.action(5).must_equal(4) 77 | end 78 | 79 | it :hides_methods do 80 | pluginator = Pluginator::Autodetect.new("something") 81 | pluginator.public_methods.map(&:to_sym).must_include(:register_plugin) 82 | pluginator.public_methods.map(&:to_sym).wont_include(:split_file_name) 83 | end 84 | 85 | it :has_no_type_when_not_forced do 86 | pluginator = Pluginator::Autodetect.new("something") 87 | pluginator.type.must_be_nil 88 | end 89 | 90 | it :defines_type_method_dynamically do 91 | pluginator = Pluginator::Autodetect.new("something", :type => "math") 92 | pluginator.type.wont_be_nil 93 | pluginator.type.must_equal(pluginator["math"]) 94 | end 95 | 96 | it :loads_self do 97 | pluginator = Pluginator::Autodetect.new("pluginator") 98 | pluginator.types.must_include("extensions") 99 | pluginator.types.size.must_equal(1) 100 | plugins = pluginator["extensions"].map(&:to_s) 101 | assert plugins.size >= 6 102 | plugins.must_include("Pluginator::Extensions::ClassExist") 103 | plugins.must_include("Pluginator::Extensions::Conversions") 104 | plugins.must_include("Pluginator::Extensions::FirstAsk") 105 | plugins.must_include("Pluginator::Extensions::FirstClass") 106 | plugins.must_include("Pluginator::Extensions::Matching") 107 | plugins.must_include("Pluginator::Extensions::PluginsMap") 108 | end 109 | 110 | end 111 | -------------------------------------------------------------------------------- /test/pluginator_test.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Copyright 2013-2017 Michal Papis 3 | 4 | This file is part of pluginator. 5 | 6 | pluginator is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published 8 | by the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | pluginator is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with pluginator. If not, see . 18 | =end 19 | 20 | require "test_helper" 21 | require "pluginator" 22 | 23 | describe Pluginator do 24 | it :loads_plugins_automatically_for_group do 25 | pluginator = Pluginator.find("something") 26 | pluginator.types.must_include("stats") 27 | pluginator.types.must_include("math") 28 | pluginator.types.must_include("nested/structure") 29 | pluginator.types.size.must_equal(3) 30 | plugins = pluginator["math"].map(&:to_s) 31 | plugins.size.must_equal(2) 32 | plugins.must_include("Something::Math::Increase") 33 | plugins.must_include("Something::Math::Decrease") 34 | plugins.wont_include("Something::Math::Add") 35 | end 36 | 37 | it :loads_plugins_automatically_for_group_type do 38 | pluginator = Pluginator.find("something", :type => "stats") 39 | pluginator.types.sort.must_equal(["stats"]) 40 | end 41 | 42 | it :loads_existing_extensions_symbol do 43 | pluginator = Pluginator.find("something", :extends => :conversions) 44 | pluginator.public_methods.map(&:to_sym).must_include(:class2string) 45 | pluginator.public_methods.map(&:to_sym).must_include(:string2class) 46 | pluginator.public_methods.map(&:to_sym).wont_include(:plugins_map) 47 | end 48 | 49 | it :loads_nested_plugins do 50 | pluginator = Pluginator.find("something") 51 | pluginator.types.must_include("nested/structure") 52 | pluginator["nested/structure"].map(&:to_s).must_equal(["Something::Nested::Structure::Test"]) 53 | end 54 | 55 | it :loads_plugins_from_load_path do 56 | pluginator = Pluginator.find("load_path", :prefix => "/(lib|load_path)") 57 | pluginator.types.must_include("stats") 58 | pluginator["stats"].map(&:to_s).must_equal(["LoadPath::Stats::Max"]) 59 | end 60 | 61 | it :loads_only_plugins_from_latest_version_of_gem do 62 | all_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" } 63 | all_gems.must_include("fake-gem-name-latest-1.0.0") 64 | all_gems.must_include("fake-gem-name-latest-2.0.0") 65 | active_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" if s.activated? }.compact 66 | active_gems.wont_include("fake-gem-name-latest-1.0.0") 67 | active_gems.wont_include("fake-gem-name-latest-2.0.0") 68 | 69 | pluginator = Pluginator.find("latest") 70 | 71 | active_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" if s.activated? }.compact 72 | active_gems.wont_include("fake-gem-name-latest-1.0.0") 73 | active_gems.must_include("fake-gem-name-latest-2.0.0") 74 | 75 | pluginator.types.must_include("version2") 76 | pluginator.types.wont_include("version1") 77 | pluginator.types.size.must_equal(1) 78 | pluginator["version2"].map(&:to_s).must_equal(["Latest::Version2::Max"]) 79 | end 80 | 81 | it :loads_only_plugins_from_activated_version_of_gem do 82 | all_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" } 83 | all_gems.must_include("fake-gem-name-activated-1.0.0") 84 | all_gems.must_include("fake-gem-name-activated-2.0.0") 85 | Gem::Specification._all.find{|s| [s.name, s.version.to_s] == ["fake-gem-name-activated", "1.0.0"] }.activate 86 | active_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" if s.activated? }.compact 87 | active_gems.must_include("fake-gem-name-activated-1.0.0") 88 | active_gems.wont_include("fake-gem-name-activated-2.0.0") 89 | 90 | pluginator = Pluginator.find("activated") 91 | 92 | active_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" if s.activated? }.compact 93 | active_gems.must_include("fake-gem-name-activated-1.0.0") 94 | 95 | pluginator.types.must_include("version1") 96 | pluginator.types.size.must_equal(1) 97 | pluginator["version1"].map(&:to_s).must_equal(["Activated::Version1::Max"]) 98 | end 99 | 100 | it :loads_latest_version_of_plugin_from_two_gems_v1 do 101 | all_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" } 102 | all_gems.must_include("fake-gem-name-v1a-1.0.0") 103 | all_gems.must_include("fake-gem-name-v1b-1.0.0") 104 | active_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" if s.activated? }.compact 105 | active_gems.wont_include("fake-gem-name-v1a-1.0.0") 106 | 107 | pluginator = Pluginator.find("v1test") 108 | 109 | active_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" if s.activated? }.compact 110 | active_gems.wont_include("fake-gem-name-v1a-1.0.0") 111 | active_gems.must_include("fake-gem-name-v1b-1.0.0") 112 | 113 | pluginator.types.must_include("stats") 114 | pluginator.types.size.must_equal(1) 115 | pluginator["stats"].map(&:to_s).must_equal(["V1test::Stats::Max"]) 116 | pluginator["stats"].first.action.must_equal(42) 117 | end 118 | 119 | it :loads_latest_version_of_plugin_from_two_gems_v2 do 120 | all_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" } 121 | all_gems.must_include("fake-gem-name-v2a-1.0.0") 122 | all_gems.must_include("fake-gem-name-v2b-1.0.0") 123 | active_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" if s.activated? }.compact 124 | active_gems.wont_include("fake-gem-name-v2a-1.0.0") 125 | 126 | pluginator = Pluginator.find("v2test") 127 | 128 | active_gems = Gem::Specification._all.map{|s| "#{s.name}-#{s.version}" if s.activated? }.compact 129 | active_gems.must_include("fake-gem-name-v2a-1.0.0") 130 | active_gems.wont_include("fake-gem-name-v2b-1.0.0") 131 | 132 | pluginator.types.must_include("stats") 133 | pluginator.types.size.must_equal(1) 134 | pluginator["stats"].map(&:to_s).must_equal(["V2test::Stats::Max"]) 135 | pluginator["stats"].first.action.must_equal(41) 136 | end 137 | end 138 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Pluginator 2 | 3 | [![Gem Version](https://badge.fury.io/rb/pluginator.png)](http://rubygems.org/gems/pluginator) 4 | [![Code Climate](https://codeclimate.com/github/rvm/pluginator.png)](https://codeclimate.com/github/rvm/pluginator) 5 | [![Coverage Status](https://coveralls.io/repos/rvm/pluginator/badge.png)](https://coveralls.io/r/rvm/pluginator) 6 | [![Build Status](https://travis-ci.org/rvm/pluginator.png)](https://travis-ci.org/rvm/pluginator) 7 | [![Dependency Status](https://gemnasium.com/rvm/pluginator.png)](https://gemnasium.com/rvm/pluginator) 8 | [![Inline docs](http://inch-ci.org/github/rvm/pluginator.png)](http://inch-ci.org/github/rvm/pluginator) 9 | [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/rvm/pluginator/master/frames) 10 | [![Github Code](http://img.shields.io/badge/github-code-blue.svg)](https://github.com/rvm/pluginator) 11 | 12 | Gem plugin system management, detects plugins using `Gem.find_file`, 13 | `$LOAD_PATH` and `$LOADED_FEATURES`. 14 | 15 | Pluginator works with *ruby 1.9.3+* and *rubygems 2.0.0+*. 16 | 17 | Pluginator tries to stay out of your way, you do not have to include or inherit anything. 18 | Pluginator only finds and groups plugins, rest is up to you, 19 | you decide what methods to define and how to find them. 20 | 21 | ## Defining plugins 22 | 23 | create a gem with a path: 24 | 25 | ```ruby 26 | lib/plugins///.rb 27 | ``` 28 | 29 | with a class inside: 30 | 31 | ```ruby 32 | :::: 33 | ``` 34 | 35 | where `` can be nested 36 | 37 | ## Loading plugins 38 | 39 | ```ruby 40 | rvm2plugins = Pluginator.find("") 41 | type_plugins = rvm2plugins[""] 42 | types = rvm2plugins.types 43 | ``` 44 | 45 | ## Usage 46 | 47 | ```ruby 48 | Pluginator.find("") => Pluginator object 49 | plugins = Pluginator.find("", type: "", prefix: "/(lib|local_lib)", extends: %i[]) 50 | plugins[""] => Array of plugins 51 | plugins.type => Array of plugins for type defined with `type: ""` 52 | plugins.types => Array of types 53 | ``` 54 | 55 | - `""` - Load plugins for given group. 56 | - `type: ""` - Load plugins only of given type, optional, makes `type` method accessible. 57 | - `prefix: "/prefix"` - Load plugins only from this paths, optional, default `/lib`. 58 | - `extends: %i[]` - Extend pluginator with given extensions. 59 | 60 | ## Extensions 61 | 62 | Pluginator comes with few handful extensions. 63 | 64 | ### Class exist 65 | 66 | Check if plugin with given class name exists. 67 | 68 | ```ruby 69 | plugins = Pluginator.find("", extends: %i[class_exist]}) 70 | plugins.class_exist?("", "") => true or false 71 | ``` 72 | 73 | ### First ask 74 | 75 | Call a method on plugin and return first one that returns `true`. 76 | 77 | ```ruby 78 | plugins = Pluginator.find("", extends: %i[first_ask]) 79 | plugins.first_ask( "", "method_to_call", *params) => plugin or nil 80 | plugins.first_ask!("", "method_to_call", *params) => plugin or exception PluginatorError 81 | ``` 82 | 83 | ### First class 84 | 85 | Find first plugin that class matches the given name. 86 | 87 | ```ruby 88 | plugins = Pluginator.find("", extends: %i[first_class]) 89 | plugins.first_class( "", "") => plugin or nil 90 | plugins.first_class!("", "") => plugin or exception PluginatorError 91 | ``` 92 | 93 | ### Matching 94 | 95 | Map array of names to available plugins. 96 | 97 | ```ruby 98 | plugins = Pluginator.find("", extends: %i[matching]) 99 | plugins.matching( "", []) => [plugins] # nil for missing ones 100 | plugins.matching!("", []) => [plugins] or exception PluginatorError 101 | ``` 102 | 103 | ### Your own ones 104 | 105 | You can define your own extensions for `pluginator`, for example: 106 | 107 | ```shell 108 | plugins/pluginator/extensions/first_one.rb 109 | ``` 110 | 111 | with: 112 | 113 | ```ruby 114 | module Pluginator::Extensions 115 | class FirstOne 116 | def first_one(type) 117 | @plugins[type].first 118 | end 119 | end 120 | end 121 | ``` 122 | 123 | And now you can use it: 124 | 125 | ```ruby 126 | plugins = Pluginator.find("", extends: %i[first_one]) 127 | plugins.first_one("") => first_plugin # nil when none 128 | ``` 129 | 130 | 131 | ## Exceptions 132 | 133 | - `PluginatorError` - base error for all Pluginator errors 134 | - `MissingPlugin` - raised when plugin can not be found, generated by `*!` methods 135 | - `MissingType` - raised when type can not be found, generated by `*!` methods 136 | 137 | ## Versioning plugins 138 | 139 | In case plugin gets moved to other gem you can specify which gem to 140 | use for loading the plugin by specifying plugin version in gems gemspec 141 | metadata: 142 | 143 | ```ruby 144 | s.metadata = { 145 | "plugins/v2test/stats/max.rb" => "1" 146 | } 147 | ``` 148 | 149 | ## Examples 150 | 151 | ### Example 1 - task plugins 152 | 153 | `plugins/rvm2/cli/echo.rb`: 154 | 155 | ```ruby 156 | class Rvm2::Cli::Echo 157 | def self.question? command 158 | command == "echo" 159 | end 160 | def answer param 161 | puts param 162 | end 163 | end 164 | ``` 165 | 166 | where `question?` and `answer` are user defined methods 167 | 168 | Now the plugin can be used: 169 | 170 | ```ruby 171 | require "pluginator" 172 | 173 | rvm2plugins = Pluginator.find("rvm2") 174 | plugin = rvm2plugins["cli"].first{ |plugin| 175 | plugin.question?("echo") 176 | } 177 | plugin.new.answer("Hello world") 178 | ``` 179 | 180 | Or using extensions: 181 | 182 | ```ruby 183 | require "pluginator" 184 | 185 | plugin = Pluginator.find("rvm2", extends: %i[first_ask]).first_ask("cli", &:question?, "echo") 186 | plugin.new.answer("Hello world") 187 | ``` 188 | 189 | ### Example 2 - hook plugins 190 | 191 | `plugins/rvm2/hooks/after_install/show.rb`: 192 | 193 | ```ruby 194 | class Rvm2::Hooks::AfterInstall::Show 195 | def self.execute name, path 196 | puts "Ruby #{name.inspect} was installed in #{path.inspect}." 197 | end 198 | end 199 | ``` 200 | 201 | and using hooks: 202 | 203 | ```ruby 204 | require "pluginator" 205 | 206 | Pluginator.find("rvm2", type: "hooks/after_install").type.each{ |plugin| 207 | plugin.execute(name, path) 208 | } 209 | ``` 210 | 211 | ## Testing 212 | 213 | ```bash 214 | NOEXEC_DISABLE=1 rake test 215 | ``` 216 | 217 | ## License 218 | 219 | Copyright 2013-2017 Michal Papis 220 | 221 | pluginator is free software: you can redistribute it and/or modify 222 | it under the terms of the GNU Lesser General Public License as published 223 | by the Free Software Foundation, either version 3 of the License, or 224 | (at your option) any later version. 225 | 226 | pluginator is distributed in the hope that it will be useful, 227 | but WITHOUT ANY WARRANTY; without even the implied warranty of 228 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 229 | GNU Lesser General Public License for more details. 230 | 231 | You should have received a copy of the GNU Lesser General Public License 232 | along with pluginator. If not, see . 233 | 234 | For details on adding copyright visit: 235 | https://www.gnu.org/licenses/gpl-howto.html 236 | -------------------------------------------------------------------------------- /COPYING.LESSER: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------