needs_resources 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013, David McCullars
+
+MIT License
+
+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/README.md

@@ -0,0 +1,4 @@
+needs_resources
+===============
+
+A lightweight Inversion of Control provider of resources for an application

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/needs_resources.rb

@@ -0,0 +1,35 @@
+require 'set'
+require 'active_support'
+require 'active_support/core_ext'
+
+module NeedsResources
+
+  def needs_resources(*names)
+    container = is_a?(ResourceContainer) ? self : TopLevelResources.instance
+    names.flatten.each do |name|
+      if is_a? Class
+        define_method name, lambda { container[name] }
+      end
+      define_singleton_method name, lambda { container[name] }
+      container.resources_needed << name.to_sym
+    end
+  end
+
+  alias :needs_resource :needs_resources
+
+  def self.ensure_resources
+    if (missing = missing_resources).present?
+      # TODO: maybe prompt user if missing?
+      raise MissingResourceError.new(*missing)
+    end
+  end
+
+  def self.missing_resources
+    TopLevelResources.instance.missing_resources
+  end
+
+end
+
+Dir[File.expand_path('../needs_resources/**/*.rb', __FILE__)].sort.each do |f|
+  require f
+end

data/lib/needs_resources/invalid_or_corrupted_resources_error.rb

@@ -0,0 +1,9 @@
+module NeedsResources
+  class InvalidOrCorruptedResourcesError < StandardError
+
+    def initialize
+      super "Invalid or corrupted resources config file"
+    end
+
+  end
+end

data/lib/needs_resources/invalid_resource_alias_error.rb

@@ -0,0 +1,9 @@
+module NeedsResources
+  class InvalidResourceAliasError < StandardError
+
+    def initialize(name)
+      super "Invalid resource alias in config file: #{name.inspect}"
+    end
+
+  end
+end

data/lib/needs_resources/invalid_resource_key_error.rb

@@ -0,0 +1,9 @@
+module NeedsResources
+  class InvalidResourceKeyError < StandardError
+
+    def initialize(name)
+      super "Invalid resource key in config file: #{name.inspect}"
+    end
+
+  end
+end

data/lib/needs_resources/invalid_resource_value_error.rb

@@ -0,0 +1,9 @@
+module NeedsResources
+  class InvalidResourceValueError < StandardError
+
+    def initialize(name, value)
+      super "Invalid resource value in config file for #{name.inspect}: #{value.inspect}"
+    end
+
+  end
+end

data/lib/needs_resources/missing_resource_error.rb

@@ -0,0 +1,13 @@
+module NeedsResources
+  class MissingResourceError < StandardError
+
+    def initialize(*names)
+      if names.size == 1
+        super "The following resources is missing: #{names.first}."
+      else
+        super "The following resources are missing: #{names.to_sentence}."
+      end
+    end
+
+  end
+end

data/lib/needs_resources/nested_resource_type.rb

@@ -0,0 +1,13 @@
+module NeedsResources
+  module NestedResourceType
+
+    def self.included(base)
+      base.send :include, ResourceType
+      base.send :include, ResourceContainer
+      base.send :include, NeedsResources
+
+      base.attr :resources, :default => {}
+    end
+
+  end
+end

data/lib/needs_resources/required_attribute_error.rb

@@ -0,0 +1,9 @@
+module NeedsResources
+  class RequiredAttributeError < StandardError
+
+    def initialize(clazz, name)
+      super "Missing resource in config file:  #{clazz} (in #{name})"
+    end
+
+  end
+end

data/lib/needs_resources/resource_container.rb

@@ -0,0 +1,42 @@
+module NeedsResources
+  module ResourceContainer
+
+    def [](name)
+      resources[name] or raise MissingResourceError.new(child_resource_name name)
+    end
+
+    def child_resource_name(child_name)
+      if respond_to?(:name)
+        "#{self.name}.#{child_name}"
+      else
+        child_name.to_s
+      end
+    end
+
+    def resources
+      @resources ||= {}.with_indifferent_access
+    end
+
+    def resources_needed
+      @resources_needed ||= Set.new
+    end
+
+    def missing_resources
+      __missing_resources__(missing = {})
+      missing.map do |k, v|
+        k.child_resource_name(v)
+      end.sort
+    end
+
+    def __missing_resources__(missing)
+      resources_needed.each do |name|
+        if !resources[name]
+          missing[self] = name
+        elsif resources[name].is_a? ResourceContainer
+          resources[name].__missing_resources__(missing)
+        end
+      end
+    end
+
+  end
+end

data/lib/needs_resources/resource_type.rb

@@ -0,0 +1,42 @@
+module NeedsResources
+  module ResourceType
+
+    def self.included(base)
+      children[base.name.demodulize.underscore] = base
+      base.instance_eval do
+        def attr(*names)
+          options = names.last.is_a?(Hash) ? names.pop : {}
+          names.flatten.each do |n|
+            attributes[n] = options.with_indifferent_access
+            attr_reader n
+          end
+        end
+
+        def attributes
+          @attributes ||= {}.with_indifferent_access
+        end
+      end
+      base.attr :name, :required => true
+    end
+
+    def self.children
+      @children ||= {}
+    end
+
+    def initialize(args={})
+      args = args.with_indifferent_access
+      self.class.attributes.each do |name, options|
+        value = args.delete(name) || options[:default]
+        if options[:required] && value.nil?
+          raise RequiredAttributeError.new(self, name)
+        end
+        value = value.with_indifferent_access if value.is_a? Hash
+        instance_variable_set "@#{name}", value
+      end
+      args.each do |k, v|
+        warn "Invalid initializer argument (#{k.inspect}) for class #{self}"
+      end
+    end
+
+  end
+end

data/lib/needs_resources/top_level_resources.rb

@@ -0,0 +1,85 @@
+require 'singleton'
+require 'yaml'
+
+module NeedsResources
+  class TopLevelResources
+
+    include Singleton
+    include ResourceContainer
+
+    private
+
+    def resources
+      @resources ||= parse(resource_config_file)
+    end
+
+    def resource_config_file
+      Dir[ENV['RESOURCES'].to_s, File.expand_path('~/.resources'), '.resources'].first
+    end
+
+    def parse(file)
+      resources = {}.with_indifferent_access
+      return resources unless File.exist? file
+
+      yaml = YAML.load_file(file)
+      raise InvalidOrCorruptedResources unless yaml.is_a? Hash
+
+      yaml.each do |name, value|
+        prefix, type = parse_resource_name(name)
+        resources[name] = parse_resource_value(name, type, value)
+
+        # Make sure both default_xyz and xyz are aliases
+        if prefix == 'default_'
+          resources[type] ||= name.to_sym
+        elsif prefix.nil?
+          resources[type] ||= "default_#{type}".to_sym
+        end
+      end
+
+      # Copy symbol aliases
+      resources.each do |name, value|
+        resources[name] = dereference_alias(resources, name, value) or raise InvalidResourceAliasError.new(value)
+      end
+
+      resources
+    end
+
+    def top_level_names
+      ResourceType.children.keys
+    end
+
+    def parse_resource_name(name)
+      if m = /^(.*_)?(#{top_level_names * '|'})$/.match(name)
+        m[1..2]
+      else
+        raise InvalidResourceKeyError.new(name)
+      end
+    end
+
+    def parse_resource_value(name, type, value)
+      case value
+      when Symbol
+        value
+      when Hash
+        ResourceType.children[type].new(value.merge :name => name)
+      else
+        raise InvalidResourceValueError.new(name, value)
+      end
+    end
+
+    def dereference_alias(hash, name, value)
+      considered = Set.new
+      while value.is_a?(Symbol) and !considered.include?(value)
+        considered << name
+        name = value
+        value = hash[value]
+      end
+      value
+    end
+
+    def to_s
+      "Top Level Resources"
+    end
+
+  end
+end

data/lib/needs_resources/version.rb

@@ -0,0 +1,3 @@
+module NeedsResources
+  VERSION = '0.1.0'
+end

data/needs_resources.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/needs_resources/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors = ["David McCullars"]
+  gem.email = ["david.mccullars@gmail.com"]
+  gem.description = %q{Ruby gem to provide lightweight inversion of control type resources for an application}
+  gem.summary = %q{Ruby gem to provide lightweight inversion of control type resources for an application}
+  gem.homepage = ""
+
+  gem.files = `git ls-files`.split($\)
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name = "needs_resources"
+  gem.require_paths = ["lib"]
+  gem.version = NeedsResources::VERSION
+
+  gem.add_dependency('active_support', '> 2.0')
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: needs_resources
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- David McCullars
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Ruby gem to provide lightweight inversion of control type resources for
+  an application
+email:
+- david.mccullars@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/needs_resources.rb
+- lib/needs_resources/invalid_or_corrupted_resources_error.rb
+- lib/needs_resources/invalid_resource_alias_error.rb
+- lib/needs_resources/invalid_resource_key_error.rb
+- lib/needs_resources/invalid_resource_value_error.rb
+- lib/needs_resources/missing_resource_error.rb
+- lib/needs_resources/nested_resource_type.rb
+- lib/needs_resources/required_attribute_error.rb
+- lib/needs_resources/resource_container.rb
+- lib/needs_resources/resource_type.rb
+- lib/needs_resources/top_level_resources.rb
+- lib/needs_resources/version.rb
+- needs_resources.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby gem to provide lightweight inversion of control type resources for an
+  application
+test_files: []