ronin-gen 0.1.0

data/lib/ronin/generators/platform/spec.rb

@@ -0,0 +1,46 @@
+#
+#--
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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 St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'ronin/generators/generator'
+
+module Ronin
+  module Generators
+    module Platform
+      class Spec < Generator
+
+        # The default spec_helper.rb file
+        SPEC_HELPER = File.join('ronin','platform','generators','spec','spec_helper.rb')
+
+        protected
+
+        #
+        # Generates a basic Spec test directory.
+        #
+        def generate!
+          directory 'spec'
+          copy SPEC_HELPER, 'spec'
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/generators/platform/static.rb

@@ -0,0 +1,31 @@
+#
+#--
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at example.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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 St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'ronin/static'
+
+module Ronin
+  module Generators
+    module Platform
+      Static.directory File.join(File.dirname(__FILE__),'..','..','..','..','static')
+    end
+  end
+end

data/lib/ronin/generators/version.rb

@@ -0,0 +1,28 @@
+#
+#--
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at example.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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 St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+module Ronin
+  module Generators
+    # Ronin Gen version
+    VERSION = '0.1.0'
+  end
+end

data/lib/ronin/ui/command_line/commands/gen_extension.rb

@@ -0,0 +1,56 @@
+#
+#--
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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 St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'ronin/ui/command_line/command'
+require 'ronin/generators/platform/extension'
+
+module Ronin
+  module UI
+    module CommandLine
+      module Commands
+        class GenExtension < Command
+
+          def defaults
+            @generator = Generators::Platform::Extension.new
+          end
+
+          def define_options(opts)
+            opts.usage = 'PATH [...]'
+
+            opts.arguments(
+              'PATH' => 'The PATH of the Extension to be created'
+            )
+
+            opts.summary('Create an empty Extension at the specified PATH')
+          end
+
+          def arguments(*args)
+            args.each do |path|
+              @generator.run(File.expand_path(path))
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/ui/command_line/commands/gen_overlay.rb

@@ -0,0 +1,97 @@
+#
+#--
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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 St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'ronin/ui/command_line/command'
+require 'ronin/generators/platform/overlay'
+
+module Ronin
+  module UI
+    module CommandLine
+      module Commands
+        class GenOverlay < Command
+
+          def defaults
+            @generator = Generators::Platform::Overlay.new
+          end
+
+          def define_options(opts)
+            opts.usage = '[options] PATH'
+
+            opts.options do
+              opts.on('-t','--title NAME','Name of the Overlay') do |title|
+                @generator.title = title
+              end
+
+              opts.on('-S','--source URL','The URL where the source of the Overlay will be hosted') do |url|
+                @generator.source = url
+              end
+
+              opts.on('-V','--source-view URL','The URL for viewing the contents of the Overlay') do |url|
+                @generator.source_view = url
+              end
+
+              opts.on('-U','--website URL','The URL of the website of the Overlay') do |url|
+                @generator.website = url
+              end
+
+              opts.on('-L','--license LICENSE','The license of the contents of the Overlay') do |license|
+                @generator.license = license
+              end
+
+              opts.on('-m','--maintainer "NAME <EMAIL>"','Name of a maintainer of the Overlay') do |text|
+                name = text.scan(/^[^<]+[^<\s]/).first
+                email = text.scan(/<([^<>]+)>\s*$/).first
+
+                email = email.first if email
+
+                @generator.maintainers << {:name => name, :email => email}
+              end
+
+              opts.on('-D','--description TEXT','The description for the Overlay') do |text|
+                @generator.description = text
+              end
+
+              opts.on('--task TASK','Add the TASK to the Overlay') do |task|
+                @generator.tasks << task.to_s
+              end
+            end
+
+            opts.arguments(
+              'PATH' => 'The PATH of the Overlay to be created'
+            )
+
+            opts.summary('Create an empty Overlay at the specified PATH')
+          end
+
+          def arguments(*args)
+            unless args.length == 1
+              fail('only one Overlay path maybe specified')
+            end
+
+            @generator.run(File.expand_path(args.first))
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/generated_extension_examples.rb

@@ -0,0 +1,27 @@
+require 'ronin/platform/extension'
+
+require 'spec_helper'
+
+shared_examples_for "Generated Extension" do
+
+  before(:all) do
+    @lib_dir = File.join(@path,Ronin::Platform::Extension::LIB_DIR)
+  end
+
+  it "should create the extension directory" do
+    File.directory?(@path).should == true
+  end
+
+  it "should create a lib/ directory" do
+    File.directory?(@lib_dir).should == true
+  end
+
+  it "should create an empty load file in the lib/ directory" do
+    File.file?(File.join(@lib_dir,@name + '.rb')).should == true
+  end
+
+  it "should create an empty directory within the lib/ directory" do
+    File.directory?(File.join(@lib_dir,@name)).should == true
+  end
+
+end

data/spec/generated_overlay_examples.rb

@@ -0,0 +1,66 @@
+require 'ronin/platform/overlay'
+
+require 'spec_helper'
+require 'nokogiri'
+
+shared_examples_for "Generated Overlay" do
+
+  it "should create the overlay directory" do
+    File.directory?(@path).should == true
+  end
+
+  it "should create a lib directory" do
+    lib_dir = File.join(@path,Ronin::Platform::Overlay::LIB_DIR)
+
+    File.directory?(lib_dir).should == true
+  end
+
+  it "should create a objects directory" do
+    objects_dir = File.join(@path,Ronin::Platform::Overlay::OBJECTS_DIR)
+
+    File.directory?(objects_dir).should == true
+  end
+
+  it "should create a Rakefile" do
+    rakefile = File.join(@path,'Rakefile')
+
+    File.file?(rakefile).should == true
+  end
+
+  it "should create a XML metadata file" do
+    metadata_file = File.join(@path,Ronin::Platform::Overlay::METADATA_FILE)
+
+    File.file?(metadata_file).should == true
+  end
+
+  describe "XML metadata file" do
+    before(:all) do
+      @doc = Nokogiri::XML(open(File.join(@path,Ronin::Platform::Overlay::METADATA_FILE)))
+    end
+
+    it "should have the title" do
+      @doc.at('/ronin-overlay/title').inner_text.should == @title
+    end
+
+    it "should have the source URL" do
+      @doc.at('/ronin-overlay/source').inner_text.should == @source
+    end
+
+    it "should have the source-view URL" do
+      @doc.at('/ronin-overlay/source-view').inner_text.should == @source_view
+    end
+
+    it "should have the website URL" do
+      @doc.at('/ronin-overlay/website').inner_text.should == @website
+    end
+
+    it "should have the license" do
+      @doc.at('/ronin-overlay/license').inner_text.should == @license
+    end
+
+    it "should have the description" do
+      @doc.at('/ronin-overlay/description').inner_text.should == @description
+    end
+  end
+
+end

data/spec/generators/generator_spec.rb

@@ -0,0 +1,40 @@
+require 'ronin/generators/generator'
+
+require 'spec_helper'
+require 'generators/helpers/generators'
+
+require 'tmpdir'
+require 'fileutils'
+
+describe Generators::Generator do
+  before(:all) do
+    @dir = File.join(Dir.tmpdir,'ronin_generators')
+
+    FileUtils.mkdir(@dir)
+  end
+
+  it "should generate files" do
+    generator = FileGenerator.new
+    generator.run(@dir)
+
+    File.read(File.join(@dir,'test.txt')).should == "hello\n"
+  end
+
+  it "should generate directories" do
+    generator = DirGenerator.new
+    generator.run(@dir)
+
+    File.directory?(File.join(@dir,'test')).should == true
+  end
+
+  it "should generate files using templates" do
+    generator = TemplatedGenerator.new('hello')
+    generator.run(@dir)
+
+    File.read(File.join(@dir,'templated.txt')).should == "message: hello\n"
+  end
+
+  after(:all) do
+    FileUtils.rm_r(@dir)
+  end
+end

data/spec/generators/generators_spec.rb

@@ -0,0 +1,9 @@
+require 'ronin/generators/version'
+
+require 'spec_helper'
+
+describe Generators do
+  it "should have a version" do
+    Generators.const_defined?('VERSION').should == true
+  end
+end

data/spec/generators/helpers/generators.rb

@@ -0,0 +1,7 @@
+require 'ronin/static/static'
+
+require 'generators/helpers/generators/file_generator'
+require 'generators/helpers/generators/dir_generator'
+require 'generators/helpers/generators/templated_generator'
+
+Static.directory File.join(File.dirname(__FILE__),'static')

data/spec/generators/helpers/generators/dir_generator.rb

@@ -0,0 +1,11 @@
+require 'ronin/generators/generator'
+
+class DirGenerator < Generators::Generator
+
+  protected
+
+  def generate!
+    directory 'test'
+  end
+
+end

data/spec/generators/helpers/generators/file_generator.rb

@@ -0,0 +1,11 @@
+require 'ronin/generators/generator'
+
+class FileGenerator < Generators::Generator
+
+  protected
+
+  def generate!
+    file('test.txt') { |test| test.puts("hello") }
+  end
+
+end