rubygems_snapshot 0.1.3 → 0.2.0

data/README.textile

@@ -1,25 +1,79 @@
-h1. rubygems_snapshot
+h1. Snapshot: A Rubygems plugin
 
-Adds snapshot command to gem. This command allow import/export gems.
+*Export and Import* your gems.
+Snapshot, copy your current gems in a single file, providing a fast and secure way to import your gems anywhere.
 
-h2. Description
+Tested with:
+* ruby-1.8.6-p399 [ i386 ]
+* ruby-1.8.7-p249 [ i386 ]
+* 1.3.6 gem version
 
-This gem is a plugin for rubygems.
-Based on ["Import/Export Patch":http://rubyforge.org/tracker/?atid=577&group_id=126&func=browse] from ["Peer Allan":http://rubyforge.org/users/pallan].
+Version 1 was based on ["Import/Export Patch":http://rubyforge.org/tracker/?atid=577&group_id=126&func=browse] from ["Peer Allan":http://rubyforge.org/users/pallan].
 
 h2. Install/Usage
 
 @gem install rubygems_snapshot@
-Hosted at ["Gemcutter":http://gemcutter.org/gems/rubygems_snapshot]
 
 After install, you can use:
 
-@gem snapshot export result_file.yml@ to export your gems
+@gem snapshot export gems.tar@ to export your gems
 
-@gem snapshot import file_exported.yml@ to import (install) gems.
+@gem snapshot import gems.tar@ to import (install) gems.
 
-*Important*: When importing, don't forget to use sudo if necessary.
-*Important(2)*: When importing, pay attention to errors relative to native build. I don't know how to deal with that. :X
+*Important*: When importing, don't forget to use sudo if necessary *and* pay attention to errors relative to native build.
+I don't know how to deal with that yet! :X
+*Hosted* at ["Gemcutter":http://gemcutter.org/gems/rubygems_snapshot]
+
+h3. Others formats
+
+Nowadays, it supports two formats:
+* tar (default)
+* yml
+
+You can chose the format, using -f parameter. For example:
+
+@gem snapshot export gems.yml -f yml@
+@gem snapshot import gems.yml -f yml@
+
+For aditional help, execute:
+@gem help snapshot@
+
+h3. How it Works?
+
+It's very simple.
+*When exporting*, get all gems (like "gem list"), puts in a yml file.
+If gem file exists at cache folder from rubygems, copy to tar file too. (tar format)
+
+*When importing*, copy all gems to rubygems cache folder.
+Read the yml file, install the gem file from cache folder or do a simple "gem install" if gem file does not exists.
+
+h2. For Developers
+
+h3. Using as API
+
+<pre>
+require "rubygems"
+GemsSnapshot::Exporter.export("example.tar", :format => :tar)
+</pre>
+
+--
+
+<pre>
+require "rubygems"
+GemsSnapshot::Importer.import("example.tar", :format => :tar)
+</pre>
+
+
+h3. Use the sources Luke!
+
+If you want help to improve Snapshot, after git clone, you'll need the following gems:
+* rake
+* rspec
+* cucumber
+
+Use "rake -T" to see the available tasks.
+I highly recomend using ["RVM":http://rvm.beginrescueend.com/] during development.
+Anything, questions, suggestions etc., send me message or leave a issue.
 
 h2. License
 

data/lib/commands/snapshot_command.rb

@@ -1,17 +1,24 @@
 require 'rubygems/command'
-require 'yaml'
 
 class Gem::Commands::SnapshotCommand < Gem::Command
 
   def initialize
-    super 'snapshot', 'Export/Import your installed gems'
+    super 'snapshot', 'Export/Import your gems.', :format => "tar"
+
+    add_option('-f', '--format FORMAT', 'Snapshot format. Default is "tar". Can be "yml" too.') do |value, options|
+      options[:format] = value
+    end
+
+  end
+
+  def defaults_str # :nodoc:
+    '--format "tar"'
   end
 
   def arguments # :nodoc:
     args = <<-EOF
-          export    export your installed gems to yml file
-          import    install allgems from yml file
-          filename  yml file used to export/import actions
+          ACTION    'export' or 'import' as action arguments
+          FILENAME  file used to export/import actions
     EOF
     return args.gsub(/^\s+/, '')
   end
@@ -19,111 +26,51 @@ class Gem::Commands::SnapshotCommand < Gem::Command
   def description # :nodoc:
     <<-EOF
 Describe here what snapshot does.
+Updated description at: http://github.com/rogerleite/rubygems_snapshot
     EOF
   end
 
   def usage # :nodoc:
-    "#{program_name} action(export|import) filename"
+    "#{program_name} ACTION(export|import) FILENAME"
   end
 
   def execute
-    action, filename = get_and_check_arguments(options[:args])
+    action, filename = extract_action(options[:args])
+    validate_options(options_without_args)
 
     if action == "export"
-      export(action, filename)
+      export(filename)
     else
-      import(action, filename)
+      import(filename)
     end
   end
 
   private
 
-  def import(action, filename)
-    #TODO: check if is a valid yml file
-
-    require 'rubygems/dependency_installer'
-
-    main_hash = nil
-    File.open(filename, "r") do |file|
-      main_hash = YAML.load(file)
-    end
-    
-    main_hash['sources'].each do |source|
-      Gem.sources << source unless Gem.sources.include?(source)
-    end
-
-    options = Gem::DependencyInstaller::DEFAULT_OPTIONS.merge({
-      :generate_rdoc     => true,
-      :generate_ri       => true,
-      :format_executable => false,
-      :test              => false,
-      :version           => Gem::Requirement.default,
-      #aditional default parameters
-      :ignore_dependencies => true,
-      :verbose => true
-    })
-
-    main_hash['gems'].each do |hash_gem|
-      gem_name = hash_gem['name']
-      hash_gem['versions'].each do |version|
-
-        say "Going to install #{gem_name} -v#{version} ... wish me luck!"
-        begin
-          gem_install(options, gem_name, version)
-
-        rescue Gem::InstallError => e
-          alert_error("Error installing #{gem_name}:\n\t#{e.message}")
-        rescue Gem::GemNotFoundException => e
-          alert_error(e.message)
-        end
-
-      end
-    end
-
+  def import(filename)
+    GemsSnapshot::Importer.import(filename, options_without_args)
+    say "Gems imported successfully."
   end
 
-  def gem_install(options, gem_name, version)
-    inst = Gem::DependencyInstaller.new(options)
-    inst.install(gem_name, version)
-
-    inst.installed_gems.each do |spec|
-      say "Successfully installed #{spec.full_name}"
-    end
+  def export(filename)
+    say "Say CHEESE to snapshot! :P"
+    filename = GemsSnapshot::Exporter.export(filename, options_without_args)
+    say "Gems exported to #{filename} successfully."
   end
 
-  def list_installed_gems
-    name = /^/i  #get all local gems
-    dep = Gem::Dependency.new(name, Gem::Requirement.default)
-    specs = Gem.source_index.search(dep)
+  def options_without_args
+    options.reject { |key, value| key == :args }
   end
 
-  def export(action, filename)
-    say "Say CHEESE to snapshot! :P"
-
-    specs = list_installed_gems
-
-    hash_specs = {}
-    specs.each do |spec|
-      versions = hash_specs[spec.name.to_s] || []
-      versions << spec.version.to_s
-      hash_specs[spec.name.to_s] = versions
+  def validate_options(options)
+    format = options[:format]
+    format = format.downcase
+    unless %w(tar yml).include?(format)
+      raise Gem::CommandLineError, "invalid format \"#{format}\" argument.\nUsage:\n#{usage}"
     end
-
-    gems = []
-    hash_specs.each do |spec_name, versions|
-      gems << {'name' => spec_name, 'versions' => versions}
-    end
-
-    main_hash = {'gems' => gems, 'sources' => Gem.sources}
-    #say main_hash.to_yaml.to_s  #for debug only :P
-
-    File.open(filename, "w") do |file|
-      file.puts(main_hash.to_yaml)
-    end
-    say "Gems exported to #{filename} successfully."
   end
 
-  def get_and_check_arguments(args)
+  def extract_action(args)
     action = args[0]
     raise Gem::CommandLineError, "Snapshot needs an action argument.\nUsage:\n#{usage}" if action.nil? or action.empty?
 
@@ -132,24 +79,15 @@ Describe here what snapshot does.
       raise Gem::CommandLineError, "invalid action \"#{action}\" argument.\nUsage:\n#{usage}"
     end
 
-    filename = nil
-    if action == "export"
-      filename = args[1] || "gems_#{Time.now.strftime("%Y%m%d_%H%M")}.yml"
-      filename = filename.downcase
-      filename.concat(".yml") unless end_with?(filename, ".yml")
-    else
-      filename = args[1]
-      raise Gem::CommandLineError, "Snapshot needs an filename argument for import action.\nUsage:\n#{usage}" if filename.nil? or filename.empty?
+    filename = args[1]
+    raise Gem::CommandLineError, "Snapshot needs an filename argument for #{action} action.\nUsage:\n#{usage}" if filename.nil? or filename.empty?
+    
+    if action == "import"
       raise Gem::Exception, "File not found. :( \nUsage:\n#{usage}" unless File.exist?(filename)
     end
 
     [action, filename]
   end
 
-  def end_with?(target, suffix)
-    suffix = suffix.to_s
-    target[-suffix.length, suffix.length] == suffix
-  end
-
 end
 

data/lib/gems_snapshot/exporter.rb

@@ -0,0 +1,37 @@
+
+module GemsSnapshot
+
+  module ExporterHelper
+
+    # List all installed gems
+    def installed_gems
+      dep = Gem::Dependency.new(/^/i, Gem::Requirement.default) #get all local gems
+      Gem.source_index.search(dep)
+    end
+
+  end
+
+  #require all "exporters" from exporter folder
+  Dir["#{File.dirname(__FILE__)}/exporter/*_exporter.rb"].each do |file|
+    require "gems_snapshot/exporter/#{File.basename(file, ".rb")}"
+  end
+
+  class Exporter
+
+    def self.export(filename, options = {})
+      options = {:format => :tar}.merge(options)
+      format = options.delete(:format)
+
+      begin
+        exporter = GemsSnapshot.const_get("#{format.to_s.capitalize}Exporter").send(:new)
+        result = exporter.export(filename)
+      rescue => ex
+        raise Gem::Exception, "Ops! An unexpected error occurred: #{ex.message}"
+      end
+
+      result
+    end
+
+  end
+
+end

data/lib/gems_snapshot/exporter/tar_exporter.rb

@@ -0,0 +1,55 @@
+require "tmpdir"              #necessary to use Dir.tmp
+require "rubygems/package"    #necessary to use Gem::Package::TarWriter
+
+module GemsSnapshot
+
+  class TarExporter
+    
+    include ExporterHelper
+
+    def export(filename)
+      filename = "snapshot.gems" if filename.nil?
+
+      files = []
+      installed_gems.each do |gem|
+        files << {:name => "gems/#{gem.full_name}.gem", :path => "#{gem.installation_path}/cache/#{gem.full_name}.gem"}
+      end
+      files << {:name => "gems.yml", :path => export_to_yml("#{Dir.tmpdir}/gems.yml")}
+
+      create_tar_file(filename, files)
+      filename
+    end
+
+    def export_to_yml(filename)
+      yml_exporter = GemsSnapshot::YmlExporter.new
+      yml_exporter.export("#{Dir.tmpdir}/gems.yml")
+    end
+
+    # Create a tar file with Gem::Package::TarWriter from Rubygems.
+    # +filename+ file destination.
+    # +files+ Array of Hash. Each hash have to be +:name+ and +:path+ keys.
+    def create_tar_file(filename, files)
+      File.open(filename, "w+") do |file|
+        Gem::Package::TarWriter.new(file) do |tar_file|
+
+          files.each do |hash|
+            next unless File.exists?(hash[:path])
+
+            filepath = hash[:path]
+            filename = hash[:name]
+
+            stat = File.stat(filepath)
+            tar_file.add_file_simple(filename, stat.mode, stat.size) do |tar_io|
+              File.open(filepath, "rb") do |file_io|
+                tar_io.write(file_io.read(4096)) until file_io.eof?
+              end
+            end
+          end
+
+        end
+      end
+    end
+
+  end
+
+end

data/lib/gems_snapshot/exporter/yml_exporter.rb

@@ -0,0 +1,29 @@
+module GemsSnapshot
+
+  class YmlExporter
+
+    include ExporterHelper
+
+    def export(filename)
+      hash_specs = {}
+      installed_gems.each do |spec|
+        versions = hash_specs[spec.name.to_s] || []
+        versions << spec.version.to_s
+        hash_specs[spec.name.to_s] = versions
+      end
+
+      gems = []
+      hash_specs.each do |spec_name, versions|
+        gems << {'name' => spec_name, 'versions' => versions}
+      end
+
+      main_hash = {'gems' => gems, 'sources' => Gem.sources}
+      #puts main_hash.to_yaml.to_s  #for debug only :P
+
+      File.open(filename, "w") { |file| file.puts(main_hash.to_yaml) }
+      filename
+    end
+
+  end
+
+end

data/lib/gems_snapshot/importer.rb

@@ -0,0 +1,25 @@
+module GemsSnapshot
+
+  #require all "importers" from importer folder
+  Dir["#{File.dirname(__FILE__)}/importer/*_importer.rb"].each do |file|
+    require "gems_snapshot/importer/#{File.basename(file, ".rb")}"
+  end
+
+  class Importer
+
+    def self.import(filename, options = {})
+      options = {:format => :tar}.merge(options)
+      format = options.delete(:format)
+
+      begin
+        importer = GemsSnapshot.const_get("#{format.to_s.capitalize}Importer").send(:new)
+        importer.import(filename)
+      rescue => ex
+        raise Gem::Exception, "Ops! An unexpected error occurred: #{ex.message}"
+      end
+
+    end
+
+  end
+
+end

data/lib/gems_snapshot/importer/tar_importer.rb

@@ -0,0 +1,55 @@
+require "tmpdir"              #necessary to use Dir.tmp
+
+module GemsSnapshot
+
+  class TarImporter
+
+    def import(filename)
+      files = extract_files_from_tar(filename)
+      copy_gems_to_cache_directory files
+      yml_metadata = get_metadata(files)
+
+      yml_importer = GemsSnapshot::YmlImporter.new
+      yml_importer.import(yml_metadata)
+    end
+
+    private
+
+    def extract_files_from_tar(filename)
+      files = []
+
+      tmp_dir = "#{Dir.tmpdir}/#{Time.now.to_i}"
+      FileUtils.rm_rf tmp_dir
+      FileUtils.mkdir_p tmp_dir
+
+      begin
+        File.open(filename, "r") do |file|
+          Gem::Package::TarReader.new(file).each_entry do |entry|
+            destination_file = "#{tmp_dir}/#{entry.full_name}"
+            FileUtils.mkdir_p File.dirname(destination_file)
+
+            File.open(destination_file, "w+") { |f| f.write entry.read }
+            files << destination_file
+          end
+        end
+      rescue ex
+        raise "An error occurred while extracting files. #{ex.message}"
+      end
+      files
+    end
+
+    def get_metadata(files)
+      result = files.select { |file| file =~ /gems.yml$/ }
+      raise "File gems.yml not found!" if result.nil? or result.size == 0
+      result.first
+    end
+
+    def copy_gems_to_cache_directory(files) 
+      cache_directory = "#{Gem.path.first}/cache"
+      files.select { |file| file =~ /.gem$/ }.each do |file|
+        FileUtils.cp file, "#{cache_directory}/#{File.basename(file)}"
+      end
+    end
+  end
+
+end

data/lib/gems_snapshot/importer/yml_importer.rb

@@ -0,0 +1,72 @@
+require 'rubygems/dependency_installer'
+require 'yaml'
+
+module GemsSnapshot
+
+  class YmlImporter
+
+    attr :errors
+
+    def import(filename)
+      yml_hash = YAML.load(File.read(filename))  #TODO: validate file content someday
+
+      yml_hash['gems'].each do |hash_gem|
+        gem_name = hash_gem['name']
+        hash_gem['versions'].each do |version|
+
+          if Gem.available? gem_name, version
+            puts "#{gem_name}-#{version} already available!"
+            next
+          end
+
+          gem_name = check_for_cache(gem_name, version)
+
+          puts "Going to install #{gem_name} -v#{version} ... wish me luck!"
+          begin
+            gem_install(gem_name, version)
+          rescue Gem::InstallError => e
+            errors << "Error installing #{gem_name}:\n\t#{e.message}"
+          rescue Gem::GemNotFoundException => e
+            errors << "Gem not found #{e.message}"
+          end
+
+        end
+      end
+    end
+
+    protected 
+
+    #Return gem file if exist at cache folder.
+    def check_for_cache(gem_name, version)
+      gem_file = "#{gem_name}-#{version}.gem"
+      Gem.path.each do |gem_path|
+        complete_path = "#{gem_path}/cache/#{gem_file}"
+        return complete_path if File.exist? complete_path
+      end
+      gem_name
+    end
+
+    def installer_options
+      @installer_options ||= Gem::DependencyInstaller::DEFAULT_OPTIONS.merge({
+        :generate_rdoc     => true,
+        :generate_ri       => true,
+        :format_executable => false,
+        :test              => false,
+        :version           => Gem::Requirement.default,
+        #aditional default parameters
+        :ignore_dependencies => true,
+        :verbose => true
+      })
+    end
+
+    def gem_install(gem_name, version, options = installer_options)
+      inst = Gem::DependencyInstaller.new(options)
+      inst.install(gem_name, version)
+      inst.installed_gems.each do |spec|
+        puts "Successfully installed #{spec.full_name}"
+      end
+    end
+
+  end
+
+end

data/lib/rubygems_plugin.rb

@@ -1,4 +1,8 @@
 require 'rubygems/command_manager'
 require 'commands/snapshot_command'
+
+require "gems_snapshot/exporter"
+require "gems_snapshot/importer"
+
 Gem::CommandManager.instance.register_command :snapshot
 

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rubygems_snapshot
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Roger Leite
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 -02:00
+date: 2010-05-06 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -23,22 +28,28 @@ extra_rdoc_files: []
 
 files: 
 - lib/commands/snapshot_command.rb
+- lib/gems_snapshot/importer/tar_importer.rb
+- lib/gems_snapshot/importer/yml_importer.rb
+- lib/gems_snapshot/exporter/tar_exporter.rb
+- lib/gems_snapshot/exporter/yml_exporter.rb
+- lib/gems_snapshot/exporter.rb
+- lib/gems_snapshot/importer.rb
 - lib/rubygems_plugin.rb
 - README.textile
 has_rdoc: true
 homepage: http://github.com/rogerleite/rubygems_snapshot
 licenses: []
 
-post_install_message: |+
-  
-  ========================================================================
-  
-      Thanks for installing RubygemsSnapshot! You can now run:
-  
-      gem snapshot      import/export your gems
-  
-  ========================================================================
-  
+post_install_message: |
+  ===============================================================================
+    Thanks for installing RubygemsSnapshot! You can now run:
+    gem snapshot export example
+    gem snapshot import example
+    ***
+    gem help snapshot for help! ;)
+    OR http://github.com/rogerleite/rubygems_snapshot
+  ===============================================================================
+
 rdoc_options: []
 
 require_paths: 
@@ -47,18 +58,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 5
       version: 1.3.5
-  version: 
 requirements: []
 
 rubyforge_project: rubygems_snapshot
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Command to import/export gems