├── .gitignore
├── .travis.yml
├── LICENSE.md
├── README.md
├── pom.xml
└── src
    ├── main
        ├── java
        │   └── com
        │   │   └── msiops
        │   │       └── premailer
        │   │           ├── Premailer.java
        │   │           └── PremailerInterface.java
        └── ruby
        │   └── premailer
        │       └── premailer_contact.rb
    └── test
        └── java
            └── com
                └── msiops
                    └── premailer
                        ├── PremailerInlineHTMLTest.java
                        └── PremailerPlainTextTest.java


/.gitignore:
--------------------------------------------------------------------------------
 1 | # Created by .ignore support plugin (hsz.mobi)
 2 | ### Maven template
 3 | target/
 4 | pom.xml.tag
 5 | pom.xml.releaseBackup
 6 | pom.xml.versionsBackup
 7 | pom.xml.next
 8 | release.properties
 9 | dependency-reduced-pom.xml
10 | buildNumber.properties
11 | .mvn/timing.properties
12 | 
13 | 
14 | ### Java template
15 | *.class
16 | 
17 | # Mobile Tools for Java (J2ME)
18 | .mtj.tmp/
19 | 
20 | # Package Files #
21 | *.jar
22 | *.war
23 | *.ear
24 | 
25 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
26 | hs_err_pid*
27 | 
28 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: java
2 | jdk:
3 |   - oraclejdk8


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | Copyright 2015 Matthew de Detrich, mdedetrich@gmail.com
 2 | 
 3 | Licensed under the Apache License, Version 2.0 (the "License");
 4 | you may not use this file except in compliance with the License.
 5 | You may obtain a copy of the License at
 6 | 
 7 |     http://www.apache.org/licenses/LICENSE-2.0
 8 | 
 9 | Unless required by applicable law or agreed to in writing, software
10 | distributed under the License is distributed on an "AS IS" BASIS,
11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | See the License for the specific language governing permissions and
13 | limitations under the License.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Java Premailer Wrapper
 2 | 
 3 | [![Maven Central](https://img.shields.io/maven-central/v/org.mdedetrich/java-premailer-wrapper?label=java-premailer-wrapper%40maven-central)](https://maven-badges.herokuapp.com/maven-central/org.mdedetrich/java-premailer-wrapper)
 4 | 
 5 | ## What is this?
 6 | 
 7 | This java wrapper around [Premailer](https://github.com/premailer/premailer). It is roughly based on the
 8 | wrapper from [here](https://github.com/r-shah/java-premailer-wrapper), with a few important differences
 9 | 
10 | - It works
11 | - Premailer is brought in as a dependency rather than being directly included in the source. This allows you
12 | to easily bump Premailer as a dependency
13 | - Added a method that allows you to terminate a Premailer instance (`PremailerInterface.destroyInstance`)
14 | - A fix for JDK 1.8 in regards to conflicts for `.merge ` method (see [here](https://github.com/jruby/jruby/issues/1249))
15 | - The `Premailer` class no longer acts like a pseudo singleton. Its up to the user to manage the instance (typically you
16 | would store this in a Singleton to reuse the `PremailerInstance`)
17 | - Uses a versioning scheme to identify between Premailer releases, i.e. 1.0_1.8.7 means version 1 using Premailer 1.8.7
18 | 
19 | ## Dependency Info
20 | 
21 | Currently hosted on maven central, with the following details
22 | 
23 | ```xml
24 | <dependency>
25 | 	  <groupId>org.mdedetrich</groupId>
26 | 	  <artifactId>java-premailer-wrapper</artifactId>
27 | 	  <version>1.3_1.8.7</version>
28 | </dependency>
29 | ```
30 | 
31 | If you haven't already done so, you need to add the `Rubygems` maven repository, i.e.
32 | 
33 | ```xml
34 | <repository>
35 |     <id>rubygems-releases</id>
36 |     <url>http://rubygems-proxy.torquebox.org/releases</url>
37 | </repository>
38 | ```
39 | 
40 | ## Building
41 | 
42 | You can build a jar by doing
43 | 
44 | ```
45 | mvn compile
46 | mvn package
47 | ```
48 | 
49 | ## Usage
50 | 
51 | To use, do something like this
52 | 
53 | ```java
54 | String testHtml = "<html><head></head><body><p>test</p></body></html>";
55 | 
56 | // Create a Premailer
57 | Premailer premailer = new Premailer()
58 | 
59 | // Get the instance
60 | PremailerInterface premailerInterface = premailer.getPremailerInstance();
61 |     
62 | // Pass your options in form of HashMap
63 | Map<String, Object> options = new HashMap<String, Object>( );
64 |     
65 | // Pass at least this option for html string
66 | options.put( "with_html_string", true );
67 |     
68 | System.out.print( premailerInterface.plain_text(testHtml, options) );
69 | System.out.print( premailerInterface.inline_css(testHtml, options) );
70 |     
71 | // Shut it down
72 | premailer.destroyInstance();     
73 | ```
74 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
  1 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  3 |     <modelVersion>4.0.0</modelVersion>
  4 |     <groupId>org.mdedetrich</groupId>
  5 |     <artifactId>java-premailer-wrapper</artifactId>
  6 |     <packaging>jar</packaging>
  7 |     <version>1.3_1.8.7</version>
  8 |     <name>java-premailer-wrapper</name>
  9 |     <description>java-premailer-wrapper</description>
 10 |     <url>https://github.com/mdedetrich/java-premailer-wrapper</url>
 11 |     <licenses>
 12 |         <license>
 13 |             <name>Apache-2</name>
 14 |             <url>http://opensource.org/licenses/Apache-2.0</url>
 15 |             <distribution>repo</distribution>
 16 |         </license>
 17 |     </licenses>
 18 |     <scm>
 19 |         <url>git@github.com:mdedetrich/java-premailer-wrapper.git</url>
 20 |         <connection>scm:git:git@github.com:mdedetrich/java-premailer-wrapper.git</connection>
 21 |     </scm>
 22 |     <developers>
 23 |         <developer>
 24 |             <id>mdedetrich</id>
 25 |             <name>Matthew de Detrich</name>
 26 |             <email>mdedetrich@gmail.com</email>
 27 |         </developer>
 28 |     </developers>
 29 |     <repositories>
 30 |         <repository>
 31 |             <id>rubygems-proxy</id>
 32 |             <name>Rubygems Proxy</name>
 33 |             <url>http://rubygems-proxy.torquebox.org/releases</url>
 34 |             <layout>default</layout>
 35 |             <releases>
 36 |                 <enabled>true</enabled>
 37 |             </releases>
 38 |             <snapshots>
 39 |                 <enabled>false</enabled>
 40 |                 <updatePolicy>never</updatePolicy>
 41 |             </snapshots>
 42 |         </repository>
 43 |     </repositories>
 44 |     <build>
 45 |         <plugins>
 46 |             <plugin>
 47 |                 <groupId>org.apache.maven.plugins</groupId>
 48 |                 <artifactId>maven-compiler-plugin</artifactId>
 49 |                 <version>3.3</version>
 50 |                 <configuration>
 51 |                     <source>1.8</source>
 52 |                     <target>1.8</target>
 53 |                 </configuration>
 54 |             </plugin>
 55 | 
 56 |             <plugin>
 57 |                 <groupId>de.saumya.mojo</groupId>
 58 |                 <artifactId>gem-maven-plugin</artifactId>
 59 |                 <version>1.0.10</version>
 60 |                 <configuration>
 61 |                     <includeRubygemsInResources>true</includeRubygemsInResources>
 62 |                 </configuration>
 63 |                 <executions>
 64 |                     <execution>
 65 |                         <goals>
 66 |                             <goal>initialize</goal>
 67 |                         </goals>
 68 |                     </execution>
 69 |                 </executions>
 70 |             </plugin>
 71 |             <plugin>
 72 |                 <groupId>org.apache.maven.plugins</groupId>
 73 |                 <artifactId>maven-gpg-plugin</artifactId>
 74 |                 <version>1.6</version>
 75 |                 <executions>
 76 |                     <execution>
 77 |                         <id>sign-artifacts</id>
 78 |                         <phase>verify</phase>
 79 |                         <goals>
 80 |                             <goal>sign</goal>
 81 |                         </goals>
 82 |                     </execution>
 83 |                 </executions>
 84 |             </plugin>
 85 |             <plugin>
 86 |                 <groupId>org.apache.maven.plugins</groupId>
 87 |                 <artifactId>maven-source-plugin</artifactId>
 88 |                 <version>3.2.1</version>
 89 |                 <executions>
 90 |                     <execution>
 91 |                         <id>attach-sources</id>
 92 |                         <goals>
 93 |                             <goal>jar</goal>
 94 |                         </goals>
 95 |                     </execution>
 96 |                 </executions>
 97 |             </plugin>
 98 |             <plugin>
 99 |                 <groupId>org.apache.maven.plugins</groupId>
100 |                 <artifactId>maven-javadoc-plugin</artifactId>
101 |                 <version>3.3.0</version>
102 |                 <executions>
103 |                     <execution>
104 |                         <id>attach-javadocs</id>
105 |                         <goals>
106 |                             <goal>jar</goal>
107 |                         </goals>
108 |                     </execution>
109 |                 </executions>
110 |             </plugin>
111 |         </plugins>
112 |     </build>
113 | 
114 |     <dependencies>
115 |         <dependency>
116 |             <groupId>junit</groupId>
117 |             <artifactId>junit</artifactId>
118 |             <version>4.12</version>
119 |             <scope>test</scope>
120 |         </dependency>
121 |         <dependency>
122 |             <groupId>org.databene</groupId>
123 |             <artifactId>contiperf</artifactId>
124 |             <version>2.2.0</version>
125 |             <scope>test</scope>
126 |         </dependency>
127 |         <dependency>
128 |             <groupId>org.jruby</groupId>
129 |             <artifactId>jruby</artifactId>
130 |             <version>9.1.2.0</version>
131 |         </dependency>
132 |         <dependency>
133 |             <groupId>rubygems</groupId>
134 |             <artifactId>premailer</artifactId>
135 |             <version>1.8.7</version>
136 |             <type>gem</type>
137 |         </dependency>
138 |         <dependency>
139 |             <groupId>rubygems</groupId>
140 |             <artifactId>nokogiri</artifactId>
141 |             <version>1.6.8</version>
142 |             <type>gem</type>
143 |         </dependency>
144 |         <dependency>
145 |             <groupId>rubygems</groupId>
146 |             <artifactId>htmlentities</artifactId>
147 |             <version>4.3.4</version>
148 |             <type>gem</type>
149 |         </dependency>
150 |         <dependency>
151 |             <groupId>rubygems</groupId>
152 |             <artifactId>css_parser</artifactId>
153 |             <version>1.4.5</version>
154 |             <type>gem</type>
155 |         </dependency>
156 |         <dependency>
157 |             <groupId>rubygems</groupId>
158 |             <artifactId>addressable</artifactId>
159 |             <version>2.8.0</version>
160 |             <type>gem</type>
161 |         </dependency>
162 |         <dependency>
163 |             <groupId>rubygems</groupId>
164 |             <artifactId>public_suffix</artifactId>
165 |             <version>4.0.6</version>
166 |             <type>gem</type>
167 |         </dependency>
168 |     </dependencies>
169 |     <distributionManagement>
170 |         <repository>
171 |             <id>deployment</id>
172 |             <name>releases</name>
173 |             <url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
174 |         </repository>
175 |         <snapshotRepository>
176 |             <id>deployment</id>
177 |             <name>snapshots</name>
178 |             <url>https://oss.sonatype.org/content/repositories/snapshots</url>
179 |         </snapshotRepository>
180 |     </distributionManagement>
181 | </project>
182 | 


--------------------------------------------------------------------------------
/src/main/java/com/msiops/premailer/Premailer.java:
--------------------------------------------------------------------------------
 1 | package com.msiops.premailer;
 2 | 
 3 | import org.jruby.embed.PathType;
 4 | import org.jruby.embed.ScriptingContainer;
 5 | 
 6 | /**
 7 |  * Class that holds the Premailer Interface instance
 8 |  */
 9 | 
10 | public final class Premailer {
11 |     
12 |     private ScriptingContainer container;
13 |     private PremailerInterface instance;
14 |     private Boolean customContainer = false;
15 |     private Boolean terminated = false;
16 |     
17 |     private static String path = "premailer/premailer_contact.rb";
18 | 
19 |     /**
20 |      * Creates a new Premailer. Note that you only need to create this once, its recommended you
21 |      * store this in a Singleton so you reuse it for multiple calls
22 |      */
23 |     
24 |     public Premailer(){
25 |         container = new ScriptingContainer();
26 |         container.setClassLoader(container.getClass().getClassLoader());
27 |         Object receiver = container.runScriptlet(PathType.CLASSPATH, path);
28 |         
29 |         // Create instance of premailer interface
30 |         instance = container.getInstance( receiver,
31 |                 PremailerInterface.class );
32 |     }
33 | 
34 |     /**
35 |      * Creates a Premailer out of an already existing JRuby Scripting Container. Useful if you already use
36 |      * JRuby elsewhere in your application
37 |      * @param container The container for Premailer to use
38 |      */
39 |     
40 |     public Premailer(ScriptingContainer container){
41 |         if (container == null) {
42 |             throw new IllegalArgumentException();
43 |         } else {
44 |             this.container = container;
45 |             customContainer = true;
46 |             Object receiver = container.runScriptlet(PathType.CLASSPATH, path);
47 |             instance = container.getInstance( receiver,
48 |                     PremailerInterface.class );
49 |         }
50 |     }
51 | 
52 |     /**
53 |      * Retrieves a Premailer instance, use this to interface with Premailer
54 |      * @return The Premailer Instance
55 |      */
56 |     
57 |     public PremailerInterface getPremailerInstance() {
58 |         return instance;
59 |     }
60 | 
61 |     /**
62 |      * Returns the JRuby Scripting Container, shouldn't really need this
63 |      * @return JRuby Scripining Container
64 |      */
65 |     
66 |     public ScriptingContainer getScriptingContainer() {
67 |         return container;
68 |     }
69 | 
70 |     /**
71 |      * Whether or not the Premailer was created with a custom Scripting Container
72 |      * @return Premailer created with custom scripting container
73 |      */
74 |     
75 |     public Boolean usesCustomScriptingContainer() {
76 |         return customContainer;
77 |     }
78 | 
79 |     /**
80 |      * Destroy's a the permailer instance
81 |      */
82 |     
83 |     public void destroyInstance() {
84 |         if (terminated) {
85 |             throw new IllegalArgumentException("Premailer already terminated");
86 |         }
87 |         
88 |         if (instance != null) {
89 |             instance = null;
90 |         }
91 |         
92 |         if (container != null) {
93 |             container.terminate();
94 |             terminated = true;
95 |         }
96 |     }
97 | }
98 | 
99 | 


--------------------------------------------------------------------------------
/src/main/java/com/msiops/premailer/PremailerInterface.java:
--------------------------------------------------------------------------------
 1 | package com.msiops.premailer;
 2 | 
 3 | import java.util.Map;
 4 | 
 5 | public interface PremailerInterface {
 6 | 
 7 |     String inline_css( String html, Map<String, Object> options );
 8 | 
 9 |     String plain_text( String html, Map<String, Object> options );
10 | }
11 | 
12 | 


--------------------------------------------------------------------------------
/src/main/ruby/premailer/premailer_contact.rb:
--------------------------------------------------------------------------------
 1 | require "java"
 2 | require "premailer"
 3 | require "jruby/synchronized"
 4 | 
 5 | #$CLASSPATH << 'target/classes';
 6 | java_import "com.msiops.premailer.PremailerInterface"
 7 | 
 8 | # see https://github.com/jruby/jruby/issues/1249
 9 | 
10 | if ENV_JAVA['java.specification.version'] >= '1.8'
11 |   class Java::JavaUtil::HashMap
12 |     def merge(other)
13 |       dup.merge!(other)
14 |     end
15 |   end
16 | end
17 | 
18 | class PremailerContact
19 |   include PremailerInterface
20 |   include JRuby::Synchronized
21 | 
22 |   def initialize
23 |   end
24 | 
25 |   def init(html, options)
26 |     options.keys.each do |key|
27 |       options[(key.to_sym rescue key) || key] = options.delete(key)
28 |     end
29 | 
30 |     @defaultOption = {:adapter => :nokogiri, :input_encoding => 'UTF-8', }
31 | 
32 |     return Premailer.new(html, options.merge(@defaultOption))
33 |   end
34 | 
35 | 
36 |   def inline_css(html, options)
37 |     return init(html, options).to_inline_css
38 |   end
39 | 
40 | 
41 |   def plain_text(html, options)
42 |     return init(html, options).to_plain_text
43 |   end
44 | 
45 | end
46 | 
47 | PremailerContact.new
48 | 


--------------------------------------------------------------------------------
/src/test/java/com/msiops/premailer/PremailerInlineHTMLTest.java:
--------------------------------------------------------------------------------
 1 | package com.msiops.premailer;
 2 | 
 3 | import static org.hamcrest.CoreMatchers.*;
 4 | import static org.junit.Assert.*;
 5 | 
 6 | import java.util.HashMap;
 7 | import java.util.Map;
 8 | 
 9 | import org.databene.contiperf.PerfTest;
10 | import org.databene.contiperf.junit.ContiPerfRule;
11 | import org.junit.Rule;
12 | import org.junit.Test;
13 | 
14 | import com.msiops.premailer.Premailer;
15 | import com.msiops.premailer.PremailerInterface;
16 | 
17 | public class PremailerInlineHTMLTest {
18 | 
19 |     @Rule
20 |     public final ContiPerfRule i = new ContiPerfRule();
21 | 
22 |     final PremailerInterface premailer = new Premailer().getPremailerInstance();
23 | 
24 |     @Test
25 |     public void shouldInlineCss() throws Exception {
26 |         final String html = "<html><head><style>body{ margin: 0; }</style></head><body></body></html>";
27 | 
28 |         final Map<String, Object> options = new HashMap<>();
29 |         options.put("with_html_string", true);
30 | 
31 |         final String inline = premailer.inline_css(html, options);
32 | 
33 |         assertThat(inline, is(notNullValue()));
34 |         assertThat(inline, is("<html><head></head><body style=\"margin: 0;\"><style type=\"text/css\">\nbody {\nmargin: 0;\n}\n</style></body></html>"));
35 |     }
36 | 
37 |     @PerfTest(invocations = 1000, threads = 5)
38 |     @Test
39 |     public void shouldInlineCSSInThreadSafeManner() throws Exception {
40 |         final String html = "<html><head><style>body{ margin: 0; }</style></head><body></body></html>";
41 | 
42 |         final Map<String, Object> options = new HashMap<>();
43 |         options.put("with_html_string", true);
44 | 
45 |         final String inline = premailer.inline_css(html, options);
46 | 
47 |         assertThat(inline, is(notNullValue()));
48 |         assertThat(inline, is("<html><head></head><body style=\"margin: 0;\"><style type=\"text/css\">\nbody {\nmargin: 0;\n}\n</style></body></html>"));
49 |     }
50 | 
51 | }
52 | 


--------------------------------------------------------------------------------
/src/test/java/com/msiops/premailer/PremailerPlainTextTest.java:
--------------------------------------------------------------------------------
 1 | package com.msiops.premailer;
 2 | 
 3 | import static org.hamcrest.CoreMatchers.*;
 4 | import static org.junit.Assert.*;
 5 | 
 6 | import java.util.HashMap;
 7 | import java.util.Map;
 8 | 
 9 | import org.databene.contiperf.PerfTest;
10 | import org.databene.contiperf.junit.ContiPerfRule;
11 | import org.junit.Rule;
12 | import org.junit.Test;
13 | 
14 | import com.msiops.premailer.Premailer;
15 | import com.msiops.premailer.PremailerInterface;
16 | 
17 | public class PremailerPlainTextTest {
18 | 
19 |     @Rule
20 |     public final ContiPerfRule i = new ContiPerfRule();
21 | 
22 |     final PremailerInterface premailer = new Premailer().getPremailerInstance();
23 | 
24 |     @Test
25 |     public void shouldPlainText() throws Exception {
26 |         final String html = "<html><head><style>body{ margin: 0; }</style></head><body>Sample Text</body></html>";
27 | 
28 |         final Map<String, Object> options = new HashMap<>();
29 |         options.put("with_html_string", true);
30 | 
31 |         final String inline = premailer.plain_text(html, options);
32 | 
33 |         assertThat(inline, is(notNullValue()));
34 |         assertThat(inline, is("Sample Text"));
35 |     }
36 | 
37 |     @PerfTest(invocations = 1000, threads = 5)
38 |     @Test
39 |     public void shouldPlainTextInThreadSafeManner() throws Exception {
40 |         final String html = "<html><head><style>body{ margin: 0; }</style></head><body>Sample Text</body></html>";
41 | 
42 |         final Map<String, Object> options = new HashMap<>();
43 |         options.put("with_html_string", true);
44 | 
45 |         final String inline = premailer.plain_text(html, options);
46 | 
47 |         assertThat(inline, is(notNullValue()));
48 |         assertThat(inline, is("Sample Text"));
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------