db-populator 0.1.1

data/.document

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'logging'
+
+group :development do
+  gem 'jeweler', '~> 1.6.0'
+  gem 'bundler', '~> 1.0.0'
+  gem 'rspec', '~> 2.3.0'
+  gem 'rcov', '>= 0'
+  gem 'yard', '~> 0.6.0'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    little-plugger (1.1.2)
+    logging (1.5.0)
+      little-plugger (>= 1.1.2)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.0)
+  logging
+  rcov
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Umang Chouhan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,35 @@
+== Populator http://travis-ci.org/optimis/populator.png
+
+Populator includes helper methods to ease parsing data files. Assigning a header and iterating over rows is handled by the module via a simple configuration.
+
+  Examples:
+
+  Define a module and extend it with the populator module.
+
+    A Custom Populator.
+
+      module CustomPopulator
+        extend Populator
+        populates 'CustomFile'
+
+        def process(row)
+          ...
+        end
+      end
+
+  The extended module focusses on business logic required to process a single row.
+
+== Contributing to populator
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Umang Chouhan. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+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 = "db-populator"
+  gem.homepage = "http://github.com/optimis/db-populator"
+  gem.license = "MIT"
+  gem.summary = %Q{Populator is a utility to parse data files.}
+  gem.description = %Q{Populator is a utility to parse data files.}
+  gem.email = "uchouhan@optimiscorp.com"
+  gem.authors = ["Umang Chouhan"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/populator/errors.rb

@@ -0,0 +1,32 @@
+# The exception class used when the data file is not configured.
+class DataFileNotConfigured < Exception
+
+  # Set the message to return when a data file is not configured.
+  #
+  # @return [String] The message to return if the data file is not configured.
+  def message
+    'No data file was specified. Usage: populates <file>'
+  end
+end
+
+# The exception class used when the data file is missing.
+class MissingDataFile < Exception
+
+  # Set the message to return when a data file is missing.
+  #
+  # @return [String] The message to return if the data file is missing.
+  def message
+    'The data file configured is missing.'
+  end
+end
+
+# The exception class used when the process method is not overridden.
+class MethodNotOverridden < Exception
+
+  # Set the message to return when the process method is not overridden.
+  #
+  # @return [String] The message to return when the process method is not overridden.
+  def message
+    'You must override the .process method in the extended populator class.'
+  end
+end

data/lib/populator/fakes.rb

@@ -0,0 +1,29 @@
+# A fake populator module with default type for testing.
+module FakePopulator
+
+  # Extend it with the Populator module.
+  extend Populator
+
+  # Populate the test file.
+  populates 'TestFile'
+end
+
+# A fake populator module with overridden type for testing.
+module FakePopulatorWithOverriddenType
+
+  # Extend it with the Populator module.
+  extend Populator
+
+  # Populate the test excel file.
+  populates 'TestExcelFile', :type => 'excel'
+end
+
+# A fake populator module with overridden directory for testing.
+module FakePopulatorWithOverriddenDirectory
+
+  # Extend it with the Populator module.
+  extend Populator
+
+  # Populate the test file.
+  populates 'TestFile', :directory => 'db/populate/files'
+end

data/lib/populator/logger.rb

@@ -0,0 +1,47 @@
+# Require the logging gem.
+require 'logging'
+
+# The populate logger class.
+class PopulateLogger
+
+  # Configures the logger.
+  #
+  # @return [Logger] The logger instance after configuration.
+  def self.setup
+    configure
+    logger
+  end
+
+  private
+
+  # Configures the level.
+  #
+  # @param [Symbol] The log level. (defaults to :info)
+  def self.level=(level)
+    @level = level
+  end
+
+  # Returns the level.
+  #
+  # @param [String] The configured level. (defaults to :info)
+  def self.level
+    @level or :info
+  end
+
+  # Returns the configured logger.
+  #
+  # @return [Logger, #info, #debug, #warn] The logger instance.
+  def self.logger
+    logger = Logging.logger['example_logger']
+    logger.add_appenders Logging.appenders.stdout, Logging.appenders.file(@path)
+    logger.level = level
+    logger
+  end
+
+  # Configures the path of the log file.
+  #
+  # @return [String] The path of the log file.
+  def self.configure
+    @path = defined?(Rails) ? "#{Rails.root}/log/populator.log" : 'populator.log'
+  end
+end

data/lib/populator.rb

@@ -0,0 +1,109 @@
+require 'populator/errors'
+require 'populator/logger'
+
+# Populator includes helper methods to ease parsing data files.
+# Assigning a header and iterating over rows is handled by the
+# module via a simple configuration.
+# 
+# @example
+#   Define a module and extend it with the populator module.
+#
+# @example A Custom Populator.
+#   module CustomPopulator
+#     extend Populator
+#     populates 'CustomFile'
+#
+#     def process(row)
+#       ...
+#     end
+#   end
+#
+# @note As noted in the example the extended module defines the
+#   logic to process a single row.
+
+module Populator
+
+  # Default directory location for data files.
+  DIRECTORY = 'files'
+
+  # Default data file type is CSV.
+  TYPE = 'csv'
+
+  # Attribute accessors for the directory, file name, header, count, rows and before hook.
+  attr_accessor :logger, :directory, :file, :type, :header, :count, :rows, :before
+
+  # Configuration helper.
+  #
+  # @param [String] file The data file name.
+  # @option options [String] :directory ('db/populate/data_files') The location of the data file.
+  # @option options [String] :type ('csv') The data file type.
+  # @option options [Boolean] :header Set true if the file has a header.
+  # @option options [String] :before The method to call before the run.
+  def populates(file, options = {})
+    # Setup the logger to log populator warnings and messages.
+    self.logger = PopulateLogger.setup
+
+    self.directory = options[:directory] || DIRECTORY
+    self.file = file
+    self.type = options[:type] || TYPE
+    self.header = options[:header]
+    self.before = options[:before]
+  end
+
+  # Parses the data file content and processes each row.
+  #
+  # @return [Boolean] Returns true if all rows are processed successfully.
+  def run
+
+    # Call the before hook if defined.
+    #
+    # @usage
+    #   populates 'TestFile', :before => :inactivate
+    send(before) if before
+
+    rows = parser.parse(read)
+    self.count = header ? rows.count - 1 : rows.count
+    self.header = rows.shift if header
+    count.times { process(rows.shift) }
+
+    # Return true when all rows are processed.
+    return true
+  end
+
+  # Stub method to be defined in the extended module.
+  # 
+  # @raise [Exception] Raises an exception if the extended module does not override the method.
+  def process(row = nil)
+    raise MethodNotOverridden
+  end
+
+  private
+  
+  # The parser to use based on the type of data file.
+  #
+  # @return [Parser, #parse] Returns the parser class to use.
+  def parser
+    if type == 'csv'
+      require 'csv'
+      return CSV::Reader
+    end
+  end
+
+  # Absolute path for the data file.
+  # 
+  # @return [String] The absolute path.
+  def path
+    "#{Rails.root}/#{directory}/#{file}.#{type}"
+  end
+
+  # Reads the data file.
+  #
+  # @return [File] The data file contents.
+  # @raise [DataFileNotConfigured] Raises an exception when the file is not configured.
+  # @raise [MissingDataFile] Raises an exception when the configured file is missing.
+  def read
+    raise DataFileNotConfigured unless file
+    raise MissingDataFile unless File.exist?(path)
+    File.read path
+  end
+end

data/populator.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{populator}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Umang Chouhan"]
+  s.date = %q{2011-05-12}
+  s.description = %q{Populator is a utility to parse data files.}
+  s.email = %q{uchouhan@optimiscorp.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/populator.rb",
+    "lib/populator/errors.rb",
+    "lib/populator/fakes.rb",
+    "lib/populator/logger.rb",
+    "populator.gemspec",
+    "spec/populator_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/optimis/populator}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Populator is a utility to parse data files.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<logging>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+    else
+      s.add_dependency(%q<logging>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    end
+  else
+    s.add_dependency(%q<logging>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+  end
+end
+

data/spec/populator_spec.rb

@@ -0,0 +1,50 @@
+require 'spec/spec_helper'
+require 'populator/fakes'
+
+describe Populator, 'DIRECTORY' do
+  it 'should be set to the default directory' do
+    Populator::DIRECTORY.should == 'files'
+  end
+end
+
+describe FakePopulator, '.directory' do
+  context 'when no directory is configured' do
+    it 'should return the default directory' do
+      FakePopulator.directory.should == Populator::DIRECTORY
+    end
+  end
+
+  context 'when the directory is configured' do
+    it 'should return the configured directory' do
+      FakePopulatorWithOverriddenDirectory.directory.should == 'db/populate/files'
+    end
+  end
+end
+
+describe FakePopulator, '.file' do
+  it 'should return the configured file name' do
+    FakePopulator.file.should == 'TestFile'
+  end
+end
+
+describe FakePopulator, '.type' do
+  context 'when no file type is configured' do
+    it 'should return the default file type' do
+      FakePopulator.type.should == 'csv'
+    end
+  end
+
+  context 'when the file type is configured' do
+    it 'should return the configured file type' do
+      FakePopulatorWithOverriddenType.type.should == 'excel'
+    end
+  end
+end
+
+describe FakePopulator, '.process(row)' do
+  it 'should raise an exception with a message to define the method in the extended populator class' do
+    lambda {
+      FakePopulator.process
+    }.should raise_exception(MethodNotOverridden)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'populator'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification 
+name: db-populator
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Umang Chouhan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: logging
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: yard
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  requirement: *id006
+description: Populator is a utility to parse data files.
+email: uchouhan@optimiscorp.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/populator.rb
+- lib/populator/errors.rb
+- lib/populator/fakes.rb
+- lib/populator/logger.rb
+- populator.gemspec
+- spec/populator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/optimis/db-populator
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Populator is a utility to parse data files.
+test_files: []
+