jewel 0.0.4 → 0.0.5

data/README.markdown

@@ -1,3 +1,106 @@
 # Jewel
 
-Centralize access to Gem information.
+Gem metadata at your fingertips.
+
+# What's this for?
+
+Sometimes it's useful to access information about a gem at runtime. Jewel exists
+to centralize access to that data and make it as easy as possible to access it.
+
+# How do I install it?
+
+Latest version:
+
+    gem install jewel
+
+From source:
+
+    git clone git://github.com/matheusmoreira/jewel.git
+
+# How do I use it?
+
+Let's say you have a gem named `awesome`. Let's define the `Awesome::Gem` class:
+
+    # lib/awesome/gem.rb
+    require 'jewel'
+
+    module Awesome
+      class Gem < Jewel::Gem
+        name! :awesome
+        summary 'Awesome gem'
+        version '1.2.3'
+        homepage 'https://github.com/you/awesome'
+
+        author 'You'
+        email 'you@awesome.com'
+
+        root '../..'  # relative to this file's directory
+        files `git ls-files`.split "\n"
+
+        depend_on :jewel
+      end
+    end
+
+Now you and others can access your specification at runtime. Let's use it to
+set up the `awesome.gemspec` file:
+
+    #!/usr/bin/env gem build
+    # encoding: utf-8
+    require './awesome/gem'
+
+    Awesome::Gem.specification
+
+Tools like `gem` and `bundler` assume the `.gemspec` returns a
+`Gem::Specification` instance, which is exactly what is happening here.
+
+# External libraries? In _my_ `.gemspec`?!
+
+Right. Unlike `.gemspec` generators, Jewel will not duplicate information and it
+will _certainly_ not make a giant mess in your version control diff. These are
+actually some of the reasons why I wrote this gem.
+
+However, you will probably run into problems if you use tools that parse your
+`.gemspec` or are unable to `require` your gem. If that's your case, then you'll
+be happy to know that you can also use your existing handwritten
+specification:
+
+    # lib/awesome/gem.rb
+    require 'jewel'
+
+    module Awesome
+      class Gem < Jewel::Gem
+        root '../..'
+        path_to_gemspec = root.join 'awesome.gemspec'
+
+        # specification is aliased as spec
+        spec ::Gem::Specification.load path_to_gemspec.to_s
+      end
+    end
+
+Hey, is that a `Rails.root`-like method? Exactly! It basically returns a dynamic
+Pathname allows you join paths by chaining methods and passing arguments to
+them:
+
+    root = Awesome::Gem.root
+    root.lib.awesome 'gem.rb'  # lib/awesome/gem.rb
+    root.i18n I18n.locale.to_s, 'messages.yml'  # i18n/en/messages.yml
+
+# Nifty. What else can it do?
+
+It can make sure that the correct versions of your dependencies will be loaded.
+When you `require` some code, RubyGems will actually load the latest version of
+the gem that it can find, even if you've specified a lower version in the
+specification. To make it load the versions you wanted, you can simply write:
+
+    Awesome::Gem.activate_dependencies!
+
+You can browse the [documentation](http://rubydoc.info/gems/jewel/frames) in
+order to learn more about the general API. There is also [edge
+documentation](http://rubydoc.info/github/matheusmoreira/jewel/master/frames),
+straight from the GitHub repository.
+
+# Hey, it's broken!! Why doesn't it do this?
+
+Found problems? Have ideas? The best way to get in touch is to [create an
+issue](https://github.com/matheusmoreira/jewel/issues/new) on the GitHub
+tracker. Feel free to fork the repository send a pull request as well!

data/lib/jewel/gem.rb

@@ -1,4 +1,5 @@
 require 'jewel/gem/metadata'
+require 'jewel/gem/root'
 
 module Jewel
 
@@ -48,7 +49,8 @@ class << Jewel::Gem
       # caller returns an array of strings that are like “file:line” or “file:line: in `method’”
       file = caller.first.split(/:/).first
       directory = File.dirname file
-      arguments << File.expand_path(relative_to, directory)
+      path = File.expand_path(relative_to, directory)
+      arguments.push Jewel::Gem::Root.new path
     end
     metadata.send :root, *arguments
   end
@@ -72,6 +74,8 @@ class << Jewel::Gem
     specification.send method, gem.to_s, *requirements
   end
 
+  alias depends_on depend_on
+
   # Makes sure the correct versions of this gem's dependencies are loaded at
   # runtime, no matter which versions are installed locally.
   #
@@ -128,8 +132,9 @@ end
 class Jewel::Gem
 
   name! :jewel
-  summary 'Easy access to gem metadata'
-  version '0.0.4'
+  summary 'Gem metadata at your fingertips'
+  description 'Jewel provides an easy way to access information about a gem at runtime'
+  version '0.0.5'
   homepage 'https://github.com/matheusmoreira/jewel'
   license 'Mozilla Public License, version 2.0'
 

data/lib/jewel/gem/root.rb

@@ -0,0 +1,25 @@
+require 'pathname'
+
+module Jewel
+  class Gem
+
+    # A Pathname that allows subdirectory access through method chaining.
+    #
+    # @author Matheus Afonso Martins Moreira
+    # @since 0.0.5
+    class Root < Pathname
+
+      # Joins the name of the missing method and all arguments with this
+      # Pathname.
+      #
+      # @return [Jewel::Gem::Root] new instance with the results of the join
+      def method_missing(method_name, *arguments, &block)
+        arguments.unshift method_name.to_s
+        pathname = join *arguments
+        self.class.new pathname
+      end
+
+    end
+
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jewel
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   segments:
   - 0
   - 0
-  - 4
+  - 5
   prerelease: 
-  hash: -3852523161477996427
+  hash: -2407718612203325966
 platform: ruby
 authors:
 - Matheus Afonso Martins Moreira
@@ -26,7 +26,7 @@ dependencies:
         version: '0'
         segments:
         - 0
-        hash: -4447801726355984837
+        hash: 4309900643650690816
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -37,7 +37,7 @@ dependencies:
         version: '0'
         segments:
         - 0
-        hash: -4447801726355984837
+        hash: 4309900643650690816
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -48,7 +48,7 @@ dependencies:
         version: '0'
         segments:
         - 0
-        hash: -4447801726355984837
+        hash: 4309900643650690816
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -59,7 +59,7 @@ dependencies:
         version: '0'
         segments:
         - 0
-        hash: -4447801726355984837
+        hash: 4309900643650690816
 - !ruby/object:Gem::Dependency
   name: rookie
   requirement: !ruby/object:Gem::Requirement
@@ -70,7 +70,7 @@ dependencies:
         version: '0'
         segments:
         - 0
-        hash: -4447801726355984837
+        hash: 4309900643650690816
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ dependencies:
         version: '0'
         segments:
         - 0
-        hash: -4447801726355984837
+        hash: 4309900643650690816
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +92,7 @@ dependencies:
         version: '0'
         segments:
         - 0
-        hash: -4447801726355984837
+        hash: 4309900643650690816
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -103,7 +103,7 @@ dependencies:
         version: '0'
         segments:
         - 0
-        hash: -4447801726355984837
+        hash: 4309900643650690816
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,7 @@ dependencies:
         version: '0'
         segments:
         - 0
-        hash: -4447801726355984837
+        hash: 4309900643650690816
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -125,8 +125,8 @@ dependencies:
         version: '0'
         segments:
         - 0
-        hash: -4447801726355984837
-description: 
+        hash: 4309900643650690816
+description: Jewel provides an easy way to access information about a gem at runtime
 email: matheus.a.m.moreira@gmail.com
 executables: []
 extensions: []
@@ -142,6 +142,7 @@ files:
 - lib/jewel.rb
 - lib/jewel/gem.rb
 - lib/jewel/gem/metadata.rb
+- lib/jewel/gem/root.rb
 - spec/jewel/gem_spec.rb
 homepage: https://github.com/matheusmoreira/jewel
 licenses:
@@ -158,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4447801726355984837
+      hash: 4309900643650690816
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -167,11 +168,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4447801726355984837
+      hash: 4309900643650690816
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Easy access to gem metadata
+summary: Gem metadata at your fingertips
 test_files: []