otp_kickoff 0.0.4 → 0.0.5

data/README.rdoc

@@ -1,20 +1,14 @@
 = otp_kickoff
 
-Simple generator to kick off Erlang/OTP projects.
+Simple generator to kick off Erlang/OTP projects quickly.
 
 == Install and configuration
 
-Install the gemcutter (a awesome gem hosting) support:
+Install the otp_kickoff gem:
 
-  sudo gem install gemcutter
+  sudo gem install otp_kickoff -s http://gemcutter.org
 
-More about gemcutter here http://gemcutter.org.
-
-Next, install the otp_kickoff:
-
-  sudo gem install otp_kickoff
-
-Finally, configure your preferences:
+And finally, configure your preferences:
 
   otp_kickoff configure --name=leandro --email=leandrodoze@gmail.com
 
@@ -41,6 +35,18 @@ That will generate:
 
 Enjoy a lot with Erlang/OTP programming!
 
+== Help
+
+If you need some help, type:
+
+  otp_kickoff help
+
+For a specific command:
+  
+  otp_kickoff help new_application
+  
+And so on...
+
 == Copyright
 
 Copyright (c) 2009 Leandro Silva. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/otp_kickoff.rb

@@ -6,6 +6,7 @@ require 'yaml'
 # Path to configuration file
 #
 CONFIGURATION_FILE = '~/.otp_kickoff'
+TODAY              = Date.today
 
 #
 # Thor classes, the magic of tasks!
@@ -29,12 +30,15 @@ class OTPKickOff < Thor
   # Tasks
   #
 
-  no_tasks { attr_accessor :application_name, :author_name, :author_email, :today }
+  no_tasks { attr_accessor :author_name, :author_email }
+
+  no_tasks { attr_accessor :application_name, :supervisor_name, :server_name, :handler_name }
   
   # task: configure
   
-  desc 'configure --author=AUTHOR --email=AUTHOR_EMAIL', 'configure informations about author'
-  method_options :author => :string, :email => :string
+  desc 'configure', 'configure informations about author'
+  method_option :author, :type => :string, :required => true
+  method_option :email,  :type => :string, :required => true
   
   def configure
     #set data about author
@@ -51,33 +55,85 @@ author_email: #{author_email}
   
   # task: new_application
   
-  desc 'new_application --name=APPLICATION_NAME', 'generate a new Erlang/OTP application stub'
-  method_options :name => :string
+  desc 'new_application', 'generate a new Erlang/OTP application stub'
+  method_option :name, :type => :string, :required => true, :aliases => "-n"
   
   def new_application
     # set data to templates
     @application_name = options[:name]
+    @supervisor_name  = @application_name
+    @server_name      = @application_name
     
-    config_info   = ConfigInfo.new
-    @author_name  = config_info.author_name
-    @author_email = config_info.author_email
-    
-    @today = Date.today
-    
+    @author_name, @author_email = get_config_info
+        
     # generate templates
-    template 'resources/template_app.app',      "#{application_name}/src/#{application_name}_app.app"
+    template 'resources/template.app',          "#{application_name}/src/#{application_name}.app"
     template 'resources/template_app.erl',      "#{application_name}/src/#{application_name}_app.erl"
     template 'resources/template_sup.erl',      "#{application_name}/src/#{application_name}_sup.erl"
     template 'resources/template_server.erl',   "#{application_name}/src/#{application_name}_server.erl"
-    template 'resources/template_handler.erl',  "#{application_name}/src/#{application_name}_handler.erl"
     template 'resources/template_appstart.erl', "#{application_name}/src/#{application_name}.erl"
     template 'resources/template_include.hrl',  "#{application_name}/src/#{application_name}.hrl"
-
+    
     # create required directories
     empty_directory "#{application_name}/ebin"
     empty_directory "#{application_name}/deps"
     empty_directory "#{application_name}/priv"
   end
+  
+  # task: new_supervisor
+  
+  desc 'new_supervisor', 'generate a new Erlang/OTP supervisor stub'
+  method_option :name, :type => :string, :required => true, :aliases => "-n"
+  method_option :application_name, :type => :string, :required => true, :aliases => "-a"
+  
+  def new_supervisor
+    # set data to templates
+    @supervisor_name  = options[:name]
+    @application_name = options[:application_name]
+    
+    @author_name, @author_email = get_config_info
+    
+    # generate templates
+    template 'resources/template_sup.erl', "#{supervisor_name}_sup.erl"
+  end
+  
+  # task: new_gen_server
+  
+  desc 'new_gen_server', 'generate a new Erlang/OTP gen_server stub'
+  method_option :name, :type => :string, :required => true, :aliases => "-n"
+  
+  def new_gen_server
+    # set data to templates
+    @server_name = options[:name]
+    
+    @author_name, @author_email = get_config_info
+    
+    # generate templates
+    template 'resources/template_server.erl', "#{server_name}_server.erl"
+  end
+  
+  # task: new_gen_server
+  
+  desc 'new_event_handler', 'generate a new Erlang/OTP gen_event handler stub'
+  method_option :name, :type => :string, :required => true, :aliases => "-n"
+  
+  def new_event_handler
+    # set data to templates
+    @handler_name = options[:name]
+    
+    @author_name, @author_email = get_config_info
+    
+    # generate templates
+    template 'resources/template_handler.erl', "#{handler_name}_handler.erl"
+  end
+  
+  private
+  
+    def get_config_info
+      config_info = ConfigInfo.new
+      
+      return config_info.author_name, config_info.author_email
+    end
 end
 
 #

data/otp_kickoff.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{otp_kickoff}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Leandro Silva"]
-  s.date = %q{2009-10-19}
+  s.date = %q{2009-12-05}
   s.default_executable = %q{otp_kickoff}
   s.email = %q{leandrodoze@gmail.com}
   s.executables = ["otp_kickoff"]
@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
      "bin/otp_kickoff",
      "lib/otp_kickoff.rb",
      "otp_kickoff.gemspec",
-     "resources/template_app.app",
+     "resources/template.app",
      "resources/template_app.erl",
      "resources/template_appstart.erl",
      "resources/template_handler.erl",
@@ -63,3 +63,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<thor>, [">= 0"])
   end
 end
+

data/resources/{template_app.app → template.app}

@@ -1,16 +1,16 @@
 %%
 %% Resource application file
 %%
-%% File   : <%=application_name%>_handler.erl
-%% Created: <%=Date.today%>
+%% File   : <%=application_name%>.app
+%% Created: <%=TODAY%>
 %%
 %% @author <%=author_name%> <<%=author_email%>>
-%% @copyright <%=today.year%> <%=author_name%>
+%% @copyright <%=TODAY.year%> <%=author_name%>
 %%
 %% @doc TODO make nice description
 %%
 
-{application, <%=application_name%>_app,
+{application, <%=application_name%>,
  [{description, "<%=application_name.capitalize%> application version 1.0"},
   {vsn, "1.0"},
   {modules, [<%=application_name%>_sup, <%=application_name%>_app, <%=application_name%>_server]},

data/resources/template_app.erl

@@ -1,11 +1,11 @@
 %%
 %% Application module
 %%
-%% File   : <%=application_name%>_handler.erl
-%% Created: <%=Date.today%>
+%% File   : <%=application_name%>_app.erl
+%% Created: <%=TODAY%>
 %%
 %% @author <%=author_name%> <<%=author_email%>>
-%% @copyright <%=today.year%> <%=author_name%>
+%% @copyright <%=TODAY.year%> <%=author_name%>
 %%
 %% @doc TODO make nice description
 %%

data/resources/template_appstart.erl

@@ -1,11 +1,11 @@
 %%
 %% Start application module
 %%
-%% File   : <%=application_name%>_handler.erl
-%% Created: <%=Date.today%>
+%% File   : <%=application_name%>.erl
+%% Created: <%=TODAY%>
 %%
 %% @author <%=author_name%> <<%=author_email%>>
-%% @copyright <%=today.year%> <%=author_name%>
+%% @copyright <%=TODAY.year%> <%=author_name%>
 %%
 %% @doc TODO make nice description
 %%

data/resources/template_handler.erl

@@ -1,35 +1,48 @@
 %%
-%% Handler module that can be used by server to catch and handle events
+%% Handler module used by event manager to deal with events
 %%
-%% File   : <%=application_name%>_handler.erl
-%% Created: <%=Date.today%>
+%% File   : <%=handler_name%>_handler.erl
+%% Created: <%=TODAY%>
 %%
 %% @author <%=author_name%> <<%=author_email%>>
-%% @copyright <%=today.year%> <%=author_name%>
+%% @copyright <%=TODAY.year%> <%=author_name%>
 %%
 %% @doc TODO make nice description
 %%
 
--module(<%=application_name%>_handler).
+-module(<%=handler_name%>_handler).
 -author('<%=author_name%> <<%=author_email%>>').
 
--export([init/1, terminate/1, handle_event/2]).
+-behahiour(gen_event).
+
+-export([init/1, terminate/1, handle_event/2, handle_call/2, handle_info/2, code_change/3]).
 
 %% @spec init(State) -> State
-%% @doc Handler init callback
-init(State) -> State.
+%% @doc Callback for initialize the <%=handler_name%>_handler
+init(State) ->
+	{ok, State}.
 
-%% @spec terminate(State) -> State
-%% @doc Handler terminate callback
+%% @spec terminate(State) -> {ok, State}
+%% @doc Callback for cleanup the handler
 terminate(State) ->
   {ok, State}.
 
-%% @spec handle_event({event, _Event}, State) -> {ok, State}
-%% @doc Handle event function
-handle_event({event, _Event}, State) ->
-  {ok, State};
-
-%% @spec handle_event(_Event, State) -> State
-%% @doc Handle event "catch" function
+%% @spec handle_event(_Event, State) -> {ok, State}
+%% @doc Callback for notified events on gen_event
 handle_event(_Event, State) ->
-  State.
+  {ok, State}.
+
+%% @spec handle_call(_Request, State) -> {ok, Reply, State}
+%% @doc Callback for specific calls for this handler
+handle_call(_Request, State) ->
+	{ok, noreply, State}.
+
+%% @spec handle_info(_Info, State) -> {ok, State}
+%% @doc Callback for unknow messages by the gen_event
+handle_info(_Info, State) ->
+	{ok, State}.
+
+%% @spec code_change(_OldVsn, State, _Extra) -> {ok, State}
+%% @doc Callback for update internal state during upgrade/downgrade
+code_change(_OldVsn, State, _Extra) ->
+	{ok, State}.

data/resources/template_include.hrl

@@ -1,11 +1,11 @@
 %%
 %% Include file
 %%
-%% File   : <%=application_name%>_handler.erl
-%% Created: <%=Date.today%>
+%% File   : <%=application_name%>_include.erl
+%% Created: <%=TODAY%>
 %%
 %% @author <%=author_name%> <<%=author_email%>>
-%% @copyright <%=today.year%> <%=author_name%>
+%% @copyright <%=TODAY.year%> <%=author_name%>
 %%
 %% @doc TODO make nice description
 %%

data/resources/template_server.erl

@@ -1,16 +1,16 @@
 %%
 %% Supervised worker process module
 %%
-%% File   : <%=application_name%>_handler.erl
-%% Created: <%=Date.today%>
+%% File   : <%=server_name%>_server.erl
+%% Created: <%=TODAY%>
 %%
 %% @author <%=author_name%> <<%=author_email%>>
-%% @copyright <%=today.year%> <%=author_name%>
+%% @copyright <%=TODAY.year%> <%=author_name%>
 %%
 %% @doc TODO make nice description
 %%
 
--module(<%=application_name%>_server).
+-module(<%=server_name%>_server).
 -author('<%=author_name%> <<%=author_email%>>').
 
 -behaviour(gen_server).
@@ -26,22 +26,17 @@
 %% Operation & Maintenance API
 %%
 
-%% @spec start_link() -> ServerReturn
-%% @doc Start the server for <%=application_name%>
+%% @spec start_link() -> {ok, Pid}
+%% @doc Start the <%=server_name%>_server
 start_link() ->
    gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
- 
-%% @spec stop() -> ServerReturn
-%% @doc Stopt the server for <%=application_name%>
-stop() ->
-	gen_server:cast(?MODULE, stop).
 
 %%
 %% Genserver callback functions
 %%
 
 %% @spec init(State) -> {ok, State}
-%% @doc Callback for initialize the server
+%% @doc Callback for initialize the <%=server_name%>_server
 init(State) ->
   {ok, State}.
  
@@ -62,7 +57,7 @@ handle_cast(_Msg, State) ->
    {noreply, State}.
  
 %% @spec handle_info(_Info, State) -> {noreply, State}
-%% @doc Callback for give informations about server
+%% @doc Callback for timeout or other unreconized messages
 handle_info(_Info, State) ->
    {noreply, State}.
  

data/resources/template_sup.erl

@@ -1,16 +1,16 @@
 %%
 %% Supervisor module
 %%
-%% File   : <%=application_name%>_handler.erl
-%% Created: <%=Date.today%>
+%% File   : <%=supervisor_name%>_sup.erl
+%% Created: <%=TODAY%>
 %%
 %% @author <%=author_name%> <<%=author_email%>>
-%% @copyright <%=today.year%> <%=author_name%>
+%% @copyright <%=TODAY.year%> <%=author_name%>
 %%
 %% @doc TODO make nice description
 %%
 
--module(<%=application_name%>_sup).
+-module(<%=supervisor_name%>_sup).
 -author('<%=author_name%> <<%=author_email%>>').
 
 -behaviour(supervisor).
@@ -27,8 +27,8 @@
 %% Operation & Maintenance API
 %%
 
-%% @spec start_link() -> SupervisorReturn
-%% @doc Start the supervisor for <%=application_name%>
+%% @spec start_link() -> {ok, Pid}
+%% @doc Start the <%=supervisor_name%>_sup for <%=application_name%> application
 start_link() ->
    supervisor:start_link({local, ?SERVER}, ?MODULE, []).
 
@@ -36,12 +36,12 @@ start_link() ->
 %% Supervisor callback function
 %%
  
-%% @spec init([]) -> SupervisorSpec
-%% @doc Callback for initialize the supervisor for <%=application_name%>
+%% @spec init([]) -> {ok, {{RestartStrategy, MaxRestart, MaxTime}, [ChildSpec]}}
+%% @doc Callback for initialize the <%=supervisor_name%>_sup for <%=application_name%> application
 init([]) ->
    %% <%=application_name%>_server is a supervisioned child process
-   Server = {<%=application_name%>_server_child,
-              {<%=application_name%>_server, start_link, []},permanent, 2000, worker, [<%=application_name%>_server]},
+   Server = {<%=application_name%>_server,
+              {<%=application_name%>_server, start_link, []}, permanent, brutal_kill, worker, [<%=application_name%>_server]},
               
    %% Restart strategies for childs
    {ok, {{one_for_one, 10, 1}, [Server]}}.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: otp_kickoff
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Leandro Silva
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-19 00:00:00 -07:00
+date: 2009-12-05 00:00:00 -08:00
 default_executable: otp_kickoff
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,7 +51,7 @@ files:
 - bin/otp_kickoff
 - lib/otp_kickoff.rb
 - otp_kickoff.gemspec
-- resources/template_app.app
+- resources/template.app
 - resources/template_app.erl
 - resources/template_appstart.erl
 - resources/template_handler.erl