skeletor 0.6.4 → 0.7.0

data/README.md

@@ -161,19 +161,18 @@ put your templates in a `templates` folder under that.  This way you just have t
 
 ###Supplied Templates###
 
-Skeletor comes with 1 presupplied template but I'll be adding a few more as I have time.
+Skeletor comes with 2 presupplied template but I'll be adding a few more as I have time.
 
 * `js-lib` Creates a skeleton for a Javascript library.  This is based on the structure I use for most Javascript projects which is in turn based on the structures of libraries such
 as Prototype and Scriptaculous.
+* `rb-gem` Creates a skeleton for a Ruby Gem. This is based on the structure I used for this gem, which was generated from Jeweler and stripped back and simplified.
 
 Coming Soon
 -----------
 
-* Add rDoc comments so rubygems.org can generate proper documentation
 * Add Tests
 * More Templates
 * Option to turn off or lessen output
-* Include parsing
 * Option to deal with file/folder existing conflicts.
 
 Notes

data/lib/skeletor/builder.rb

@@ -52,6 +52,8 @@ module Skeletor
             node.each_pair{
               |dir,content| 
           
+              dir = replace_tags(dir)
+          
               puts 'Creating directory ' + File.join(path,dir)
               Dir.mkdir(File.join(path,dir))
         
@@ -94,20 +96,21 @@ module Skeletor
     # Checks if file is listed in the includes list and if so copies it from
     # the given location. If not it creates a blank file.
     def write_file(file,path)
-      
       #if a pre-existing file is specified in the includes list, copy that, if not write a blank file      
       if @template.includes.has_key?(file)
         begin
-          Includes.copy_include(@template.includes[file],File.join(path,file),@template.path)
+          content = Includes.copy_include(@template.includes[file],@template.path)
+          file = replace_tags(file)
         rescue TypeError => e
           puts e.message
           exit
         end
       else
+       file = replace_tags(file) 
         puts 'Creating blank file: ' + File.join(path,file)
-        File.open(File.join(path,file),'w')
+        content=''
       end
-      
+      File.open(File.join(path,file),'w'){|f| f.write(replace_tags(content))}
     end
     
     # Parses the task string and runs the task.
@@ -125,9 +128,7 @@ module Skeletor
         
         puts 'Running Task: ' + task
         
-        task = task.gsub('<skeleton_path>',@path)
-        task = task.gsub('<skeleton_project>',@project)
-        task = task.gsub('<skelton_template>',@template_name)
+        task = replace_tags(task);
         
         options = task.split(', ')
         action = options.slice!(0)
@@ -142,6 +143,19 @@ module Skeletor
                   
     end
     
+    # Parses supplied string and replaces any instances of following tags with the relavant 
+    # internal variable:
+    #
+    # <skeleton_path>,
+    # <skeleton_project>,
+    # <skeleton_template>
+    def replace_tags(str)
+     str = str.gsub('<skeleton_path>',@path)
+     str = str.gsub('<skeleton_project>',@project)
+     str = str.gsub('<skelton_template>',@template_name)
+     return str
+    end
+    
   end
   
 end

data/lib/skeletor/cli.rb

@@ -30,7 +30,7 @@ module Skeletor
     # Cleans out the specified directory
     def clean
       print 'Are you sure you want to clean this project directory? (Y|n): '
-      confirm = gets.chomp
+      confirm = $stdin.gets.chomp
       if confirm != 'Y' && confirm != 'n'
         puts 'Please enter Y or n'
       elsif confirm == 'Y'

data/lib/skeletor/includes.rb

@@ -16,7 +16,7 @@ module Skeletor
     
     # Reads the required include from either the remote url or the local path and writes it to the 
     # required location in the skeleton.
-    def self.copy_include(include,target,path)
+    def self.copy_include(include,path)
       
       #if include path includes a protocol. Load from that
       matches = PROTOCOL_PATTERN.match(include).to_a
@@ -36,17 +36,17 @@ module Skeletor
             else
               raise TypeError, 'Unsupported protocol ' + protocol + ' for remote file. Only the following are supported: ' + SUPPORTED_PROTOCOLS.join(', ') 
            end
-           puts 'Copying remote file ' + include + ' to ' + target
+           puts 'Reading remote file ' + include
         else
           raise TypeError, 'Unsupported protocol for remote file. Only the following are supported: ' + SUPPORTED_PROTOCOLS.join(', ') 
         end
       else
-        puts 'Copying ' + include +  ' from template directory to ' + target
+        puts 'Reading ' + include +  ' from template directory'
         file = File.open(File.join(path,include))
-        content = file.gets 
+        content = file.gets nil
       end
       
-      File.open(target,'w'){|f| f.write(content)}
+      return content
       
     end
     

data/lib/skeletor/skeletons/loader.rb

@@ -1,4 +1,4 @@
-require 'YAML'
+require 'yaml'
 
 module Skeletor
   

data/lib/skeletor/skeletons/validator.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module Skeletor
   
   module Skeletons

data/lib/skeletor/templates/js-lib/includes/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 <Your Name Here>
+
+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/lib/skeletor/templates/js-lib/js-lib.yml

@@ -12,3 +12,5 @@ directory_structure:
   -
     - README.md
     - LICENSE
+includes:
+  LICENSE: includes/LICENSE

data/lib/skeletor/templates/rb-gem/includes/Gemfile

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

data/lib/skeletor/templates/rb-gem/includes/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 <Your Name Here>
+
+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/lib/skeletor/templates/rb-gem/includes/sample.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = "<skeleton_project>"
+  s.version = "0.0.0"
+  s.summary = "[Insert Gem Summary Here]"
+  s.description = "[Insert Longer Gem Description Here]"
+
+  s.files = Dir["README", "LICENSE", "lib/**/*.rb"]
+  s.authors = ["[Your Name Here]"]
+  s.email = ["[Your Email Here]"]
+  s.homepage = "[Gem Homepage Here]"
+  s.rubyforge_project = "<skeleton_project>"
+  s.licenses = ["MIT"]
+  
+end
+

data/lib/skeletor/templates/rb-gem/rb-gem.yml

@@ -0,0 +1,18 @@
+directory_structure: 
+  -
+    lib: 
+      - 
+        <skeleton_project>:
+      -
+        - <skeleton_project>.rb
+    test:
+  - 
+    - <skeleton_project>.gemspec
+    - README
+    - LICENSE
+    - GemFile
+includes: 
+  <skeleton_project>.gemspec: includes/sample.gemspec
+  LICENSE: includes/LICENSE
+  GemFile: includes/GemFile
+   

data/lib/skeletor/version.rb

@@ -1,4 +1,4 @@
 module Skeletor
   # Current version number
-  VERSION="0.6.4"
+  VERSION="0.7.0"
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 4
-  version: 0.6.4
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Will McKenzie
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-27 00:00:00 +01:00
+date: 2011-09-29 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,7 +54,12 @@ files:
 - lib/skeletor/version.rb
 - lib/skeletor.rb
 - bin/skeletor
+- lib/skeletor/templates/js-lib/includes/LICENSE
 - lib/skeletor/templates/js-lib/js-lib.yml
+- lib/skeletor/templates/rb-gem/includes/Gemfile
+- lib/skeletor/templates/rb-gem/includes/LICENSE
+- lib/skeletor/templates/rb-gem/includes/sample.gemspec
+- lib/skeletor/templates/rb-gem/rb-gem.yml
 - lib/skeletor/templates/template-schema.yml
 has_rdoc: true
 homepage: http://github.com/OiNutter/skeletor