syc-spector 0.0.1 → 0.0.2

data/README

@@ -1,17 +1,54 @@
-# The sycspector scans a file for patterns provided on the command line.
-# Lines that match the pattern are saved to a valid file and those lines that
-# don't match the pattern are added to an invalid file.
-# The valid and invalid files as well as the used pattern are stored in a
-# history file. The saved values are used for a subsequent call to sycspector
-# with --show and -f for fix.
-#
-# Invokation Examples
-#   sycspector mail_addresses -p email
-# searches for email addresses in the provided file 'email_addresses'
-#
-# Lines that are not recognized can be prompted, fixed and appended to the
-# valid file with
-#   sycspector -fa
-#
-# To show the result of the invokation use
-#   sycspector --show
+= Welcome to syc-spector
+ home :: https://github.com/sugaryourcoffee/syc-spector
+
+== Description
+The sycspector scans a file for patterns provided on the command line.
+Lines that match the pattern are saved to a file with valid values and those lines that don't match the pattern are added to a file with invalid values.
+The valid and invalid files as well as the used pattern are stored in a
+history file. The saved values are used for a subsequent call to sycspector
+with --show and -f for fix to show the results or to prompt the invalid values to fix them. Fixed values can appended to the valid values file.
+
+== Installation
+sycspector can be installed as a gem from [RubyGems](http://RubyGems.org) with
+  $ gem install syc-spector
+
+== Invokation Examples
+Rearches for email addresses in the provided file 'email_addresses'
+  $ sycspector email_addresses -p email
+
+Lines that are not recognized can be prompted, fixed and appended to the
+valid file with
+  $ sycspector -fa
+
+To show the result of the invokation use
+  $ sycspector --show
+
+To fix the values from the input file at the first scan
+  $ sycspector -f email-addresses -p email
+
+To sort the values
+  $ sycspector -s email-addresses -p email
+
+To fix, sort and remove duplicates (individualize)
+  $ sycspector -fsi email-addresses -p email
+
+Matching patterns like 'name, firstname'
+  $ syscpector name -p "\w+, \w+"
+
+Scanning only whole lines use
+  $ sycspector name -p "\A\w+, \w+\A"
+
+If the file contains lines like "Doe, John and Doe, Jane" these won't be saved at the first scan but can be scanned with the --fix switch and appended to the valid values from the last run
+  $ sycspector -fa
+
+Fixing a specific file by specifying the invalid file as inputfile
+  $ sycspector -fa 2013016-083346_invalid_name -o 2013016-083346_valid_name
+
+Specifying the file where the results (valid and invalid) should go to
+  $ sycspector -fa -o outputfile
+
+To process all at once
+  $ sycspector -fis inputfile -o outputfile -p "\A\w+, w+\Z" --show
+
+== License
+syc-spector is released under the {MIT License}[http://www.opensource.org/license/MIT].

data/README.rdoc

@@ -0,0 +1,54 @@
+= Welcome to syc-spector
+ home :: https://github.com/sugaryourcoffee/syc-spector
+
+== Description
+The sycspector scans a file for patterns provided on the command line.
+Lines that match the pattern are saved to a file with valid values and those lines that don't match the pattern are added to a file with invalid values.
+The valid and invalid files as well as the used pattern are stored in a
+history file. The saved values are used for a subsequent call to sycspector
+with --show and -f for fix to show the results or to prompt the invalid values to fix them. Fixed values can appended to the valid values file.
+
+== Installation
+sycspector can be installed as a gem from [RubyGems](http://RubyGems.org) with
+  $ gem install syc-spector
+
+== Invokation Examples
+Rearches for email addresses in the provided file 'email_addresses'
+  $ sycspector email_addresses -p email
+
+Lines that are not recognized can be prompted, fixed and appended to the
+valid file with
+  $ sycspector -fa
+
+To show the result of the invokation use
+  $ sycspector --show
+
+To fix the values from the input file at the first scan
+  $ sycspector -f email-addresses -p email
+
+To sort the values
+  $ sycspector -s email-addresses -p email
+
+To fix, sort and remove duplicates (individualize)
+  $ sycspector -fsi email-addresses -p email
+
+Matching patterns like 'name, firstname'
+  $ syscpector name -p "\w+, \w+"
+
+Scanning only whole lines use
+  $ sycspector name -p "\A\w+, \w+\A"
+
+If the file contains lines like "Doe, John and Doe, Jane" these won't be saved at the first scan but can be scanned with the --fix switch and appended to the valid values from the last run
+  $ sycspector -fa
+
+Fixing a specific file by specifying the invalid file as inputfile
+  $ sycspector -fa 2013016-083346_invalid_name -o 2013016-083346_valid_name
+
+Specifying the file where the results (valid and invalid) should go to
+  $ sycspector -fa -o outputfile
+
+To process all at once
+  $ sycspector -fis inputfile -o outputfile -p "\A\w+, w+\Z" --show
+
+== License
+syc-spector is released under the {MIT License}[http://www.opensource.org/license/MIT].

data/doc/README.html

@@ -85,6 +85,12 @@
 
 <div id="documentation" class="description">
   
+<h1 id="label-syc-spector+-+Dokumentation">syc-spector - Dokumentation</h1>
+
+<pre>home :: https://github.com/sugaryourcoffee/syc-spector</pre>
+
+<h2 id="label-Description">Description</h2>
+
 <p>The sycspector scans a file for patterns provided on the command line.
 Lines that match the pattern are saved to a valid file and those lines that
 don’t match the pattern are added to an invalid file. The valid and invalid
@@ -92,20 +98,58 @@ files as well as the used pattern are stored in a history file. The saved
 values are used for a subsequent call to sycspector with –show and -f for
 fix.</p>
 
-<p>Invokation Examples</p>
+<h2 id="label-Invokation+Examples">Invokation Examples</h2>
 
-<pre>sycspector mail_addresses -p email</pre>
+<p>Rearches for email addresses in the provided file ‘email_addresses’</p>
 
-<p>searches for email addresses in the provided file ‘email_addresses’</p>
+<pre>$ sycspector email_addresses -p email</pre>
 
 <p>Lines that are not recognized can be prompted, fixed and appended to the
 valid file with</p>
 
-<pre>sycspector -fa</pre>
+<pre>$ sycspector -fa</pre>
 
 <p>To show the result of the invokation use</p>
 
-<pre>sycspector --show</pre>
+<pre>$ sycspector --show</pre>
+
+<p>To fix the values from the input file at the first scan</p>
+
+<pre>$ sycspector -f email-addresses -p email</pre>
+
+<p>To sort the values</p>
+
+<pre>$ sycspector -s email-addresses -p email</pre>
+
+<p>To fix, sort and remove duplicates (individualize)</p>
+
+<pre>$ sycspector -fsi email-addresses -p email</pre>
+
+<p>Matching patterns like ‘name, firstname’</p>
+
+<pre>$ syscpector name -p &quot;\w+, \w+&quot;</pre>
+
+<p>Scanning only whole lines use</p>
+
+<pre>$ sycspector name -p &quot;\A\w+, \w+\A&quot;</pre>
+
+<p>If the file contains lines like “Doe, John and Doe, Jane” these won’t be
+saved at the first scan but can be scanned with the –fix switch and
+appended to the valid values from the last run</p>
+
+<pre>$ sycspector -fa</pre>
+
+<p>Fixing a specific file by specifying the invalid file as inputfile</p>
+
+<pre>$ sycspector -fa 2013016-083346_invalid_name -o 2013016-083346_valid_name</pre>
+
+<p>Specifying the file where the results (valid and invalid) should go to</p>
+
+<pre>$ sycspector -fa -o outputfile</pre>
+
+<p>To process all at once</p>
+
+<pre>$ sycspector -fis inputfile -o outputfile -p &quot;\A\w+, w+\Z&quot; --show</pre>
 
 </div>
 

data/doc/created.rid

@@ -1,4 +1,4 @@
-Tue, 15 Jan 2013 23:07:10 +0100
+Wed, 16 Jan 2013 08:34:21 +0100
 ./test/test_options.rb	Tue, 15 Jan 2013 23:04:15 +0100
 ./test/test_separator.rb	Tue, 15 Jan 2013 23:02:11 +0100
 ./test/test_console.rb	Tue, 15 Jan 2013 22:59:35 +0100
@@ -8,4 +8,4 @@ Tue, 15 Jan 2013 23:07:10 +0100
 ./lib/inspector/console.rb	Tue, 15 Jan 2013 22:54:55 +0100
 ./lib/inspector/runner.rb	Tue, 15 Jan 2013 22:56:24 +0100
 ./bin/sycspector	Tue, 15 Jan 2013 22:57:52 +0100
-./README	Tue, 15 Jan 2013 22:46:24 +0100
+./README	Wed, 16 Jan 2013 08:34:09 +0100

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["inspector","console","options","runner","separator","object","testconsole","testoptions","testseparator","char_if_pressed()","fix()","get_file_from_history()","initialize_infile()","initialize_options()","new()","new()","new()","print_statistics()","process()","prompt()","run()","save_result_files()","setup()","setup()","teardown()","readme"],"longSearchIndex":["inspector","inspector::console","inspector::options","inspector::runner","inspector::separator","object","testconsole","testoptions","testseparator","inspector::console#char_if_pressed()","inspector::separator#fix()","inspector::options#get_file_from_history()","testseparator#initialize_infile()","testseparator#initialize_options()","inspector::options::new()","inspector::runner::new()","inspector::separator::new()","inspector::separator#print_statistics()","inspector::separator#process()","inspector::console#prompt()","inspector::runner#run()","inspector::options#save_result_files()","testoptions#setup()","testseparator#setup()","testoptions#teardown()",""],"info":[["Inspector","","Inspector.html","","<p>This module encapsulates functionality related to scanning values for\npatterns. If a line contains the …\n"],["Inspector::Console","","Inspector/Console.html","","<p>Console provides functions for user input\n"],["Inspector::Options","","Inspector/Options.html","","<p>Parses the provided command line flags, switches and arguments\n"],["Inspector::Runner","","Inspector/Runner.html","","<p>Processes based on the provided command line arguments the scan of the file\nor shows the last processed …\n"],["Inspector::Separator","","Inspector/Separator.html","","<p>The Separator scans the input file for a provided pattern and prints the\nresults of the scan to the console. …\n"],["Object","","Object.html","",""],["TestConsole","","TestConsole.html","","<p>Tests the Console class\n"],["TestOptions","","TestOptions.html","","<p>Test of the Options class\n"],["TestSeparator","","TestSeparator.html","","<p>Tests the Separator class\n"],["char_if_pressed","Inspector::Console","Inspector/Console.html#method-i-char_if_pressed","()","<p>Listens for key presses and returns the pressed key without pressing return\n"],["fix","Inspector::Separator","Inspector/Separator.html#method-i-fix","(value, pattern)","<p>Prompts the PROMPT_STRING and tests the value against the pattern\n<p>Return a hash with :value and :answer …\n"],["get_file_from_history","Inspector::Options","Inspector/Options.html#method-i-get_file_from_history","(type)","<p>After running the application output files are saved in the history.\n–get_file_from_history– retrieves …\n"],["initialize_infile","TestSeparator","TestSeparator.html#method-i-initialize_infile","(values = [], separator)","<p>Initilize the infile with provided values and separating the values with\nthe provided separator\n"],["initialize_options","TestSeparator","TestSeparator.html#method-i-initialize_options","(opts={})","<p>Overrides some of the standard @optinons initialized in setup\n"],["new","Inspector::Options","Inspector/Options.html#method-c-new","(argv)","<p>Initializes Options and parses the provided user input from the command\nline\n"],["new","Inspector::Runner","Inspector/Runner.html#method-c-new","(argv)","<p>Initializes runner and invokes Options with the command line arguments\nprovided\n"],["new","Inspector::Separator","Inspector/Separator.html#method-c-new","()","<p>Initializes the Separator and creating a Console object\n"],["print_statistics","Inspector::Separator","Inspector/Separator.html#method-i-print_statistics","(opts)","<p>Prints the results of the invokation of Separator.process\n"],["process","Inspector::Separator","Inspector/Separator.html#method-i-process","(opts)","<p>Processes the scan of the lines of the file and add the values eather to\nthe valid or invalid values. …\n"],["prompt","Inspector::Console","Inspector/Console.html#method-i-prompt","(choice_line)","<p>Prompts the user for input.\n<p>choice_line is the prompt string. If the prompt string contains a (x)\nsequence …\n"],["run","Inspector::Runner","Inspector/Runner.html#method-i-run","()","<p>Runs the Separator or shows the requested valid or invalid file. To show\nthe file ‘less’ is used.\n"],["save_result_files","Inspector::Options","Inspector/Options.html#method-i-save_result_files","(opts)","<p>Save the results of the last run of the application to\n<code>.sycspector.data</code>. It contains the valid and invalid …\n"],["setup","TestOptions","TestOptions.html#method-i-setup","()","<p>Intializes the input, valid, invalid and history file\n"],["setup","TestSeparator","TestSeparator.html#method-i-setup","()","<p>Initialize the @options\n"],["teardown","TestOptions","TestOptions.html#method-i-teardown","()","<p>Cleans up the test directory by deleting the files created in setup\n"],["README","","README.html","","<p>The sycspector scans a file for patterns provided on the command line.\nLines that match the pattern are …\n"]]}}
+var search_data = {"index":{"searchIndex":["inspector","console","options","runner","separator","object","testconsole","testoptions","testseparator","char_if_pressed()","fix()","get_file_from_history()","initialize_infile()","initialize_options()","new()","new()","new()","print_statistics()","process()","prompt()","run()","save_result_files()","setup()","setup()","teardown()","readme"],"longSearchIndex":["inspector","inspector::console","inspector::options","inspector::runner","inspector::separator","object","testconsole","testoptions","testseparator","inspector::console#char_if_pressed()","inspector::separator#fix()","inspector::options#get_file_from_history()","testseparator#initialize_infile()","testseparator#initialize_options()","inspector::options::new()","inspector::runner::new()","inspector::separator::new()","inspector::separator#print_statistics()","inspector::separator#process()","inspector::console#prompt()","inspector::runner#run()","inspector::options#save_result_files()","testoptions#setup()","testseparator#setup()","testoptions#teardown()",""],"info":[["Inspector","","Inspector.html","","<p>This module encapsulates functionality related to scanning values for\npatterns. If a line contains the …\n"],["Inspector::Console","","Inspector/Console.html","","<p>Console provides functions for user input\n"],["Inspector::Options","","Inspector/Options.html","","<p>Parses the provided command line flags, switches and arguments\n"],["Inspector::Runner","","Inspector/Runner.html","","<p>Processes based on the provided command line arguments the scan of the file\nor shows the last processed …\n"],["Inspector::Separator","","Inspector/Separator.html","","<p>The Separator scans the input file for a provided pattern and prints the\nresults of the scan to the console. …\n"],["Object","","Object.html","",""],["TestConsole","","TestConsole.html","","<p>Tests the Console class\n"],["TestOptions","","TestOptions.html","","<p>Test of the Options class\n"],["TestSeparator","","TestSeparator.html","","<p>Tests the Separator class\n"],["char_if_pressed","Inspector::Console","Inspector/Console.html#method-i-char_if_pressed","()","<p>Listens for key presses and returns the pressed key without pressing return\n"],["fix","Inspector::Separator","Inspector/Separator.html#method-i-fix","(value, pattern)","<p>Prompts the PROMPT_STRING and tests the value against the pattern\n<p>Return a hash with :value and :answer …\n"],["get_file_from_history","Inspector::Options","Inspector/Options.html#method-i-get_file_from_history","(type)","<p>After running the application output files are saved in the history.\n–get_file_from_history– retrieves …\n"],["initialize_infile","TestSeparator","TestSeparator.html#method-i-initialize_infile","(values = [], separator)","<p>Initilize the infile with provided values and separating the values with\nthe provided separator\n"],["initialize_options","TestSeparator","TestSeparator.html#method-i-initialize_options","(opts={})","<p>Overrides some of the standard @optinons initialized in setup\n"],["new","Inspector::Options","Inspector/Options.html#method-c-new","(argv)","<p>Initializes Options and parses the provided user input from the command\nline\n"],["new","Inspector::Runner","Inspector/Runner.html#method-c-new","(argv)","<p>Initializes runner and invokes Options with the command line arguments\nprovided\n"],["new","Inspector::Separator","Inspector/Separator.html#method-c-new","()","<p>Initializes the Separator and creating a Console object\n"],["print_statistics","Inspector::Separator","Inspector/Separator.html#method-i-print_statistics","(opts)","<p>Prints the results of the invokation of Separator.process\n"],["process","Inspector::Separator","Inspector/Separator.html#method-i-process","(opts)","<p>Processes the scan of the lines of the file and add the values eather to\nthe valid or invalid values. …\n"],["prompt","Inspector::Console","Inspector/Console.html#method-i-prompt","(choice_line)","<p>Prompts the user for input.\n<p>choice_line is the prompt string. If the prompt string contains a (x)\nsequence …\n"],["run","Inspector::Runner","Inspector/Runner.html#method-i-run","()","<p>Runs the Separator or shows the requested valid or invalid file. To show\nthe file ‘less’ is used.\n"],["save_result_files","Inspector::Options","Inspector/Options.html#method-i-save_result_files","(opts)","<p>Save the results of the last run of the application to\n<code>.sycspector.data</code>. It contains the valid and invalid …\n"],["setup","TestOptions","TestOptions.html#method-i-setup","()","<p>Intializes the input, valid, invalid and history file\n"],["setup","TestSeparator","TestSeparator.html#method-i-setup","()","<p>Initialize the @options\n"],["teardown","TestOptions","TestOptions.html#method-i-teardown","()","<p>Cleans up the test directory by deleting the files created in setup\n"],["README","","README.html","","<p>syc-spector - Dokumentation\n\n<pre>home :: https://github.com/sugaryourcoffee/syc-spector</pre>\n<p>Description\n"]]}}

data/doc/table_of_contents.html

@@ -27,6 +27,13 @@
 <ul>
   <li class="file">
     <a href="README.html">README</a>
+
+    <img class="toc-toggle" src="images/transparent.png" alt="" title="toggle headings">
+    <ul class="initially-hidden">
+      <li><a href="README.html#label-syc-spector+-+Dokumentation">syc-spector - Dokumentation</a>
+      <li><a href="README.html#label-Description">Description</a>
+      <li><a href="README.html#label-Invokation+Examples">Invokation Examples</a>
+    </ul>
   </li>
   
 </ul>

data/sycspector.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
      Allow to sort, remove double and manually fix values."
   s.description  = File.read(File.join(File.dirname(__FILE__), 'README'))
   s.requirements = ['No requirements']
-  s.version      = "0.0.1"
+  s.version      = "0.0.2"
   s.author       = "Pierre Sugar"
   s.email        = "pierre@sugaryourcoffee.de"
   s.homepage     = "http://syc.dyndns.org/drupal"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syc-spector
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,50 +9,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-01-16 00:00:00.000000000 Z
 dependencies: []
-description: ! '# The sycspector scans a file for patterns provided on the command
-  line.
-
-  # Lines that match the pattern are saved to a valid file and those lines that
-
-  # don''t match the pattern are added to an invalid file.
-
-  # The valid and invalid files as well as the used pattern are stored in a
-
-  # history file. The saved values are used for a subsequent call to sycspector
-
-  # with --show and -f for fix.
-
-  #
-
-  # Invokation Examples
-
-  #   sycspector mail_addresses -p email
-
-  # searches for email addresses in the provided file ''email_addresses''
-
-  #
-
-  # Lines that are not recognized can be prompted, fixed and appended to the
-
-  # valid file with
-
-  #   sycspector -fa
-
-  #
-
-  # To show the result of the invokation use
-
-  #   sycspector --show
-
-'
+description: ! "= Welcome to syc-spector\n home :: https://github.com/sugaryourcoffee/syc-spector\n\n==
+  Description\nThe sycspector scans a file for patterns provided on the command line.\nLines
+  that match the pattern are saved to a file with valid values and those lines that
+  don't match the pattern are added to a file with invalid values.\nThe valid and
+  invalid files as well as the used pattern are stored in a\nhistory file. The saved
+  values are used for a subsequent call to sycspector\nwith --show and -f for fix
+  to show the results or to prompt the invalid values to fix them. Fixed values can
+  appended to the valid values file.\n\n== Installation\nsycspector can be installed
+  as a gem from [RubyGems](http://RubyGems.org) with\n  $ gem install syc-spector\n\n==
+  Invokation Examples\nRearches for email addresses in the provided file 'email_addresses'\n
+  \ $ sycspector email_addresses -p email\n\nLines that are not recognized can be
+  prompted, fixed and appended to the\nvalid file with\n  $ sycspector -fa\n\nTo show
+  the result of the invokation use\n  $ sycspector --show\n\nTo fix the values from
+  the input file at the first scan\n  $ sycspector -f email-addresses -p email\n\nTo
+  sort the values\n  $ sycspector -s email-addresses -p email\n\nTo fix, sort and
+  remove duplicates (individualize)\n  $ sycspector -fsi email-addresses -p email\n\nMatching
+  patterns like 'name, firstname'\n  $ syscpector name -p \"\\w+, \\w+\"\n\nScanning
+  only whole lines use\n  $ sycspector name -p \"\\A\\w+, \\w+\\A\"\n\nIf the file
+  contains lines like \"Doe, John and Doe, Jane\" these won't be saved at the first
+  scan but can be scanned with the --fix switch and appended to the valid values from
+  the last run\n  $ sycspector -fa\n\nFixing a specific file by specifying the invalid
+  file as inputfile\n  $ sycspector -fa 2013016-083346_invalid_name -o 2013016-083346_valid_name\n\nSpecifying
+  the file where the results (valid and invalid) should go to\n  $ sycspector -fa
+  -o outputfile\n\nTo process all at once\n  $ sycspector -fis inputfile -o outputfile
+  -p \"\\A\\w+, w+\\Z\" --show\n\n== License\nsyc-spector is released under the {MIT
+  License}[http://www.opensource.org/license/MIT].\n"
 email: pierre@sugaryourcoffee.de
 executables:
 - sycspector
 extensions: []
 extra_rdoc_files: []
 files:
+- syc-spector-0.0.1.gem
+- README.rdoc
 - test/test_options.rb
 - test/test_separator.rb
 - test/test_console.rb