rstore 0.3.2 → 0.3.4

data/ChangeLog.md

@@ -1,3 +1,8 @@
+## Version 0.3.4 (February 14, 2012)
+
+### Other
+* Update dependencies in gemspec.
+
 ## Version 0.3.2 (December 12, 2011)
 
 ### Bugfixes

data/Rakefile

@@ -1,6 +1,7 @@
 # require 'spec/rake/spectask' # depreciated
 require 'rspec/core/rake_task'
-require 'rake/gempackagetask'
+# require 'rake/gempackagetask' # depreciated
+require 'rubygems/package_task'
 require 'rdoc/task'
 
 # Build gem: rake gem
@@ -27,7 +28,7 @@ end
 
 gem_spec = eval(File.read('rstore.gemspec'))
 
-Rake::GemPackageTask.new( gem_spec ) do |t|
+Gem::PackageTask.new( gem_spec ) do |t|
   t.need_zip = true
 end
 
@@ -36,5 +37,5 @@ end
 #end
 
 task :push => :gem do |t|
-  sh "gem push pkg/#{gem_spec.name}-#{gem_spec.version}.gem"
+  sh "gem push -v pkg/#{gem_spec.name}-#{gem_spec.version}.gem"
 end

data/lib/rstore/base_db.rb

@@ -7,7 +7,7 @@ module RStore
 
     class << self
       # A Hash holding subclasses of {RStore::BaseDB}
-      # @return [Hash{Symbol=>BaseDB}] All subclasses of {RStore::BaseDB} defined in the current namespace.  
+      # @return [Hash{Symbol=>BaseDB}] All subclasses of {RStore::BaseDB} defined in the current namespace.
       #   Subclasses are added automatically via _self.inherited_.
       # @example
       #   class CompanyDB < RStore::BaseDB
@@ -30,17 +30,17 @@ module RStore
       BaseDB.db_classes[subclass.name] = subclass
     end
 
-   
+
     # Define the database connection.
     # @note To be called when defining a _subclass_ of {RStore::BaseDB}
     # Accepts the same _one_ _arity_ parameters as [Sequel.connect](http://sequel.rubyforge.org/rdoc/files/doc/opening_databases_rdoc.html)
     # @overload info(options)
     #  @param [String, Hash] connection_info Either a connection string such as _postgres://user:password@localhost/blog_, or a `Hash` with the following options:
-    #  @option options [String] :adapter The SQL database used, such as _mysql_ or _postgres_ 
+    #  @option options [String] :adapter The SQL database used, such as _mysql_ or _postgres_
     #  @option options [String] :host Example: 'localhost'
-    #  @option options [String] :user 
-    #  @option options [String] :password 
-    #  @option options [String] :database The database name. You don't need to provide this option, as its value will be inferred from the class name. 
+    #  @option options [String] :user
+    #  @option options [String] :password
+    #  @option options [String] :database The database name. You don't need to provide this option, as its value will be inferred from the class name.
     #  @return [void]
     # @example
     #  # Using a connection string
@@ -50,29 +50,33 @@ module RStore
     #
     #  # Using an options hash
     #  class CompanyDB < RStore::BaseDB
-    #    info(adapter: 'mysql', 
-    #         host: 'localhost', 
-    #         user: 'root', 
+    #    info(adapter: 'mysql',
+    #         host: 'localhost',
+    #         user: 'root',
     #         password: 'xxx')
     #  end
     def self.info hash_or_string
-      class << self            # self = #<Class:CompanyDB>
+      # self = CompanyDB
+
+      class << self
+        # self = #<Class:CompanyDB>
         attr_reader :connection_info
       end
-                               # self = CompanyDB
+
+      # Instance variables always belong to self.
       @connection_info = hash_or_string.is_a?(Hash) ? hash_or_string.merge(:database => self.name.to_s): hash_or_string
     end
 
 
-    # Uses the connection info from {.info} to connect to the database.  
+    # Uses the connection info from {.info} to connect to the database.
     # @note To be called when defining a _subclass_ of {RStore::BaseDB}
     # @yieldparam [Sequel::Database] db The opened Sequel {http://sequel.rubyforge.org/rdoc/classes/Sequel/Database.html Database} object, which is closed when the block exits.
     # @return [void]
     # @example
     #  class CompanyDB < RStore::BaseDB
-    #    info(adapter: 'mysql', 
-    #         host: 'localhost', 
-    #         user: 'root', 
+    #    info(adapter: 'mysql',
+    #         host: 'localhost',
+    #         user: 'root',
     #         password: 'xxx')
     #  end
     #
@@ -110,10 +114,10 @@ module RStore
     #
     #  CompanyDB.name
     #  #=> :company
-    def self.name  
+    def self.name
       super.gsub!(/DB/,'').downcase.to_sym
     end
 
   end
 end
- 
+

data/lib/rstore/configuration.rb

@@ -36,6 +36,9 @@ module RStore
 
       @path        = path
       self.options = new_options
+      # options= deletes all valid options already processed from new_options,
+      # leaving only options that are not valid.
+      # Therefore, new_options.size > 0 indicates that options not recognized where passed.
       raise ArgumentError, arg_error_message(@path, new_options) if new_options.size > 0
 
       @file_options  = extract_with(Configuration.default_file_options)

data/lib/rstore/converter.rb

@@ -34,9 +34,10 @@ module RStore
     #  where the error occured.
     Converters = Hash.new {|h,k| h[k] = lambda { |field| field }}.
       merge!({string:     lambda { |field| field },
-              date:       lambda { |field| Date.parse(field).to_s },
+              date:       lambda { |field| Date.parse(field).strftime("%Y-%m-%d") },
               datetime:   lambda { |field| DateTime.parse(field).to_s },
               # Convert to DateTime, because DateTime also checks if the argument is valid
+              # Sequel handles Time as DateTime
               time:       lambda { |field| DateTime.parse(field).to_s },
               integer:    lambda { |field| Integer(field) },
               float:      lambda { |field| Float(field) },

data/lib/rstore/data.rb

@@ -20,14 +20,14 @@ module RStore
 
     def initialize path, content, state, options
       error_message = "#{path}: The following options are not valid as an argument to #{self.class}:\n#{options}"
-      raise ArgumentError, error_message  unless options.is_a?(Hash) 
+      raise ArgumentError, error_message  unless options.is_a?(Hash)
       @path      = path
       @content   = content
       self.state = state
       @options   = options
     end
 
-  
+
     #def extract_type path
     #  path, filename = File.split(path)
     #  filename.match(/\.(?<type>.*)$/)[:type].to_sym
@@ -41,9 +41,9 @@ module RStore
 
       begin
         csv = CSVWrapper.parse(@content, parse_options)
-        csv = csv.drop(1)  if file_options[:has_headers] == true  # drop the first row if it is a header 
+        csv = csv.drop(1)  if file_options[:has_headers] == true  # drop the first row if it is a header
       rescue => e
-        Logger.new(@options).print(@data.path, :parse, e)
+        Logger.new(@options).print(@path, :parse, e)
       end
 
       @state = :parsed
@@ -64,7 +64,7 @@ module RStore
 
 
     def state= state
-      error_message = "#{state.inspect} is not a valid state. The following states are valid: #{print_valid_states}" 
+      error_message = "#{state.inspect} is not a valid state. The following states are valid: #{print_valid_states}"
       raise ArgumentError, error_message  unless KnownStates.include?(state)
       @state = state
     end
@@ -76,5 +76,5 @@ module RStore
     end
 
   end
-end 
- 
+end
+

data/lib/rstore/file_crawler.rb

@@ -11,7 +11,7 @@ module RStore
     #attr_reader :file_options_hash
     attr_reader :data_hash
 
-    attr_reader :file_options, :parse_options 
+    attr_reader :file_options, :parse_options
     attr_reader :path
     attr_reader :file_paths, :file_type
     attr_reader :config
@@ -31,7 +31,7 @@ module RStore
 
 
     def file_paths= path
-      return @file_paths unless @file_paths.nil?
+      return @file_paths unless @file_paths.nil?  # @file_path can only be set once on initialization
 
       @file_paths = []
       files       = []
@@ -45,7 +45,7 @@ module RStore
         end
       else                                            # Either a file or a non-existing directory path
         file = File.expand_path(path)
-        raise ArgumentError, "'#{path}' is not a valid path" unless File.exists?(file)
+        raise ArgumentError, "'#{path}' is not a valid path" unless File.exists?(file) # File.exist?(“/path/to/file_or_dir”)
 
         error_message = <<-MESSAGE.gsub(/^\s+/,'')
                            Not a #{@file_type} file.
@@ -79,8 +79,6 @@ module RStore
 
 
     def file_options_hash= file_paths
-      @file_options_hash unless @file_options_hash.nil?
-
       hash = Hash.new {|h,k| h[k] = Hash.new {|h,k| h[k] = nil}}
       file_paths.each do |path|
         hash[path][:file_options]  = @file_options
@@ -122,10 +120,10 @@ module RStore
         when /^www/  # open-uri does not recognize URLs starting with 'www'
           address = 'http://' + address
           retry
-        when /^http:/ # open-uri does not redirect from http to https on a valid https URL 
+        when /^http:/ # open-uri does not redirect from http to https on a valid https URL
           address = address.gsub(/http/,'https')
           retry
-        else 
+        else
           raise ArgumentError, "Could not connect to #{url}. Please check if this URL is correct."
         end
       end

data/lib/rstore/logger.rb

@@ -7,10 +7,10 @@ module RStore
 
     attr_accessor :data
     attr_accessor :message
-    
 
-    KnownStates = 
-      {:fetch   => "loading files", 
+
+    KnownStates =
+      {:fetch   => "loading files",
        :parse   => "parsing file content",
        :convert => "converting field values into their corresponding datatypes",
        :store   => "storing file content into database"}
@@ -24,19 +24,19 @@ module RStore
 
 
     def log state, error, loc={}
-      raise ArgumentError "#{state} is an invalid state vor #{self.class}"  unless valid_state? state
+      raise ArgumentError "#{state} is an invalid state for #{self.class}"  unless valid_state? state
 
       loc = correct_location(loc)
 
       type_of_error = error.class
       error_message = error.to_s
-      location      = "Location     : #{location_to_s(loc)}" 
+      location      = "Location     : #{location_to_s(loc)}"
       location      = loc.empty? ? '' : location
 
       report = <<-TEXT.gsub(/^\s+/, '')
       An error occured while #{KnownStates[state]}:
-      File         : #{@data.path} 
-      Type of error: #{type_of_error} 
+      File         : #{@data.path}
+      Type of error: #{type_of_error}
       Error message: #{error_message}
       #{location}
       =============
@@ -61,9 +61,9 @@ module RStore
     end
 
 
-    
+
     def correct_location location
- 
+
       if location[:row]        # row_index
         row = correct_row(location[:row])
         if location[:col]      # col_index
@@ -88,7 +88,7 @@ module RStore
 
 
     def valid_state? state
-      KnownStates.keys.any? { |val| val == state } 
+      KnownStates.keys.any? { |val| val == state }
     end
 
 

data/lib/rstore/version.rb

@@ -1,3 +1,3 @@
 module RStore
-  VERSION = "0.3.2"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rstore
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,30 +9,38 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-08 00:00:00.000000000Z
+date: 2012-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: &23883620 !ruby/object:Gem::Requirement
+  type: :runtime
+  name:
+  - open-uri
+  - nokogiri
+  - bigdecimal
+  - sequel
+  - csv
+  prerelease: false
+  requirement: &16180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *23883620
+  version_requirements: *16180
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &23883160 !ruby/object:Gem::Requirement
+  type: :development
+  name:
+  - rspec
+  - mysql
+  - sqlite3-ruby
+  prerelease: false
+  requirement: &16244 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *23883160
+  version_requirements: *16244
 description: ! "  RStore makes batch processing of csv files a breeze.\n  Automatically
   fetches data files, directories, URLs\n  :: Customizable using additional options\n
   \ :: Validation of field values\n  :: Descriptive error messages\n  :: Safe and
@@ -42,6 +50,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/rstore.rb
 - lib/rstore/version.rb
 - lib/rstore/csv.rb
 - lib/rstore/configuration.rb
@@ -52,13 +61,12 @@ files:
 - lib/rstore/logger.rb
 - lib/rstore/storage.rb
 - lib/rstore/base_table.rb
+- lib/rstore/exceptions.rb
 - lib/rstore/core_ext/hash.rb
 - lib/rstore/core_ext/csv_wrapper.rb
 - lib/rstore/core_ext/string.rb
 - lib/rstore/core_ext/object.rb
-- lib/rstore/exceptions.rb
 - lib/rstore/modules/helper_methods.rb
-- lib/rstore.rb
 - ChangeLog.md
 - README.md
 - Rakefile
@@ -83,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rstore
-rubygems_version: 1.8.11
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: RStore - A library for easy batch storage of csv data into a database