paper_house 0.4.0

data/examples/static_library_subdirs/Rakefile

@@ -0,0 +1,17 @@
+require "paper_house"
+
+task :hello => :libhello
+
+PaperHouse::StaticLibraryTask.new :libhello do | task |
+  task.library_name = "hello"
+  task.target_directory = "objects"
+  task.sources = "sources/hello.c"
+  task.includes = "includes"
+  task.cflags = [ "-Werror", "-Wall", "-Wextra" ]
+end
+
+PaperHouse::ExecutableTask.new :hello do | task |
+  task.sources = "sources/main.c"
+  task.includes = "includes"
+  task.ldflags = "-Lobjects"
+end

data/examples/static_library_subdirs/includes/hello.h

@@ -0,0 +1 @@
+void print_hello();

data/examples/static_library_subdirs/sources/hello.c

@@ -0,0 +1,6 @@
+#include <stdio.h>
+
+void
+print_hello() {
+  printf( "Hello, PaperHouse!\n" );
+}

data/examples/static_library_subdirs/sources/main.c

@@ -0,0 +1,8 @@
+#include <stdlib.h>
+#include "hello.h"
+
+int
+main() {
+  print_hello();
+  return 0;
+}

data/features/c_extension_task.feature

@@ -0,0 +1,119 @@
+Feature: PaperHouse::CExtensionTask
+
+  PaperHouse provides a rake task called `PaperHouse::CExtensionTask`
+  to build a C extention library from *.c and *.h files. These source
+  files can be located in multiple subdirectories.
+
+  @linux
+  Scenario: Build a C extension from one *.c and *.h file
+    Given the current project directory is "examples/c_extension"
+    When I successfully run `rake hello`
+    Then the output should match /^gcc/
+    And the output should not match /^llvm-gcc/
+    And a file named "hello.so" should exist
+    And I successfully run `ruby -I. -rhello -e "p HelloPaperHouse"`
+    And the output should contain:
+    """
+    HelloPaperHouse
+    """
+
+  @mac
+  Scenario: Build a C extension from one *.c and *.h file
+    Given the current project directory is "examples/c_extension"
+    When I successfully run `rake hello`
+    Then the output should match /^gcc/
+    And the output should not match /^llvm-gcc/
+    And a file named "hello.bundle" should exist
+    And I successfully run `ruby -I. -rhello -e "p HelloPaperHouse"`
+    And the output should contain:
+    """
+    HelloPaperHouse
+    """
+
+  @linux
+  Scenario: Build a C extension from one *.c and *.h file using llvm-gcc by specifying 'CC=' option
+    Given the current project directory is "examples/c_extension"
+    When I successfully run `rake hello CC=llvm-gcc`
+    Then the output should match /^llvm-gcc/
+    And the output should not match /^gcc/
+    And a file named "hello.so" should exist
+    And I successfully run `ruby -I. -rhello -e "p HelloPaperHouse"`
+    And the output should contain:
+    """
+    HelloPaperHouse
+    """
+
+  @mac
+  Scenario: Build a C extension from one *.c and *.h file using llvm-gcc by specifying 'CC=' option
+    Given the current project directory is "examples/c_extension"
+    When I successfully run `rake hello CC=llvm-gcc`
+    Then the output should match /^llvm-gcc/
+    And the output should not match /^gcc/
+    And a file named "hello.bundle" should exist
+    And I successfully run `ruby -I. -rhello -e "p HelloPaperHouse"`
+    And the output should contain:
+    """
+    HelloPaperHouse
+    """
+
+  @linux
+  Scenario: Build a C extension from one *.c and *.h file using llvm-gcc
+    Given the current project directory is "examples/c_extension"
+    When I successfully run `rake -f Rakefile.llvm hello`
+    Then the output should match /^llvm-gcc/
+    And the output should not match /^gcc/
+    And a file named "hello.so" should exist
+    And I successfully run `ruby -I. -rhello -e "p HelloPaperHouse"`
+    And the output should contain:
+    """
+    HelloPaperHouse
+    """
+
+  @mac
+  Scenario: Build a C extension from one *.c and *.h file using llvm-gcc
+    Given the current project directory is "examples/c_extension"
+    When I successfully run `rake -f Rakefile.llvm hello`
+    Then the output should match /^llvm-gcc/
+    And the output should not match /^gcc/
+    And a file named "hello.bundle" should exist
+    And I successfully run `ruby -I. -rhello -e "p HelloPaperHouse"`
+    And the output should contain:
+    """
+    HelloPaperHouse
+    """
+
+  @linux
+  Scenario: Clean
+    Given the current project directory is "examples/c_extension"
+    And I successfully run `rake hello`
+    When I successfully run `rake clean`
+    Then a file named "hello.o" should not exist
+    And a file named ".hello.depends" should exist
+    And a file named "hello.so" should exist
+
+  @mac
+  Scenario: Clean
+    Given the current project directory is "examples/c_extension"
+    And I successfully run `rake hello`
+    When I successfully run `rake clean`
+    Then a file named "hello.o" should not exist
+    And a file named ".hello.depends" should exist
+    And a file named "hello.bundle" should exist
+
+  @linux
+  Scenario: Clobber
+    Given the current project directory is "examples/c_extension"
+    And I successfully run `rake hello`
+    When I successfully run `rake clobber`
+    Then a file named "hello.o" should not exist
+    And a file named ".hello.depends" should not exist
+    And a file named "hello.so" should not exist
+
+  @mac
+  Scenario: Clobber
+    Given the current project directory is "examples/c_extension"
+    And I successfully run `rake hello`
+    When I successfully run `rake clobber`
+    Then a file named "hello.o" should not exist
+    And a file named ".hello.depends" should not exist
+    And a file named "hello.bundle" should not exist

data/features/executable_task.feature

@@ -0,0 +1,83 @@
+Feature: PaperHouse::ExecutableTask
+
+  PaperHouse provides a rake task called `PaperHouse::ExecutableTask`
+  to build an executable from *.c and *.h files. These source files
+  can be located in multiple subdirectories.
+
+  Scenario: Build an executable from one *.c file
+    Given the current project directory is "examples/executable"
+    When I successfully run `rake hello`
+    Then the output should contain:
+    """
+    gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    gcc -o ./hello ./hello.o
+    """
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  Scenario: Build an executable from one *.c file using llvm-gcc by specifying `CC=` option
+    Given the current project directory is "examples/executable"
+    When I successfully run `rake hello CC=llvm-gcc`
+    Then the output should contain:
+    """
+    llvm-gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    llvm-gcc -o ./hello ./hello.o
+    """
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  Scenario: Build an executable from one *.c file using llvm-gcc
+    Given the current project directory is "examples/executable"
+    When I successfully run `rake -f Rakefile.llvm hello`
+    Then the output should contain:
+    """
+    llvm-gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    llvm-gcc -o ./hello ./hello.o
+    """
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  Scenario: Build an executable from multiple *.c and *.h files in subdirectories
+    Given the current project directory is "examples/executable_subdirs"
+    When I successfully run `rake hello`
+    Then the output should contain:
+    """
+    gcc -H -Wall -Wextra -fPIC -Iincludes -Isources -c sources/hello.c -o objects/hello.o
+    gcc -H -Wall -Wextra -fPIC -Iincludes -Isources -c sources/main.c -o objects/main.o
+    mkdir -p objects
+    gcc -o objects/hello objects/hello.o objects/main.o
+    """
+    And a file named "objects/hello" should exist
+    And I successfully run `./objects/hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  Scenario: Clean
+    Given the current project directory is "examples/executable"
+    And I successfully run `rake hello`
+    When I successfully run `rake clean`
+    Then a file named "hello.o" should not exist
+    And a file named ".hello.depends" should exist
+    And a file named "hello" should exist
+
+  Scenario: Clobber
+    Given the current project directory is "examples/executable"
+    And I successfully run `rake hello`
+    When I successfully run `rake clobber`
+    Then a file named "hello.o" should not exist
+    And a file named ".hello.depends" should not exist
+    And a file named "hello" should not exist

data/features/shared_library_task.feature

@@ -0,0 +1,209 @@
+Feature: PaperHouse::SharedLibraryTask
+
+  PaperHouse provides a rake task called
+  `PaperHouse::SharedLibraryTask` to build a shared library from *.c
+  and *.h files. These source files can be located in multiple
+  subdirectories.
+
+  @linux
+  Scenario: Build a shared library from one *.c and *.h file
+    Given the current project directory is "examples/shared_library"
+    When I successfully run `rake hello`
+    Then the output should contain:
+    """
+    gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    gcc -H -fPIC -I. -c main.c -o ./main.o
+    gcc -shared -Wl,-soname,libhello.so.0 -o ./libhello.so.0.1.0 ./hello.o -lm
+    ln -s libhello.so.0.1.0 libhello.so
+    ln -s libhello.so.0.1.0 libhello.so.0
+    gcc -o ./hello ./main.o -L. -lhello
+    """
+    And a file named "libhello.so.0.1.0" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  @mac
+  Scenario: Build a shared library from one *.c and *.h file
+    Given the current project directory is "examples/shared_library"
+    When I successfully run `rake hello`
+    Then the output should contain:
+    """
+    gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    gcc -H -fPIC -I. -c main.c -o ./main.o
+    gcc -shared -Wl,-install_name,libhello.so.0 -o ./libhello.so.0.1.0 ./hello.o -lm
+    ln -s libhello.so.0.1.0 libhello.so
+    ln -s libhello.so.0.1.0 libhello.so.0
+    gcc -o ./hello ./main.o -L. -lhello
+    """
+    And a file named "libhello.so.0.1.0" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  @linux
+  Scenario: Build a shared library from one *.c and *.h file using llvm-gcc by specifying `CC=` option
+    Given the current project directory is "examples/shared_library"
+    When I successfully run `rake hello CC=llvm-gcc`
+    Then the output should contain:
+    """
+    llvm-gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    llvm-gcc -H -fPIC -I. -c main.c -o ./main.o
+    llvm-gcc -shared -Wl,-soname,libhello.so.0 -o ./libhello.so.0.1.0 ./hello.o -lm
+    ln -s libhello.so.0.1.0 libhello.so
+    ln -s libhello.so.0.1.0 libhello.so.0
+    llvm-gcc -o ./hello ./main.o -L. -lhello
+    """
+    And a file named "libhello.so.0.1.0" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  @mac
+  Scenario: Build a shared library from one *.c and *.h file using llvm-gcc by specifying `CC=` option
+    Given the current project directory is "examples/shared_library"
+    When I successfully run `rake hello CC=llvm-gcc`
+    Then the output should contain:
+    """
+    llvm-gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    llvm-gcc -H -fPIC -I. -c main.c -o ./main.o
+    llvm-gcc -shared -Wl,-install_name,libhello.so.0 -o ./libhello.so.0.1.0 ./hello.o -lm
+    ln -s libhello.so.0.1.0 libhello.so
+    ln -s libhello.so.0.1.0 libhello.so.0
+    llvm-gcc -o ./hello ./main.o -L. -lhello
+    """
+    And a file named "libhello.so.0.1.0" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  @linux
+  Scenario: Build a shared library from one *.c and *.h file using llvm-gcc
+    Given the current project directory is "examples/shared_library"
+    When I successfully run `rake -f Rakefile.llvm hello`
+    Then the output should contain:
+    """
+    llvm-gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    llvm-gcc -H -fPIC -I. -c main.c -o ./main.o
+    llvm-gcc -shared -Wl,-soname,libhello.so.0 -o ./libhello.so.0.1.0 ./hello.o -lm
+    ln -s libhello.so.0.1.0 libhello.so
+    ln -s libhello.so.0.1.0 libhello.so.0
+    llvm-gcc -o ./hello ./main.o -L. -lhello
+    """
+    And a file named "libhello.so.0.1.0" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  @mac
+  Scenario: Build a shared library from one *.c and *.h file using llvm-gcc
+    Given the current project directory is "examples/shared_library"
+    When I successfully run `rake -f Rakefile.llvm hello`
+    Then the output should contain:
+    """
+    llvm-gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    llvm-gcc -H -fPIC -I. -c main.c -o ./main.o
+    llvm-gcc -shared -Wl,-install_name,libhello.so.0 -o ./libhello.so.0.1.0 ./hello.o -lm
+    ln -s libhello.so.0.1.0 libhello.so
+    ln -s libhello.so.0.1.0 libhello.so.0
+    llvm-gcc -o ./hello ./main.o -L. -lhello
+    """
+    And a file named "libhello.so.0.1.0" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  @linux
+  Scenario: Build a shared library from multiple *.c and *.h files in subcirectories
+    Given the current project directory is "examples/shared_library_subdirs"
+    When I successfully run `rake hello`
+    Then the output should contain:
+    """
+    gcc -H -Werror -Wall -Wextra -fPIC -Iincludes -Isources -c sources/hello.c -o objects/hello.o
+    gcc -H -fPIC -Iincludes -Isources -c sources/main.c -o ./main.o
+    mkdir -p objects
+    gcc -shared -Wl,-soname,libhello.so.0 -o objects/libhello.so.0.1.0 objects/hello.o
+    ln -s objects/libhello.so.0.1.0 libhello.so
+    ln -s objects/libhello.so.0.1.0 libhello.so.0
+    gcc -o ./hello ./main.o -L. -lhello
+    """
+    And a file named "objects/libhello.so.0.1.0" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  @mac
+  Scenario: Build a shared library from multiple *.c and *.h files in subcirectories
+    Given the current project directory is "examples/shared_library_subdirs"
+    When I successfully run `rake hello`
+    Then the output should contain:
+    """
+    gcc -H -Werror -Wall -Wextra -fPIC -Iincludes -Isources -c sources/hello.c -o objects/hello.o
+    gcc -H -fPIC -Iincludes -Isources -c sources/main.c -o ./main.o
+    mkdir -p objects
+    gcc -shared -Wl,-install_name,libhello.so.0 -o objects/libhello.so.0.1.0 objects/hello.o
+    ln -s objects/libhello.so.0.1.0 libhello.so
+    ln -s objects/libhello.so.0.1.0 libhello.so.0
+    gcc -o ./hello ./main.o -L. -lhello
+    """
+    And a file named "objects/libhello.so.0.1.0" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  Scenario: Automatically rebuild an executable when dependent library is updated
+    Given the current project directory is "examples/shared_library"
+    And I successfully run `rake hello`
+    And I successfully run `sleep 1`
+    And I successfully run `touch libhello.so.0`
+    When I successfully run `rake hello`
+    Then the output should contain:
+    """
+    gcc -o ./hello ./main.o -L. -lhello
+    """
+
+  Scenario: Clean
+    Given the current project directory is "examples/shared_library"
+    When I successfully run `rake hello`
+    When I successfully run `rake clean`
+    Then a file named "hello.o" should not exist
+    And a file named "main.o" should not exist
+    And a file named ".libhello.depends" should exist
+    And a file named ".hello.depends" should exist
+    And a file named "libhello.so.0.1.0" should exist
+    And a file named "hello" should exist
+
+  Scenario: Clobber
+    Given the current project directory is "examples/shared_library"
+    When I successfully run `rake hello`
+    When I successfully run `rake clobber`
+    Then a file named "hello.o" should not exist
+    And a file named "main.o" should not exist
+    And a file named ".libhello.depends" should not exist
+    And a file named ".hello.depends" should not exist
+    And a file named "libhello.so.0.1.0" should not exist
+    And a file named "hello" should not exist

data/features/static_library_task.feature

@@ -0,0 +1,116 @@
+Feature: PaperHouse::StaticLibraryTask
+
+  PaperHouse provides a rake task called
+  `PaperHouse::StaticLibraryTask` to build a static library from *.c
+  and *.h files. These source files can be located in multiple
+  subdirectories.
+
+  Scenario: Build a static library from one *.c and *.h file
+    Given the current project directory is "examples/static_library"
+    When I successfully run `rake hello`
+    Then the output should contain:
+    """
+    gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    gcc -H -fPIC -I. -c main.c -o ./main.o
+    ar -cq ./libhello.a ./hello.o
+    ranlib ./libhello.a
+    gcc -o ./hello ./main.o -L. -lhello
+    """
+    And a file named "libhello.a" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  Scenario: Build a static library from one *.c and *.h file using llvm-gcc by specifying `CC=` option
+    Given the current project directory is "examples/static_library"
+    When I successfully run `rake hello CC=llvm-gcc`
+    Then the output should contain:
+    """
+    llvm-gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    llvm-gcc -H -fPIC -I. -c main.c -o ./main.o
+    ar -cq ./libhello.a ./hello.o
+    ranlib ./libhello.a
+    llvm-gcc -o ./hello ./main.o -L. -lhello
+    """
+    And a file named "libhello.a" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  Scenario: Build a static library from one *.c and *.h file using llvm-gcc
+    Given the current project directory is "examples/static_library"
+    When I successfully run `rake -f Rakefile.llvm hello`
+    Then the output should contain:
+    """
+    llvm-gcc -H -fPIC -I. -c hello.c -o ./hello.o
+    llvm-gcc -H -fPIC -I. -c main.c -o ./main.o
+    ar -cq ./libhello.a ./hello.o
+    ranlib ./libhello.a
+    llvm-gcc -o ./hello ./main.o -L. -lhello
+    """
+    And a file named "libhello.a" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  Scenario: Build a static library from multiple *.c and *.h files in subcirectories
+    Given the current project directory is "examples/static_library_subdirs"
+    When I successfully run `rake hello`
+    Then the output should contain:
+    """
+    gcc -H -Werror -Wall -Wextra -fPIC -Iincludes -Isources -c sources/hello.c -o objects/hello.o
+    gcc -H -fPIC -Iincludes -Isources -c sources/main.c -o ./main.o
+    mkdir -p objects
+    ar -cq objects/libhello.a objects/hello.o
+    ranlib objects/libhello.a
+    gcc -o ./hello ./main.o -Lobjects -lhello
+    """
+    And a file named "objects/libhello.a" should exist
+    And a file named "hello" should exist
+    And I successfully run `./hello`
+    And the output should contain:
+    """
+    Hello, PaperHouse!
+    """
+
+  Scenario: Automatically rebuild an executable when dependent library is updated
+    Given the current project directory is "examples/static_library"
+    And I successfully run `rake hello`
+    And I successfully run `sleep 1`
+    And I successfully run `touch libhello.a`
+    When I successfully run `rake hello`
+    Then the output should contain:
+    """
+    gcc -o ./hello ./main.o -L. -lhello
+    """
+
+  Scenario: Clean
+    Given the current project directory is "examples/static_library"
+    And I successfully run `rake hello`
+    When I successfully run `rake clean`
+    Then a file named "hello.o" should not exist
+    And a file named "main.o" should not exist
+    And a file named ".libhello.depends" should exist
+    And a file named ".hello.depends" should exist
+    And a file named "libhello.a" should exist
+    And a file named "hello" should exist
+
+  Scenario: Clobber
+    Given the current project directory is "examples/static_library"
+    And I successfully run `rake hello`
+    When I successfully run `rake clobber`
+    Then a file named "hello.o" should not exist
+    And a file named "main.o" should not exist
+    And a file named ".libhello.depends" should not exist
+    And a file named ".hello.depends" should not exist
+    And a file named "libhello.a" should not exist
+    And a file named "hello" should not exist

data/features/step_definitions/paper_house_steps.rb

@@ -0,0 +1,8 @@
+Given(/^the current project directory is "(.*?)"$/) do | dir |
+  in_current_dir do
+    project_files = Dir.glob( File.join( "..", "..", dir, "*" ) )
+    FileUtils.cp_r project_files, "."
+    system "rake clobber"
+    FileUtils.rm_r "objects" if FileTest.exists?( "objects" )
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,41 @@
+#
+# 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 "rubygems"
+
+require "simplecov"
+SimpleCov.start
+
+require "aruba/cucumber"
+require "rake"
+
+
+ENV[ "LD_LIBRARY_PATH" ] = "."
+
+
+if ENV[ "TRAVIS" ]
+  require "coveralls"
+  Coveralls.wear_merged!
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/features/support/hooks.rb

@@ -0,0 +1,12 @@
+Before do
+  ENV[ "CC" ] = nil
+  ENV[ "dragonegg_disable_version_check" ] = "1"
+  @aruba_timeout_seconds = 5
+end
+
+
+After do
+  ENV[ "CC" ] = nil
+  ENV[ "dragonegg_disable_version_check" ] = nil
+  Rake::Task.clear
+end