ronin-gen 0.2.0 → 1.0.0.pre1

data/lib/ronin/ui/{command_line → cli}/commands/gen.rb

@@ -1,7 +1,7 @@
 #
 # Ronin Gen - A Ruby library for Ronin that provides various generators.
 #
-# Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2009-2010 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
@@ -18,31 +18,30 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #
 
-require 'ronin/generators/version'
-require 'ronin/ui/command_line/command'
-require 'ronin/ui/command_line/command_line'
+require 'ronin/ui/cli/command'
+require 'ronin/gen/gen'
+require 'ronin/gen/version'
 
 module Ronin
   module UI
-    module CommandLine
+    module CLI
       module Commands
+        #
+        # Lists the available generators.
+        #
         class Gen < Command
 
-          desc "version", "Prints the version and exists"
-          def version
-            puts "Ronin Gen #{Ronin::Generators::VERSION}"
-            exit
-          end
+          desc "Prints the list of available generators"
+          class_option :version, :type => :boolean
+
+          def execute
+            if options.version?
+              puts "ronin-gen #{Ronin::Gen::VERSION}"
+              return
+            end
 
-          desc "default", "Prints the list of available generators"
-          def default
-            print_array CommandLine.commands.map { |name|
-              if name =~ /^gen_/
-                name.gsub(/^gen_/,'')
-              else
-                nil
-              end
-            }.compact.sort
+            print_title 'Available Generators'
+            print_array Ronin::Gen.generators.keys.sort
           end
 
         end

data/ronin-gen.gemspec

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  STDERR.puts "The 'ronin-gen.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore` to install Ore."
+end

data/spec/gen/classes/basic_generator.rb

@@ -0,0 +1,16 @@
+require 'ronin/gen/generator'
+
+class BasicGenerator < Gen::Generator
+
+  attr_reader :var
+
+  def generate
+  end
+
+  protected
+
+  def setup
+    @var = 'test'
+  end
+
+end

data/spec/gen/classes/dir_generator.rb

@@ -0,0 +1,9 @@
+require 'ronin/gen/dir_generator'
+
+class DirGenerator < Gen::Generator
+
+  def generate
+    mkdir 'test'
+  end
+
+end

data/spec/{generators → gen}/classes/file_generator.rb

@@ -1,6 +1,6 @@
-require 'ronin/generators/generator'
+require 'ronin/gen/generator'
 
-class FileGenerator < Generators::Generator
+class FileGenerator < Gen::Generator
 
   def generate
     create_file('test.txt') do

data/spec/{generators → gen}/classes/templated_generator.rb

@@ -1,13 +1,13 @@
-require 'ronin/generators/generator'
+require 'ronin/gen/generator'
 
-class TemplatedGenerator < Generators::Generator
+class TemplatedGenerator < Gen::Generator
 
   TEMPLATE_FILE = File.join('generators','templated.txt.erb')
 
   class_option :message, :type => :string
 
   def generate
-    template TEMPLATE_FILE, 'templated.txt'
+    erb TEMPLATE_FILE, 'templated.txt'
   end
 
 end

data/spec/gen/classes/touch_generator.rb

@@ -0,0 +1,9 @@
+require 'ronin/gen/generator'
+
+class TouchGenerator < Gen::Generator
+
+  def generate
+    touch('test2.txt')
+  end
+
+end

data/spec/gen/gen_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'ronin/gen/gen'
+require 'ronin/gen/version'
+
+describe Gen do
+  it "should have a version" do
+    subject.const_defined?('VERSION').should == true
+  end
+
+  it "should load generators from 'ronin/gen/generators'" do
+    generator = subject.generator('library')
+
+    generator.should_not be_nil
+    generator.name.should == 'Ronin::Gen::Generators::Library'
+  end
+
+  it "should raise an UnknownGenerator exception on missing generators" do
+    lambda {
+      subject.generator('lolbadfail')
+    }.should raise_error(Gen::UnknownGenerator)
+  end
+end

data/spec/gen/generator_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'ronin/gen/generator'
+
+require 'gen/helpers/data'
+require 'gen/classes/basic_generator'
+require 'gen/classes/file_generator'
+require 'gen/classes/touch_generator'
+require 'gen/classes/dir_generator'
+require 'gen/classes/templated_generator'
+require 'tmpdir'
+require 'fileutils'
+
+describe Gen::Generator do
+  it "should include Thor::Actions" do
+    Gen::Generator.should include(Thor::Actions)
+  end
+
+  describe "setup" do
+    subject { BasicGenerator.new }
+
+    before(:all) do
+      subject.invoke_all
+    end
+
+    it "should set default values before invoking any tasks" do
+      subject.var.should == 'test'
+    end
+  end
+
+  describe "actions" 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
+      FileGenerator.generate
+
+      File.read(File.join(@dir,'test.txt')).should == "hello"
+    end
+
+    it "should touch files" do
+      TouchGenerator.generate
+
+      File.file?(File.join(@dir,'test2.txt')).should == true
+    end
+
+    it "should generate directories" do
+      DirGenerator.generate
+
+      File.directory?(File.join(@dir,'test')).should == true
+    end
+
+    it "should generate files using templates" do
+      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
+end

data/spec/gen/generators/library_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+require 'ronin/gen/generators/library'
+
+require 'pathname'
+require 'tmpdir'
+
+describe Gen::Generators::Library do
+  context "defaults" do
+    let(:path) { Pathname.new(Dir.tmpdir).join('ronin-name') }
+
+    before(:all) do
+      Gen::Generators::Library.generate(path)
+    end
+
+    it "should initialize a git repository" do
+      path.join('.git').should be_directory
+    end
+
+    it "should create a bin/ directory" do
+      path.join('bin').should be_directory
+    end
+
+    it "should create a lib/ directory" do
+      path.join('lib').should be_directory
+    end
+
+    it "should create a lib/ronin directory" do
+      path.join('lib','ronin').should be_directory
+    end
+
+    it "should create a lib/ronin/name.rb directory" do
+      path.join('lib','ronin','name.rb').should be_file
+    end
+
+    it "should create a lib/ronin/name directory" do
+      path.join('lib','ronin','name').should be_directory
+    end
+
+    it "should create a lib/ronin/name/version.rb file" do
+      path.join('lib','ronin','name','version.rb').should be_file
+    end
+
+    it "should create a data/ directory" do
+      path.join('data').should be_directory
+    end
+
+    it "should create a spec/ directory" do
+      path.join('spec').should be_directory
+    end
+
+    it "should create a spec/spec_helper.rb file" do
+      path.join('spec','spec_helper.rb').should be_file
+    end
+
+    it "should create a spec/name directory" do
+      path.join('spec','name').should be_directory
+    end
+
+    it "should create a spec/name/name_spec.rb file" do
+      path.join('spec','name','name_spec.rb').should be_file
+    end
+
+    it "should create a COPYING.txt file" do
+      path.join('COPYING.txt').should be_file
+    end
+
+    it "should create a README.md file" do
+      path.join('README.md').should be_file
+    end
+
+    it "should create a ChangeLog.md file" do
+      path.join('ChangeLog.md').should be_file
+    end
+
+    it "should create a Gemfile" do
+      path.join('Gemfile').should be_file
+    end
+
+    it "should create a Rakefile" do
+      path.join('Rakefile').should be_file
+    end
+
+    it "should create a .rspec file" do
+      path.join('.rspec').should be_file
+    end
+
+    it "should create a .yardopts file" do
+      path.join('.yardopts').should be_file
+    end
+
+    after(:all) do
+      path.rmtree
+    end
+  end
+
+  context "custom path and name" do
+    let(:name) { 'ronin-name' }
+    let(:path) { Pathname.new(Dir.tmpdir).join('ronin-library') }
+
+    before(:all) do
+      Gen::Generators::Library.generate(path, {:name => name})
+    end
+
+    it "should create a lib/ronin/name.rb file" do
+      path.join('lib','ronin','name.rb').should be_file
+    end
+
+    it "should create a lib/ronin/name/ directory" do
+      path.join('lib','ronin','name').should be_directory
+    end
+
+    it "should create a lib/ronin/name/version.rb file" do
+      path.join('lib','ronin','name','version.rb').should be_file
+    end
+
+    it "should create a bin/ronin-name file" do
+      path.join('bin','ronin-name').should be_file
+    end
+
+    it "should create a spec/name directory" do
+      path.join('spec','name').should be_directory
+    end
+
+    it "should create a spec/name/name_spec.rb file" do
+      path.join('spec','name','name_spec.rb').should be_file
+    end
+
+    after(:all) do
+      path.rmtree
+    end
+  end
+end

data/spec/gen/generators/repository_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'ronin/gen/generators/repository'
+
+require 'pathname'
+require 'tmpdir'
+
+describe Gen::Generators::Repository do
+  let(:name) { 'ronin_generated_repo' }
+  let(:path) { Pathname.new(Dir.tmpdir).join(name) }
+  let(:title) { 'Test Repository' }
+  let(:uri) { 'ssh+svn://www.example.com/var/svn/test/' }
+  let(:source) { 'http://www.example.com/test/' }
+  let(:website) { 'http://www.example.com/blog/' }
+  let(:license) { 'GPL-2' }
+  let(:description) { 'This is a test repository' }
+
+  before(:all) do
+    Gen::Generators::Repository.generate(
+      path,
+      :title => title,
+      :uri => uri,
+      :source => source,
+      :website => website,
+      :license => license,
+      :description => description
+    )
+  end
+
+  it "should create the repository directory" do
+    path.should be_directory
+  end
+
+  it "should create a data/ directory" do
+    path.join('data').should be_directory
+  end
+
+  it "should create a lib/ directory" do
+    path.join(Ronin::Repository::LIB_DIR).should be_directory
+  end
+
+  it "should create a lib/ronin/ directory" do
+    path.join(Ronin::Repository::LIB_DIR,'ronin').should be_directory
+  end
+
+  it "should create a cache/ directory" do
+    path.join(Ronin::Repository::CACHE_DIR).should be_directory
+  end
+
+  it "should create a Rakefile" do
+    path.join('Rakefile').should be_file
+  end
+
+  it "should create a XML metadata file" do
+    path.join(Ronin::Repository::METADATA_FILE).should be_file
+  end
+
+  describe "metadata" do
+    subject { YAML.load_file(path.join(Ronin::Repository::METADATA_FILE)) }
+
+    it "should contain a Hash" do
+      subject.should be_kind_of(Hash)
+    end
+
+    it "should have the title" do
+      subject['title'].should == title
+    end
+
+    it "should have the repository URI" do
+      subject['uri'].should == uri
+    end
+
+    it "should have the source URL" do
+      subject['source'].should == source
+    end
+
+    it "should have the website URL" do
+      subject['website'].should == website
+    end
+
+    it "should have the license" do
+      subject['license'].should == license
+    end
+
+    it "should have the description" do
+      subject['description'].should == description
+    end
+  end
+
+  after(:all) do
+    path.rmtree
+  end
+end