csv_madness 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f4f9b06af750b458f7eb43b10053dfce2b60a69cc55ea4410d4466c72680f0c
-  data.tar.gz: 23ddbf472f0b52973769e21eb72939622bee0e5b13e43e8c292ae28203106145
+  metadata.gz: 63380347571236804849e35c32c5463efc6e71151e992a3e3f18f8d2673fc110
+  data.tar.gz: 8c58382266af7f1091a80dc89eb6900a4efb8a5f956fe5801aa77ea5d5e4f05f
 SHA512:
-  metadata.gz: 1e44f1666c4118cf68a16f254ea5ad8808f9a0036b346755d187c74baf24a65cff718323d81741cd5478b036fcea3518daa3b2b5f72f6de2bf89b3b435392de8
-  data.tar.gz: b44d0fa470ec59317f5a93b0e73d1ec6a032f300083734e2b0aef27b2077b51303dce1b504e77102e6cfb5f79cc2c229d136d4a5d7eca049402bb88e740e711a
+  metadata.gz: 3b8ca366e680bf629fbb081145a8b254e5a121102b0772a40095893e06bc1f46f1f081c64cfa60efb1cbe69e633685c65b406795601c237157a8af63a5ce4d3c
+  data.tar.gz: 298b6b68d6bed7254ae7177b6fd24f8bfccb765435df5fbd5e9bfabb618db3bf386c276c741ca5fbab2bd9d8168c011010579ccca3bbfe7af0a19a2cffe163ad

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/CHANGELOG.markdown

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+0.0.10
+------
+
+
 0.0.6
 -----
 

data/Gemfile

@@ -7,13 +7,8 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 
 group :development do
-  # gem "shoulda", ">= 3.5"
-  # gem "rdoc", "~> 3.12"
-  # gem "bundler", "~> 1.5"
-  # gem "jeweler", "~> 2"
   gem "fun_with_testing"
-  # gem "debugger"
 end
 
-gem "csv"
-gem 'fun_with_gems', '~> 0.0', ">= 0.0.7"
+gem 'fun_with_gems', '~> 0.0', ">= 0.0.6"
+gem 'csv'     # removed from core

data/Rakefile

@@ -1,89 +1,23 @@
 # encoding: utf-8
 require 'fun_with_gems'
 require_relative File.join( "lib", "csv_madness" )
-self.extend( FunWith::Gems::Rakefile)
 
+self.extend( FunWith::Gems::Rakefile )
 rakefile_setup CsvMadness
 
 gem_specification do |gem|
-    # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-    # dependencies defined in Gemfile
-      gem.name = "csv_madness"
-      gem.homepage = "http://github.com/darthschmoo/csv_madness"
-      gem.license = "MIT"
-      gem.summary = "CSV Madness turns your CSV rows into happycrazy objects."
-      gem.description = "CSV Madness removes what little pain is left from Ruby's CSV class.  Load a CSV file, and get back an array of objects with customizable getter/setter methods."
-      gem.email = "keeputahweird@gmail.com"
-      gem.authors = ["Bryce Anderson"]
+# gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+# dependencies defined in Gemfile
+  gem.name = "csv_madness"
+  gem.homepage = "http://github.com/darthschmoo/csv_madness"
+  gem.license = "MIT"
+  gem.summary = "CSV Madness turns your CSV rows into happycrazy objects."
+  gem.description = "CSV Madness removes what little pain is left from Ruby's CSV class.  Load a CSV file, and get back an array of objects with customizable getter/setter methods."
+  gem.email = "keeputahweird@gmail.com"
+  gem.authors = ["Bryce Anderson"]
 
-      # dependencies defined in Gemfile
-      gem.files = Dir.glob( File.join( ".", "lib", "**", "*.rb" ) ) +
-                  Dir.glob( File.join( ".", "test", "**", "*" ) ) +
-                  %w( Gemfile Rakefile LICENSE.txt README.rdoc VERSION CHANGELOG.markdown ) 
-                  # csv_madness.gemspec )
+  # dependencies defined in Gemfile
+  add_specification_files( gem, :default )
 end
 
 setup_gem_boilerplate
-
-#
-#
-# require 'rubygems'
-# require 'bundler'
-#
-# begin
-#   Bundler.setup(:default, :development)
-# rescue Bundler::BundlerError => e
-#   $stderr.puts e.message
-#   $stderr.puts "Run `bundle install` to install missing gems"
-#   exit e.status_code
-# end
-#
-# require 'rake'
-#
-# require 'jeweler'
-#
-# Jeweler::Tasks.new do |gem|
-#   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-#   gem.name = "csv_madness"
-#   gem.homepage = "http://github.com/darthschmoo/csv_madness"
-#   gem.license = "MIT"
-#   gem.summary = "CSV Madness turns your CSV rows into happycrazy objects."
-#   gem.description = "CSV Madness removes what little pain is left from Ruby's CSV class.  Load a CSV file, and get back an array of objects with customizable getter/setter methods."
-#   gem.email = "keeputahweird@gmail.com"
-#   gem.authors = ["Bryce Anderson"]
-#
-#   # dependencies defined in Gemfile
-#   gem.files = Dir.glob( File.join( ".", "lib", "**", "*.rb" ) ) +
-#               Dir.glob( File.join( ".", "test", "**", "*" ) ) +
-#               %w( Gemfile Rakefile LICENSE.txt README.rdoc VERSION CHANGELOG.markdown csv_madness.gemspec )
-#
-# end
-#
-# Jeweler::RubygemsDotOrgTasks.new
-#
-# require 'rake/testtask'
-# Rake::TestTask.new(:test) do |test|
-#   test.libs << 'lib' << 'test'
-#   test.pattern = 'test/**/test_*.rb'
-#   test.verbose = true
-# end
-#
-# # require 'rcov/rcovtask'
-# # Rcov::RcovTask.new do |test|
-# #   test.libs << 'test'
-# #   test.pattern = 'test/**/test_*.rb'
-# #   test.verbose = true
-# #   test.rcov_opts << '--exclude "gems/*"'
-# # end
-#
-# task :default => :test
-#
-# require 'rdoc/task'
-# Rake::RDocTask.new do |rdoc|
-#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
-#
-#   rdoc.rdoc_dir = 'rdoc'
-#   rdoc.title = "csv_madness #{version}"
-#   rdoc.rdoc_files.include('README*')
-#   rdoc.rdoc_files.include('lib/**/*.rb')
-# end

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.0.10

data/lib/csv_madness/builder.rb

@@ -5,12 +5,14 @@ module CsvMadness
     def initialize( &block )
       @columns = {}
       @column_syms = []
+      @column_counters  = {}
 
       @module = Module.new   # for extending
       self.extend( @module )
       yield self if block_given?
     end
 
+
     def column( sym, method_path = nil, &block )
       warn( "#{sym} already defined. Overwriting." ) if @column_syms.include?( sym )
       
@@ -23,6 +25,24 @@ module CsvMadness
                         Proc.new(&sym)
                       end
     end
+    
+    def column_names
+      @column_syms
+    end
+    
+    def constant_column( sym, const )
+      cproc = Utils::ConstProc.proc_for( const )
+      column( sym, &cproc )
+    end
+    
+    def blank_column( sym )
+      constant_column( sym, nil )
+    end
+    
+    def counter_column( sym, initial_value = 0 )
+      column( sym, &Utils::CounterProc.counter( initial_value ) )
+    end
+      
 
     # Three :on_error values:
     #    :print  => Put an error message in the cell instead of a value
@@ -30,23 +50,34 @@ module CsvMadness
     #    :ignore => Hand back an empty cell
     # 
     # Although ideally it should be configurable by column...   
-    def build( objects, opts = { :on_error => :print } )
+    def build( objects, opts = {} )
+      @progress_mode = choose_progress_mode( opts[:progress] )
+      debugger unless defined?( @show_progress )
+      
+      @on_error      = opts.fetch(:on_error){ :print }
+      @verbose       = opts.fetch(:verbose){ false }
+      
       spreadsheet = CsvMadness::Sheet.new( @column_syms )
+      
+      @objects = objects
+      @objects = @objects.records if @objects.is_a?( CsvMadness::Sheet )
 
-      for object in objects
-        STDOUT << "."
+      for object in @objects
         record = {}
         for sym in @column_syms
           record[sym] = build_cell( object, sym, opts )
         end
-
+        
         spreadsheet.add_record( record )  # hash form
+        show_progress
       end
+      
+      _reset_counter_columns
 
       spreadsheet
     end
 
-    def build_cell( object, sym, opts = { :on_error => :print } )
+    def build_cell( object, sym, opts = {} )
       column = @columns[sym]
 
       case column
@@ -55,10 +86,12 @@ module CsvMadness
       when Proc
         build_cell_by_proc( object, column, opts )
       else
-        "no idea what to do"
+        debugger
+        "no idea what to do with #{column.inspect} (#{column.class})"
       end
     end
 
+    # ?????
     def def( method_name, &block )
       @module.send( :define_method, method_name, &block )
     end
@@ -66,7 +99,7 @@ module CsvMadness
     protected
     def build_cell_by_pathstring( object, str, opts )
       handle_cell_build_error( :build_cell_by_pathstring, opts ) do
-        for method in str.split(".").map(&:to_sym)
+        for method in str.split(".")
           object = object.send(method)
         end
 
@@ -85,9 +118,9 @@ module CsvMadness
         yield
       end
     rescue Exception => e
-      case opts[:on_error]
+      case @on_error
       when nil, :print
-        puts "error #{e.message} #{caller}" if opts[:verbose]
+        puts "error #{e.message} #{caller}" if @verbose
         "ERROR: #{e.message} (#{caller}())"
       when :raise
         puts "Re-raisinge error #{e.message}.  Set opts[:on_error] to :print or :ignore if you want Builder to continue on errors."
@@ -96,5 +129,54 @@ module CsvMadness
         ""
       end
     end
+    
+    def _reset_counter_columns
+      for sym, column in @columns
+        column.reset if column.is_a?( Utils::CounterProc )
+      end
+    end
+    
+    # 
+    def choose_progress_mode( m )
+      case m
+      when true
+        @show_progress = true
+        @progress_mode = progress_bar_available? ? :tty : :stdout
+      when false, nil
+        @show_progress = false
+        @progress_mode = :none
+      when Symbol
+        @show_progress = (m == :none) ? false : true
+        @progress_mode = m
+      else
+        warn "unknown progress mode #{m.inspect}"
+        choose_progress_mode( false )
+      end
+    end
+    
+    def show_progress
+      if @show_progress
+        @progress_mode ||= progress_bar_available? ? :tty : :stdout
+        
+        case @progress_mode
+        when :tty
+          @tty_progress_bar ||= TTY::ProgressBar.new( "Building spreadsheet :current/:total (:percent) [:bar]", total: @objects.length )
+          @tty_progress_bar.advance(1)
+        when :stdout
+          STDOUT << "."
+        when :counter
+          unless defined?( @tty_progress_count )
+            puts ""
+            @tty_progress_count = 1
+          end
+          
+          print "\r#{@tty_progress_count}/#{@objects.length} records written                    "
+        end
+      end
+    end
+    
+    def progress_bar_available?
+      defined?(TTY) && defined?(TTY::ProgressBar)
+    end
   end
 end

data/lib/csv_madness/column.rb

@@ -0,0 +1,30 @@
+module CsvMadness
+  class Column
+    include ColumnMethods::CoreMethods
+    include ColumnMethods::FetchMethods
+    include ColumnMethods::TypingMethods
+    include ColumnMethods::ErrorMethods
+    include ColumnMethods::DefaultValueMethods
+    
+    attr_accessor :spreadsheet,
+                  :index,
+                  :name,
+                  :type_conversion
+    
+    
+    def initialize( _sheet, _name, _index, _type )
+      self.name    = convert_column_name( nm )
+      self.index   = index
+      self.aliases = @opts[:aliases]
+      self.set_type( opts[:type] )
+    end
+    
+    def get_cell( record )
+      record.data[self.index]
+    end
+    
+    def set_cell( record, value )
+      record.data[self.index] = self.type_convert( value )
+    end
+  end
+end

data/lib/csv_madness/column_methods/core_methods.rb

@@ -0,0 +1,6 @@
+module CsvMadness
+  module ColumnMethods
+    module CoreMethods
+    end
+  end
+end

data/lib/csv_madness/column_methods/default_value_methods.rb

@@ -0,0 +1,7 @@
+module CsvMadness
+  module ColumnMethods
+    module DefaultValueMethods
+      attr_accessor :default_value
+    end
+  end
+end

data/lib/csv_madness/column_methods/error_methods.rb

@@ -0,0 +1,19 @@
+module CsvMadness
+  module ColumnMethods
+    module ErrorMethods
+      # When a conversion fails, what happens?
+      # 
+      # debug   : enters debugger (test mode)
+      # ignore  : no message is given and the default value is returned ("" for string, 0 for integer, 0.0 for float)?
+      # stdout  : message printed to stdout
+      # stderr  : message printed to stderr
+      # cell    : message appears in the cell
+      attr_accessor :warning_style
+      
+      
+      attr_accessor :error_message
+      
+      
+    end
+  end
+end

data/lib/csv_madness/column_methods/fetch_methods.rb

@@ -0,0 +1,11 @@
+module CsvMadness
+  module ColumnMethods
+    module FetchMethods
+      def contents
+        self.spreadsheet.records.map do |record|
+          self.get_cell( record )
+        end 
+      end
+    end
+  end
+end

data/lib/csv_madness/column_methods/typing_methods.rb

@@ -0,0 +1,24 @@
+module CsvMadness
+  module ColumnMethods
+    module TypingMethods
+      def type_convert( value )
+        if self.type_conversion
+          self.type_conversion.call( value )
+        else
+          value
+        end
+      end
+
+      def set_type( type )
+        self.type_conversion = TypeConversion[@opts[:type]]
+        self.convert_column_to_type
+      end
+
+      def convert_column_to_type
+        for record in self.spreadsheet.records
+          set_cell( record, get_cell( record ) )
+        end
+      end
+    end
+  end
+end

data/lib/csv_madness/column_set.rb

@@ -0,0 +1,5 @@
+module CsvMadness
+  class ColumnSet < Array
+    
+  end
+end

data/lib/csv_madness/column_type.rb

@@ -0,0 +1,74 @@
+module CsvMadness
+  class ColumnType
+    COLUMN_TYPE_LOOKUP = {
+      :integer => ColumnTypes::IntegerType,
+      :date    => ColumnTypes::DateType,
+      :string  => ColumnTypes::StringType,
+      # :number  => ColumnTypes::NumberType,
+      :float   => ColumnTypes::FloatType
+    }
+    
+    DEFAULT_ERROR_MESSAGES = {
+      
+    }
+    
+    
+    # What is returned when a conversion fails?
+    #
+    # :default : the type conversion returns
+    # :blank   : the cell becomes a nil
+    # :stderr  : send warning message to stderr and return a nil
+    # :stdout  : send warning message to stdout and return a nil
+    # :sheet   : write the warning message into the sheet itself
+    attr_accessor :conversion_error_value
+    
+    
+    def self.[]( t )
+      COLUMN_TYPE_LOOKUP[t]
+    end
+    
+    def initialize( opts = {} )
+      
+    end
+    
+    # default_hierarchy
+    
+    
+    
+    def standard_opts( overrides )
+      
+      
+    end
+    
+    
+    def conversion_error_message( input )
+      
+    end
+    
+    def handle_conversion_errors( input, &block )
+      begin
+        yield if block_given?
+      rescue ArgumentError
+        
+      end
+    end
+    
+    def self.default_value
+      nil
+    end
+    
+    def default
+      self.default_value || self.class.default_value || nil
+    end
+    
+    protected
+    def build_error_message( input, e )
+      if input =~ /CsvMadness::TypeError/
+        input
+      else
+        "CsvMadness::TypeError::#{ }"
+      end
+    end
+    
+  end
+end

data/lib/csv_madness/column_types/date.rb

@@ -0,0 +1,14 @@
+module CsvMadness
+  module ColumnTypes
+    class DateType < CsvMadness::ColumnType
+      # Blank inputs return nil.  Other inputs may raise a date error
+      def self.convert( input )
+        if input.fwf_blank?
+          self.default_value
+        elsif input.is_a?(String)
+          Date.parse( input )
+        end
+      end
+    end
+  end
+end

data/lib/csv_madness/column_types/float.rb

@@ -0,0 +1,25 @@
+module CsvMadness
+  module ColumnTypes
+    class FloatType < CsvMadness::ColumnType
+      
+      # I suspect that a blank string and a nil should be treated the same, and that
+      # 0.0 is the wrong choice for a default.  Maybe these should return :default or :error,
+      # and leave it to the individual column definition to handle that.
+      def self.convert( input )
+        if input.fwf_blank?
+          :default
+        elsif input.is_a?( String )
+          Float( input )
+        elsif input.respond_to?( :to_f )
+          input.to_f
+        elsif input.respond_to?( :to_i )
+          input.to_i.to_f
+        else
+          :error
+        end
+      rescue ArgumentError
+        :error
+      end
+    end
+  end
+end

data/lib/csv_madness/column_types/integer.rb

@@ -0,0 +1,17 @@
+module CsvMadness
+  module ColumnTypes
+    class IntegerType < CsvMadness::ColumnType
+      def self.convert( input )
+        if input.fwf_blank?
+          0
+        elsif input.is_a?( String )
+          Float( input ).round
+        elsif input.respond_to?( :to_f )
+          input.to_f.round
+        elsif input.respond_to?( :to_i )
+          input.to_i
+        end
+      end
+    end
+  end
+end

data/lib/csv_madness/column_types/string.rb

@@ -0,0 +1,9 @@
+module CsvMadness
+  module ColumnTypes
+    class StringType < CsvMadness::ColumnType
+      def self.convert( input )
+        input.to_s
+      end
+    end
+  end
+end