paper_house 0.5.0 → 0.6.0

data/README.md

@@ -1,10 +1,16 @@
 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)
+[![Gem Version](http://img.shields.io/gem/v/paper_house.svg)][gem]
+[![Build Status](http://img.shields.io/travis/trema/paper-house/develop.svg)][travis]
+[![Code Climate](http://img.shields.io/codeclimate/github/trema/paper-house.svg)][codeclimate]
+[![Coverage Status](http://img.shields.io/coveralls/trema/paper-house/develop.svg)][coveralls]
+[![Dependency Status](http://img.shields.io/gemnasium/trema/paper-house.svg)][gemnasium]
+
+[gem]: https://rubygems.org/gems/paper_house
+[travis]: http://travis-ci.org/trema/paper-house
+[codeclimate]: https://codeclimate.com/github/trema/paper-house
+[coveralls]: https://coveralls.io/r/trema/paper-house?branch=develop
+[gemnasium]: 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>
 
@@ -22,9 +28,10 @@ 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.
+   ([makedepend](http://linux.die.net/man/1/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).
+   major version of Ruby (1.9.3, 2.0.0).
 
 
 Example
@@ -35,17 +42,18 @@ and `*.h` files in the current directory, just add the following lines
 to your `Rakefile`.
 
 ```ruby
-require "paper_house"
+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``.
+an executable named `hello`.
 
 If you wish to customize the build process more, please set the
-following options defined in `PaperHouse::ExecutableTask`:
+following options defined in
+[PaperHouse::ExecutableTask](http://rubydoc.info/github/trema/paper-house/PaperHouse/ExecutableTask):
 
 ```ruby
 PaperHouse::ExecutableTask.new :hello do |task|

data/Rakefile

@@ -1,126 +1,16 @@
-#
-# 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.
-#
+# encoding: utf-8
 
 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']
+# rubocop:disable HashSyntax
 
 task :default => :travis
-task :travis => [:spec, :cucumber, :quality, 'coveralls:push']
-task :quality => [:reek, :flog, :flay]
-
-Coveralls::RakeTask.new
-
-RSpec::Core::RakeTask.new
-
-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|
-    !(/##{flog.no_method}$/ =~ name) && score > threshold
-  end
-  bad_methods.sort { |a, b| a[1] <=> b[1] }.reverse.each do |name, score|
-    puts sprintf('%8.1f: %s', [score, name])
-  end
-  unless bad_methods.empty?
-    fail "#{bad_methods.size} methods have a flog complexity > #{threshold}"
-  end
-end
 
-FlayTask.new do |t|
-  t.dirs = ruby_source.map do |each|
-    each[/[^\/]+/]
-  end.uniq
-  t.threshold = 0
-  t.verbose = true
-end
-
-if RUBY_VERSION >= '1.9.0'
-  task :quality => :rubocop
-  require 'rubocop/rake_task'
-  Rubocop::RakeTask.new
-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 Rake.verbose
-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
+task :travis => [:spec, :cucumber, :quality, 'coveralls:push']
 
-rubies.each do |each|
-  portability_task_name = "portability:#{each}"
-  task :portability => portability_task_name
+desc 'Check for code quality'
+task :quality => [:reek, :flog, :flay, :rubocop]
 
-  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
+# rubocop:enable HashSyntax
 
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:
+Dir.glob('tasks/*.rake').each { |each| import each }

data/features/executable_task.feature

@@ -69,3 +69,9 @@ Feature: PaperHouse::ExecutableTask
     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
+
+  Scenario: Failure
+    Given the current project directory is "examples/fail"
+    When I run `rake hello`
+    Then the exit status should not be 0
+    And the stderr should contain "failed with status"

data/features/step_definitions/paper_house_steps.rb

@@ -9,7 +9,7 @@ Given(/^the current project directory is "(.*?)"$/) do | dir |
       FileUtils.rm_r 'objects' if FileTest.exists?('objects')
     end
   end
-  step %{I cd to "#{example_name}"}
+  step %(I cd to "#{example_name}")
 end
 
 When(/^I run rake "(.*?)"$/) do |args|

data/features/support/env.rb

@@ -1,38 +1,9 @@
-# -*- 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 'rubygems'
-
-require 'simplecov'
-SimpleCov.start
+# encoding: utf-8
 
 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:
+require 'coveralls'
+Coveralls.wear_merged!

data/lib/paper_house/auto_depends.rb

@@ -1,21 +1,8 @@
 # -*- 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.
-#
+# encoding: utf-8
 
+require 'paper_house/build_failed'
 require 'paper_house/safe_popen'
 
 module PaperHouse
@@ -38,7 +25,7 @@ module PaperHouse
     def run
       @out.puts @command
       exit_status = popen_command
-      fail "#{@cc} failed" if exit_status != 0
+      fail BuildFailed.new(@command, exit_status) if exit_status != 0
     end
 
     private
@@ -47,7 +34,7 @@ module PaperHouse
       SafePopen.popen(@command) do |stdout, stderr, stdin, |
         stdin.close
         parse_cc_h_stderr stderr
-      end.exitstatus
+      end
     end
 
     def parse_cc_h_stderr(stderr)
@@ -82,9 +69,3 @@ module PaperHouse
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/paper_house/build_failed.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+
+module PaperHouse
+  # Exception raised if a build task fails
+  class BuildFailed < ::StandardError
+    attr_reader :command
+    attr_reader :status
+
+    def initialize(command, status)
+      @command = command
+      @status = status
+    end
+
+    def message
+      "Command `#{command}' failed with status #{status.exitstatus}"
+    end
+  end
+end

data/lib/paper_house/build_task.rb

@@ -1,24 +1,9 @@
-# -*- 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.
-#
+# encoding: utf-8
 
 require 'paper_house/auto_depends'
-require 'paper_house/dependency'
+require 'paper_house/build_failed'
 require 'paper_house/cc_options'
+require 'paper_house/dependency'
 require 'rake/clean'
 require 'rake/tasklib'
 
@@ -154,11 +139,12 @@ module PaperHouse
     def dependency
       @dependency ||= Dependency.new(@name)
     end
+
+    def generate_target
+      command = ([cc] + cc_options).join(' ')
+      sh(command) do |ok, status|
+        ok || fail(BuildFailed.new(command, status))
+      end
+    end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/paper_house/cc_options.rb

@@ -1,20 +1,4 @@
-# -*- 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.
-#
+# encoding: utf-8
 
 module PaperHouse
   # CC option utilities.
@@ -63,9 +47,3 @@ module PaperHouse
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/paper_house/dependency.rb

@@ -1,20 +1,4 @@
-# -*- 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.
-#
+# encoding: utf-8
 
 require 'pstore'
 require 'rake'
@@ -57,9 +41,3 @@ module PaperHouse
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/paper_house/executable_task.rb

@@ -1,20 +1,4 @@
-# -*- 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.
-#
+# encoding: utf-8
 
 require 'paper_house/build_task'
 require 'paper_house/linker_options'
@@ -46,10 +30,6 @@ module PaperHouse
 
     private
 
-    def generate_target
-      sh(([cc] + cc_options).join(' '))
-    end
-
     def cc_options
       [o_option, objects, ldflags, l_options].flatten
     end
@@ -59,9 +39,3 @@ module PaperHouse
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/paper_house/library_task.rb

@@ -1,20 +1,4 @@
-# -*- 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.
-#
+# encoding: utf-8
 
 require 'paper_house/build_task'
 
@@ -54,9 +38,3 @@ module PaperHouse
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/paper_house/linker_options.rb

@@ -1,20 +1,4 @@
-# -*- 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.
-#
+# encoding: utf-8
 
 module PaperHouse
   #
@@ -71,9 +55,3 @@ module PaperHouse
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/paper_house/platform.rb

@@ -1,20 +1,4 @@
-# -*- 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.
-#
+# encoding: utf-8
 
 require 'rbconfig'
 
@@ -38,23 +22,18 @@ module PaperHouse
     SONAME_OPTION = MAC ? '-install_name' : '-soname'
 
     # 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
+    RUBY_INCLUDES =
+      [
+        File.join(CONFIG['rubyhdrdir'], CONFIG['arch']),
+        File.join(CONFIG['rubyhdrdir'], 'ruby/backward'),
+        CONFIG['rubyhdrdir']
+      ]
 
     # Library directories for compiling C extensions.
     RUBY_LIBDIR = CONFIG['libdir']
+
+    def self.name
+      MAC ? 'mac' : 'linux'
+    end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/paper_house/ruby_extension_task.rb

@@ -1,20 +1,4 @@
-# -*- 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.
-#
+# encoding: utf-8
 
 require 'paper_house/library_task'
 require 'paper_house/linker_options'
@@ -46,10 +30,6 @@ module PaperHouse
 
     private
 
-    def generate_target
-      sh(([cc] + cc_options).join(' '))
-    end
-
     def cc_options
       [LDSHARED, o_option, objects, ldflags, libdir_option, l_options].flatten
     end
@@ -67,9 +47,3 @@ module PaperHouse
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/paper_house/safe_popen.rb

@@ -1,20 +1,4 @@
-# -*- 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.
-#
+# encoding: utf-8
 
 require 'popen4'
 
@@ -40,9 +24,3 @@ module PaperHouse
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End: