rim 1.1.0 → 1.2.0

data/Changelog

@@ -1,7 +1,16 @@
-1.1.0 New tasks: git:tag and check_version
+1.2.0
+New tasks: install, uninstall, gem:install, gem:uninstall
+API extension: Rim.defaults and Rim.setup accept now a parameter in block and
+yield Rim.instance in this case.
 
-1.0.2 Fix typo in email
+1.1.0
+New tasks: git:tag and check_version
 
-1.0.1 First working public release
+1.0.2
+Fix typo in email
 
-1.0.0 First public release (yanked, because defect)
+1.0.1
+First working public release
+
+1.0.0
+First public release (yanked, because defect)

data/README.rdoc

@@ -1 +1,59 @@
-Rim - a simple project / gem manager
+== Rim a super simple ruby project / gem manager
+
+Goal is to have a project managing that just works on many Ruby
+versions as possible and is easy to extend. Feel free to dislike it. ;)
+
+=== Use for project management
+
+Minimal Rakefile:
+  require 'rim'
+  require 'rim/gem'
+  # require 'rim/...'
+
+  Rim.setup do
+    name 'My project'
+    authors 'me'
+    version '1.0.0'
+  end
+
+For advanced usuage have a look at the Rakefile of rim.
+
+
+=== Writing an extension
+
+* Extend the class Rim with +attr_accessors+ for new attributes if needed.
+* Set default values use +Rim.defaults+.
+* Define tasks with +Rim.after_setup+.
+
+A very simple example extension:
+  # require other extensions if neccessary
+
+  require 'rim/another_extension'
+
+  # Extend the class
+
+  class Rim
+    # Attribute for somewhat (default: 42)
+    attr_accessor :my_attr
+  end
+
+  # Setting default values
+
+  Rim.defaults do
+    my_attr 42
+  end
+
+  # Stuff to execute after setting the defaults and calling Rim.setup in Rakefile.
+  # Usual for defining tasks.
+
+  Rim.after_setup do
+    task :my_task => :another_task do
+      # stuff
+    end
+  end
+
+For more examples have a look at the tasks comming with rim in lib/rim/*.rb
+
+
+=== License
+MIT license, see file LICENSE.

data/Rakefile

@@ -0,0 +1,23 @@
+$:.unshift File.dirname(__FILE__) + '/lib'
+require 'rim'
+require 'rim/core'
+require 'rim/check_version'
+require 'rim/gem'
+require 'rim/git'
+require 'rim/info'
+require 'rim/irb'
+require 'rim/rdoc'
+require 'rim/test'
+
+Rim.setup do
+  name 'rim'
+  authors 'Jan Friedrich'
+  email 'janfri26@gmail.com'
+  homepage 'http://gitorious.org/rim'
+  version Rim::VERSION
+  summary 'A simple project / gem manager'
+  description <<-END
+Goal is to have a project managing that just works on many Ruby
+versions as possible and is easy to extend. Feel free to dislike it. ;)
+  END
+end

data/lib/rim/core.rb

@@ -3,13 +3,16 @@ class Rim
   # Name of the project / gem
   attr_accessor :name
 
-  # lib directory (default +lib+)
-  attr_accessor :lib_dir
-
   # Authors of the project / gem
   attr_accessor :authors
 
-  defaults do
-    lib_dir 'lib'
-  end
+  # Project / gem version
+  attr_accessor :version
+
+  # Paths for require to load the lib (default: <code>['lib']</code>
+  attr_accessor :require_paths
+end
+
+Rim.defaults do |r|
+  r.require_paths = ['lib']
 end

data/lib/rim/gem.rb

@@ -1,9 +1,7 @@
 # -- encoding: utf-8 --
+require 'rim/install'
 require 'rim/release'
 class Rim
-  # Gem version
-  attr_accessor :version
-
   # Project / gem description
   attr_accessor :description
 
@@ -16,12 +14,12 @@ class Rim
   # Project homepage
   attr_accessor :homepage
 
-  # Files included in the gem (default: <code>/^README/i, /^Changelog/i, /^COPYING/i, /^LICENSE/i, 'lib/**/*', 'test/**/*'</code>)
+  # Files included in the gem (default: <code>/^README/i, /^Changelog/i, /^COPYING/i, /^LICENSE/i, /^Rakefile/i, 'bin/*', 'lib/**/*', 'test/**/*'</code>)
   attr_accessor :gem_files
 end
 
 Rim.defaults do
-  gem_files filelist(/^README/i, /^Changelog/i, /^COPYING/i, /^LICENSE/i, 'lib/**/*', 'test/**/*')
+  gem_files filelist(/^README/i, /^Changelog/i, /^COPYING/i, /^LICENSE/i, /^Rakefile/i, 'bin/*', 'lib/**/*', 'test/**/*')
 end
 
 Rim.after_setup do
@@ -35,6 +33,9 @@ Rim.after_setup do
   end
 
   if klass
+    task :gem do
+      puts "Building #{name}-#{version}.gem"
+    end
     spec = Gem::Specification.new do |s|
       s.authors = authors
       s.email = email
@@ -44,7 +45,7 @@ Rim.after_setup do
       s.name = name
       s.summary = summary
       s.version = version
-      s.require_path = lib_dir
+      s.require_paths = require_paths
       s.files = gem_files
     end
 
@@ -52,14 +53,23 @@ Rim.after_setup do
     end
 
     namespace :gem do
+      gem_filename = format('%s/%s.gem', task_object.package_dir, task_object.name)
       desc 'Push the gem to rubygems.org'
       task :push => [:clean, :test, :gem] do
-        gem_filename = format('%s/%s.gem', task_object.package_dir, task_object.name)
-        puts "Push #{gem_filename} to rubygems.org"
         sh "gem push #{gem_filename}"
       end
+      desc "Install #{gem_filename}"
+      task :install => :gem do
+        sh "gem install #{gem_filename}"
+      end
+      desc "Uninstall gem #{name} version #{version}"
+      task :uninstall do
+        sh "gem uninstall --version #{version} #{name}"
+      end
     end
     task :release => :gem
+    task :install => 'gem:install'
+    task :uninstall => 'gem:uninstall'
   end
 
 end

data/lib/rim/git.rb

@@ -11,8 +11,15 @@ Rim.after_setup do
         puts cmd
         sh cmd
       end
+      desc 'Check if git tree is clean'
+      task :check do
+        res = `git status`
+        if res !~ /nothing to commit/
+          raise 'Git tree is not clean'
+        end
+      end
     end
-    task :release do
+    task :release => 'git:check' do
       invoke 'git:tag'
     end
   end

data/lib/rim/install.rb

@@ -0,0 +1,8 @@
+require 'rim'
+Rim.after_setup do
+  desc 'Install the project'
+  task :install
+
+  desc 'Uninstall the project'
+  task :uninstall
+end

data/lib/rim/irb.rb

@@ -2,6 +2,7 @@
 Rim.after_setup do
   desc 'Start an irb session an loading lib'
   task :irb do
-    exec "irb -I #{lib_dir} -r #{name}"
+    i_params = Array(require_paths).map {|e| '-I ' << e}.join(' ')
+    sh "irb #{i_params} -r #{name}"
   end
 end

data/lib/rim.rb

@@ -3,10 +3,13 @@ require 'rake'
 require 'rake/clean'
 require 'singleton'
 
-# Rim a super simple ruby project / gem manager
+# == Rim a super simple ruby project / gem manager
+#
+# Goal is to have a project managing that just works on many Ruby
+# versions as possible and is easy to extend. Feel free to dislike it. ;)
 class Rim
 
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 
   begin
     require 'rake/dsl_definition'
@@ -16,14 +19,28 @@ class Rim
   include Singleton
 
   # Setting the default values of attributes. Useful when writing Rim extensions.
+  # The block is evaluated in Rim.instance when no parameter is used.
+  # Otherwise the method yields Rim.instance.
   def self.defaults(&blk)
-    Rim.instance.instance_eval &blk
+    rim = Rim.instance
+    if blk.arity == 0
+      rim.instance_eval &blk
+    else
+      yield rim
+    end
   end
 
   # Setting up Rim. This method is usual used in Rakefiles to setting the project specific
   # values of the Rim instance.
+  # The block is evaluated in Rim.instance when no parameter is used.
+  # Otherwise the method yields Rim.instance.
   def self.setup(&blk)
-    Rim.instance.instance_eval &blk
+    rim = Rim.instance
+    if blk.arity == 0
+      rim.instance_eval &blk
+    else
+      yield rim
+    end
     execute_definitions
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rim
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,13 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-12 00:00:00.000000000 Z
+date: 2011-09-15 00:00:00.000000000 Z
 dependencies: []
-description: ! "    Goal is to have a project managing that just works on many Ruby\n
-  \   versions as possible and is easy to extend. Feel free to dislike it. ;)\n"
+description: ! 'Goal is to have a project managing that just works on many Ruby
+
+  versions as possible and is easy to extend. Feel free to dislike it. ;)
+
+'
 email: janfri26@gmail.com
 executables: []
 extensions: []
@@ -21,11 +24,13 @@ files:
 - README.rdoc
 - Changelog
 - LICENSE
+- Rakefile
 - lib/rim/check_version.rb
 - lib/rim/core.rb
 - lib/rim/gem.rb
 - lib/rim/git.rb
 - lib/rim/info.rb
+- lib/rim/install.rb
 - lib/rim/irb.rb
 - lib/rim/rdoc.rb
 - lib/rim/release.rb