inventory 0.1.0 → 0.2.2

data/README

@@ -0,0 +1,6 @@
+                                   Inventory
+
+  Inventory allows you to create inventories of your Ruby projects.  These
+  inventories can then be used to load the project, create gem specifications
+  and gems, run unit tests, and verify that the project’s content is what you
+  think it is.

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'lookout/rake/tasks'
+require 'inventory/rake/tasks'
+require 'inventory/version'
+
+Inventory::Rake::Tasks.define Inventory::Version, :gem => proc{ |_, s|
+  s.author = 'Nikolai Weibull'
+  s.email = 'now@bitwi.se'
+  s.homepage = 'https://github.com/now/inventory'
+}
+Lookout::Rake::Tasks::Test.new

data/lib/inventory.rb

@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+
+class Inventory
+  def initialize(major, minor, patch,
+                 path = (m = /\A(.*):\d+(?::in .*)?\z/.match(caller.first) and m[1]),
+                 &block)
+    @major, @minor, @patch = major, minor, patch
+    raise ArgumentError, 'default value of path argument could not be calculated' unless path
+    @path = path
+    @srcdir, _, @package_require = File.dirname(File.expand_path(path)).rpartition('/lib/')
+    raise ArgumentError,
+      'path is not of the form PATH/lib/PACKAGE/version.rb: %s' % path if
+        @path.empty?
+    instance_exec(&block) if block
+  end
+
+  def package
+    package_require.gsub('/', '-')
+  end
+
+  def version_require
+    File.join(package_require, 'version')
+  end
+
+  def lib_directories
+    %w'lib'
+  end
+
+  def load
+    requires.each do |requirement|
+      require requirement
+    end
+    loads.each do |load|
+      Kernel.load File.expand_path('lib/%s' % load, srcdir)
+    end
+    self
+  end
+
+  def requires
+    []
+  end
+
+  def loads
+    libs
+  end
+
+  def libs
+    []
+  end
+
+  def additional_libs
+    [package_require, version_require].map{ |e| '%s.rb' % e }
+  end
+
+  def all_libs
+    libs + additional_libs
+  end
+
+  def lib_files
+    all_libs.map{ |e| 'lib/%s' % e }
+  end
+
+  def unit_tests
+    all_libs
+  end
+
+  def additional_unit_tests
+    []
+  end
+
+  def all_unit_tests
+    unit_tests + additional_unit_tests
+  end
+
+  def unit_test_files
+    all_unit_tests.map{ |e| 'test/unit/%s' % e }
+  end
+
+  def test_files
+    unit_test_files
+  end
+
+  def additional_files
+    %w'
+      README
+      Rakefile
+    '
+  end
+
+  def files
+    lib_files + test_files + additional_files
+  end
+
+  def to_a
+    files
+  end
+
+  def to_s
+    '%d.%d.%d' % [major, minor, patch]
+  end
+
+  def inspect
+    '#<%s: %s %s>' % [self.class, package, self]
+  end
+
+  attr_reader :major, :minor, :patch, :path, :srcdir, :package_require
+end

data/lib/inventory/rake/tasks.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+require 'rake'
+
+class Inventory; module Rake end end
+
+module Inventory::Rake::Tasks
+  %w'check clean gem inventory'.each do |file|
+    load File.expand_path('../tasks/%s.rb' % file, __FILE__)
+  end
+
+  @mostlycleanfiles, @cleanfiles, @distcleanfiles = [], [], []
+
+  class << self
+    attr_accessor :inventory
+
+    attr_reader :mostlycleanfiles, :cleanfiles, :distcleanfiles
+
+    def define(inventory, options = {})
+      self.inventory = inventory
+      Clean.define
+      Inventory.new(:inventory => inventory)
+      Gem.new(:inventory => inventory, &(options.fetch(:gem, proc{ })))
+    end
+  end
+end

data/lib/inventory/rake/tasks/check.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+desc 'Check that the package meets its expecatations'
+task :check

data/lib/inventory/rake/tasks/clean.rb

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+
+class Inventory::Rake::Tasks::Clean
+  include Rake::DSL
+
+  class << self
+    include Rake::DSL
+
+    def define
+      desc 'Delete targets built by rake that are often rebuilt'
+      new :mostlyclean, Inventory::Rake::Tasks.mostlycleanfiles
+
+      desc 'Delete targets built by rake'
+      new :clean, Inventory::Rake::Tasks.cleanfiles
+      task :clean => :mostlyclean
+
+      desc 'Delete targets built by extconf.rb'
+      new :distclean, Inventory::Rake::Tasks.distcleanfiles
+      task :distclean => :clean
+    end
+  end
+
+  def initialize(name, files = [])
+    @name, @files = name, files
+    define
+  end
+
+  def define
+    task name do
+      rm files, :force => true
+    end
+  end
+
+  attr_accessor :name, :files
+end

data/lib/inventory/rake/tasks/gem.rb

@@ -0,0 +1,154 @@
+# -*- coding: utf-8 -*-
+
+class Inventory::Rake::Tasks::Gem
+  include Rake::DSL
+
+  def initialize(options = {})
+    self.inventory = options.fetch(:inventory, Inventory::Rake::Tasks.inventory)
+    self.specification = options.fetch(:specification,
+                                       Gem::Specification.new{ |s|
+                                         next unless @inventory
+
+                                         s.name = @inventory.package
+                                         s.version = @inventory.to_s # TODO: We could probably skip #to_s
+
+                                         s.description = IO.read('README')
+                                         s.summary = s.description[/^.*?\./].lstrip
+
+                                         s.files = @inventory.files # TODO: We can skip #files and rely on #to_a
+
+                                         s.require_paths = @inventory.lib_directories
+                                       })
+    yield self, @specification if block_given?
+    define
+  end
+
+  def define
+    desc 'Create specifications' unless Rake::Task.task_defined? :spec
+    task :spec => :'gem:spec'
+
+    gemspec = '%s.gemspec' % @specification.name
+    Inventory::Rake::Tasks.cleanfiles << gemspec
+
+    desc 'Create gem specification' unless Rake::Task.task_defined? :'gem:spec'
+    task :'gem:spec' => gemspec
+
+    file gemspec => %w'Rakefile README' + [@inventory.path] do |t|
+      tmp = '%s.tmp' % t.name
+      rm([t.name, tmp], :force => true)
+      puts 'gem specification --ruby %s > %s' %
+        [@specification.name, tmp] if verbose
+      File.open(tmp, 'wb') do |f|
+        f.write @specification.to_ruby
+      end
+      chmod File.stat(tmp).mode & ~0222, tmp
+      mv tmp, t.name
+     end
+
+    desc 'Create files for distribution' unless Rake::Task.task_defined? :dist
+    task :dist => :'gem:dist'
+
+    desc 'Create %s for distribution' % @specification.file_name
+    task :'gem:dist' => [:'inventory:check', @specification.file_name]
+    file @specification.file_name => @specification.files do
+      require 'rubygems' unless defined? Gem
+      puts 'gem build %s' % gemspec if verbose
+      Gem::Builder.new(@specification).build
+    end
+
+    desc 'Check files before distribution' unless
+      Rake::Task.task_defined? :'dist:check'
+    task :'dist:check' => [:dist, :'gem:dist:check']
+
+    desc 'Check %s before distribution' % @specification.file_name
+    task :'gem:dist:check' => :'gem:dist' do
+      require 'rubygems' unless defined? Gem
+      require 'rubygems/installer' unless defined? Gem::Installer
+      checkdir = @specification.full_name
+      puts 'gem unpack %s --target %s' %
+        [@specification.file_name, checkdir] if verbose
+      Gem::Installer.new(@specification.file_name, :unpack => true).
+        unpack File.expand_path(checkdir)
+      chdir checkdir do
+        sh '%s %sinventory:check check' %
+          [Rake.application.name, Rake.application.options.silent ? '-s ' : '']
+      end
+      rm_r checkdir
+    end
+
+    desc 'Install distribution files on the local system' unless
+      Rake::Task.task_defined? :install
+    task :install => :'gem:install'
+
+    desc 'Install %s and its dependencies in ruby gem directory' %
+      @specification.file_name
+    task :'gem:install' => :'gem:dist' do |t|
+      require 'rubygems' unless defined? Gem
+      require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
+      puts 'gem install %s' % @specification.file_name if verbose
+      Gem::DependencyInstaller.new.install @specification.file_name
+    end
+
+    desc 'Install distribution files for the current user' unless
+      Rake::Task.task_defined? :'install:user'
+    task :'install:user' => :'gem:install:user'
+
+    desc 'Install %s and its dependencies in user gem directory' %
+      @specification.file_name
+    task :'gem:install:user' => :'gem:dist' do
+      require 'rubygems' unless defined? Gem
+      require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
+      puts 'gem install --user-install --bindir %s %s' %
+        [Gem.bindir(Gem.user_dir), @specification.file_name] if verbose
+      Gem::DependencyInstaller.
+        new(:user_install => true,
+            :bindir => Gem.bindir(Gem.user_dir)).
+        install @specification.file_name
+    end
+
+    desc 'Delete all files installed on the local system' unless
+      Rake::Task.task_defined? :uninstall
+    task :uninstall => :'gem:uninstall'
+
+    desc 'Uninstall %s from ruby gem directory' % @specification.file_name
+    task :'gem:uninstall' do
+      require 'rubygems' unless defined? Gem
+      # TODO: I have absolutely no idea why this is needed, but it is.
+      require 'rubygems/user_interaction' unless defined? Gem::UserInteraction
+      require 'rubygems/uninstaller' unless defined? Gem::Uninstaller
+      puts 'gem uninstall --executables %s' % @specification.name if verbose
+      Gem::Uninstaller.new(@specification.name,
+                           :executables => true,
+                           :version => @specification.version).uninstall
+    end
+
+    desc 'Delete all files installed for current user' unless
+      Rake::Task.task_defined? :'uninstall:user'
+    task :'uninstall:user' => :'gem:uninstall:user'
+
+    desc 'Uninstall %s from user gem directory' % @specification.file_name
+    task :'gem:uninstall:user' do
+      require 'rubygems' unless defined? Gem
+      # TODO: I have absolutely no idea why this is needed, but it is.
+      require 'rubygems/user_interaction' unless defined? Gem::UserInteraction
+      require 'rubygems/uninstaller' unless defined? Gem::Uninstaller
+      puts 'gem uninstall --executables --install-dir %s %s' %
+        [Gem.user_dir, @specification.name] if verbose
+      Gem::Uninstaller.new(@specification.name,
+                           :executables => true,
+                           :install_dir => Gem.user_dir,
+                           :version => @specification.version).uninstall
+    end
+
+    desc 'Push distribution files to distribution hubs' unless
+      Rake::Task.task_defined? :push
+    task :push => :'gem:push'
+
+    desc 'Push %s to rubygems.org' % @specification.file_name
+    task :'gem:push' => :'gem:dist:check' do
+      sh 'gem push -%s-verbose %s' % [verbose ? '' : '-no', @specification.file_name]
+    end
+  end
+
+  attr_writer :inventory, :specification
+end

data/lib/inventory/rake/tasks/inventory.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+
+class Inventory::Rake::Tasks::Inventory
+  include Rake::DSL
+
+  def initialize(options = {})
+    self.inventory = options.fetch(:inventory, Inventory::Rake::Tasks.inventory)
+    yield self if block_given?
+    define
+  end
+
+  def define
+    desc 'Check that the inventory is correct'
+    task :'inventory:check' do
+      # TODO: Use directories from Inventory instead of hard-coding lib and
+      # test/unit.  We want to check ext too?
+      diff = ((Dir['{lib,test/unit}/**/*.rb'] -
+               @inventory.lib_files -
+               @inventory.unit_test_files).map{ |e| 'file not listed in inventory: %s' % e } +
+              @inventory.files.reject{ |e| File.exist? e }.map{ |e| 'file listed in inventory does not exist: %s' % e })
+      fail diff.join("\n") unless diff.empty?
+      # TODO: puts 'inventory checks out' if verbose
+    end
+  end
+
+  attr_writer :inventory
+end

data/lib/inventory/version.rb

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+require 'inventory'
+
+class Inventory
+  Version = Inventory.new(0, 2, 2){
+    def additional_libs
+      super + %w'
+        inventory/rake/tasks.rb
+        inventory/rake/tasks/check.rb
+        inventory/rake/tasks/clean.rb
+        inventory/rake/tasks/gem.rb
+        inventory/rake/tasks/inventory.rb
+      '
+    end
+  }
+end

data/test/unit/inventory.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

data/test/unit/inventory/rake/tasks.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

data/test/unit/inventory/rake/tasks/check.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

data/test/unit/inventory/rake/tasks/clean.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

data/test/unit/inventory/rake/tasks/gem.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

data/test/unit/inventory/rake/tasks/inventory.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

data/test/unit/inventory/version.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inventory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-04 00:00:00.000000000 Z
+date: 2012-03-17 00:00:00.000000000 Z
 dependencies: []
-description: Inventory allows you to create inventories of your Ruby projects.
+description: ! "                                   Inventory\n\n  Inventory allows
+  you to create inventories of your Ruby projects.  These\n  inventories can then
+  be used to load the project, create gem specifications\n  and gems, run unit tests,
+  and verify that the project’s content is what you\n  think it is.\n"
 email: now@bitwi.se
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/inventory.rb
+- lib/inventory/version.rb
+- lib/inventory/rake/tasks.rb
+- lib/inventory/rake/tasks/check.rb
+- lib/inventory/rake/tasks/clean.rb
+- lib/inventory/rake/tasks/gem.rb
+- lib/inventory/rake/tasks/inventory.rb
+- test/unit/inventory.rb
+- test/unit/inventory/version.rb
+- test/unit/inventory/rake/tasks.rb
+- test/unit/inventory/rake/tasks/check.rb
+- test/unit/inventory/rake/tasks/clean.rb
+- test/unit/inventory/rake/tasks/gem.rb
+- test/unit/inventory/rake/tasks/inventory.rb
+- README
+- Rakefile
 homepage: https://github.com/now/inventory
 licenses: []
 post_install_message: 
@@ -42,4 +61,3 @@ signing_key:
 specification_version: 3
 summary: Inventory allows you to create inventories of your Ruby projects.
 test_files: []
-has_rdoc: