mundane 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20449c7c8e3ff9ad2aeec4956726476ba8b07b06
-  data.tar.gz: 501721ae5254cb5f8a9e76245aa64c222b7c5b87
+  metadata.gz: 14540f02f5fe1ea047a6a7e68af94bcfa44b50b1
+  data.tar.gz: c975d603d3883f09b65940d4be8b6708be0d3792
 SHA512:
-  metadata.gz: 58e185cd77bb6b55ece2ad35f0e865a11b02fc3c6c00f2299f72c452d133ee1c5b0644d2d80edc136cf0b3eb64ad4d36412bf750150a3846cca98c262535b70d
-  data.tar.gz: a44b72ae6c9ff63edb8155f7916e0bd193596a4319bb9d06f59b401a3fd91b4fda38579b1d6dfdef2f52fe8669d291391293bdb1e1f760c29a25e5cb5aa9625d
+  metadata.gz: 3aa7a0b89dcfcee21523679d04d423a3fb3614e96d0408bc1875f8e8f904c58d349d787a123ba4314c5c3dc92e0a54585e8a3b1bc5248b144ce10a4ba4f3b120
+  data.tar.gz: 51f314566f12ba45d249769d81e9c2f2ce91ddedd59400d062aaae6dc9aae40a7dbf69ef5f220c92c136b335e2a77f29957ee85cd499b251638f0fb5b23ee3ed

data/README

@@ -1,15 +1,17 @@
-Oh, why, hello there.  I'm Notary Sojac, and you are inspecting one of my scripts which was designed to take all the files in the current working folder, and put them into \out.  The catch?  Oh yes, the catch is that they will become .zip files meaning that you will need to decrypt them before reading/seeing/interacting with them.  There are no free lunches.  
+Oh, why, hello there.  I'm Notary Sojac, and you are inspecting one of my scripts which was originally designed to take all the files in the current working folder, and put them into \out.  The catch?  Oh yes, the catch is that they will become .zip files meaning that you will need to decrypt them before reading/seeing/interacting with them.  There are no free lunches.  But this algo is helpful for getting NES rom files into a proper format for consumption by NestopiaX. 
+
+There will be more mundane algorithms added, such as right now, an algo to unzip a bunch of zip files and dump their contents into out/ (so a mass unzipping algo).  
 
 To make it do:
 
-1)  Have ruby installed on your machine
+1)  Have ruby installed on your machine.
 
-2)  do $  gem install rubyzip  to install the dependancy
+2)  do `$  gem install mundane` to install the gem. 
 
-3)  Copy my snazzy script files_to_zips.rb into the folder you have laying around which contains the files you would like individually zipped.
+3)  Change directory into the folder you'd like to conduct a mundane task in.  
 
-4)  Run my script in that directory ($  ruby files_to_zips.rb)
+4)  Run the gem, specifying which mundane task you'd like performed, eg `$  mundane files2zips`
 
-5)  Investigate the "out" directory which was created throughout this process.  
+5)  Investigate the "out" directory which was created when you ran the command.  
 
-6)  Profit
+6)  Profit.

data/bin/mundane

@@ -4,19 +4,24 @@ require 'thor'
 require 'mundane'
 
 class MundaneRunner < Thor
-  
-  #default_task :help
-  
-  desc "files2zips", "reads each file in the directory and zips it, placing it in a new folder named 'out'."
-  def files2zips
-    Mundane.files_to_zips
-  end
 
   desc "version", "Prints Mundane's version"
   def version
     puts Mundane.version
   end
 
+  desc "files2zips", "reads each file in the directory and zips it, placing it in a new folder named 'out'.\n
+                      This will not include directorys, it will only work on files."
+  def files2zips
+    Mundane.files_to_zips
+  end
+  
+  desc "zips2files", "Reads each zip file in the current directory and extracts its contents to a folder named 'out'.\n
+                                  "
+  def zips2files
+    Mundane.zips_to_files
+  end
+
 end
 
 MundaneRunner.start

data/lib/mundane.rb

@@ -2,18 +2,25 @@ require 'pry'
 require 'zip'
 
 require 'mundane/version'
-require 'mundane/files_to_zips'
+require 'mundane/file_worker'
+require 'mundane/prompter'
+require 'mundane/algos/files_to_zips'
+require 'mundane/algos/zips_to_files'
+
 
 
 module Mundane
   
   def self.files_to_zips
     FilesToZips.execute
-    #puts "this here is a stub"
+  end
+  
+  def self.zips_to_files
+    ZipsToFiles.execute
   end
 
   def self.version
-    puts Mundane::VERSION
+    Mundane::VERSION
   end
 
 end

data/lib/mundane/algos/files_to_zips.rb

@@ -0,0 +1,37 @@
+module Mundane
+  class FilesToZips
+    extend Mundane::FileWorker
+    extend Mundane::Prompter
+    
+    def self.execute
+      user_wants_to_proceed = prompt_user("Are you sure you want to make %count_targeted_files% zipped files and put them into ./out/ ?\n[Y/n]")
+
+      if user_wants_to_proceed
+        make_output_directory
+        files = get_files_in_current_folder
+        compress_files_and_write_to_out_as_zips(files)
+      end
+      
+    end
+  
+  
+    def self.compress_files_and_write_to_out_as_zips(files)
+      files.each do |f|
+        pretty_name = f.chomp(File.extname(f))
+        
+        if File.exists?("out/#{pretty_name}.zip")
+          puts "out/#{pretty_name}.zip  ALREADY EXISTED, SKIPPING FILE.  DELETE MANUALLY IF NEEDED =/"
+          next
+        end
+        
+        Zip::File.open("out/#{pretty_name}.zip", Zip::File::CREATE) do |zipfile|
+          zipfile.add(f, f)
+        end
+        
+      end
+    end
+   
+  end
+end
+
+

data/lib/mundane/algos/zips_to_files.rb

@@ -0,0 +1,41 @@
+module Mundane
+  class ZipsToFiles
+    extend Mundane::FileWorker
+    extend Mundane::Prompter
+    
+    def self.execute
+      user_wants_to_proceed = prompt_user("Are you sure you want to unzip %count_targeted_files% zip files and dump their contents into ./out/ ?\n[Y/n]")
+
+      if user_wants_to_proceed
+        make_output_directory
+        files = get_files_in_current_folder
+        decompress_files_and_dump_them_to_out(files)
+      end
+      
+    end
+    
+    def self.decompress_files_and_dump_them_to_out(files)
+      incomplete_extractions = 0
+      
+      # decompress each file in the list
+      files.each do |zip|
+                                             # TODO:  next if zip.extension != 'zip'
+        Zip::File.open(zip) do |archive|
+          archive.each do |f|
+            output_path = "out/#{f.name}"
+            if File.exists? output_path          # don't auto-overwrite anything...
+              puts "#{output_path} ALREADY EXISTED, SKIPPING FILE.  DELETE MANUALLY IF NEEDED =/"
+              incomplete_extractions += 1
+              next
+            end
+            f.extract output_path
+          end
+        end
+
+      end
+      
+      puts "\nOperation terminated, there were #{incomplete_extractions} incomplete extractions." if incomplete_extractions > 0
+    end
+    
+  end
+end

data/lib/mundane/file_worker.rb

@@ -0,0 +1,22 @@
+module Mundane
+  module FileWorker
+    
+    def make_output_directory
+      Dir.mkdir("out") unless Dir.exists?("out")
+    end
+    
+    def get_files_in_current_folder
+      files = []
+      Dir.foreach(".") do |f|
+        next if File.directory?(f) # or f == __FILE__       # skip directory names and the script we're running...
+        files << f
+      end
+      return files
+    end
+    
+    def count_targeted_files
+      get_files_in_current_folder.count
+    end
+    
+  end
+end

data/lib/mundane/prompter.rb

@@ -0,0 +1,22 @@
+module Mundane
+  module Prompter
+    extend Mundane::FileWorker
+    
+    def prompt_user(prompt)
+      puts construct_informative_message(prompt)
+      proceed = STDIN.gets.strip.downcase
+  
+      if proceed == "y" or proceed == "yes" or proceed == ""
+        true 
+      else
+        false
+      end
+    end
+    
+    def construct_informative_message(prompt)
+      prompt.sub("%count_targeted_files%", count_targeted_files.to_s)
+    end
+    
+    extend self  # allows for unit testing...
+  end
+end

data/lib/mundane/version.rb

@@ -1,3 +1,3 @@
 module Mundane
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

data/spec/hack_working_directory.rb

@@ -0,0 +1,12 @@
+require 'fileutils'
+include FileUtils
+
+# We need to change our working directory to a virtual directory so we don't risk 
+# making a ton of files in ./out that will annoy testers... but we need to trigger
+# this faked working directory only AFTER all the other requires are made in testing files
+rm_rf fake_working_directory if File.exists? fake_working_directory
+mkdir_p fake_working_directory
+cd fake_working_directory
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'fileutils'
+include FileUtils
+
+def fake_working_directory
+  "/tmp/mundane-virtual-working-directory"
+end
+
+def fake_out_directory
+  fake_working_directory + "/out"
+end
+
+def clean_dummy_working_directory
+  rm_rf(Dir.glob("/tmp/mundane-virtual-working-directory/*"))
+end
+
+def drop_dummy_files_in_working_directory
+  touch "/tmp/mundane-virtual-working-directory/a"
+  touch "/tmp/mundane-virtual-working-directory/b"
+  touch "/tmp/mundane-virtual-working-directory/c"
+end
+
+def drop_dummy_zip_file
+  # This string was coppied from a hex editor (bless) on linux
+  byte_array_of_zip_file = "50 4B 03 04 0A 03 00 00 00 00 9A 85 4C 43 05 40 6D 5B 08 00 00 00 08 00 00 00 01 00 00 00 61 68 65 6C 6C 6F 20 61 0A 50 4B 03 04 0A 03 00 00 00 00 B8 85 4C 43 C6 13 40 70 08 00 00 00 08 00 00 00 01 00 00 00 62 68 65 6C 6C 6F 20 62 0A 50 4B 01 02 3F 03 0A 03 00 00 00 00 9A 85 4C 43 05 40 6D 5B 08 00 00 00 08 00 00 00 01 00 00 00 00 00 00 00 00 00 20 80 A4 81 00 00 00 00 61 50 4B 01 02 3F 03 0A 03 00 00 00 00 B8 85 4C 43 C6 13 40 70 08 00 00 00 08 00 00 00 01 00 00 00 00 00 00 00 00 00 20 80 A4 81 27 00 00 00 62 50 4B 05 06 00 00 00 00 02 00 02 00 5E 00 00 00 4E 00 00 00 00 00"
+  bin_format = byte_array_of_zip_file.split.map {|s| s.to_i(16).chr}
+  File.binwrite("mine_embedded.zip", bin_format.join)
+end
+
+def count_of_files_in(directory_path)
+  Dir.glob(File.join(directory_path, '**', '*')).select { |file| File.file?(file) }.count
+end

data/spec/unit/mundane_spec.rb

@@ -1,11 +1,65 @@
 require './spec/spec_helper'
-
 require './lib/mundane'
 
-describe "get testing" do
+require './spec/hack_working_directory'   # this require must come LAST or reletive requires will fail hard... oh wait... if there are more test files... everything foobars...
 
-	it 'should test' do
-    Mundane.files_to_zips
-	end
+describe "test the algos" do
 
-end
+  describe "test files_to_zips algo" do
+    
+    before :each do
+      Mundane::FilesToZips.stub(:prompt_user).and_return(true)
+      
+      clean_dummy_working_directory
+    end
+    
+    after :each do
+      Mundane::FilesToZips.unstub(:prompt_user)
+    end
+    
+    it 'should make 3 files in the out folder' do
+      drop_dummy_files_in_working_directory
+      
+      Mundane.files_to_zips
+      count_of_files_in(fake_out_directory).should be 3
+    end
+    
+    
+  end
+  
+  describe "test zips_to_files algo" do
+    before :each do
+      Mundane::ZipsToFiles.stub(:prompt_user).and_return(true)
+      
+      clean_dummy_working_directory
+    end
+    
+    after :each do
+      Mundane::ZipsToFiles.unstub(:prompt_user)
+    end
+    
+    it 'should make 2 files in the out folder' do
+      drop_dummy_zip_file
+      
+      Mundane.zips_to_files
+      count_of_files_in(fake_out_directory).should be 2
+    end
+    
+  end
+  
+  
+  describe "prompter unit test..." do
+    before :each do
+      clean_dummy_working_directory
+    end
+    
+    it 'should have a pleasant prompt message' do
+      drop_dummy_files_in_working_directory
+      
+      prompt = "hello %count_targeted_files% bye"
+      Mundane::Prompter.construct_informative_message(prompt).should eq "hello 3 bye"
+    end
+  end
+  
+  
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: mundane
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
-- ''
+- n-jax
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -107,7 +107,11 @@ files:
 - bin/mundane
 - lib/mundane.rb
 - lib/mundane/version.rb
-- lib/mundane/files_to_zips.rb
+- lib/mundane/file_worker.rb
+- lib/mundane/prompter.rb
+- lib/mundane/algos/zips_to_files.rb
+- lib/mundane/algos/files_to_zips.rb
+- spec/hack_working_directory.rb
 - spec/unit/mundane_spec.rb
 - spec/spec_helper.rb
 - README

data/lib/mundane/files_to_zips.rb

@@ -1,65 +0,0 @@
-module Mundane
-  class FilesToZips
-    
-    def self.execute
-      binding.pry
-      user_wants_to_proceed = ask_user_if_theyd_like_to_make_zips
-
-      if user_wants_to_proceed
-        make_output_directory
-  
-        files = get_files_in_current_folder
-  
-        compress_files_and_write_to_out_as_zips(files)
-      end
-      
-    end
-  
-    def self.compress_files_and_write_to_out_as_zips(files)
-      files.each do
-        |f|
-        pretty_name = f.chomp(File.extname(f))
-        if File.exists?("out/#{pretty_name}.zip")
-          puts "out/#{pretty_name}.zip  ALREADY EXISTED, SKIPPING FILE.  DELETE MANUALLY IF PREFERED =/"
-          next
-        end
-        Zip::File.open("out/#{pretty_name}.zip", Zip::File::CREATE) {
-          |zipfile|
-          zipfile.add(f, f)
-        }
-      end
-    end
-
-    def self.get_files_in_current_folder
-      files = []
-      Dir.foreach(".") do
-        |f|
-        next if File.directory?(f) or f == __FILE__       # skip directory names and the script we're running...
-        files << f
-      end
-      return files
-    end
-
-    def self.make_output_directory
-      Dir.mkdir("out") unless Dir.exists?("out")
-    end
-
-    def self.ask_user_if_theyd_like_to_make_zips
-      puts "Are you sure you want to make X zip files and put them into ./out/ ?"
-      puts "[Y/n]"
-      proceed = STDIN.gets.strip.downcase
-  
-      if proceed == "y" or proceed == "yes" or proceed == ""
-        proceed = true 
-      else
-        proceed = false
-      end
-      return proceed
-    end
-    
-    
-    
-  end
-end
-
-