ronin-core 0.1.0.beta1 → 0.1.1

data/lib/ronin/core/metadata/id.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #
@@ -25,13 +25,13 @@ module Ronin
       # ### Example
       #
       #     class MyClass
-      #     
+      #
       #       include Ronin::Core::Metadata::ID
       #
       #       id 'my_class'
       #
       #     end
-      #     
+      #
       module ID
         #
         # Adds {ClassMethods} to the class.
@@ -45,6 +45,9 @@ module Ronin
           base.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the class `id`.

data/lib/ronin/core/metadata/references.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #
@@ -26,14 +26,14 @@ module Ronin
       # ### Example
       #
       #     class MyModule
-      #     
+      #
       #       include Ronin::Core::Metadata::References
-      #     
+      #
       #       references [
       #         "https://...",
       #         ...
       #       ]
-      #     
+      #
       #     end
       #
       module References
@@ -49,6 +49,9 @@ module Ronin
           base.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the reference links.
@@ -71,7 +74,11 @@ module Ronin
           #
           def references(new_references=nil)
             if new_references
-              @references = references() + new_references
+              @references = if superclass.kind_of?(ClassMethods)
+                              superclass.references + new_references
+                            else
+                              new_references
+                            end
             else
               @references || if superclass.kind_of?(ClassMethods)
                                superclass.references

data/lib/ronin/core/metadata/summary.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #
@@ -26,11 +26,11 @@ module Ronin
       # ### Example
       #
       #     class MyModule
-      #     
+      #
       #       include Ronin::Core::Metadata::Summary
-      #     
+      #
       #       summary "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
-      #     
+      #
       #     end
       #
       module Summary
@@ -46,6 +46,9 @@ module Ronin
           base.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the summary.
@@ -57,7 +60,7 @@ module Ronin
           #   The previously set summary text.
           #
           # @example Setting the summary:
-          #   summary "Lorem ipsum dolor sit amet, consectetur adipiscing elit" 
+          #   summary "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
           #
           # @example Getting the summary:
           #   MyModule.summary
@@ -67,7 +70,7 @@ module Ronin
               @summary = new_summary
             else
               @summary || if superclass.kind_of?(ClassMethods)
-                                superclass.summary
+                            superclass.summary
                           end
             end
           end

data/lib/ronin/core/metadata/version.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #
@@ -26,11 +26,11 @@ module Ronin
       # ### Example
       #
       #     class MyModule
-      #     
+      #
       #       include Ronin::Core::Metadata::Version
-      #     
+      #
       #       version '0.2'
-      #     
+      #
       #     end
       #
       module Version
@@ -46,6 +46,9 @@ module Ronin
           base.extend ClassMethods
         end
 
+        #
+        # Class methods.
+        #
         module ClassMethods
           #
           # Gets or sets the version number.

data/lib/ronin/core/params/exceptions.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #

data/lib/ronin/core/params/mixin.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #
@@ -29,36 +29,36 @@ module Ronin
       # ## Examples
       #
       #     class BaseClass
-      #     
+      #
       #       include Ronin::Core::Params::Mixin
-      #     
+      #
       #     end
       #
       #     class MyModule < BaseClass
-      #     
+      #
       #       param :str, desc: 'A basic string param'
-      #     
+      #
       #       param :feature_flag, Boolean, desc: 'A boolean param'
-      #     
+      #
       #       param :enum, Enum[:one, :two, :three],
       #                    desc: 'An enum param'
       #
       #       param :num1, Integer, desc: 'An integer param'
-      #     
+      #
       #       param :num2, Integer, default: 42,
       #                            desc: 'A param with a default value'
-      #     
+      #
       #       param :num3, Integer, default: ->{ rand(42) },
       #                             desc: 'A param with a dynamic default value'
-      #     
+      #
       #       param :float, Float, 'Floating point param'
       #
       #       param :url, URI, desc: 'URL param'
       #
       #       param :pattern, Regexp, desc: 'Regular Expression param'
-      #     
+      #
       #     end
-      #     
+      #
       #     mod = MyModule.new(params: {num1: 1, enum: :two})
       #     mod.params
       #     # => {:num2=>42, :num3=>25, :num1=>1, :enum=>:two}
@@ -79,7 +79,7 @@ module Ronin
         #   The class which is including {Mixin}.
         #
         # @raise [TypeError]
-        #   {Mixin} was inclued into a module instead of a class.
+        #   {Mixin} was included into a module instead of a class.
         #
         # @api private
         #
@@ -197,7 +197,7 @@ module Ronin
         end
 
         # The param values.
-        # 
+        #
         # @return [Hash{Symbol => Object}]
         #
         # @api public
@@ -220,7 +220,7 @@ module Ronin
         #
         def initialize(*arguments, params: nil, **kwargs, &block)
           if params then self.params = params
-          else           initialize_params()
+          else           initialize_params
           end
 
           super(*arguments,**kwargs,&block)
@@ -281,7 +281,7 @@ module Ronin
         #
         def params=(new_params)
           # re-initialize the params each time they are set en-mass
-          initialize_params()
+          initialize_params
 
           new_params.each do |name,value|
             set_param(name,value)

data/lib/ronin/core/params/param.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #
@@ -41,7 +41,7 @@ module Ronin
         # @return [Boolean]
         attr_reader :required
 
-        # The cefault value or proc for the param.
+        # The default value or proc for the param.
         #
         # @return [Object, Proc, nil]
         attr_reader :default

data/lib/ronin/core/params/types/boolean.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #

data/lib/ronin/core/params/types/enum.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #
@@ -51,7 +51,11 @@ module Ronin
             end
 
             @values = values
-            @map    = Hash[values.map { |value| [value.to_s, value] }]
+            @map    = {}
+
+            values.each do |value|
+              @map[value.to_s] = value
+            end
           end
 
           #

data/lib/ronin/core/params/types/float.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #

data/lib/ronin/core/params/types/integer.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #

data/lib/ronin/core/params/types/numeric.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #
@@ -30,7 +30,7 @@ module Ronin
           # The optional minimum value.
           #
           # @return [::Integer, nil]
-          # 
+          #
           # @api private
           attr_reader :min
 

data/lib/ronin/core/params/types/regexp.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #

data/lib/ronin/core/params/types/string.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #

data/lib/ronin/core/params/types/type.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #

data/lib/ronin/core/params/types/uri.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #

data/lib/ronin/core/params/types.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #
@@ -28,6 +28,9 @@ require 'ronin/core/params/types/enum'
 module Ronin
   module Core
     module Params
+      #
+      # Contains all {Param::Type} classes.
+      #
       module Types
         # Mapping of ruby core classes to param types.
         TYPE_ALIASES = {
@@ -35,7 +38,7 @@ module Ronin
           ::Integer => Types::Integer,
           ::Float   => Types::Float,
           ::Regexp  => Types::Regexp,
-          ::URI     => Types::URI,
+          ::URI     => Types::URI
         }
 
         #

data/lib/ronin/core/params.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # ronin-core 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 Lesser General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU Lesser General Public License
 # along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
 #