mailchimp_template 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcfb5a972fbc33a6fd8eab0bda3ec2da9a440736
+  data.tar.gz: 7790c29cfdbe7c57861ebc6cf23d598c257d2b57
+SHA512:
+  metadata.gz: 9b273a3c7ea7303624e89a87e0dc8d137d21fcc8840be1df928282134d1e6575a720487134e161443bc9fd1bb4f1ba824097709ce88ea6203c5e5723c92527be
+  data.tar.gz: 53f4545ad303a40fc082978f3c385ed261ae83a84b09844a13c3324d823bba38b8fb512932594bf3fc8fb2490f6e92e616c4c01550eb8bc39009b0155999d88d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mailchimp_template.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Steven Karas
+
+MIT License
+
+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.md

@@ -0,0 +1,50 @@
+# MailchimpTemplate
+
+Ruby implementation of [Mailchimp's Template Language][mc-template-language]. Not everything works, but I'll add more support as I get requests.
+
+[mc-template-language]: http://kb.mailchimp.com/templates/code/getting-started-with-mailchimps-template-language "Mailchimp Template Langauge Official Documentation"
+
+## Currently Supported Features
+
+- [x] Generic Merge Tags
+- [ ] System Merge Tags
+- [ ] Conditional Merge Tags
+- [x] Editable regions
+- [ ] Repeatable regions
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mailchimp_template'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mailchimp_template
+
+## Usage
+
+
+```ruby
+template = MailchimpTemplate.new("hello, *|MERGETAG|*")
+template.render(merge_tags: {"MERGETAG" => "world"})
+```
+
+### Editable regions
+
+```ruby
+template = MailchimpTemplate.new('hello, <div mc:edit="body">lorem ipsum</body>')
+template.render(regions: { "body" => "world" })
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/stevenkaras/mailchimp_template/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/mailchimp_template/version.rb

@@ -0,0 +1,3 @@
+class MailchimpTemplate
+  VERSION = "1.0.0"
+end

data/lib/mailchimp_template.rb

@@ -0,0 +1,45 @@
+require File.expand_path("mailchimp_template/version", __dir__)
+
+require "nokogiri"
+
+class MailchimpTemplate
+  def initialize(template)
+    @template = template
+  end
+
+  def render(merge_tags: {}, regions: {})
+    html = Nokogiri::HTML::DocumentFragment.parse(@template)
+    html.css("*").select { |n| n.attr("mc:edit") }.each do |editable_region|
+      editable_region.children = Nokogiri::HTML::DocumentFragment.parse(regions[editable_region.attr("mc:edit")])
+      editable_region.remove_attribute("mc:edit")
+    end
+    result = html.to_s
+
+    result.gsub! /\*\|(?<tag_name>.+?)\|\*/ do |match|
+      case $~[:tag_name]
+      when /^IF:(?<cond>.+)/, /^IFNOT:(?<cond>.+)/, /^ELSEIF:(?<cond>.+)/, "ELSE:", "END:IF"
+        #TODO: handle conditional merge tags
+        match
+      when "MC:TOC"
+        #TODO: generate TOC of h1 and h2 tags
+        match
+      when "MC:TOC_TEXT"
+        #TODO: generate TOC of h1 and h2 tags, render as text
+        match
+      when /^DATE:(?<format>.+)/
+        #TODO: render with PHP date format (nontrivial, requires a custom parser)
+        match
+      when "CURRENT_YEAR"
+        Date.today.year
+      else
+        merge_tags[$~[:tag_name]] || match
+      end
+    end
+
+    return result
+  end
+
+  def merge_tags
+    @template.scan(/\*\|(?<tag_name>.+?)\|\*/).flatten
+  end
+end

data/mailchimp_template.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailchimp_template/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mailchimp_template"
+  spec.version       = MailchimpTemplate::VERSION
+  spec.authors       = ["Steven Karas"]
+  spec.email         = ["steven.karas@gmail.com"]
+  spec.summary       = %q{Implementation of Mailchimp Template Language}
+  spec.description   = %q{Implementaiton of Mailchimp Template Language. Not all features are supported, but most are}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "nokogiri", "~> 1.6"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: mailchimp_template
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steven Karas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Implementaiton of Mailchimp Template Language. Not all features are supported,
+  but most are
+email:
+- steven.karas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mailchimp_template.rb
+- lib/mailchimp_template/version.rb
+- mailchimp_template.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Implementation of Mailchimp Template Language
+test_files: []