smilodon 0.0.2 → 0.2.2

data/Gemfile

@@ -1,6 +1,11 @@
 source 'http://rubygems.org'
 
+gem 'logging'
+
 group :development do
-  gem 'rake'
-  gem 'rspec'
+  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

@@ -1,20 +1,34 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
-    rake (0.9.2.2)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.0)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
+    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
-  rake
-  rspec
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.0)
+  logging
+  rcov
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/README.rdoc

@@ -1,6 +1,6 @@
 == Populator http://travis-ci.org/optimis/populator.png
 
-http://www.paleospot.com/illustrations/Smilodon.jpg
+http://dinofelis-cristata.artspots.com/image_sizes/0012/1985/smilodon_populator.jpg
 
 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.
 

data/Rakefile

@@ -1,10 +1,44 @@
-#!/usr/bin/env rake
+# encoding: utf-8
 
-require 'bundler/gem_tasks'
+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 = "smilodon"
+  gem.homepage = "http://github.com/optimis/smilodon"
+  gem.license = "MIT"
+  gem.summary = %Q{Smilodon is a utility to parse data files.}
+  gem.description = %Q{Smilodon 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
 
-desc 'Run specs'
-RSpec::Core::RakeTask.new do |task|
+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
+
+require 'smilodon/tasks'

data/VERSION

@@ -1 +1 @@
-0.2.9
+0.2.2

data/lib/smilodon/fakes.rb

@@ -27,23 +27,3 @@ module FakePopulatorWithOverriddenDirectory
   # Populate the test file.
   populates 'TestFile', :directory => 'db/populate/files'
 end
-
-# A fake populator module with overridden directory for testing.
-module FakePopulatorWithMultipleFiles
-
-  # Extend it with the Populator module.
-  extend Smilodon::Populator
-
-  # Populate the test file.
-  populates 'TestFile1', 'TestFile2', 'TestFile3', :directory => 'db/populate/files'
-end
-
-# A fake populator module with overridden directory for testing.
-module FakePopulatorWithOnlyDirectory
-
-  # Extend it with the Populator module.
-  extend Smilodon::Populator
-
-  # Populate the test file.
-  populates :directory => 'spec/test_files'
-end

data/lib/smilodon/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/smilodon.rb

@@ -1,7 +1,5 @@
-require 'bundler/setup'
-
 require 'smilodon/errors'
-require 'smilodon/railtie' if defined?(Rails)
+require 'smilodon/logger'
 
 # Smilodon includes helper methods to ease parsing data files.
 # Assigning a header and iterating over rows is handled by the
@@ -32,53 +30,45 @@ module Smilodon
     # Default data file type is CSV.
     TYPE = 'csv'
 
-    # Attribute accessors for the directory, file name, header, rows and before hook.
-    attr_accessor :logger, :directory, :files, :type, :header, :rows, :before
+    # 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 [Array] args an array of strings with an optional options hash
+    # @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(*args)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-
-      self.directory = if defined?(Rails) 
-        "#{Rails.root}/#{options[:directory] || DIRECTORY}"
-      else
-        options[:directory] || DIRECTORY
-      end
+    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]
-      self.files = args.empty? ? grab_files : args
     end
 
     # Parses the data file content and processes each row.
     #
     # @return [Boolean] Returns true if all rows are processed successfully.
     def run
-      files.each do |f|
-        # Call the before hook if defined.
-        #
-        # @usage
-        #   populates 'TestFile', :before => :inactivate
-        send(before) if before
-        rows = parser.parse(read(f))
-        rows.each_with_index do |row, index|
-          if index == 0 && header
-            self.header = row
-          else
-            process(row)
-          end
-        end
-      end
+
+      # 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.
-      true
+      return true
     end
 
     # Stub method to be defined in the extended module.
@@ -89,15 +79,9 @@ module Smilodon
     end
 
     private
-    def grab_files
-      Dir.glob("#{directory}/*").map do |file|
-        File.basename(file, File.extname(file))
-      end
-    end
-
+    
     # The parser to use based on the type of data file.
     #
-    # @param [String] Name of file to be read
     # @return [Parser, #parse] Returns the parser class to use.
     def parser
       if type == 'csv'
@@ -109,20 +93,19 @@ module Smilodon
     # Absolute path for the data file.
     # 
     # @return [String] The absolute path.
-    def path(file)
-      "#{directory}/#{file}.#{type}"
+    def path
+      "#{Rails.root}/#{directory}/#{file}.#{type}"
     end
 
     # Reads the data file.
     #
-    # @param [String] Name of file to be read
     # @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(file)
+    def read
       raise DataFileNotConfigured unless file
-      raise MissingDataFile unless File.exist?(path(file))
-      File.read path(file)
+      raise MissingDataFile unless File.exist?(path)
+      File.read path
     end
   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/smilodon.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "smilodon"
-  s.version = "0.0.2"
+  s.name = %q{smilodon}
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Umang Chouhan"]
-  s.date = "2012-07-25"
-  s.description = "Smilodon is a utility to parse data files."
-  s.email = "uchouhan@optimiscorp.com"
+  s.date = %q{2011-07-11}
+  s.description = %q{Smilodon is a utility to parse data files.}
+  s.email = %q{uchouhan@optimiscorp.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -28,21 +28,21 @@ Gem::Specification.new do |s|
     "lib/smilodon.rb",
     "lib/smilodon/errors.rb",
     "lib/smilodon/fakes.rb",
+    "lib/smilodon/logger.rb",
     "lib/smilodon/tasks.rb",
     "lib/tasks/populate.rake",
     "lib/tasks/populate.yml",
+    "populator.gemspec",
     "smilodon.gemspec",
     "spec/lib/smilodon_spec.rb",
     "spec/lib/tasks/populate_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/test_files/bar.csv",
-    "spec/test_files/foo.csv"
+    "spec/spec_helper.rb"
   ]
-  s.homepage = "http://github.com/optimis/smilodon"
+  s.homepage = %q{http://github.com/optimis/smilodon}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.15"
-  s.summary = "Smilodon is a utility to parse data files."
+  s.rubygems_version = %q{1.5.3}
+  s.summary = %q{Smilodon is a utility to parse data files.}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/spec/lib/smilodon_spec.rb

@@ -23,7 +23,7 @@ end
 
 describe FakePopulator, '.file' do
   it 'should return the configured file name' do
-    FakePopulator.files.should == ['TestFile']
+    FakePopulator.file.should == 'TestFile'
   end
 end
 
@@ -48,67 +48,3 @@ describe FakePopulator, '.process(row)' do
     }.should raise_exception(MethodNotOverridden)
   end
 end
-
-describe FakePopulator, '.files' do
-  it 'should return the configured file names' do
-    FakePopulatorWithMultipleFiles.files.should == ['TestFile1', 'TestFile2', 'TestFile3']
-  end
-
-  it 'should handle an options hash' do
-    FakePopulatorWithMultipleFiles.directory.should == 'db/populate/files'
-  end
-
-  it 'calls read for each file passed to populate' do
-    FakePopulatorWithMultipleFiles.files.each { |f| FakePopulatorWithMultipleFiles.should_receive(:read).with(f).and_return('') }
-    FakePopulatorWithMultipleFiles.run
-  end
-
-  context 'given a directory and no files' do
-    it 'sets files to all the files in directory' do
-      FakePopulatorWithOnlyDirectory.files.sort.should == ['bar', 'foo'].sort
-    end
-  end
-end
-
-describe FakePopulator, '.run' do
-  module TestPopulator
-    extend Smilodon::Populator
-    populates 'abc'
-  end
-
-  context 'header is true' do
-    let!(:csv) { ["id,name", "1,atsuya"].join("\n") }
-
-    before do 
-      TestPopulator.header = true
-      TestPopulator.stub(:read).and_return(csv)
-      TestPopulator.should_receive(:process).once
-      TestPopulator.run
-    end
-
-    it 'should process csv file' do
-      TestPopulator.header.should == ["id", "name"]
-    end
-
-    it 'calls process for each non-header row' do
-    end
-  end
-
-  context 'header is false' do
-    let!(:csv) { ["id,name", "1,atsuya"].join("\n") }
-
-    before do
-      TestPopulator.header = false
-      TestPopulator.stub(:read).and_return(csv)
-      TestPopulator.should_receive(:process).twice
-      TestPopulator.run
-    end
-
-    it 'should process csv file' do
-      TestPopulator.header.should == false
-    end
-    
-    it 'calls process for each row' do
-    end
-  end
-end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: smilodon
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Umang Chouhan
@@ -15,100 +10,75 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-25 00:00:00 Z
+date: 2011-07-11 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  name: logging
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  requirement: *id001
-  name: logging
   type: :runtime
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 6
-        - 0
         version: 1.6.0
-  requirement: *id002
-  name: jeweler
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
-  requirement: *id003
-  name: bundler
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 3
-        - 0
         version: 2.3.0
-  requirement: *id004
-  name: rspec
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  requirement: *id005
-  name: rcov
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 6
-        - 0
         version: 0.6.0
-  requirement: *id006
-  name: yard
   type: :development
+  prerelease: false
+  version_requirements: *id006
 description: Smilodon is a utility to parse data files.
 email: uchouhan@optimiscorp.com
 executables: []
@@ -130,15 +100,16 @@ files:
 - lib/smilodon.rb
 - lib/smilodon/errors.rb
 - lib/smilodon/fakes.rb
+- lib/smilodon/logger.rb
 - lib/smilodon/tasks.rb
 - lib/tasks/populate.rake
 - lib/tasks/populate.yml
+- populator.gemspec
 - smilodon.gemspec
 - spec/lib/smilodon_spec.rb
 - spec/lib/tasks/populate_spec.rb
 - spec/spec_helper.rb
-- spec/test_files/bar.csv
-- spec/test_files/foo.csv
+has_rdoc: true
 homepage: http://github.com/optimis/smilodon
 licenses: 
 - MIT
@@ -152,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 571169230994044764
       segments: 
       - 0
       version: "0"
@@ -161,14 +132,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Smilodon is a utility to parse data files.