adapter-registry 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb5d6f841887d5b267b73b91cf09784d71037c6b
+  data.tar.gz: 26a72a8a54287a5a81bdf5a61277e70db25e0822
+SHA512:
+  metadata.gz: 8ce7cdf9e0634da117e95f31249f42a0eff85fef8975d4925f17797326fe7e5308ba1efa7dd9745680f2a181437c546b9120ef843ea16d53cf53c344d9d1000d
+  data.tar.gz: b2a823568648950a46cbcd6239ad99d180bd21e18d4fbba3d590833e8cc1924dccf743c2b9a4f76543ad316633a9a89934c1ea8d3f7e8479cad38362f8940858

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2013 RadarServices Smart IT-Security <gems@radarservices.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Adapter Registry
+
+provides a generic registry for traits and classes, where a class adapter can
+be stored and recalled in the correct context.
+
+## Installation
+
+```
+$ gem install adapter-registry
+```
+
+```ruby
+require 'adapter-registry'
+```
+
+or use ``gem 'adapter-registry'`` in your Gemfile when using bundler.
+
+##Examples
+
+### Implementing Adapters 
+
+```ruby
+require 'adapter-registry'
+
+class SomeClass
+end
+
+class SomeOtherClass < SomeClass
+end
+
+class SomeAdapter
+    
+  include AdapterRegistry::Implementation
+
+  implements :something # trait, defines the lookup context
+  adapts_instance SomeClass # stores the trait/class combination in the registry
+
+  #...
+
+end
+
+class SomeClassAdapter
+    
+  include AdapterRegistry::Implementation
+
+  implements :something
+  adapts_class SomeClass # stores the trait/class or ancestor combination in the registry
+
+  #...
+
+end
+```
+
+### Initialization
+
+```ruby
+require 'adapter-registry'
+
+AdapterRegistry.load_directories(['./lib/some_adapters', './lib/some_other_adapters'])
+```
+
+The ``load`` section should be used in an initializer when using Rails. ``adapter-registry`` uses ``require_dependency`` in favour of ``require`` when included in a Rails context.
+
+### Usage
+
+```ruby
+obj = SomeClass.new
+adapter = AdapterRegistry.get(:something, obj)
+
+class_adapter = AdapterRegistry.get(:something, SomeOtherClass)
+
+some_other_instance = class_adapter.new # uses the same adapter because SomeClass is an ancestor
+```

data/adapter-registry.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), 'lib', 'adapter-registry', 'version')
+
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name = "adapter-registry"
+  s.version = AdapterRegistry::VERSION
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andreas Kopecky <andreas.kopecky@radarservices.com>", "Anton Bangratz <anton.bangratz@radarservices.com>", "Martin Natano <martin.natano@radarservices.com"]
+  s.date = Date.today.strftime
+  s.description = "Simple adapter registry"
+  s.email = "gems [a] radarservices [d] com"
+  s.files            = `git ls-files`.split("\n").reject { |file| file == '.gitignore' }
+  s.extra_rdoc_files = %w[LICENSE README.md]
+
+  s.homepage = "http://github.com/rs-dev/adapter-registry"
+  s.require_paths = ["lib"]
+  # s.rubygems_version = "1.8.24"
+  s.summary = "Simple adapter registry for enhancing classes via adapters"
+  s.license = "ISC"
+end

data/lib/adapter-registry/implementation.rb

@@ -0,0 +1,45 @@
+module AdapterRegistry
+
+  module Implementation
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      attr_accessor :traits
+      def implements(*traits)
+        self.traits = traits
+      end
+
+      def adapts_instance(*klasses)
+        adapts do |context|
+          klasses.any? { |klass| context.is_a?(klass) }
+        end
+      end
+
+      def adapts_class(*klasses)
+        adapts do |context|
+          context.is_a?(Class) && klass_is_a?(context, *klasses)
+        end
+      end
+
+      def adapts(&block)
+        self.traits.each do |trait|
+          Adapter.register(trait, self, &block)
+        end if (self.traits && block)
+      end
+
+      def instance_for(context)
+        self.new(context)
+      end
+
+      def klass_is_a?(klass, *klasses)
+        (klasses.map(&:to_s) & klass.ancestors.map(&:name)).any?
+      end
+
+    end
+
+  end
+
+end

data/lib/adapter-registry/registry.rb

@@ -0,0 +1,27 @@
+module AdapterRegistry
+
+  class Registry < Hash
+    def get_adapter(trait, context)
+      if trait_registry = self[trait]
+        trait_registry.select do |entry|
+          entry[:for].call(context)
+        end.first.try(:[], :adapter)
+      end
+    end
+
+    def get(trait, context)
+      if adapter = get_adapter(trait, context)
+        adapter.instance_for(context)
+      end
+    end
+
+    def set(trait, adapter, &block)
+      self[trait] ||= Set.new
+      self[trait] << {
+        adapter: adapter,
+        for: block,
+      }
+    end
+  end
+
+end

data/lib/adapter-registry/version.rb

@@ -0,0 +1,5 @@
+module AdapterRegistry
+
+  VERSION = '0.0.1'
+
+end

data/lib/adapter-registry.rb

@@ -0,0 +1,34 @@
+require 'adapter-registry/registry'
+require 'adapter-registry/implementation'
+
+module AdapterRegistry
+
+  def self.registry
+    @@registry ||= Registry.new
+  end
+
+  def self.get(trait, context)
+    registry.get(trait, context)
+  end
+
+  def self.register(trait, adapter, &block)
+    registry.set(trait, adapter, &block)
+  end
+
+  def self.load_directory(path)
+    Dir[path].each do |file|
+      if defined?(Rails)
+        require_dependency(file)
+      else
+        require(file)
+      end
+    end
+  end
+
+  def self.load_directories(paths)
+    paths.each do |path|
+      self.load_directory(path)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: adapter-registry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andreas Kopecky <andreas.kopecky@radarservices.com>
+- Anton Bangratz <anton.bangratz@radarservices.com>
+- Martin Natano <martin.natano@radarservices.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-10 00:00:00.000000000 Z
+dependencies: []
+description: Simple adapter registry
+email: gems [a] radarservices [d] com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- adapter-registry.gemspec
+- lib/adapter-registry.rb
+- lib/adapter-registry/implementation.rb
+- lib/adapter-registry/registry.rb
+- lib/adapter-registry/version.rb
+homepage: http://github.com/rs-dev/adapter-registry
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple adapter registry for enhancing classes via adapters
+test_files: []