ronin 0.2.2 → 0.2.3

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

@@ -51,11 +51,15 @@ module Ronin
             topic = args.first
 
             if topic
-              CommandLine.run(topic,'--help')
+              begin
+                CommandLine.get_command(topic).run('--help')
+              rescue UnknownCommand
+                fail("unknown sub-command #{topic.dump}")
+              end
             else
-              puts 'Available commands:'
+              puts 'Available sub-commands:'
 
-              CommandLine.commands.keys.sort.each do |name|
+              CommandLine.commands.sort.each do |name|
                 puts "  #{name}"
               end
             end

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

@@ -28,7 +28,7 @@ module Ronin
   module UI
     module CommandLine
       module Commands
-        class LS < Command
+        class Ls < Command
 
           def defaults
             @cache = nil

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

@@ -28,7 +28,7 @@ module Ronin
   module UI
     module CommandLine
       module Commands
-        class RM < Command
+        class Rm < Command
 
           def defaults
             @cache = nil

data/lib/ronin/ui/command_line/exceptions/unknown_command.rb

@@ -24,7 +24,7 @@
 module Ronin
   module UI
     module CommandLine
-      class UnknownCommand < RuntimeError
+      class UnknownCommand < StandardError
       end
     end
   end

data/lib/ronin/ui/diagnostics.rb

@@ -32,13 +32,22 @@ module Ronin
       # Prints the given _messages_ as info diagnostics.
       #
       def print_info(*messages)
+        STDERR.puts(*(messages.map { |mesg| "[-] #{mesg}" }))
+      end
+
+      #
+      # Prints the given _messages_ as debugging diagnostics,
+      # if Ronin::UI::Verbose was enabled.
+      #
+      def print_debug(*messages)
         if Verbose.enabled?
-          STDERR.puts(*(messages.map { |mesg| "[-] #{mesg}" }))
+          STDERR.puts(*(messages.map { |mesg| "[+] #{mesg}" }))
         end
       end
 
       #
-      # Prints the given _messages_ as warning diagnostics.
+      # Prints the given _messages_ as warning diagnostics,
+      # if Ronin::UI::Verbose was enabled.
       #
       def print_warning(*messages)
         if Verbose.enabled?
@@ -50,9 +59,7 @@ module Ronin
       # Prints the given _messages_ as error diagnostics.
       #
       def print_error(*messages)
-        if Verbose.enabled?
-          STDERR.puts(*(messages.map { |mesg| "[!] #{mesg}" }))
-        end
+        STDERR.puts(*(messages.map { |mesg| "[!] #{mesg}" }))
       end
     end
   end

data/lib/ronin/ui/hexdump/extensions/file.rb

@@ -30,7 +30,9 @@ class File
   # to the given _output_ stream.
   #
   def self.hexdump(path,output=STDOUT)
-    Ronin::UI::Hexdump.dump(self.open(path),output)
+    self.open(path) do |file|
+      Ronin::UI::Hexdump.dump(file,output)
+    end
   end
 
 end

data/lib/ronin/ui/hexdump/hexdump.rb

@@ -39,7 +39,7 @@ module Ronin
             index,
             hex_segment.join(' ').ljust(47).insert(23,' '),
             print_segment
-        )
+          )
         }
 
         object.each_byte do |b|

data/lib/ronin/ui/verbose.rb

@@ -24,18 +24,32 @@
 module Ronin
   module UI
     module Verbose
+      #
+      # Enables verbose mode.
+      #
       def Verbose.enable!
         @@ronin_verbose = true
       end
 
+      #
+      # Returns +true+ if verbose mode is enabled, returns +false+
+      # otherwise.
+      #
       def Verbose.enabled?
         (@@ronin_verbose ||= false) == true
       end
 
+      #
+      # Disables verbose mode.
+      #
       def Verbose.disable!
         @@ronin_verbose = false
       end
 
+      #
+      # Returns +true+ if verbose mode is disabled, returns +false+
+      # otherwise.
+      #
       def Verbose.disabled?
         (@@ronin_verbose ||= false) == false
       end

data/lib/ronin/version.rb

@@ -23,5 +23,5 @@
 
 module Ronin
   # Ronin version 
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/spec/cacheable_spec.rb

@@ -0,0 +1,150 @@
+require 'ronin/cacheable'
+
+require 'spec_helper'
+require 'classes/cacheable_model'
+require 'helpers/cacheable'
+
+describe Cacheable do
+  before(:all) do
+    CacheableModel.auto_migrate!
+  end
+
+  it "should maintain a list of models which are cacheable" do
+    Cacheable.models.include?(CacheableModel).should == true
+  end
+
+  it "should be able to load arbitrary objects from a file" do
+    objs = Cacheable.load_all_from(CACHEABLE_FILE)
+
+    objs.length.should == 1
+    objs.first.content.should == 'this is a test'
+  end
+
+  it "should be able to cache arbitrary objects from a file" do
+    objs = Cacheable.cache_all(CACHEABLE_FILE)
+
+    objs.length.should == 1
+    objs.first.content.should == 'this is a test'
+  end
+
+  describe "load_from" do
+    before(:all) do
+      CacheableModel.auto_migrate!
+
+      @obj = CacheableModel.load_from(CACHEABLE_FILE)
+    end
+
+    it "should set the cached_path property" do
+      @obj.cached_path.should == Pathname.new(CACHEABLE_FILE)
+    end
+
+    it "should set the cached_timestamp property" do
+      @obj.cached_timestamp.should == File.mtime(CACHEABLE_FILE).to_i
+    end
+
+    it "should prepare the object to be cached" do
+      @obj.content.should == 'this is a test'
+    end
+
+    it "should preserve instance variables" do
+      @obj.config.should == true
+    end
+
+    it "should preserve instance methods" do
+      @obj.greeting.should == 'hello'
+    end
+  end
+
+  describe "new files" do
+    before(:all) do
+      CacheableModel.auto_migrate!
+      FileUtils.cp CACHEABLE_FILE, CACHEABLE_PATH
+    end
+
+    it "should be able to cache new files" do
+      obj = CacheableModel.cache(CACHEABLE_PATH)
+
+      obj.should_not be_dirty
+      obj.id.should == 1
+    end
+
+    it "should call the cache method before saving the new object" do
+      model = CacheableModel.first
+
+      model.content.should == 'this is a test'
+    end
+  end
+
+  describe "unmodified files" do
+    before(:all) do
+      CacheableModel.auto_migrate!
+      CacheableModel.cache(CACHEABLE_PATH)
+    end
+
+    it "should not re-cache unmodified files" do
+      model = CacheableModel.first
+
+      (model.sync!).should == false
+    end
+  end
+
+  describe "modified files" do
+    before(:all) do
+      CacheableModel.auto_migrate!
+
+      model = CacheableModel.cache(CACHEABLE_PATH)
+      model.cached_timestamp -= 10
+      model.save!
+    end
+
+    it "should re-cache modified files" do
+      model = CacheableModel.first
+
+      (model.sync!).should == true
+    end
+  end
+
+  describe "cached files" do
+    before(:all) do
+      CacheableModel.auto_migrate!
+      CacheableModel.cache(CACHEABLE_FILE)
+    end
+
+    it "should be able to load the original object" do
+      model = CacheableModel.first
+
+      model.load_original!
+      model.greeting.should == 'hello'
+    end
+
+    it "should load the original object on demand" do
+      model = CacheableModel.first
+      model.greeting.should == 'hello'
+    end
+
+    it "should only load the original object once" do
+      model = CacheableModel.first
+      model.load_original!
+
+      model.config = false
+      model.load_original!
+
+      model.config.should == false
+    end
+  end
+
+  describe "missing files" do
+    before(:all) do
+      CacheableModel.auto_migrate!
+      CacheableModel.cache(CACHEABLE_PATH)
+
+      FileUtils.rm CACHEABLE_PATH
+    end
+
+    it "should be able to expunge cached objects for missing files" do
+      CacheableModel.first.sync!
+
+      CacheableModel.all(:cached_path => CACHEABLE_PATH).should be_empty
+    end
+  end
+end

data/spec/classes/cacheable_model.rb

@@ -0,0 +1,15 @@
+require 'ronin/cacheable'
+
+class CacheableModel
+
+  include Ronin::Cacheable
+
+  contextify :ronin_cacheable_model
+
+  property :id, Serial
+
+  property :content, String
+
+  attr_accessor :config
+
+end

data/spec/classes/licensed_model.rb

@@ -0,0 +1,12 @@
+require 'ronin/has_license'
+
+class LicensedModel
+
+  include Model
+  include HasLicense
+
+  property :id, Serial
+
+  property :content, String
+
+end

data/spec/code/classes/thing.rb

@@ -0,0 +1,13 @@
+class Thing
+
+  def exposed
+    1
+  end
+
+  protected
+
+  def not_exposed
+    2
+  end
+
+end

data/spec/code/reference_spec.rb

@@ -1,23 +1,10 @@
 require 'ronin/code/reference'
 
 require 'spec_helper'
+require 'code/classes/thing'
 
 describe Code::Reference do
   before(:all) do
-    class Thing
-
-      def exposed
-        1
-      end
-
-      protected
-
-      def not_exposed
-        2
-      end
-
-    end
-
     @object = Thing.new
     @ref = Code::Reference.new(@object)
   end

data/spec/extensions/array_spec.rb

@@ -0,0 +1,34 @@
+require 'ronin/extensions/array'
+
+describe Array do
+  it "should provide Array#power_set" do
+    [].respond_to?(:power_set).should == true
+  end
+
+  describe "power_set" do
+    before(:all) do
+      @array = [1,2,3]
+      @set = @array.power_set
+    end
+
+    it "should contain an empty set" do
+      @set.include?([]).should == true
+    end
+
+    it "should contain singleton sets of all the elements" do
+      @set.include?([1]).should == true
+      @set.include?([2]).should == true
+      @set.include?([3]).should == true
+    end
+
+    it "should include the sub-sets of the original set" do
+      @set.include?([1,2]).should == true
+      @set.include?([1,3]).should == true
+      @set.include?([2,3]).should == true
+    end
+
+    it "should include the original set itself" do
+      @set.include?(@array).should == true
+    end
+  end
+end

data/spec/extensions/ip_addr_spec.rb

@@ -0,0 +1,44 @@
+require 'ronin/extensions/ip_addr'
+
+require 'spec_helper'
+
+describe IPAddr do
+  describe "CIDR addresses" do
+    before(:all) do
+      @fixed_addr = IPAddr.new('10.1.1.2')
+      @class_c = IPAddr.new('10.1.1.2/24')
+    end
+
+    it "should only iterate over one IP address for an address" do
+      addresses = @fixed_addr.map { |ip| IPAddr.new(ip) }
+
+      addresses.length.should == 1
+      @fixed_addr.include?(addresses.first)
+    end
+
+    it "should iterate over all IP addresses contained within the IP range" do
+      @class_c.each do |ip|
+        @class_c.include?(IPAddr.new(ip)).should == true
+      end
+    end
+  end
+
+  describe "globbed addresses" do
+    before(:all) do
+      @ipv4_range = '10.1.1-5.1'
+      @ipv6_range = '::ff::02-0a::c3'
+    end
+
+    it "should iterate over all IP addresses in an IPv4 range" do
+      IPAddr.each(@ipv4_range) do |ip|
+        ip =~ /^10\.1\.[1-5]\.1$/
+      end
+    end
+
+    it "should iterate over all IP addresses in an IPv6 range" do
+      IPAddr.each(@ipv6_range) do |ip|
+        ip =~ /^::ff::0[2-9a]::c3$/
+      end
+    end
+  end
+end