paper_house 0.4.0

data/lib/paper_house/linker_options.rb

@@ -0,0 +1,89 @@
+#
+# 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.
+#
+
+
+module PaperHouse
+  #
+  # Linker option utilities.
+  #
+  module LinkerOptions
+    # @!attribute ldflags
+    #   Linker options pass to C compiler.
+    attr_writer :ldflags
+
+    def ldflags
+      @ldflags ||= []
+      [ @ldflags ].flatten.compact
+    end
+
+
+    #
+    # List of libraries to link.
+    #
+    def library_dependencies= name
+      @library_dependencies = [ name ].flatten.compact
+    end
+
+
+    #
+    # List of libraries to link.
+    #
+    def library_dependencies
+      @library_dependencies ||= []
+      [ @library_dependencies ].flatten.compact
+    end
+
+
+    ############################################################################
+    private
+    ############################################################################
+
+
+    def find_prerequisites task, klass_list
+      klass_list.each do | klass |
+        maybe_enhance task, klass
+      end
+    end
+
+
+    def maybe_enhance name, klass
+      task = klass.find_by( name )
+      enhance task if task
+    end
+
+
+    def enhance library_task
+      @library_dependencies ||= []
+      @library_dependencies |= [ library_task.lname ]
+      Rake::Task[ target_path ].enhance [ library_task.target_path ]
+    end
+
+
+    def l_options
+      library_dependencies.collect do | each |
+        "-l#{ each }"
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house/platform.rb

@@ -0,0 +1,69 @@
+#
+# 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 "rbconfig"
+
+
+module PaperHouse
+  #
+  # Platform-dependent stuff.
+  #
+  module Platform
+    include RbConfig
+
+
+    # MACOSX or not.
+    MAC = ( /darwin|mac os/=~ CONFIG[ "host_os" ] )
+
+
+    if MAC
+      # File extension of C extensions.
+      SHARED_EXT = ".bundle"
+      # CC options for compiling shared libraries.
+      LDSHARED = "-dynamic -bundle"
+      # CC option for setting soname.
+      SONAME_OPTION = "-install_name"
+    else
+      SHARED_EXT = ".so"
+      LDSHARED = "-shared"
+      SONAME_OPTION = "-soname"
+    end
+
+
+    # Include directories for compiling C extensions.
+    RUBY_INCLUDES = if RUBY_VERSION >= "1.9.0"
+                      [
+                        File.join( CONFIG[ "rubyhdrdir" ], CONFIG[ "arch" ] ),
+                        File.join( CONFIG[ "rubyhdrdir" ], "ruby/backward" ),
+                        CONFIG[ "rubyhdrdir" ]
+                      ]
+                    else
+                      [ CONFIG[ "archdir" ] ]
+                    end
+
+    # Library directories for compiling C extensions.
+    RUBY_LIBDIR = CONFIG[ "libdir" ]
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house/safe_popen.rb

@@ -0,0 +1,50 @@
+#
+# 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 "popen4"
+
+
+module PaperHouse
+  #
+  # Thin POpen4 wrapper that avoids POpen4's segraults in 1.8.6.
+  # See also https://github.com/engineyard/engineyard/issues/115
+  #
+  class SafePopen
+    #
+    # Starts a new process and pass the subprocess IOs and pid to the
+    # block supplied.
+    #
+    def self.popen command, &block
+      status = nil
+      begin
+        GC.disable
+        status = POpen4.popen4( command, &block )
+      ensure
+        GC.enable
+      end
+      status
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house/shared_library_task.rb

@@ -0,0 +1,92 @@
+#
+# 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/library_task"
+require "paper_house/linker_options"
+require "paper_house/platform"
+
+
+module PaperHouse
+  # Compiles *.c files into a shared library.
+  class SharedLibraryTask < LibraryTask
+    include LinkerOptions
+    include Platform
+
+
+    # Library version string.
+    attr_accessor :version
+
+
+    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 "."
+    end
+    alias :real_name :target_file_name
+
+
+    # Name of library used by linkers.
+    def linker_name
+      library_name + ".so"
+    end
+
+
+    # Soname of target library.
+    def soname
+      File.basename( target_file_name ).sub( /\.\d+\.\d+\Z/, "" )
+    end
+
+
+    ############################################################################
+    private
+    ############################################################################
+
+
+    def generate_target
+      sh ( [ cc ] + cc_options ).join( " " )
+    end
+
+
+    def cc_options
+      [ "-shared", wl_option, o_option, objects, ldflags, l_options ].flatten
+    end
+
+
+    def wl_option
+      "-Wl,#{ SONAME_OPTION },#{ soname }"
+    end
+
+
+    def o_option
+      "-o #{ target_path }"
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house/static_library_task.rb

@@ -0,0 +1,65 @@
+#
+# 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/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"
+    end
+
+
+    ##########################################################################
+    private
+    ##########################################################################
+
+
+    def generate_target
+      maybe_rm_target
+      ar
+      ranlib
+    end
+
+
+    def maybe_rm_target
+      a_file = target_path
+      sh "rm #{ a_file }" if FileTest.exist?( a_file )
+    end
+
+
+    def ar
+      sh "ar -cq #{ target_path } #{ objects.to_s }"
+    end
+
+
+    def ranlib
+      sh "ranlib #{ target_path }"
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house/version.rb

@@ -0,0 +1,30 @@
+#
+# 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.
+#
+
+
+# Base module.
+module PaperHouse
+  # gem version.
+  VERSION = "0.4.0"
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house.rb

@@ -0,0 +1,30 @@
+#
+# 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/c_extension_task"
+require "paper_house/executable_task"
+require "paper_house/shared_library_task"
+require "paper_house/static_library_task"
+require "paper_house/version"
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/paper_house.gemspec

@@ -0,0 +1,34 @@
+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.version = PaperHouse::VERSION
+  gem.summary = "Rake for C projects."
+  gem.description = "Rake tasks for compiling C projects."
+
+  gem.license = "GPL3"
+
+  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.require_paths = [ "lib" ]
+
+  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"
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/paper_house/c_extension_task_spec.rb

@@ -0,0 +1,59 @@
+#
+# 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/c_extension_task"
+
+
+module PaperHouse
+  [ CExtensionTask, RubyLibraryTask ].each do | klass |
+    describe klass, ".new :libtest" do
+      subject { klass.new :libtest }
+
+      its( :cc ) { should eq "gcc" }
+      its( :cflags ) { should be_empty }
+      its( :includes ) { should be_empty }
+      its( :name ) { should eq "libtest" }
+      its( :sources ) { should eq "*.c"  }
+      its( :target_directory ) { should eq "." }
+
+      it {
+        expect {
+          Rake::Task[ subject.name ].invoke
+        }.to raise_error( "Cannot find sources (*.c)." )
+      }
+    end
+
+
+    describe klass, ".new( :libtest ) do ... end" do
+      subject {
+        klass.new :libtest do | task |
+          task.library_name = "test"
+        end
+      }
+
+      its( :library_name ) { should eq "test" }
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/paper_house/cc_options_spec.rb

@@ -0,0 +1,59 @@
+#
+# 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/cc_options"
+
+
+module PaperHouse
+  class TestTask
+    include CcOptions
+
+    public
+    :i_options
+  end
+
+
+  describe CcOptions, "(default properties)" do
+    subject { TestTask.new }
+
+    its( :sources ) { should eq "*.c" }
+    its( :cflags ) { should be_empty }
+    its( :includes ) { should be_empty }
+  end
+
+
+  describe CcOptions, "(sources=./sources/foo.c, includes=./includes)" do
+    subject {
+      task = TestTask.new
+      task.sources = "./sources/foo.c"
+      task.includes = "./includes"
+      task
+    }
+
+    its( "i_options.size" ) { should eq 2 }
+    its( :i_options ) { should include "-I./includes" }
+    its( :i_options ) { should include "-I./sources" }
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/paper_house/executable_task_spec.rb

@@ -0,0 +1,49 @@
+#
+# 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/executable_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)." )
+    }
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End: