rim 1.9.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73ae1a69fd80fb16e51ea6591de4d35e731ef022
-  data.tar.gz: 40e8becdef14a4ec449fcd096c01f3c597fb4b0f
+  metadata.gz: 4e36d2436b1aa607d1c650ad7ccc4307cd6d7863
+  data.tar.gz: 3e50060fb3e55f52fa12d75b59b71f9ee8a0f57e
 SHA512:
-  metadata.gz: d175c0234b96627e4357a23fa995c79697cb962fb40f2d0268f5b4baee5772c4a690577dde57b7b99df2345d0ddba8850506e1e27c0ec08e5d4196164100d17e
-  data.tar.gz: 23f427eb60ef787e28bc988c8a95a817e8f079984e50dac37b215e20b4df54db36190578e79402adb7c6a22cb7c5d3db86c9bcdd39c1be527165f606bd1d919d
+  metadata.gz: 3744ff51d7fcd3e4233d41b0b2d89d9418607cb7d1778d6952e085111bb5c7cdcb7058dfbba3f0c449843bf342b79b53b492e127bac02f941cd16f88cb8d0cad
+  data.tar.gz: accf9d5582c9dc6b7ba3baa97ed0d3748fdad8384427e0f3a99cc554e7a0d8009501b9f74d3a3d1cafea54c49d70e476973face9d0415dbe481dae50d7045642

data/Changelog

@@ -1,3 +1,12 @@
+2.0.0
+Using gem standard to describe versions in dependencies,
+this breaks backwards compatibility.
+New rake tasks aspell:check and regtest.
+Restructuring internals using
+Rim#feature_loaded? instead of require to describe
+dependencies between modules.
+Optimizing some internals.
+
 1.9.0
 New Rake task aspell.
 Fix typos and improve some internals.
@@ -14,14 +23,14 @@ New option license for gem tasks.
 1.7.0
 Remove option git_remotes for git_push_commands.
 This brings a much more flexible way to do things
-in git:push. PLease update your ~/.rimrc if
+in git:push. Please update your ~/.rimrc if
 necessary.
 Adding support for local .rimrc files. Now ~/.rimrc
 is first loaded if it exists and then .rimrc is
 loaded if it exists.
 
 1.6.2
-Make git tasks independant from current
+Make git tasks independent from current
 locale and push tags.
 
 1.6.1

data/README.rdoc

@@ -11,7 +11,7 @@ Minimal Rakefile:
   # require 'rim/...'
 
   Rim.setup do
-    name 'My project'
+    name 'my_project'
     authors 'me'
     version '1.0.0'
   end

data/Rakefile

@@ -4,7 +4,10 @@ require 'rim/aspell'
 require 'rim/check_version'
 require 'rim/gem'
 require 'rim/git'
+require 'rim/info'
 require 'rim/rdoc'
+require 'rim/regtest'
+require 'rim/release'
 require 'rim/test'
 
 Rim.setup do
@@ -19,4 +22,5 @@ Rim.setup do
 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
+  development_dependencies << 'regtest'
 end

data/lib/rim/aspell.rb

@@ -1,8 +1,6 @@
 # -- encoding: utf-8 --
-require 'rim/release'
-
 class Rim
-  # Files to check via aspell (default: /^README/i)
+  # Files to check via aspell (default: /^README/i, /^Changelog/i)
   attr_accessor :aspell_files
 
   # Language for aspell (default: 'en')
@@ -10,7 +8,7 @@ class Rim
 end
 
 Rim.defaults do
-  aspell_files filelist(/^README/i)
+  aspell_files filelist(/^README/i, /^Changelog/i)
   aspell_lang 'en'
 end
 
@@ -21,4 +19,19 @@ Rim.after_setup do
       sh "aspell -c -x -l #{aspell_lang} #{fn}"
     end
   end
+  namespace :aspell do
+    desc 'Test if there are no spellcheck errors'
+    task :check do
+      error_files = []
+      aspell_files.each do |fn|
+        unless `aspell list -l #{aspell_lang} < #{fn}`.empty?
+          error_files << fn
+        end
+      end
+      fail "There are spelling errors in #{error_files.join(', ')}" unless error_files.empty?
+    end
+  end
+  if feature_loaded? 'rim/release'
+    task :release => 'aspell:check'
+  end
 end

data/lib/rim/check_version.rb

@@ -1,5 +1,4 @@
 # -- encoding: utf-8 --
-require 'rim/release'
 Rim.after_setup do
   changelog = filelist(/^Changelog/i).first
   desc "Check version in #{changelog} with Rim#version."
@@ -9,11 +8,13 @@ Rim.after_setup do
   end
   if line =~ /^(\d+\.\d+(?:\.\d+)+)/
     if $1 != version
-      raise "Version error (#{changelog}: #$1, setup: #{version})"
+      fail "Version error (#{changelog}: #$1, setup: #{version})"
     end
   else
-    raise "No version information in #{changelog}"
+    fail "No version information in #{changelog}"
   end
   end
-  task :release => :check_version
+  if feature_loaded? 'rim/release'
+    task :release => :check_version
+  end
 end

data/lib/rim/gem.rb

@@ -1,6 +1,4 @@
 # -- encoding: utf-8 --
-require 'rim/install'
-require 'rim/release'
 class Rim
   # Project / gem description
   attr_accessor :description
@@ -20,7 +18,10 @@ class Rim
   # 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
 
-  # Dependencies for development (default: <code>["rim ~> #{Rim::VERSION.split(/\./)[0..1].join('.')}"]</code>)
+  # Dependencies of the gem
+  attr_accessor :dependencies
+
+  # Dependencies for development (default: <code>[%W(rim ~>#{Rim::VERSION.split(/\./)[0..1].join('.')})]</code>)
   attr_accessor :development_dependencies
 
   # Required Ruby version
@@ -35,7 +36,7 @@ end
 
 Rim.defaults do
   gem_files filelist(/^README/i, /^Changelog/i, /^COPYING/i, /^LICENSE/i, /^Rakefile/i, 'bin/*', 'lib/**/*', 'test/**/*')
-  development_dependencies ["rim ~> #{Rim::VERSION.split(/\./)[0..1].join('.')}"]
+  development_dependencies [%W(rim ~>#{Rim::VERSION.split(/\./)[0..1].join('.')})]
   requirements []
 end
 
@@ -53,6 +54,7 @@ Rim.after_setup do
     task :gem do
       puts "Building #{name}-#{version}.gem"
     end
+
     spec = Gem::Specification.new do |s|
       s.authors = authors
       s.email = email
@@ -68,33 +70,39 @@ Rim.after_setup do
       s.required_ruby_version = ruby_version if ruby_version
       s.post_install_message = install_message
       s.requirements = Array(requirements)
-      Array(development_dependencies).each do |depend|
-        g, v = depend.split(' ', 2)
-        s.add_development_dependency *[g, v]
+      Array(dependencies).each do |dep|
+        s.add_dependency *Array(dep)
+      end
+      Array(development_dependencies).each do |dep|
+        s.add_development_dependency *Array(dep)
       end
     end
 
     task_object = klass.new(spec) do |pkg|
     end
 
+    gem_filename = format('%s/%s.gem', task_object.package_dir, task_object.name)
+
     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
+      task :push => :gem do
         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'
+
+    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
+
+    if feature_loaded? 'rim/release'
+      task :release => :gem
+    end
   end
 
 end

data/lib/rim/git.rb

@@ -1,6 +1,4 @@
 # -- encoding: utf-8 --
-require 'rim/release'
-
 class Rim
   # Git push commands (default: <tt>['--tags origin master']</tt>)
   attr_accessor :git_push_commands
@@ -23,7 +21,7 @@ Rim.after_setup do
       task :check do
         res = `git status --porcelain`
         unless res.empty?
-          raise 'Git tree is not clean'
+          fail 'Git tree is not clean'
         end
       end
       desc 'Push master to git remotes'
@@ -33,8 +31,10 @@ Rim.after_setup do
         end
       end
     end
-    task :release => 'git:check' do
-      invoke 'git:tag'
+    if feature_loaded? 'rim/release'
+      task :release => 'git:check' do
+        invoke 'git:tag'
+      end
     end
   end
 end

data/lib/rim/regtest.rb

@@ -0,0 +1,2 @@
+# -- encoding: utf-8 --
+require 'regtest/task'

data/lib/rim/release.rb

@@ -1,7 +1,8 @@
 Rim.after_setup do
-  task :release
-    desc "Release version #{version}"
-    task :release => [:clean, :test] do
+  desc "Release version #{version}"
+  task :release do
+    if feature_loaded? 'rim/gem'
       invoke 'gem:push'
     end
+  end
 end

data/lib/rim/test.rb

@@ -20,5 +20,12 @@ Rim.after_setup do
       t.libs << test_require_paths
     end
     task :default => :test
+
+    if feature_loaded? 'rim/gem'
+      prepend_dep :test, :gem
+    end
+    if feature_loaded? 'rim/release'
+      prepend_dep :test, :release
+    end
   end
 end

data/lib/rim.rb

@@ -9,7 +9,7 @@ require 'singleton'
 # versions as possible and is easy to extend. Feel free to dislike it. ;)
 class Rim
 
-  VERSION = '1.9.0'
+  VERSION = '2.0.0'
 
   begin
     require 'rake/dsl_definition'
@@ -72,6 +72,17 @@ class Rim
     res
   end
 
+  # Helper method to check if a module is already required
+  # Example: feature_loaded?('rim/release')
+  def feature_loaded? name
+    ! $LOADED_FEATURES.grep(%r(/#{name}\.rb$)).empty?
+  end
+
+  # Helper method to prepend dependencies of tasks
+  def prepend_dep dep, t
+    task(t).prerequisites.unshift(dep)
+  end
+
   private
 
   def self.attr_accessor attr
@@ -92,4 +103,4 @@ class Rim
 end
 
 require 'rim/core'
-require 'rim/rimrc'
+require 'rim/rimrc' unless ENV['SELFTEST']

data/test/test_helper_methods.rb

@@ -8,19 +8,41 @@ class TestHelperMethods < Test::Unit::TestCase
     attr_accessor :some_new_attr
   end
 
+  def setup
+    @rim = Rim.instance
+  end
+
   def test_attr_accessor
-    rim = Rim.instance
-    assert_nil rim.some_new_attr, 'New attribute must be nil.'
-    rim.some_new_attr = :standard_setter
-    assert_equal :standard_setter, rim.some_new_attr
-    rim.some_new_attr :advanced_setter
-    assert_equal :advanced_setter, rim.some_new_attr
+    assert_nil @rim.some_new_attr, 'New attribute must be nil.'
+    @rim.some_new_attr = :standard_setter
+    assert_equal :standard_setter, @rim.some_new_attr
+    @rim.some_new_attr :advanced_setter
+    assert_equal :advanced_setter, @rim.some_new_attr
   end
 
   def test_filelist
-    rim = Rim.instance
-    fl = rim.filelist(/^rakefile/i, 'lib')
+    fl = @rim.filelist(/^rakefile/i, 'lib')
     assert_equal %w(Rakefile lib), fl.to_a
   end
 
+  def test_feature_loaded
+    assert_equal false, @rim.feature_loaded?('et/http')
+    assert_equal false, @rim.feature_loaded?('net/htt')
+    assert_equal false, @rim.feature_loaded?('net/http')
+    require 'net/http'
+    assert_equal false, @rim.feature_loaded?('et/http')
+    assert_equal false, @rim.feature_loaded?('net/htt')
+    assert_equal true, @rim.feature_loaded?('net/http')
+  end
+
+  require 'rake'
+  require 'rake/dsl_definition'
+  include Rake::DSL
+
+  def test_prepend_dep
+    t = task :a => :b
+    @rim.prepend_dep :c, :a
+    assert_equal [:c, :b], task(:a).prerequisites.map {|e| e.to_sym}
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rim
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rim
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: regtest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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. ;)
@@ -43,10 +57,10 @@ files:
 - lib/rim/gem.rb
 - lib/rim/git.rb
 - lib/rim/info.rb
-- lib/rim/install.rb
 - lib/rim/irb.rb
 - lib/rim/pry.rb
 - lib/rim/rdoc.rb
+- lib/rim/regtest.rb
 - lib/rim/release.rb
 - lib/rim/rimrc.rb
 - lib/rim/ripl.rb

data/lib/rim/install.rb

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