architecture-js 0.2.0 → 0.2.1

data/README.md

@@ -157,21 +157,61 @@ Having to do this manually every time you change a file and want to see it in yo
 
 This will watch the project directory and compile the project every time a file changes. Even rather large applications compile instantly, so you can work without ever having to wait for it to build.
 
-<a id="scaffolds"></a>
 ## Scaffolds
 
+The ArchitectureJS scaffolding allows you to generate custom script templates dynamically. This system is a great way to share common boilerplate code in one easy to maintain place. 
+
 ### generate
 The `generate` command will create a new file based on a predefined template. Default template files are defined by the blueprint the project is using. The `default` blueprint only has one template named `blank`:
 
     architect generate blank test
 
-This will create a blank javascript file in the current directory. This doesn't really do much, the only reason it's there is the test the template generator. However, You can add your own template by putting files inside a templates directory inside your project root. For example, if you created a `/templates/class.js` file, you could generate a class template with the following line:
+This will create a blank javascript file named `test.js` in the current directory. This doesn't really do much, the only reason it's there is to test the template generator. However, You can add your own templates by putting files inside a `/templates` directory inside your project root. For example, if you created a `/templates/class.js` file, you could generate a class template with the following command:
+
+    architect generate class widget
+
+This would create a file named `widget.js` in the current directory based on the contents of `/templates/class.js`. At this point the file is just an empty file. Let's make a more practical template. We'll edit the `class.js` template to take advantage of the command line options:
+
+```ruby
+    <%= options[:name] %> = (function() {
+    <% if options[:f] %>
+        function <%= options[:name] %>() {};
+        return new <%= options[:name] %>();
+    <% else %>
+        var <%= options[:name] %> = function() {};
+        return <%= options[:name] %>;
+    <% end %>
+    })();
+```
+
+The syntax may be a little strange if you've never worked with ERB but this template gives us a great way to generate template files via the command line with `architect`. There are two types of variable you can pass to a template via the generate command: named variables and flags. Named variables allow you to set variables with values. To pass a named variable you use the double dash syntax `architect generate class widget --name "Widget"`, passing the value as the next argument. Flags are simple boolean switches that turn on a flag. To pass a flag, use the single dash syntax `architect generate class widget -f`. All arguments passed will be available through the options variable in the template. Using the `class` template from above we can generate two basic class models using the command options:
+
+    architect generate class widget --name "Foo"
+
+Which would create:
 
-    architect generate class Widget
+```js
+    Foo = (function() {
+        var Foo = function() {};
+        return Foo;
+    })();
+```
+
+We can generate a slightly different class template using the -f flag:
+
+    architect generate class widget --name "Foo" -f
+
+Which generates:
+
+```js
+    Foo = (function() {
+        function Foo() {};
+        return new Foo();
+    })();
+```
 
-This would create a file named `Widget.js` in the current directory based on the contents of `/templates/class.js`
+This is a slightly contrived but not wholly unrealistic example of how you can use the architect template generator. Some blueprints contain default templates which work without the presence of a `/templates` folder. 
 
-<a id="package-management"></a>
 ## Package Management
 _Not Yet Implemented_
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/architecture-js.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "architecture-js"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dayton Nolan"]

data/lib/architecture-js/generator.rb

@@ -32,7 +32,7 @@ module ArchitectureJS
     end
 
     def read_template(file)
-      ERB.new File.read(file)
+      ERB.new(File.read(file), nil, '<>')
     end
 
     def generate(template, filename, options)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: architecture-js
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fssm
-  requirement: &70350982276720 !ruby/object:Gem::Requirement
+  requirement: &70211069072180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.2.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *70350982276720
+  version_requirements: *70211069072180
 - !ruby/object:Gem::Dependency
   name: jsmin
-  requirement: &70350982276220 !ruby/object:Gem::Requirement
+  requirement: &70211069070900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *70350982276220
+  version_requirements: *70211069070900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70350982275720 !ruby/object:Gem::Requirement
+  requirement: &70211069069380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70350982275720
+  version_requirements: *70211069069380
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70350982275220 !ruby/object:Gem::Requirement
+  requirement: &70211069067860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70350982275220
+  version_requirements: *70211069067860
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70350982274720 !ruby/object:Gem::Requirement
+  requirement: &70211069066260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70350982274720
+  version_requirements: *70211069066260
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &70350982274240 !ruby/object:Gem::Requirement
+  requirement: &70211069056380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 4.6.2
   type: :development
   prerelease: false
-  version_requirements: *70350982274240
+  version_requirements: *70211069056380
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &70350982273700 !ruby/object:Gem::Requirement
+  requirement: &70211069054460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.2.16
   type: :development
   prerelease: false
-  version_requirements: *70350982273700
+  version_requirements: *70211069054460
 - !ruby/object:Gem::Dependency
   name: jsmin
-  requirement: &70350982273180 !ruby/object:Gem::Requirement
+  requirement: &70211069052760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70350982273180
+  version_requirements: *70211069052760
 - !ruby/object:Gem::Dependency
   name: fssm
-  requirement: &70350982272640 !ruby/object:Gem::Requirement
+  requirement: &70211069047000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70350982272640
+  version_requirements: *70211069047000
 description: Architecture.js helps you generate scaffolding, manage third-party packages,
   compile, and compress your application.
 email: daytonn@gmail.com
@@ -223,7 +223,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2033111183266170727
+      hash: -2723290340733350047
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: