ddplugin 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 19d0ae996f2999cccb30bc44777e07a1b0c04f1e
-  data.tar.gz: 8b0bda0c3d2bf442a8e1e8d49313c8b57ff44498
+SHA256:
+  metadata.gz: 998e406c491ddfcde5cd7559cd22084fca1327f1b27b8dd177d6fe21b30ff79b
+  data.tar.gz: 0b3673fdf1c69fc0ae67ca50ef4ac6575a9973e58d50d86b3a86a91ef3a6c796
 SHA512:
-  metadata.gz: f4eb79aa5c0cd23076cf4b32fe37ee40357bf77cf2c6b72929999c1af65f48a44ca29cada37632cebeb53177b694bc9500b9c5dd3c0c9f0bb16a2da4d1334d51
-  data.tar.gz: 39fe5a9c5b28043cc0c218bed98a2125e100660511a86ddf68e95dfe57fce1cc0902413f3fd05e5660b9a09474bfd2503eb7878b269cef04b1311a56bd87dc61
+  metadata.gz: 52a6bfdfadc2f47031beb29dc586cd81e2cf7bfb756148f8f1dec312b890701c075406ba3dbbf9694dc5f084ece2d311b03c78ffa844afa6ccf61b53c80ac98f
+  data.tar.gz: 65684a38e9e46dbf83da7e010269712280c7605a9d141ff46a799809f1621dd37edb0feedc019f98e6bbb68753162516fb829628e5526df9f3404911c2ceeeac

data/Gemfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
+gem 'coveralls', require: false
 gem 'minitest'
 gem 'rake'
-gem 'coveralls', require: false
 gem 'rubocop'

data/Gemfile.lock

@@ -1,43 +1,45 @@
 PATH
   remote: .
   specs:
-    ddplugin (1.0.1)
+    ddplugin (1.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.3.0)
-    coveralls (0.8.19)
+    ast (2.4.0)
+    coveralls (0.8.21)
       json (>= 1.8, < 3)
-      simplecov (~> 0.12.0)
+      simplecov (~> 0.14.1)
       term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
+      thor (~> 0.19.4)
       tins (~> 1.6)
     docile (1.1.5)
-    json (2.0.3)
-    minitest (5.10.1)
-    parser (2.4.0.0)
-      ast (~> 2.2)
+    json (2.1.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.0.5)
+      ast (~> 2.4.0)
     powerpack (0.1.1)
-    rainbow (2.2.1)
-    rake (12.0.0)
-    rubocop (0.47.1)
-      parser (>= 2.3.3.1, < 3.0)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rubocop (0.54.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    simplecov (0.12.0)
+    ruby-progressbar (1.9.0)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    term-ansicolor (1.4.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
       tins (~> 1.0)
     thor (0.19.4)
-    tins (1.13.2)
-    unicode-display_width (1.1.3)
+    tins (1.16.3)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
@@ -51,4 +53,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.14.5
+   1.16.1

data/NEWS.md

@@ -1,5 +1,11 @@
 # ddplugin release notes
 
+## 1.0.2 (2018-03-31)
+
+Enhancements:
+
+* Made it possible to pass strings instead of symbols (#4)
+
 ## 1.0.1 (2017-02-28)
 
 Fixes:

data/README.md

@@ -1,7 +1,8 @@
-[![Build Status](https://travis-ci.org/ddfreyne/ddplugin.png)](https://travis-ci.org/ddfreyne/ddplugin)
-[![Code Climate](https://codeclimate.com/github/ddfreyne/ddplugin.png)](https://codeclimate.com/github/ddfreyne/ddplugin)
-[![Coverage Status](https://coveralls.io/repos/ddfreyne/ddplugin/badge.png?branch=master)](https://coveralls.io/r/ddfreyne/ddplugin)
-[![Inline docs](http://inch-ci.org/github/ddfreyne/ddplugin.png)](http://inch-ci.org/github/ddfreyne/ddplugin)
+[![Gem version](http://img.shields.io/gem/v/ddplugin.svg)](http://rubygems.org/gems/ddplugin)
+[![Gem downloads](https://img.shields.io/gem/dt/ddplugin.svg)](http://rubygems.org/gems/ddplugin)
+[![Build status](http://img.shields.io/travis/ddfreyne/ddplugin.svg)](https://travis-ci.org/ddfreyne/ddplugin)
+[![Code Climate](http://img.shields.io/codeclimate/github/ddfreyne/ddplugin.svg)](https://codeclimate.com/github/ddfreyne/ddplugin)
+[![Code Coverage](https://img.shields.io/coveralls/ddfreyne/ddplugin.svg)](https://coveralls.io/r/ddfreyne/ddplugin)
 
 # ddplugin
 
@@ -29,7 +30,7 @@ A typical way to use plugins would be to store the plugin names in a configurati
 
 ## Requirements
 
-*ddplugin* requires Ruby 2.1 or higher.
+*ddplugin* requires Ruby 2.3 or higher.
 
 ## Versioning
 
@@ -63,23 +64,27 @@ class DataSource
 end
 ```
 
-To define a plugin, create a class that inherits from the plugin type and sets the identifier:
+To define a plugin, create a class that inherits from the plugin type and sets the identifier, either as a symbol or a string:
 
 ```ruby
 class ERBFilter < Filter
+  # Specify the identifier as a symbol…
   identifier :erb
 end
 
 class HamlFilter < Filter
-  identifier :haml
+  # … or as a string …
+  identifier 'haml'
 end
 
 class FilesystemDataSource < DataSource
-  identifier :filesystem
+  # … or even provide multiple.
+  identifiers :filesystem, :file_system
 end
 
 class PostgresDataSource < DataSource
-  identifier :postgres
+  # … or mix and match (not sure why you would, though)
+  identifier :postgres, 'postgresql'
 end
 ```
 
@@ -89,7 +94,7 @@ To find a plugin of a given type and with a given identifier, call `.named` on t
 Filter.named(:erb)
 # => ERBFilter
 
-Filter.named(:haml)
+Filter.named('haml')
 # => HamlFilter
 
 DataSource.named(:filesystem)
@@ -99,22 +104,50 @@ DataSource.named(:postgres)
 # => PostgresDataSource
 ```
 
+In a real-world situation, the plugin types could be described in the environment:
+
+```
+% cat .env
+DATA_SOURCE_TYPE=postgres
+```
+
+```ruby
+DataSource.named(ENV.fetch('DATA_SOURCE_TYPE'))
+# => PostgresDataSource
+```
+
+… or in a configuration file:
+
+```
+% cat config.yml
+data_source: 'filesystem'
+```
+
+```ruby
+config = YAML.load_file('config.yml')
+DataSource.named(config.fetch('data_source'))
+# => FilesystemDataSource
+```
+
 To get all plugins of a given type, call `.all` on the plugin type:
 
 ```ruby
 Filter.all
-# => [ ERBFilter, HamlFilter ]
+# => [ERBFilter, HamlFilter]
 
 DataSource.all
-# => [ FilesystemDataSource, PostgresDataSource ]
+# => [FilesystemDataSource, PostgresDataSource]
 ```
 
-To get the identifier of a plugin, call `.identifier`:
+To get the identifier of a plugin, call `.identifier`, which returns a symbol:
 
 ```ruby
 Filter.named(:erb).identifier
 # => :erb
 
+Filter.named('haml').identifier
+# => :haml
+
 PostgresDataSource.identifier
 # => :postgres
 ```
@@ -125,8 +158,9 @@ Pull requests and issues are greatly appreciated.
 
 When you submit a pull request, make sure that your change is covered by tests, and that the `README` and [YARD](http://yardoc.org/) source code documentation are still up-to-date.
 
-To run the tests, execute `rake`:
+To run the tests:
 
 ```
-% rake
+% bundle install
+% bundle exec rake
 ```

data/Rakefile

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 require 'rubocop/rake_task'
 
 Rake::TestTask.new do |t|
-  t.libs = %w( lib test )
+  t.libs = %w[lib test]
   t.test_files = FileList['test/**/test_*.rb', 'test/**/*_spec.rb']
 end
 
 RuboCop::RakeTask.new do |task|
-  task.options  = %w(--display-cop-names --format simple)
+  task.options  = %w[--display-cop-names --format simple]
   task.patterns = ['lib/**/*.rb', 'test/**/*.rb']
 end
 
-task :default => [:test, :rubocop]
+task default: %i[test rubocop]

data/ddplugin.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/ddplugin/version'
 
 Gem::Specification.new do |s|
@@ -11,15 +13,15 @@ Gem::Specification.new do |s|
   s.email   = 'denis.defreyne@stoneship.org'
   s.license = 'MIT'
 
-  s.required_ruby_version = '>= 2.1.0'
+  s.required_ruby_version = '~> 2.3'
 
   s.files              = Dir['[A-Z]*'] +
                          Dir['{lib,test}/**/*'] +
-                         [ 'ddplugin.gemspec' ]
-  s.require_paths      = [ 'lib' ]
+                         ['ddplugin.gemspec']
+  s.require_paths      = ['lib']
 
-  s.rdoc_options     = [ '--main', 'README.md' ]
-  s.extra_rdoc_files = [ 'LICENSE', 'README.md', 'NEWS.md' ]
+  s.rdoc_options     = ['--main', 'README.md']
+  s.extra_rdoc_files = ['LICENSE', 'README.md', 'NEWS.md']
 
   s.add_development_dependency('bundler', '~> 1.13')
 end

data/lib/ddplugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ddplugin/version'
 require 'ddplugin/plugin'
 require 'ddplugin/registry'

data/lib/ddplugin/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DDPlugin
   # A module that contains class methods for plugins. It provides functions
   # for setting identifiers and finding plugins. Plugin classes should extend
@@ -7,8 +9,8 @@ module DDPlugin
     #
     #   Sets the identifiers for this class.
     #
-    #   @param [Array<Symbol>] identifiers A list of identifiers to assign to
-    #     this class.
+    #   @param [Array<Symbol, String>] identifiers A list of identifiers to
+    #     assign to this class.
     #
     #   @return [void]
     #
@@ -34,7 +36,8 @@ module DDPlugin
     #
     #   Sets the identifier for this class.
     #
-    #   @param [Symbol] identifier The identifier to assign to this class.
+    #   @param [Symbol, String] identifier The identifier to assign to this
+    #     class.
     #
     #   @return [void]
     #
@@ -54,7 +57,7 @@ module DDPlugin
       DDPlugin::Registry.instance.find_all(self)
     end
 
-    # @param [Symbol] identifier The identifier of the class to find
+    # @param [Symbol, String] identifier The identifier of the class to find
     #
     # @return [Class] The class with the given identifier
     def named(identifier)

data/lib/ddplugin/registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DDPlugin
   # The registry is responsible for keeping track of all loaded plugins.
   class Registry
@@ -25,7 +27,7 @@ module DDPlugin
     #
     # @return [void]
     def register(root_class, klass, *identifiers)
-      identifiers.each do |identifier|
+      identifiers.map(&:to_sym).each do |identifier|
         @classes_to_identifiers[root_class][klass] ||= []
 
         @identifiers_to_classes[root_class][identifier] = klass
@@ -53,6 +55,7 @@ module DDPlugin
     #
     # @return [Class, nil] The class with the given identifier
     def find(root_class, identifier)
+      identifier = identifier.to_sym
       @identifiers_to_classes[root_class] ||= {}
       @identifiers_to_classes[root_class][identifier]
     end

data/lib/ddplugin/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DDPlugin
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.0.2'
 end

data/test/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'coveralls'
 Coveralls.wear!
 

data/test/test_plugin.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'helper'
 
-class DDPlugin::PluginTest < Minitest::Test
+class PluginTest < Minitest::Test
   class IdentifierSample
     extend DDPlugin::Plugin
   end
@@ -28,15 +30,34 @@ class DDPlugin::PluginTest < Minitest::Test
     assert_equal :foo, klass.identifier
   end
 
+  def test_identifier_with_string
+    klass = Class.new(IdentifierSample)
+    assert_nil klass.identifier
+
+    klass.identifier 'asdf'
+    assert_equal :asdf, klass.identifier
+  end
+
   def test_identifiers
     klass = Class.new(IdentifierSample)
     assert_empty klass.identifiers
 
     klass.identifiers :foo1, :foo2
-    assert_equal [:foo1, :foo2], klass.identifiers
+    assert_equal %i[foo1 foo2], klass.identifiers
 
     klass.identifiers :bar1, :bar2
-    assert_equal [:foo1, :foo2, :bar1, :bar2], klass.identifiers
+    assert_equal %i[foo1 foo2 bar1 bar2], klass.identifiers
+  end
+
+  def test_identifiers_with_string
+    klass = Class.new(IdentifierSample)
+    assert_empty klass.identifiers
+
+    klass.identifiers 'foo1', 'foo2'
+    assert_equal %i[foo1 foo2], klass.identifiers
+
+    klass.identifiers 'bar1', 'bar2'
+    assert_equal %i[foo1 foo2 bar1 bar2], klass.identifiers
   end
 
   def test_root
@@ -50,7 +71,7 @@ class DDPlugin::PluginTest < Minitest::Test
     assert_equal subklass, InheritanceSample.named(:sub)
 
     assert_equal :sub, subklass.identifier
-    assert_equal [:sub, :also_sub], subklass.identifiers
+    assert_equal %i[sub also_sub], subklass.identifiers
 
     assert_equal InheritanceSample, superklass.root_class
     assert_equal InheritanceSample, subklass.root_class
@@ -64,6 +85,14 @@ class DDPlugin::PluginTest < Minitest::Test
     assert_equal klass, NamedSample.named(:named_test)
   end
 
+  def test_named_with_string
+    klass = Class.new(NamedSample)
+    klass.identifier :named_test
+
+    assert_nil NamedSample.named('unknown')
+    assert_equal klass, NamedSample.named('named_test')
+  end
+
   def test_all
     klass1 = Class.new(AllSample)
     klass1.identifier :one

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddplugin
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-28 00:00:00.000000000 Z
+date: 2018-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,9 +58,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Plugins for Ruby apps