paper_house 0.4.1 → 0.5.0

data/lib/paper_house/{c_extension_task.rb → ruby_extension_task.rb}

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,79 +16,58 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
+require 'paper_house/library_task'
+require 'paper_house/linker_options'
+require 'paper_house/platform'
 
-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 CExtensionTask < LibraryTask
+  class RubyExtensionTask < LibraryTask
     include LinkerOptions
     include Platform
 
-
     # Name of target library.
     attr_writer :library_name
 
-
     # Name of target library file.
     def target_file_name
-      library_name + SHARED_EXT
+      library_name.to_s + SHARED_EXT
     end
 
-
     # List of libraries to link.
     def library_dependencies
-      if Platform::MAC
-        ( [ @library_dependencies ] << "ruby" ).flatten.compact
-      else
-        super
-      end
+      MAC ? ([@library_dependencies] << 'ruby').flatten.compact : super
     end
 
-
-    ############################################################################
     private
-    ############################################################################
-
 
     def generate_target
-      sh ( [ cc ] + cc_options ).join( " " )
+      sh(([cc] + cc_options).join(' '))
     end
 
-
     def cc_options
-      [ LDSHARED, o_option, objects, ldflags, libdir_option, l_options ].flatten
+      [LDSHARED, o_option, objects, ldflags, libdir_option, l_options].flatten
     end
 
-
     def o_option
-      "-o #{ target_path }"
+      "-o #{target_path}"
     end
 
-
     def libdir_option
-      "-L#{ RUBY_LIBDIR }"
+      "-L#{RUBY_LIBDIR}"
     end
 
-
     def include_directories
-      ( includes + auto_includes + RUBY_INCLUDES ).uniq
+      (includes + auto_includes + RUBY_INCLUDES).uniq
     end
   end
-
-
-  #
-  # Alias for CExtensionTask
-  #
-  RubyLibraryTask = CExtensionTask
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/paper_house/safe_popen.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,9 +16,7 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
-require "popen4"
-
+require 'popen4'
 
 module PaperHouse
   #
@@ -29,11 +28,11 @@ module PaperHouse
     # Starts a new process and pass the subprocess IOs and pid to the
     # block supplied.
     #
-    def self.popen command, &block
+    def self.popen(command, &block)
       status = nil
       begin
         GC.disable
-        status = POpen4.popen4( command, &block )
+        status = POpen4.popen4(command, &block)
       ensure
         GC.enable
       end
@@ -42,7 +41,6 @@ module PaperHouse
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/paper_house/shared_library_task.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,11 +16,9 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
-require "paper_house/library_task"
-require "paper_house/linker_options"
-require "paper_house/platform"
-
+require 'paper_house/library_task'
+require 'paper_house/linker_options'
+require 'paper_house/platform'
 
 module PaperHouse
   # Compiles *.c files into a shared library.
@@ -27,64 +26,51 @@ module PaperHouse
     include LinkerOptions
     include Platform
 
-
     # Library version string.
     attr_accessor :version
 
-
-    def initialize name, version = nil, &block
+    def initialize(name, version = nil, &block)
       @version = version
       super name, &block
     end
 
-
     # Real name of target library.
     def target_file_name
-      fail ":version option is a mandatory." if not @version
-      [ linker_name, @version ].join "."
+      fail 'version option is a mandatory.' unless @version
+      [linker_name, @version].join '.'
     end
-    alias :real_name :target_file_name
-
+    alias_method :real_name, :target_file_name
 
     # Name of library used by linkers.
     def linker_name
-      library_name + ".so"
+      library_name + '.so'
     end
 
-
     # Soname of target library.
     def soname
-      File.basename( target_file_name ).sub( /\.\d+\.\d+\Z/, "" )
+      File.basename(target_file_name).sub(/\.\d+\.\d+\Z/, '')
     end
 
-
-    ############################################################################
     private
-    ############################################################################
-
 
     def generate_target
-      sh ( [ cc ] + cc_options ).join( " " )
+      sh(([cc] + cc_options).join(' '))
     end
 
-
     def cc_options
-      [ "-shared", wl_option, o_option, objects, ldflags, l_options ].flatten
+      ['-shared', wl_option, o_option, objects, ldflags, l_options].flatten
     end
 
-
     def wl_option
-      "-Wl,#{ SONAME_OPTION },#{ soname }"
+      "-Wl,#{SONAME_OPTION},#{soname}"
     end
 
-
     def o_option
-      "-o #{ target_path }"
+      "-o #{target_path}"
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/paper_house/static_library_task.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,23 +16,17 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
-require "paper_house/library_task"
-
+require 'paper_house/library_task'
 
 module PaperHouse
   # Compiles *.c files into a static library.
   class StaticLibraryTask < LibraryTask
     # Name of target library file.
     def target_file_name
-      library_name + ".a"
+      library_name + '.a'
     end
 
-
-    ##########################################################################
     private
-    ##########################################################################
-
 
     def generate_target
       maybe_rm_target
@@ -39,25 +34,21 @@ module PaperHouse
       ranlib
     end
 
-
     def maybe_rm_target
       a_file = target_path
-      sh "rm #{ a_file }" if FileTest.exist?( a_file )
+      sh "rm #{a_file}" if FileTest.exist?(a_file)
     end
 
-
     def ar
-      sh "ar -cq #{ target_path } #{ objects.to_s }"
+      sh "ar -cq #{target_path} #{objects.to_s}"
     end
 
-
     def ranlib
-      sh "ranlib #{ target_path }"
+      sh "ranlib #{target_path}"
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/paper_house/version.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,14 +16,12 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
 # Base module.
 module PaperHouse
   # gem version.
-  VERSION = "0.4.1"
+  VERSION = '0.5.0'
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8

data/lib/paper_house.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,13 +16,11 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
-require "paper_house/c_extension_task"
-require "paper_house/executable_task"
-require "paper_house/shared_library_task"
-require "paper_house/static_library_task"
-require "paper_house/version"
-
+require 'paper_house/executable_task'
+require 'paper_house/ruby_extension_task'
+require 'paper_house/shared_library_task'
+require 'paper_house/static_library_task'
+require 'paper_house/version'
 
 ### Local variables:
 ### mode: Ruby

data/paper_house.gemspec

@@ -1,32 +1,30 @@
-lib = File.expand_path( "../lib", __FILE__ )
-$LOAD_PATH.unshift( lib ) unless $LOAD_PATH.include?( lib )
-require "paper_house/version"
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paper_house/version'
 
-
-Gem::Specification.new do | gem |
-  gem.name = "paper_house"
+Gem::Specification.new do |gem|
+  gem.name = 'paper_house'
   gem.version = PaperHouse::VERSION
-  gem.summary = "Rake for C projects."
-  gem.description = "Rake tasks for compiling C projects."
+  gem.summary = 'Rake for C projects.'
+  gem.description = 'Rake tasks for compiling C projects.'
 
-  gem.license = "GPL3"
+  gem.license = 'GPL3'
 
-  gem.authors = [ "Yasuhito Takamiya" ]
-  gem.email = [ "yasuhito@gmail.com" ]
-  gem.homepage = "http://github.com/trema/paper-house"
+  gem.authors = ['Yasuhito Takamiya']
+  gem.email = ['yasuhito@gmail.com']
+  gem.homepage = 'http://github.com/trema/paper-house'
 
-  gem.files = `git ls-files`.split( "\n" )
+  gem.files = `git ls-files`.split("\n")
 
-  gem.require_paths = [ "lib" ]
+  gem.require_paths = ['lib']
 
-  gem.extra_rdoc_files = [ "README.md" ]
-  gem.test_files = `git ls-files -- {spec,features}/*`.split( "\n" )
+  gem.extra_rdoc_files = ['README.md']
+  gem.test_files = `git ls-files -- {spec,features}/*`.split("\n")
 
-  gem.add_dependency "POpen4", "~> 0.1.4"
-  gem.add_dependency "rake", "~> 10.1.0"
+  gem.add_dependency 'POpen4', '~> 0.1.4'
+  gem.add_dependency 'rake', '~> 10.1.0'
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/rake_simplecov_hook.rb

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'simplecov'
+
+def scenario_name
+  File.basename Dir.pwd
+end
+
+def id_file
+  File.join Dir.pwd, '..', '..', ".#{scenario_name}_id"
+end
+
+def new_scenario_id
+  new_id = 0
+  new_id = IO.read(id_file).chomp.to_i + 1 if File.exists?(id_file)
+  File.open(id_file, 'w') { | file | file.puts new_id }
+  new_id
+end
+
+SimpleCov.start do
+  root File.dirname(__FILE__)
+  command_name "#{scenario_name} scenario ##{new_scenario_id}"
+  use_merging true
+end

data/rubocop-todo.yml

@@ -0,0 +1,6 @@
+# This configuration was generated by `rubocop --auto-gen-config`.
+# The point is for the user to remove these configuration records
+# one by one as the offences are removed from the code base.
+
+HashSyntax:
+  EnforcedStyle: hash_rockets

data/spec/paper_house/executable_task_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,32 +16,76 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
+require 'paper_house/executable_task'
 
-require "paper_house/executable_task"
+describe Rake::Task do
+  before { Rake::Task.clear }
 
+  describe '.[]' do
+    subject { Rake::Task[task] }
 
-module PaperHouse
-  describe ExecutableTask, ".new( :test )" do
-    subject { 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 "." }
-
-    it {
-      expect {
-        Rake::Task[ subject.name ].invoke
-      }.to raise_error( "Cannot find sources (*.c)." )
-    }
+    context 'with :test' do
+      let(:task) { :test }
+
+      context 'when ExecutableTask named :test is defined' do
+        before { PaperHouse::ExecutableTask.new :test }
+
+        describe '#invoke' do
+          it do
+            expect do
+              subject.invoke
+            end.to raise_error('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
 
+#
+# PaperHouse::ExecutableTask spec.
+#
+module PaperHouse
+  describe ExecutableTask, '.new' do
+    context 'with name :test' do
+      subject { 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 '.' }
+    end
+
+    context 'with :test and block' do
+      subject do
+        ExecutableTask.new(:test) do | task |
+          task.executable_name = executable_name
+        end
+      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 }
+      end
+    end
+  end
+end
 
 ### Local variables:
 ### mode: Ruby

data/spec/paper_house/ruby_extension_task_spec.rb

@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2013 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+require 'paper_house/ruby_extension_task'
+
+describe Rake::Task do
+  before { Rake::Task.clear }
+
+  describe '.[]' do
+    subject { Rake::Task[task] }
+
+    context 'with :test' do
+      let(:task) { :test }
+
+      context 'when RubyExtensionTask named :test is defined' do
+        before { PaperHouse::RubyExtensionTask.new :test }
+
+        describe '#invoke' do
+          it do
+            expect do
+              subject.invoke
+            end.to raise_error('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
+
+#
+# PaperHouse::RubyExtensionTask spec.
+#
+module PaperHouse
+  describe RubyExtensionTask, '.new :test' do
+    before { Rake::Task.clear }
+
+    describe '.find_named' do
+      subject { RubyExtensionTask.find_named name }
+
+      context 'with :test' do
+        let(:name) { :test }
+
+        context 'when RubyExtensionTask named :test is defined' do
+          before { RubyExtensionTask.new :test }
+
+          it { expect(subject).to be_a RubyExtensionTask }
+        end
+
+        context 'when RubyExtensionTask named :test is not defined' do
+          it { expect(subject).to be_nil }
+        end
+      end
+
+      context %{with 'test'} do
+        let(:name) { 'test' }
+
+        context %{when RubyExtensionTask named 'test' is defined} do
+          before { RubyExtensionTask.new :test }
+
+          it { expect(subject).to be_a RubyExtensionTask }
+        end
+      end
+
+      context 'with :no_such_task' do
+        let(:name) { :no_such_task }
+
+        it { expect(subject).to be_nil }
+      end
+    end
+  end
+
+  describe '.new' do
+    context 'with :test' do
+      subject { 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
+        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 }
+      end
+    end
+  end
+end
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End: