rplusplus 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af2b70a8e4415e61ee91023a7d5d39aa2ad373e6
-  data.tar.gz: ad4ef2a7baf8ba17fd0b158ca765e424bd962cb7
+  metadata.gz: 1f11712f1e2e7bfb1949089f363d8e99bd588125
+  data.tar.gz: e21fa0e4daaf9185ea35878a74e3ee7905817f4e
 SHA512:
-  metadata.gz: 9a301b16027df9bb54809759621ef511dd35e9b4a02a7dc6208fb62c6d71035d29d54de146306998494e3c95f1af9c287b7a046a8f2d6547bba83caf255586bc
-  data.tar.gz: 9c02e6a66f19a2e2562d7ee014178931caaef0628a787971f9acb539a1539a595204f9e0f8dc2cf6597aada134d74204309219f2c153c8133c3a1ca562fc8a34
+  metadata.gz: c14309834c20d92ca82239aba502400cc64e12ec74916a3c43c8a06484a8b141feb46aa550b58b2ff18282125043716e4a556b0695f5145769148e4cc6fe9662
+  data.tar.gz: d6d06c50765b6a6078971ad2644b957bdc4558054bfbef4b33dd62998b776accd692bb9499c75ee77d3f1938c1ad662662977defafd509bb503f48d2ec980396

data/README.md

@@ -2,9 +2,7 @@
 
 Making C++ slightly less painful.
 
-Of all the horrid languages to ever exist, C++ has to be the most widely used. 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.
-
-R++ also aims to bring some kind of order to the world of C++ by following the principle of convention over configuration.
+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!
 
@@ -14,8 +12,6 @@ WARNING: I just started this project so functionality is super limited. You have
 
 ## Using it in your Rakefile
 
-This bit of functionality exists, and it's super useful (but still in BETA):
-
 In your Rakefile, do this:
 
 ```
@@ -23,11 +19,11 @@ require 'rplusplus'
 env = RPlusPlus::Environment.new
 ```
 
-Now, env has some useful properties:
+Now, env has some useful properties which you can make use of in your Rake tasks:
 
-    * `env.objects` contains a hash of the form `'foo.o' => ['foo.cpp', 'foo.h', ...]` which you can use for creating file tasks for all your o-files.
-    * `env.builds` contains a hash of the form `'main' => ['main.o', 'foo.o', ...]` which you can use for file tasks for all your executables.
-    * `env.erbs` contains a hash of the form `'foo.cpp' => ['foo.cpp.erb']` so you can make file tasks for generating source code from embedded ruby source files.
+  * `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']`
 
 `env.objects` and `env.builds` magically take into account any `*.erb` files in existence so you can just code away without any funny business.
 
@@ -41,6 +37,8 @@ The builds are discovered by finding each cpp file with a main function, and the
 
 The ERB dependencies are simply computed by finding each erb file and then removing the erb extention.
 
+Go ahead and crack open that codebase and see for yourself!
+
 ## Ideas for the soon-to-exist command-line tool
 
 Make a new C++ app, with a Rakefile, .gitignore, and some skeleton source files:
@@ -49,13 +47,6 @@ Make a new C++ app, with a Rakefile, .gitignore, and some skeleton source files:
 $ r++ new MyApp
 ```
 
-Some other things I plan on including:
-
-Work out the dependencies a-la `g++ -MM`, except in rake-friendly syntax instead of Make:
-```
-$ r++ -MM some_code.cpp
-```
-
 Generates a header and source file skeleton for a class:
 ```
 $ r++ generate class MyClass
@@ -67,12 +58,13 @@ $ r++ generate class MyClass
   * 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).
 
 ## Disclaimer
 
 This has absolutely nothing to do with Bell labs R++.
 
-## I want you to help make R++ better for everyone.
+## Help me make R++ better for everyone! :)
 
 The easiest way to contribute is to try this thing out and submit an issue when it breaks.
 

data/bin/r++

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rplusplus'
+
+RPlusPlus.call ARGV

data/lib/rplusplus.rb

@@ -1,5 +1,14 @@
+require 'active_support/all'
+
 require "rplusplus/version"
-require "environment"
+require "rplusplus/environment"
+require "rplusplus/command"
+require "rplusplus/commands/generate"
+require "rplusplus/generators/class_generator"
 
 module RPlusPlus
+  def self.call argv
+    command, *arguments = *argv
+    Command.call command, *arguments
+  end
 end

data/lib/rplusplus/command.rb

@@ -0,0 +1,26 @@
+module RPlusPlus
+  class Command
+    def self.commands
+      @@commands ||= {}
+    end
+
+    def self.register name, command
+      self.commands[name] = command
+    end
+
+    def self.list
+      self.commands.keys
+    end
+
+    def self.call name, *args
+      name = name.to_sym
+      if !self.commands.has_key? name
+        raise MissingCommandError.new("'#{name}' is not a r++ command")
+      end
+      self.commands[name].call(*args)
+    end
+
+    class MissingCommandError < StandardError
+    end
+  end
+end

data/lib/rplusplus/commands/generate.rb

@@ -0,0 +1,30 @@
+module RPlusPlus
+  module Commands
+    class Generate
+      Command.register :generate, self
+
+      def self.generators
+        @@generators ||= {}
+      end
+
+      def self.register name, generator
+        self.generators[name.to_sym] = generator
+      end
+
+      def self.list
+        self.generators.keys
+      end
+
+      def self.call name, *args
+        name = name.to_sym
+        if !self.generators.has_key? name
+          raise MissingGeneratorError.new("'#{name}' is not a r++ generator")
+        end
+        self.generators[name].call(*args)
+      end
+
+      class MissingGeneratorError < StandardError
+      end
+    end
+  end
+end

data/lib/rplusplus/generators/class_generator.rb

@@ -0,0 +1,27 @@
+module RPlusPlus
+  module Generators
+    class ClassGenerator
+      Commands::Generate.register :class, self
+
+      def self.call class_name
+        File.write("#{class_name.underscore}.h", header_erb.result(binding))
+        File.write("#{class_name.underscore}.cpp", class_erb.result(binding))
+      end
+
+      class << self
+        private
+        def template_dir
+          File.join File.dirname(__FILE__), '../templates'
+        end
+
+        def class_erb
+          ERB.new(File.read(File.join(template_dir, 'class.erb')))
+        end
+
+        def header_erb
+          ERB.new(File.read(File.join(template_dir, 'class_header.erb')))
+        end
+      end
+    end
+  end
+end

data/lib/rplusplus/templates/class.erb

@@ -0,0 +1,9 @@
+#include "<%= class_name.underscore.downcase %>.h"
+
+<%= class_name %>::<%= class_name %>() {
+
+}
+
+<%= class_name %>::~<%= class_name %>() {
+
+}

data/lib/rplusplus/templates/class_header.erb

@@ -0,0 +1,12 @@
+#ifndef <%= class_name.underscore.upcase %>_H
+#define <%= class_name.underscore.upcase %>_H
+
+class <%= class_name %> {
+  public:
+    <%= class_name %>();
+    virtual ~<%= class_name %>();
+
+  private:
+};
+
+#endif

data/lib/rplusplus/version.rb

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

data/rplusplus.gemspec

@@ -20,7 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.3'
 
+  spec.add_runtime_dependency "activesupport", "~> 4.2"
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.3"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "fakefs", "~> 0.6"
 end

data/spec/command_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe RPlusPlus::Command do
+  let(:fake_command) { spy('command') }
+  after do
+    RPlusPlus::Command.commands.delete :test_command
+  end
+
+  describe '#register' do
+    it 'registers a command' do
+      RPlusPlus::Command::register :test_command, fake_command
+
+      expect(RPlusPlus::Command.commands).to include(:test_command => fake_command)
+    end
+  end
+
+  describe '#list' do
+    after do
+      [:foo, :bar, :baz].each { |x| RPlusPlus::Command.commands.delete x }
+    end
+
+    it 'lists all registered generators' do
+      RPlusPlus::Command.register(:foo, fake_command)
+      RPlusPlus::Command.register(:bar, fake_command)
+      RPlusPlus::Command.register(:baz, fake_command)
+
+      expect(RPlusPlus::Command.list).to include(:foo, :bar, :baz)
+    end
+  end
+
+  describe '#call' do
+    before do
+      RPlusPlus::Command.register :test_command, fake_command
+    end
+
+    it 'calls the specific command with the given arguments' do
+      RPlusPlus::Command.call :test_command, 'foo', 'bar', 'baz'
+
+      expect(fake_command).to have_received(:call).with('foo', 'bar', 'baz')
+    end
+
+    it 'converts command strings to symbols' do
+      RPlusPlus::Command.call 'test_command', 'foo', 'bar', 'baz'
+
+      expect(fake_command).to have_received(:call).with('foo', 'bar', 'baz')
+    end
+
+    it 'raises if the specific command does not exists' do
+      expect {
+        RPlusPlus::Command.call :nonexistent, :something
+      }.to raise_error(RPlusPlus::Command::MissingCommandError,
+        "'nonexistent' is not a r++ command")
+    end
+  end
+end

data/spec/commands/generate_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe RPlusPlus::Commands::Generate do
+  let(:fake_generator) { spy('generator') }
+
+  after do
+    RPlusPlus::Commands::Generate.generators.delete :test_generator
+  end
+
+  it 'registers itself with Command' do
+    expect(RPlusPlus::Command.commands).to include(
+      :generate => RPlusPlus::Commands::Generate)
+  end
+
+  describe '#register' do
+    it 'registers a generator' do
+      RPlusPlus::Commands::Generate.register(:test_generator, fake_generator)
+
+      expect(RPlusPlus::Commands::Generate.generators).to include(
+        :test_generator => fake_generator)
+    end
+  end
+
+  describe '#list' do
+    after do
+      [:foo, :bar, :baz].each { |x| RPlusPlus::Commands::Generate.generators.delete x }
+    end
+
+    it 'lists all registered generators' do
+      RPlusPlus::Commands::Generate.register(:foo, fake_generator)
+      RPlusPlus::Commands::Generate.register(:bar, fake_generator)
+      RPlusPlus::Commands::Generate.register(:baz, fake_generator)
+
+      expect(RPlusPlus::Commands::Generate.list).to include(:foo, :bar, :baz)
+    end
+  end
+
+  describe '#call' do
+    before do
+      RPlusPlus::Commands::Generate.register(:test_generator, fake_generator)
+    end
+
+    it 'runs the specified generator with the given arguments' do
+      RPlusPlus::Commands::Generate.call(:test_generator, 'foo', 'bar', 'baz')
+
+      expect(fake_generator).to have_received(:call).with('foo', 'bar', 'baz')
+    end
+
+    it 'converts generator strings into symbols' do
+      RPlusPlus::Commands::Generate.call('test_generator', 'foo', 'bar', 'baz')
+
+      expect(fake_generator).to have_received(:call).with('foo', 'bar', 'baz')
+    end
+
+    it 'raises if the specific generator does not exists' do
+      expect {
+        RPlusPlus::Commands::Generate.call :nonexistent, :something
+      }.to raise_error(RPlusPlus::Commands::Generate::MissingGeneratorError,
+        "'nonexistent' is not a r++ generator")
+    end
+  end
+end

data/spec/environment_spec.rb

@@ -4,9 +4,14 @@ describe RPlusPlus::Environment do
   let(:env) { RPlusPlus::Environment.new }
 
   before(:all) do
+    @pwd = Dir.pwd
     Dir.chdir('spec/support/samples')
   end
 
+  after(:all) do
+    Dir.chdir(@pwd)
+  end
+
   describe '#objects' do
     it 'contains a list of objects with their dependencies' do
       expect(env.objects).to include(

data/spec/generators/class_generator_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe RPlusPlus::Generators::ClassGenerator do
+  it 'registers itself with the generate command' do
+    expect(RPlusPlus::Commands::Generate.generators).to include(
+      :class => RPlusPlus::Generators::ClassGenerator)
+  end
+
+  describe '#call' do
+    # include FakeFS::SpecHelpers
+
+    before(:all) do
+      @pwd = Dir.pwd
+      Dir.chdir('spec/support/sandbox')
+    end
+
+    after(:all) do
+      Dir.chdir(@pwd)
+    end
+
+    after do
+      FileUtils.rm 'my_class.h'
+      FileUtils.rm 'my_class.cpp'
+    end
+
+    it 'generates a class' do
+      RPlusPlus::Generators::ClassGenerator.call('MyClass')
+
+      header_file = File.read('my_class.h')
+      class_file = File.read('my_class.cpp')
+
+      expect(header_file).to include('#ifndef MY_CLASS_H', '#define MY_CLASS_H',
+        'class MyClass {', 'MyClass();', 'virtual ~MyClass();')
+      expect(class_file).to include('#include "my_class.h"', 'MyClass::MyClass() {',
+        'MyClass::~MyClass() {')
+    end
+  end
+end

data/spec/rplusplus_spec.rb

@@ -1,4 +1,21 @@
 require 'spec_helper'
 
 describe RPlusPlus do
+  describe '#call' do
+    let (:fake_command) { spy('fake_command') }
+
+    before do
+      RPlusPlus::Command.register :test_command, fake_command
+    end
+
+    after do
+      RPlusPlus::Command.commands.delete :test_command
+    end
+
+    it 'calls the specified command with the given arguments' do
+      RPlusPlus.call ['test_command', 'foo', 'bar', 'baz']
+
+      expect(fake_command).to have_received(:call).with('foo', 'bar', 'baz')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'bundler/setup'
-Bundler.setup
+require 'fakefs/spec_helpers'
 
 require 'rplusplus'
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rplusplus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Daniel Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2015-05-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,10 +66,39 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: A collection of command-line tools for making C++ development easier.
 email:
 - jellymann@gmail.com
-executables: []
+executables:
+- r++
 extensions: []
 extra_rdoc_files: []
 files:
@@ -65,12 +108,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/environment.rb
+- bin/r++
 - lib/rplusplus.rb
+- lib/rplusplus/command.rb
+- lib/rplusplus/commands/generate.rb
+- lib/rplusplus/environment.rb
+- lib/rplusplus/generators/class_generator.rb
+- lib/rplusplus/templates/class.erb
+- lib/rplusplus/templates/class_header.erb
 - lib/rplusplus/version.rb
 - rplusplus.gemspec
+- spec/command_spec.rb
+- spec/commands/generate_spec.rb
 - spec/environment_spec.rb
-- spec/r++_spec.rb
+- spec/generators/class_generator_spec.rb
 - spec/rplusplus_spec.rb
 - spec/spec_helper.rb
 - spec/support/load_file.rb
@@ -87,6 +138,7 @@ files:
 - spec/support/samples/other_class.cpp
 - spec/support/samples/other_class.h
 - spec/support/samples/other_main.cpp
+- spec/support/sandbox/.keep
 homepage: https://github.com/jellymann/rplusplus
 licenses:
 - MIT
@@ -107,13 +159,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Making C++ slightly less painful.
 test_files:
+- spec/command_spec.rb
+- spec/commands/generate_spec.rb
 - spec/environment_spec.rb
-- spec/r++_spec.rb
+- spec/generators/class_generator_spec.rb
 - spec/rplusplus_spec.rb
 - spec/spec_helper.rb
 - spec/support/load_file.rb
@@ -130,3 +184,5 @@ test_files:
 - spec/support/samples/other_class.cpp
 - spec/support/samples/other_class.h
 - spec/support/samples/other_main.cpp
+- spec/support/sandbox/.keep
+has_rdoc: 

data/spec/r++_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-describe 'r++' do
-  pending 'Write tests using the r++ command'
-end