paper_house 0.4.1 → 0.5.0

data/lib/paper_house/build_task.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,59 +16,67 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
-require "paper_house/auto_depends"
-require "paper_house/dependency"
-require "paper_house/cc_options"
-require "rake/clean"
-require "rake/tasklib"
-
+require 'paper_house/auto_depends'
+require 'paper_house/dependency'
+require 'paper_house/cc_options'
+require 'rake/clean'
+require 'rake/tasklib'
 
 module PaperHouse
   # Common base class for *.c compilation tasks.
   class BuildTask < Rake::TaskLib
-    include CcOptions
+    # Helper class for defining CLEAN and CLOBBER.
+    class CleanTask
+      def initialize(targets, file_list)
+        @targets = targets
+        @file_list = Object.const_get(file_list.to_s.upcase)
+        define_task
+      end
+
+      private
 
+      def define_task
+        @targets.each do |each|
+          next if @file_list.include?(each)
+          @file_list.include each
+        end
+        @file_list.existing!
+      end
+    end
+
+    include CcOptions
 
     # Name of task.
     attr_accessor :name
 
-
     # @!attribute target_directory
     #   Directory where *.o files are created.
     attr_writer :target_directory
 
     def target_directory
-      @target_directory ||= "."
+      @target_directory ||= '.'
     end
 
-
     # @!attribute cc
     #   C compiler name or path.
     attr_writer :cc
 
     def cc
-      ENV[ "CC" ] || @cc || "gcc"
+      ENV['CC'] || @cc || 'gcc'
     end
 
-
-    def initialize name, &block
+    def initialize(name, &block)
       @name = name.to_s
       block.call self if block
       define
     end
 
-
     # Relative path to target file.
     def target_path
-      File.join target_directory, target_file_name
+      File.join target_directory, target_file_name.to_s
     end
 
-
-    ############################################################################
     private
-    ############################################################################
-
 
     def define
       define_main_task
@@ -77,112 +86,77 @@ module PaperHouse
       define_clean_tasks
     end
 
-
     def define_main_task
       path = target_path
-      task name => [ target_directory, path ]
+      task name => [target_directory, path]
     end
 
-
     def define_directory_task
       directory target_directory
     end
 
-
     def define_all_c_compile_tasks
-      sources_list.zip( objects ) do | source, object |
+      sources_list.zip(objects) do |source, object|
         define_c_compile_task source, object
       end
     end
 
-
-    def define_c_compile_task source, object
-      task object => source do | task |
-        compile task.name, task.prerequisites[ 0 ]
+    def define_c_compile_task(source, object)
+      task object => source do |task|
+        compile task.name, task.prerequisites[0]
       end
     end
 
-
     def define_maybe_generate_target_task
-      file target_path => objects do | task |
-        next if uptodate?( task.name, task.prerequisites )
+      file target_path => objects do |task|
+        next if uptodate?(task.name, task.prerequisites)
         build
       end
     end
 
-
     def build
       check_sources_list
       generate_target
     end
 
-
     def check_sources_list
-      if sources_list.empty?
-        fail "Cannot find sources (#{ @sources })."
-      end
+      fail "Cannot find sources (#{@sources})." if sources_list.empty?
     end
 
-
     def define_clean_tasks
-      define_clean_task
-      define_clobber_task
-    end
-
-
-    def define_clean_task
-      objects.each do | each |
-        next if CLEAN.include?( each )
-        CLEAN.include each
-      end
-      CLEAN.existing!
+      CleanTask.new objects, :clean
+      CleanTask.new clobber_targets, :clobber
     end
 
-
-    def define_clobber_task
-      clobber_targets.each do | each |
-        next if CLOBBER.include?( each )
-        CLOBBER.include each
-      end
-      CLOBBER.existing!
-    end
-
-
     def clobber_targets
-      [ target_path, dependency.path ]
+      [target_path, dependency.path]
     end
 
-
     def objects
-      sources_list.pathmap File.join( target_directory, "%n.o" )
+      sources_list.pathmap File.join(target_directory, '%n.o')
     end
 
-
-    def compile o_file, c_file
-      return if no_need_to_compile?( o_file, c_file )
-      auto_depends = AutoDepends.new( c_file, o_file, cc, auto_depends_cc_options )
+    def compile(o_file, c_file)
+      return if no_need_to_compile?(o_file, c_file)
+      auto_depends = AutoDepends.new(c_file, o_file, cc, ad_cc_options)
       auto_depends.run
       dependency.write o_file, auto_depends.data
     end
 
-
-    def no_need_to_compile?( o_file, c_file )
-      uptodate?( o_file, dependency.read( o_file ) << c_file )
+    def no_need_to_compile?(o_file, c_file)
+      uptodate?(o_file, dependency.read(o_file) << c_file)
     end
 
-
-    def auto_depends_cc_options
-      ( cflags + [ "-fPIC" ] + i_options ).join " "
+    def ad_cc_options
+      (cflags + ['-fPIC'] + i_options).join ' '
     end
 
-
     def dependency
-      @dependency ||= Dependency.new( @name )
+      @dependency ||= Dependency.new(@name)
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/paper_house/cc_options.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,7 +16,6 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
 module PaperHouse
   # CC option utilities.
   module CcOptions
@@ -24,10 +24,9 @@ module PaperHouse
     attr_writer :sources
 
     def sources
-      @sources ||= "*.c"
+      @sources ||= '*.c'
     end
 
-
     # @!attribute cflags
     #   Compile options pass to C compiler.
     attr_writer :cflags
@@ -36,44 +35,35 @@ module PaperHouse
       @cflags ||= []
     end
 
-
     # @!attribute includes
     #   Glob pattern to match include directories.
     attr_writer :includes
 
     def includes
       @includes ||= []
-      FileList[ [ @includes ] ]
+      FileList[[@includes]]
     end
 
-
-    ############################################################################
     private
-    ############################################################################
-
 
     def i_options
-      include_directories.pathmap "-I%p"
+      include_directories.pathmap '-I%p'
     end
 
-
     def include_directories
-      ( includes + auto_includes ).uniq
+      (includes + auto_includes).uniq
     end
 
-
     def auto_includes
-      FileList[ sources_list.pathmap( "%d" ).uniq ]
+      FileList[sources_list.pathmap('%d').uniq]
     end
 
-
     def sources_list
-      FileList[ sources ]
+      FileList[sources]
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/paper_house/dependency.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,10 +16,8 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
-require "pstore"
-require "rake"
-
+require 'pstore'
+require 'rake'
 
 module PaperHouse
   #
@@ -27,46 +26,38 @@ module PaperHouse
   class Dependency
     attr_reader :path
 
-
-    def initialize name
+    def initialize(name)
       @name = name
-      @path = File.join( Rake.original_dir, ".#{ name }.depends" )
+      @path = File.join(Rake.original_dir, ".#{name}.depends")
       @cache = {}
     end
 
-
     #
     # Reads the dependency information of +object_file+.
     #
-    def read object_file
-      db.transaction( true ) do | store |
-        store[ object_file ]
+    def read(object_file)
+      db.transaction(true) do |store|
+        store[object_file]
       end || []
     end
 
-
     #
     # Saves the dependency information (+object_file+ => +dependent_files+).
     #
-    def write object_file, dependent_files
-      db.transaction( false ) do | store |
-        store[ object_file ] = dependent_files
+    def write(object_file, dependent_files)
+      db.transaction(false) do |store|
+        store[object_file] = dependent_files
       end
     end
 
-
-    ############################################################################
     private
-    ############################################################################
-
 
     def db
-      @cache[ @name ] ||= PStore.new( @path )
+      @cache[@name] ||= PStore.new(@path)
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/paper_house/executable_task.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,12 +16,10 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
-require "paper_house/build_task"
-require "paper_house/linker_options"
-require "paper_house/shared_library_task"
-require "paper_house/static_library_task"
-
+require 'paper_house/build_task'
+require 'paper_house/linker_options'
+require 'paper_house/shared_library_task'
+require 'paper_house/static_library_task'
 
 module PaperHouse
   #
@@ -29,15 +28,13 @@ module PaperHouse
   class ExecutableTask < BuildTask
     include LinkerOptions
 
-
-    def initialize name, &block
+    def initialize(name, &block)
       super name, &block
-      Rake::Task[ name ].prerequisites.each do | each |
-        find_prerequisites each, [ StaticLibraryTask, SharedLibraryTask ]
+      Rake::Task[name].prerequisites.each do |each|
+        find_prerequisites each, [StaticLibraryTask, SharedLibraryTask]
       end
     end
 
-
     # @!attribute executable_name
     #   Name of target executable file.
     attr_writer :executable_name
@@ -45,31 +42,24 @@ module PaperHouse
     def executable_name
       @executable_name ||= @name
     end
-    alias :target_file_name :executable_name
-
+    alias_method :target_file_name, :executable_name
 
-    ############################################################################
     private
-    ############################################################################
-
 
     def generate_target
-      sh ( [ cc ] + cc_options ).join( " " )
+      sh(([cc] + cc_options).join(' '))
     end
 
-
     def cc_options
-      [ o_option, objects, ldflags, l_options ].flatten
+      [o_option, objects, ldflags, l_options].flatten
     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/library_task.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,48 +16,45 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
-require "paper_house/build_task"
-
+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_by name
-      ObjectSpace.each_object( self ) do | each |
-        return each if each.name == name.to_s
+    def self.find_named(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
       end
       nil
     end
 
-
-    def initialize name, &block
+    def initialize(name, &block)
       @library_dependencies = []
       super name, &block
     end
 
-
     # Name of library.
     def library_name
       @library_name ||= @name
     end
 
-
     # Name of library.
-    def library_name= new_name
-       @library_name = /\Alib/=~ new_name ? new_name : "lib" + new_name
+    def library_name=(name)
+      new_name = name.to_s
+      @library_name = /\Alib/ =~ new_name ? new_name : 'lib' + new_name
     end
 
-
     # Name of library pass to -l option.
     def lname
-      library_name.sub( /^lib/, "" )
+      library_name.sub(/^lib/, '')
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/paper_house/linker_options.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013 NEC Corporation
 #
@@ -15,7 +16,6 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
 module PaperHouse
   #
   # Linker option utilities.
@@ -27,61 +27,51 @@ module PaperHouse
 
     def ldflags
       @ldflags ||= []
-      [ @ldflags ].flatten.compact
+      [@ldflags].flatten.compact
     end
 
-
     #
     # List of libraries to link.
     #
-    def library_dependencies= name
-      @library_dependencies = [ name ].flatten.compact
+    def library_dependencies=(name)
+      @library_dependencies = [name].flatten.compact
     end
 
-
     #
     # List of libraries to link.
     #
     def library_dependencies
       @library_dependencies ||= []
-      [ @library_dependencies ].flatten.compact
+      [@library_dependencies].flatten.compact
     end
 
-
-    ############################################################################
     private
-    ############################################################################
-
 
-    def find_prerequisites task, klass_list
-      klass_list.each do | klass |
+    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 )
+    def maybe_enhance(name, klass)
+      task = klass.find_named(name)
       enhance task if task
     end
 
-
-    def enhance library_task
+    def enhance(library_task)
       @library_dependencies ||= []
-      @library_dependencies |= [ library_task.lname ]
-      Rake::Task[ target_path ].enhance [ library_task.target_path ]
+      @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 }"
+      library_dependencies.map do |each|
+        "-l#{each}"
       end
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

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