ToolParade 0.0.2

data/CHANGELOG

@@ -0,0 +1,4 @@
+0.0.2 - July 19th 2007
+  Addition of 
+0.0.1 - July 17th 2007
+  Initial beta release

data/README

@@ -0,0 +1,130 @@
+<b>Tool parade scans your system for Ruby Gems and Rails plugins and uploads the result to a central server</b>
+
+This data is used for analysis on Working With Rails to generate
+public charts of the most active plugins and gems.
+You have full control over how and what data is submitted	
+
+Project Home page: http://toolparade.rubyforge.org  (pending)
+
+==Why do this? 
+
+* Share your installed gems/plugins with others. Get ideas of what
+  libraries you might want to use based on others credentials.
+
+* Ensure that the authors of the plugin/gems get the credit they deserve.
+* Gem builders / plugin authors - see how many developers use your gem, which version etc.
+
+* Lowers the barrier for people to report what libraries they are using. It is 
+  potentially more informative than pure download stats.
+
+* Allows the system to make intelligent recommendations of plugins you may 
+  also be interested in / alternatives. (in the future)
+
+
+==Usage
+
+Run this on your development machine only. It's always best to set it to where you 
+develop your Rails application. Scanning for plugins may take a very long time
+if you have a large number projects.
+
+
+Standard operation:
+   toolparade 
+ 
+Help
+   toolparade help
+
+Setup 
+   toolparade setup
+
+Config  (views the config)
+   toolparade config
+
+Debug
+   toolparade debug
+
+== Tips
+
+Lets say you are working on a super top secret library and you don't want
+this to be published. 
+Just add it to the ignore section in your toolparade.yml config (usually
+located in your home directory):
+
+
+Example:
+
+
+   ignore:
+    gems: my_private_gem,CVS
+    plugins: my_secret_project
+
+
+If you know you don't really use a plugin / gem also feel free to use
+ignore list.
+
+
+==Limitations
+
+Removal of a gem or plugin is not currently reflected. 
+You need to remove it using the web based interface if desired.
+
+This is true in the case of ignore filters if the gem/plugin to ignore has
+already been registered in a previous scan. 
+
+Of course just because the plugin / gem is installed on your system is doesn't
+mean you are using it all the time if at all. Currently this tool doesn't
+make allowances for distinguishing this matter.
+There is however plenty of scope to improve the algorithms and scanning techniques
+in place. Feel free to drop me a line with suggestions.
+ 
+
+
+
+==History and credits
+
+For some time I've been toying with the idea of incorporating some kind
+of plugin/gem stats functionality into Working With Rails. 
+I had a feature branch I've been developing since January that did a basic scan
+of plugins (albeit crudely). I also had suggestions from other members
+of the community to do something similar so this spurred me on. 
+
+However I hadn't previously released this for fear of diluting the current people based
+focus of WWR. I'm not looking to turn it into a replacement plugin /gem directory
+as we already have places for that. 
+
+Some folks to thank:
+
+Johannes de Jong - Shows us your gems! suggestion
+http://workingwithrails.com/person/7426-johannes-de-jong
+
+and Mike Clark (for starting the topic)
+http://clarkware.com/cgi/blosxom/2007/02/10#GemSurvey
+
+Jeremy Kemper (Rails core team) - gem stats idea (pending further implementation)
+http://workingwithrails.com/person/5323-jeremy-kemper
+
+
+
+== Suggestions / Improvements
+
+This kind of thing ultimately only works if people use it. So it's up
+to you give it a try and spread the word. 
+
+Feel free to drop me a mail: mtsbtt @ googlemail.com
+or submit patches.
+
+I'm always open to suggestions and quick to implement when I get time.
+
+
+==About the Author
+
+Martin Sadler currently works for DSC a web consulting, hosting, web development
+and design firm based in London, UK. 
+
+He runs a blog at:
+* http://www.beyondthetype.com
+
+and also kick started and maintains the Working With Rails community site:
+* http://www.workingwithrails.com
+
+

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+Gem::manage_gems
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+PKG_FILES = FileList[
+  "Rakefile", "README","CHANGELOG",
+  "config/**/*",
+  "test/**/*",
+  "lib/**/*.rb",
+  "bin/**/*"
+]  
+  
+spec = Gem::Specification.new do |s| 
+  s.name = "ToolParade"
+  s.version = "0.0.2"
+  s.author = "Martin Sadler"
+  s.email = "mtsbtt@googlemail.com"
+  s.homepage = "http://beyondthetype.com/"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Get your tools out for parade"
+  s.files = PKG_FILES
+  s.require_path = "lib"
+  s.autorequire = "name"
+  s.test_files = FileList["{test}/**/*test.rb"].to_a
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README"]
+  s.executables = ['toolparade']
+  
+end
+
+# Genereate the RDoc documentation
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "Tool Parade"
+  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include(Dir.glob("lib/**/*.rb") )
+}
+
+
+Rake::GemPackageTask.new(spec) do |pkg| 
+  pkg.need_tar = true 
+end 
+
+task :default => "pkg/#{spec.name}-#{spec.version}.gem" do
+    puts "generated latest version"
+end
+

data/bin/toolparade

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+require 'toolparade'
+
+PROGRAM     = File::basename $0
+mode        = ARGV.shift
+@debug      = false 
+
+puts "Ruby and Rails Tool Parade"
+puts "=-=-=-=-=-=-=-=-=-=-=-=-=-"
+puts "\"#{PROGRAM} help\" for help"
+
+case mode
+when  %r/help/
+    puts File.open(File.expand_path(File.dirname(__FILE__) + "/../README")).read
+    exit
+when  %r/setup/
+     ToolParade.setup
+     exit
+when  %r/config/
+    @tp       =   ToolParade.new
+    puts "Reading config located in #{ToolParade::CONFIG}"
+    puts  @tp.config.to_yaml
+    exit
+when  %r/debug/
+    @debug = true
+end    
+
+@tp       =   ToolParade.new
+p @tp.config if @debug
+
+puts "Scanning system for: "
+print "Gems... "
+@tp.scan_for_gems
+p @tp.gemslist if @debug
+puts 'Done'
+puts "Plugins.. (this may take a while) "
+@tp.scan_for_plugins
+p @tp.pluginslist if @debug
+puts "Finished"
+
+@tp.view_scan
+
+@tp.get_login_credentials
+puts "Please wait. Authenticating and uploading...."
+@tp.upload
+puts "The result of your upload can be viewed at http://#{@tp.domain} from your profile page."
+puts "Thank you for using Tool Parade"

data/config/default.yml

@@ -0,0 +1,16 @@
+upload:
+  domain: workingwithrails.com
+  username:
+  password:
+    
+paths:
+  plugins: ~/dev;~/sandbox
+ 
+transmit:
+  gem_version_numbers: true
+  plugin_numbers: true
+
+# Regex's allowed e.g. prefix_*  
+ignore:
+  gems: my_private_gem,CVS
+  plugins: my_secret_project    

data/lib/toolparade.rb

@@ -0,0 +1,199 @@
+require 'fileutils'
+require 'yaml'
+require 'net/http'
+require 'uri'
+
+def Kernel.is_windows?
+   processor, platform, *rest = RUBY_PLATFORM.split("-")
+   platform == 'mswin32'
+end
+
+
+# See README for full documentation
+#
+#TODO: Room for some refactoring, perhaps use of exceptions in places (make it easier to catch and test desired behaviours)
+class ToolParade
+   # :stopdoc:
+   VERSION        = "0.0.1"
+   HOME           = ENV["HOME"] || ENV["HOMEPATH"] || File::expand_path("~")
+   CONFIG         = File::join HOME, ".toolparade.yml"
+   DEFAULT_CONFIG = File.expand_path("#{__FILE__}/../../config/default.yml")
+
+   # :startdoc:
+   attr_accessor :config
+   attr_reader :pluginslist
+   attr_reader :plugin_descriptions
+   
+   attr_reader :gemslist
+
+   attr_reader :username
+   attr_reader :password
+   attr_reader :domain
+
+   def initialize(options = {})
+      return if options[:skip]
+
+      begin
+         @config = YAML.load_file(CONFIG)
+      rescue Errno::ENOENT
+         puts "No configuration file detected. Entering first time setup."
+         puts
+         setup
+      end
+      @username            = @config['upload']['username']
+      @password            =  @config['upload']['password']
+      @domain              = @config['upload']['domain']
+      @plugin_descriptions = {}
+      
+   end
+
+   def self.setup
+      new(:skip => true).setup
+   end
+
+   def setup
+      puts "Enter the path where you develop your Rails applications."
+      puts "Separated by ; if there is more than one e.g. ~/dev;~/sandbox"
+      print "> Rails plugin scan path (#{HOME}): "
+      path = gets.chomp!
+      path = path == '' ? HOME : path
+      @config = YAML.load_file(DEFAULT_CONFIG)
+      @config['paths']['plugins'] = path
+      begin
+         open(CONFIG, "w") { |f| f.write @config.to_yaml }
+      rescue Errno::ENOENT
+         puts "Unable to open #{CONFIG} for writing."
+         exit
+      end
+      puts "SETUP COMPLETE. Configuration stored in: #{CONFIG}"
+      puts
+   end
+
+
+   def scan_for_gems
+      @gemslist = Kernel.is_windows?  ? `cmd /c gem list` : `gem list`
+      @gemslist =  "#{@gemslist.grep(/^[a-zA-Z]/)}\n"
+      remove_bracketed_info!(@gemlist) unless @config['transmit']['gem_version_numbers']
+      apply_ignore_filters!(@gemslist)
+   end
+
+
+   def scan_for_plugins
+       
+
+      scores =   Hash.new(0)
+      for path in @config['paths']['plugins'].split(';')
+         scanpath = File.expand_path(path.to_s.strip)
+         if FileTest.exist?(scanpath)
+
+            Dir["#{scanpath}/**/vendor/plugins/**"].each{|f| 
+                scores[File.basename(f)] += 1
+                readme = File.expand_path("#{f}/README")
+                if FileTest.exist?(readme)
+                   @plugin_descriptions[File.basename(f)] ||= File.open(readme).read
+                end
+            }
+         else
+            puts "Warning / Notice: Plugin scan path: #{path} cannot be read"
+         end
+      end
+      @pluginslist =  scores.collect{|name,score| "#{name} (#{score})"}.join("\n")+"\n"
+
+      remove_bracketed_info!(@pluginslist) unless @config['transmit']['plugin_numbers']
+      apply_ignore_filters!(@pluginslist)
+   end
+   
+   def view_scan
+      print "Would you like to review the list of plugins and gems details that will be uploaded before continuing? (Y/N): "
+      return unless gets =~ /y/i
+      print_gem_and_plugin_info
+      
+        puts "If you wish filter out certain results you may do so now by editing #{CONFIG}"
+        puts ""
+      
+      ok = false
+      
+      while !ok
+          
+          print "If you have modified the configuration file hit yes for your changes to take effect (Y/N): "
+      
+        
+         if gets =~ /y/i
+            @config = YAML.load_file(CONFIG)
+            remove_bracketed_info!(@pluginslist) unless @config['transmit']['plugin_numbers']
+            apply_ignore_filters!(@pluginslist)
+            remove_bracketed_info!(@gemlist) unless @config['transmit']['gem_version_numbers']
+            apply_ignore_filters!(@gemslist)
+            
+         end
+         print_gem_and_plugin_info
+         puts "Displayed are the results that will be now uploaded."
+         puts "You may go back and edit the configuration file some more or..."
+         print "If you are happy with the results hit yes. (Y/N:)" 
+         ok = true if gets =~ /y/i
+     end
+   end
+
+   def print_gem_and_plugin_info
+         puts "Gems Found"
+         puts "---------------------------------------"
+         puts @gemslist
+         puts "Plugins Found"
+         puts "---------------------------------------"
+         puts @pluginslist.split("\n").sort
+   end
+
+      def get_login_credentials
+         return if "#{@username}".strip.chomp != '' && "#{@password}".strip.chomp !=''
+
+         puts "Please login to Working With Rails to continue upload"
+         print "> Username: "
+         @username  = gets.chomp!
+         print "> Password:  "
+         @password  = get_password
+         puts ""
+
+      end
+
+      def upload
+         res = Net::HTTP.post_form(URI.parse("http://#{@domain}/rubygems/upload"),
+         {'login'=>@username, 'password'=>@password, 'list' => @gemslist})
+         puts "Gem upload response: #{res.body}"
+         
+         
+         post_fields = {'login'=>@username, 'password'=>@password, 'list' => @pluginslist}
+         @plugin_descriptions.each{|name, description| post_fields["readmes[#{name}]"] = description}
+         
+         res = Net::HTTP.post_form(URI.parse("http://#{@domain}/railsplugins/upload"),
+         post_fields)
+         puts "Plugin upload response: #{res.body}"
+      end
+
+
+      private
+
+      def get_password
+         if  Kernel.is_windows?
+            return gets.chomp!
+         else
+            # on a non-windows box we can hide input for the password
+            `stty -echo`
+            begin
+               out = STDIN.gets.chomp
+            ensure
+               `stty echo`
+            end
+            return out
+         end
+      end
+
+
+
+      def remove_bracketed_info!(string)
+         string.gsub!(/\([^\)]+\)/,'')
+      end
+
+      def apply_ignore_filters!(string)
+         string.gsub!(/#{config['ignore']['plugins'].split(',').collect{|i|   "^#{i.strip}.*\n"}.join('|')}/,'')
+      end
+   end

data/test/test_toolparade.rb

@@ -0,0 +1,32 @@
+require 'test/unit'
+require 'lib/toolparade'
+
+
+class TestToolParade < Test::Unit::TestCase
+
+   def setup
+       @tp       =   ToolParade.new
+       @tp.config['paths']['plugins']  = "#{File.expand_path(File.dirname(__FILE__))}/fixtures"
+   end
+
+   def test_plugin_path_scan
+      @tp.scan_for_plugins
+      assert_equal "acts_as_a (1)\nacts_as_b (1)\nacts_as_c (1)\n", @tp.pluginslist
+   end
+
+   def test_ignore_filters_for_plugin
+      @tp.config['ignore']['plugins'] = "acts_as_b,acts_as_c\n"
+      @tp.scan_for_plugins
+      assert_equal "acts_as_a (1)\n", @tp.pluginslist
+
+   end
+
+   def test_filter_version_numbers
+     @tp.config['transmit']['gem_version_numbers'] = false  
+     gemslist = "gem a (1.0)\ngem b (2.0)\ngem c (2.1,2.01)\n"
+     @tp.send('remove_bracketed_info!',gemslist)
+     assert_equal  "gem a \ngem b \ngem c \n", gemslist
+   end
+
+   
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: ToolParade
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+date: 2007-07-19 00:00:00 +01:00
+summary: Get your tools out for parade
+require_paths: 
+- lib
+email: mtsbtt@googlemail.com
+homepage: http://beyondthetype.com/
+rubyforge_project: 
+description: 
+autorequire: name
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Martin Sadler
+files: 
+- Rakefile
+- README
+- CHANGELOG
+- config/default.yml
+- test/fixtures
+- test/fixtures/vendor
+- test/fixtures/vendor/plugins
+- test/fixtures/vendor/plugins/acts_as_a
+- test/fixtures/vendor/plugins/acts_as_b
+- test/fixtures/vendor/plugins/acts_as_c
+- test/fixtures/vendor/plugins/acts_as_c/not_shown
+- test/test_toolparade.rb
+- lib/toolparade.rb
+- bin/toolparade
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: 
+- toolparade
+extensions: []
+
+requirements: []
+
+dependencies: []
+