mjollnir 0.1.1 → 0.2.0

data/README.md

@@ -1,18 +1,18 @@
-# Mjollnir
+# Mjollnir - 0.2.0
 
 A gem for prepending and appending text to rails generated files.
 
-## Usage
+## Installation
 
-add `gem 'mjollnir'` to your Gemfile
-
-Create a directory in your lib directory called `mjollnir`.
-Add four files to this directory:  
+Use the generator `rails g mjollnir:install`.  This will create the four necessary files in your lib directory:  
 1. `append.rb` - this file contains instructions for insertions at the end of generated files.  
 2. `prepend.rb` - this file contains instructions for insertions at the beinning of generated files.  
 3. `comment_starts.csv` - put lines in this file when you need to create block comments in different file types.  For example, use a line, `rb,=start` for the start of a ruby block.  When generating text in the `append.rb` or `prepend.rb` files, use `<%= universal_comment_start %>` to declare the start of any comment block, so long as that file type has been included in `comment_starts.csv`.  
 4. `comment_ends.csv` - much like `comment_starts.csv`, but this file is for comment block ends in generated text.  For example, use `erb,-->` to end a comment block. in an erb file.  When generating text in the `append.rb` or `prepend.rb` files, use `<%= universal_comment_end %>` to declare the end of any comment block, so long as that file type has been included in `comment.ends.csv`.  
 
+The csv files are generated with some common default values.  Do be careful when writing your append and prepends when writing haml or yml files, as these file types do not take block comments in the way the other files do.
+                    
+
 ## Variables
 
 The following usable variables for `append.rb` and `prepend.rb`:  
@@ -46,7 +46,6 @@ The following usable variables for `append.rb` and `prepend.rb`:
 rb,=end  
 scss,*/  
 js,*/  
-haml,#-  
 coffee,###  
 css,*/  
 erb,-->  
@@ -64,5 +63,7 @@ html,-->
 
 ## Planned changes
 
-1. Version 0.2.0 will add a generator for the prepend, and append ruby files, as well as for the two csvs.
-2. The change after that will be to automate some testing.
+TODO 
+- Automated testing  
+- Add options for common licences
+- Add example for haml and yml prepends

data/lib/generators/mjollnir/install_generator.rb

@@ -0,0 +1,27 @@
+module Mjollnir
+  module Generators
+	class InstallGenerator < Rails::Generators::Base
+		desc "Creates the four required files for mjollnir"
+
+		source_root File.expand_path("../templates", __FILE__)
+
+		def create_lib_files
+			mjollnir_root = "lib/mjollnir"
+	
+			empty_directory mjollnir_root	
+		
+			create_file mjollnir_root + "/prepend.rb", <<-FILE
+
+			FILE
+			create_file mjollnir_root + "/append.rb", <<-FILE
+
+			FILE
+			#create_file mjollnir_root + "/comment_starts.csv", File.join('comment_starts.csv')
+			template 'comment_starts.csv', File.join(mjollnir_root, 'comment_starts.csv')
+
+			#create_file mjollnir_root + "/comment_ends.csv", File.join('comment_ends.csv')
+			template 'comment_ends.csv', File.join(mjollnir_root, 'comment_ends.csv')
+		end
+	end
+  end
+end

data/lib/generators/mjollnir/templates/comment_ends.csv

@@ -0,0 +1,7 @@
+rb,=end
+scss,*/
+js,*/
+coffee,###
+css,*/
+erb,-->
+html,-->

data/lib/generators/mjollnir/templates/comment_starts.csv

@@ -0,0 +1,9 @@
+rb,=begin
+scss,/*
+js,/*
+haml,#-
+coffee,###
+css,/*
+erb,<!--
+html,<!--
+yml,#

data/lib/mjollnir/version.rb

@@ -1,3 +1,3 @@
 module Mjollnir
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjollnir
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-10 00:00:00.000000000 Z
+date: 2012-10-18 00:00:00.000000000 Z
 dependencies: []
 description: A gem for prepending and appending generated files from any rails generator,
   though the power of Thor.
@@ -24,6 +24,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/mjollnir/install_generator.rb
+- lib/generators/mjollnir/templates/comment_ends.csv
+- lib/generators/mjollnir/templates/comment_starts.csv
 - lib/mjollnir.rb
 - lib/mjollnir/version.rb
 - mjollnir.gemspec