paper_house 0.6.0 → 0.6.1

data/lib/paper_house/build_task.rb

@@ -12,9 +12,11 @@ module PaperHouse
   class BuildTask < Rake::TaskLib
     # Helper class for defining CLEAN and CLOBBER.
     class CleanTask
-      def initialize(targets, file_list)
+      # Add +targets+ to +target_type+ (+:CLEAN+ or +:CLOBBER+).
+      # @example CleanTask.new %w(file1 file2), :CLEAN
+      def initialize(targets, target_type)
         @targets = targets
-        @file_list = Object.const_get(file_list.to_s.upcase)
+        @file_list = Object.const_get(target_type)
         define_task
       end
 
@@ -50,6 +52,7 @@ module PaperHouse
       ENV['CC'] || @cc || 'gcc'
     end
 
+    # @private
     def initialize(name, &block)
       @name = name.to_s
       block.call self if block
@@ -109,8 +112,8 @@ module PaperHouse
     end
 
     def define_clean_tasks
-      CleanTask.new objects, :clean
-      CleanTask.new clobber_targets, :clobber
+      CleanTask.new objects, :CLEAN
+      CleanTask.new clobber_targets, :CLOBBER
     end
 
     def clobber_targets

data/lib/paper_house/dependency.rb

@@ -4,30 +4,32 @@ require 'pstore'
 require 'rake'
 
 module PaperHouse
-  #
   # Keeps compilation dependencies
-  #
   class Dependency
     attr_reader :path
 
+    # Creates an object that tracks depencency information about a
+    # rake task specified with the +name+ argument.
+    #
+    # @example
+    #   Dependency.new('hello')
     def initialize(name)
       @name = name
       @path = File.join(Rake.original_dir, ".#{name}.depends")
       @cache = {}
     end
 
-    #
     # Reads the dependency information of +object_file+.
-    #
+    # @return [Array<String>]
     def read(object_file)
       db.transaction(true) do |store|
         store[object_file]
       end || []
     end
 
-    #
-    # Saves the dependency information (+object_file+ => +dependent_files+).
-    #
+    # Saves the dependency information
+    # (+object_file+ => +dependent_files+).
+    # @return [void]
     def write(object_file, dependent_files)
       db.transaction(false) do |store|
         store[object_file] = dependent_files

data/lib/paper_house/executable_task.rb

@@ -12,6 +12,18 @@ module PaperHouse
   class ExecutableTask < BuildTask
     include LinkerOptions
 
+    # Defines a rake task called +name+ that builds an executable.
+    # Several task attributes can be set in the +block+.
+    #
+    # @yield [task]
+    # @example
+    #   PaperHouse::ExecutableTask.new :hello do |task|
+    #     task.executable_name = 'hello'
+    #     task.target_directory = 'objects'
+    #     task.sources = 'sources/*.c'
+    #     task.includes = 'includes'
+    #     task.cflags = %w(-Wall -Wextra)
+    #   end
     def initialize(name, &block)
       super name, &block
       Rake::Task[name].prerequisites.each do |each|
@@ -24,7 +36,7 @@ module PaperHouse
     attr_writer :executable_name
 
     def executable_name
-      @executable_name ||= @name
+      (@executable_name ||= @name).to_s
     end
     alias_method :target_file_name, :executable_name
 

data/lib/paper_house/library_task.rb

@@ -5,17 +5,18 @@ require 'paper_house/build_task'
 module PaperHouse
   # Common base class for static, shared, and ruby library tasks.
   class LibraryTask < BuildTask
-    # Find a LibraryTask by name
-    def self.find_named(name)
+    # Find a LibraryTask by +name+.
+    # @return [LibraryTask]
+    def self.find_by_name(name)
       ObjectSpace.each_object(self) do |each|
         obj_name = each.name
-        if Rake::Task.task_defined?(obj_name) && obj_name == name.to_s
-          return each
-        end
+        next if !Rake::Task.task_defined?(obj_name) || obj_name != name.to_s
+        return each
       end
       nil
     end
 
+    # @private
     def initialize(name, &block)
       @library_dependencies = []
       super name, &block
@@ -23,7 +24,7 @@ module PaperHouse
 
     # Name of library.
     def library_name
-      @library_name ||= @name
+      (@library_name ||= @name).to_s
     end
 
     # Name of library.

data/lib/paper_house/linker_options.rb

@@ -38,7 +38,7 @@ module PaperHouse
     end
 
     def maybe_enhance(name, klass)
-      task = klass.find_named(name)
+      task = klass.find_by_name(name)
       enhance task if task
     end
 

data/lib/paper_house/platform.rb

@@ -3,9 +3,7 @@
 require 'rbconfig'
 
 module PaperHouse
-  #
   # Platform-dependent stuff.
-  #
   module Platform
     include RbConfig
 
@@ -13,13 +11,13 @@ module PaperHouse
     MAC = (/darwin|mac os/ =~ CONFIG['host_os'])
 
     # File extension of C extensions.
-    SHARED_EXT = MAC ? '.bundle' : '.so'
+    SHARED_EXT = (MAC ? '.bundle' : '.so').freeze
 
     # CC options for compiling shared libraries.
-    LDSHARED = MAC ? '-dynamic -bundle' : '-shared'
+    LDSHARED = (MAC ? '-dynamic -bundle' : '-shared').freeze
 
     # CC option for setting soname.
-    SONAME_OPTION = MAC ? '-install_name' : '-soname'
+    SONAME_OPTION = (MAC ? '-install_name' : '-soname').freeze
 
     # Include directories for compiling C extensions.
     RUBY_INCLUDES =
@@ -27,13 +25,14 @@ module PaperHouse
         File.join(CONFIG['rubyhdrdir'], CONFIG['arch']),
         File.join(CONFIG['rubyhdrdir'], 'ruby/backward'),
         CONFIG['rubyhdrdir']
-      ]
+      ].freeze
 
     # Library directories for compiling C extensions.
-    RUBY_LIBDIR = CONFIG['libdir']
+    RUBY_LIBDIR = CONFIG['libdir'].freeze
 
+    # Platform name.
     def self.name
-      MAC ? 'mac' : 'linux'
+      (MAC ? 'mac' : 'linux').freeze
     end
   end
 end

data/lib/paper_house/ruby_extension_task.rb

@@ -4,13 +4,9 @@ require 'paper_house/library_task'
 require 'paper_house/linker_options'
 require 'paper_house/platform'
 
-#
 # Rake for C projects.
-#
 module PaperHouse
-  #
   # Compiles *.c files into a Ruby extension library.
-  #
   class RubyExtensionTask < LibraryTask
     include LinkerOptions
     include Platform

data/lib/paper_house/shared_library_task.rb

@@ -13,6 +13,17 @@ module PaperHouse
     # Library version string.
     attr_accessor :version
 
+    # Defines a rake task called +name+ that builds a shared library.
+    # Note that version number must be set as the +version+ argument
+    # or in the +block+ to build the library.
+    #
+    # @yield [task]
+    # @example
+    #   PaperHouse::SharedLibraryTask.new :libhello do |task|
+    #     task.version = '0.1.0'
+    #     task.sources = 'hello.c'
+    #     task.library_dependencies = 'm'
+    #   end
     def initialize(name, version = nil, &block)
       @version = version
       super name, &block

data/lib/paper_house/version.rb

@@ -3,5 +3,5 @@
 # Base module.
 module PaperHouse
   # gem version.
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'.freeze
 end

data/paper_house.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.files = %w(CONTRIBUTING.md LICENSE Rakefile paper_house.gemspec)
   gem.files += Dir.glob('lib/**/*.rb')
   gem.files += Dir.glob('bin/**/*')
+  gem.files += Dir.glob('examples/**/*')
   gem.files += Dir.glob('spec/**/*')
   gem.files += Dir.glob('features/**/*')
 
@@ -30,5 +31,5 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 1.9.3'
   gem.add_dependency 'POpen4', '~> 0.1.4'
-  gem.add_dependency 'rake', '~> 10.2.1'
+  gem.add_dependency 'rake'
 end

data/spec/paper_house/executable_task_spec.rb

@@ -3,65 +3,58 @@
 require 'paper_house/executable_task'
 
 describe Rake::Task do
-  before { Rake::Task.clear }
+  context 'when ExecutableTask (name = :test) is defined' do
+    Given { Rake::Task.clear }
+    Given { PaperHouse::ExecutableTask.new :test }
 
-  describe '.[]' do
-    subject { Rake::Task[task] }
+    describe '.[]' do
+      context 'with :test' do
+        Given(:name) { :test }
 
-    context 'with :test' do
-      let(:task) { :test }
-
-      context 'when ExecutableTask named :test is defined' do
-        before { PaperHouse::ExecutableTask.new :test }
+        When(:task) { Rake::Task[name] }
+        Then { task.is_a? Rake::Task }
 
         describe '#invoke' do
-          it do
-            expect do
-              subject.invoke
-            end.to raise_error('Cannot find sources (*.c).')
+          When(:result) { task.invoke }
+          Then do
+            result ==
+              Failure(RuntimeError, 'Cannot find sources (*.c).')
           end
         end
       end
-
-      context 'when ExecutableTask named :test is not defined' do
-        it { expect { subject }.to raise_error }
-      end
     end
   end
 end
 
 describe PaperHouse::ExecutableTask, '.new' do
-  context 'with name :test' do
-    subject { PaperHouse::ExecutableTask.new :test }
-
-    its(:cc) { should eq 'gcc' }
-    its(:cflags) { should be_empty }
-    its(:executable_name) { should eq 'test' }
-    its(:includes) { should be_empty }
-    its(:ldflags) { should be_empty }
-    its(:library_dependencies) { should be_empty }
-    its(:name) { should eq 'test' }
-    its(:sources) { should eq '*.c'  }
-    its(:target_directory) { should eq '.' }
+  context 'with :test' do
+    When(:task) { PaperHouse::ExecutableTask.new(:test) }
+    Then { task.name == 'test' }
+    Then { task.executable_name == 'test' }
+    Then { task.sources == '*.c' }
+    Then { task.target_directory == '.' }
+    Then { task.cc == 'gcc' }
+    Then { task.cflags.empty? }
+    Then { task.includes.empty? }
+    Then { task.ldflags.empty? }
+    Then { task.library_dependencies.empty? }
   end
 
-  context 'with :test and block' do
-    subject do
-      PaperHouse::ExecutableTask.new(:test) do | task |
-        task.executable_name = executable_name
+  context "with :test and a block setting :executable_name = 'executable'" do
+    When(:task) do
+      PaperHouse::ExecutableTask.new(:test) do |task|
+        task.executable_name = 'executable'
       end
     end
+    Then { task.executable_name == 'executable' }
+  end
 
-    context %(with #executable_name = 'new_name') do
-      let(:executable_name) { 'new_name' }
-
-      its(:executable_name) { should eq 'new_name' }
-    end
-
-    context 'with #executable_name = :new_name' do
-      let(:executable_name) { :new_name }
-
-      its(:executable_name) { should eq :new_name }
+  context 'with :test and a block setting :executable_name = :executable' do
+    When(:task) do
+      PaperHouse::ExecutableTask.new(:test) do |task|
+        task.executable_name = :executable
+      end
     end
+    Then { task.executable_name == 'executable' }
   end
 end

data/spec/paper_house/ruby_extension_task_spec.rb

@@ -3,100 +3,62 @@
 require 'paper_house/ruby_extension_task'
 
 describe Rake::Task do
-  before { Rake::Task.clear }
+  context 'when RubyExtensionTask (name = :test) is defined' do
+    Given { Rake::Task.clear }
+    Given { PaperHouse::RubyExtensionTask.new :test }
 
-  describe '.[]' do
-    subject { Rake::Task[task] }
+    describe '.[]' do
+      context 'with :test' do
+        Given(:name) { :test }
 
-    context 'with :test' do
-      let(:task) { :test }
-
-      context 'when RubyExtensionTask named :test is defined' do
-        before { PaperHouse::RubyExtensionTask.new :test }
+        When(:task) { Rake::Task[name] }
+        Then { task.is_a? Rake::Task }
 
         describe '#invoke' do
-          it do
-            expect do
-              subject.invoke
-            end.to raise_error('Cannot find sources (*.c).')
+          When(:result) { task.invoke }
+          Then do
+            result ==
+              Failure(RuntimeError, 'Cannot find sources (*.c).')
           end
         end
       end
-
-      context 'when RubyExtensionTask named :test is not defined' do
-        it { expect { subject }.to raise_error }
-      end
     end
   end
 end
 
-describe PaperHouse::RubyExtensionTask do
-  before { Rake::Task.clear }
-
-  describe '.find_named' do
-    subject { PaperHouse::RubyExtensionTask.find_named name }
-
-    context 'with :test' do
-      let(:name) { :test }
-
-      context 'when RubyExtensionTask named :test is defined' do
-        before { PaperHouse::RubyExtensionTask.new :test }
-
-        it { expect(subject).to be_a PaperHouse::RubyExtensionTask }
-      end
-
-      context 'when RubyExtensionTask named :test is not defined' do
-        it { expect(subject).to be_nil }
-      end
+describe PaperHouse::RubyExtensionTask, '.new' do
+  context 'with :test' do
+    When(:task) { PaperHouse::RubyExtensionTask.new(:test) }
+    Then { task.name == 'test' }
+    Then { task.library_name == 'test' }
+    Then { task.sources == '*.c' }
+    Then { task.target_directory == '.' }
+    Then { task.cc == 'gcc' }
+    if PaperHouse::Platform.name == 'mac'
+      Then { task.library_dependencies == ['ruby'] }
+    else
+      Then { task.library_dependencies.empty? }
     end
+    Then { task.cflags.empty? }
+    Then { task.includes.empty? }
+    Then { task.ldflags.empty? }
+  end
 
-    context %(with 'test') do
-      let(:name) { 'test' }
-
-      context %(when RubyExtensionTask named 'test' is defined) do
-        before { PaperHouse::RubyExtensionTask.new :test }
-
-        it { expect(subject).to be_a PaperHouse::RubyExtensionTask }
+  context "with :test and a block setting :library_name = 'libtest'" do
+    When(:task) do
+      PaperHouse::RubyExtensionTask.new(:test) do |task|
+        task.library_name = 'libtest'
       end
     end
-
-    context 'with :no_such_task' do
-      let(:name) { :no_such_task }
-
-      it { expect(subject).to be_nil }
-    end
+    Then { task.library_name == 'libtest' }
   end
 
-  describe '.new' do
-    context 'with :test' do
-      subject { PaperHouse::RubyExtensionTask.new :test }
-
-      its(:cc) { should eq 'gcc' }
-      its(:cflags) { should be_empty }
-      its(:includes) { should be_empty }
-      its(:name) { should eq 'test' }
-      its(:sources) { should eq '*.c'  }
-      its(:target_directory) { should eq '.' }
-    end
-
-    context 'with :test and block' do
-      subject do
-        PaperHouse::RubyExtensionTask.new(:test) do | task |
-          task.library_name = library_name
-        end
-      end
-
-      context %(with #library_name = 'new_name') do
-        let(:library_name) { 'new_name' }
-
-        its(:library_name) { should eq 'new_name' }
-      end
-
-      context 'with #library_name = :new_name' do
-        let(:library_name) { :new_name }
-
-        its(:library_name) { should eq :new_name }
+  context 'with :test and a block setting :library_name = :libtest' do
+    When(:task) do
+      PaperHouse::RubyExtensionTask.new(:test) do |task|
+        task.library_name = :libtest
       end
     end
+    Then { task.library_name == 'libtest' }
   end
 end