jgdavey-movable_erb 0.1.3 → 0.2.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+v0.2.0 Complete rework from ground up. Old API is deprecated.
+
+v0.1.3 First working version on Github

data/{README.textile → LICENSE}

@@ -1,31 +1,5 @@
-h1. Movable Erb
-    by Joshua Davey
-    http://github.com/jgdavey/movable_erb
-
-h2. DESCRIPTION:
-
-A simple CSV to MTImport conversion utility
-
-h2. FEATURES/PROBLEMS:
-
-* Commandline access
-
-h2. SYNOPSIS:
-
-  @movable_erb [options] yourfile.csv@
-
-h2. REQUIREMENTS:
-
-* fastercsv gem
-
-h2. INSTALL:
-
-@sudo gem install movable_erb@
-(PENDING release)
-
-h2. LICENSE:
-
-(The MIT License)
+The MIT License
+---------------
 
 Copyright (c) 2009
 

data/Manifest

@@ -0,0 +1,20 @@
+CHANGELOG
+LICENSE
+Manifest
+README.md
+Rakefile
+bin/movable_erb
+cucumber.yml
+features/csv.feature
+features/step_definitions/csv_steps.rb
+features/step_definitions/tmp.csv
+features/support/env.rb
+lib/movable_erb.rb
+lib/templates/mtimport.erb
+spec/csv_spec.rb
+spec/fixtures/advanced.csv
+spec/fixtures/example.csv
+spec/fixtures/template.erb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.md

@@ -0,0 +1,57 @@
+Movable Erb
+===========
+
+by Joshua Davey  
+http://github.com/jgdavey/movable_erb
+
+Description
+-----------
+
+A simple CSV to MTImport conversion utility. 
+Useful for mapping contacts data into individual entries in Movable Type.
+
+MTImport format is simple enough that most blogging platforms can import it, so this utility could ease the pain of moving some older data structure in CSV format into a blog platform.
+
+Requirements
+------------
+
+* fastercsv gem
+
+Installation
+------------
+
+	[sudo] gem install jgdavey-movable_erb
+
+
+Usage
+-----
+
+After installing the gem, just run
+
+	movable_erb [options] yourfile.csv
+
+
+
+The MIT License
+---------------
+
+Copyright (c) 2009
+
+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/Rakefile

@@ -1,40 +1,17 @@
-# Look in the tasks/setup.rb file for the various options that can be
-# configured in this Rakefile. The .rake files in the tasks directory
-# are where the options are used.
-
-begin
-  require 'bones'
-  Bones.setup
-rescue LoadError
-  begin
-    load 'tasks/setup.rb'
-  rescue LoadError
-    raise RuntimeError, '### please install the "bones" gem ###'
-  end
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('movable_erb') do |p|
+  p.description    = "A General-purpose CSV to ERB template formatter"
+  p.url            = "http://github.com/jgdavey/movable_erb"
+  p.author         = "Joshua Davey"
+  p.email          = "josh@joshuadavey.com"
+  p.ignore_pattern = ["tmp/*", "script/*", "coverage/*"]
+  p.development_dependencies = ['rspec']
+  p.executable_pattern = ["bin/*"]
+  p.runtime_dependencies = ["fastercsv", "trollop"]
 end
 
-ensure_in_path 'lib'
-require 'movable_erb'
-
-task :default => 'spec:run'
-
-PROJ.name = 'movable_erb'
-PROJ.authors = 'Joshua Davey'
-PROJ.email = 'josh@joshuadavey.com'
-PROJ.summary = 'A simple CSV to MTImport conversion utility'
-PROJ.description = 'Usage: movable_erb [options]'
-PROJ.url = 'http://github.com/jgdavey/movable_erb/'
-PROJ.version = MovableErb::VERSION
-PROJ.rubyforge.name = 'movable_erb'
-
-PROJ.gem.dependencies = ['fastercsv']
-
-PROJ.readme_file = 'README.textile'
-PROJ.exclude << %w(\.git ^pkg tmp$)
-
-PROJ.notes.exclude = %w(^README\.txt$ ^data/)
-PROJ.rdoc.exclude = %w(^README\.txt$ ^data/)
-
-PROJ.spec.opts << '--color'
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
 
-# EOF

data/bin/movable_erb

@@ -1,66 +1,37 @@
 #!/usr/bin/env ruby
-require 'optparse'
-require 'ostruct'
 require 'pp'
+require 'rubygems'
+require 'trollop'
 
-require File.expand_path(
-    File.join(File.dirname(__FILE__), %w[.. lib movable_erb]))
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib movable_erb]))
 
-class MovableErbCLI
-  def self.parse(args)
-    # The options specified on the command line will be collected in *options*.
-    # We set default values here.
-    options = OpenStruct.new
-    options.template = nil
-    options.file    = ''
+DEFAULT_TEMPLATE = File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib templates mtimport.erb]))
 
-    opts = OptionParser.new do |opts|
-      opts.banner = "Usage: movable_erb [options]"
-      
-      opts.separator ""
-      opts.separator "It is often useful to pipe the output from STDOUT to a file"
-      opts.separator "e.g. # movable_erb -f yourfile.csv > import.txt"
-      
-      opts.separator ""
-      opts.separator "Specific options:"
+opts = Trollop::options do
 
-      opts.on("-f", "--file FILE", "CSV file to parse") do |f|
-        options.file = f
-      end
-      
-      opts.on("-t", "--template TEMPLATE", "Template to use (default is MTImport)") do |t|
-        options.template = t
-      end
+  version "MovableErb v#{MovableErb::VERSION}  (c) 2009 Joshua Davey"
+  banner <<-EOS
+  Usage:
 
-      opts.separator ""
-      opts.separator "Common options:"
+  movable_erb [options] <filenames.csv>
 
-      # No argument, shows at tail.  This will print an options summary.
-      # Try it and see!
-      opts.on_tail("-h", "--help", "Show this message") do
-        puts opts
-        exit
-      end
+  Options:
 
-      # Another typical switch to print the version.
-      opts.on_tail("--version", "Show version") do
-        puts MovableErb::VERSION
-        exit
-      end
-    end
+  EOS
 
-    opts.parse!(args)
-    if options.file == ''
-      opts
-    else
-      mtnew = MovableErb::MTImport.new(:csv => {:file => options.file,:template => options.template })
-      mtnew.setup_column_nums
-      mtnew.render_with_template
-    end
-  end  # parse()
-end
+  # Options
+  opt :separator, "Separator between records", :default => "", :short => '-s'
+  opt :template, "path to ERB template", :default => DEFAULT_TEMPLATE, :short => '-t'
+
+  # Show the help screen when no file given
+  educate if ARGV.empty?
 
-result = MovableErbCLI.parse(ARGV)
-puts result
+  # Only continue if the CSV file is found
+  Trollop::die "That file could not be found" unless File.exist?(ARGV.first)
+end
 
-# EOF
+# Paths for CSV files are left in ARGV
+ARGV.each do |csv|
+  opts.merge!(:csv => csv)
+  puts MovableErb.new(opts).convert
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --tags ~wip features

data/features/csv.feature

@@ -0,0 +1,40 @@
+Feature: CSV Conversion
+  In order to convert my list of contacts to blog format
+  As a Command-line user
+  I want to use commandline utility to convert CSV files to MTImport files
+
+  Scenario: A short CSV of contacts
+    Given I am on the commandline
+    When I invoke the utility with the following CSV file:
+      """
+      Title,Body,Body
+      John,773-123-1234,john@example.com
+      Abigail,,abby@example.com
+      Bernard,903-294-3921,
+      """
+    Then I should see the following output:
+      """
+      TITLE: John
+      -----
+      BODY:
+
+      773-123-1234
+      john@example.com
+
+      --------
+      TITLE: Abigail
+      -----
+      BODY:
+
+      abby@example.com
+      
+      --------
+      TITLE: Bernard
+      -----
+      BODY:
+
+      903-294-3921
+      
+      --------
+      
+      """

data/features/step_definitions/csv_steps.rb

@@ -0,0 +1,14 @@
+Given /^I am on the commandline$/ do
+  # dummy step
+end
+
+When /^I invoke the utility with the following CSV file:?$/ do |string|
+  File.open(File.dirname(__FILE__) + '/tmp.csv', 'w') {|f| f.write(string) }  
+  puts FasterCSV.parse(string).inspect
+  @erb = MovableErb.new({:csv => File.dirname(__FILE__) + '/tmp.csv', :separator => ''})
+end
+
+Then /^I should see the following output:?$/ do |string|
+  puts @erb.csv.to_hashes.inspect
+  @erb.convert.should == string
+end

data/features/step_definitions/tmp.csv

@@ -0,0 +1,4 @@
+Title,Body,Body
+John,773-123-1234,john@example.com
+Abigail,,abby@example.com
+Bernard,903-294-3921,

data/features/support/env.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'spec'
+
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. .. lib movable_erb]))
+
+require "mocha"
+ 
+World(Mocha::API)
+ 
+Before do
+  mocha_setup
+end
+ 
+After do
+  begin
+    mocha_verify
+  ensure
+    mocha_teardown
+  end
+end

data/lib/movable_erb.rb

@@ -1,49 +1,92 @@
+class MovableErb
+  VERSION = "0.2.0"
+  attr_accessor :csv, :erb, :separator
 
-module MovableErb
+  DEFAULT_TEMPLATE = File.expand_path(File.dirname(__FILE__) + '/templates/mtimport.erb')
 
-  # :stopdoc:
-  VERSION = '0.1.3'
-  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
-  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
-  # :startdoc:
+  def initialize(options = {})
+    @erb = MovableErb::Erb.setup do |erb|
+      erb.template = options[:template] || DEFAULT_TEMPLATE
+    end
+    if options[:csv]
+      @csv = MovableErb::CSV.setup do |csv|
+        csv.filename = options[:csv]
+      end
+    end
+    @separator = options[:separator] || ""
+  end
 
-  # Returns the version string for the library.
-  #
-  def self.version
-    VERSION
+  def convert
+    @results = []
+    csv.parse!
+    csv.hashes.each do |hash_data|
+      erb.data = hash_data
+      @results << erb.build!
+    end
+    @results.join(separator)
   end
+end
+
+class MovableErb::CSV
+  require 'fastercsv'
+
+  attr_accessor :filename, :hashes
 
-  # Returns the library path for the module. If any arguments are given,
-  # they will be joined to the end of the libray path using
-  # <tt>File.join</tt>.
-  #
-  def self.libpath( *args )
-    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  def setup(&block)
+    yield self
+    parse! if @filename
+    self
   end
 
-  # Returns the lpath for the module. If any arguments are given,
-  # they will be joined to the end of the path using
-  # <tt>File.join</tt>.
-  #
-  def self.path( *args )
-    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  def self.setup
+    csv = self.new
+    yield csv
+    csv.parse!
   end
 
-  # Utility method used to require all files ending in .rb that lie in the
-  # directory below this file that has the same name as the filename passed
-  # in. Optionally, a specific _directory_ name can be passed in such that
-  # the _filename_ does not have to be equivalent to the directory.
-  #
-  def self.require_all_libs_relative_to( fname, dir = nil )
-    dir ||= ::File.basename(fname, '.*')
-    search_me = ::File.expand_path(
-        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+  def parse!
+    @hashes = self.to_hashes
+    self
+  end
 
-    Dir.glob(search_me).sort.each {|rb| require rb}
+  def to_hashes
+    array_of_arrays = FasterCSV.read(filename)
+    headers = array_of_arrays.shift
+    headers.each { |h| h.downcase! && h.gsub!(/\s/,"_") } if headers
+    hashes = Array.new(array_of_arrays.length) { Hash.new }
+    array_of_arrays.each_with_index do |row,i|
+      headers.each_with_index do |header, j|
+        unless row[j].nil?
+          hashes[i][header] = [] if hashes[i][header].nil?
+          hashes[i][header] << row[j]
+        end
+      end
+    end
+    hashes
   end
+end
+
+class MovableErb::Erb
+  require 'erb'
 
-end  # module MovableErb
+  attr_accessor :template, :parsed_string, :data
 
-MovableErb.require_all_libs_relative_to(__FILE__)
+  def self.setup
+    erb = self.new
+    yield erb
+    erb
+  end
 
-# EOF
+  def template=(template_file)
+    @template = File.read template_file
+  end
+
+  def setup
+    yield self
+  end
+
+  def build!
+    erb = ERB.new(template, nil, '<>')
+    @parsed_string = erb.result(binding) if erb
+  end
+end

data/lib/templates/mtimport.erb

@@ -0,0 +1,22 @@
+TITLE: <%= data['title'].join(', ') if data['title'] %>
+<% if data['author'] %>
+AUTHOR: <%= data['author'].join(', ') %>
+<% end %>
+<% data['category'] && data['category'].each do |cat| %>
+CATEGORY: <%= cat %>
+<% end %>
+-----
+BODY:
+
+<%= data['body'].join("\n") if data['body'] %>
+
+<% if data['extended_body'] %>
+
+-----
+EXTENDED BODY:
+
+<%= data['extended_body'] %>
+
+<% end %>
+
+--------

data/movable_erb.gemspec

@@ -2,25 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{movable_erb}
-  s.version = "0.1.3"
+  s.version = "0.2.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Davey"]
-  s.date = %q{2009-04-18}
+  s.date = %q{2009-09-26}
   s.default_executable = %q{movable_erb}
-  s.description = %q{Usage: movable_erb [options]}
+  s.description = %q{A General-purpose CSV to ERB template formatter}
   s.email = %q{josh@joshuadavey.com}
   s.executables = ["movable_erb"]
-  s.extra_rdoc_files = ["History.txt", "bin/movable_erb", "lib/movable_erb/templates/default.erb"]
-  s.files = ["History.txt", "README.textile", "Rakefile", "bin/movable_erb", "lib/movable_erb.rb", "lib/movable_erb/csv.rb", "lib/movable_erb/mtimport.rb", "lib/movable_erb/templates/default.erb", "movable_erb.gemspec", "spec/csv_spec.rb", "spec/fixtures/example.csv", "spec/movable_erb_spec.rb", "spec/mtimport_spec.rb", "spec/spec_helper.rb", "test/test_movable_erb.rb"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/jgdavey/movable_erb/}
-  s.rdoc_options = ["--main", "README.textile"]
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.md", "bin/movable_erb", "lib/movable_erb.rb", "lib/templates/mtimport.erb", "tasks/rspec.rake"]
+  s.files = ["CHANGELOG", "LICENSE", "README.md", "Rakefile", "bin/movable_erb", "cucumber.yml", "features/csv.feature", "features/step_definitions/csv_steps.rb", "features/step_definitions/tmp.csv", "features/support/env.rb", "lib/movable_erb.rb", "lib/templates/mtimport.erb", "spec/csv_spec.rb", "spec/fixtures/advanced.csv", "spec/fixtures/example.csv", "spec/fixtures/template.erb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake", "Manifest", "movable_erb.gemspec"]
+  s.homepage = %q{http://github.com/jgdavey/movable_erb}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Movable_erb", "--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{movable_erb}
-  s.rubygems_version = %q{1.3.2}
-  s.summary = %q{A simple CSV to MTImport conversion utility}
-  s.test_files = ["test/test_movable_erb.rb"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A General-purpose CSV to ERB template formatter}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -28,13 +26,16 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<fastercsv>, [">= 0"])
-      s.add_development_dependency(%q<bones>, [">= 2.5.0"])
+      s.add_runtime_dependency(%q<trollop>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
     else
       s.add_dependency(%q<fastercsv>, [">= 0"])
-      s.add_dependency(%q<bones>, [">= 2.5.0"])
+      s.add_dependency(%q<trollop>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
     s.add_dependency(%q<fastercsv>, [">= 0"])
-    s.add_dependency(%q<bones>, [">= 2.5.0"])
+    s.add_dependency(%q<trollop>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end