gn 0.0.2 → 0.1.0

data/Readme.md

@@ -10,30 +10,36 @@ ever find.
 Say you want to generate always a typical `README` file, like this
 one, you should do the following:
 
-Create a folder `readme` on your current folder and add an `init.rb`
-with the following content:
+Create a folder `~/.gn/readme` and add a `plan.rb` file with the
+following content:
 
 ```ruby
 module Plan
-  module Readme
-
+  class README
     def name
       "CHANGEME"
     end
 
+    def author
+      "Your Name"
+    end
+
     def destination
-      "readme"
+      "README"
     end
   end
 end
 ```
 
-Create a `readme/templates` folder and add the template for your
-README files:
+The only mandatory method is `destination`. Everything else is
+optional and is based on how the template is designed.
+
+Create a `~/.gn/readme/plan` folder and add the template for your
+README file:
 
 ```
-mkdir readme/templates
-touch readme/templates/readme.mote
+mkdir ~/.gn/readme/plan
+touch ~/.gn/readme/plan/readme.mote
 ```
 
 For example, add the following to the template:
@@ -41,14 +47,14 @@ For example, add the following to the template:
 ```markdown
 # {{name}}
 
-Copyright (c) 2012 Lucas Florio
+Copyright (c) 2012 {{author}}
 ```
 
 Templates are rendered using [`mote`](http://soveran.github.com/mote),
-the minimalist template engine. In `mote` variable interpolation is
+the minimalist template engine. In `mote`, variable interpolation is
 done by using the `{{variable}}` syntax, as shown in the example
 above. Variable names are extracted from the current context, in this
-case the `Plan::Readme` module.
+case an instance of `Plan::README`.
 
 Then run the generator like this:
 
@@ -56,19 +62,19 @@ Then run the generator like this:
 gn readme
 ```
 
-Now your default `$EDITOR` will pop open with a copy of your `init.rb`
-file, ready to be updated if necessary. **Note that your original
-`init.rb` file won't be modified**.
+Now your default `$EDITOR` will pop open with a copy of your `plan.rb`
+file, ready to be updated if necessary. Note that the original
+`plan.rb` file won't be modified.
 
-Close your editor and done! Your `gn` generated `README` file will be
-placed in your current directory.
+Close your editor and you are done! Your `gn` generated `README` file
+will be placed in your current directory.
 
 ## Other usages
 
-You can use gn to generate different things. In our case, we design it
-so we could generate basic crud/scaffolds for
-[Cuba](http://soveran.github.com/cuba), but you could use it for
-whatever you want.
+You can use gn to generate different things. In our case, we
+designed it so we could generate basic crud/scaffolds for
+[Cuba](http://soveran.github.com/cuba), but you can use it for
+anything you want.
 
 See the folder named examples for some ideas.
 

data/bin/gn

@@ -1,84 +1,36 @@
 #!/usr/bin/env ruby
-require 'mote'
-require 'fileutils'
-require 'tempfile'
 
-class Gn
-
-  attr_reader :name
-
-  def initialize(name)
-    @name = name
-    if location
-      process
-    else
-      puts "Plan named '#{name}' doesn't exist" 
-    end
-  end
-
-  def process
-    load_plan
-    Plan.constants.each do |constant_name|
-      constant = Plan.const_get(constant_name)
-      if constant.class == Class
-        puts "-> Generating #{constant_name}"
-        generate_from constant_name, constant.new 
-      end
-    end
-  end
-
-  def generate_from(constant_name, blueprint)
-    template = File.join(templates_location, 
-      "#{constant_name.to_s.downcase}.mote")
-    FileUtils.mkdir_p(File.dirname(blueprint.destination))
-    File.open(blueprint.destination, "w") do |f|
-      f.write Mote.parse(File.read(template), blueprint).call
-    end
-  end
-
-  def location
-    @location ||= available_locations.detect do |path|
-      Dir.exists?(path)
-    end
-  end
-
-  def available_locations
-    [name, "./plans/#{name}", "#{ENV['HOME']}/.plans/#{name}"]
-  end
-
-  def templates_location
-    File.join(@location, "templates")
-  end
-
-  def load_plan
-    file = Tempfile.new('plan_init.rb')
-    file.write(File.read(File.join(location, "init.rb")))
-    file.close
-    open_with_editor(file)
-    load file.path
-  end
-
-  def open_with_editor(file)
-    editor = ENV['EDITOR'] || "vi"
-    system("#{editor} #{file.path}")
-  end
-
-end
+require_relative "../lib/gn"
 
 name = ARGV.first.to_s.strip
 
 if name.empty? || name == "-h" || name == "--help"
+
   puts <<-USAGE
   Usage: gn <name>
 
-  Run the first <name> generator that is found in the following locations:
-
-  * <name>/init.rb
-  * plans/<name>/init.rb
-  *  ~/.plans/<name>/init.rb
+  Run the <name> generator found in ~/.gn/<name>.
 
   See http://lucasefe.github.com/gn for more information.
   USAGE
+
 else
-  Gn.new(name)
+  require "fileutils"
+
+  gn = Gn.new(name)
+
+  # Load edited plan.
+  gn.load!
+
+  # Process each blueprint.
+  gn.blueprints.each do |blueprint|
+
+    # Create destination directory.
+    FileUtils.mkdir_p(File.dirname(blueprint.destination))
+
+    # Write generated template.
+    File.open(blueprint.destination, "w") do |file|
+      file.write blueprint.render
+    end
+  end
 end

data/lib/gn.rb

@@ -0,0 +1,64 @@
+require "mote"
+require "tempfile"
+
+class Gn
+  class Blueprint
+    def initialize(parent, constant)
+      @parent   = parent
+      @instance = constant.new
+      @name     = constant.name
+    end
+
+    def destination
+      @instance.destination
+    end
+
+    def file
+      File.join(@name.downcase.split("::")) + ".mote"
+    end
+
+    def template
+      File.read(@parent.path(file))
+    end
+
+    def render
+      Mote.parse(template, @instance).call
+    end
+  end
+
+  PLAN_FILE = "plan.rb"
+
+  attr :name
+
+  def initialize(name)
+    @name = name
+  end
+
+  def path(file)
+    "#{ENV["HOME"]}/.gn/#{name}/#{file}"
+  end
+
+  def load!
+    file = Tempfile.new(PLAN_FILE)
+    file.write(File.read(path(PLAN_FILE)))
+    file.close
+
+    edit(file)
+
+    load file.path
+  end
+
+  def editor
+    ENV["EDITOR"] || "vi"
+  end
+
+  def edit(file)
+    system "%s %s" % [editor, file.path]
+  end
+
+  def blueprints
+    Plan.constants.map do |constant|
+      Blueprint.new(self, Plan.const_get(constant))
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gn
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-02 00:00:00.000000000 Z
+date: 2012-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mote
-  requirement: &70340185824720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,7 +23,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70340185824720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple Generator for the masses
 email:
 - lucasefe@gmail.com
@@ -32,8 +37,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/gn
+- lib/gn.rb
 - lib/gn/dsl.rb
+- bin/gn
 - LICENSE
 - Readme.md
 homepage: http://lucasefe.github.com/gn
@@ -57,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Simple Generator for the masses