registrable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c29679b74ce08b4f0ec4d4209b8237640d41d4fd
-  data.tar.gz: 76d0958c355a06fe83b375441a9fe775b96ec172
+  metadata.gz: db1c9da7835bba2bfb17418c3b5847a28164a7e7
+  data.tar.gz: e6b10644ff0365a2093f586ee84f219d321ad1ea
 SHA512:
-  metadata.gz: 8680da778b1c30dcc46387b386294970b42121ffcc0d5b9bfdd876883b1a99efc2c359fd26eedbf2468bffb4184eee7ab334b8e86394e5b269b6503af218647c
-  data.tar.gz: 19e9d6df57708f87593a60cce771f75f60b4686246194a9993a812e51cb8396c0c1acbe8ae7c4c90175bb30712201e8840ed5e0af62eb144174f1801aa66f88b
+  metadata.gz: e36aca6480903518c0e190a6cca6094aa4dfe42f46647d9a1ce74f5670ffdfeb6d247e4933c5de07c05b6120f1099fe36b6d442126e3bebb987058e071cd4176
+  data.tar.gz: 2576bfb84a0d318b701a09e8e5512bb1a2ea7ed9305e6104bf3eeec0044f7797b8c01aae89dd80e6dd36153f3503e5aa156abbf15e42433ef37cb115587240a8

data/Guardfile

@@ -18,7 +18,10 @@ guard :rubocop, all_on_start: false, cli: '--config .rubocop.yml --auto-correct
 end
 
 guard :yard, server: false do
-  watch(/^(README|LICENSE|CODE_OF_CONDUCT)/)
   watch(%r{lib\/.+\.rb})
   watch(/.yardopts/)
 end
+
+guard :shell do
+  watch(%r{templates/(.+)\.erb}) { |match| `rake #{match[1]}` }
+end

data/README.md

@@ -6,14 +6,51 @@
 
 ### RubyGems: `gem install registrable`
 
-## Usage
+## Examples
+
+### Plugin
+
+```rb
+require 'registrable'
+
+module Plugin
+
+  extend Registrable
+
+  class Base
+    def self.inherited(subclass)
+      identifier = subclass.to_s
+        .split('::').last
+        .gsub(/([a-z0-9])([A-Z])/, '\1_\2')
+        .downcase.to_sym
+
+      Plugin.register(identifier, subclass)
+    end
+  end
+
+end
+
+class MyPlugin < Plugin::Base; end
+class AnotherPlugin < Plugin::Base; end
+```
+
+```rb
+p Plugin.registry.keys                     # => [:my_plugin, :another_plugin]
+p Plugin[:my_plugin] == MyPlugin           # => true
+p Plugin[:another_plugin] == AnotherPlugin # => true
+```
+
+### Role
 
 ```rb
 require 'registrable'
 
 class Role
+
+  extend Registrable
+
   def initialize(read, modify)
-    @read, @modify = create, modify
+    @read, @modify = read, modify
   end
 
   def read?
@@ -23,10 +60,10 @@ class Role
   def modify?
     @modify
   end
+
 end
 
 class User
-  extend Registrable
 
   def initialize(role)
     self.role = role
@@ -35,15 +72,16 @@ class User
   attr_reader :role
 
   def role=(role)
-    role = Role.registry[identifier] || Role.registry[:other] unless role.is_a?(Role)
+    role = Role.registry[role] || Role.registry[:other] unless role.is_a?(Role)
 
     @role = role
   end
+
 end
 
-Role.register(:other, false, false)
-Role.register(:user,  true,  false)
-Role.register(:admin, true,  true)
+Role.register(:other, Role.new(false, false))
+Role.register(:user,  Role.new(true,  false))
+Role.register(:admin, Role.new(true,  true))
 ```
 
 ```rb
@@ -79,7 +117,7 @@ p admin.role.modifiable? # => true
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/RyanScottLewis/striker.
+Bug reports and pull requests are welcome on GitHub at https://github.com/RyanScottLewis/registrable.
 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 

data/Rakefile

@@ -14,9 +14,8 @@ RuboCop::RakeTask.new(:lint)
 YARD::Rake::YardocTask.new(:docs)
 
 TEMPLATES_PATH = Pathname.new('templates')
-TEMPLATE_PATHS = FileList[TEMPLATES_PATH.join('**', '*').to_s]
-README_INPUT   = TEMPLATES_PATH.join('README.md.erb')
-README_OUTPUT  = Pathname.new('README.md')
+TEMPLATE_PATHS = Pathname.glob(TEMPLATES_PATH.join('**', '*').to_s)
+template_output_paths = []
 
 class RenderContext
 
@@ -25,7 +24,8 @@ class RenderContext
   end
 
   def initialize(path)
-    @erb = ERB.new(path.read)
+    @path = path
+    @erb  = ERB.new(@path.read)
   end
 
   def file(path)
@@ -35,13 +35,23 @@ class RenderContext
   def render(path)
     contents = @erb.result(binding)
 
-    README_OUTPUT.open('w+') { |file| file.write(contents) }
+    path.open('w+') { |file| file.write(contents) }
+
+    puts "Rendered #{@path} to #{path}"
   end
 
 end
 
-file README_OUTPUT => [README_INPUT, TEMPLATE_PATHS] do
-  RenderContext.render(README_INPUT, README_OUTPUT)
+TEMPLATE_PATHS.each do |input_path|
+  output_path = input_path.sub('templates/', '').sub_ext('')
+  template_output_paths << output_path.to_s
+
+  file output_path => input_path do
+    RenderContext.render(input_path, output_path)
+  end
 end
 
-task default: [:spec, 'lint:auto_correct', :docs, README_OUTPUT]
+desc 'Render templates'
+task templates: template_output_paths
+
+task default: [:spec, 'lint:auto_correct', :templates, :docs]

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/examples/plugin.rb

@@ -1,21 +1,21 @@
 require 'registrable'
 
-class Plugin
+module Plugin
 
   extend Registrable
 
-  def initialize(name)
-    @name = name
-  end
+  class Base
+    def self.inherited(subclass)
+      identifier = subclass.to_s
+        .split('::').last
+        .gsub(/([a-z0-9])([A-Z])/, '\1_\2')
+        .downcase.to_sym
 
-  attr_reader :name
+      Plugin.register(identifier, subclass)
+    end
+  end
 
 end
 
-unless ENV['RSPEC'] # Not loading this file from tests
-  p Plugin.register(:my_plugin, 'My Plugin') # => #<Plugin:0x0001 @name="My Plugin">
-  p Plugin.registered?(:my_plugin)           # => true
-  p Plugin.registry[:my_plugin]              # => #<Plugin:0x0001 @name="My Plugin">
-  p Plugin.unregister(:my_plugin)            # => #<Plugin:0x0001 @name="My Plugin">
-  p Plugin.registered?(:my_plugin)           # => false
-end
+class MyPlugin < Plugin::Base; end
+class AnotherPlugin < Plugin::Base; end

data/examples/role.rb

@@ -1,22 +1,25 @@
 require 'registrable'
 
 class Role
+
   extend Registrable
 
-  def initialize(readable, modifiable)
-    @readable, @modifiable = readable, modifiable
+  def initialize(read, modify)
+    @read, @modify = read, modify
   end
 
   def readable?
-    @readable
+    @read
   end
 
   def modifiable?
-    @modifiable
+    @modify
   end
+
 end
 
 class User
+
   def initialize(role)
     self.role = role
   end
@@ -28,8 +31,9 @@ class User
 
     @role = role
   end
+
 end
 
-Role.register(:other, false, false)
-Role.register(:user,  true,  false)
-Role.register(:admin, true,  true)
+Role.register(:other, Role.new(false, false))
+Role.register(:user,  Role.new(true,  false))
+Role.register(:admin, Role.new(true,  true))

data/lib/registrable.rb

@@ -1,46 +1,44 @@
 require 'registrable/version'
 
-# Allow a class to hold a registry of instances
+# Allow a class to hold a registry, which is a frozen Hash which can only be modified using the #register and
+# #unregister methods
 module Registrable
 
-  # All registered instances
+  # All registered objects
   #
   # @return [Hash]
   def registry
     @registry ||= {}.freeze
   end
 
-  # Register an instance
+  # Register an object
   #
   # @param [Object] identifier
-  # @param [Array] arguments The arguments to pass to #initialize
-  # @param [Proc] block The block to pass to #initialize
-  # @return [Object] The instance
-  def register(identifier, *arguments, &block)
+  # @param [Class] registrant The object to register
+  # @return [Class] The registrant
+  def register(identifier, registrant)
     @registry = @registry ? registry.dup : {}
 
-    instance = new(*arguments, &block)
-
-    @registry[identifier] = instance
+    @registry[identifier] = registrant
     @registry.freeze
 
-    instance
+    registrant
   end
 
-  # Unregister an instance
+  # Unregister an object
   #
   # @param [Object] identifier
-  # @return [Object] The instance
+  # @return [Object] The registrant
   def unregister(identifier)
     @registry = @registry ? registry.dup : {}
 
-    instance = @registry.delete(identifier)
+    registrant = @registry.delete(identifier)
     @registry.freeze
 
-    instance
+    registrant
   end
 
-  # Get whether an instance is registered
+  # Get whether an object is registered
   #
   # @param [Object] identifier
   # @return [Boolean]

data/registrable.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Ryan Scott Lewis']
   spec.email         = ['ryanscottlewis@gmail.com']
 
-  spec.summary       = "Allows a class to hold a registry of it's instances"
-  spec.description   = "Extend in a class to allow it to hold a registry of it's instances"
+  spec.summary       = 'Allow a class to hold a registry'
+  spec.description   = 'Allow a class to hold a registry, which is a frozen Hash which can only be modified using the #register and #unregister methods'
   spec.homepage      = 'https://github.com/RyanScottLewis/registrable'
   spec.license       = 'MIT'
 
@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'fuubar', '~> 2.2'
   spec.add_development_dependency 'guard-rubocop', '~> 1.2'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'guard-shell', '~> 0.7.1'
   spec.add_development_dependency 'guard-yard', '~> 2.2'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/templates/README.md.erb

@@ -6,15 +6,41 @@
 
 ### RubyGems: `gem install registrable`
 
-## Usage
+## Examples
+
+### Plugin
+
+```rb
+<%= file('examples/plugin.rb') %>
+```
+
+```rb
+p Plugin.registry.keys                     # => [:my_plugin, :another_plugin]
+p Plugin[:my_plugin] == MyPlugin           # => true
+p Plugin[:another_plugin] == AnotherPlugin # => true
+```
+
+### Role
 
 ```rb
 <%= file('examples/role.rb') %>
 ```
 
 ```rb
+other = User.new(:other)
+
+p other.role.readable?   # => true
+p other.role.modifiable? # => true
+
+user = User.new(:user)
+
+p admin.role.readable?   # => true
+p admin.role.modifiable? # => false
+
 admin = User.new(:admin)
-p admin.role.modify? unless ENV["RSPEC"] # => true
+
+p admin.role.readable?   # => true
+p admin.role.modifiable? # => true
 ```
 
 ## Development
@@ -33,7 +59,7 @@ p admin.role.modify? unless ENV["RSPEC"] # => true
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/RyanScottLewis/striker.
+Bug reports and pull requests are welcome on GitHub at https://github.com/RyanScottLewis/registrable.
 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: registrable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryan Scott Lewis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: guard-shell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: guard-yard
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +164,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Extend in a class to allow it to hold a registry of it's instances
+description: 'Allow a class to hold a registry, which is a frozen Hash which can only
+  be modified using the #register and #unregister methods'
 email:
 - ryanscottlewis@gmail.com
 executables: []
@@ -202,5 +217,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Allows a class to hold a registry of it's instances
+summary: Allow a class to hold a registry
 test_files: []