otp_kickoff 0.0.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Leandro Silva
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,46 @@
+= otp_kickoff
+
+Simple generator to kick off Erlang/OTP projects.
+
+== Install and configuration
+
+Install the gemcutter (a awesome gem hosting) support:
+
+  sudo gem install gemcutter
+
+More about gemcutter here http://gemcutter.org.
+
+Next, install the otp_kickoff:
+
+  sudo gem install otp_kickoff
+
+Finally, configure your preferences:
+
+  otp_kickoff configure --name=leandro --email=leandrodoze@gmail.com
+
+== Usage
+
+Type:
+
+  otp_kickoff new_application --name=amazingapp
+
+That will generate:
+
+  create  amazingapp/src
+  create  amazingapp/ebin
+  create  amazingapp/deps
+  create  amazingapp/src/amazingapp_app.app
+  create  amazingapp/src/amazingapp_app.erl
+  create  amazingapp/src/amazingapp_sup.erl
+  create  amazingapp/src/amazingapp_server.erl
+  create  amazingapp/src/amazingapp_handler.erl
+  create  amazingapp/src/amazingapp.erl
+  create  amazingapp/src/amazingapp.hrl
+
+== Next
+
+Enjoy a lot with Erlang/OTP programming!
+
+== Copyright
+
+Copyright (c) 2009 Leandro Silva. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "otp_kickoff"
+    gem.summary = %Q{Simple generator to kick off Erlang/OTP projects}
+    gem.email = "leandrodoze@gmail.com"
+    gem.homepage = "http://github.com/leandrosilva/otp_kickoff"
+    gem.authors = ["Leandro Silva"]
+    gem.add_development_dependency "rspec"
+    gem.add_dependency "thor"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "otp_kickoff #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/bin/otp_kickoff

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/otp_kickoff')
+
+OTPKickOff.start

data/lib/otp_kickoff.rb

@@ -0,0 +1,103 @@
+require 'rubygems'
+require 'thor'
+require 'yaml'
+
+#
+# Path to configuration file
+#
+CONFIGURATION_FILE = '~/.otp_kickoff'
+
+#
+# Thor classes, the magic of tasks!
+#
+class OTPKickOff < Thor
+  include Thor::Actions
+  
+  #
+  # Setup
+  #
+  
+  def self.source_root
+    File.expand_path(File.dirname(__FILE__) + '/..')
+  end
+  
+  def self.destination_root
+    File.expand_path(File.dirname('.'))
+  end
+  
+  #
+  # Tasks
+  #
+
+  no_tasks { attr_accessor :application_name, :author_name, :author_email, :today }
+  
+  # task: configure
+  
+  desc 'configure --author=AUTHOR --email=AUTHOR_EMAIL', 'configure informations about author'
+  method_options :author => :string, :email => :string
+  
+  def configure
+    #set data about author
+    @author_name  = options[:author]
+    @author_email = options[:email]
+    
+    create_file CONFIGURATION_FILE do
+      %Q{
+author_name: #{author_name}
+author_email: #{author_email}
+      }
+    end
+  end
+  
+  # task: new_application
+  
+  desc 'new_application --name=APPLICATION_NAME', 'generate a new Erlang/OTP application stub'
+  method_options :name => :string
+  
+  def new_application
+    # set data to templates
+    @application_name = options[:name]
+    
+    config_info   = ConfigInfo.new
+    @author_name  = config_info.author_name
+    @author_email = config_info.author_email
+    
+    @today = Date.today
+    
+    # generate templates
+    template 'resources/template_app.app',      "#{application_name}/src/#{application_name}_app.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
+end
+
+#
+# Helper class to get informations from configuration file (~/.otp_kickoff)
+#
+class ConfigInfo
+  attr_accessor :author_name, :author_email
+  
+  def initialize
+    begin
+      info = YAML.load_file(File.expand_path(CONFIGURATION_FILE))
+    rescue
+      puts "I'm sorry but the configuration file doesn't exists."
+      puts "Please run the command below:"
+      puts "  otp_kickoff configure --author=YOUR_NAME --email=YOUR_EMAIL"
+      
+      exit 0
+    end
+    
+    @author_name  = info["author_name"]
+    @author_email = info["author_email"]
+  end
+end

data/otp_kickoff.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{otp_kickoff}
+  s.version = "0.0.4"
+
+  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.default_executable = %q{otp_kickoff}
+  s.email = %q{leandrodoze@gmail.com}
+  s.executables = ["otp_kickoff"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/otp_kickoff",
+     "lib/otp_kickoff.rb",
+     "otp_kickoff.gemspec",
+     "resources/template_app.app",
+     "resources/template_app.erl",
+     "resources/template_appstart.erl",
+     "resources/template_handler.erl",
+     "resources/template_include.hrl",
+     "resources/template_server.erl",
+     "resources/template_sup.erl",
+     "spec/otp-kickoff_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/leandrosilva/otp_kickoff}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple generator to kick off Erlang/OTP projects}
+  s.test_files = [
+    "spec/otp-kickoff_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<thor>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<thor>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<thor>, [">= 0"])
+  end
+end

data/resources/template_app.app

@@ -0,0 +1,21 @@
+%%
+%% Resource application file
+%%
+%% File   : <%=application_name%>_handler.erl
+%% Created: <%=Date.today%>
+%%
+%% @author <%=author_name%> <<%=author_email%>>
+%% @copyright <%=today.year%> <%=author_name%>
+%%
+%% @doc TODO make nice description
+%%
+
+{application, <%=application_name%>_app,
+ [{description, "<%=application_name.capitalize%> application version 1.0"},
+  {vsn, "1.0"},
+  {modules, [<%=application_name%>_sup, <%=application_name%>_app, <%=application_name%>_server]},
+  {registered, [<%=application_name%>_sup]},
+  {applications, [kernel, stdlib, sasl]},
+	{env, [{var1, "Value of environment variable 1"}]}
+  {mod, {<%=application_name%>_app, []}}
+ ]}.

data/resources/template_app.erl

@@ -0,0 +1,36 @@
+%%
+%% Application module
+%%
+%% File   : <%=application_name%>_handler.erl
+%% Created: <%=Date.today%>
+%%
+%% @author <%=author_name%> <<%=author_email%>>
+%% @copyright <%=today.year%> <%=author_name%>
+%%
+%% @doc TODO make nice description
+%%
+
+-module(<%=application_name%>_app).
+-author('<%=author_name%> <<%=author_email%>>').
+
+-behaviour(application).
+ 
+-export([start/2, stop/1]).
+
+%% @spec start(_Type, _StartArgs)  -> {ok, Pid}
+%% @doc Application start callback <%=application_name%>
+start(_Type, _StartArgs) ->
+   case <%=application_name%>_sup:start_link() of
+      {ok, Pid} ->
+          alarm_handler:clear_alarm({application_stopped, ?MODULE}),
+          {ok, Pid};
+      Error ->
+          alarm_handler:set_alarm({{application_stopped, ?MODULE}, []}),
+          Error
+   end.
+
+%% @spec stop(_State) -> ok
+%% @doc Application stop callback for <%=application_name%>
+stop(_State) ->
+   alarm_handler:set_alarm({{application_stopped, ?MODULE}, []}),
+   ok.

data/resources/template_appstart.erl

@@ -0,0 +1,26 @@
+%%
+%% Start application module
+%%
+%% File   : <%=application_name%>_handler.erl
+%% Created: <%=Date.today%>
+%%
+%% @author <%=author_name%> <<%=author_email%>>
+%% @copyright <%=today.year%> <%=author_name%>
+%%
+%% @doc TODO make nice description
+%%
+
+-module(<%=application_name%>).
+-author('<%=author_name%> <<%=author_email%>>').
+
+-export ([start/0, stop/0]).
+
+%% @spec start() -> ok
+%% @doc Start the <%=application_name%> application
+start() ->
+	application:start(<%=application_name%>).
+	
+%% @spec stop() -> ok
+%% @doc Stop the <%=application_name%> application
+stop() ->
+	application:stop(%=application_name%>).

data/resources/template_handler.erl

@@ -0,0 +1,35 @@
+%%
+%% Handler module that can be used by server to catch and handle events
+%%
+%% File   : <%=application_name%>_handler.erl
+%% Created: <%=Date.today%>
+%%
+%% @author <%=author_name%> <<%=author_email%>>
+%% @copyright <%=today.year%> <%=author_name%>
+%%
+%% @doc TODO make nice description
+%%
+
+-module(<%=application_name%>_handler).
+-author('<%=author_name%> <<%=author_email%>>').
+
+-export([init/1, terminate/1, handle_event/2]).
+
+%% @spec init(State) -> State
+%% @doc Handler init callback
+init(State) -> State.
+
+%% @spec terminate(State) -> State
+%% @doc Handler terminate callback
+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
+handle_event(_Event, State) ->
+  State.

data/resources/template_include.hrl

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

data/resources/template_server.erl

@@ -0,0 +1,77 @@
+%%
+%% Supervised worker process module
+%%
+%% File   : <%=application_name%>_handler.erl
+%% Created: <%=Date.today%>
+%%
+%% @author <%=author_name%> <<%=author_email%>>
+%% @copyright <%=today.year%> <%=author_name%>
+%%
+%% @doc TODO make nice description
+%%
+
+-module(<%=application_name%>_server).
+-author('<%=author_name%> <<%=author_email%>>').
+
+-behaviour(gen_server).
+ 
+%% operation & maintenance 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]).
+
+%%
+%% Operation & Maintenance API
+%%
+
+%% @spec start_link() -> ServerReturn
+%% @doc Start the server for <%=application_name%>
+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
+init(State) ->
+  {ok, State}.
+ 
+%% @spec handle_call(_Request, _From, State) -> {reply, Reply, State}
+%% @doc Callback for synchronous requests
+handle_call(_Request, _From, State) ->
+   Reply = ok,
+   {reply, Reply, State}.
+ 
+%% @spec handle_cast(stop, State) -> {stop, normal, State}
+%% @doc Callback for assynchronous messages
+handle_cast(stop, State) ->
+	{stop, normal, State};
+
+%% @spec handle_cast(_Msg, State) -> {noreply, State}
+%% @doc Callback for assynchronous messages
+handle_cast(_Msg, State) ->
+   {noreply, State}.
+ 
+%% @spec handle_info(_Info, State) -> {noreply, State}
+%% @doc Callback for give informations about server
+handle_info(_Info, State) ->
+   {noreply, State}.
+ 
+%% @spec terminate(_Reason, _State) -> ok
+%% @doc Callback for free resources used by the server
+terminate(_Reason, _State) ->
+   ok.
+ 
+%% @spec code_change(_OldVsn, State, _Extra) -> {ok, State}
+%% @doc Callback for upgrade source code
+code_change(_OldVsn, State, _Extra) ->
+   {ok, State}.

data/resources/template_sup.erl

@@ -0,0 +1,47 @@
+%%
+%% Supervisor module
+%%
+%% File   : <%=application_name%>_handler.erl
+%% Created: <%=Date.today%>
+%%
+%% @author <%=author_name%> <<%=author_email%>>
+%% @copyright <%=today.year%> <%=author_name%>
+%%
+%% @doc TODO make nice description
+%%
+
+-module(<%=application_name%>_sup).
+-author('<%=author_name%> <<%=author_email%>>').
+
+-behaviour(supervisor).
+
+%% operation & maintenance api
+-export([start_link/0]).
+
+%% supervisor callback
+-export([init/1]).
+ 
+-define(SERVER, ?MODULE).
+ 
+%%
+%% Operation & Maintenance API
+%%
+
+%% @spec start_link() -> SupervisorReturn
+%% @doc Start the supervisor for <%=application_name%>
+start_link() ->
+   supervisor:start_link({local, ?SERVER}, ?MODULE, []).
+
+%%
+%% Supervisor callback function
+%%
+ 
+%% @spec init([]) -> SupervisorSpec
+%% @doc Callback for initialize the supervisor for <%=application_name%>
+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]},
+              
+   %% Restart strategies for childs
+   {ok, {{one_for_one, 10, 1}, [Server]}}.

data/spec/otp-kickoff_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "OtpKickoff" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'otp-kickoff'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: otp_kickoff
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Leandro Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-19 00:00:00 -07:00
+default_executable: otp_kickoff
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: leandrodoze@gmail.com
+executables: 
+- otp_kickoff
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/otp_kickoff
+- lib/otp_kickoff.rb
+- otp_kickoff.gemspec
+- resources/template_app.app
+- resources/template_app.erl
+- resources/template_appstart.erl
+- resources/template_handler.erl
+- resources/template_include.hrl
+- resources/template_server.erl
+- resources/template_sup.erl
+- spec/otp-kickoff_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/leandrosilva/otp_kickoff
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple generator to kick off Erlang/OTP projects
+test_files: 
+- spec/otp-kickoff_spec.rb
+- spec/spec_helper.rb