jewel 0.0.1 → 0.0.2

data/lib/jewel.rb

@@ -1,6 +1,7 @@
-# Provides easy access to Gem metadata in an object oriented fashion.
+# Easy, object-oriented access to gem metadata.
 #
 # @author Matheus Afonso Martins Moreira
+# @see Jewel::Gem
 # @since 0.0.1
 module Jewel
 end

data/lib/jewel/gem.rb

@@ -2,7 +2,7 @@ require 'jewel/gem/metadata'
 
 module Jewel
 
-  # The centralized spot for information about a gem.
+  # Stores information about a gem.
   #
   # @author Matheus Afonso Martins Moreira
   # @since 0.0.1
@@ -20,38 +20,74 @@ class << Jewel::Gem
     @metadata ||= Jewel::Gem::Metadata.new
   end
 
-  # Forwards everything to this Gem's metadata.
+  # Forwards everything to this gem's {metadata}.
   def method_missing(method_name, *arguments, &block)
     metadata.send method_name, *arguments, &block
   end
 
-  # Sets the name of the gem.
+  # Sets the name of the gem. Returns the name if not given an argument.
   #
-  # @param [String, Symbol, #to_s] name the name of the library
-  # @return [String]
+  # @param [String, Symbol, #to_s] name the name of the gem
+  # @return [String] the name of the gem
   def name!(name = nil)
     arguments = [ name ].compact.map &:to_s
     metadata.send :name, *arguments
   end
 
+  # Sets the root of the gem, relative to the directory where the current file
+  # is located. Returns the gem root if not given an argument.
+  #
+  # @param [String, #to_s] relative_to the gem root relative to the current
+  #                                    directory
+  # @return [String] the gem root as an absolute path
+  # @since 0.0.2
+  def root(relative_to = nil)
+    arguments = []
+    arguments << File.expand_path(relative_to.to_s, File.dirname(__FILE__)) unless relative_to.nil?
+    metadata.send :root, *arguments
+  end
+
   # Adds a runtime dependency.
   #
   # If called within a {development} context, a development dependency will be
   # added instead.
   #
-  # @param [String, Symbol] gem the name of the gem
-  # @param [String] version the version of the gem
+  # @param [String, Symbol, #to_s] gem the name of the gem
+  # @param [String, Symbol, #to_s] version the version of the gem
+  # @see development
+  # @example
+  #   depend_on :jewel    # runtime dependency
+  #
+  #   development do
+  #     depend_on :rspec  # development dependency
+  #   end
   def depend_on(gem, version = nil)
     metadata.send(if development?
       :development_dependencies
     else :dependencies end).merge! gem => version
   end
 
+  # Makes sure the correct versions of this gem's dependencies are loaded at
+  # runtime, no matter which versions are installed locally.
+  #
+  # @option options [true, false, :only] :development (false) which set of
+  #   dependencies should be activated
+  # @since 0.0.2
+  def activate_dependencies!(options = {})
+    metadata.each_dependency options do |name, version|
+      gem name, version unless version.nil?
+    end
+  end
+
   # Executes the given block within a development context, turning runtime
   # dependencies into development dependencies.
   #
-  # @yield nothing
+  # @param [Proc] block the block to evaluate
   # @see depend_on
+  # @example
+  #   development do
+  #     depend_on :rspec
+  #   end
   def development(&block)
     @development = true
     instance_eval &block
@@ -61,8 +97,8 @@ class << Jewel::Gem
 
   # Returns this gem's specification.
   #
-  # @return [Gem::Specification] the gem specification
-  # @see Jewel::Gem::Metadata.to_spec
+  # @return [::Gem::Specification] the gem specification
+  # @see Jewel::Gem::Metadata#to_spec
   def spec
     metadata.to_spec
   end
@@ -84,15 +120,17 @@ end
 
 class Jewel::Gem
 
-  name! 'jewel'
-  summary 'Easy access to Gem metadata'
-  version '0.0.1'
+  name! :jewel
+  summary 'Easy access to gem metadata'
+  version '0.0.2'
   homepage 'https://github.com/matheusmoreira/jewel'
+  license 'Mozilla Public License, version 2.0'
 
   author 'Matheus Afonso Martins Moreira'
   email 'matheus.a.m.moreira@gmail.com'
 
   files `git ls-files`.split "\n"
+  root '../..'
 
   development do
     depend_on :bundler

data/lib/jewel/gem/metadata.rb

@@ -13,14 +13,11 @@ module Jewel
       # instance.
       #
       # @param [Proc] block the initializer block
-      # @since 0.0.1
       def initialize(&block)
         instance_eval &block unless block.nil?
       end
 
       # Associates the name of the missing method with the given arguments.
-      #
-      # @since 0.0.1
       def method_missing(method_name, *arguments, &block)
         method = method_name.to_s.gsub(/[=?!\z]/ix, '').strip.intern
         count = arguments.count
@@ -32,7 +29,6 @@ module Jewel
       # This gem's runtime dependencies.
       #
       # @return [Hash] name => version pairs
-      # @since 0.0.1
       def dependencies
         @dependencies ||= {}
       end
@@ -40,31 +36,59 @@ module Jewel
       # This gem's development dependencies.
       #
       # @return [Hash] name => version pairs
-      # @since 0.0.1
       def development_dependencies
         @development_dependencies ||= {}
       end
 
-      # Use the stored information to generate a Gem::Specification.
+      # Runtime and development dependencies. The former takes precedence,
+      # should version requirements conflict.
+      #
+      # @return [Hash] name => version pairs
+      # @since 0.0.2
+      def all_dependencies
+        development_dependencies.merge dependencies
+      end
+
+      # Yields dependencies to the given block, or returns an enumerator.
       #
-      # @return [Gem::Specification] the specification
-      # @since 0.0.1
+      # @option options [true, false, :only] :development (false) whether
+      #   runtime and development dependencies should be included
+      # @yieldparam [String] gem_name the name of the gem
+      # @yieldparam [String, nil] version the required version
+      # @since 0.0.2
+      def each_dependency(options = {})
+        return enum_for :each_dependency, options unless block_given?
+        development = options.fetch :development, false
+        case development
+          when :only then development_dependencies
+          when  true then all_dependencies
+          else dependencies
+        end.each do |gem_name, version|
+          yield gem_name.to_s, version
+        end
+      end
+
+      # Uses the stored information to generate a ::Gem::Specification.
+      #
+      # @return [::Gem::Specification] the specification
       def to_spec
         ::Gem::Specification.new do |gem_specification|
 
           # Set all attributes
           stored_attributes.keys.each do |key|
-            writer = '='.prepend key.to_s
-            gem_specification.send writer, stored_attributes[key] if gem_specification.respond_to? writer
+            writer_method = '='.prepend(key.to_s).intern
+            if gem_specification.respond_to? writer_method
+              gem_specification.send writer_method, stored_attributes[key]
+            end
           end
 
           # Add the dependencies
           {
-            :add_runtime_dependency => dependencies,
-            :add_development_dependency => development_dependencies
-          }.each do |method_name, dependencies|
-            dependencies.each do |gem_name, version|
-              gem_specification.send method_name.intern, gem_name.to_s, version
+            :add_runtime_dependency => false,
+            :add_development_dependency => :only
+          }.each do |method, option|
+            each_dependency development: option do |*arguments|
+              gem_specification.send method, *arguments.compact
             end
           end
         end
@@ -75,7 +99,6 @@ module Jewel
       # The stored gem attributes.
       #
       # @return [Hash] hash holding information about the gem
-      # @since 0.0.1
       def stored_attributes
         @stored_attributes ||= {}
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jewel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2012-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,7 +84,7 @@ files:
 - .gitignore
 - .rvmrc
 - Gemfile
-- LICENSE.MPL2
+- LICENSE.MPLv2.0
 - README.markdown
 - Rakefile
 - jewel.gemspec
@@ -92,7 +92,8 @@ files:
 - lib/jewel/gem.rb
 - lib/jewel/gem/metadata.rb
 homepage: https://github.com/matheusmoreira/jewel
-licenses: []
+licenses:
+- Mozilla Public License, version 2.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -105,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2841041591828843644
+      hash: 1007763749711895978
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -114,11 +115,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2841041591828843644
+      hash: 1007763749711895978
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Easy access to Gem metadata
+summary: Easy access to gem metadata
 test_files: []