csv_filter 0.3.0 → 0.4.0

data/README.rdoc

@@ -2,6 +2,24 @@
 
 Filters CSV or TSV files (default) by column names.
 
+== CLI Usage
+
+csv_filter comes with a command line utility conveniently called csv_filter. To use it:
+`csv_filter path_to_file`
+
+When prompted, enter the names of the columns (fields) you'd like to limit your results to.
+
+Example:
+
+<pre>
+csv_filter spec/sample.tsv
+available fields are: ["value", "type", "url", "format"]
+enter field names to filter
+type format
+0.    URL	RAW	
+1.    URL	RAW
+</pre>
+
 == Contributing to csv_filter
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/csv_filter.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "csv_filter"
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kris Luminar"]
-  s.date = "2012-12-11"
+  s.date = "2012-12-12"
   s.description = "Filters CSV or TSV files (default) by column names"
   s.email = "kris.luminar@gmail.com"
   s.executables = ["csv_filter"]

data/lib/csv_filter.rb

@@ -10,6 +10,8 @@ class CsvFilter
     grab_header
   end
 
+  # grab the first row of the inputed csv file
+  #
   def grab_header
     return @header if (@header and !@header.empty?)
     @file.rewind
@@ -19,15 +21,22 @@ class CsvFilter
     @header
   end
 
+  # the positions of all the columns that the user wants filtered on
+  #
   def filtered_column_positions columns
     columns = columns.flatten
     @filtered_column_positions ||= register.select {|field, pos| columns.include? field }.values
   end
 
+  # map column names to their relative positions (numbers)
+  #
   def register
     grab_header.invert
   end
 
+  # selects just the desired columns from a CSV file
+  #
+  # @param columns list of columns to filter on
   def filter(*columns)
     # columns = [*columns].flatten #columns should accept either an array of strings or a variable number of strings
     raise ArgumentError unless (columns.respond_to?(:size) and columns.size < @num_columns)
@@ -46,6 +55,9 @@ class CsvFilter
     output
   end
 
+  # CLI interface for filter
+  #
+  # (see #filter)
   def print_filter(columns)
     lines = filter(columns)
     output = []
@@ -59,10 +71,15 @@ class CsvFilter
     puts output.join("\n")
   end
 
+  # count num of columns
+  # already deprecated, always a bad sign
+  #
   def count_columns
     fields.size
   end
 
+  # list the fields from the header rown in the input file
+  #
   def fields
     return @fields if @fields
     @file.rewind

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_filter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000 Z
+date: 2012-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -132,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4030006348523475583
+      hash: 384472246441890925
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: