jgdavey-movable_erb 0.1.2

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 / 2009-04-03
+
+* 1 major enhancement
+  * Birthday!

data/README.textile

@@ -0,0 +1,49 @@
+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)
+
+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

@@ -0,0 +1,40 @@
+# 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
+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'
+
+# EOF

data/bin/movable_erb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'ostruct'
+require 'pp'
+
+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    = ''
+
+    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.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
+
+      opts.separator ""
+      opts.separator "Common options:"
+
+      # 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
+
+      # Another typical switch to print the version.
+      opts.on_tail("--version", "Show version") do
+        puts MovableErb::VERSION
+        exit
+      end
+    end
+
+    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
+
+result = MovableErbCLI.parse(ARGV)
+puts result
+
+# EOF

data/lib/movable_erb.rb

@@ -0,0 +1,49 @@
+
+module MovableErb
+
+  # :stopdoc:
+  VERSION = '0.1.2'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # 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)
+  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)
+  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'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module MovableErb
+
+MovableErb.require_all_libs_relative_to(__FILE__)
+
+# EOF

data/lib/movable_erb/csv.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'fastercsv'
+
+module MovableErb
+  class Csv
+    attr_reader :file
+    def initialize(args)
+      if args[:file]
+        args[:file].gsub!(/^([^\.\/])/,'./\1')
+        @file = args[:file]
+      end
+    end
+    
+    def rows
+      FasterCSV.read(file)
+    end
+    
+    def header
+      rows.first
+    end
+    
+    def data
+      rows[1..rows.length]
+    end
+    
+    def body
+      data
+    end
+  end
+end

data/lib/movable_erb/mtimport.rb

@@ -0,0 +1,65 @@
+module MovableErb
+  class MTImport
+    require 'erb'
+    
+    COLUMNNAMES = ['title','body','extended', 'category', 'tags']
+    
+    attr_accessor :csv, :template, :columns
+    
+    def initialize(args = {})
+      if args[:csv]
+        @csv = Csv.new(args[:csv])
+        @columns = {:body => nil, :title => nil}
+      end
+        @template = args[:template] || File.join(File.dirname(__FILE__), 'templates', 'default.erb')
+    end
+    
+    def header_rows
+      if @csv
+        @csv.header
+      else
+        raise "No CSV file"
+      end
+    end
+    
+    def setup_column_nums
+      COLUMNNAMES.each do |colname|
+        @columns[colname.to_sym] = header_rows.to_enum(:each_with_index).collect do |x,i| 
+          i if x.downcase == colname
+        end.compact
+      end
+      # Useful defaults
+      @columns[:title] = [0] if @columns[:title].empty?
+      @columns[:body] = [1] if @columns[:body].empty?
+      @columns
+    end
+    
+    def column_nums_for(column)
+      @columns[column.to_sym]
+    end
+    
+    def content_for(column, row = 0)
+      content = column_nums_for(column).map do |i|
+        csv.body[row][i]
+      end
+    end
+
+    
+    def render_with_template(template = @template)
+      rendered = []
+      csv.body.each_with_index do |row, i|
+        title = content_for('title', i).join(" ")
+        body = content_for('body', i).join("\n")
+        extended = content_for('extended', i).join("\n")
+        category = content_for('category', i).join(" ")
+        tags = content_for('tags', i).join(", ")
+        erb = File.open(template, "rb").read
+        r = ERB.new(erb, 0, '<>') if erb
+        b = binding
+        rendered << r.result(b)
+      end
+      rendered.join("--------\n")
+    end
+    
+  end
+end

data/lib/movable_erb/templates/default.erb

@@ -0,0 +1,21 @@
+TITLE: <%= title %>
+<% if category && !category.empty? %>
+CATEGORY: <%= category %>
+<% end %>
+<% if tags && !tags.empty? %>
+TAGS: <%= tags %>
+<% end %>
+-----
+BODY:
+
+<%= body %>
+
+
+<% unless extended.nil? || extended.empty? %>
+-----
+EXTENDED:
+
+<%= extended %>
+
+
+<% end %>

data/movable_erb.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{movable_erb}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Davey"]
+  s.date = %q{2009-04-18}
+  s.default_executable = %q{movable_erb}
+  s.description = %q{Usage: movable_erb [options]}
+  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.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"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    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"])
+    else
+      s.add_dependency(%q<fastercsv>, [">= 0"])
+      s.add_dependency(%q<bones>, [">= 2.5.0"])
+    end
+  else
+    s.add_dependency(%q<fastercsv>, [">= 0"])
+    s.add_dependency(%q<bones>, [">= 2.5.0"])
+  end
+end

data/spec/csv_spec.rb

@@ -0,0 +1,73 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe MovableErb::Csv do
+  describe "intialization" do
+
+    before(:each) do
+      @csv = MovableErb::Csv.new({:file => 'example.csv'})
+    end
+
+    it "should accept arguments" do
+      @csv.should_not be_nil
+    end
+
+    it "should have @file attribute match passed in value" do
+      @csv.file.should eql('./example.csv')
+    end
+    
+    it "should allow files in sub-folders" do
+      @csv = MovableErb::Csv.new({:file => 'subfolder/example.csv'})
+      @csv.file.should eql('./subfolder/example.csv')
+    end
+    
+    it "should recognize the dot as current folder" do
+      @csv = MovableErb::Csv.new({:file => './example.csv'})
+      @csv.file.should eql('./example.csv')
+    end
+
+  end
+  
+  describe "opening the file" do
+    before(:each) do
+      @file_to_open = File.join(File.dirname(__FILE__), 'fixtures', 'example.csv')
+      @csv = MovableErb::Csv.new({:file => @file_to_open})
+    end
+
+    it "should find the file" do
+      File.open(@file_to_open).should_not be_nil
+    end
+
+    it "should populate rows" do
+      @csv.rows.should_not be_nil
+    end
+  end
+  
+  describe "rows" do
+    before(:each) do
+      @file_to_open = File.join(File.dirname(__FILE__), 'fixtures', 'example.csv')
+      @csv = MovableErb::Csv.new({:file => @file_to_open})
+    end
+
+    it "should be an array of arrays" do
+      @csv.rows.should be_instance_of(Array)
+      @csv.rows.each do |row|
+        row.should be_instance_of(Array)
+      end
+    end
+
+    it "should have a header row" do
+      @csv.header.should eql(['Name','Phone','Email'])
+    end
+
+    it "should exclude header from data" do
+      @csv.data.first.should_not eql(['Name','Phone','Email'])
+    end
+    
+    it "should should have data" do
+      @csv.data.first.should eql(['John','773-123-1234','john@example.com'])
+    end
+  end
+end
+
+# EOF

data/spec/fixtures/example.csv

@@ -0,0 +1,5 @@
+Name,Phone,Email
+John,773-123-1234,john@example.com
+Abigail,,abby@example.com
+Bernard,903-294-3921,
+Casius,,

data/spec/movable_erb_spec.rb

@@ -0,0 +1,10 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe MovableErb do
+  it "should have class Csv" do
+    MovableErb::Csv.should_not be_nil
+  end
+end
+
+# EOF

data/spec/mtimport_spec.rb

@@ -0,0 +1,173 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe MovableErb::MTImport do
+
+  it "should exist" do
+    MovableErb::MTImport.should_not be_nil
+  end
+
+  describe "initialization" do
+    before(:each) do
+      @mt = MovableErb::MTImport.new(:csv => {:file => 'does_not_exist.csv'})
+      @mt.csv.stub!(:header).and_return(['Title','Body'])
+      @mt.setup_column_nums
+    end
+
+    it "should have a title column in first column by default" do
+      @mt.columns[:title].should eql([0])
+    end
+
+    it "should have a body column in second column by default" do
+      @mt.columns[:body].should eql([1])
+    end
+  end
+  
+  describe "with non-default order of header rows" do
+    before(:each) do
+      @mt = MovableErb::MTImport.new(:csv => {:file => 'does_not_exist.csv'})
+      @mt.csv.stub!(:header).and_return(['Body','Title'])
+      @mt.setup_column_nums
+    end
+
+    it "should find and correctly assign the title column" do
+      @mt.columns[:title].should eql([1])
+    end
+    
+    it "should find and correctly assign the body column" do
+      @mt.columns[:body].should eql([0])
+    end
+  end
+  
+  describe "joining field titles with same name" do
+    before(:each) do
+      @mt = MovableErb::MTImport.new(:csv => {:file => 'does_not_exist.csv'})
+      @mt.csv.stub!(:header).and_return(['Title','Body','Body'])
+      @mt.csv.stub!(:body).and_return([['A Title', 'Part of the body','is right here'],['Title 2', 'Body 2','is right here']])
+      @mt.setup_column_nums
+    end
+
+    it "should find more than one element with Body if given" do
+      @mt.columns[:body].should eql([1,2])
+      @mt.content_for('body',0).should eql(['Part of the body','is right here'])
+      @mt.content_for('body',1).should eql(['Body 2','is right here'])
+    end
+    
+    
+    it "should render with a template file" do
+      @mt.render_with_template.should eql( 
+      %q{TITLE: A Title
+      -----
+      BODY:
+
+      Part of the body
+      is right here
+
+      --------
+      TITLE: Title 2
+      -----
+      BODY:
+
+      Body 2
+      is right here
+
+      }.gsub(/^ +/,'') )
+    end
+  end
+  
+  describe "non-default fields" do
+    before(:each) do
+      @mt = MovableErb::MTImport.new(:csv => {:file => 'spec/fixtures/example.csv'})
+      @mt.csv.stub!(:header).and_return(['Title','Body','Category',"Extended"])
+      @mt.csv.stub!(:body).and_return([['A Title', 'Part of the body','Articles','Another field'],['Title 2', 'Body 2','Articles','field 2']])
+      @mt.setup_column_nums
+    end
+
+    it "should recognize an extended field" do
+      @mt.columns[:extended].should_not be_nil
+      @mt.columns[:extended].should be_instance_of(Array)
+      @mt.columns[:extended].should eql([3])
+    end
+    
+    it "should recognize the category field" do
+      @mt.columns[:category].should_not be_nil
+      @mt.columns[:category].should be_instance_of(Array)
+      @mt.columns[:category].should eql([2])
+    end
+    
+    it "should correctly render" do
+      @mt.render_with_template.should eql(
+      %q{TITLE: A Title
+      CATEGORY: Articles
+      -----
+      BODY:
+
+      Part of the body
+      
+      -----
+      EXTENDED:
+      
+      Another field
+      
+      --------
+      TITLE: Title 2
+      CATEGORY: Articles
+      -----
+      BODY:
+      
+      Body 2
+      
+      -----
+      EXTENDED:
+      
+      field 2
+      
+      }.gsub(/^ +/,''))
+    end
+  end
+  
+  describe "tags" do
+    before(:each) do
+      @mt = MovableErb::MTImport.new(:csv => {:file => 'spec/fixtures/example.csv'})
+      @mt.csv.stub!(:header).and_return(['Title','Body','Tags'])
+      @mt.csv.stub!(:body).and_return([['A Title', 'Body content','dog, cats, mice']])
+      @mt.setup_column_nums
+    end
+    
+    it "should recognize tags" do
+      @mt.columns[:tags].should_not be_nil
+    end
+    
+    it "should render correctly" do
+      @mt.render_with_template.should eql(
+      %q{TITLE: A Title
+      TAGS: dog, cats, mice
+      -----
+      BODY:
+
+      Body content
+      
+      }.gsub(/^ +/,''))
+    end
+  end
+  
+  describe "when header column is not named/misnamed" do
+    before(:each) do
+      @mt = MovableErb::MTImport.new(:csv => {:file => 'spec/fixtures/example.csv'})
+      @mt.csv.stub!(:header).and_return(['Name','Address','Nothing'])
+      @mt.csv.stub!(:body).and_return([['John Boy', '123 Nowhere Lane','dog, cats, mice']])
+      @mt.setup_column_nums
+    end
+    
+    it "should default the first field to title" do
+      @mt.columns[:title].should_not be_nil
+      @mt.columns[:title].should eql([0])
+    end
+    
+    it "should default the second field to body" do
+      @mt.columns[:body].should_not be_nil
+      @mt.columns[:body].should eql([1])
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'fastercsv'
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib movable_erb]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+
+# EOF

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: jgdavey-movable_erb
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Joshua Davey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-18 00:00:00 -07:00
+default_executable: movable_erb
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+    version: 
+description: "Usage: movable_erb [options]"
+email: josh@joshuadavey.com
+executables: 
+- movable_erb
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- bin/movable_erb
+- lib/movable_erb/templates/default.erb
+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
+has_rdoc: true
+homepage: http://github.com/jgdavey/movable_erb/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.textile
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: movable_erb
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A simple CSV to MTImport conversion utility
+test_files: 
+- test/test_movable_erb.rb