erlgen 0.0.1 → 0.0.2

data/README.rdoc

@@ -2,9 +2,19 @@
 
 erlgen is a Erlang application generator. It generates the basic application layout with some simple files to build upon.
 
+
+== Usage
+
+The basic command is erlgen projectname to generate a skeleton erlang project named **projectname**. The command-line options include:
+  --with-git
+initializes a git repository in the project folder (does not commit anything).
+  --gen_server/--gen_fsm/--gen_event
+instead of generating a application, generates a skeleton gen_server/fsm/event module with the name specified. If you're in the root of your project, it will write the fiel to the _src_ directory. If not, it will write it to the current directory.
+  --help 
+reminds you about the options.
+
 == Planned features:
 
-* Include rake tasks (or command line arguments) to generate default gen_server, gen_fsm, etc. modules.
 * Option to choose between Rake/Make/Emake.
 
 == Note on Patches/Pull Requests
@@ -17,6 +27,11 @@ erlgen is a Erlang application generator. It generates the basic application lay
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+== Thanks
+
+I would like to thank the authors of the jeweler gem, lots of code in this gem comes from their work.
+
+
 == Copyright
 
 Copyright (c) 2010 Dimitri Krassovski. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/erlgen.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{erlgen}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dimitri Krassovski"]
@@ -33,6 +33,9 @@ Gem::Specification.new do |s|
      "lib/erlgen/templates/application.app",
      "lib/erlgen/templates/application.erl",
      "lib/erlgen/templates/application_sup.erl",
+     "lib/erlgen/templates/gen_event.erl",
+     "lib/erlgen/templates/gen_fsm.erl",
+     "lib/erlgen/templates/gen_server.erl",
      "spec/erlgen_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"

data/lib/erlgen/generator.rb

@@ -1,13 +1,13 @@
 require 'optparse'
 require 'fileutils'
 require 'erb'
-require 'git'
+require 'date'
+#require 'git'
 
 class Erlgen
   class Generator
     attr_accessor :project_name, :options
     def initialize(*args)
-
       @options = {}
       @opts = OptionParser.new do |o|
         o.banner = "Usage: #{File.basename($0)} [options] appname\ne.g. #{File.basename($0)} superapp"
@@ -15,15 +15,28 @@ class Erlgen
           @options[:with_git] = true
         end
 
+        o.on('--gen_server', 'create a skeleton gen_server module') do
+          @options[:file_only] = true
+          @options[:gen] = "gen_server"
+        end
+
+        o.on('--gen_fsm', 'create a skeleton gen_fsm module') do
+          @options[:file_only] = true
+          @options[:gen] = "gen_fsm"
+        end
+
+        o.on('--gen_event', 'create a skeleton gen_event module') do
+          @options[:file_only] = true
+          @options[:gen] = "gen_event"
+        end
+
+
         o.on_tail('-h', '--help', 'display this help and exit') do
           @options[:show_help] = true
         end
       end
       @opts.parse!(args)
-      
       @project_name = args.shift
-
-     
     end
 
     def run
@@ -36,8 +49,12 @@ class Erlgen
         $stderr.puts @opts
         return 1
       end
-
-      create_files
+      
+      if @options[:file_only]
+        create_gen
+      else
+        create_files
+      end
 
       if @options[:with_git]
         create_version_control
@@ -58,10 +75,15 @@ class Erlgen
       output_template_in_target 'application.erl', File.join('src', "#{@project_name}.erl")
       output_template_in_target 'application_sup.erl', File.join('src', "#{@project_name}_sup.erl") 
       output_template_in_target 'Rakefile'
+      touch_in_target File.join('include', "#{@project_name}.hrl")
     end
     
+    def create_gen
+       output_template_in_target "#{@options[:gen]}.erl", "#{@project_name}.erl"
+    end
+
     def target_dir
-      @project_name
+      @options[:file_only] ? (Dir['*'].include?('src') ? 'src' : Dir.pwd) : @project_name
     end
 
     def mkdir_in_target(directory)
@@ -86,6 +108,12 @@ class Erlgen
 
       $stdout.puts "\tcreate\t#{destination}"
     end
+    
+    def touch_in_target(destination)
+      final_destination = File.join(target_dir, destination)
+      FileUtils.touch  final_destination
+      $stdout.puts "\tcreate\t#{destination}"
+    end
 
     def template_dir
       File.join(File.dirname(__FILE__), 'templates')

data/lib/erlgen/templates/gen_event.erl

@@ -0,0 +1,105 @@
+%%%-------------------------------------------------------------------
+%%% File          : <%= @project_name%>.erl
+%%% Author        : 
+%%% Description   : 
+%%%
+%%% Created       : <%= Date.today.year%>
+%%%-------------------------------------------------------------------
+-module(<%= @project_name%>).
+
+-behaviour(gen_event).
+
+%% API
+-export([start_link/0, add_handler/0]).
+
+%% gen_event callbacks
+-export([init/1, handle_event/2, handle_call/2, 
+	 handle_info/2, terminate/2, code_change/3]).
+
+-record(state, {}).
+
+%%====================================================================
+%% gen_event callbacks
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function: start_link() -> {ok,Pid} | {error,Error} 
+%% Description: Creates an event manager.
+%%--------------------------------------------------------------------
+start_link() ->
+    gen_event:start_link({local, ?SERVER}). 
+
+%%--------------------------------------------------------------------
+%% Function: add_handler() -> ok | {'EXIT',Reason} | term()
+%% Description: Adds an event handler
+%%--------------------------------------------------------------------
+add_handler() ->
+    gen_event:add_handler(?SERVER, ?MODULE, []).
+
+%%====================================================================
+%% gen_event callbacks
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function: init(Args) -> {ok, State}
+%% Description: Whenever a new event handler is added to an event manager,
+%% this function is called to initialize the event handler.
+%%--------------------------------------------------------------------
+init([]) ->
+    {ok, #state{}}.
+
+%%--------------------------------------------------------------------
+%% Function:  
+%% handle_event(Event, State) -> {ok, State} |
+%%                               {swap_handler, Args1, State1, Mod2, Args2} |
+%%                               remove_handler
+%% Description:Whenever an event manager receives an event sent using
+%% gen_event:notify/2 or gen_event:sync_notify/2, this function is called for
+%% each installed event handler to handle the event. 
+%%--------------------------------------------------------------------
+handle_event(_Event, State) ->
+    {ok, State}.
+
+%%--------------------------------------------------------------------
+%% Function: 
+%% handle_call(Request, State) -> {ok, Reply, State} |
+%%                                {swap_handler, Reply, Args1, State1, 
+%%                                  Mod2, Args2} |
+%%                                {remove_handler, Reply}
+%% Description: Whenever an event manager receives a request sent using
+%% gen_event:call/3,4, this function is called for the specified event 
+%% handler to handle the request.
+%%--------------------------------------------------------------------
+handle_call(_Request, State) ->
+    Reply = ok,
+    {ok, Reply, State}.
+
+%%--------------------------------------------------------------------
+%% Function: 
+%% handle_info(Info, State) -> {ok, State} |
+%%                             {swap_handler, Args1, State1, Mod2, Args2} |
+%%                              remove_handler
+%% Description: This function is called for each installed event handler when
+%% an event manager receives any other message than an event or a synchronous
+%% request (or a system message).
+%%--------------------------------------------------------------------
+handle_info(_Info, State) ->
+    {ok, State}.
+
+%%--------------------------------------------------------------------
+%% Function: terminate(Reason, State) -> void()
+%% Description:Whenever an event handler is deleted from an event manager,
+%% this function is called. It should be the opposite of Module:init/1 and 
+%% do any necessary cleaning up. 
+%%--------------------------------------------------------------------
+terminate(_Reason, _State) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% Function: code_change(OldVsn, State, Extra) -> {ok, NewState} 
+%% Description: Convert process state when code is changed
+%%--------------------------------------------------------------------
+code_change(_OldVsn, State, _Extra) ->
+    {ok, State}.
+
+%%--------------------------------------------------------------------
+%%% Internal functions
+%%--------------------------------------------------------------------

data/lib/erlgen/templates/gen_fsm.erl

@@ -0,0 +1,149 @@
+%%%-------------------------------------------------------------------
+%%% File          : <%= @project_name%>.erl
+%%% Author        : 
+%%% Description   : 
+%%%
+%%% Created       : <%= Date.today.year%>
+%%%-------------------------------------------------------------------
+-module(<%= @project_name%>).
+
+-behaviour(gen_fsm).
+
+%% API
+-export([start_link/0]).
+
+%% gen_fsm callbacks
+-export([init/1, state_name/2, state_name/3, handle_event/3,
+	 handle_sync_event/4, handle_info/3, terminate/3, code_change/4]).
+
+-record(state, {}).
+
+%%====================================================================
+%% API
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function: start_link() -> ok,Pid} | ignore | {error,Error}
+%% Description:Creates a gen_fsm process which calls Module:init/1 to
+%% initialize. To ensure a synchronized start-up procedure, this function
+%% does not return until Module:init/1 has returned.  
+%%--------------------------------------------------------------------
+start_link() ->
+    gen_fsm:start_link({local, ?SERVER}, ?MODULE, [], []).
+
+%%====================================================================
+%% gen_fsm callbacks
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function: init(Args) -> {ok, StateName, State} |
+%%                         {ok, StateName, State, Timeout} |
+%%                         ignore                              |
+%%                         {stop, StopReason}                   
+%% Description:Whenever a gen_fsm is started using gen_fsm:start/[3,4] or
+%% gen_fsm:start_link/3,4, this function is called by the new process to 
+%% initialize. 
+%%--------------------------------------------------------------------
+init([]) ->
+    {ok, state_name, #state{}}.
+
+%%--------------------------------------------------------------------
+%% Function: 
+%% state_name(Event, State) -> {next_state, NextStateName, NextState}|
+%%                             {next_state, NextStateName, 
+%%                                NextState, Timeout} |
+%%                             {stop, Reason, NewState}
+%% Description:There should be one instance of this function for each possible
+%% state name. Whenever a gen_fsm receives an event sent using
+%% gen_fsm:send_event/2, the instance of this function with the same name as
+%% the current state name StateName is called to handle the event. It is also 
+%% called if a timeout occurs. 
+%%--------------------------------------------------------------------
+state_name(_Event, State) ->
+    {next_state, state_name, State}.
+
+%%--------------------------------------------------------------------
+%% Function:
+%% state_name(Event, From, State) -> {next_state, NextStateName, NextState} |
+%%                                   {next_state, NextStateName, 
+%%                                     NextState, Timeout} |
+%%                                   {reply, Reply, NextStateName, NextState}|
+%%                                   {reply, Reply, NextStateName, 
+%%                                    NextState, Timeout} |
+%%                                   {stop, Reason, NewState}|
+%%                                   {stop, Reason, Reply, NewState}
+%% Description: There should be one instance of this function for each
+%% possible state name. Whenever a gen_fsm receives an event sent using
+%% gen_fsm:sync_send_event/2,3, the instance of this function with the same
+%% name as the current state name StateName is called to handle the event.
+%%--------------------------------------------------------------------
+state_name(_Event, _From, State) ->
+    Reply = ok,
+    {reply, Reply, state_name, State}.
+
+%%--------------------------------------------------------------------
+%% Function: 
+%% handle_event(Event, StateName, State) -> {next_state, NextStateName, 
+%%						  NextState} |
+%%                                          {next_state, NextStateName, 
+%%					          NextState, Timeout} |
+%%                                          {stop, Reason, NewState}
+%% Description: Whenever a gen_fsm receives an event sent using
+%% gen_fsm:send_all_state_event/2, this function is called to handle
+%% the event.
+%%--------------------------------------------------------------------
+handle_event(_Event, StateName, State) ->
+    {next_state, StateName, State}.
+
+%%--------------------------------------------------------------------
+%% Function: 
+%% handle_sync_event(Event, From, StateName, 
+%%                   State) -> {next_state, NextStateName, NextState} |
+%%                             {next_state, NextStateName, NextState, 
+%%                              Timeout} |
+%%                             {reply, Reply, NextStateName, NextState}|
+%%                             {reply, Reply, NextStateName, NextState, 
+%%                              Timeout} |
+%%                             {stop, Reason, NewState} |
+%%                             {stop, Reason, Reply, NewState}
+%% Description: Whenever a gen_fsm receives an event sent using
+%% gen_fsm:sync_send_all_state_event/2,3, this function is called to handle
+%% the event.
+%%--------------------------------------------------------------------
+handle_sync_event(Event, From, StateName, State) ->
+    Reply = ok,
+    {reply, Reply, StateName, State}.
+
+%%--------------------------------------------------------------------
+%% Function: 
+%% handle_info(Info,StateName,State)-> {next_state, NextStateName, NextState}|
+%%                                     {next_state, NextStateName, NextState, 
+%%                                       Timeout} |
+%%                                     {stop, Reason, NewState}
+%% Description: This function is called by a gen_fsm when it receives any
+%% other message than a synchronous or asynchronous event
+%% (or a system message).
+%%--------------------------------------------------------------------
+handle_info(_Info, StateName, State) ->
+    {next_state, StateName, State}.
+
+%%--------------------------------------------------------------------
+%% Function: terminate(Reason, StateName, State) -> void()
+%% Description:This function is called by a gen_fsm when it is about
+%% to terminate. It should be the opposite of Module:init/1 and do any
+%% necessary cleaning up. When it returns, the gen_fsm terminates with
+%% Reason. The return value is ignored.
+%%--------------------------------------------------------------------
+terminate(_Reason, _StateName, _State) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% Function:
+%% code_change(OldVsn, StateName, State, Extra) -> {ok, StateName, NewState}
+%% Description: Convert process state when code is changed
+%%--------------------------------------------------------------------
+code_change(_OldVsn, StateName, State, _Extra) ->
+    {ok, StateName, State}.
+
+%%--------------------------------------------------------------------
+%%% Internal functions
+%%--------------------------------------------------------------------
+

data/lib/erlgen/templates/gen_server.erl

@@ -0,0 +1,96 @@
+%%%-------------------------------------------------------------------
+%%% File          : <%= @project_name%>.erl
+%%% Author        : 
+%%% Description   : 
+%%%
+%%% Created       : <%= Date.today.year %>
+%%%-------------------------------------------------------------------
+-module(<%= @project_name%>).
+
+-behaviour(gen_server).
+
+%% API
+-export([start_link/0]).
+
+%% gen_server callbacks
+-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
+	 terminate/2, code_change/3]).
+
+-record(state, {}).
+
+%%====================================================================
+%% API
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function: start_link() -> {ok,Pid} | ignore | {error,Error}
+%% Description: Starts the server
+%%--------------------------------------------------------------------
+start_link() ->
+    gen_server:start_link({local, ?SERVER}, ?MODULE, [], []).
+
+%%====================================================================
+%% gen_server callbacks
+%%====================================================================
+
+%%--------------------------------------------------------------------
+%% Function: init(Args) -> {ok, State} |
+%%                         {ok, State, Timeout} |
+%%                         ignore               |
+%%                         {stop, Reason}
+%% Description: Initiates the server
+%%--------------------------------------------------------------------
+init([]) ->
+    {ok, #state{}}.
+
+%%--------------------------------------------------------------------
+%% Function: %% handle_call(Request, From, State) -> {reply, Reply, State} |
+%%                                      {reply, Reply, State, Timeout} |
+%%                                      {noreply, State} |
+%%                                      {noreply, State, Timeout} |
+%%                                      {stop, Reason, Reply, State} |
+%%                                      {stop, Reason, State}
+%% Description: Handling call messages
+%%--------------------------------------------------------------------
+handle_call(_Request, _From, State) ->
+    Reply = ok,
+    {reply, Reply, State}.
+
+%%--------------------------------------------------------------------
+%% Function: handle_cast(Msg, State) -> {noreply, State} |
+%%                                      {noreply, State, Timeout} |
+%%                                      {stop, Reason, State}
+%% Description: Handling cast messages
+%%--------------------------------------------------------------------
+handle_cast(_Msg, State) ->
+    {noreply, State}.
+
+%%--------------------------------------------------------------------
+%% Function: handle_info(Info, State) -> {noreply, State} |
+%%                                       {noreply, State, Timeout} |
+%%                                       {stop, Reason, State}
+%% Description: Handling all non call/cast messages
+%%--------------------------------------------------------------------
+handle_info(_Info, State) ->
+    {noreply, State}.
+
+%%--------------------------------------------------------------------
+%% Function: terminate(Reason, State) -> void()
+%% Description: This function is called by a gen_server when it is about to
+%% terminate. It should be the opposite of Module:init/1 and do any necessary
+%% cleaning up. When it returns, the gen_server terminates with Reason.
+%% The return value is ignored.
+%%--------------------------------------------------------------------
+terminate(_Reason, _State) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% Func: code_change(OldVsn, State, Extra) -> {ok, NewState}
+%% Description: Convert process state when code is changed
+%%--------------------------------------------------------------------
+code_change(_OldVsn, State, _Extra) ->
+    {ok, State}.
+
+%%--------------------------------------------------------------------
+%%% Internal functions
+%%--------------------------------------------------------------------
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Dimitri Krassovski
@@ -69,6 +69,9 @@ files:
 - lib/erlgen/templates/application.app
 - lib/erlgen/templates/application.erl
 - lib/erlgen/templates/application_sup.erl
+- lib/erlgen/templates/gen_event.erl
+- lib/erlgen/templates/gen_fsm.erl
+- lib/erlgen/templates/gen_server.erl
 - spec/erlgen_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb