mop 0.0.5 → 0.0.6

data/.gemspec

@@ -2,38 +2,45 @@
 $:.unshift './lib'
 require 'mop/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "mop"
-  gem.version       = Mop::VERSION
-  gem.authors       = %w(☈king)
-  gem.email         = %w(mop-gem@sharpsaw.org)
-  gem.summary       = %q{Make OK for Public: Clean up sensitive info from a file before jisting}
-  gem.description   = <<-EOT
-== A simplistic pre-filter (not (yet) a substitute for manual examination).
+# TODO:
+# require 'working/gemspec'
+# main_blurb = Working.readme 'README.rdoc', /^== Usage/, /^== Works/
+main_blurb = %q{
+== Usage
+
+ mop < /var/log/nginx/error_log > cleaned_file
+ vim cleaned_file
+ # ☝ check for anything it might've missed
+ jist -co cleaned_file
+ # ☝ upload, copy its URL to clipboard, open in browser
 
-Usage
------
+== Note
 
-    mop < /var/log/nginx/error_log > cleaned_file
-    vim cleaned_file # check for anything it might've missed
-    jist -co cleaned_file # upload, copy its URL to clipboard, open in browser
+This thing is really in its beginning phases. It currently:
 
-Note
-----
+* Deletes too much
+* Leaves too much
 
-This thing is really in its beginning phases. It currently deletes too much and
-also leaves too much.
+However, all Issues will be addressed.  Just file 'em at:
+https://github.com/rking/mop/issues
+}
 
-However, all Issues will be addressed. Just file 'em here: https://github.com/exad/mop/issues
-  EOT
+Gem::Specification.new do |gem|
+  gem.name          = "mop"
+  gem.version       = Mop::VERSION
+  gem.authors       = %w(☈king)
+  gem.email         = %w(mop-gem@sharpsaw.org)
+  # TODO: gem.summary = Working.readme_third_line
+  gem.summary       = 'Make OK for Public.  A simplistic pre-filter (not (yet|ever) a substitute for manual examination).'
+  # TODO:
+  gem.post_install_message = "= mop\n\n" + gem.summary + "\n" + main_blurb
+  gem.description   = gem.summary + "\n" + main_blurb
   gem.homepage      = 'https://github.com/exad/mop'
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{|f| File.basename f}
   gem.test_files    = gem.files.grep %r{^ test|spec|features/}
   gem.require_paths = ['lib']
 
-  %w(
-    jist
-  ).each do |dep| gem.add_dependency dep end
+  gem.add_dependency 'jist'
   gem.add_development_dependency 'working'
 end

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mop (0.0.4)
+    mop (0.0.6)
       jist
 
 GEM

data/Guardfile

@@ -1,4 +1,4 @@
 require 'working/guard'
 guard :sporkminitest do
-  watch 'test/cases.yml' do 'test/mop_test.rb' end
+  watch %r(test/cases.yml|README.rdoc.erb) do 'test/mop_test.rb' end
 end

data/README.rdoc

@@ -0,0 +1,100 @@
+= mop
+
+Make OK for Public.  A simplistic pre-filter (not (yet|ever) a substitute for
+manual examination).
+
+== Usage
+
+ mop < /var/log/nginx/error_log > cleaned_file
+ vim cleaned_file
+ # ☝ check for anything it might've missed
+ jist -co cleaned_file
+ # ☝ upload, copy its URL to clipboard, open in browser
+
+== Note
+
+This thing is really in its beginning phases. It currently:
+
+* Deletes too much
+* Leaves too much
+
+However, all Issues will be addressed.  Just file 'em at:
+https://github.com/rking/mop/issues
+
+== Currently Works With
+
+- Passwords
+  - <tt>"password: secr3t"</tt> ⇒ <tt>"password: hiddenpass"</tt>
+  - <tt>"password:   secr3t"</tt> ⇒ <tt>"password:   hiddenpass"</tt>
+  - <tt>"password:\n\tsecr3t"</tt> ⇒ <tt>"password:\n\thiddenpass"</tt>
+  - <tt>"password: 'secr3t'"</tt> ⇒ <tt>"password: hiddenpass"</tt>
+  - <tt>"password:secr3t"</tt> ⇒ <tt>"password:hiddenpass"</tt>
+  - <tt>"passwd:secr3t"</tt> ⇒ <tt>"passwd:hiddenpass"</tt>
+  - <tt>"passwd: secr3t"</tt> ⇒ <tt>"passwd: hiddenpass"</tt>
+  - <tt>"password=secr3t"</tt> ⇒ <tt>"password=hiddenpass"</tt>
+  - <tt>"passwd=secr3t"</tt> ⇒ <tt>"passwd=hiddenpass"</tt>
+  - <tt>"password=\"secr3t\""</tt> ⇒ <tt>"password=hiddenpass"</tt>
+  - <tt>"buzbuz password: secr3t bizbiz"</tt> ⇒ <tt>"buzbuz password: hiddenpass bizbiz"</tt>
+  - <tt>"buzbuz password: secr3t bizbiz another password: secr4t bazbaz"</tt> ⇒ <tt>"buzbuz password: hiddenpass bizbiz another password: hiddenpass bazbaz"</tt>
+  - <tt>"USER: user55 PASS: secr3t"</tt> ⇒ <tt>"USER: hiddenuser PASS: hiddenpass"</tt>
+  - <tt>"U/N: user55 P/W: secr3t"</tt> ⇒ <tt>"U/N: hiddenuser P/W: hiddenpass"</tt>
+  - <tt>"U: user55 P: secr3t"</tt> ⇒ <tt>"U: hiddenuser P: hiddenpass"</tt>
+  - <tt>"U=user55 P=secr3t"</tt> ⇒ <tt>"U=hiddenuser P=hiddenpass"</tt>
+  - <tt>"u=user55 p=secr3t"</tt> ⇒ <tt>"u=hiddenuser p=hiddenpass"</tt>
+  - <tt>"u: user55 p: secr3t"</tt> ⇒ <tt>"u: hiddenuser p: hiddenpass"</tt>
+  - <tt>"L=user55 P=secr3t"</tt> ⇒ <tt>"L=hiddenuser P=hiddenpass"</tt>
+- Users
+  - <tt>"user: user55"</tt> ⇒ <tt>"user: hiddenuser"</tt>
+  - <tt>"User=user55"</tt> ⇒ <tt>"User=hiddenuser"</tt>
+  - <tt>"/Users/user55"</tt> ⇒ <tt>"hiddenuser"</tt>
+  - <tt>"/home/user55"</tt> ⇒ <tt>"hiddenuser"</tt>
+- IPv4 Addresses
+  - <tt>"1.2.3.4"</tt> ⇒ <tt>"XX.YY.ZZ.AA"</tt>
+  - <tt>"asdf 1.2.3.4 asdf"</tt> ⇒ <tt>"asdf XX.YY.ZZ.AA asdf"</tt>
+  - <tt>"1.2.3.4:22"</tt> ⇒ <tt>"XX.YY.ZZ.AA:22"</tt>
+  - <tt>"123.45.67.89"</tt> ⇒ <tt>"XX.YY.ZZ.AA"</tt>
+  - <tt>"0.0.0.0"</tt> _unchanged_
+  - <tt>"127.0.0.1"</tt> _unchanged_
+- IPv6 Addresses (probably many patterns TODO on this one)
+  - <tt>"21:43:6f:1a:f6:f6"</tt> ⇒ <tt>"aa:bb:cc:dd:ee:ff"</tt>
+- Capistrano's `deploy.rb`
+  - <tt>"host_name: 'shouldhide'"</tt> ⇒ <tt>"host_name: caphidden"</tt>
+  - <tt>"host_name: \"shouldhide\""</tt> ⇒ <tt>"host_name: caphidden"</tt>
+  - <tt>":host_name => 'shouldhide'"</tt> ⇒ <tt>":host_name => caphidden"</tt>
+  - <tt>":host_name, 'shouldhide'"</tt> ⇒ <tt>":host_name, caphidden"</tt>
+  - <tt>":port => 'shouldhide'"</tt> ⇒ <tt>":port => caphidden"</tt>
+  - <tt>"deploy_to, 'shouldhide'"</tt> ⇒ <tt>"deploy_to, caphidden"</tt>
+  - <tt>"server 'shouldhide', …"</tt> ⇒ <tt>"server capserver …"</tt>
+  - <tt>"set :application, \"shouldhide\""</tt> ⇒ <tt>"set :application, caphidden"</tt>
+  - <tt>"set :user, \"shouldhide\""</tt> ⇒ <tt>"set :user, hiddenuser"</tt>
+  - <tt>"server without comma"</tt> _unchanged_
+  - <tt>"portage"</tt> _unchanged_
+- /etc/passwd having "fakeuser" and "fakeuser2"
+  - <tt>"foo bar fakeuser baz"</tt> ⇒ <tt>"foo bar hiddenuser baz"</tt>
+  - <tt>"~/fakeuser"</tt> ⇒ <tt>"~/hiddenuser"</tt>
+  - <tt>"/home/fakeuser/.foo"</tt> ⇒ <tt>"hiddenuser"</tt>
+  - <tt>"fakeuser2"</tt> ⇒ <tt>"hiddenuser"</tt>
+  - <tt>"cron"</tt> _unchanged_
+  - <tt>"root"</tt> _unchanged_
+- hostname being 'gargantatron'
+  - <tt>"gargantatron"</tt> ⇒ <tt>"hiddenhost"</tt>
+- Git repos
+  - <tt>"git@github.com/username/reponame.git"</tt> ⇒ <tt>"git@github.com/hiddenrepo"</tt>
+  - <tt>"git@github.com/username/reponame"</tt> ⇒ <tt>"git@github.com/hiddenrepo"</tt>
+  - <tt>"git@github.com:username/reponame"</tt> ⇒ <tt>"git@github.com:hiddenrepo"</tt>
+  - <tt>"https://github.com/username/reponame"</tt> ⇒ <tt>"https://github.com/hiddenrepo"</tt>
+  - <tt>"http://github.com/username/reponame"</tt> ⇒ <tt>"http://github.com/hiddenrepo"</tt>
+  - <tt>"git://github.com/username/reponame"</tt> ⇒ <tt>"git://github.com/hiddenrepo"</tt>
+  - <tt>"http://someotherhost.net/reponame.git"</tt> ⇒ <tt>"http://hiddenrepo"</tt>
+- SSH
+  - <tt>"ssh://user55@secrethost/path/to/reponame.git/"</tt> ⇒ <tt>"ssh://hiddensshurl"</tt>
+
+
+== TODO
+
+- Add -j for ConradIrwin's <tt>jist</tt> gem (after an editor preview, of course)
+- Make distinct (similar to an uglifier's symbol replacement)
+  - first.host.name ⇒ hiddenhostname1
+  - second.host.name ⇒ hiddenhostname2
+- Learn more about IPv6 Addresses
+- Dorky ISP-given hostnames that show IP addresses

data/README.rdoc.erb

@@ -0,0 +1,35 @@
+= mop
+
+Make OK for Public.  A simplistic pre-filter (not (yet|ever) a substitute for
+manual examination).
+
+== Usage
+
+ mop < /var/log/nginx/error_log > cleaned_file
+ vim cleaned_file
+ # ☝ check for anything it might've missed
+ jist -co cleaned_file
+ # ☝ upload, copy its URL to clipboard, open in browser
+
+== Note
+
+This thing is really in its beginning phases. It currently:
+
+* Deletes too much
+* Leaves too much
+
+However, all Issues will be addressed.  Just file 'em at:
+https://github.com/rking/mop/issues
+
+== Currently Works With
+
+<%= actual_results %>
+
+== TODO
+
+- Add -j for ConradIrwin's <tt>jist</tt> gem (after an editor preview, of course)
+- Make distinct (similar to an uglifier's symbol replacement)
+  - first.host.name ⇒ hiddenhostname1
+  - second.host.name ⇒ hiddenhostname2
+- Learn more about IPv6 Addresses
+- Dorky ISP-given hostnames that show IP addresses

data/lib/mop/version.rb

@@ -1,3 +1,3 @@
 class Mop
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/test/mop_test.rb

@@ -13,8 +13,8 @@ class MopTest < MiniTest::Unit::TestCase
   end
 
   def write_readme actual_results
-    template = ERB.new File.read('README.md.erb')
-    File.write 'README.md', template.result(binding)
+    template = ERB.new File.read('README.rdoc.erb')
+    File.write 'README.rdoc', template.result(binding)
   end
 
   def test_in_a_big_loop
@@ -25,7 +25,7 @@ class MopTest < MiniTest::Unit::TestCase
         if intention.has_key? 'passthru'
           intention['passthru'].each do |already_clean|
             assert_equal Mop.wipe(already_clean), already_clean
-            doc.puts "  - `#{already_clean.inspect}` _(unchanged)_"
+            doc.puts "  - <tt>#{already_clean.inspect}</tt> _unchanged_"
           end
         elsif intention.has_key? 'filter' and intention.has_key? 'from'
           illicit = [intention['filter']].flatten
@@ -36,9 +36,8 @@ class MopTest < MiniTest::Unit::TestCase
               refute clean.include?(e),
                 "#{name} — should wipe #{illicit} from #{dirty}"
             end
-            doc.puts "  - `#{dirty.inspect}` ⇒ `#{clean.inspect}`"
-          end
-        else
+            doc.puts "  - <tt>#{dirty.inspect}</tt> ⇒ <tt>#{clean.inspect}</tt>"
+          end else
           fail "Unknown test case structure: #{intention.to_yaml}"
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mop
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -43,12 +43,12 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "== A simplistic pre-filter (not (yet) a substitute for manual examination).\n\nUsage\n-----\n\n
-  \   mop < /var/log/nginx/error_log > cleaned_file\n    vim cleaned_file # check
-  for anything it might've missed\n    jist -co cleaned_file # upload, copy its URL
-  to clipboard, open in browser\n\nNote\n----\n\nThis thing is really in its beginning
-  phases. It currently deletes too much and\nalso leaves too much.\n\nHowever, all
-  Issues will be addressed. Just file 'em here: https://github.com/exad/mop/issues\n"
+description: ! "Make OK for Public.  A simplistic pre-filter (not (yet|ever) a substitute
+  for manual examination).\n\n== Usage\n\n mop < /var/log/nginx/error_log > cleaned_file\n
+  vim cleaned_file\n # ☝ check for anything it might've missed\n jist -co cleaned_file\n
+  # ☝ upload, copy its URL to clipboard, open in browser\n\n== Note\n\nThis thing
+  is really in its beginning phases. It currently:\n\n* Deletes too much\n* Leaves
+  too much\n\nHowever, all Issues will be addressed.  Just file 'em at:\nhttps://github.com/rking/mop/issues\n"
 email:
 - mop-gem@sharpsaw.org
 executables:
@@ -57,12 +57,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gemspec
+- .gitignore
 - .rspec
 - Gemfile
 - Gemfile.lock
 - Guardfile
-- README.md
-- README.md.erb
+- README.rdoc
+- README.rdoc.erb
 - Rakefile
 - acceptance-test
 - bin/mop
@@ -73,12 +74,19 @@ files:
 - pkg/mop-0.0.2.gem
 - pkg/mop-0.0.3.gem
 - pkg/mop-0.0.4.gem
+- pkg/mop-0.0.5.gem
 - test/cases.yml
 - test/mop_test.rb
 - test/test_helper.rb
 homepage: https://github.com/exad/mop
 licenses: []
-post_install_message: 
+post_install_message: ! "= mop\n\nMake OK for Public.  A simplistic pre-filter (not
+  (yet|ever) a substitute for manual examination).\n\n== Usage\n\n mop < /var/log/nginx/error_log
+  > cleaned_file\n vim cleaned_file\n # ☝ check for anything it might've missed\n
+  jist -co cleaned_file\n # ☝ upload, copy its URL to clipboard, open in browser\n\n==
+  Note\n\nThis thing is really in its beginning phases. It currently:\n\n* Deletes
+  too much\n* Leaves too much\n\nHowever, all Issues will be addressed.  Just file
+  'em at:\nhttps://github.com/rking/mop/issues\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -99,7 +107,8 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ! 'Make OK for Public: Clean up sensitive info from a file before jisting'
+summary: Make OK for Public.  A simplistic pre-filter (not (yet|ever) a substitute
+  for manual examination).
 test_files:
 - .gemspec
 - .rspec

data/README.md

@@ -1,103 +0,0 @@
-mop
-===
-
-Make OK for Public.  A simplistic pre-filter (not (yet) a substitute for manual
-examination).
-
-Usage
------
-
-    mop < /var/log/nginx/error_log > cleaned_file
-    vim cleaned_file # check for anything it might've missed
-    jist -co cleaned_file # upload, copy its URL to clipboard, open in browser
-
-Note
-----
-
-This thing is really in its beginning phases. It currently:
-
-* Deletes too much
-* Leaves too much
-
-However, all [Issues](https://github.com/rking/mop/issues) will be addressed.
-Just file 'em.'
-
-Currently Works With
---------------------
-
-- Passwords
-  - `"password: secr3t"` ⇒ `"password: hiddenpass"`
-  - `"password:   secr3t"` ⇒ `"password:   hiddenpass"`
-  - `"password:\n\tsecr3t"` ⇒ `"password:\n\thiddenpass"`
-  - `"password: 'secr3t'"` ⇒ `"password: hiddenpass"`
-  - `"password:secr3t"` ⇒ `"password:hiddenpass"`
-  - `"passwd:secr3t"` ⇒ `"passwd:hiddenpass"`
-  - `"passwd: secr3t"` ⇒ `"passwd: hiddenpass"`
-  - `"password=secr3t"` ⇒ `"password=hiddenpass"`
-  - `"passwd=secr3t"` ⇒ `"passwd=hiddenpass"`
-  - `"password=\"secr3t\""` ⇒ `"password=hiddenpass"`
-  - `"buzbuz password: secr3t bizbiz"` ⇒ `"buzbuz password: hiddenpass bizbiz"`
-  - `"buzbuz password: secr3t bizbiz another password: secr4t bazbaz"` ⇒ `"buzbuz password: hiddenpass bizbiz another password: hiddenpass bazbaz"`
-  - `"USER: user55 PASS: secr3t"` ⇒ `"USER: hiddenuser PASS: hiddenpass"`
-  - `"U/N: user55 P/W: secr3t"` ⇒ `"U/N: hiddenuser P/W: hiddenpass"`
-  - `"U: user55 P: secr3t"` ⇒ `"U: hiddenuser P: hiddenpass"`
-  - `"U=user55 P=secr3t"` ⇒ `"U=hiddenuser P=hiddenpass"`
-  - `"u=user55 p=secr3t"` ⇒ `"u=hiddenuser p=hiddenpass"`
-  - `"u: user55 p: secr3t"` ⇒ `"u: hiddenuser p: hiddenpass"`
-  - `"L=user55 P=secr3t"` ⇒ `"L=hiddenuser P=hiddenpass"`
-- Users
-  - `"user: user55"` ⇒ `"user: hiddenuser"`
-  - `"User=user55"` ⇒ `"User=hiddenuser"`
-  - `"/Users/user55"` ⇒ `"hiddenuser"`
-  - `"/home/user55"` ⇒ `"hiddenuser"`
-- IPv4 Addresses
-  - `"1.2.3.4"` ⇒ `"XX.YY.ZZ.AA"`
-  - `"asdf 1.2.3.4 asdf"` ⇒ `"asdf XX.YY.ZZ.AA asdf"`
-  - `"1.2.3.4:22"` ⇒ `"XX.YY.ZZ.AA:22"`
-  - `"123.45.67.89"` ⇒ `"XX.YY.ZZ.AA"`
-  - `"0.0.0.0"` _(unchanged)_
-  - `"127.0.0.1"` _(unchanged)_
-- IPv6 Addresses (probably many patterns TODO on this one)
-  - `"21:43:6f:1a:f6:f6"` ⇒ `"aa:bb:cc:dd:ee:ff"`
-- Capistrano's `deploy.rb`
-  - `"host_name: 'shouldhide'"` ⇒ `"host_name: caphidden"`
-  - `"host_name: \"shouldhide\""` ⇒ `"host_name: caphidden"`
-  - `":host_name => 'shouldhide'"` ⇒ `":host_name => caphidden"`
-  - `":host_name, 'shouldhide'"` ⇒ `":host_name, caphidden"`
-  - `":port => 'shouldhide'"` ⇒ `":port => caphidden"`
-  - `"deploy_to, 'shouldhide'"` ⇒ `"deploy_to, caphidden"`
-  - `"server 'shouldhide', …"` ⇒ `"server capserver …"`
-  - `"set :application, \"shouldhide\""` ⇒ `"set :application, caphidden"`
-  - `"set :user, \"shouldhide\""` ⇒ `"set :user, hiddenuser"`
-  - `"server without comma"` _(unchanged)_
-  - `"portage"` _(unchanged)_
-- /etc/passwd having "fakeuser" and "fakeuser2"
-  - `"foo bar fakeuser baz"` ⇒ `"foo bar hiddenuser baz"`
-  - `"~/fakeuser"` ⇒ `"~/hiddenuser"`
-  - `"/home/fakeuser/.foo"` ⇒ `"hiddenuser"`
-  - `"fakeuser2"` ⇒ `"hiddenuser"`
-  - `"cron"` _(unchanged)_
-  - `"root"` _(unchanged)_
-- hostname being 'gargantatron'
-  - `"gargantatron"` ⇒ `"hiddenhost"`
-- Git repos
-  - `"git@github.com/username/reponame.git"` ⇒ `"git@github.com/hiddenrepo"`
-  - `"git@github.com/username/reponame"` ⇒ `"git@github.com/hiddenrepo"`
-  - `"git@github.com:username/reponame"` ⇒ `"git@github.com:hiddenrepo"`
-  - `"https://github.com/username/reponame"` ⇒ `"https://github.com/hiddenrepo"`
-  - `"http://github.com/username/reponame"` ⇒ `"http://github.com/hiddenrepo"`
-  - `"git://github.com/username/reponame"` ⇒ `"git://github.com/hiddenrepo"`
-  - `"http://someotherhost.net/reponame.git"` ⇒ `"http://hiddenrepo"`
-- SSH
-  - `"ssh://user55@secrethost/path/to/reponame.git/"` ⇒ `"ssh://hiddensshurl"`
-
-
-TODO
-----
-
-- Add -j for ConradIrwin's `jist` gem
-- Make distinct (similar to an uglifier's symbol replacement)
-  - first.host.name ⇒ hiddenhostname1
-  - second.host.name ⇒ hiddenhostname2
-- Learn more about IPv6 Addresses
-- Dorky ISP-given hostnames that show IP addresses

data/README.md.erb

@@ -1,38 +0,0 @@
-mop
-===
-
-Make OK for Public.  A simplistic pre-filter (not (yet) a substitute for manual
-examination).
-
-Usage
------
-
-    mop < /var/log/nginx/error_log > cleaned_file
-    vim cleaned_file # check for anything it might've missed
-    jist -co cleaned_file # upload, copy its URL to clipboard, open in browser
-
-Note
-----
-
-This thing is really in its beginning phases. It currently:
-
-* Deletes too much
-* Leaves too much
-
-However, all [Issues](https://github.com/rking/mop/issues) will be addressed.
-Just file 'em.'
-
-Currently Works With
---------------------
-
-<%= actual_results %>
-
-TODO
-----
-
-- Add -j for ConradIrwin's `jist` gem
-- Make distinct (similar to an uglifier's symbol replacement)
-  - first.host.name ⇒ hiddenhostname1
-  - second.host.name ⇒ hiddenhostname2
-- Learn more about IPv6 Addresses
-- Dorky ISP-given hostnames that show IP addresses