├── generators ├── resources │ └── leiningen │ │ └── generate │ │ └── namespace │ │ ├── source.clj │ │ └── test.clj ├── project.clj └── src │ └── leiningen │ └── generate │ └── namespace.clj ├── template ├── resources │ └── leiningen │ │ └── new │ │ └── generators │ │ ├── source.clj │ │ ├── gitignore │ │ ├── README.md │ │ ├── project.clj │ │ ├── generate.clj │ │ └── LICENSE ├── project.clj └── src │ └── leiningen │ └── new │ └── generators.clj ├── .gitignore ├── plugin ├── src │ ├── lein_gen │ │ └── plugin.clj │ └── leiningen │ │ ├── generate.clj │ │ └── generate │ │ └── templates.clj └── project.clj └── README.md /generators/resources/leiningen/generate/namespace/source.clj: -------------------------------------------------------------------------------- 1 | (ns {{name}}) 2 | -------------------------------------------------------------------------------- /template/resources/leiningen/new/generators/source.clj: -------------------------------------------------------------------------------- 1 | (ns {{name-var}}) 2 | 3 | ;; FIXME 4 | -------------------------------------------------------------------------------- /generators/resources/leiningen/generate/namespace/test.clj: -------------------------------------------------------------------------------- 1 | (ns {{name}}-test 2 | (:require [clojure.test :refer :all] 3 | [{{name}} :refer :all])) 4 | -------------------------------------------------------------------------------- /template/resources/leiningen/new/generators/gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /classes 3 | /checkouts 4 | pom.xml 5 | pom.xml.asc 6 | *.jar 7 | *.class 8 | /.lein-* 9 | /.nrepl-port -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /generators/target 3 | /template/target 4 | /plugin/target 5 | /classes 6 | /checkouts 7 | pom.xml 8 | pom.xml.asc 9 | *.jar 10 | *.class 11 | /.lein-* 12 | /.nrepl-port 13 | -------------------------------------------------------------------------------- /plugin/src/lein_gen/plugin.clj: -------------------------------------------------------------------------------- 1 | (ns lein-gen.plugin 2 | (:require [leiningen.generate :as g] 3 | [leiningen.core.project :as project])) 4 | 5 | (defn middleware [project] 6 | (project/load-plugins project :generators) 7 | (alter-meta! #'g/generate assoc :subtasks (g/list-generators)) 8 | project) 9 | -------------------------------------------------------------------------------- /plugin/project.clj: -------------------------------------------------------------------------------- 1 | (defproject lein-gen "0.2.1" 2 | :description "Lein plugin for generating files" 3 | :url "https://github.com/weavejester/lein-gen" 4 | :scm {:dir ".."} 5 | :license {:name "Eclipse Public License" 6 | :url "http://www.eclipse.org/legal/epl-v10.html"} 7 | :eval-in-leiningen true) 8 | -------------------------------------------------------------------------------- /template/resources/leiningen/new/generators/README.md: -------------------------------------------------------------------------------- 1 | # {{name}} 2 | 3 | Leiningen generators for FIXME. 4 | 5 | ## Usage 6 | 7 | FIXME 8 | 9 | ## License 10 | 11 | Copyright © {{year}} FIXME 12 | 13 | Distributed under the Eclipse Public License either version 1.0 or (at 14 | your option) any later version. 15 | -------------------------------------------------------------------------------- /template/project.clj: -------------------------------------------------------------------------------- 1 | (defproject generators/lein-template "0.2.1" 2 | :description "Basic generators for the lein-gen plugin" 3 | :url "https://github.com/weavejester/lein-gen" 4 | :scm {:dir ".."} 5 | :license {:name "Eclipse Public License" 6 | :url "http://www.eclipse.org/legal/epl-v10.html"} 7 | :eval-in-leiningen true) 8 | -------------------------------------------------------------------------------- /template/resources/leiningen/new/generators/project.clj: -------------------------------------------------------------------------------- 1 | (defproject {{name}} "0.1.0-SNAPSHOT" 2 | :description "FIXME: write description" 3 | :url "http://example.com/FIXME" 4 | :license {:name "Eclipse Public License" 5 | :url "http://www.eclipse.org/legal/epl-v10.html"} 6 | :eval-in-leiningen true 7 | :dependencies [[lein-gen "0.2.1"]] 8 | :profiles {:dev {:plugins [[lein-gen "0.2.1"]]}}) 9 | -------------------------------------------------------------------------------- /generators/project.clj: -------------------------------------------------------------------------------- 1 | (defproject lein-gen/generators "0.2.1" 2 | :description "A basic set of generators for lein-gen" 3 | :url "https://github.com/weavejester/lein-gen" 4 | :scm {:dir ".."} 5 | :license {:name "Eclipse Public License" 6 | :url "http://www.eclipse.org/legal/epl-v10.html"} 7 | :eval-in-leiningen true 8 | :dependencies [[lein-gen "0.2.1"]] 9 | :profiles {:dev {:plugins [[lein-gen "0.2.1"]]}}) 10 | -------------------------------------------------------------------------------- /template/resources/leiningen/new/generators/generate.clj: -------------------------------------------------------------------------------- 1 | (ns leiningen.generate.{{name}} 2 | (:require [leiningen.generate.templates :refer [renderer ->files]] 3 | [leiningen.new.templates :refer [name-to-path render-text]] 4 | [leiningen.core.main :as main])) 5 | 6 | (def render (renderer "{{name}}")) 7 | 8 | (defn {{name}} 9 | "FIXME: write documentation" 10 | [project name] 11 | (let [data {:name name, :sanitized (name-to-path name)}] 12 | (main/info (render-text "Creating src/{{sanitized-var}}.clj" data)) 13 | (->files data ["src/{{sanitized-var}}.clj" (render "source.clj" data)]))) 14 | -------------------------------------------------------------------------------- /generators/src/leiningen/generate/namespace.clj: -------------------------------------------------------------------------------- 1 | (ns leiningen.generate.namespace 2 | (:refer-clojure :exclude [namespace]) 3 | (:require [leiningen.generate.templates :as tmpl] 4 | [leiningen.new.templates :refer [name-to-path]] 5 | [leiningen.core.main :as main])) 6 | 7 | (defn namespace 8 | "Generate a new namespace and test file." 9 | [project name] 10 | (let [data {:name name, :sanitized (name-to-path name)}] 11 | (doto (tmpl/renderer "namespace") 12 | (tmpl/create-file "source.clj" "src/{{sanitized}}.clj" data) 13 | (tmpl/create-file "test.clj" "test/{{sanitized}}_test.clj" data)))) 14 | -------------------------------------------------------------------------------- /template/src/leiningen/new/generators.clj: -------------------------------------------------------------------------------- 1 | (ns leiningen.new.generators 2 | (:require [leiningen.new.templates :refer [renderer sanitize year ->files]] 3 | [leiningen.core.main :as main])) 4 | 5 | (def render (renderer "generators")) 6 | 7 | (defn generators 8 | "Create a new generators template for lein-generate." 9 | [name] 10 | (let [data {:name name 11 | :name-var "{{name}}" 12 | :sanitized (sanitize name) 13 | :sanitized-var "{{sanitized}}" 14 | :year (year)}] 15 | (main/info "Creating a new generators project called" name) 16 | (->files data 17 | [".gitignore" (render "gitignore" data)] 18 | ["LICENSE" (render "LICENSE" data)] 19 | ["README.md" (render "README.md" data)] 20 | ["project.clj" (render "project.clj" data)] 21 | ["src/leiningen/generate/{{sanitized}}.clj" 22 | (render "generate.clj" data)] 23 | ["resources/leiningen/generate/{{sanitized}}/source.clj" 24 | (render "source.clj" data)]))) 25 | -------------------------------------------------------------------------------- /plugin/src/leiningen/generate.clj: -------------------------------------------------------------------------------- 1 | (ns leiningen.generate 2 | (:require [leiningen.core.project :as project] 3 | [leiningen.core.main :refer [abort parse-options option-arg]] 4 | [leiningen.help :as help] 5 | [bultitude.core :as bultitude])) 6 | 7 | (defn list-generators [] 8 | (for [n (bultitude/namespaces-on-classpath :prefix "leiningen.generate.") 9 | :when (not= n 'leiningen.generate.templates)] 10 | (-> (doto n require) 11 | (the-ns) 12 | (ns-resolve (symbol (last (.split (str n) "\\."))))))) 13 | 14 | (defn resolve-generator [name] 15 | (let [sym (symbol (str "leiningen.generate." name))] 16 | (if (try (require sym) true 17 | (catch java.io.FileNotFoundException _ false)) 18 | (resolve (symbol (str sym "/" name))) 19 | (abort "Could not find generator" name "on the classpath.")))) 20 | 21 | (defn run-generator [project [template & args]] 22 | (apply (resolve-generator template) project args)) 23 | 24 | (defn generate 25 | "Generate files from templates in the current project. 26 | 27 | Generators are run as subtasks: 28 | 29 | lein generate $SUBTASK 30 | 31 | Often generators will require additional arguments: 32 | 33 | lein generate $SUBTASK $ARG_1 $ARG_2 ... $ARG_N" 34 | {:help-arglists '[[project generator & args]]} 35 | [project & args] 36 | (let [[options args] (parse-options args)] 37 | (if (empty? args) 38 | (help/help project "generate") 39 | (run-generator project args)))) 40 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # lein-generate 2 | 3 | A [Leiningen][1] plugin for generating file templates within an existing 4 | project. 5 | 6 | [1]: https://github.com/technomancy/leiningen 7 | 8 | ## Usage 9 | 10 | Add `lein-gen` as a plugin dependency to your project or profiles. 11 | 12 | ```clojure 13 | :plugins [[lein-gen "0.2.1"]] 14 | ``` 15 | 16 | Then add dependencies for the generators you want to use. This plugin 17 | comes with an optional library of simple generators: 18 | 19 | ```clojure 20 | :generators [[lein-gen/generators "0.2.1"]] 21 | ``` 22 | 23 | Included in this library is a namespace generator, which creates a new 24 | source and test file for a given namespace: 25 | 26 | ``` 27 | lein generate namespace bar.core 28 | ``` 29 | 30 | The above example will create two new files: `src/bar/core.clj` and 31 | `test/bar/core_test.clj`. 32 | 33 | To find out the generators you have available, use: 34 | 35 | ``` 36 | lein help generate 37 | ``` 38 | 39 | For help on a specific generator, such as the namespace generator, 40 | use: 41 | 42 | ``` 43 | lein help generate namespace 44 | ``` 45 | 46 | Generators are very similar to Leiningen project templates in both 47 | function and the way they are developed. To create your own library of 48 | generators, start with: 49 | 50 | ``` 51 | lein new generators foo 52 | ``` 53 | 54 | Note the plural of "generators". Unlike templates, there can be many 55 | generators in a library. 56 | 57 | ## License 58 | 59 | Copyright © 2014 James Reeves 60 | 61 | Distributed under the Eclipse Public License either version 1.0 or (at 62 | your option) any later version. 63 | -------------------------------------------------------------------------------- /plugin/src/leiningen/generate/templates.clj: -------------------------------------------------------------------------------- 1 | (ns leiningen.generate.templates 2 | "Functions for handling generator templates that are not in the 3 | leiningen.new.templates namespace." 4 | (:require [leiningen.new.templates :refer [sanitize render-text slurp-resource]] 5 | [clojure.java.io :as io] 6 | [clojure.string :as string] 7 | [leiningen.core.main :as main :refer [*cwd*]])) 8 | 9 | (defn renderer 10 | "Create a renderer function that looks for mustache templates in the 11 | right place given the name of your template. If no data is passed, the 12 | file is simply slurped and the content returned unchanged. 13 | 14 | Functionally the same as leiningen.new.templates/renderer, except 15 | templates are looked for in leiningen/generate rather than leiningen/new." 16 | [name] 17 | (fn [template & [data]] 18 | (let [path (string/join "/" ["leiningen" "generate" (sanitize name) template])] 19 | (if-let [resource (io/resource path)] 20 | (if data 21 | (render-text (slurp-resource resource) data) 22 | (io/reader resource)) 23 | (main/abort (format "Template resource '%s' not found." path)))))) 24 | 25 | (defn ->files 26 | "Generate a file with content. path can be a java.io.File or string. 27 | It will be turned into a File regardless. Any parent directories will 28 | be created automatically." 29 | [data & paths] 30 | (doseq [path paths] 31 | (if (string? path) 32 | (.mkdirs (io/file *cwd* (render-text path data))) 33 | (let [[path content & options] path 34 | path (io/file *cwd* (render-text path data)) 35 | options (apply hash-map options)] 36 | (.mkdirs (.getParentFile path)) 37 | (when (.exists path) 38 | (main/abort (format "File '%s' already exists." path))) 39 | (io/copy content path) 40 | (when (:executable options) 41 | (.setExecutable path true)))))) 42 | 43 | (defn create-file 44 | "Create a new file using a render function, a source template and a map of 45 | data. The file will be placed in a destination path, which may include 46 | template variables." 47 | [render src dest data] 48 | (main/info "Creating" (render-text dest data)) 49 | (->files data [dest (render src data)])) 50 | -------------------------------------------------------------------------------- /template/resources/leiningen/new/generators/LICENSE: -------------------------------------------------------------------------------- 1 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC 2 | LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM 3 | CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. 4 | 5 | 1. DEFINITIONS 6 | 7 | "Contribution" means: 8 | 9 | a) in the case of the initial Contributor, the initial code and 10 | documentation distributed under this Agreement, and 11 | 12 | b) in the case of each subsequent Contributor: 13 | 14 | i) changes to the Program, and 15 | 16 | ii) additions to the Program; 17 | 18 | where such changes and/or additions to the Program originate from and are 19 | distributed by that particular Contributor. A Contribution 'originates' from 20 | a Contributor if it was added to the Program by such Contributor itself or 21 | anyone acting on such Contributor's behalf. Contributions do not include 22 | additions to the Program which: (i) are separate modules of software 23 | distributed in conjunction with the Program under their own license 24 | agreement, and (ii) are not derivative works of the Program. 25 | 26 | "Contributor" means any person or entity that distributes the Program. 27 | 28 | "Licensed Patents" mean patent claims licensable by a Contributor which are 29 | necessarily infringed by the use or sale of its Contribution alone or when 30 | combined with the Program. 31 | 32 | "Program" means the Contributions distributed in accordance with this 33 | Agreement. 34 | 35 | "Recipient" means anyone who receives the Program under this Agreement, 36 | including all Contributors. 37 | 38 | 2. GRANT OF RIGHTS 39 | 40 | a) Subject to the terms of this Agreement, each Contributor hereby grants 41 | Recipient a non-exclusive, worldwide, royalty-free copyright license to 42 | reproduce, prepare derivative works of, publicly display, publicly perform, 43 | distribute and sublicense the Contribution of such Contributor, if any, and 44 | such derivative works, in source code and object code form. 45 | 46 | b) Subject to the terms of this Agreement, each Contributor hereby grants 47 | Recipient a non-exclusive, worldwide, royalty-free patent license under 48 | Licensed Patents to make, use, sell, offer to sell, import and otherwise 49 | transfer the Contribution of such Contributor, if any, in source code and 50 | object code form. This patent license shall apply to the combination of the 51 | Contribution and the Program if, at the time the Contribution is added by the 52 | Contributor, such addition of the Contribution causes such combination to be 53 | covered by the Licensed Patents. The patent license shall not apply to any 54 | other combinations which include the Contribution. No hardware per se is 55 | licensed hereunder. 56 | 57 | c) Recipient understands that although each Contributor grants the licenses 58 | to its Contributions set forth herein, no assurances are provided by any 59 | Contributor that the Program does not infringe the patent or other 60 | intellectual property rights of any other entity. Each Contributor disclaims 61 | any liability to Recipient for claims brought by any other entity based on 62 | infringement of intellectual property rights or otherwise. As a condition to 63 | exercising the rights and licenses granted hereunder, each Recipient hereby 64 | assumes sole responsibility to secure any other intellectual property rights 65 | needed, if any. For example, if a third party patent license is required to 66 | allow Recipient to distribute the Program, it is Recipient's responsibility 67 | to acquire that license before distributing the Program. 68 | 69 | d) Each Contributor represents that to its knowledge it has sufficient 70 | copyright rights in its Contribution, if any, to grant the copyright license 71 | set forth in this Agreement. 72 | 73 | 3. REQUIREMENTS 74 | 75 | A Contributor may choose to distribute the Program in object code form under 76 | its own license agreement, provided that: 77 | 78 | a) it complies with the terms and conditions of this Agreement; and 79 | 80 | b) its license agreement: 81 | 82 | i) effectively disclaims on behalf of all Contributors all warranties and 83 | conditions, express and implied, including warranties or conditions of title 84 | and non-infringement, and implied warranties or conditions of merchantability 85 | and fitness for a particular purpose; 86 | 87 | ii) effectively excludes on behalf of all Contributors all liability for 88 | damages, including direct, indirect, special, incidental and consequential 89 | damages, such as lost profits; 90 | 91 | iii) states that any provisions which differ from this Agreement are offered 92 | by that Contributor alone and not by any other party; and 93 | 94 | iv) states that source code for the Program is available from such 95 | Contributor, and informs licensees how to obtain it in a reasonable manner on 96 | or through a medium customarily used for software exchange. 97 | 98 | When the Program is made available in source code form: 99 | 100 | a) it must be made available under this Agreement; and 101 | 102 | b) a copy of this Agreement must be included with each copy of the Program. 103 | 104 | Contributors may not remove or alter any copyright notices contained within 105 | the Program. 106 | 107 | Each Contributor must identify itself as the originator of its Contribution, 108 | if any, in a manner that reasonably allows subsequent Recipients to identify 109 | the originator of the Contribution. 110 | 111 | 4. COMMERCIAL DISTRIBUTION 112 | 113 | Commercial distributors of software may accept certain responsibilities with 114 | respect to end users, business partners and the like. While this license is 115 | intended to facilitate the commercial use of the Program, the Contributor who 116 | includes the Program in a commercial product offering should do so in a 117 | manner which does not create potential liability for other Contributors. 118 | Therefore, if a Contributor includes the Program in a commercial product 119 | offering, such Contributor ("Commercial Contributor") hereby agrees to defend 120 | and indemnify every other Contributor ("Indemnified Contributor") against any 121 | losses, damages and costs (collectively "Losses") arising from claims, 122 | lawsuits and other legal actions brought by a third party against the 123 | Indemnified Contributor to the extent caused by the acts or omissions of such 124 | Commercial Contributor in connection with its distribution of the Program in 125 | a commercial product offering. The obligations in this section do not apply 126 | to any claims or Losses relating to any actual or alleged intellectual 127 | property infringement. In order to qualify, an Indemnified Contributor must: 128 | a) promptly notify the Commercial Contributor in writing of such claim, and 129 | b) allow the Commercial Contributor tocontrol, and cooperate with the 130 | Commercial Contributor in, the defense and any related settlement 131 | negotiations. The Indemnified Contributor may participate in any such claim 132 | at its own expense. 133 | 134 | For example, a Contributor might include the Program in a commercial product 135 | offering, Product X. That Contributor is then a Commercial Contributor. If 136 | that Commercial Contributor then makes performance claims, or offers 137 | warranties related to Product X, those performance claims and warranties are 138 | such Commercial Contributor's responsibility alone. Under this section, the 139 | Commercial Contributor would have to defend claims against the other 140 | Contributors related to those performance claims and warranties, and if a 141 | court requires any other Contributor to pay any damages as a result, the 142 | Commercial Contributor must pay those damages. 143 | 144 | 5. NO WARRANTY 145 | 146 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON 147 | AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER 148 | EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR 149 | CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A 150 | PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the 151 | appropriateness of using and distributing the Program and assumes all risks 152 | associated with its exercise of rights under this Agreement , including but 153 | not limited to the risks and costs of program errors, compliance with 154 | applicable laws, damage to or loss of data, programs or equipment, and 155 | unavailability or interruption of operations. 156 | 157 | 6. DISCLAIMER OF LIABILITY 158 | 159 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY 160 | CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, 161 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION 162 | LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 163 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 164 | ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE 165 | EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY 166 | OF SUCH DAMAGES. 167 | 168 | 7. GENERAL 169 | 170 | If any provision of this Agreement is invalid or unenforceable under 171 | applicable law, it shall not affect the validity or enforceability of the 172 | remainder of the terms of this Agreement, and without further action by the 173 | parties hereto, such provision shall be reformed to the minimum extent 174 | necessary to make such provision valid and enforceable. 175 | 176 | If Recipient institutes patent litigation against any entity (including a 177 | cross-claim or counterclaim in a lawsuit) alleging that the Program itself 178 | (excluding combinations of the Program with other software or hardware) 179 | infringes such Recipient's patent(s), then such Recipient's rights granted 180 | under Section 2(b) shall terminate as of the date such litigation is filed. 181 | 182 | All Recipient's rights under this Agreement shall terminate if it fails to 183 | comply with any of the material terms or conditions of this Agreement and 184 | does not cure such failure in a reasonable period of time after becoming 185 | aware of such noncompliance. If all Recipient's rights under this Agreement 186 | terminate, Recipient agrees to cease use and distribution of the Program as 187 | soon as reasonably practicable. However, Recipient's obligations under this 188 | Agreement and any licenses granted by Recipient relating to the Program shall 189 | continue and survive. 190 | 191 | Everyone is permitted to copy and distribute copies of this Agreement, but in 192 | order to avoid inconsistency the Agreement is copyrighted and may only be 193 | modified in the following manner. The Agreement Steward reserves the right to 194 | publish new versions (including revisions) of this Agreement from time to 195 | time. No one other than the Agreement Steward has the right to modify this 196 | Agreement. The Eclipse Foundation is the initial Agreement Steward. The 197 | Eclipse Foundation may assign the responsibility to serve as the Agreement 198 | Steward to a suitable separate entity. Each new version of the Agreement will 199 | be given a distinguishing version number. The Program (including 200 | Contributions) may always be distributed subject to the version of the 201 | Agreement under which it was received. In addition, after a new version of 202 | the Agreement is published, Contributor may elect to distribute the Program 203 | (including its Contributions) under the new version. Except as expressly 204 | stated in Sections 2(a) and 2(b) above, Recipient receives no rights or 205 | licenses to the intellectual property of any Contributor under this 206 | Agreement, whether expressly, by implication, estoppel or otherwise. All 207 | rights in the Program not expressly granted under this Agreement are 208 | reserved. 209 | 210 | This Agreement is governed by the laws of the State of New York and the 211 | intellectual property laws of the United States of America. No party to this 212 | Agreement will bring a legal action under this Agreement more than one year 213 | after the cause of action arose. Each party waives its rights to a jury trial 214 | in any resulting litigation. 215 | --------------------------------------------------------------------------------