ronin-support 0.1.0.pre1

data/spec/path_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'ronin/path'
+
+describe Path do
+  let(:n) { 7 }
+
+  it "should inherit from Pathname" do
+    Path.superclass.should == Pathname
+  end
+
+  it "should provide the root path" do
+    path = Path.root
+
+    path.should.class == Path
+    path.to_s.should == '/'
+  end
+
+  describe "up" do
+    it "should be able to traverse up 0 directories" do
+      Path.up(0).should == File::SEPARATOR
+    end
+
+    it "should raise an ArgumentError when not passed an Integer or Enumerable" do
+      lambda {
+        Path.up(1.5)
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should raise an ArgumentError on negative number of directories" do
+      lambda {
+        Path.up(-1)
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should create directory-escaping paths" do
+      Path.up(n).to_s.should == (['..'] * n).join(File::SEPARATOR)
+    end
+
+    it "should create a range of directory-escaping paths" do
+      range = 7..10
+
+      Path.up(range).should == range.map { |i| Path.up(i) }
+    end
+
+    it "should allow using custom path separators" do
+      Path.up(n,'\\').to_s.should == (['..'] * n).join("\\")
+    end
+  end
+
+  describe "join" do
+    let(:base_path) { Path.new('base') }
+
+    it "should join with sub-paths" do
+      sub_path = File.join('one','two')
+      expected = [base_path, sub_path].join(File::SEPARATOR)
+
+      base_path.join(sub_path).to_s.should == expected
+    end
+
+    it "should join with a sub-directory" do
+      sub_directory = 'three'
+      expected = [base_path, sub_directory].join(File::SEPARATOR)
+
+      base_path.join(sub_directory).to_s.should == expected
+    end
+
+    it "should not collapse directory traversals" do
+      traversal = Path.up(n)
+      expected = [base_path, traversal].join(File::SEPARATOR)
+
+      base_path.join(traversal).to_s.should == expected
+    end
+
+    it "should filter out extra directory separators" do
+      expected = [base_path, 'sub'].join(File::SEPARATOR)
+
+      base_path.join('/','sub','/').to_s.should == expected
+    end
+
+    it "should join with the root path" do
+      Path.root.join('etc','passwd').to_s.should == '/etc/passwd'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'ronin/support/version'
+
+include Ronin

data/spec/support_spec.rb

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

data/spec/templates/classes/example_erb.rb

@@ -0,0 +1,11 @@
+require 'ronin/templates/erb'
+
+class ExampleErb
+
+  include Ronin::Templates::Erb
+
+  attr_accessor :x
+
+  attr_accessor :y
+
+end

data/spec/templates/classes/example_template.rb

@@ -0,0 +1,35 @@
+require 'ronin/templates/template'
+
+class ExampleTemplate
+
+  include Ronin::Templates::Template
+
+  def enter_example_template(&block)
+    enter_template(File.join('templates','example.erb'),&block)
+  end
+
+  def enter_relative_template(&block)
+    enter_template(File.join('templates','example.erb')) do |path|
+      enter_template(File.join('..','includes','_relative.erb'),&block)
+    end
+  end
+
+  def enter_missing_template(&block)
+    enter_template('totally_missing.erb',&block)
+  end
+
+  def read_example_template(&block)
+    read_template(File.join('templates','example.erb'),&block)
+  end
+
+  def read_relative_template(&block)
+    read_template(File.join('templates','example.erb')) do |contents|
+      read_template(File.join('..','includes','_relative.erb'),&block)
+    end
+  end
+
+  def read_missing_template(&block)
+    read_template('totally_missing.erb',&block)
+  end
+
+end

data/spec/templates/erb_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'ronin/templates/erb'
+
+require 'templates/classes/example_erb'
+
+describe Templates::Erb do
+  subject { ExampleErb.new }
+
+  before(:all) do
+    subject.x = 2
+    subject.y = 3
+  end
+
+  it "should render inline ERB templates" do
+    subject.erb(%{<%= 'hello' %>}).should == 'hello'
+  end
+
+  it "should render ERB templates using the binding of the object" do
+    subject.erb(%{<%= @x %> <%= @y %>}).should == '2 3'
+  end
+end

data/spec/templates/helpers/data.rb

@@ -0,0 +1,9 @@
+require 'data_paths'
+
+module Helpers
+  include DataPaths
+
+  TEMPLATE_DIR = File.expand_path(File.join(File.dirname(__FILE__),'data'))
+
+  register_data_dir TEMPLATE_DIR
+end

data/spec/templates/helpers/data/includes/_relative.erb

@@ -0,0 +1 @@
+This is a template that will be called using a relative path.

data/spec/templates/helpers/data/templates/example.erb

@@ -0,0 +1 @@
+Example template.

data/spec/templates/template_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'ronin/templates/template'
+
+require 'templates/classes/example_template'
+require 'templates/helpers/data'
+
+describe Templates::Template do
+  let(:example_template) { File.join(Helpers::TEMPLATE_DIR,'templates','example.erb') }
+  let(:relative_template) { File.join(Helpers::TEMPLATE_DIR,'includes','_relative.erb') }
+
+  subject { ExampleTemplate.new }
+
+  it "should return the result of the block when entering a template" do
+    subject.enter_example_template { |path|
+      'result'
+    }.should == 'result'
+  end
+
+  it "should be able to find templates relative to the current one" do
+    subject.enter_example_template do |path|
+      path.should == example_template
+    end
+  end
+
+  it "should be able to find static templates" do
+    subject.enter_relative_template do |path|
+      path.should == relative_template
+    end
+  end
+
+  it "should raise a RuntimeError when entering an unknown template" do
+    lambda {
+      subject.enter_missing_template { |path| }
+    }.should raise_error(RuntimeError)
+  end
+
+  it "should be able to read templates relative to the current one" do
+    subject.read_example_template do |contents|
+      contents.should == File.read(example_template)
+    end
+  end
+
+  it "should be able to find static templates" do
+    subject.read_relative_template do |contents|
+      contents.should == File.read(relative_template)
+    end
+  end
+
+  it "should raise a RuntimeError when entering an unknown template" do
+    lambda {
+      subject.read_missing_template { |path| }
+    }.should raise_error(RuntimeError)
+  end
+end

metadata

@@ -0,0 +1,286 @@
+--- !ruby/object:Gem::Specification 
+name: ronin-support
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 1
+  - 0
+  - pre1
+  version: 0.1.0.pre1
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-30 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: chars
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: uri-query_params
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: data_paths
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 1
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: Ronin Support is a support library for Ronin. Ronin Support contains many of the convenience methods used by Ronin and additional libraries.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- ChangeLog.md
+- COPYING.txt
+files: 
+- .document
+- .rspec
+- .yardopts
+- COPYING.txt
+- ChangeLog.md
+- Gemfile
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/ronin/extensions.rb
+- lib/ronin/extensions/file.rb
+- lib/ronin/extensions/ip_addr.rb
+- lib/ronin/extensions/kernel.rb
+- lib/ronin/extensions/meta.rb
+- lib/ronin/extensions/meta/object.rb
+- lib/ronin/extensions/string.rb
+- lib/ronin/formatting.rb
+- lib/ronin/formatting/binary.rb
+- lib/ronin/formatting/digest.rb
+- lib/ronin/formatting/extensions.rb
+- lib/ronin/formatting/extensions/binary.rb
+- lib/ronin/formatting/extensions/binary/file.rb
+- lib/ronin/formatting/extensions/binary/integer.rb
+- lib/ronin/formatting/extensions/binary/string.rb
+- lib/ronin/formatting/extensions/digest.rb
+- lib/ronin/formatting/extensions/digest/file.rb
+- lib/ronin/formatting/extensions/digest/string.rb
+- lib/ronin/formatting/extensions/http.rb
+- lib/ronin/formatting/extensions/http/integer.rb
+- lib/ronin/formatting/extensions/http/string.rb
+- lib/ronin/formatting/extensions/text.rb
+- lib/ronin/formatting/extensions/text/array.rb
+- lib/ronin/formatting/extensions/text/string.rb
+- lib/ronin/formatting/http.rb
+- lib/ronin/formatting/text.rb
+- lib/ronin/network.rb
+- lib/ronin/network/esmtp.rb
+- lib/ronin/network/extensions.rb
+- lib/ronin/network/extensions/esmtp.rb
+- lib/ronin/network/extensions/esmtp/net.rb
+- lib/ronin/network/extensions/http.rb
+- lib/ronin/network/extensions/http/net.rb
+- lib/ronin/network/extensions/imap.rb
+- lib/ronin/network/extensions/imap/net.rb
+- lib/ronin/network/extensions/pop3.rb
+- lib/ronin/network/extensions/pop3/net.rb
+- lib/ronin/network/extensions/smtp.rb
+- lib/ronin/network/extensions/smtp/net.rb
+- lib/ronin/network/extensions/ssl.rb
+- lib/ronin/network/extensions/ssl/net.rb
+- lib/ronin/network/extensions/tcp.rb
+- lib/ronin/network/extensions/tcp/net.rb
+- lib/ronin/network/extensions/telnet.rb
+- lib/ronin/network/extensions/telnet/net.rb
+- lib/ronin/network/extensions/udp.rb
+- lib/ronin/network/extensions/udp/net.rb
+- lib/ronin/network/http.rb
+- lib/ronin/network/http/exceptions.rb
+- lib/ronin/network/http/exceptions/unknown_request.rb
+- lib/ronin/network/http/http.rb
+- lib/ronin/network/http/proxy.rb
+- lib/ronin/network/imap.rb
+- lib/ronin/network/network.rb
+- lib/ronin/network/pop3.rb
+- lib/ronin/network/smtp.rb
+- lib/ronin/network/smtp/email.rb
+- lib/ronin/network/smtp/smtp.rb
+- lib/ronin/network/ssl.rb
+- lib/ronin/network/tcp.rb
+- lib/ronin/network/telnet.rb
+- lib/ronin/network/udp.rb
+- lib/ronin/path.rb
+- lib/ronin/support.rb
+- lib/ronin/support/inflector.rb
+- lib/ronin/support/version.rb
+- lib/ronin/templates.rb
+- lib/ronin/templates/erb.rb
+- lib/ronin/templates/template.rb
+- ronin-support.gemspec
+- spec/extensions/file_spec.rb
+- spec/extensions/ip_addr_spec.rb
+- spec/extensions/kernel_spec.rb
+- spec/extensions/string_spec.rb
+- spec/formatting/binary/helpers/hexdumps.rb
+- spec/formatting/binary/helpers/hexdumps/ascii.bin
+- spec/formatting/binary/helpers/hexdumps/hexdump_decimal_shorts.txt
+- spec/formatting/binary/helpers/hexdumps/hexdump_hex_bytes.txt
+- spec/formatting/binary/helpers/hexdumps/hexdump_hex_shorts.txt
+- spec/formatting/binary/helpers/hexdumps/hexdump_octal_bytes.txt
+- spec/formatting/binary/helpers/hexdumps/hexdump_octal_shorts.txt
+- spec/formatting/binary/helpers/hexdumps/hexdump_repeated.txt
+- spec/formatting/binary/helpers/hexdumps/od_decimal_bytes.txt
+- spec/formatting/binary/helpers/hexdumps/od_decimal_ints.txt
+- spec/formatting/binary/helpers/hexdumps/od_decimal_quads.txt
+- spec/formatting/binary/helpers/hexdumps/od_decimal_shorts.txt
+- spec/formatting/binary/helpers/hexdumps/od_hex_bytes.txt
+- spec/formatting/binary/helpers/hexdumps/od_hex_ints.txt
+- spec/formatting/binary/helpers/hexdumps/od_hex_quads.txt
+- spec/formatting/binary/helpers/hexdumps/od_hex_shorts.txt
+- spec/formatting/binary/helpers/hexdumps/od_octal_bytes.txt
+- spec/formatting/binary/helpers/hexdumps/od_octal_ints.txt
+- spec/formatting/binary/helpers/hexdumps/od_octal_quads.txt
+- spec/formatting/binary/helpers/hexdumps/od_octal_shorts.txt
+- spec/formatting/binary/helpers/hexdumps/od_repeated.txt
+- spec/formatting/binary/helpers/hexdumps/repeated.bin
+- spec/formatting/binary/integer_spec.rb
+- spec/formatting/binary/string_spec.rb
+- spec/formatting/digest/string_spec.rb
+- spec/formatting/http/integer_spec.rb
+- spec/formatting/http/string_spec.rb
+- spec/formatting/text/array_spec.rb
+- spec/formatting/text/string_spec.rb
+- spec/network/http/http_spec.rb
+- spec/network/http/proxy_spec.rb
+- spec/network/network_spec.rb
+- spec/network/ssl_spec.rb
+- spec/path_spec.rb
+- spec/spec_helper.rb
+- spec/support_spec.rb
+- spec/templates/classes/example_erb.rb
+- spec/templates/classes/example_template.rb
+- spec/templates/erb_spec.rb
+- spec/templates/helpers/data.rb
+- spec/templates/helpers/data/includes/_relative.erb
+- spec/templates/helpers/data/templates/example.erb
+- spec/templates/template_spec.rb
+has_rdoc: yard
+homepage: http://github.com/ronin-ruby/ronin-support
+licenses: 
+- LGPL-2.1
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: ronin-support
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A support library for Ronin.
+test_files: 
+- spec/network/network_spec.rb
+- spec/network/http/http_spec.rb
+- spec/network/http/proxy_spec.rb
+- spec/network/ssl_spec.rb
+- spec/templates/erb_spec.rb
+- spec/templates/template_spec.rb
+- spec/path_spec.rb
+- spec/extensions/file_spec.rb
+- spec/extensions/kernel_spec.rb
+- spec/extensions/string_spec.rb
+- spec/extensions/ip_addr_spec.rb
+- spec/formatting/binary/integer_spec.rb
+- spec/formatting/binary/string_spec.rb
+- spec/formatting/digest/string_spec.rb
+- spec/formatting/text/array_spec.rb
+- spec/formatting/text/string_spec.rb
+- spec/formatting/http/integer_spec.rb
+- spec/formatting/http/string_spec.rb
+- spec/support_spec.rb