ktec-subtrac 0.1.23 → 0.1.24

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 1
-:patch: 23
+:patch: 24

data/bin/subtrac

@@ -16,7 +16,7 @@ command :install do |c|
   c.description = 'Installation of default files required to host multipe development projects.'
   c.example 'description', 'installs the default trac and svn setup'
   c.option '-c','--clean', 'Performs a clean install'
-  c.option '-d','--accept-defaults DEFAULTS', 'Accept all defaults'
+  c.option '-d','--defaults', 'Accept all defaults'
   c.when_called Subtrac::Commands::Install
 end
 

data/lib/subtrac.rb

@@ -50,85 +50,130 @@ module Subtrac
 
   class << self
 
-    # The Configuration instance used to configure the Subtrac environment
-    def configuration
-      @@configuration
-    end
+    # Filesystem directories
 
-    def configuration=(configuration)
-      @@configuration = configuration
+    def root
+      Pathname.new(SUBTRAC_ROOT) if defined?(SUBTRAC_ROOT)
     end
 
-    def initialized?
-      @initialized || false
+    def public_path
+      @public_path ||= self.root ? File.join(self.root, "public") : "public"
     end
- 
-    def initialized=(initialized)
-      @initialized ||= initialized
+    
+    def public_path=(path)
+      @public_path = path
     end
 
-    def root
-      Pathname.new(SUBTRAC_ROOT) if defined?(SUBTRAC_ROOT)
+    def subtrac_path
+      @subtrac_path ||= self.root ? File.join(self.root, "subtrac") : "subtrac"
     end
 
-    def public_path
-      @@public_path ||= self.root ? File.join(self.root, "public") : "public"
+    def install_dir
+      @install_dir ||= File.expand_path(@APP_CONFIG[:installation_dir])
+    end
+
+    def install_dir=(name)
+      puts "Setting new install_dir variable to #{name}"
+      @install_dir = name
     end
     
-    def subtrac_path
-      @@subtrac_path ||= self.root ? File.join(self.root, "subtrac") : "subtrac"
+    def apache_conf_dir
+      @apache_conf_dir ||= @APP_CONFIG[:apache_conf_dir]
     end
 
-    def public_path=(path)
-      @@public_path = path
+    def apache_conf_dir=(name)
+      @APP_CONFIG[:apache_conf_dir] = @@apache_conf_dir = name
     end
 
     def docs_dir
-      @@docs_dir ||= File.join(@install_dir,@APP_CONFIG[:dirs][:docs])
+      @docs_dir ||= File.join(install_dir,@APP_CONFIG[:dirs][:docs])
     end
 
-    def docs_dir=(dir)
-      @@docs_dir = dir
+    def svn_dir
+      @svn_dir ||= File.join(install_dir,@APP_CONFIG[:dirs][:svn])
     end
 
-    def svn_dir
-      @@svn_dir ||= File.join(@install_dir,@APP_CONFIG[:dirs][:svn])
+    def trac_dir
+      @trac_dir ||= File.join(install_dir,@APP_CONFIG[:dirs][:trac])
     end
 
-    def svn_dir=(dir)
-      @@svn_dir = dir
+    def temp_dir
+      @temp_dir ||= File.join(install_dir,@APP_CONFIG[:dirs][:temp])
     end
 
-    def trac_dir
-      @@trac_dir ||= File.join(@install_dir,@APP_CONFIG[:dirs][:trac])
+    def log_dir
+      @log_dir ||= File.join(install_dir,@APP_CONFIG[:dirs][:log])
     end
 
-    def trac_dir=(dir)
-      @@trac_dir = dir
+    def locations_dir
+      @locations_dir ||= File.join(install_dir,@APP_CONFIG[:dirs][:locations])
     end
 
-    def temp_dir
-      @@temp_dir ||= File.join(@install_dir,@APP_CONFIG[:dirs][:temp])
+    def server_name
+      @server_name ||= @APP_CONFIG[:server_name]
     end
 
-    def temp_dir=(dir)
-      @@temp_dir = dir
+    def server_name=(name)
+      @APP_CONFIG[:server_name] = @@server_name = name
     end
 
-    def log_dir
-      @@log_dir ||= File.join(@install_dir,@APP_CONFIG[:dirs][:log])
+    def server_hostname
+      @server_hostname ||= @APP_CONFIG[:server_hostname]
     end
 
-    def log_dir=(dir)
-      @@log_dir = dir
+    def server_hostname=(name)
+      @APP_CONFIG[:server_hostname] = @@server_hostname = name
     end
 
-    def locations_dir
-      @@locations_dir ||= File.join(@install_dir,@APP_CONFIG[:dirs][:locations])
+    def default_client
+      @default_client ||= @APP_CONFIG[:default_client]
+    end
+
+    def default_client=(name)
+      @APP_CONFIG[:default_client] = @@default_client = name
+    end
+    
+    def default_project
+      @default_project ||= @APP_CONFIG[:default_project]
+    end
+
+    def default_project=(name)
+      puts "Updating default_project to #{name}"
+      @APP_CONFIG[:default_project] = @@default_project = name
+    end
+
+    # LDAP
+
+    def enable_ldap
+      @enable_ldap ||= @APP_CONFIG[:ldap][:enable]
     end
 
-    def locations_dir=(dir)
-      @@locations_dir = dir
+    def enable_ldap=(value)
+      @APP_CONFIG[:ldap][:enable] = @@enable_ldap = value
+    end
+
+    def ldap_bind_dn
+      @ldap_bind_dn ||= @APP_CONFIG[:ldap][:bind_dn]
+    end
+
+    def ldap_bind_dn=(value)
+      @APP_CONFIG[:ldap][:bind_dn] = @@ldap_bind_dn = value
+    end
+    
+    def ldap_bind_password
+      @ldap_bind_password ||= @APP_CONFIG[:ldap][:bind_password]
+    end
+
+    def ldap_bind_password=(value)
+      @APP_CONFIG[:ldap][:bind_password] = @@ldap_bind_password = value
+    end
+    
+    def ldap_bind_host
+      @ldap_bind_host ||= @APP_CONFIG[:ldap][:bind_host]
+    end
+
+    def ldap_bind_host=(value)
+      @APP_CONFIG[:ldap][:bind_host] = @@ldap_bind_password = value
     end
     
   end
@@ -142,8 +187,7 @@ module Subtrac
     file_path = File.join(subtrac_path,"/config/config.yml") if not File.exists?(file_path)
     puts "Attempting to read config file: #{file_path}"
     begin
-      raw_config = File.read(file_path)
-      yamlFile = YAML.load(raw_config)
+      yamlFile = YAML.load(File.read(file_path))
     rescue Exception => e
       raise StandardError, "Config #{file_path} could not be loaded."
     end
@@ -156,100 +200,78 @@ module Subtrac
     else
       raise StandardError, "config/config.yml does not exist."
     end
-    puts "\n==== Installation options ===="
-    
-    say("Setting up default configuration...")
-    @server_name = @APP_CONFIG[:server_name]
-    @server_hostname = @APP_CONFIG[:server_hostname]
-    @server_ip = @APP_CONFIG[:server_ip]
-    
-    @default_client = @APP_CONFIG[:default_client]
-    @default_project = @APP_CONFIG[:default_project]
-    
-    @install_dir = File.expand_path(@APP_CONFIG[:installation_dir])
-    @conf_dir = @APP_CONFIG[:apache2_conf]
-    
-    @ldap_enable = @APP_CONFIG[:ldap][:enable]
-    if (@ldap_enable) then
-      @ldap_bind_dn = @APP_CONFIG[:ldap][:bind_dn]
-      @ldap_bind_password = @APP_CONFIG[:ldap][:bind_password]
-      @ldap_url = @APP_CONFIG[:ldap][:host]
-    end
-
+    say("Configuration loaded successfully...")
   end
 
 
   # Install
   def self.install(args,options)
     puts "\n==== Installing development server files ===="
+    
     if options.defaults then
-      create_environment_directories(options.clean)
-      install_common_files()
-      install_default_theme()
-      configure_admin_user()
-      create_virtual_host()
-      # create default project and client
-      create_project(@default_project,@default_client)
-      save_config()
+      overwrite = options.clean
+      confirm_default_client = true
     else
       # check where we are installing
-      change_install_dir = agree("The default installation directory is \"#{@install_dir}\". Would you like to change this? [Y/n]")
-      @install_dir = ask("Where would you like to install this server?") if change_install_dir
-
-      unless !File.directory?(@install_dir) 
+      confirm_or_replace_value(:install_dir,"install_dir")
+      
+      unless !File.directory?(install_dir) 
         # Ask if the user agrees (yes or no)
         confirm_clean = agree("Err, it seems there's some stuff in there. You sure you want me to overwrite? [Y/n]") if options.clean
-        confirm_clean = agree("Doubly sure? I can't undo this....[Y/n]") if confirm_clean
+        overwrite = agree("Doubly sure? I can't undo this....[Y/n]") if confirm_clean
       end
 
-      # right lets install
-      change_server_name = agree("The default server name is \"#{@server_name}\". Would you like to change this? [Y/n]")
-      @server_name = ask("What would you like to call your new development server?  ") if change_server_name
+      # confirm server
+      confirm_or_replace_value(:server_name,"server_name")
 
       # ask for hostname
-      change_server_hostname = agree("The default server hostname is \"#{@server_hostname}\". Would you like to change this? [Y/n]")
-      @server_hostname = ask("What url will your new server use?  ") if change_server_hostname
-
-      create_environment_directories(confirm_clean)
-      confirm_default_client = agree("Do you want to create a default client project? [Y/n]")
-      # create default project and client
-      if confirm_default_client
-        change_client = agree("The default client name is \"#{@default_client}\". Would you like to change this? [Y/n]")
-        @default_client = ask("What client name would you like to use?  ") if change_client
-        change_project = agree("The default project name is \"#{@default_project}\". Would you like to change this? [Y/n]")
-        @default_project = ask("What would you like to call your new project?  ") if change_project
-        create_project(@default_project,@default_client)
-      end
-      install_common_files()
-      install_default_theme()
-      configure_admin_user()
-      # TODO: Need to check for default client/project before creating virtual host
-      # otherwise we need remove the rewrite rule
-      create_virtual_host()
-      save_config()
+      confirm_or_replace_value(:server_hostname,"server_hostname")
+
+      # default client/project name
+      confirm_or_replace_value(:default_client,"default_client")
+      confirm_or_replace_value(:default_project,"default_project")
+
     end
+    
+    say("Ok we're about to install now, these are the options you have chosen:
+    installation directory: #{install_dir}
+    overwrite: #{overwrite}
+    server name: #{server_name}
+    server hostname: #{server_hostname}
+    default client: #{default_client}
+    default project: #{default_project}")
+
+    confirm = agree("Is this ok? [y/n]")
+    
+    exit 0 if !confirm
+    
+    create_environment_directories(overwrite)
+    create_virtual_host()
+    install_common_files()
+    install_default_theme()
+    configure_admin_user()
+    create_project(default_project,default_client)
+    save_config()
 
   end
 
   private
   
+  # confirms the current value with the user or accepts a new value if required
+  def self.confirm_or_replace_value(prop, name)
+    method(prop).call # initialise the property
+    current_value = instance_variable_get("@#{prop}")
+    accept_default = agree("The default value for #{prop} is \"#{current_value}\". Is this ok? [y/n]")
+    if !accept_default then
+      answer = ask("What would you like to change it to?")
+      send("#{prop}=", answer)
+      #instance_variable_set(prop, answer)
+    end
+  end
+  
   # Write the changes configuration to disk
   def self.save_config
-    # save the things that might have changed
-    @APP_CONFIG[:server_name] = @server_name
-    @APP_CONFIG[:server_hostname] = @server_hostname
-    @APP_CONFIG[:server_ip] = @server_ip
-    
-    @APP_CONFIG[:default_client] = @default_client
-    @APP_CONFIG[:default_project] = @default_project
-    
-    @APP_CONFIG[:installation_dir] = @install_dir
-    @APP_CONFIG[:apache2_conf] = @conf_dir
-    
-    @APP_CONFIG[:ldap][:bind_dn] = @ldap_bind_dn
-    @APP_CONFIG[:ldap][:bind_password] = @ldap_bind_password
-    @APP_CONFIG[:ldap][:host] = @ldap_url
-    
+    # save the things that might have changed    
     file_path = File.join(subtrac_path, USER_CONFIG)
     open(file_path, 'w') {|f| YAML.dump({SUBTRAC_ENV => @APP_CONFIG}, f)}
   end
@@ -281,17 +303,17 @@ module Subtrac
 
   # creates a new virtual host and reloads apache and enables the new virtual host
   def self.create_virtual_host
-    # TODO: Need to check for default client/project before creating virtual host
-    # otherwise we need remove the rewrite rule
     puts "\n==== Creating new virtual host ===="
     vhost_template = File.join(subtrac_path, @APP_CONFIG[:templates][:virtual_host])
-    puts "group apache tempalte: #{vhost_template}"
-    new_vhost = File.join(@conf_dir,@server_hostname)
+    puts "group apache virtual host template: #{vhost_template}"
+    # TODO: Copy this to the conf folder and map a file with an Include to it.
+    # this way the vhost file will get backed up as well.
+    new_vhost = File.join(apache_conf_dir,server_hostname)
     puts "group apache file: #{new_vhost}"
     parse_template(vhost_template,new_vhost,binding) if SUBTRAC_ENV != 'test'
     # reload apache configuration
     `/etc/init.d/apache2 force-reload` if SUBTRAC_ENV != 'test'
-    `a2ensite #{@server_hostname}` if SUBTRAC_ENV != 'test'
+    `a2ensite #{server_hostname}` if SUBTRAC_ENV != 'test'
   end
   
   def self.install_common_files
@@ -300,14 +322,12 @@ module Subtrac
     # TODO: refactor /common to the app config
     FileUtils.cp_r(Dir.glob(File.join(subtrac_path, "common/.")),docs_dir)
     FileUtils.cp_r(Dir.glob(File.join(subtrac_path, "shared/.")),create_if_missing(File.join(trac_dir, ".shared")))
-    # this need to be replaced with a question/answer session
-    #FileUtils.cp(,@install_dir)
   end
   
   def self.configure_admin_user
     puts "\n==== Configure admin user ===="
     # create admin user
-    passwd_file = File.join(@install_dir, ".passwd")
+    passwd_file = File.join(install_dir, ".passwd")
     admin_user = ask("New admin user:  ") { |q| q.echo = true }
     admin_pass = ask("New password:  ") { |q| q.echo = "*" }
     admin_pass_confirm = ask("Re-type new password:  ") { |q| q.echo = "*" }
@@ -324,11 +344,11 @@ module Subtrac
 
   def self.create_environment_directories(overwrite=false)
     puts "\n==== Creating new environment directories ===="
-    FileUtils.rm_rf @install_dir if overwrite
-    create_if_missing @install_dir
+    FileUtils.rm_rf install_dir if overwrite
+    create_if_missing install_dir
     # create the environment directories
     @APP_CONFIG[:dirs].each do |key, value|
-      dir = File.join(@install_dir,value)
+      dir = File.join(install_dir,value)
       create_if_missing dir
     end
   end  
@@ -365,8 +385,9 @@ module Subtrac
     
     #`sudo svn co --username #{@APP_CONFIG[:admin_user]} --password #{@APP_CONFIG[:admin_pass]} \
     #    file://#{svn_dir}/#{client_name}/trac_theme/trunk #{client_theme_dir}` if SUBTRAC_ENV != 'test'
+    # TODO: Need to find a way to test before trying
     template_dir = File.join(subtrac_path, "templates","trac","themes","subtractheme")
-    `sudo easy_install #{template_dir}`
+    say(`sudo easy_install #{template_dir}`)
   end
   
   def self.create_project(project, client, project_type=@APP_CONFIG[:default_project_template])
@@ -412,7 +433,7 @@ module Subtrac
     # create a new trac site
     say("Creating a new trac site...")
     result = `trac-admin #{project_trac_dir} initenv #{project_name} sqlite:#{project_trac_dir}/db/trac.db svn #{project_svn_dir}` if SUBTRAC_ENV != 'test'
-    FileUtils.chown_R('www-data', 'www-data', project_trac_dir, :verbose => true)  if SUBTRAC_ENV != 'test'
+    FileUtils.chown_R('www-data', 'www-data', project_trac_dir, :verbose => false)  if SUBTRAC_ENV != 'test'
     FileUtils.mkdir_p("#{project_trac_dir}/conf") if SUBTRAC_ENV == 'test' # fake the folder for tests
     
     say("Installing trac configuration...")
@@ -443,7 +464,8 @@ module Subtrac
     end
 
     # chown the whole directory
-    FileUtils.chown_R('www-data', 'www-data', File.join(@install_dir,"*"), :verbose => true)  if SUBTRAC_ENV != 'test'
+    `sudo chown -R www-data:www-data #{install_dir}`
+    #FileUtils.chown_R('www-data', 'www-data', File.join(install_dir,"*"), :verbose => true)  if SUBTRAC_ENV != 'test'
     
     # run trac upgrade
     say("Upgrading the trac installation...")

data/lib/subtrac/config/config.yml

@@ -3,7 +3,6 @@ development: &non_production_settings
     :admin_user: "admin"
     :server_name: "Subtrac Development Server"
     :server_hostname: "dev.subtrac.com"
-    :server_ip: "192.168.2.1"
     
     :installation_dir: test
 
@@ -13,7 +12,7 @@ development: &non_production_settings
     :default_project: "Public"
     :shared_trac_ini: "shared/trac.ini"
 
-    :apache2_conf: /etc/apache2/sites-available
+    :apache_conf_dir: /etc/apache2/sites-available
 
     :ldap:
         :enable: false

data/lib/subtrac/templates/projects/blank/trac/wiki/WikiStart

@@ -13,7 +13,7 @@ This is the home of development for <%= client %>. This page is editable by desi
 Make sure you have subversion client installed, then you can check the project out using:
 
 {{{
-svn checkout http://<%= @server_hostname %><%= @APP_CONFIG[:urls][:svn] %>/<%= client_name %>/<%= project_name %>/trunk <%= project_name %>
+svn checkout http://<%= server_hostname %><%= @APP_CONFIG[:urls][:svn] %>/<%= client_name %>/<%= project_name %>/trunk <%= project_name %>
 }}}
 
 === Using SVN ===

data/lib/subtrac/templates/vhost.conf.erb

@@ -1,26 +1,26 @@
 <virtualhost *>
 	ServerAdmin webmaster@localhost
-	ServerName <%= @server_hostname %>
+	ServerName <%= server_hostname %>
 	DocumentRoot <%= docs_dir %>
-	ErrorLog <%= log_dir %>/error.<%= @server_hostname %>.log
-	CustomLog <%= log_dir %>/access.<%= @server_hostname %>.log combined
+	ErrorLog <%= log_dir %>/error.<%= server_hostname %>.log
+	CustomLog <%= log_dir %>/access.<%= server_hostname %>.log combined
 	LogLevel error
 
 	RewriteEngine On
-	RewriteRule ^/$ http://<%= @server_hostname %>/<%= @default_client.downcase %>/<%= @default_project.downcase %>
-	RewriteRule ^/index*$ http://<%= @server_hostname %>/<%= @default_client.downcase %>/<%= @default_project.downcase %>
+	RewriteRule ^/$ http://<%= server_hostname %>/<%= default_client.downcase %>/<%= default_project.downcase %>
+	RewriteRule ^/index*$ http://<%= server_hostname %>/<%= default_client.downcase %>/<%= default_project.downcase %>
 
 	<location />
 		AuthType Basic
-		AuthName '<%= @server_name %>'
-		AuthUserFile <%= @install_dir %>/.passwd
+		AuthName '<%= server_name %>'
+		AuthUserFile <%= install_dir %>/.passwd
 		Require valid-user
 		AuthBasicProvider file
-		<% if @ldap_enable then %>
+		<% if enable_ldap then %>
 		#AuthBasicProvider file ldap
-		#AuthLDAPBindDN '<%= @ldap_bind_dn %>'
-		#AuthLDAPBindPassword '<%= @ldap_bind_password %>'
-		#AuthLDAPURL '<%= @ldap_url %>'
+		#AuthLDAPBindDN '<%= ldap_bind_dn %>'
+		#AuthLDAPBindPassword '<%= ldap_bind_password %>'
+		#AuthLDAPURL '<%= ldap_url %>'
 		#AuthzLDAPAuthoritative off
 		<% end %>
 	</location>
@@ -30,7 +30,7 @@
 		SVNParentPath <%= @APP_CONFIG[:dirs][:svn] %>/
 		SVNListParentPath On
 		SVNAutoversioning On
-		SVNReposName '<%= @server_name %>'
+		SVNReposName '<%= server_name %>'
 	</location>
 
 	Include <%= locations_dir %>/*

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ktec-subtrac
 version: !ruby/object:Gem::Version 
-  version: 0.1.23
+  version: 0.1.24
 platform: ruby
 authors: 
 - Keith Salisbury
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-22 00:00:00 -07:00
+date: 2009-04-23 00:00:00 -07:00
 default_executable: subtrac
 dependencies: 
 - !ruby/object:Gem::Dependency