rplusplus 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f11712f1e2e7bfb1949089f363d8e99bd588125
-  data.tar.gz: e21fa0e4daaf9185ea35878a74e3ee7905817f4e
+  metadata.gz: 446702f23e9654cb84e635114fa2b9d27fc3e2a2
+  data.tar.gz: bccd78bcfb59ba820bdebab6f61ca2652cf7b46a
 SHA512:
-  metadata.gz: c14309834c20d92ca82239aba502400cc64e12ec74916a3c43c8a06484a8b141feb46aa550b58b2ff18282125043716e4a556b0695f5145769148e4cc6fe9662
-  data.tar.gz: d6d06c50765b6a6078971ad2644b957bdc4558054bfbef4b33dd62998b776accd692bb9499c75ee77d3f1938c1ad662662977defafd509bb503f48d2ec980396
+  metadata.gz: 458624828a67224493f6023640750ecb14a78addd9cf6f3e1b6169f86bd1ec9afff3e0119268364c68386a4d870739e11174bd61e1bbe435a059b63e3fdf34ef
+  data.tar.gz: 9cbe6ac573fe8e1550cfe06bea6e5b3536bedf6fd8fa1029c70275d1d765d9d1dcb18b362a3b3e5807846d28da6486848943e308ebf54e2b305227829be477f6

data/README.md

@@ -4,30 +4,55 @@ Making C++ slightly less painful.
 
 R++ aims to being a collection of command-line utilities and magical fairy dust to make all the C++ monsters go away and let you, as the awesome programmer, get to what's important.
 
-WARNING: I just started this project so functionality is super limited. You have been warned!
-
 ## Installation
 
-    $ gem install rplusplus
+```
+$ gem install rplusplus
+```
+
+## Usage
 
-## Using it in your Rakefile
+### Create a new Project
 
-In your Rakefile, do this:
+Make a new C++ app, with a Rakefile, gitignore, and some skeleton source files:
 
 ```
+$ r++ new MyApp
+```
+
+This creates a folder called `MyApp` with a main source file called `my_app.cpp` as well as accompanying `Rakefile` and `.gitignore` files to get you going.
+
+### Class Generator
+
+Generate header and source file skeletons for a class:
+
+```
+$ r++ generate class MyClass
+```
+
+This generates a `my_class.h` and `my_class.cpp` file in the current directory.
+
+### In your Rakefile
+
+**NOTE**: You still have to do some work yourself in the Rakefile at this point. Grab the example Rakefile in `examples/Rakefile` and modify it to your needs.
+
+At the moment, all R++ can do is calculate the dependencies for you, a la `g++ -MM`. Just add this to your Rakefile:
+
+```ruby
 require 'rplusplus'
 env = RPlusPlus::Environment.new
 ```
 
-Now, env has some useful properties which you can make use of in your Rake tasks:
-
-  * `env.objects` is a hash of the form `'foo.o' => ['foo.cpp', 'foo.h', ...]`
-  * `env.builds` is a hash of the form `'main' => ['main.o', 'foo.o', ...]`
-  * `env.erbs` is a hash of the form `'foo.cpp' => ['foo.cpp.erb']`
+Now, `env` has some useful properties which you can make use of in your Rake tasks:
 
-`env.objects` and `env.builds` magically take into account any `*.erb` files in existence so you can just code away without any funny business.
+  * `env.objects` is a hash of `*.o` files to dependencies: e.g.
+    `'foo.o' => ['foo.cpp', 'foo.h', ...]`
+  * `env.builds` is a hash of executables to dependencies: e.g.
+    `'main' => ['main.o', 'foo.o', ...]`
+  * `env.erbs` is a hash of `*.erb` files to dependencies: e.g.
+    `'foo.cpp' => ['foo.cpp.erb']`
 
-I have used this in one of my own projects and it works like a charm, but I haven't come across any gotchas as of yet so YMMV.
+The `env.objects` and `env.builds` hashes magically take into account any `*.erb` files in existence so you can just code away without any funny business.
 
 ## How does it work?
 
@@ -39,32 +64,29 @@ The ERB dependencies are simply computed by finding each erb file and then remov
 
 Go ahead and crack open that codebase and see for yourself!
 
-## Ideas for the soon-to-exist command-line tool
+## Coming Soon
 
-Make a new C++ app, with a Rakefile, .gitignore, and some skeleton source files:
+Generate a basic Rakefile, etc. for an existing C++ project:
 
 ```
-$ r++ new MyApp
-```
-
-Generates a header and source file skeleton for a class:
-```
-$ r++ generate class MyClass
+$ r++ init
 ```
 
 ## More Ideas
 
-  * Have `r++` act as a wrapper or superset of `g++` to allow users to drop `r++` straight into an existing project.
+  * Move all the boilerplate from the example Rakefile into R++ so there is less for developers to do to get started.
+  * Add support for a C++ test framework and add a `rake test` task.
+  * Do some kind of caching for the dependencies. I'm suspecting the Rakefile will take really long on a larger project.
   * Add some magical C++ code generating libraries to use with ERB.
   * Make it easy for people to package their library or app or whatever into a deb or an rpm or a pkg or a whatever using a config file called a "libspec" or something (a-la "gemspec").
   * On that note, make it easy for people to publish to a package repository (apt, yum, aur, etc).
-  * Get a better name perhaps, I don't thing "R++" is the best name for this, since it's already been used by a past, failed project (we might pick up its bad luck or something).
+  * Have `r++` act as a wrapper or superset of `g++` to allow users to drop `r++` straight into an existing project.
 
 ## Disclaimer
 
-This has absolutely nothing to do with Bell labs R++.
+This has absolutely nothing to do with [Bell labs R++](http://ect.bell-labs.com/who/pfps/rpp/index.html).
 
-## Help me make R++ better for everyone! :)
+## Help make R++ better for everyone :)
 
 The easiest way to contribute is to try this thing out and submit an issue when it breaks.
 

data/examples/Rakefile

@@ -0,0 +1,58 @@
+require 'rake/clean'
+require 'rplusplus'
+env = RPlusPlus::Environment.new
+
+# TODO: move a lot of this stuff into R++ configuration
+CC = 'g++'
+
+LIBS = ['glew', 'glfw3'] # example libs for, e.g. and OpenGL application
+
+# Grab flags from pkg-config. NOTE: this requres pkg-config to be installed AND your included libs to work with it
+LIB_CFLAGS = LIBS.map { |lib|
+                %x[ pkg-config --cflags #{lib} ].gsub(/\n/,' ')
+             }.flatten.join(' ')
+LDLIBS = LIBS.map {
+           |lib| %x[ pkg-config --static --libs #{lib} ].gsub(/\n/,' ')
+         }.flatten.join(' ')
+
+# Some strict default CFLAGS
+WARNING_FLAGS = [
+  'all', 'extra', 'effc++', 'init-self', 'missing-include-dirs', 'switch-default', 'switch-enum', 'unused-parameter',
+  'strict-overflow=5', 'float-equal', 'shadow', 'c++0x-compat', 'conversion', 'sign-conversion', 'missing-declarations',
+  'overloaded-virtual', 'sign-promo'
+].map { |flag| "-W#{flag}"}.join ' '
+FORMATTING_FLAGS = ['message-length=80', 'diagnostics-show-option'].map { |flag| "-f#{flag}"}.join ' '
+EXTRA_CFLAGS = "-std=c++11 -pipe -pedantic"
+CFLAGS = "#{WARNING_FLAGS} #{FORMATTING_FLAGS} #{LIB_CFLAGS} #{EXTRA_CFLAGS}"
+
+EXTRA_LDFLAGS = ""
+LDFLAGS = "#{LDLIBS} #{EXTRA_LDFLAGS}"
+
+CLOBBER.include(*env.objects.keys, *env.builds.keys, *env.erbs.keys)
+
+task :default => :all
+
+task :all => ['main'] # if your main function is in a file called main.cpp
+
+# TODO: do the following for you, so you don't have to put this in yourself
+
+# compile ERBs into cpp/h files
+env.erbs.each do |target, sources|
+  file target => sources do |t|
+    File.write(target, ERB.new(File.read(sources.first)).result)
+  end
+end
+
+# compile CPPs into O-files
+env.objects.each do |object, sources|
+  file object => sources do |t|
+    sh "#{CC} #{CFLAGS} -c #{sources.first} -o #{object}"
+  end
+end
+
+# build executables from main CPPs
+env.builds.each do |target, objects|
+  file target => objects do |t|
+    sh "#{CC} #{objects.join(' ')} -o #{target} #{LDFLAGS}"
+  end
+end

data/lib/rplusplus/commands/new.rb

@@ -0,0 +1,34 @@
+module RPlusPlus
+  module Commands
+    class New
+      Command.register :new, self
+
+      def self.call project_name, *args
+        FileUtils.mkdir project_name
+
+        File.write("#{project_name}/#{project_name.underscore}.cpp", main_erb.result(binding))
+        File.write("#{project_name}/Rakefile", rakefile_erb.result(binding))
+        File.write("#{project_name}/.gitignore", gitignore_erb.result(binding))
+      end
+
+      class << self
+        private
+        def template_dir
+          File.join File.dirname(__FILE__), '../templates'
+        end
+
+        def main_erb
+          ERB.new(File.read(File.join(template_dir, 'main.erb')))
+        end
+
+        def rakefile_erb
+          ERB.new(File.read(File.join(template_dir, 'Rakefile.erb')))
+        end
+
+        def gitignore_erb
+          ERB.new(File.read(File.join(template_dir, 'gitignore.erb')))
+        end
+      end
+    end
+  end
+end

data/lib/rplusplus/templates/Rakefile.erb

@@ -0,0 +1,53 @@
+require 'rake/clean'
+require 'rplusplus'
+env = RPlusPlus::Environment.new
+
+CC = 'g++'
+
+LIBS = []
+
+LIB_CFLAGS = LIBS.map { |lib|
+                %x[ pkg-config --cflags #{lib} ].gsub(/\n/,' ')
+             }.flatten.join(' ')
+LDLIBS = LIBS.map {
+           |lib| %x[ pkg-config --static --libs #{lib} ].gsub(/\n/,' ')
+         }.flatten.join(' ')
+
+WARNING_FLAGS = [
+  'all', 'extra', 'effc++', 'init-self', 'missing-include-dirs', 'switch-default', 'switch-enum', 'unused-parameter',
+  'strict-overflow=5', 'float-equal', 'shadow', 'c++0x-compat', 'conversion', 'sign-conversion', 'missing-declarations',
+  'overloaded-virtual', 'sign-promo'
+].map { |flag| "-W#{flag}"}.join ' '
+FORMATTING_FLAGS = ['message-length=80', 'diagnostics-show-option'].map { |flag| "-f#{flag}"}.join ' '
+EXTRA_CFLAGS = "-std=c++11 -pipe -pedantic"
+CFLAGS = "#{WARNING_FLAGS} #{FORMATTING_FLAGS} #{LIB_CFLAGS} #{EXTRA_CFLAGS}"
+
+EXTRA_LDFLAGS = ""
+LDFLAGS = "#{LDLIBS} #{EXTRA_LDFLAGS}"
+
+CLOBBER.include(*env.objects.keys, *env.builds.keys, *env.erbs.keys)
+
+task :default => :all
+
+task :all => ['<%= project_name.underscore %>']
+
+# compile ERBs into cpp/h files
+env.erbs.each do |target, sources|
+  file target => sources do |t|
+    File.write(target, ERB.new(File.read(sources.first)).result)
+  end
+end
+
+# compile CPPs into O-files
+env.objects.each do |object, sources|
+  file object => sources do |t|
+    sh "#{CC} #{CFLAGS} -c #{sources.first} -o #{object}"
+  end
+end
+
+# build executables from main CPPs
+env.builds.each do |target, objects|
+  file target => objects do |t|
+    sh "#{CC} #{objects.join(' ')} -o #{target} #{LDFLAGS}"
+  end
+end

data/lib/rplusplus/templates/gitignore.erb

@@ -0,0 +1,2 @@
+*.o
+<%= project_name.underscore %>

data/lib/rplusplus/templates/main.erb

@@ -0,0 +1,4 @@
+int main(int argc, char* argv[])
+{
+  return 0;
+}

data/lib/rplusplus/version.rb

@@ -1,3 +1,3 @@
 module Rplusplus
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/rplusplus.rb

@@ -5,6 +5,7 @@ require "rplusplus/environment"
 require "rplusplus/command"
 require "rplusplus/commands/generate"
 require "rplusplus/generators/class_generator"
+require "rplusplus/commands/new"
 
 module RPlusPlus
   def self.call argv

data/spec/commands/new_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe RPlusPlus::Commands::New do
+  it 'registers itself with Command' do
+    expect(RPlusPlus::Command.commands).to include(:new => RPlusPlus::Commands::New)
+  end
+
+  describe '#call' do
+    before(:all) do
+      @pwd = Dir.pwd
+      Dir.chdir('spec/support/sandbox')
+    end
+
+    after(:all) do
+      Dir.chdir(@pwd)
+    end
+
+    after do
+      FileUtils.rm_rf 'my_project'
+    end
+
+    it 'creates a new folder with the project name' do
+      RPlusPlus::Commands::New.call('my_project')
+
+      expect(File).to be_directory('my_project')
+    end
+
+    it 'creates a starting main file with the project name' do
+      RPlusPlus::Commands::New.call('my_project')
+
+      expect(File).to exist('my_project/my_project.cpp')
+      main_cpp = File.read 'my_project/my_project.cpp'
+
+      expect(main_cpp).to include 'int main(int argc, char* argv[])'
+      expect(main_cpp).to include 'return 0;'
+    end
+
+    it 'creates a starting Rakefile with the executable as the default task' do
+      RPlusPlus::Commands::New.call('my_project')
+
+      expect(File).to exist('my_project/Rakefile')
+      rakefile = File.read 'my_project/Rakefile'
+
+      expect(rakefile).to include "require 'rplusplus'"
+      expect(rakefile).to include "env = RPlusPlus::Environment.new"
+      expect(rakefile).to include 'task :default => :all'
+      expect(rakefile).to include "task :all => ['my_project']"
+    end
+
+    it 'creates a .gitignore that ignores *.o files and the main executable' do
+      RPlusPlus::Commands::New.call('my_project')
+      expect(File).to exist('my_project/.gitignore')
+      gitignore = File.read 'my_project/.gitignore'
+
+      expect(gitignore).to include '*.o'
+      expect(gitignore).to include 'my_project'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rplusplus
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Daniel Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-10 00:00:00.000000000 Z
+date: 2015-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,17 +109,23 @@ files:
 - README.md
 - Rakefile
 - bin/r++
+- examples/Rakefile
 - lib/rplusplus.rb
 - lib/rplusplus/command.rb
 - lib/rplusplus/commands/generate.rb
+- lib/rplusplus/commands/new.rb
 - lib/rplusplus/environment.rb
 - lib/rplusplus/generators/class_generator.rb
+- lib/rplusplus/templates/Rakefile.erb
 - lib/rplusplus/templates/class.erb
 - lib/rplusplus/templates/class_header.erb
+- lib/rplusplus/templates/gitignore.erb
+- lib/rplusplus/templates/main.erb
 - lib/rplusplus/version.rb
 - rplusplus.gemspec
 - spec/command_spec.rb
 - spec/commands/generate_spec.rb
+- spec/commands/new_spec.rb
 - spec/environment_spec.rb
 - spec/generators/class_generator_spec.rb
 - spec/rplusplus_spec.rb
@@ -166,6 +172,7 @@ summary: Making C++ slightly less painful.
 test_files:
 - spec/command_spec.rb
 - spec/commands/generate_spec.rb
+- spec/commands/new_spec.rb
 - spec/environment_spec.rb
 - spec/generators/class_generator_spec.rb
 - spec/rplusplus_spec.rb