turple 0.0.9 → 0.0.10

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTllNzk2ZWQ3MTY0NDcwNjk3YzczODY1OTVkNjg2ODNiMmMxZTdmZQ==
+    MWEyNzIxNjY4MjFkZGMxNjNiMTgyZTc3YTIyNjliMzBlNjEwNjI0ZQ==
   data.tar.gz: !binary |-
-    YjY5ZjM3NDMwZTZhNTkyMGVmYmFmNWRiZDAyZGViMTE3ZWZhOWQ2Mg==
+    N2MwZTJlOGRlMTEyYzU3ZTVmNGM5MWMzMDVjZmZjMmU2YmVjZDYyOA==
 SHA512:
   metadata.gz: !binary |-
-    N2MzMzIyZTc2NjJkYmI0MTkwZTgwY2Y0ZmM2MmU3NDYwZGMyODU5NDFhN2Rj
-    MDc2OWY0ZTI2MGNkZDQ2ZTNlMzAwODA2MjU3NTY0NmY4MDY0NzFjMTc4ZGY3
-    ODE2YTYzNjhiZjQ1OTM3MDAxMGM2MzE1YmYyNTlmMThmMTBhOTU=
+    OWJkMDMwZTlkMmExZjU2YWZlZWJiMjMwMjBmNzI4NjI3NGRmZWI1ZjIyMWQ3
+    M2IxOGQyNjZkYjAzMTdjOTIwZTQ0NGQ3M2I3ZGIzMDE4MTdmM2UwNmE5ZTMx
+    OTRjOGFiMjRmZDI3NmIwYjlkNmUyMTYzYWYyNmFiN2I4Y2RhNTQ=
   data.tar.gz: !binary |-
-    ODAyZDIxN2FkNDkyNzZhMWEyNTRiZDg4ZmMyYjBhODQ2MmVhMjNiNzZhMGRi
-    YTNlMWYyMjFkMTA1MWE3ZjExOTlhMmYzZjZiYjVkMGRkZmQ4Y2VmYTM1MTNk
-    YmIzODVkZTNiNTRhNGNlMmEyMTk4NDZlMzhjMmY2NGQ4MzY4YjQ=
+    YzQ2NDE1YTRjMDQ4NDRlYjU1ZTMyMWU1Njk0Y2Q2ZjkzNTE0NTJkOGMxMjIx
+    ZWI2ODE4NmI1NDQ2MzU4N2FjZDdjMjQwOTllMWRmZjk4Mjc2YmIzYjIyNWYx
+    ZTEzOTBlODRlMGRkNGE0YWMwMGMzNzYxYTk0NmVjNzc2MGY4Mjg=

data/README.md

@@ -3,11 +3,13 @@
 [![Coverage Status](https://coveralls.io/repos/brewster1134/turple/badge.png)](https://coveralls.io/r/brewster1134/turple)
 
 # Turple
+
 Quick project templating, with optional cli wizard support
 
 Turple can take a custom template and use it to bootstrap projects structures you commonly use instead of **copy/pasting** an old project and **find/replacing** to make it a new project.
 
 ### Install
+
 ```sh
 gem install turple
 ```
@@ -35,14 +37,9 @@ Turple is best used from a command line, but it can be used directly in ruby as
 
 Turple requires a path to a template, and an optional destination. If no destination is passed, it will put everything in a `turple` folder in your current working directory.
 
-```sh
-turple --template /path/to/template --destination my_new_project_name
-
-# or with shorter aliases
-turple -t /path/to/template -d my_new_project_name
-```
+Turple will scan the template, determine what data is needed to process it, and prompt you for any missing data. If you wanted to run turple without the wizard, you can put a `Turplefile` in your destination directory with the necessary data.
 
-Turple will scan the template, determine what data is needed to process it, and prompt you for any missing data. If you wanted to run turple without the wizard, just put a `Turplefile` into your destination directory with the necessary data. Assuming our template requires a single piece of information called `foo`, our destination Turplefile could look something like this.
+e.g. Assuming our template requires a single piece of information called `foo`, a Turplefile in your new project directory could look something like this.
 
 ```yaml
 data:
@@ -65,20 +62,34 @@ data:
 A turple template is simply a directory containing a Turplefile, and any amount of custom folders and files your project template needs. The Turplefile inside a template has different data than a destination file. It has instructions on how to prompt a user for data, and the configuration details on how the template is built. _This example uses the default turple configuration._
 
 ###### Remote Template
+
 You can easily use remote templates directly, or share other user's templates by passing turple a remote source in addition to a template name. Simply separate the source name from the template name with 2 hashes (`##`).
 
 Turple uses the [Sourcerer](https://github.com/brewster1134/sourcerer) gem to download remote sources to a tmp directory, so you can use any supported Sourcerer format *(including github shorthand!)*
 
-```
+```sh
+# local template
+turple --template /path/to/template --destination new_project_name
+
+# local template with shorter aliases
+turple -t /path/to/template -d new_project_name
+
+# remote template (with source and template)
 turple -t brewster1134/turple_templates##javascript
-```
 
-To customize a template, you can modify the configuration in a template's Turplefile
+# remote template (with just template)
+# this requires the source be loaded in your home Turplefile
+turple -t javascript
+
+# already turple'd project
+turple -t my_old_project_name -d new_project_name
+```
 
 ### Configuration
 
+A Turple template requires a Turplefile the defines the template's configuration.  It can also include a data map that describes all the data a template requires.
+
 ```yaml
-name: Foo Project Template
 configuration:
   file_ext: turple
   path_regex: '\[([A-Z_\.]+)\]'
@@ -87,19 +98,21 @@ configuration:
   content_separator: .
 data_map:
   foo: What is the foo called?
+  bar: The name of the bar.
 ```
 
-* `name` is just a friendly name for the template. its optional. we can use the template directory name for that.
 * `configuration` has some very important details. (again, these are the defaults, so if your template does not have a custom configuration, it uses these values)
   * `file_ext` is the file extension turple looks for to tell it there is content inside the file that needs processed
   * `path_regex` this is a string representing a regex match to variable names
   * `path_separator` this is a string representing a character(s) to seperate variables strung togehter
   * `content_regex` & `content_separator` are the same as with a path, but to match file contents rather than a path.
 * `data_map` is a hash that matches the same structure as the data required for a template, but instead provides the details to prompt a user in case a peice of required data is missing.
+  * data_map entries will be displayed with a prompt to enter missing data.  you can pose a data map entry in the form of a question, or just a description of the data.
 
 ## Example Template
 
 Say you design a template using the turple default configuration, and you create a file structure like so...
+
 ```
 foo_template
   |__ my_[FOO.BAR]_dir
@@ -110,13 +123,14 @@ foo_template
 ```
 
 and say your `my_[FOO.BAZ]_file.txt.turple` file contains the following
+
 ```
 This <>foo.baz<> file is in the <>foo.bar<> folder.
 ```
 
 With a simple Turplefile containing...
+
 ```
-name: Foo Template
 data_map:
   foo:
     bar: What is the foo bar?
@@ -128,7 +142,8 @@ data_map:
 * Notice how the content variables match the `content_regex`
 * Notice how the separator of the content variables match the `content_separator`
 
-**Let's run Turple!**
+**Now let's run Turple!**
+
 ```sh
 Saving to: /your/current/directory/turple
 There is some missing data. You will be prompted to enter each value.
@@ -146,6 +161,7 @@ Paths Turpleated: 2
 ```
 
 ### Ruby
+
 You can run turple directly in ruby if needed as well. _This example matches the template from the above example._
 
 ```ruby
@@ -164,6 +180,7 @@ Turple.ate '~/Code/templates/mini_ruby_project', {
 most notably the passing of the destination in the 3rd argument _(the configuration hash)_
 
 ### Development & Testing
+
 ```shell
 gem install yuyi
 yuyi -m https://raw.githubusercontent.com/brewster1134/turple/master/yuyi_menu

data/lib/turple.rb

@@ -110,13 +110,21 @@ class Turple
   # @param file [String] relative/absolute path to a turplefile
   # @return [Hash]
   #
-  def self.load_turplefile turplefile_path
+  def self.load_turplefile turplefile_path, update_turpleobject = true
     turplefile_path = File.expand_path turplefile_path
 
     # return false if file doesnt exist
     return false unless File.exists? turplefile_path
 
-    self.turpleobject = YAML.load File.read turplefile_path
+    # read turplefile to ruby object
+    turplefile_data = YAML.load File.read turplefile_path
+
+    # update the turpleobject, or return a symbolized hash
+    if update_turpleobject
+      self.turpleobject = turplefile_data
+    else
+      turplefile_data.deep_symbolize_keys
+    end
   end
 
   # Add additional data to the collective turplefile
@@ -134,6 +142,18 @@ private
     # load home turplefile
     Turple.load_turplefile File.join(File.expand_path('~'), 'Turplefile')
 
+    # check if template path is an interpolated project
+    template_turplefile = Turple.load_turplefile(File.join(template_path, 'Turplefile'), false)
+    if template_turplefile && template_turplefile[:created_on]
+      # use the project template
+      template_path = template_turplefile[:template]
+
+      # load the project sources
+      Turple.turpleobject = {
+        :sources => template_turplefile[:sources]
+      }
+    end
+
     # create sources
     Turple.sources.each do |source_name, source_path|
       Turple::Source.new source_name, source_path

data/lib/turple/interpolate.rb

@@ -65,7 +65,7 @@ private
   #
   def process_path! path
     # start the new_path out matching the original path
-    new_path = path.dup
+    new_path = path.clone
 
     # interpolate file contents
     file_ext_regex = /\.#{Regexp.escape(@configuration[:file_ext])}$/

data/lib/turple/source.rb

@@ -33,7 +33,8 @@ private
     @template_paths = {}
     @source = Sourcerer.new(source_path)
 
-    add_templates @source.destination
+    # after source is created
+    add_templates @source
 
     # add new source to hash
     @@sources[source_name] = self
@@ -41,10 +42,10 @@ private
 
   # search through source and add any directory with a Turplefile as a turple template
   #
-  # @param source_path [String] a path to a source.  this will be a generated tmp dir from Sourcerer
+  # @param source [Sourcerer] A Sourcerer instance object
   #
-  def add_templates source_path
-    @source.files('**/Turplefile').each do |turplefile_path|
+  def add_templates source
+    source.files('**/Turplefile').each do |turplefile_path|
       template_path = File.dirname(turplefile_path)
       template_name = File.basename(template_path)
 

data/lib/turple/template.rb

@@ -32,7 +32,7 @@ private
     valid_configuration? Turple.configuration
 
     # set variables after validating path
-    @name = File.basename @path
+    @name = template
     @required_data = scan_for_data @path
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turple
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Ryan Brewster