greg 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ce205a1383267a783a85edffb4caddd38698ab3
-  data.tar.gz: 53b65e3e6061c23c28aa4c6b4e2262ab554b7499
+  metadata.gz: 43d86623060138705711092c127b214b7603dedc
+  data.tar.gz: 3d34ed47a7b3db7f901993f7173c2065c1465590
 SHA512:
-  metadata.gz: 98557f0cd97fa4b2947f45487a0d31c943c48601cd0e23997915fc93b19781d3c924c7531e1a431e6ed8c04fc0c93deaeb7084c3af5860af1fcbba6b4330dc2e
-  data.tar.gz: 998427235a0c5e6d1f5cf4c820b47214330c4290d64867ce13d80559f20ef116c07ebc67fe39600210cdc60822e6992c27dbac7b53b4cf76541796b167078ea8
+  metadata.gz: fa23c9e295dd50935e69688c2a3429a68e20668b634d613dbe942e4048858ffa72e6f536fb1b4569c3ded8295f0947fbb7712f8737fa50d21f4e739a21d96222
+  data.tar.gz: 0f765367414ccf8afe1ef527647cfb4a4ec796fd140dd246a86bfa86d5d7033b0a001ae65a548458555a461aea80a0612e2d9ed5b939a38149f683ef409c56b6

data/README.md

@@ -1,26 +1,132 @@
 # Greg
 
-TODO: Write a gem description
+Simple code generator
 
-## Installation
+## Introduction
+
+Greg is a simple code generator. It generates code based on templates.
+
+## Usage
+
+To create an app use the `greg` command as follows:
+
+    $ greg <app name> --template=<template name>
+
+This will create your app on the current directory.
+
+For example, to create a Roda application:
+
+```bash
+$ pwd
+/tmp/code
+$ ls
+$ greg my_awesome_app --template=roda_app
+Creating Project:
+    [create] .env
+    [create] routes/
+    [create] routes/main.rb
+    [create] spec/
+    [create] spec/my_awesome_app/
+    [create] spec/spec_helper.rb
+    [create] spec/my_awesome_app_spec.rb
+    [create] config.ru
+    [create] Gemfile
+    [create] public/
+    [create] my_awesome_app.rb
+    [create] views/
+    [create] views/welcome.haml
+    [create] views/layout.haml
+    [create] assets/
+    [create] assets/js/
+    [create] assets/js/some_file.coffee
+    [create] assets/css/
+    [create] assets/css/some_file.scss
+%
+$ ls
+my_awesome_app
+$ ls my_awesome_app
+assets  config.ru  Gemfile  my_awesome_app.rb  public  routes  spec  views
+$
+```
+
+To get a list of templates you can use the `--list` flag
+
+    $ greg --list
+
+To install a template (mus be listed under "Available templates" on the `--list`):
+
+    $ greg --install=<template name>
+
+For example:
+
+    $ greg --install=roda_app
+
+## Creating you own template
+
+The first thing you probably want to do is get some boilerplate in place:
 
-Add this line to your application's Gemfile:
+    $ greg my_template --template=template
+
+This will create a new directory called `my_template` under `~/.greg_templates/`.
+Inside, you'll find the `my_template_generator.rb` file. That's where all the logic for the generator goes.
+
+Now you just need to define a method called `#files`, which should return an array containing all the needed files to be created.
+
+The easiest way to get started is using `Greg::FileTreeTemplate`, like this:
 
 ```ruby
-gem 'greg'
+class MyTemplateGenerator < Greg::Generator
+  def files
+    [
+     Greg::FileTreeTemplate.new("templates"),
+    ]
+  end
+end
 ```
 
-And then execute:
+And under `~/.greg_templates/my_template/templates/` put all the template files. This will compy the `templates` subdirectory almost verbatim to the generated application.
 
-    $ bundle
+Notice I said "almost verbatim" and that's because we have an ace under our sleeves.
+Normally, we want to name files with some name different than just 'app.rb' or 'my_app.whatever'. In that case, instead of naming the file like that, you can use the `@APP_NAME@` "variable".
+If you have the following tree:
 
-Or install it yourself as:
+```
+~/.greg_templates/foo/templates/
+├── @APP_NAME@.rb
+└── spec
+    ├── @APP_NAME@_spec.rb
+    ├── @TEMPLATE_NAME@_spec.rb
+    └── spec_helper.rb
+```
 
-    $ gem install greg
+When you run
 
-## Usage
+    $ greg my_cool_app --template=foo
 
-TODO: Write usage instructions here
+the resulting tree will be:
+
+```
+~/.greg_templates/foo/templates/
+├── my_cool_app.rb
+└── spec
+    ├── my_cool_app_spec.rb
+    ├── foo_spec.rb
+    └── spec_helper.rb
+```
+
+You also have some variables to use inside the file contents. The files will be rendered using ERB and you have the following methods available:
+(assuming the app name is again `my_cool_app`)
+
+| variable      | exported value |
+| ------------- |:--------------:| 
+| app_name      | my_cool_app    | 
+| app_clas_name | MyCoolApp      | 
+
+## Installation
+
+You can install Greg by running
+
+    $ gem install greg
 
 ## Contributing
 

data/bin/greg

@@ -19,20 +19,54 @@ Options:
 Installing a template
   greg --install=<template-name> [--path=<template-path>]
   greg -i <template-name> [--path=<template-path>]
-  EOF
 
+Listing templates
+  greg --list
+  EOF
   puts usage
   exit(0)
 end
 
+require "greg"
+
+if options[:list]
+  require "json"
+
+  installed_templates = `ls #{Greg.templates_dir}`.split("\n")
+  remote_templates = begin
+                       JSON.parse(`curl https://api.github.com/orgs/GregTemplates/repos`).map {|i|i["name"]}
+                     rescue
+                       []
+                     end
+
+
+  available_templates = remote_templates - ["greg", *installed_templates]
+
+  puts available_templates
+  msg = []
+  msg << "Installed templates:"
+  msg << installed_templates.map { |l| "  * #{l}" }
+  msg << ""
+  if available_templates.any?
+    msg << "Available templates:"
+    msg << available_templates.map { |l| "  * #{l}" }
+  end
+  puts msg.join("\n")
+
+  exit(0)
+end
+
 if options[:i] || options[:install]
+  i = options.delete(:install)
+  i ||= options.delete(:i)
+  options[:template] ||= i
   require "greg/template_installer"
-  installer = Greg::TemplateInstaller.new(options).install
+  installer = Greg::TemplateInstaller.new(**options).install
+
   exit(0)
 end
 
 begin
-  require "greg"
 
   templates_dir = options.delete(:templates_dir)
   Greg.templates_dir = templates_dir if templates_dir

data/greg.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Federico Iachetti"]
   spec.email         = ["iachetti.federico@gmail.com"]
   spec.summary       = %q{Simple generator.}
-  spec.description   = %q{Simple generator.}
+  spec.description   = %q{Simple code generator.}
   spec.homepage      = "https://github.com/iachettifederico/greg"
   spec.license       = "MIT"
 

data/lib/greg.rb

@@ -13,6 +13,15 @@ module Greg
     @generator ||= get_generator(**options)
   end
 
+  def self.templates_dir
+    @templates_dir ||= Pathname("~/.greg_templates").expand_path.to_s
+  end
+
+  def self.templates_dir=(new_dir)
+    @templates_dir = Pathname(new_dir).expand_path.to_s
+  end
+
+  private
   def self.get_generator(**options) #name:, template_name: , output_directory: ".", force: false)
     template_name = options[:template_name]
     generator_name = "#{template_name}_generator"
@@ -27,12 +36,4 @@ module Greg
     generator_class.new( **options )
   end
 
-  def self.templates_dir
-    @templates_dir ||= Pathname("~/.greg_templates").expand_path.to_s
-  end
-
-  def self.templates_dir=(new_dir)
-    @templates_dir = Pathname(new_dir).expand_path.to_s
-  end
-
 end

data/lib/greg/template_installer.rb

@@ -1,5 +1,20 @@
 module Greg
   class TemplateInstaller
-    
+    attr_reader :template
+    attr_reader :templates_dir
+    def initialize(template:, templates_dir: Greg.templates_dir)
+      raise "greg is not a template" if template == "greg"
+      @template      = template
+      @templates_dir = templates_dir
+    end
+    def install
+      output_dir = "#{templates_dir}/#{template}"
+      `rm -rf #{output_dir}`
+      command = %W[git clone git@github.com:GregTemplates/#{template}.git #{output_dir}]
+      puts command.join " "
+      IO.popen(command) do |out|
+        out.read.each_line {|l| puts l}
+      end
+    end
   end
 end

data/lib/greg/templates/file_tree_template.rb

@@ -7,7 +7,6 @@ module Greg
       @templates ||= templates
     end
 
-    #def each(&block)
     def create!
       iterate_tree(templates) do |entry|
         puts entry.msg if entry.msg

data/lib/greg/version.rb

@@ -1,3 +1,3 @@
 module Greg
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: greg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Federico Iachetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-22 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.6
-description: Simple generator.
+description: Simple code generator.
 email:
 - iachetti.federico@gmail.com
 executables: