rim 2.17.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b15a2c430c7e1478514a923b3038b691a1e6c6526b690d9de84c1b58dc7a493
-  data.tar.gz: 3fbce8caf9392280e75151bddf849235a66d9b786896d2790b86a4fb9b56c109
+  metadata.gz: 4d6a9301cf2bd657059f0a2d0f52b1f68493e3c331e4dcd4adbcd3bfad6e6763
+  data.tar.gz: 980272cd29d0b3d336ebfbbad3dbf584d01c24f2afc88723f58ac14199b3b9a6
 SHA512:
-  metadata.gz: ec68de807803ce8f7371abd0fb5678155ed2d068f2a27f2b93613e631ebcb33dc3f9b9551c3e1c39c949aecf6248320023196f3fcb985cc22ae70f0476649bd2
-  data.tar.gz: 5a2ee73639871ac1c3b4cbdf7888db9a5805214df7bbd57059db2a40ca6f58ab28ba976fc180400ccef4e6cc2f18465925960641ae3bd82f1ccf91f5506b584a
+  metadata.gz: 86195c13a7382bcf6db85f64feb0d7e16843c847d44e4e9662bc5f6cc5b4f5b5e66bee0c963b4fdc2d3314c386ce0c6329a380d4a947ec9bfbb7febac8cf65be
+  data.tar.gz: 79af1f0eab514667c317eec3d86d6a7d916dbf15e6d3972d1d1ad193f375b3c85a3a387499246f7c54f78572b333b056b661eeecc5d09a41524f0a9fe9ae3ed8

data/Changelog

@@ -1,3 +1,16 @@
+3.0.0
+In older versions of rim the gemspec file was generated by rim from values
+defined in Rim.setup in Rakefile.  Now it is the other way around: all values
+which could be defined in the gemspec file must be defined there.  Therefore
+all according accessor methods are no longer relevant. Rim emits a warning
+when such a method is called and does not use these values any longer. It is
+necessary to set those in the gemspec file.
+
+There is also added a new Rake task gem:files.
+
+2.18.0
+Add new accessors Rim#bindir and Rim#executables to gem plugin.
+
 2.17.1
 Remove superfluous calls of public and private to suppress warnings in newer
 Ruby versions.

data/README.md

@@ -0,0 +1,111 @@
+# 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
+
+Since rim version 3.0.0 it is necessary to create a gemspec file with the basic
+configuration of the project. See [online
+documentation](https://guides.rubygems.org/specification-reference/) for more
+information. The rest is done in Rakefile.
+
+Example of a minimal Rakefile:
+
+```ruby
+require 'rim'
+require 'rim/gem'
+# require 'rim/...'
+
+Rim.setup do
+  # set up things of necessary
+end
+```
+
+For advanced usage have a look at the Rakefile of rim.
+
+
+## Upgrading from Rim before version 3.0.0
+
+In rim before 3.0.0 the gemspec file was generated by rim from values defined
+in <code>Rim.setup</code> in Rakefile.  Now it is the other way around: all
+values which could be defined in the gemspec file must be defined there.
+Therefore all according accessor methods are no longer relevant. Rim emits a
+warning when such a method is called and <em>does not</em> use these values any
+longer. It is necessary to set those in the gemspec file.
+
+
+## Writing an extension
+
+* Extend the class Rim with <code>attr_accessors</code> for new attributes if needed.
+* Set default values use <code>Rim.defaults</code>.
+* Define tasks with <code>Rim.after_setup</code>.
+
+A very simple example extension:
+
+```ruby
+# require other extensions if necessary
+
+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 coming with rim in <code>lib/rim/*.rb</code>
+
+
+## Similar projects
+
+* https://github.com/seattlerb/hoe
+* https://github.com/evan/echoe
+
+
+## Credits
+
+<em>Jim Weirich</em> For written the great Rake. (Sad that he is already gone.)
+
+<em>Ryan Davis</em> and <em>Evan Weaver</em> For their inspirations in Hoe respectively Echoe.
+
+
+## Contribution
+
+The code is also hosted in a git repository at [github](http://github.com/janfri/rim) and [bitbucket](https://bitbucket.org/janfri/rim)
+
+Feel free to contribute!
+
+
+## Versioning
+
+Rim follows [Semantic Versioning](https://semver.org/), both SemVer and
+SemVerTag.
+
+
+## Author
+
+Jan Friedrich <janfri26@gmail.com>
+
+
+## License
+
+MIT-style license, see file LICENSE.

data/lib/rim/aspell.rb

@@ -1,4 +1,6 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 class Rim
   # Encoding of spell checked files (default: 'UTF-8')
   attr_accessor :aspell_encoding
@@ -51,7 +53,4 @@ Rim.after_setup do
     task :prepare_release => 'aspell:check'
     task :release => 'aspell:check'
   end
-  if feature_loaded? 'rim/gem'
-    gem_files << aspell_word_list
-  end
 end

data/lib/rim/check_version.rb

@@ -1,4 +1,6 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 Rim.after_setup do
   task :check_version do
     fail "Task check_version is obsolete, use version:check!"

data/lib/rim/gem.rb

@@ -1,128 +1,49 @@
-# -- encoding: utf-8 --
-class Rim
-  # Project / gem description
-  attr_accessor :description
-
-  # Project / gem summary
-  attr_accessor :summary
-
-  # E-Mail address
-  attr_accessor :email
-
-  # License imformation
-  attr_accessor :licenses
-
-  # Project homepage
-  attr_accessor :homepage
-
-  # Files included in the gem (default: <code>/^README/i, /^Changelog/i, /^COPYING/i, /^LICENSE/i, /^Rakefile/i, /^Gemfile$/, '*.gemspec', 'bin/*', 'lib/**/*', 'test/**/*'</code>)
-  attr_accessor :gem_files
-
-  # Dependencies of the gem
-  attr_accessor :dependencies
-
-  # Dependencies for development (default: <code>['rake', %W(rim ~>#{Rim::VERSION.scan(/[^.]+\.[^.]+/).first})]</code>)
-  attr_accessor :development_dependencies
-
-  # Required Ruby version
-  attr_accessor :ruby_version
-
-  # Installation message
-  attr_accessor :install_message
-
-  # Requirements (external to rubygems)
-  attr_accessor :requirements
-
-  alias license licenses
-  alias license= licenses=
-
-  protected
-
-  def gem_spec
-    spec = Gem::Specification.new do |s|
-      s.authors = authors
-      s.email = email
-      s.platform = Gem::Platform::RUBY
-      s.description = description
-      s.license = license if license
-      s.homepage = homepage
-      s.name = name
-      s.summary = summary
-      s.version = version
-      s.require_paths = Array(require_paths)
-      s.files = Array(gem_files)
-      s.required_ruby_version = ruby_version if ruby_version
-      s.post_install_message = install_message
-      s.requirements = Array(requirements)
-      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
-    disclaimer = <<-END
-    #
-    # This file is automatically generated by rim.
-    # PLEASE DO NOT EDIT IT DIRECTLY!
-    # Change the values in Rim.setup in Rakefile instead.
-
-    END
-    disclaimer.gsub!(/^\s+/, '')
-    spec_string = spec.to_ruby.gsub(/([)>"])\.freeze\b/, '\1')
-    spec_string.sub(/^$/, disclaimer)
-  end
-
-  def gemspec_file
-    "#{name}.gemspec"
-  end
-
-end
-
-Rim.defaults do
-  gem_files filelist(/^README/i, /^Changelog/i, /^COPYING/i, /^LICENSE/i, /^Rakefile/i, /^Gemfile$/, '*.gemspec', 'bin/*', 'lib/**/*', 'test/**/*')
-  dependencies []
-  development_dependencies ['rake',%W(rim ~>#{Rim::VERSION.scan(/[^.]+\.[^.]+/).first})]
-  requirements []
-end
+# encoding: utf-8
+require_relative '../rim'
 
 Rim.after_setup do
 
   require 'rubygems/package'
 
-  gem_file = "pkg/#{name}-#{version}.gem"
+  directory PKG_DIR = 'pkg'
 
-  directory 'pkg'
+  name = gemspec.name
+  version = gemspec.version
+  gem_file = File.join(PKG_DIR, "#{name}-#{version}.gem")
 
-  CLOBBER.include(FileList['pkg'].existing)
+
+  CLOBBER.include(FileList[PKG_DIR].existing)
 
   desc "Build the gem file #{gem_file}"
   task :gem => 'gem:build'
 
   namespace :gem do
 
-    file gem_file => ['pkg', gemspec_file] do
-      sh "gem build #{gemspec_file}"
-      mv File.basename(gem_file), 'pkg'
+    file gem_file => [PKG_DIR, gemspec_file] + gemspec.files do
+      sh "gem build #{gemspec_file} -o #{gem_file}"
+    end
+
+    if feature_loaded? 'rim/test'
+      task :build => [:test, gem_file]
+    else
+      task :build => [gem_file]
     end
 
-    task :build => [:spec, :test, gem_file]
+    desc "Show files included and files not included in gem"
+    task :files do
+      gemspec_files = gemspec.files
+      all_files = filelist('**/*') + filelist('**/.*')
+      all_files.select! {|fn| File.file?(fn)}
+      puts '===== Files included in gem =====', gemspec_files.sort.join("\n")
+      puts
+      puts '=== Files NOT included in gem ===', (all_files - gemspec_files).sort.join("\n")
+    end
 
     desc "Push the gem #{name} version #{version} to rubygems.org"
     task :push => :gem do
       sh "gem push #{gem_file}"
     end
 
-    gem_files_without_gemspec = gem_files.clone
-    gem_files_without_gemspec.exclude('*.gemspec')
-    file gemspec_file => gem_files_without_gemspec do
-      gem_files << gemspec_file
-      File.write(gemspec_file, gem_spec)
-    end
-
-    desc "Generate #{gemspec_file}"
-    task :spec => gemspec_file
-
   end
 
   desc "Install version #{version}"

data/lib/rim/gemspec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+class Rim
+
+  # Deprecate accessors of older Rim versions (< 3.0)
+  %w(author authors bindir dependencies description development_dependencies email executables gem_files homepage install_message license name require_paths requirements ruby_version summary version).each do |attr|
+    define_method attr do |*args|
+      warn "WARNING: Rim accessor #{attr} is not longer supported, define the value in #{gemspec_file}"
+      []
+    end
+    alias_method "#{attr}=", attr
+  end
+
+  def gemspec_file
+    @gemspec_file ||= Dir['*.gemspec'].first or fail 'no gemspec file found'
+  end
+
+  def gemspec
+    @gemspec ||= eval(File.read(gemspec_file), binding, gemspec_file)
+  end
+
+end

data/lib/rim/git.rb

@@ -1,4 +1,6 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 class Rim
   # Git push commands (default: <tt>['--tags origin master']</tt>)
   attr_accessor :git_push_commands
@@ -10,7 +12,7 @@ end
 
 Rim.after_setup do
   if File.exist?('.git') && File.directory?('.git')
-    tag_name = "v#{version}"
+    tag_name = "v#{gemspec.version}"
     namespace :git do
       desc "Create git tag #{tag_name}"
       task :tag do
@@ -34,9 +36,6 @@ Rim.after_setup do
     if feature_loaded? 'rim/gem'
       task 'gem:push' => 'git:check'
       task 'git:tag' => 'gem:push'
-      if feature_loaded? 'rim/release'
-        task :release => 'gem:spec'
-      end
     end
     if feature_loaded? 'rim/release'
       task :release => %w(git:check git:tag)

data/lib/rim/info.rb

@@ -1,4 +1,6 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 Rim.after_setup do
   desc 'Prints informations about the Rim object.'
   task :info do

data/lib/rim/irb.rb

@@ -1,19 +1,20 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 class Rim
   # Required files for irb (default: Rim#name)
   attr_accessor :irb_requires
 end
 
-# Use Rim.after_setup because name in not yet set
-# in Rim.defaults
+# Use Rim.after_setup because gemspec may not yet be set in Rim.defaults
 Rim.after_setup do |r|
-  r.irb_requires ||= r.name
+  r.irb_requires ||= r.gemspec.name
 end
 
 Rim.after_setup do
   desc 'Start an irb session and loading lib'
   task :irb do
-    i_params = Array(require_paths).map {|e| '-I ' << e}.join(' ')
+    i_params = Array(gemspec.require_paths).map {|e| '-I ' << e}.join(' ')
     r_params = Array(irb_requires).map {|e| '-r ' << e}.join(' ')
     sh "irb #{i_params} #{r_params}"
   end

data/lib/rim/pry.rb

@@ -1,8 +1,10 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 Rim.after_setup do
   desc 'Start a pry session and loading lib'
   task :pry do
-    i_params = Array(require_paths).map {|e| '-I ' << e}.join(' ')
-    sh "pry #{i_params} -r #{name}"
+    i_params = Array(gemspec.require_paths).map {|e| '-I ' << e}.join(' ')
+    sh "pry #{i_params} -r #{gemspec.name}"
   end
 end

data/lib/rim/rdoc.rb

@@ -1,4 +1,6 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 class Rim
   # Directory for rdoc output
   attr_accessor :rdoc_dir

data/lib/rim/regtest.rb

@@ -1,4 +1,6 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 require 'regtest/task'
 
 class Rim
@@ -21,18 +23,6 @@ Rim.defaults do
 end
 
 Rim.after_setup do
-  if feature_loaded? 'rim/gem'
-    self.gem_files += regtest_files
-    unless development_dependencies.flatten.include? 'regtest'
-      begin
-        require 'regtest/version'
-        v = Regtest::VERSION.sub(/\.\d+(?:\.?\w+)?$/, '')
-        development_dependencies << %W(regtest ~>#{v})
-      rescue LoadError
-        development_dependencies << %w(regtest ~>1.0)
-      end
-    end
-  end
   if regtest_files_rb != REGTEST_FILES_RB
     (::REGTEST_FILES_RB.clear << regtest_files_rb).flatten!
   end

data/lib/rim/release.rb

@@ -1,5 +1,8 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 Rim.after_setup do
+  version = gemspec.version
   if version
     desc "Prepare release version #{version}"
   end

data/lib/rim/rimrc.rb

@@ -1,4 +1,4 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
 
 # Load ~/.rimrc if it exists
 home = if Dir.respond_to? :home

data/lib/rim/ripl.rb

@@ -1,8 +1,10 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 Rim.after_setup do
   desc 'Start a ripl session and loading lib'
   task :ripl do
-    i_params = Array(require_paths).map {|e| '-I ' << e}.join(' ')
-    sh "ripl #{i_params} -r #{name}"
+    i_params = Array(gemspec.require_paths).map {|e| '-I ' << e}.join(' ')
+    sh "ripl #{i_params} -r #{gemspec.name}"
   end
 end

data/lib/rim/rspec.rb

@@ -1,4 +1,6 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 class Rim
   # RSpec files (default: <code>'spec/**/*.rb')</code>
   attr_accessor :rspec_files

data/lib/rim/test.rb

@@ -1,4 +1,6 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 class Rim
   # Test files (default: <code>'test/**/*.rb')</code>
   attr_accessor :test_files

data/lib/rim/tire.rb

@@ -1,6 +1,6 @@
-# -- encoding: utf-8 --
-require 'rim'
-require 'rim/gem'
-require 'rim/info'
-require 'rim/release'
-require 'rim/test'
+# encoding: utf-8
+
+require_relative 'gem'
+require_relative 'info'
+require_relative 'release'
+require_relative 'test'

data/lib/rim/version.rb

@@ -1,12 +1,12 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+require_relative '../rim'
+
 Rim.after_setup do
   namespace :version do
     changelog = filelist(/^Changelog/i).first
     fail 'No Changelog file found' unless changelog
     if feature_loaded? 'rim/gem'
-      desc "Check if Rim#version is equal to version in #{changelog} and #{gemspec_file}."
-    else
-      desc "Check if Rim#version is equal to version in #{changelog}."
+      desc "Check if version in #{gemspec_file} is equal to version in #{changelog}."
     end
     task :check do
       version_re = /^(\d+\.\d+(?:\.\d+)+(?:\.?\S+)?)/
@@ -14,30 +14,15 @@ Rim.after_setup do
       line = File.open(changelog) do |f|
         f.readline
       end
+      version = gemspec.version.to_s
       if line =~ version_re
         if $1 != version
-          fail "Version mismatch (#{changelog}: #$1, Rim#version: #{version})"
+          fail "Version mismatch (#{changelog}: #$1, #{gemspec_file}: #{version})"
         end
       else
         fail "No version information in #{changelog}"
       end
-      if feature_loaded? 'rim/gem'
-        # gemspec
-        fail 'No gemspec file found' unless File.exist? gemspec_file
-        spec = eval File.read(gemspec_file)
-        unless spec.version
-          fail "No version information in #{gemspec_file}"
-        end
-        if version != spec.version.to_s
-          fail "Version mismatch (#{gemspec_file}: #{spec.version}, Rim#version: #{version})\nTry rake gem:spec"
-        end
-      end
     end
-
-    if feature_loaded? 'rim/release'
-      task :check => 'gem:spec'
-    end
-
   end
   if feature_loaded? 'rim/gem'
     task 'gem:push' => 'version:check'

data/lib/rim/yard.rb

@@ -1,4 +1,5 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
+
 CLEAN.include(FileList['.yardoc'].existing)
 CLOBBER.include(FileList['doc'].existing)
 task :yard do

data/lib/rim.rb

@@ -1,4 +1,4 @@
-# -- encoding: utf-8 --
+# encoding: utf-8
 require 'rake'
 require 'rake/clean'
 require 'singleton'
@@ -9,7 +9,7 @@ require 'singleton'
 # versions as possible and is easy to extend. Feel free to dislike it. ;)
 class Rim
 
-  VERSION = '2.17.1'
+  VERSION = '3.0.0'
 
   begin
     require 'rake/dsl_definition'
@@ -95,5 +95,5 @@ class Rim
 
 end
 
-require 'rim/core'
+require 'rim/gemspec'
 require 'rim/rimrc' unless ENV['SELFTEST']