logcabin 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b2fb63c6e1a668540feb08448fe3cde4543a2ba
-  data.tar.gz: c1d2b56bd6842d96465bc438fde829e563ae1ea8
+  metadata.gz: 78dfabf180182de5dd6875e7f2243daf68cbf8b3
+  data.tar.gz: f469c06d8306c37972d634d8e51de37858aca3d0
 SHA512:
-  metadata.gz: 4b13f3472d15ce311aa057f0021720507ab9d6f2c5612a35cbd1a2c02836d9f14cace38b19d019cbec450fb533117e500d06a759ff522025be668d3361fc4d1f
-  data.tar.gz: 3a608885cd6c708fa5c9aead8eeb613559dbe0c7f0116bdf375cc38f1fad5233a0822b92a56c2d775be64070606370107460ab2d37c73badeb2e0902f9c5aa4c
+  metadata.gz: 46cc8adc143a1323e5f89308fed8e791d2f808030df61d28bf899798ef406965191884e60799fedb895e91bf60aba394b7ff668232797c0ca8e59338c177d5b4
+  data.tar.gz: 526caafd0a0d0ad491a852a0301af625fbd91d3d016e08586fcefa9f73aa6ae997ba2a538229dadf2791fd92c7703faeaa82d7952eecc2b0e7f3c6d102cea3d7

data/README.md

@@ -12,6 +12,43 @@ Support dynamic loading of modules at runtime
 
 ## Usage
 
+Create a collection of modules with `collection = LogCabin.new(load_path: '/path/to/modules')`.
+
+You can also pass in an array of paths as load_path.
+
+You can then load a module and return it with `collection.find(:module_name)` (you can use a string or symbol for the name).
+
+Modules should be children of LogCabin::Modules, like so:
+
+```
+module LogCabin
+  module Modules
+    module MyDynamicModule
+      def useful_function
+        puts "Hello world"
+      end
+    end
+  end
+end
+```
+
+This should go in the file "my_dynamic_module.rb", and would be loaded with `collection.find(:my_dynamic_module)`. This naming convention is required for modules, where an underscore in the filename matches with a capitalized letter in the module definition.
+
+As an example usage, you can use LogCabin to dynamically extend instances of a class:
+
+```
+COLLECTION = LogCabin.new(load_path: '/path/to/my/dynamic/module')
+
+class BoringClass
+  def initialize(cool_module)
+    extend COLLECTION.find(cool_module)
+  end
+end
+
+x = BoringClass.new('my_dynamic_module')
+x.useful_function >> puts "Hello World"
+```
+
 ## Installation
 
     gem install logcabin

data/lib/logcabin/collection.rb

@@ -18,6 +18,8 @@ module LogCabin
       require file
       class_name = parse_class_name(name)
       @modules[name] = LogCabin::Modules.const_get(class_name)
+    rescue LoadError
+      raise("Error while loading #{name}")
     end
 
     private
@@ -37,7 +39,7 @@ module LogCabin
         file_path = File.join(dir, "#{name}.rb")
         return file_path if File.exist? file_path
       end
-      fail("Module #{method} not found")
+      fail("Module #{name} not found")
     end
   end
 end

data/logcabin.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'logcabin'
-  s.version     = '0.0.1'
+  s.version     = '0.0.3'
   s.date        = Time.now.strftime('%Y-%m-%d')
 
   s.summary     = 'Support dynamic loading of modules at runtime'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logcabin
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop