jodosha-sashimi 0.1.5 → 0.2.1

data/CHANGELOG

@@ -1,3 +1,141 @@
+* Prepare for v0.2.1
+
+* CHANGELOG massive update
+
+* Use hardcoded file list for sashimi.gemspec
+
+* Give a more informative message when Svn or Git is not installed on the system
+
+* Make sure to load AbstractRepository first. [#15 state:resolved]
+
+* Print on stdout the name of the remote repository while executing Git Rake tasks
+
+* Created Git related Rake tasks
+
+* Created dist and clean Rake tasks
+
+
+
+* *v0.2.0*
+
+* Tagged v0.2.0
+
+* Prepare for v0.2.0
+
+* Ignored flunked test cases
+
+* Massive changelog
+
+* rdoc formatting
+
+* Using, where possible, @@class_variable and cattr_reader instead of class methods. Documentation improvements.
+
+* Don't try to remove the gem from working copy at the beginning of Rake install
+
+* Print plugin name when execute uninstall command
+
+* Aliased #cache_content with #list in order to clean up AbstractRepository from stdout formattin code. The code was moved to Commands::List
+
+* Clean up for #with_path in test_helper.rb
+
+* Removed with_path from #files_scheduled_for_add and #files_scheduled_for_remove because #update_versioned_rails_plugins already works in vendor/plugins
+
+* Removed unnecessary with_path statement from AbstractRepository#prepare_installation
+
+* Removed unnecessary with_path statement from AbstractRepository#remove_temp_folder
+
+* Removed unnecessary with_path statement from AbstractRepository#update_unversioned_rails_plugins
+
+* Removed with_path from #update_rails_plugins, because update command should be always executed from the root of a Rails app
+
+* Removed unnecessary with_path statement from AbstractRepository#copy_plugin_to_rails_app
+
+* Removed unnecessary with_path statement for AbstractRepository#write_to_cache
+
+* Remove builded gem from working copy, after rake install task
+
+* Don't generate rdoc and ri on Rake install
+
+* Fixed AbstractRepository#update_versioned_rails_plugins. Made AbstractRepository#temp_plugin_name public
+
+* Created install Rake task
+
+* Improved test coverage for AbstractRepository
+
+* Added AbstractRepository#temp_plugin_name
+
+* File#join -> Array#to_path or String#to_path. Code cleanup.
+
+* Improved tests for AbstractRepository cache and instantiation
+
+* Improved test coverage for AbstractRepository
+
+* Added tests for uninstall. Re-enabled tests.
+
+* Initial rewriting of test suite
+
+* Added String#to_path and Array#to_path
+
+* Added AbstractRepository#with_path in order to scopify current directory changes
+
+* Added block support to Class#class_method_proxy
+
+
+
+* *v0.1.7*
+
+* Tagged v0.1.7
+
+* Prepare for v0.1.7
+
+* Updated installation instructions in README
+
+* Automatic file lists for sashimi.gemspec
+
+
+
+* *v0.1.6*
+
+* Tagged v0.1.6
+
+* Prepare for v0.1.6
+
+* Massive changelog
+
+* Added rubyforge project reference to gemspec
+
+* Added sashimi*.gem to .gitignore
+
+* Removed AbstractRepository#cache_file, now uses cattr_accessor
+
+* Updated annotation for AbstractRepository public methods in test/test_helper.rb
+
+* Introduced Class#class_method_proxy in order to make available annotated class methods as private methods
+  
+  Example:
+    class Repository
+      def self.path
+        @@path
+      end
+    
+      class_method_proxy :path
+    end
+
+  Produces:
+    # Proxy method for <tt>Repository#path</tt>
+    def path
+      self.class.path
+    end
+    private :path
+
+* Improved tests for repositories system calls
+
+
+
+* *v0.1.5*
+
+* Tagged v0.1.5
+
 * Prepare for v0.1.5
 
 * Raise a PluginNotFound exception if try to update a not existent plugin for the current Rails app

data/README

@@ -1,78 +1,80 @@
-Sashimi
-=======
+= Sashimi
 
 Sashimi is a Rails plugins manager.
+
 It allows to install your favourite plugins in a local repository and add them to your Rails apps.
 The main goal is to allow the plugins offline installation.
 
 
 
-Installation
-============
+= Installation
+
+  $ (sudo) gem install sashimi
+
+or
 
-$ (sudo) gem install jodosha-sashimi --source=http://gems.github.com
+  $ (sudo) gem install jodosha-sashimi --source=http://gems.github.com
 
 
 
-Usage
-=====
+= Usage
 
 Install a plugin from a subversion URL:
-$ sashimi install http://dev.rubyonrails.com/svn/rails/plugins/continuous_builder
+  $ sashimi install http://dev.rubyonrails.com/svn/rails/plugins/continuous_builder
 
 Install a plugin from a git URL:
-$ sashimi install git://github.com/jodosha/click-to-globalize.git
+  $ sashimi install git://github.com/jodosha/click-to-globalize.git
 
 Uninstall a plugin:
-$ sashimi uninstall continuous_builder
+  $ sashimi uninstall continuous_builder
 
 Update a plugin:
-$ sashimi update click-to-globalize
+  $ sashimi update click-to-globalize
 
 Update a plugin of a Rails app:
-$ sashimi update --rails click-to-globalize
+  $ sashimi update --rails click-to-globalize
 
 NOTE: If your application is versioned with Svn or Git, Sashimi will automatically schedules for add/remove the added/removed files.
 
 List all installed plugins:
-$ sashimi list
+  $ sashimi list
 
 Add installed plugin(s) to a Rails app:
-$ sashimi add click-to-globalize
-$ sashimi install --rails click-to-globalize
+  $ sashimi add click-to-globalize
+or
+  $ sashimi install --rails click-to-globalize
 
 
 
-Known And Common Issues
-=======================
+= Known And Common Issues
 
 * When add a plugin to an app, make sure your current directory is the rails root.
 
 * Only Subversion and Git repositories are currently supported.
 
 
-Contribute
-==========
+= Contribute
 
 * Check out the code and test it:
+
   $ git clone git://github.com/jodosha/sashimi.git
+  
   $ rake
 
-* Create a ticket to: http://sushistar.lighthouseapp.com
+* Create a ticket to the {Sushistar Lighthouse page}[http://sushistar.lighthouseapp.com]
 
 * Create a patch and add as attachement to the ticket.
 
 
-Credits
-=======
+= Credits
 
 Partially inspired to RaPT[http://rapt.rubyforge.org/].
 
 
 
-Home Page
-=========
-http://lucaguidi.com/pages/sashimi
+= Home Page
+
+The Sashimi homepage is http://lucaguidi.com/pages/sashimi
 
 
 

data/Rakefile

@@ -1,7 +1,10 @@
+$:.unshift 'lib'
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
+repositories = %w( origin rubyforge )
+
 desc 'Default: run unit tests.'
 task :default => :test
 
@@ -20,3 +23,62 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc 'Build and install the gem (useful for development purposes).'
+task :install do
+  require 'sashimi'
+  system "gem build sashimi.gemspec"
+  system "sudo gem uninstall sashimi"
+  system "sudo gem install --local --no-rdoc --no-ri sashimi-#{Sashimi::VERSION::STRING}.gem"
+  system "rm sashimi-*.gem"
+end
+
+desc 'Build and prepare files for release.'
+task :dist => :clean do
+  require 'sashimi'
+  system "gem build sashimi.gemspec"
+  system "cd .. && tar -czf sashimi-#{Sashimi::VERSION::STRING}.tar.gz sashimi"
+  system "cd .. && tar -cjf sashimi-#{Sashimi::VERSION::STRING}.tar.bz2 sashimi"
+  system "cd .. && cp sashimi-* sashimi"
+end
+
+desc 'Clean the working copy from release files.'
+task :clean do
+  require 'sashimi'
+  version = Sashimi::VERSION::STRING
+  system "rm sashimi-#{version}.gem"     if File.exist? "sashimi-#{version}.gem"
+  system "rm sashimi-#{version}.tar.gz"  if File.exist? "sashimi-#{version}.tar.gz"
+  system "rm sashimi-#{version}.tar.bz2" if File.exist? "sashimi-#{version}.tar.bz2"
+end
+
+desc 'Show the file list for the gemspec file'
+task :files do
+  puts "Files:\n #{Dir['**/*'].reject {|f| File.directory?(f)}.sort.inspect}"
+  puts "Test files:\n #{Dir['test/**/*_test.rb'].reject {|f| File.directory?(f)}.sort.inspect}"
+end
+
+namespace :git do
+  desc 'Push local Git commits to all remote centralized repositories.'
+  task :push do
+    repositories.each do |repository|
+      puts "Pushing #{repository}...\n"
+      system "git push #{repository} master"
+    end
+  end
+  
+  desc 'Perform a git-tag'
+  task :tag do
+    puts "Please enter the tag name: "
+    tag_name = STDIN.gets.chomp
+    exit(1) if tag_name.nil? or tag_name.empty?
+    system "git tag -s #{tag_name}"
+  end
+  
+  desc 'Push all the tags to remote centralized repositories.'
+  task :push_tags do
+    repositories.each do |repository|
+      puts "Pushing tags to #{repository}...\n"
+      system "git push --tags #{repository}"
+    end
+  end
+end

data/lib/sashimi/commands.rb

@@ -125,6 +125,7 @@ module Sashimi
       def parse!(args)
         options.parse!(args)
         args.each do |name|
+          puts name.titleize + "\n"
           Plugin.new(name).uninstall
         end
       end
@@ -179,7 +180,10 @@ module Sashimi
       
       def parse!(args)
         options.parse!(args)
-        puts Plugin.list
+        output = Plugin.list.sort.collect do |plugin, contents|
+          "#{plugin}\t\t#{contents['summary']}"
+        end.join("\n")
+        puts output
       end
     end
 

data/lib/sashimi/core_ext/array.rb

@@ -0,0 +1,22 @@
+class Array
+  # Transform the current +Array+ to a path.
+  #
+  # It's an alias for <tt>File#join</tt>.
+  #
+  #    %w(path to app).to_path # => path/to/app+
+  #    %w(path to app).to_path(true) # => /Users/luca/path/to/app
+  def to_path(absolute = false)
+    path = File.join(self)
+    path = File.expand_path(path) if absolute
+    path
+  end
+
+  # Transform the current +Array+ to an absolute path.
+  #
+  #    %w(path to app).to_absolute_path # => /Users/luca/path/to/app
+  #    %w(path to app).to_abs_path # => /Users/luca/path/to/app
+  def to_absolute_path
+    to_path(true)
+  end
+  alias_method :to_abs_path, :to_absolute_path
+end

data/lib/sashimi/core_ext/class.rb

@@ -0,0 +1,31 @@
+class Class
+  # Dinamically creates a proxy for given class methods.
+  #
+  # Example:
+  # 
+  #   class Repository
+  #     def self.path
+  #       @@path
+  #     end
+  #   
+  #     class_method_proxy :path
+  #   end
+  #
+  # It produces:
+  #   # Proxy method for <tt>Repository#path</tt>
+  #   def path
+  #     self.class.path
+  #   end
+  #   private :path
+  def class_method_proxy(*method_names)
+    method_names.each do |m|
+      self.class_eval %{
+        # Proxy method for <tt>#{self.class.name}##{m}</tt>
+        def #{m}(*args, &block)
+          self.class.#{m}(*args, &block)
+        end
+        private :#{m}
+      }, __FILE__, __LINE__
+    end
+  end
+end

data/lib/sashimi/core_ext/string.rb

@@ -0,0 +1,13 @@
+class String
+  # Transform the current +String+ to a system path,
+  # according to the current platform file system.
+  #
+  #  "path/to/app".to_path # => path/to/app (on *nix)
+  #  "path/to/app".to_path # => path\to\app (on Windows)
+  #
+  #  "path/to/app".to_path(true) # => /Users/luca/path/to/app (on *nix)
+  #  "path/to/app".to_path(true) # => C:\path\to\app (on Windows)
+  def to_path(absolute = false)
+    self.split(/\/\\/).to_path(absolute)
+  end
+end

data/lib/sashimi/core_ext.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + '/core_ext/*.rb'].each{|f| require f}

data/lib/sashimi/plugin.rb

@@ -30,9 +30,8 @@ module Sashimi
     def repository #:nodoc:
       @repository ||= instantiate_repository
     end
-    
-    # Read the content of the <tt>about.yml</tt>.
-    # New feature of Rails 2.1.x http:://dev.rubyonrails.org/changeset/9098
+
+    # Returns the informations about the plugin.
     def about
       @about ||= repository.about
     end
@@ -52,7 +51,7 @@ module Sashimi
       name
     end
     
-    # Serialize the plugin to Hash format.
+    # Serialize the plugin to +Hash+ format.
     def to_hash
       { self.guess_name => 
         { 'type' => repository.scm_type,