requirium 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7dd79837d4d7b07b5b43a6e4bdb2b0d9282d3b98
+  data.tar.gz: 13ddcef5f0246ccbfcef8ded2a482d979fc7aedb
+SHA512:
+  metadata.gz: 09e1b4dd928cdb25678789a5297e2294433a92a5d2a8e4f387cac139a6c9f8f5edca4e6039f24f505f62847f4a70960c885a392cbaf458724a8bf0602b0c6a4c
+  data.tar.gz: 87c1368019c3383bf822180a25054d93bccc5308095b20ddd4565cb096c151b6449964d1a41d7f9555f89216f28f55b7723e054123e045e2dd89bbf5ad9ab5e3

data/README.md

@@ -0,0 +1,67 @@
+# requirium
+
+An autoload alternative for Ruby.
+
+* https://github.com/SilverPhoenix99/requirium
+
+## INSTALL:
+
+    gem install requirium
+
+## DESCRIPTION:
+
+Requirium offers advanced loading mechanisms, similar to Ruby's autoload and require.
+
+`autoload` calls Ruby's `load`, while `autorequire` calls Ruby's `require` as expected, so they both search for files as Ruby does. But they do more than that, such as loading multiple files for a single constant, and batching multiple constants with a single call.
+
+To use, simply extend the Requirium module and the loading methods will be available:
+
+```ruby
+module M
+  extend Requirium
+
+  autoload :A # loads 'a' (camel case constant to snake case file name)
+  autoload :B, 'b', 'b1', 'dir/b2' # loads the 3 files
+  autoload A: nil, B: ['b', 'b1', 'dir/b2'] # joins the 2 previous options in a single call
+
+  autorequire :A # requires 'a'
+  autorequire :B, 'b', 'b1', 'dir/b2' # requires the 3 files
+  autorequire A: nil, B: ['b', 'b1', 'dir/b2'] # joins the 2 previous options in a single call
+  
+  # theses next examples are similar to the previous ones,
+  # but they load relative to the current file
+  
+  autoload_relative :X
+  autoload_relative :Y, 'y', 'y1', 'dir/y2'
+  autoload_relative X: nil, Y: ['y', 'y1', 'dir/y2']
+  
+  autorequire_relative :X
+  autorequire_relative :Y, 'y', 'y1', 'dir/y2'
+  autorequire_relative X: nil, Y: ['y', 'y1', 'dir/y2']
+end
+```
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright © 2014 Pedro Pinto
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/requirium.rb

@@ -0,0 +1,135 @@
+require 'thread'
+require 'pathname'
+require 'facets/string/snakecase'
+
+#Automatically calls <code>Kernel#load</code> or <code>Kernel#require</code> on first use.
+#Example usage:
+#
+#    module M
+#      extend Requirium
+#
+#      autoload :A
+#      autoload :B, 'b', 'b1', 'b2'
+#      autoload A: nil, B: ['b', 'b1', 'b2']
+#      autoload_relative :X
+#      autoload_relative :Y, 'y', 'y1', 'y2'
+#      autoload_relative X: nil, Y: ['y', 'y1', 'y2']
+#
+#      autorequire :A
+#      autorequire :B, 'b', 'b1', 'b2'
+#      autorequire A: nil, B: ['b', 'b1', 'b2']
+#      autorequire_relative :X
+#      autorequire_relative :Y, 'y', 'y1', 'y2'
+#      autorequire_relative X: nil, Y: ['y', 'y1', 'y2']
+#    end
+module Requirium
+  VERSION = '0.0.1'.freeze
+
+  EXTENSIONS = "{#{Gem.suffixes.join(',')}}".freeze
+
+  class CondVar < ConditionVariable
+    def mutex
+      @mutex ||= Mutex.new
+    end
+
+    def ready!
+      @ready = true
+      mutex.synchronize { signal }
+      nil
+    end
+
+    def wait_ready
+      mutex.synchronize { until @ready; wait(mutex) end }
+      nil
+    end
+  end
+
+  @queue = Queue.new
+  @loader_thread = Thread.new do
+      loop do
+        mod, sym, cond = @queue.pop
+        begin
+          mod.send(:internal_load, sym)
+        rescue ScriptError => e
+          $stderr.puts e
+        rescue => e
+          $stderr.puts e
+        end
+        cond.ready!
+      end
+  end
+
+  class << self
+    attr_reader :loader_thread, :queue
+  end
+
+  def autoload(*args) #TODO sync const_defined? ?
+    common_auto :load, args
+  end
+
+  def autoload_relative(*args) #TODO sync const_defined? ?
+    common_auto :load, args, File.dirname(caller(1, 1)[0][/^(.+):\d+:in `.+'$/, 1])
+  end
+
+  def autorequire(*args) #TODO sync const_defined? ?
+    common_auto :require, args
+  end
+
+  def autorequire_relative(*args) #TODO sync const_defined? ?
+    common_auto :require, args, File.dirname(caller(1, 1)[0][/^(.+):\d+:in `.+'$/, 1])
+  end
+
+  #def const_defined?(*args)
+  #  Requirium.synchronize { super }
+  #end
+
+  def const_missing(sym)
+    if Thread.current == Requirium.loader_thread
+      internal_load(sym)
+    else
+      cond = CondVar.new
+      Requirium.queue.push [self, sym, cond]
+      cond.wait_ready
+    end
+    const_defined?(sym) ? const_get(sym) : super
+  end
+
+  private
+
+  def common_auto(method, args, dirname = nil)
+    if args.length == 1 && args.first.is_a?(Hash)
+      args.each { |sym, paths| add_load_item method, sym, paths, dirname }
+      return
+    end
+
+    sym, paths = args
+    add_load_item method, sym, paths, dirname
+  end
+
+  def add_load_item(method, sym, paths, dirname = nil)
+    return if const_defined?(sym)
+    paths = [*paths]
+    #puts "auto#{method}#{dirname ? '_relative' : ''} #{sym.inspect}, #{paths.map(&:inspect).join(', ')}"
+    load_list { |l| l[sym.to_s] = [method, paths, dirname] }
+    nil
+  end
+
+  def internal_load(sym)
+    return if const_defined?(sym)
+    method, paths, dirname = load_list { |l| l[sym.to_s] }
+    return unless method
+    paths = [sym.to_s.snakecase] if paths.empty?
+    paths = paths.map { |path| (Pathname(dirname) + path).to_s } if dirname
+    paths.each do |filename|
+      #puts "#{method} #{sym.inspect}, #{filename.inspect}"
+      raise NoMethodError, "invalid method type: #{method.inspect}" unless [:load, :require].include?(method)
+      send(method, filename)
+    end
+    load_list { |l| l.delete(sym.to_s) } if const_defined?(sym)
+    nil
+  end
+
+  def load_list
+    (@mutex ||= Mutex.new).synchronize { yield(@load_list ||= {}) }
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: requirium
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- SilverPhoenix99
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: An autoload alternative
+email:
+- silver.phoenix99@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/requirium.rb
+homepage: https://github.com/SilverPhoenix99/requirium
+licenses:
+- MIT
+metadata: {}
+post_install_message: |
+  +----------------------------------------------------------------------------+
+    Thank you for choosing Requirium.
+
+    ==========================================================================
+    If you find any bugs, please report them on
+      https://github.com/SilverPhoenix99/requirium/issues
+
+  +----------------------------------------------------------------------------+
+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.2.2
+signing_key: 
+specification_version: 4
+summary: An autoload alternative
+test_files: []
+has_rdoc: