fake_gem 0.1.12 → 0.1.13

data/Rakefile

@@ -4,6 +4,10 @@ project(
   name: "fake_gem",
   gem: true,
   summary: "Makes any directory looks like Ruby Gem",
+  
+  bin: 'bin',
+  executables: ['fake_gem'],
+  dirs: %w(bin),
 
   author: "Alexey Petrushin",
   homepage: "http://github.com/alexeypetrushin/fake_gem"

data/bin/fake_gem

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+if ARGV.empty? or %w(-h --help help).any?{|k| ARGV.include? k}
+  puts <<-TEXT
+  fake_gem makes any directory looks like ruby gem.
+  
+  Usage:          
+    $ fake_gem ~/projects ~/other_projects
+    
+  Details:
+    Let's suppose Your projects are located 
+    in the /my_projects dir, and there is 3 folders:  
+    ~/my_projects
+      /app
+      /lib1
+      /lib2
+        
+    You want lib1 and lib2 to be available as a gems
+    while You are developing Your app, do following steps:      
+    1. mark lib1 as fake_gem:
+      create /projects/lib/fake_gem file
+      and add there following lines:
+        name: lib1
+        libs: lib
+    2. do the same for lib2
+    3. enable fake_gem in current bash session, type:
+      $ fake_gem ~/projects
+    
+    All done, now lib1 and lib2 will be 
+    availiable as real gems in ruby scripts.  
+TEXT
+  exit
+end
+
+dir = File.expand_path("#{__FILE__}/../..")
+
+rubyopt = ENV['RUBYOPT'] || ""
+rubyopt = "#{rubyopt} -r#{dir}/lib/fake_gem.rb" unless rubyopt =~ /fake_gem/
+
+fake_gem_paths = (ENV['FAKE_GEM_PATHS'] || "").split(':')
+fake_gem_paths = (fake_gem_paths + ARGV).uniq.join(':')
+
+puts <<-TEXT
+Please execute following commands or add it to Your bash profile:
+RUBYOPT=#{rubyopt}
+FAKE_GEM_PATHS=#{fake_gem_paths}
+TEXT

data/lib/fake_gem.rb

@@ -7,6 +7,21 @@ unless defined?(FakeGem) or defined?(JRuby)
   
   $indent = -1
   Kernel.class_eval do
+    alias :gem_without_fgem :gem
+    def gem name, *version_requirements      
+      gem_without_fgem name, *version_requirements
+    rescue Gem::LoadError => e
+      
+      # need this check to prevent very tricky bug caused by recursive retry and resulting in
+      # files will be required multiple times and strange error messages will be produced
+      raise e if e.raised_in_fake_gem
+      
+      unless FakeGem.activate_gem(name)
+        e.raised_in_fake_gem = true
+        raise e
+      end
+    end
+    
     alias :require_without_fgem :require
     def require path      
       require_without_fgem path    
@@ -44,28 +59,15 @@ unless defined?(FakeGem) or defined?(JRuby)
   
   module FakeGem
     class FakeGemSpec
-      attr_accessor :dir
-      def initialize file
+      attr_reader :dir, :name, :libs
+      def initialize file        
         should_exist file
         @dir, @libs = File.expand_path(File.dirname(file)), []
-        instance_eval File.read(file), __FILE__, __LINE__
-      end
-
-      def libs *args
-        if args.empty?
-          @libs
-        else
-          args = args.first if args.first.is_a? Array
-          args = args.collect do |d| 
-            d = d.to_s
-            d = (d =~ /^\//) ? d : "#{dir}/#{d}"
-            should_exist d, "file '%{file}' not exist (folder '#{dir}' is false_gem but the folder declared as :lib not exist)!"
-            d            
-          end
-          @libs.push(*args)
-        end
+        
+        require 'yaml'
+        spec = YAML.load_file file
+        self.name, self.libs = spec['name'], Array(spec['libs'])
       end
-      attr_writer :libs
       
       def inspect
         relative_libs = @libs.collect{|l| l.sub("#{@dir}/", '')}
@@ -79,6 +81,18 @@ unless defined?(FakeGem) or defined?(JRuby)
           raise msg.sub('%{file}', file) unless File.exist? file
           file
         end
+        
+        def libs= libs
+          libs = libs.collect do |d|
+            d = d.to_s
+            d = (d =~ /^\//) ? d : "#{dir}/#{d}"            
+            should_exist d, "file '%{file}' not exist (folder '#{dir}' is false_gem but the folder declared as :lib not exist)!"
+            d            
+          end
+          @libs = libs
+        end
+        
+        attr_writer :name
     end
 
     class << self
@@ -128,6 +142,22 @@ unless defined?(FakeGem) or defined?(JRuby)
           false
         end
       end
+      
+      # searches for that path in all libs inside of registered fake_gems and 
+      # updates $LOAD_PATH if found.
+      def activate_gem name
+        found = gems.find{|gem_spec| gem_spec.name && (gem_spec.name == name)}        
+        
+        if found
+          gems.delete found
+          found.libs.each do |lib_path|
+            $LOAD_PATH << lib_path unless $LOAD_PATH.include? lib_path
+          end
+          true
+        else
+          false
+        end
+      end
 
       # list of found false-gems
       def gems

data/readme.md

@@ -1,61 +1,35 @@
-# Makes any directory looks like Ruby Gem
+FakeGem - very handy hack that makes any directory looks like gem and greatly simplifies gem development. Forget about compiling & pushing Your gems or changing the Bundler's Gemfile file.
+Yes, there's the :path opion in Bundler, but it doesn't solve the problem - if You have multiple projects depending on multiple gems - then You have to change multiple paths in multiple Gemfiles, that's boing. And the FakeGem solves this problem very easily.
 
-## Overview
+## Usage
 
-Why? Because I want some of my projects be accessible as a gem, but without overhead like providing gem spec, rebuild and pushing it with every update.
-I need only the most basic functional of gem system - automatic path resolving.  And the **fake_gem** does exactly that.
+``` bash
+fake_gem ~/my_projects
+```
 
-**Note**: it's not a gem replacement, It's just a handy hack to simplify development in cases when you don't need all the gem power. At any time you
-can add standard gem's specification and it become real gem, without any change for other code that uses it.
+Let's suppose Your projects are located in the /my_projects dir, and because You respect the 'divide and rule' principle Your app divided into 3 modules - the app itself and 2 gems:
 
-## Usage
+```
+~/my_projects
+  /app
+  /lib1
+  /lib2
+```  
+
+You want lib1 and lib2 to be available as a gems while You are developing Your app, do following steps:
 
-Let's say you have the 'application' project and want to use 'user-management' and 'billing' libraries in it.
-
-	~/projects
-		/application
-			/lib
-				/app.rb
-								
-		/user-management
-			/lib
-				user_management.rb 
-			fake_gem # libs :lib
-				
-		/billing
-			/lib
-				billing.rb
-			fake_gem # libs :lib
-			
-		/some-other-app
-			/lib
-				/some_other_app.rb
-
-You should do the following steps:
-
-1. create 2 files called 'fake_gem' with the "libs :lib" content inside each of 'user-management' and 'billing' libraries.
-
-2. add the following lines to your 'app.rb' file:
-	
-	require 'fake_gem'
-	FakeGem.paths '~/projects'
-	
-Now both of those libraries are available inside of your application, like that:
-
-	require 'user_management' # => true
-	require 'billing' # => true
-	
-FakeGem ignores and don't mess with your other projects don't marked with the 'fake_gem' label.
-
-	require 'some_other_app' # => Error, no such file!
-	
-**Note**: there's a better way, without affecting the 'app.rb' file. Add following lines to your ~/.profile
-	
-	export FAKE_GEM_PATH="~/projects"
-	export RUBYOPT="-rrubygems -r<your path to the 'fake_gem' gem dir>/lib/fake_gem.rb"
-	
-now you don't need the step 2 (don't forget to reload your .profile changes by executing $source ~/.profile).
+1. mark lib1 as fake_gem: create /projects/lib/fake_gem file and add there following lines:
+  name: lib1
+  libs: lib
+2. do the same for lib2
+3. enable fake_gem in current bash session, type:
+  $ fake_gem ~/projects
+  
+All done, now lib1 and lib2 will be availiable as real gems in ruby scripts. 
+No changes needed to source code, You can use real gems or fake gems - the application knows nothing about it.
 
 ## Installation
 
-	$ sudo gem install fake_gem
+```
+gem install fake_gem
+```

data/spec/fake_gem_spec/common/project_a/fake_gem

@@ -1 +1,2 @@
-libs :lib
+name: project_a
+libs: lib

data/spec/fake_gem_spec/twice/kit/fake_gem

@@ -1 +1 @@
-libs :lib
+libs: lib

data/spec/fake_gem_spec/twice/saas/fake_gem

@@ -1 +1 @@
-libs :lib
+libs: lib

data/spec/fake_gem_spec.rb

@@ -41,6 +41,15 @@ describe FakeGem do
     $LOAD_PATH.should_not include("#{spec_dir}/common/project_b/lib")
   end
   
+  it "hould load directories with fake_gem as gems" do
+    FakeGem.paths "#{spec_dir}/common"
+    FakeGem.gems.size.should == 1
+
+    gem 'project_a'
+    
+    $LOAD_PATH.should include("#{spec_dir}/common/project_a/lib")
+  end
+  
   it "should load directories with fake_gem as gems" do
     FakeGem.paths "#{spec_dir}/common"
     FakeGem.gems.size.should == 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fake_gem
 version: !ruby/object:Gem::Version 
-  version: 0.1.12
+  version: 0.1.13
   prerelease: 
 platform: ruby
 authors: 
@@ -10,14 +10,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-30 00:00:00 +04:00
+date: 2011-08-06 00:00:00 +04:00
 default_executable: 
 dependencies: []
 
 description: 
 email: 
-executables: []
-
+executables: 
+- fake_gem
 extensions: []
 
 extra_rdoc_files: []
@@ -35,6 +35,7 @@ files:
 - spec/fake_gem_spec/twice/saas/fake_gem
 - spec/fake_gem_spec/twice/saas/lib/the_saas.rb
 - spec/fake_gem_spec.rb
+- bin/fake_gem
 has_rdoc: true
 homepage: http://github.com/alexeypetrushin/fake_gem
 licenses: []