paper_house 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83d636e710a9e46668564e002ac98bbc9f3cd631
-  data.tar.gz: b2e2476518e7525c286218e44ba056eb794d133b
+  metadata.gz: cd32bc848ebfef5fba3838600d62f9f04ed847f0
+  data.tar.gz: 7d0c0cb2a9c5ef813d209c659f1b4885bb0cc21b
 SHA512:
-  metadata.gz: ef8b24154b40f9e0e97ef8ee5baf2a166eb5e6b2141b29814fa781fae330ac3c31519da6aed8382e337115c72ae3318ecee3a4b24d0dea19c82716f013786773
-  data.tar.gz: 11c1e1ef0198a2f013f1a7a914ed563332a4a28c945c8a42a1cdaf011295cd82811ecb760acbe286a31c17eeb6f8e3e16e009f922e2c6ebbf0585404dae37049
+  metadata.gz: 3f2b002f1b9348348016771fdeec488408239653d6cca002fa0d149ec122e18aa650046fc9042f7069c3b564f5a39a3d9a62d11e5249f38b375c4b5c761ade88
+  data.tar.gz: d792a1b063b989e139471c2ab718a2afa5ae2239261be1cab9825072ac2770d86d46ec57b8c6105c6fd563d7e3dfc7f30fa13ffa5f72b95dc321c7ab49b677fd

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: rubocop-todo.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -3,6 +3,7 @@ language: ruby
 script: "rake travis"
 
 rvm:
+  - 1.8.7
   - 1.9.3
   - 2.0.0
 

data/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing to PaperHouse
+
+* Check out the latest develop to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't
+  requested it and/or contributed it.
+* Fork the project.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it
+  in a future version unintentionally.
+* Squash your commits.
+* Create a pull-request.

data/Gemfile

@@ -1,34 +1,33 @@
-source "https://rubygems.org"
-
+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 "fuubar", "~> 1.2.1"
-  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"
+  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 'fuubar', '~> 1.2.1'
+  gem 'guard', '~> 1.8.3' if RUBY_VERSION < '1.9.0'
+  gem 'guard', '~> 2.0.5' if RUBY_VERSION >= '1.9.0'
+  gem 'guard-cucumber', '~> 1.4.0'
+  gem 'guard-rspec', '~> 3.1.0' if RUBY_VERSION < '1.9.0'
+  gem 'guard-rspec', '~> 4.0.1' if RUBY_VERSION >= '1.9.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 'rubocop', '~> 0.14.1' if RUBY_VERSION >= '1.9.0'
+  gem 'terminal-notifier-guard', '~> 1.5.3'
+  gem 'yard', '~> 0.8.7.2'
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/Guardfile

@@ -4,13 +4,7 @@ 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
+guard :rspec, :cmd => "rspec --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" }

data/README.md

@@ -13,7 +13,7 @@ Paper House is a ruby gem to easily build C projects using [Rake](https://github
  * [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)
+ * [Ruby extension written in C](http://rubydoc.info/github/trema/paper-house/PaperHouse/RubyExtensionTask)
 
 
 Features Overview
@@ -48,15 +48,15 @@ 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"
+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 = %w(-Werror -Wall -Wextra)
+  task.ldflags = '-L/some/path'
+  task.library_dependencies = 'm'
 end
 ```
 

data/Rakefile

@@ -15,121 +15,110 @@
 # 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" ]
-
+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 ]
-
+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 |
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new do |t|
   profile = %w(--profile)
-  require "paper_house/platform"
+  require 'paper_house/platform'
   if PaperHouse::Platform::MAC
-    profile << "mac"
+    profile << 'mac'
   else
-    profile << "linux"
+    profile << 'linux'
   end
-  t.cucumber_opts = profile.join( " " )
+  t.cucumber_opts = profile.join(' ')
 end
 
-
-Reek::Rake::Task.new do | t |
+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
+  t.ruby_opts = ['-rubygems']
+  t.reek_opts = '--quiet'
+  t.source_files = ruby_source
 end
 
-
-desc "Analyze for code complexity"
+desc 'Analyze for code complexity'
 task :flog do
-  flog = Flog.new( :continue => true )
-  flog.flog( *$ruby_source )
+  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
+  bad_methods = flog.totals.select do |name, score|
+    !(/##{flog.no_method}$/ =~ name) && 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 ]
+  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?
-    raise "#{ bad_methods.size } methods have a flog complexity > #{ threshold }"
+    fail "#{bad_methods.size} methods have a flog complexity > #{threshold}"
   end
 end
 
-
-FlayTask.new do | t |
-  t.dirs = $ruby_source.collect do | each |
-    each[ /[^\/]+/ ]
+FlayTask.new do |t|
+  t.dirs = ruby_source.map do |each|
+    each[/[^\/]+/]
   end.uniq
   t.threshold = 0
-  t.verbose = $trace
+  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"
+  sh 'relish push trema/paper-house'
 end
 
-
-YARD::Rake::YardocTask.new do | t |
-  t.options = [ "--no-private" ]
-  t.options << "--debug" << "--verbose" if $trace
+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"
+  File.join File.dirname(__FILE__), '.travis.yml'
 end
 
-
 def rubies
-  ( [ "1.8.7" ] + YAML.load_file( travis_yml )[ "rvm" ] ).uniq.sort
+  (['1.8.7'] + YAML.load_file(travis_yml)['rvm']).uniq.sort
 end
 
-
-desc "Run tests against multiple rubies"
+desc 'Run tests against multiple rubies'
 task :portability
 
-rubies.each do | each |
-  portability_task_name = "portability:#{ each }"
+rubies.each do |each|
+  portability_task_name = "portability:#{each}"
   task :portability => portability_task_name
 
-  desc "Run tests against Ruby#{ each }"
+  desc "Run tests against Ruby#{each}"
   task portability_task_name do
-    sh "rvm #{ each } exec bundle"
-    sh "rvm #{ each } exec bundle exec rake"
+    sh "rvm #{each} exec bundle"
+    sh "rvm #{each} exec bundle exec rake"
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/examples/executable/Rakefile

@@ -1,3 +1,5 @@
-require "paper_house"
+# -*- coding: utf-8 -*-
+
+require 'paper_house'
 
 PaperHouse::ExecutableTask.new :hello

data/examples/executable_subdirs/Rakefile

@@ -1,9 +1,11 @@
-require "paper_house"
+# -*- coding: utf-8 -*-
+
+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" ]
+  task.executable_name = 'hello'
+  task.target_directory = 'objects'
+  task.sources = 'sources/*.c'
+  task.includes = 'includes'
+  task.cflags = %w(-Wall -Wextra)
 end

data/examples/ruby_extension/Rakefile

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+require 'paper_house'
+
+PaperHouse::RubyExtensionTask.new :hello

data/examples/ruby_extension/Rakefile.llvm

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

data/examples/shared_library/Rakefile

@@ -1,17 +1,23 @@
-require "paper_house"
+# -*- coding: utf-8 -*-
 
-$libhello = PaperHouse::SharedLibraryTask.new :libhello do | task |
-  task.version = "0.1.0"
-  task.sources = "hello.c"
-  task.library_dependencies = "m" # not used.
+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
 
+[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
 
-task :hello => [ :libhello, $libhello.linker_name, $libhello.soname ]
+task :hello => [:libhello, libhello.linker_name, libhello.soname]
 
-PaperHouse::ExecutableTask.new :hello do | task |
-  task.sources = "main.c"
-  task.ldflags = "-L."
+PaperHouse::ExecutableTask.new :hello do |task|
+  task.sources = 'main.c'
+  task.ldflags = '-L.'
 end
-
-load "symlinks.rake"

data/examples/shared_library/Rakefile.llvm

@@ -1,19 +1,25 @@
+# -*- coding: utf-8 -*-
+
 require "paper_house"
 
-$libhello = PaperHouse::SharedLibraryTask.new :libhello do | task |
+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
 
+[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
 
-task :hello => [ :libhello, $libhello.linker_name, $libhello.soname ]
+task :hello => [:libhello, libhello.linker_name, libhello.soname]
 
-PaperHouse::ExecutableTask.new :hello do | task |
+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_subdirs/Rakefile

@@ -1,27 +1,28 @@
-require "paper_house"
+# -*- coding: utf-8 -*-
+
+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" ]
+  task.library_name = 'hello'
+  task.version = '0.1.0'
+  task.target_directory = 'objects'
+  task.sources = 'sources/hello.c'
+  task.includes = 'includes'
+  task.cflags = %w(-Werror -Wall -Wextra)
 end
 
-
-task :hello => [ :libhello, libhello.linker_name, libhello.soname ]
+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."
+  task.sources = 'sources/main.c'
+  task.includes = 'includes'
+  task.ldflags = '-L.'
 end
 
-[ libhello.linker_name, libhello.soname ].each do | each |
+[libhello.linker_name, libhello.soname].each do | each |
   file each do | task |
-    symlink File.join( "objects", libhello.target_file_name ), task.name
+    symlink File.join('objects', libhello.target_file_name), task.name
   end
 
-  CLOBBER.include each if FileTest.exists?( each )
+  CLOBBER.include each if FileTest.exists?(each)
 end

data/examples/static_library/Rakefile

@@ -1,13 +1,14 @@
-require "paper_house"
+# -*- coding: utf-8 -*-
+
+require 'paper_house'
 
 task :hello => :libhello
 
 PaperHouse::StaticLibraryTask.new :libhello do | task |
-  task.sources = "hello.c"
+  task.sources = 'hello.c'
 end
 
-
 PaperHouse::ExecutableTask.new :hello do | task |
-  task.ldflags = "-L."
-  task.sources = "main.c"
+  task.ldflags = '-L.'
+  task.sources = 'main.c'
 end

data/examples/static_library_subdirs/Rakefile

@@ -1,17 +1,19 @@
-require "paper_house"
+# -*- coding: utf-8 -*-
+
+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" ]
+  task.library_name = 'hello'
+  task.target_directory = 'objects'
+  task.sources = 'sources/hello.c'
+  task.includes = 'includes'
+  task.cflags = %w(-Werror -Wall -Wextra)
 end
 
 PaperHouse::ExecutableTask.new :hello do | task |
-  task.sources = "sources/main.c"
-  task.includes = "includes"
-  task.ldflags = "-Lobjects"
+  task.sources = 'sources/main.c'
+  task.includes = 'includes'
+  task.ldflags = '-Lobjects'
 end

data/features/executable_task.feature

@@ -6,65 +6,53 @@ Feature: PaperHouse::ExecutableTask
 
   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:
+    When I run rake "hello"
+    Then the stderr 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!
-    """
+    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:
+    When I run rake "hello CC=llvm-gcc"
+    Then the stderr 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!
-    """
-
+    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:
+    When I run rake "-f Rakefile.llvm hello"
+    Then the stderr 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!
-    """
-
+    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:
+    When I run rake "hello"
+    Then the stderr should contain:
     """
+    mkdir -p objects
     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!
-    """
+    And the output should contain "Hello, PaperHouse!"
 
   Scenario: Clean
     Given the current project directory is "examples/executable"