paper_house 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76f6b308698dc77f7b335bc6b0ef88673815a48e
+  data.tar.gz: 64f2969fa8e010f9508d07b268c8492effde8594
+SHA512:
+  metadata.gz: ffba1f28e1c9deb249c5e48cb14bb152103439831367586bf8c4284d04f86c7aab34b615ce09247491689c8989586d7b72c9b899ffda1b52835ec3aaf1e50231
+  data.tar.gz: fe01a0af5f02b5a122bbb2f16aad92f61c862190504e185f3af086bc42522594620b4413c140cb92a430ca1b43d87b2299ff919d7f16846919724de8da30eba1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+InstalledFiles
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+script: "rake travis"
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+branches:
+  only:
+    - master
+    - develop
+
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install -qq llvm-gcc-4.6
+

data/Gemfile

@@ -0,0 +1,35 @@
+source "https://rubygems.org"
+
+
+gemspec
+
+
+group :development do
+  gem "aruba", "~> 0.5.3"
+  gem "coveralls", "~> 0.7.0", :require => false
+  gem "cucumber", "~> 1.3.8"
+  gem "flay", "~> 2.4.0"
+  gem "flog", "~> 4.1.2"
+  gem "guard", "~> 1.8.3"
+  gem "guard-bundler", "~> 1.0.0"
+  gem "guard-cucumber", "~> 1.4.0"
+  gem "guard-rspec", "~> 3.1.0"
+  gem "rb-fchange", "~> 0.0.6", :require => false
+  gem "rb-fsevent", "~> 0.9.3", :require => false
+  gem "rb-inotify", "~> 0.9.2", :require => false
+  gem "redcarpet", "~> 2.3.0" if RUBY_VERSION < "1.9.0"
+  gem "redcarpet", "~> 3.0.0" if RUBY_VERSION >= "1.9.0"
+  gem "reek", "~> 1.3.3"
+  gem "relish", "~> 0.7"
+  gem "rspec", "~> 2.14.1"
+  gem "rspec-instafail", "~> 0.2.4"
+  gem "terminal-notifier-guard", "~> 1.5.3"
+  gem "yard", "~> 0.8.7.2"
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/Guardfile

@@ -0,0 +1,28 @@
+# More info at https://github.com/guard/guard#readme
+
+notification :terminal_notifier
+notification :tmux, :display_message => true
+
+
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+
+guard :rspec, :cli => "--color -r rspec/instafail -f RSpec::Instafail", :all_on_start => false do
+  watch(%r{^spec/paper_house/.+_spec\.rb$})
+  watch(%r{^lib/paper_house/(.+)\.rb$})     { |m| "spec/paper_house/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+
+require "paper_house/platform"
+
+cli_opts = %w(--format progress --strict --profile) + [ PaperHouse::Platform::MAC ? "mac" : "linux" ]
+
+guard :cucumber, :cli => cli_opts.join( " " ), :all_on_start => false do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/README.md

@@ -0,0 +1,116 @@
+Paper House
+===========
+[![Gem Version](https://badge.fury.io/rb/paper-house.png)](http://badge.fury.io/rb/paper-house)
+[![Build Status](https://travis-ci.org/trema/paper-house.png?branch=develop)](https://travis-ci.org/trema/paper-house)
+[![Code Climate](https://codeclimate.com/github/trema/paper-house.png)](https://codeclimate.com/github/trema/paper-house)
+[![Coverage Status](https://coveralls.io/repos/trema/paper-house/badge.png?branch=develop)](https://coveralls.io/r/trema/paper-house)
+[![Dependency Status](https://gemnasium.com/trema/paper-house.png)](https://gemnasium.com/trema/paper-house)
+
+<a href="http://www.flickr.com/photos/studiobeerhorst/8221979536/" title="paper houses - 3d woodcut prints by Rick&Brenda Beerhorst, on Flickr"><img src="http://farm9.staticflickr.com/8202/8221979536_60404c309d_n.jpg" width="320" height="240" alt="paper houses - 3d woodcut prints" align="right"></a>
+
+Paper House is a ruby gem to easily build C projects using [Rake](https://github.com/jimweirich/rake). It supports the following build targets:
+
+ * [Executable](http://rubydoc.info/github/trema/paper-house/PaperHouse/ExecutableTask)
+ * [Static library](http://rubydoc.info/github/trema/paper-house/PaperHouse/StaticLibraryTask)
+ * [Shared library](http://rubydoc.info/github/trema/paper-house/PaperHouse/SharedLibraryTask)
+ * [C extension for Ruby](http://rubydoc.info/github/trema/paper-house/PaperHouse/CExtensionTask)
+
+
+Features Overview
+-----------------
+
+ * Provides a simple yet a powerful syntax to build above mentioned
+   targets using predefined Rake tasks.
+ * Pure Ruby. No additional dependency on other external tools
+   (`makedepend` etc.) to resolve file dependencies.
+ * Multi-Platform. Runs on both Linux and MacOSX, and supports all
+   major version of Ruby (1.8.7, 1.9.3, 2.0.0).
+
+
+Example
+-------
+
+Its usage is dead simple: to build an executable from all the `*.c`
+and `*.h` files in the current directory, just add the following lines
+to your `Rakefile`.
+
+```ruby
+require "paper_house"
+
+PaperHouse::ExecutableTask.new :hello
+```
+
+This defines a new task `hello`, and `rake hello` will automatically
+analyze all file dependencies of the source files, compile them into
+an executable named `hello``.
+
+If you wish to customize the build process more, please set the
+following options defined in `PaperHouse::ExecutableTask`:
+
+```ruby
+PaperHouse::ExecutableTask.new :hello do | task |
+  task.executable_name = "hello_world"
+  task.target_directory = "objects"
+  task.cc = "llvm-gcc"
+  task.includes = "includes"
+  task.sources = "sources"
+  task.cflags = [ "-Werror", "-Wall", "-Wextra" ]
+  task.ldflags = "-L/some/path"
+  task.library_dependencies = "m"
+end
+```
+
+You can find more examples in the
+[examples/](https://github.com/trema/paper-house/tree/master/examples)
+directory.
+
+
+Installation
+------------
+
+The simplest way to install Paper House is to use [Bundler](http://gembundler.com/).
+
+Add Paper House to your `Gemfile`:
+
+```ruby
+gem 'paper_house'
+```
+
+and install it by running Bundler:
+
+```bash
+$ bundle
+```
+
+
+Documents
+---------
+
+ * [API document generated with YARD](http://rubydoc.info/github/trema/paper-house/frames/file/README.md)
+ * [Usage document generated with Cucumber and Relish](https://www.relishapp.com/trema/paper-house/docs)
+
+
+### Author
+
+[Yasuhito Takamiya](https://github.com/yasuhito) ([@yasuhito](http://twitter.com/yasuhito))
+
+### Contributors
+
+[https://github.com/trema/paper-house/contributors](https://github.com/trema/paper-house/contributors)
+
+
+Alternatives
+------------
+
+ * rake-compiler: https://github.com/luislavena/rake-compiler
+ * rake-builder: https://github.com/joeyates/rake-builder
+ * Rant: http://rant.rubyforge.org/
+ * cxxproject: https://github.com/marcmo/cxxproject
+
+
+License
+-------
+
+Trema is released under the GNU General Public License version 3.0:
+
+* http://www.gnu.org/licenses/gpl.html

data/Rakefile

@@ -0,0 +1,139 @@
+#
+# 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 "bundler/gem_tasks"
+require "coveralls/rake/task"
+require "flay"
+require "flay_task"
+require "flog"
+require "rake/tasklib"
+require "reek/rake/task"
+require "rspec/core"
+require "rspec/core/rake_task"
+require "yaml"
+require "yard"
+
+
+$ruby_source = FileList[ "lib/**/*.rb" ]
+
+
+task :default => :travis
+task :travis => [ :spec, :cucumber, :quality, "coveralls:push" ]
+task :quality => [ :reek, :flog, :flay ]
+
+
+Coveralls::RakeTask.new
+
+
+RSpec::Core::RakeTask.new do | task |
+  task.rspec_opts = "--format documentation --color"
+end
+
+
+require "cucumber/rake/task"
+Cucumber::Rake::Task.new do | t |
+  profile = %w(--profile)
+  require "paper_house/platform"
+  if PaperHouse::Platform::MAC
+    profile << "mac"
+  else
+    profile << "linux"
+  end
+  t.cucumber_opts = profile.join( " " )
+end
+
+
+Reek::Rake::Task.new do | t |
+  t.fail_on_error = true
+  t.verbose = false
+  t.ruby_opts = [ "-rubygems" ]
+  t.reek_opts = "--quiet"
+  t.source_files = $ruby_source
+end
+
+
+desc "Analyze for code complexity"
+task :flog do
+  flog = Flog.new( :continue => true )
+  flog.flog( *$ruby_source )
+  threshold = 10
+
+  bad_methods = flog.totals.select do | name, score |
+    ( not ( /##{flog.no_method}$/=~ name ) ) and score > threshold
+  end
+  bad_methods.sort do | a, b |
+    a[ 1 ] <=> b[ 1 ]
+  end.reverse.each do | name, score |
+    puts "%8.1f: %s" % [ score, name ]
+  end
+  unless bad_methods.empty?
+    raise "#{ bad_methods.size } methods have a flog complexity > #{ threshold }"
+  end
+end
+
+
+FlayTask.new do | t |
+  t.dirs = $ruby_source.collect do | each |
+    each[ /[^\/]+/ ]
+  end.uniq
+  t.threshold = 0
+  t.verbose = $trace
+end
+
+
+task :relish do
+  sh "relish push trema/paper-house"
+end
+
+
+YARD::Rake::YardocTask.new do | t |
+  t.options = [ "--no-private" ]
+  t.options << "--debug" << "--verbose" if $trace
+end
+
+
+def travis_yml
+  File.join File.dirname( __FILE__ ), ".travis.yml"
+end
+
+
+def rubies
+  ( [ "1.8.7" ] + YAML.load_file( travis_yml )[ "rvm" ] ).uniq.sort
+end
+
+
+desc "Run tests against multiple rubies"
+task :portability
+
+rubies.each do | each |
+  portability_task_name = "portability:#{ each }"
+  task :portability => portability_task_name
+
+  desc "Run tests against Ruby#{ each }"
+  task portability_task_name do
+    sh "rvm #{ each } exec bundle"
+    sh "rvm #{ each } exec bundle exec rake"
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/cucumber.yml

@@ -0,0 +1,3 @@
+linux: --tags ~@wip --tags ~@mac
+mac: --tags ~@wip --tags ~@linux
+

data/examples/c_extension/.gitignore

@@ -0,0 +1,5 @@
+.hello.depends
+hello.bundle
+hello.o
+hello.so
+

data/examples/c_extension/Rakefile

@@ -0,0 +1,3 @@
+require "paper_house"
+
+PaperHouse::CExtensionTask.new :hello

data/examples/c_extension/Rakefile.llvm

@@ -0,0 +1,5 @@
+require "paper_house"
+
+PaperHouse::CExtensionTask.new :hello do | task |
+  task.cc = "llvm-gcc"
+end

data/examples/c_extension/hello.c

@@ -0,0 +1,6 @@
+#include "ruby.h"
+
+void
+Init_hello() {
+  VALUE cHelloPaperHouse = rb_define_class( "HelloPaperHouse", rb_cObject );
+}

data/examples/executable/.gitignore

@@ -0,0 +1,4 @@
+.hello.depends
+hello
+hello.o
+

data/examples/executable/Rakefile

@@ -0,0 +1,3 @@
+require "paper_house"
+
+PaperHouse::ExecutableTask.new :hello

data/examples/executable/Rakefile.llvm

@@ -0,0 +1,5 @@
+require "paper_house"
+
+PaperHouse::ExecutableTask.new :hello do | task |
+  task.cc = "llvm-gcc"
+end

data/examples/executable/hello.c

@@ -0,0 +1,7 @@
+#include <stdio.h>
+
+int
+main() {
+  printf( "Hello, PaperHouse!\n");
+  return 0;
+}

data/examples/executable_subdirs/.gitignore

@@ -0,0 +1,4 @@
+.hello.depends
+hello
+hello.o
+main.o

data/examples/executable_subdirs/Rakefile

@@ -0,0 +1,9 @@
+require "paper_house"
+
+PaperHouse::ExecutableTask.new :hello do | task |
+  task.executable_name = "hello"
+  task.target_directory = "objects"
+  task.sources = "sources/*.c"
+  task.includes = "includes"
+  task.cflags = [ "-Wall", "-Wextra" ]
+end

data/examples/executable_subdirs/includes/hello.h

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

data/examples/executable_subdirs/sources/hello.c

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

data/examples/executable_subdirs/sources/main.c

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

data/examples/shared_library/.gitignore

@@ -0,0 +1,8 @@
+.hello.depends
+.libhello.depends
+hello
+hello.o
+libhello.so
+libhello.so.0
+libhello.so.0.1.0
+main.o

data/examples/shared_library/Rakefile

@@ -0,0 +1,17 @@
+require "paper_house"
+
+$libhello = PaperHouse::SharedLibraryTask.new :libhello do | task |
+  task.version = "0.1.0"
+  task.sources = "hello.c"
+  task.library_dependencies = "m" # not used.
+end
+
+
+task :hello => [ :libhello, $libhello.linker_name, $libhello.soname ]
+
+PaperHouse::ExecutableTask.new :hello do | task |
+  task.sources = "main.c"
+  task.ldflags = "-L."
+end
+
+load "symlinks.rake"

data/examples/shared_library/Rakefile.llvm

@@ -0,0 +1,19 @@
+require "paper_house"
+
+$libhello = PaperHouse::SharedLibraryTask.new :libhello do | task |
+  task.version = "0.1.0"
+  task.sources = "hello.c"
+  task.cc = "llvm-gcc"
+  task.library_dependencies = "m" # not used.
+end
+
+
+task :hello => [ :libhello, $libhello.linker_name, $libhello.soname ]
+
+PaperHouse::ExecutableTask.new :hello do | task |
+  task.sources = "main.c"
+  task.cc = "llvm-gcc"
+  task.ldflags = "-L."
+end
+
+load "symlinks.rake"

data/examples/shared_library/hello.c

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

data/examples/shared_library/hello.h

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

data/examples/shared_library/main.c

@@ -0,0 +1,7 @@
+#include "hello.h"
+
+int
+main() {
+  hello();
+  return 0;
+}

data/examples/shared_library/symlinks.rake

@@ -0,0 +1,7 @@
+[ $libhello.linker_name, $libhello.soname ].each do | each |
+  file each do | task |
+    symlink $libhello.target_file_name, task.name
+  end
+
+  CLOBBER.include each if FileTest.exists?( each )
+end

data/examples/shared_library_subdirs/.gitignore

@@ -0,0 +1,8 @@
+.hello.depends
+.libhello.depends
+hello
+hello.o
+libhello.so
+libhello.so.0
+libhello.so.0.1.0
+main.o

data/examples/shared_library_subdirs/Rakefile

@@ -0,0 +1,27 @@
+require "paper_house"
+
+libhello = PaperHouse::SharedLibraryTask.new :libhello do | task |
+  task.library_name = "hello"
+  task.version = "0.1.0"
+  task.target_directory = "objects"
+  task.sources = "sources/hello.c"
+  task.includes = "includes"
+  task.cflags = [ "-Werror", "-Wall", "-Wextra" ]
+end
+
+
+task :hello => [ :libhello, libhello.linker_name, libhello.soname ]
+
+PaperHouse::ExecutableTask.new :hello do | task |
+  task.sources = "sources/main.c"
+  task.includes = "includes"
+  task.ldflags = "-L."
+end
+
+[ libhello.linker_name, libhello.soname ].each do | each |
+  file each do | task |
+    symlink File.join( "objects", libhello.target_file_name ), task.name
+  end
+
+  CLOBBER.include each if FileTest.exists?( each )
+end

data/examples/shared_library_subdirs/includes/hello.h

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

data/examples/shared_library_subdirs/sources/hello.c

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

data/examples/shared_library_subdirs/sources/main.c

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

data/examples/static_library/.gitignore

@@ -0,0 +1,7 @@
+.hello.depends
+.libhello.depends
+hello
+hello.o
+libhello.a
+main.o
+

data/examples/static_library/Rakefile

@@ -0,0 +1,13 @@
+require "paper_house"
+
+task :hello => :libhello
+
+PaperHouse::StaticLibraryTask.new :libhello do | task |
+  task.sources = "hello.c"
+end
+
+
+PaperHouse::ExecutableTask.new :hello do | task |
+  task.ldflags = "-L."
+  task.sources = "main.c"
+end

data/examples/static_library/Rakefile.llvm

@@ -0,0 +1,14 @@
+require "paper_house"
+
+task :hello => :libhello
+
+PaperHouse::StaticLibraryTask.new :libhello do | task |
+  task.cc = "llvm-gcc"
+  task.sources = "hello.c"
+end
+
+PaperHouse::ExecutableTask.new :hello do | task |
+  task.cc = "llvm-gcc"
+  task.ldflags = "-L."
+  task.sources = "main.c"
+end

data/examples/static_library/hello.c

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

data/examples/static_library/hello.h

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

data/examples/static_library/main.c

@@ -0,0 +1,7 @@
+#include "hello.h"
+
+int
+main() {
+  hello();
+  return 0;
+}

data/examples/static_library_subdirs/.gitignore

@@ -0,0 +1,7 @@
+.hello.depends
+.libhello.depends
+hello
+hello.o
+libhello.a
+main.o
+