ronin-gen 0.1.1 → 0.2.0

data/spec/generated_overlay_examples.rb

@@ -9,6 +9,12 @@ shared_examples_for "Generated Overlay" do
     File.directory?(@path).should == true
   end
 
+  it "should create a static directory" do
+    static_dir = File.join(@path,'static')
+
+    File.directory?(static_dir).should == true
+  end
+
   it "should create a lib directory" do
     lib_dir = File.join(@path,Ronin::Platform::Overlay::LIB_DIR)
 

data/spec/generators/classes/dir_generator.rb

@@ -2,10 +2,8 @@ require 'ronin/generators/generator'
 
 class DirGenerator < Generators::Generator
 
-  protected
-
-  def generate!
-    directory 'test'
+  def generate
+    mkdir 'test'
   end
 
 end

data/spec/generators/classes/file_generator.rb

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

data/spec/generators/classes/templated_generator.rb

@@ -4,14 +4,10 @@ class TemplatedGenerator < Generators::Generator
 
   TEMPLATE_FILE = File.join('generators','templated.txt.erb')
 
-  def initialize(message)
-    @message = message
-  end
-
-  protected
+  class_option :message, :type => :string
 
-  def generate!
-    render_file TEMPLATE_FILE, 'templated.txt'
+  def generate
+    template TEMPLATE_FILE, 'templated.txt'
   end
 
 end

data/spec/generators/classes/touch_generator.rb

@@ -2,9 +2,7 @@ require 'ronin/generators/generator'
 
 class TouchGenerator < Generators::Generator
 
-  protected
-
-  def generate!
+  def generate
     touch('test2.txt')
   end
 

data/spec/generators/generator_spec.rb

@@ -7,46 +7,44 @@ require 'generators/classes/touch_generator'
 require 'generators/classes/dir_generator'
 require 'generators/classes/templated_generator'
 
-
 require 'tmpdir'
 require 'fileutils'
 
 describe Generators::Generator do
   before(:all) do
+    @previous_dir = Dir.pwd
     @dir = File.join(Dir.tmpdir,'ronin_generators')
 
     FileUtils.mkdir(@dir)
+    Dir.chdir(@dir)
   end
 
   it "should generate files" do
-    generator = FileGenerator.new
-    generator.run(@dir)
+    FileGenerator.generate
 
-    File.read(File.join(@dir,'test.txt')).should == "hello\n"
+    File.read(File.join(@dir,'test.txt')).should == "hello"
   end
 
   it "should touch files" do
-    generator = TouchGenerator.new
-    generator.run(@dir)
+    TouchGenerator.generate
 
     File.file?(File.join(@dir,'test2.txt')).should == true
   end
 
   it "should generate directories" do
-    generator = DirGenerator.new
-    generator.run(@dir)
+    DirGenerator.generate
 
     File.directory?(File.join(@dir,'test')).should == true
   end
 
   it "should generate files using templates" do
-    generator = TemplatedGenerator.new('hello')
-    generator.run(@dir)
+    TemplatedGenerator.generate(:message => 'hello')
 
     File.read(File.join(@dir,'templated.txt')).should == "message: hello\n"
   end
 
   after(:all) do
     FileUtils.rm_r(@dir)
+    Dir.chdir(@previous_dir)
   end
 end

data/spec/generators/helpers/static/generators/templated.txt.erb

@@ -1 +1 @@
-message: <%= @message %>
+message: <%= options[:message] %>

data/spec/generators/platform/extension_spec.rb

@@ -7,13 +7,11 @@ require 'tmpdir'
 require 'fileutils'
 
 describe Generators::Platform::Overlay do
-
   before(:all) do
     @name = 'ronin_generated_extension'
     @path = File.join(Dir.tmpdir,@name)
 
-    generator = Generators::Platform::Extension.new
-    generator.run(@path)
+    Generators::Platform::Extension.generate(@path)
   end
 
   it_should_behave_like "Generated Extension"
@@ -21,5 +19,4 @@ describe Generators::Platform::Overlay do
   after(:all) do
     FileUtils.rm_r(@path)
   end
-
 end

data/spec/generators/platform/overlay_spec.rb

@@ -7,7 +7,6 @@ require 'tmpdir'
 require 'fileutils'
 
 describe Generators::Platform::Overlay do
-
   before(:all) do
     @name = 'ronin_generated_overlay'
     @path = File.join(Dir.tmpdir,@name)
@@ -18,7 +17,8 @@ describe Generators::Platform::Overlay do
     @license = 'GPL-2'
     @description = 'This is a test overlay'
 
-    generator = Generators::Platform::Overlay.new(
+    Generators::Platform::Overlay.generate(
+      @path,
       :title => @title,
       :source => @source,
       :source_view => @source_view,
@@ -26,7 +26,6 @@ describe Generators::Platform::Overlay do
       :license => @license,
       :description => @description
     )
-    generator.run(@path)
   end
 
   it_should_behave_like "Generated Overlay"
@@ -34,5 +33,4 @@ describe Generators::Platform::Overlay do
   after(:all) do
     FileUtils.rm_r(@path)
   end
-
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-gem 'rspec', '>=1.1.12'
+gem 'rspec', '>=1.2.8'
 require 'spec'
 
 require 'ronin/generators/version'

data/spec/ui/command_line/commands/gen_extension_spec.rb

@@ -11,7 +11,7 @@ describe UI::CommandLine::Commands::GenExtension do
     @name = 'ronin_generated_extension'
     @path = File.join(Dir.tmpdir,@name)
 
-    UI::CommandLine::Commands::GenExtension.run(@path)
+    UI::CommandLine::Commands::GenExtension.start [@path]
   end
 
   it_should_behave_like "Generated Extension"

data/spec/ui/command_line/commands/gen_overlay_spec.rb

@@ -18,15 +18,15 @@ describe UI::CommandLine::Commands::GenOverlay do
     @license = 'GPL-2'
     @description = 'This is a test overlay'
 
-    UI::CommandLine::Commands::GenOverlay.run(
+    UI::CommandLine::Commands::GenOverlay.start [
+      @path,
       '--title', @title,
       '--source', @source,
       '--source-view', @source_view,
       '--website', @website,
       '--license', @license,
-      '--description', @description,
-      @path
-    )
+      '--description', @description
+    ]
   end
 
   it_should_behave_like "Generated Overlay"

data/static/ronin/generators/platform/Rakefile.erb

@@ -0,0 +1,5 @@
+# -*- ruby -*-
+<% @tasks.each do |task| %>
+require 'ronin/platform/tasks/<%= task %>
+<% end %>
+# vim: syntax=Ruby

data/static/ronin/{platform/generators → generators/platform}/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 gem 'rspec', '>=1.1.12'
 require 'spec'
 
-require 'ronin/generators/version'
+require 'ronin/platform'
 
 include Ronin
 

data/tasks/spec.rb

@@ -6,4 +6,5 @@ Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_opts = ['--colour', '--format', 'specdoc']
 end
 
+task :test => :spec
 task :default => :spec

data/tasks/yard.rb

@@ -0,0 +1,13 @@
+require 'ronin/yard/handlers'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = [
+    '--protected',
+    '--files', 'History.txt',
+    '--title', 'Ronin Generators',
+    '--quiet'
+  ]
+end
+
+task :docs => :yardoc

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ronin-gen
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Postmodern
@@ -30,7 +30,7 @@ cert_chain:
   pDj+ws7QjtH/Qcrr1l9jfN0ehDs=
   -----END CERTIFICATE-----
 
-date: 2009-07-08 00:00:00 -07:00
+date: 2009-09-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,7 +41,27 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.4
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.3.5
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -51,14 +71,14 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.2
+        version: 2.3.3
     version: 
 description: |-
   Ronin Gen is a Ruby library for Ronin that provides various generators.
   
-  Ronin is a Ruby platform designed for information security and data
-  exploration tasks. Ronin allows for the rapid development and distribution
-  of code over many of the common Source-Code-Management (SCM) systems.
+  Ronin is a Ruby platform for exploit development and security research.
+  Ronin allows for the rapid development and distribution of code, exploits
+  or payloads over many common Source-Code-Management (SCM) systems.
 email: 
 - postmodern.mod3@gmail.com
 executables: 
@@ -72,14 +92,12 @@ extra_rdoc_files:
 - COPYING.txt
 - Manifest.txt
 - README.txt
-- TODO.txt
 files: 
 - History.txt
 - COPYING.txt
 - Manifest.txt
 - README.txt
 - Rakefile
-- TODO.txt
 - bin/ronin-gen
 - bin/ronin-gen-overlay
 - bin/ronin-gen-extension
@@ -90,11 +108,11 @@ files:
 - lib/ronin/generators/platform/static.rb
 - lib/ronin/generators/platform/overlay.rb
 - lib/ronin/generators/platform/extension.rb
-- lib/ronin/generators/platform/spec.rb
 - lib/ronin/ui/command_line/commands/gen.rb
 - lib/ronin/ui/command_line/commands/gen_overlay.rb
 - lib/ronin/ui/command_line/commands/gen_extension.rb
 - tasks/spec.rb
+- tasks/yard.rb
 - spec/spec_helper.rb
 - spec/generated_overlay_examples.rb
 - spec/generated_extension_examples.rb
@@ -110,9 +128,10 @@ files:
 - spec/generators/platform/extension_spec.rb
 - spec/ui/command_line/commands/gen_overlay_spec.rb
 - spec/ui/command_line/commands/gen_extension_spec.rb
-- static/ronin/platform/generators/extension.rb
-- static/ronin/platform/generators/spec/spec_helper.rb
-has_rdoc: true
+- static/ronin/generators/platform/Rakefile.erb
+- static/ronin/generators/platform/extension.rb
+- static/ronin/generators/platform/spec/spec_helper.rb
+has_rdoc: yard
 homepage: http://ronin.rubyforge.org/gen/
 licenses: []
 
@@ -137,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ronin
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Ronin Gen is a Ruby library for Ronin that provides various generators

data/TODO.txt

@@ -1,3 +0,0 @@
-== TODO:
-
-

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

@@ -1,46 +0,0 @@
-#
-#--
-# 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