ronin 1.0.0 → 1.1.0.rc1

data/lib/ronin/ui/cli/commands/ips.rb

@@ -17,7 +17,7 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/ui/cli/model_command'
+require 'ronin/ui/cli/resources_command'
 require 'ronin/extensions/ip_addr'
 require 'ronin/ip_address'
 
@@ -28,9 +28,9 @@ module Ronin
         #
         # The `ronin-ips` command.
         #
-        class IPs < ModelCommand
+        class IPs < ResourcesCommand
 
-          self.model = IPAddress
+          model IPAddress
 
           query_option :v4, :type => :boolean, :aliases => '-4'
           query_option :v6, :type => :boolean, :aliases => '-6'
@@ -85,8 +85,6 @@ module Ronin
           # @since 1.0.0
           #
           def lookup(host)
-            Database.setup
-
             print_info "Looking up #{host} ..."
 
             IPAddress.lookup(host).each do |ip|
@@ -105,8 +103,6 @@ module Ronin
           # @since 1.0.0
           #
           def import(path)
-            Database.setup
-
             File.open(options[:import]) do |file|
               file.each_line do |line|
                 IPAddr.extract(line) do |match|

data/lib/ronin/ui/cli/commands/repos.rb

@@ -17,9 +17,8 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/ui/cli/command'
+require 'ronin/ui/cli/model_command'
 require 'ronin/repository'
-require 'ronin/database'
 
 module Ronin
   module UI
@@ -28,7 +27,7 @@ module Ronin
         #
         # The `ronin repos` command.
         #
-        class Repos < Command
+        class Repos < ModelCommand
 
           desc 'Manages Ronin repositories'
           class_option :add, :type => :string,
@@ -57,8 +56,6 @@ module Ronin
           # Executes the command.
           #
           def execute
-            Database.setup
-
             if options[:add]
               add options[:add]
             elsif options[:install]
@@ -143,19 +140,10 @@ module Ronin
                 if repo.verbose?
                   putc "\n"
 
-                  if repo.title
-                    puts "Title: #{repo.title}"
-                  end
-
+                  puts "Title: #{repo.title}" if repo.title
                   puts "URI: #{repo.uri}" if repo.uri
-
-                  if repo.source
-                    puts "Source URI: #{repo.source}"
-                  end
-
-                  if repo.website
-                    puts "Website: #{repo.website}"
-                  end
+                  puts "Source URI: #{repo.source}" if repo.source
+                  puts "Website: #{repo.website}" if repo.website
 
                   executables = repo.executables
 

data/lib/ronin/ui/cli/commands/urls.rb

@@ -17,7 +17,7 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/ui/cli/model_command'
+require 'ronin/ui/cli/resources_command'
 require 'ronin/url'
 
 module Ronin
@@ -27,9 +27,9 @@ module Ronin
         #
         # The `ronin-urls` command.
         #
-        class URLs < ModelCommand
+        class URLs < ResourcesCommand
 
-          self.model = URL
+          model URL
 
           query_option :http, :type => :boolean
           query_option :https, :type => :boolean

data/lib/ronin/ui/cli/model_command.rb

@@ -20,20 +20,16 @@
 require 'ronin/ui/cli/command'
 require 'ronin/database'
 
-require 'set'
-
 module Ronin
   module UI
     module CLI
       #
-      # A base-command for querying and exporting {Model}s.
+      # A base-command for querying {Model}s.
       #
       class ModelCommand < Command
 
-        class_option :csv, :type => :boolean
-        class_option :xml, :type => :boolean
-        class_option :yaml, :type => :boolean
-        class_option :json, :type => :boolean
+        class_option :database, :type => :string,
+                                :aliases => '-D'
 
         #
         # The model to query.
@@ -41,33 +37,52 @@ module Ronin
         # @return [DataMapper::Resource]
         #   The model that will be queried.
         #
-        # @since 1.0.0
+        # @since 1.1.0
+        #
+        # @api semipublic
         #
-        def self.model
-          @model
+        def self.query_model
+          @query_model ||= if self.superclass < ModelCommand
+                       self.superclass.query_model
+                     end
         end
 
         #
         # The query options for the command.
         #
-        # @return [Set]
+        # @return [Array<Symbol>]
         #   The query options and their query method names.
         #
         # @since 1.0.0
         #
+        # @api semipublic
+        #
         def self.query_options
-          @query_options ||= Set[]
+          @query_options ||= []
         end
 
         #
-        # Default method performs the query and prints the found resources.
+        # Iterates over the query options for the command.
         #
-        # @since 1.0.0
+        # @yield [name]
+        #   The given block will be passed the names of the query options.
         #
-        def execute
-          Database.setup
+        # @yieldparam [Symbol] name
+        #   The name of a query option.
+        #
+        # @return [Enumerator]
+        #   If no block is given, an Enumerator object will be returned.
+        #
+        # @since 1.1.0
+        #
+        def self.each_query_option(&block)
+          return enum_for(:each_query_option) unless block
 
-          print_resources(query)
+          self.class.ancestors.each do |ancestor|
+            if ancestor < ModelCommand
+              ancestor.query_options.each(&block)
+            end
+          end
         end
 
         protected
@@ -81,10 +96,12 @@ module Ronin
         # @return [DataMapper::Resource]
         #   The model that will be queried.
         #
-        # @since 1.0.0
+        # @since 1.1.0
+        #
+        # @api semipublic
         #
-        def self.model=(model)
-          @model = model
+        def self.model(model)
+          @query_model = model
         end
 
         #
@@ -98,108 +115,76 @@ module Ronin
         #
         # @since 1.0.0
         #
+        # @api semipublic
+        #
         def self.query_option(name,options={})
           query_options << name
           class_option(name,options)
         end
 
         #
-        # Invokes a query method on a query.
-        #
-        # @param [DataMapper::Collection] query
-        #   The query.
-        #
-        # @param [Symbol] name
-        #   The method name to call.
-        #
-        # @param [Array] arguments
-        #   Additional arguments to pass to the query method.
+        # Sets up the {Database}.
         #
-        # @return [DataMapper::Collection]
-        #   The modified query.
+        # @since 1.1.0
         #
-        # @since 1.0.0
+        # @api semipublic
         #
-        def query_method(query,name,arguments=[])
-          query_method = begin
-                           query.model.method(name)
-                         rescue NameError
-                           raise("Undefined query method #{query.model}.#{name}")
-                         end
-
-          case query_method.arity
-          when 0
-            query.send(name)
-          when 1
-            query.send(name,arguments)
-          else
-            query.send(name,*arguments)
+        def setup
+          super
+
+          if self.options[:database]
+            Database.repositories[:default] = options[:database]
           end
+
+          Database.setup
         end
 
         #
         # Builds a new query using the options of the command.
         #
-        # @yield [query]
-        #   If a block is given, it will be passed the new query.
-        #
-        # @yieldparam [DataMapper::Collection] query
-        #   The new query.
-        #
         # @return [DataMapper::Collection]
         #   The new query.
         #
+        # @raise [RuntimeError]
+        #   The query option does not map to a query-method or property
+        #   defined in the Model.
+        #
         # @since 1.0.0
         #
+        # @api semipublic
+        #
         def query
-          new_query = self.class.model.all
+          unless self.class.query_model
+            raise("query model not defined for #{self.class}")
+          end
 
-          self.class.ancestors.each do |ancestor|
-            if ancestor < ModelCommand
-              ancestor.query_options.each do |name|
-                unless options[name].nil?
-                  new_query = query_method(new_query,name,options[name])
-                end
-              end
+          query = self.class.query_model.all
+
+          self.class.each_query_option do |name|
+            value = options[name]
+
+            # skip unset options
+            next if value.nil?
+
+            if query_model.properties.named?(name)
+              query = query.all(name => value)
+            elsif query_model.respond_to?(name)
+              query_method = query_model.method(name)
+
+              query = case query_method.arity
+                      when 0
+                        query.send(name)
+                      when 1
+                        query.send(name,value)
+                      else
+                        query.send(name,*value)
+                      end
+            else
+              raise("unknown query method or property #{name} for #{query_model}")
             end
           end
 
-          new_query = yield(new_query) if block_given?
-          return new_query
-        end
-
-        #
-        # Default method which will print every queried resource.
-        #
-        # @param [DataMapper::Resource] resource
-        #   A queried resource from the Database.
-        #
-        # @since 1.0.0
-        #
-        def print_resource(resource)
-          puts resource
-        end
-
-        #
-        # Prints multiple resources.
-        #
-        # @param [DataMapper::Collection, Array<DataMapper::Resource>] resources
-        #   The query to print.
-        #
-        # @since 1.0.0
-        #
-        def print_resources(resources)
-          if options.csv?
-            print resources.to_csv
-          elsif options.xml?
-            print resources.to_xml
-          elsif options.yaml?
-            print resources.to_yaml
-          elsif options.json?
-            print resources.to_json
-          else
-            resources.each { |resource| print_resource(resource) }
-          end
+          return query
         end
 
       end

data/lib/ronin/ui/cli/resources_command.rb

@@ -0,0 +1,89 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin.
+#
+# Ronin 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 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/ui/cli/model_command'
+
+module Ronin
+  module UI
+    module CLI
+      #
+      # A base-command class for listing Database Resources.
+      #
+      class ResourcesCommand < ModelCommand
+
+        class_option :csv, :type => :boolean
+        class_option :xml, :type => :boolean
+        class_option :yaml, :type => :boolean
+        class_option :json, :type => :boolean
+
+        #
+        # Default method performs the query and prints the found resources.
+        #
+        # @since 1.1.0
+        #
+        # @api semipublic
+        #
+        def execute
+          print_resources(query)
+        end
+
+        protected
+
+        #
+        # Default method which will print every queried resource.
+        #
+        # @param [DataMapper::Resource] resource
+        #   A queried resource from the Database.
+        #
+        # @since 1.1.0
+        #
+        # @api semipublic
+        #
+        def print_resource(resource)
+          puts resource
+        end
+
+        #
+        # Prints multiple resources.
+        #
+        # @param [DataMapper::Collection] resources
+        #   The query to print.
+        #
+        # @since 1.1.0
+        #
+        # @api semipublic
+        #
+        def print_resources(resources)
+          if options.csv?
+            print resources.to_csv
+          elsif options.xml?
+            print resources.to_xml
+          elsif options.yaml?
+            print resources.to_yaml
+          elsif options.json?
+            print resources.to_json
+          else
+            resources.each { |resource| print_resource(resource) }
+          end
+        end
+
+      end
+    end
+  end
+end