brutalitops 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fb7ccf41927b8945bc986b4113072a833500e26ef2e6f4198b777e968ac31d4
-  data.tar.gz: e098e2de80e874745888eefddd0b326284b15fc64afebdb17454baadf712b66d
+  metadata.gz: 90b13fda7a7a5079244ae8b974fb3f0b8ee2acfbbc5ddb6d7b49731b636c5a82
+  data.tar.gz: d11b46b9ff069374d71f949d249d0aca175d40c8b98845473af999a1a569ba00
 SHA512:
-  metadata.gz: 31eedc9cfd8f1062ead44a57cf7e627a4fc074e6b4c0c120791fc8f8cd5e183ecaab0a9b1ec1cfdf6e01548b5ec93ac86505b44421f8e5771c4bce0a5645c397
-  data.tar.gz: e021209db9b87e5cb35909cff3442e66b273d778b01adbb101c740c086f725c8435dafdd297531819bc0439a67d78eefb465fe4a6599ed3e29514c7c74bf26d6
+  metadata.gz: 22072c221ba4c31f5e25575bbba5754206df46425c5bab6a4ecd3b1b2bc2a5bab0e3dbcb485ea048992b4d3accde513b804c40e96719fdc912c134706c8df40d
+  data.tar.gz: af1bd27da73a058fe3d11458bd7e9f8d3524ba4c5927f1c1e790b04bad9a13d172f1d3a841137e231da3567b5e6779f8c7bd6232bbecd0abaddb33491673fc1a

data/README

@@ -1,2 +1,44 @@
 Generates permutations and returns an array, or prints to csv, or prints to console. See https://github.com/andydwyer/brutalitops for usage.
 
+# Usage
+
+## Initialization
+
+```
+Brutalitops.new( min_length_of_the_permutation, max_length_of_the_permutation, [optional_symbols_and_or_custom_array] )
+
+Example:
+b = Brutalitops.new(1,3,[:alpha_lowercase, :alpha_uppercase, :nums, :special_chars, ["ä", "ö", "ü"]])
+
+:alpha_lowercase = ('a'..'z').to_a
+:alpha_uppercase = ('A'..'Z').to_a
+:nums = (0..9).to_a
+:special_chars = [' ', '!', '@', '#', '$', '%','^', '&', '*', '(', ')', '-', '_', '+', '=', '[', ']', '{', '}', '|', '\\', '?', "/", '<', '>', '.', ',', '~', '`']
+["ä", "ö", "ü"] = any array of elements
+
+All arrays passed in as the 3rd argument are concatentated.
+
+Note: Generating permutations when max_length_of_the_permutation > 3 might take a long time (i.e. hours) depending on your processing power.
+```
+
+## Methods
+
+```
+b.print_permutations_to_console
+
+-Prints the resulting permutations to console.
+-Accepts an optional boolean argument to turn off status-related console messages, e.g. b.print_permutations_to_console(false)
+```
+
+```
+b.print_permutations_to_csv
+
+-Prints the resulting permutations to a CSV named brutalitops_<time stamp>.csv
+-Accepts an optional boolean argument to turn off status-related console messages, e.g. b.print_permutations_to_csv(false)
+```
+
+```
+a = b.to_array
+
+-Returns the resulting permutations to an array
+```

data/bin/brutalitops

@@ -1,75 +1,76 @@
 #!/usr/bin/env ruby
-
-class Brutalitops
-
-    def initialize(min, max, options=[])
-        alphabet_lowercase = ('a'..'z').to_a
-        alphabet_uppercase = ('A'..'Z').to_a
-        nums = (0..9).to_a
-        specials = [' ', '!', '@', '#', '$', '%','^', '&', '*', '(', ')', '-', '_', '+', '=', '[', ']', '{', '}', '|', '\\', '?', "/", '<', '>', '.', ',', '~', '`']
-
-        @min = min
-        @max = max
-        @selection = []
-
-        if !options.empty?
-            options.each do |option|
-                case option
-                when :alpha_lowercase
-                    @selection += alphabet_lowercase
-                when :alpha_uppercase
-                    @selection += alphabet_uppercase
-                when :nums
-                    @selection += nums
-                when :special_chars
-                    @selection += specials
-                else
-                    #handle custom array passed in
-                    @selection += option
+module Brutalitops
+    class Brutalitops
+
+        def initialize(min, max, options=[])
+            alphabet_lowercase = ('a'..'z').to_a
+            alphabet_uppercase = ('A'..'Z').to_a
+            nums = (0..9).to_a
+            specials = [' ', '!', '@', '#', '$', '%','^', '&', '*', '(', ')', '-', '_', '+', '=', '[', ']', '{', '}', '|', '\\', '?', "/", '<', '>', '.', ',', '~', '`']
+
+            @min = min
+            @max = max
+            @selection = []
+
+            if !options.empty?
+                options.each do |option|
+                    case option
+                    when :alpha_lowercase
+                        @selection += alphabet_lowercase
+                    when :alpha_uppercase
+                        @selection += alphabet_uppercase
+                    when :nums
+                        @selection += nums
+                    when :special_chars
+                        @selection += specials
+                    else
+                        #handle custom array passed in
+                        @selection += option
+                    end
                 end
             end
         end
-    end
 
-    def print_permutations_to_console(verbose=true)
-        generate_permutations(verbose).each do |permutation|
-            puts permutation
+        def print_permutations_to_console(verbose=true)
+            generate_permutations(verbose).each do |permutation|
+                puts permutation
+            end
         end
-    end
 
-    def print_permutations_to_csv(verbose=true)
-        puts "Generating csv..." if verbose
-        File.open("brutalitops_#{Time.now.strftime("%Y_%m_%d_%H%M%S").to_s}.csv", "w") do |file|
-            generate_permutations(verbose).each do |permutation|
-                file.puts permutation
+        def print_permutations_to_csv(verbose=true)
+            puts "Generating csv..." if verbose
+            File.open("brutalitops_#{Time.now.strftime("%Y_%m_%d_%H%M%S").to_s}.csv", "w") do |file|
+                generate_permutations(verbose).each do |permutation|
+                    file.puts permutation
+                end
             end
+            puts "Finished generating csv." if verbose
         end
-        puts "Finished generating csv." if verbose
-    end
 
-    def to_array
-        generate_permutations
-    end
+        def to_array
+            generate_permutations
+        end
 
-private
+    private
 
-    def generate_permutations(verbose=false)
-        permutations = []
-        puts "Generating permutations..." if verbose
+        def generate_permutations(verbose=false)
+            permutations = []
+            puts "Generating permutations..." if verbose
 
-        @min.upto(@max) do |i|
-            puts "Building permutation with #{i} choices. This might take some time." if verbose
-            temp_arr = @selection.repeated_permutation(i).to_a
-            temp_arr.each {|t| permutations << t.join.to_s}
-            puts "Finished building permutation with #{i} choices." if verbose
-        end
+            @min.upto(@max) do |i|
+                puts "Building permutation with #{i} choices. This might take some time." if verbose
+                temp_arr = @selection.repeated_permutation(i).to_a
+                temp_arr.each {|t| permutations << t.join.to_s}
+                puts "Finished building permutation with #{i} choices." if verbose
+            end
 
-        puts "Finished permutations." if verbose
-        puts "Number of permutations generated: #{permutations.size}" if verbose
+            puts "Finished permutations." if verbose
+            puts "Number of permutations generated: #{permutations.size}" if verbose
 
-        permutations
-    end
+            permutations
+        end
 
+    end
 end
 
 #test things out

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brutalitops
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - andydwyer
@@ -10,8 +10,8 @@ bindir: bin
 cert_chain: []
 date: 2020-06-04 00:00:00.000000000 Z
 dependencies: []
-description: "Generates permutations and returns an array, or prints to csv, or prints
-  to console. See https://github.com/andydwyer/brutalitops for usage.\n\n"
+description: Generates permutations and returns an array, or prints to csv, or prints
+  to console. See https://github.com/andydwyer/brutalitops for usage.
 email: ktanyag@gmail.com
 executables:
 - brutalitops