logirel 0.0.15 → 0.0.17

data/.semver

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 0
-:patch: 15
+:patch: 17
 :special: ""

data/README.md

@@ -1,41 +1,39 @@
-Let's try and make a gem to create .Net projects easily.
-
-Getting started
-===============
- 1. `gem install logirel`
- 1. Go to the project of your choice
- 1. `logirel init`
- 1. You should now answer the questions that logirel poses.
-
- 
-Hacking it
-==========
- 1. `git clone https://haf@github.com/haf/logirel.git`
- 1. `bundle install`
- 1. `bundle exec rspec spec`
-
-My thinking
-===========
-
-Some problems I want to solve with this project;
-
- * (bundler/semver/rake/gems)		having foundations for semver, rake for builds and nuget for packaging. 
- * (logirel) 						easily adding structure to a solution folder created with Visual Studio `logirel init`
- * (gitflow)						using ["a successful branching model"](http://nvie.com/posts/a-successful-git-branching-model/)
- * (logirel/teamcity)				continuous integration friendly with 'environments' and transform files for e.g. config files
- * (logirel)						easily updating buildscripts from a git repository 'logirel update', which runs `git pull -s subtree logirel master`.
- * ensuring correct versions of build script dependencies
+Let's try and make a gem to create .Net projects easily.
+
+Getting started
+===============
+ 1. `gem install logirel`
+ 1. Go to the project of your choice
+ 1. `logirel init`
+ 1. You should now answer the questions that logirel poses.
+ 1. after it's done, run `rake`.
+
+ 
+Hacking it
+==========
+ 1. `git clone https://haf@github.com/haf/logirel.git`
+ 1. `bundle install`
+ 1. `bundle exec rspec spec`
+
+My thinking
+===========
+
+Some problems I want to solve with this project;
+
+ * (bundler/semver/rake/gems)		having foundations for semver, rake for builds and nuget for packaging. 
+ * (logirel) 						easily adding structure to a solution folder created with Visual Studio `logirel init`
+ * (gitflow)						using ["a successful branching model"](http://nvie.com/posts/a-successful-git-branching-model/)
+ * (logirel/teamcity)				continuous integration friendly with 'environments' and transform files for e.g. config files
+ * (logirel)						easily updating buildscripts from a git repository `gem update ; logirel update`
+ * ensuring correct versions of build script dependencies
  * (nuget/owrap/symbolserver.org)	ensuring correct versions of source code dependencies
- * (gitflow)						nicely tagging your source trees corresponding to semver
+ * (gitflow)						nicely tagging your source trees corresponding to semver
  * `nuget :nuget do |n|; 'git ls-files'.split("\n").each{ |f| n.file f }; end` create a nuget item with just files
 
 TODO list
 =========
 
- 1. create gemspec for releases
- 1. learn how to unit test ruby and put some fences around my 'release' f-n
- 1. build a small interactive prompt; it should set project properties when invoked
- 1. specify dependencies with bundler: bundler + bundle, semver, albacore, ruby, rake, nuget
+ 1. make the core functionality solid
  1. sample configuration settings for team city to build from github
  1. build rake tasks invoking semver with ruby that integrate with teamcity
  1. try the gem out on the transactions, auto tx and nhibernate facility projects
@@ -60,7 +58,9 @@ of managing another build is too large.
 
 Shoulders of Giants
 ===================
- * http://madduck.net/blog/2007.07.11:creating-a-git-branch-without-ancestry/
- * http://rubydoc.info/github/wycats/thor/master/file/README.md
- * https://github.com/radar/guides/blob/master/gem-development.md
- * http://eggsonbread.com/2010/03/28/my-rspec-best-practices-and-tips/
+ * http://madduck.net/blog/2007.07.11:creating-a-git-branch-without-ancestry/
+ * http://rubydoc.info/github/wycats/thor/master/file/README.md
+ * https://github.com/radar/guides/blob/master/gem-development.md
+ * http://eggsonbread.com/2010/03/28/my-rspec-best-practices-and-tips/
+ * https://github.com/jondot/albathor (I actually started work on this one, before I saw this project; none the less
+   I've integrated pieces of its functionality into logirel, mostly its actions module and vs proj parsing.)

data/Rakefile.rb

@@ -48,5 +48,4 @@ desc "run specs, tag, push and release (to rubygems)"
 task :all => [:verify] do
   Rake::Task["spec"].invoke
   Rake::Task["release"].invoke
-  Rake::Task["push"].invoke
 end

data/lib/logirel/Initer.rb

@@ -1,152 +1,124 @@
-require 'semver'
+require 'logirel/queries/bool_q'
+require 'logirel/queries/str_q'
+require 'semver'
 require 'enumerator'
 require 'net/http'
-require 'logirel/q_model'
 require 'uuid'
 
-
 module Logirel
   class Initer
-    
-    attr_accessor :root_path, :buildscripts_path
-    
-    def initialize(root = '.', buildscripts = 'buildscripts'); 
+
+    attr_reader :root_path, :buildscripts_path, :tools_path
+
+    def initialize(root = '.',
+        buildscripts = 'buildscripts',
+        tools = 'tools')
       @root_path = root
       @buildscripts_path = buildscripts
+      @tools_path = tools
     end
-    def set_root(root); @root_path = root; end
-    
-    def get_commands
-      cmd ||= []
-      cmd << "semver init"
-    end
-    
+
     def nuget_from_codeplex(cp_ver, gem_ver)
       (cp_ver <=> gem_ver) > 0
     end
-    
-    def create_structure
-      # puts "making dir #{@root_path}"
-      ['buildscripts', 'src'].each do |d|
-        path = File.join(@root_path, d)
-        Dir.mkdir path unless Dir.exists? path
-      end
-    end
-    
+
     def create_path_folders(metas, f)
-      	f.puts %q{
+      f.puts %q{
 require File.dirname(__FILE__) + '/project_data'
 root_folder = File.expand_path("#{File.dirname(__FILE__)}/..")
 Folders = \{
-}
-		f.puts ":src => " + StrQ.new("src").exec + ","
-		f.puts ":out => " + StrQ.new("build").exec + ","
-		f.puts ":package => " + StrQ.new("packages").exec + ","
-		f.puts ":tools => " + StrQ.new("tools").exec + ","
-		f.puts %q{:tests => File.join("build", "tests"),
+             }
+      f.puts ":src => " + StrQ.new("src").exec + ","
+      f.puts ":out => " + StrQ.new("build").exec + ","
+      f.puts ":package => " + StrQ.new("packages").exec + ","
+      f.puts ":tools => " + StrQ.new("tools").exec + ","
+      f.puts %q{:tests => File.join("build", "tests"),
 :nuget => File.join("build", "nuget"),
 :root => root_folder,
 :binaries => "placeholder - specify build environment",
 }
-		f.puts ":#{metas[:ruby_key]}" + " => {"
-        f.puts ':nuspec => File.join("build", "nuspec", Projects[' + ":#{metas[:ruby_key]}" + '][' + ":#{metas[:dir]}" + ']),'
-        f.puts %q{:out => 'placeholder - specify build environment',
+      f.puts ":#{metas[:ruby_key]}" + " => {"
+      f.puts ':nuspec => File.join("build", "nuspec", Projects[' + ":#{metas[:ruby_key]}" + '][' + ":#{metas[:dir]}" + ']),'
+      f.puts %q{:out => 'placeholder - specify build environment',
 :test_out => 'placeholder - specify build environment'
 \},\}}
-	end
-	
-	def create_path_files(metas, f)
-	    f.puts "Files = {"
-		f.puts ":sln => " + StrQ.new("sln").exec + ","
-		f.puts ":#{metas[:ruby_key]} => {"
-		f.puts ':nuspec => File.join(Folders[:nuspec], Projects[' + ":#{metas[:ruby_key]}" + '][' + ":#{metas[:id]}" + '].nuspec),'
-		f.puts %q{:nunit => File.join(Folders[:nunit], "nunit-console.exe"),
+    end
+
+    def create_path_files(metas, f)
+      f.puts "Files = {"
+      f.puts ":sln => " + StrQ.new("sln").exec + ","
+      f.puts ":#{metas[:ruby_key]} => {"
+      f.puts ':nuspec => File.join(Folders[:nuspec], Projects[' + ":#{metas[:ruby_key]}" + '][' + ":#{metas[:id]}" + '].nuspec),'
+      f.puts %q{:nunit => File.join(Folders[:nunit], "nunit-console.exe"),
 :ilmerge => File.join(Folders[:tools], "ILMerge.exe")
 \},\}}
-	end
-	
-	def create_path_commands(metas, f)
-	  	f.puts %q{Commands = \{
+    end
+
+    def create_path_commands(metas, f)
+      f.puts %q{Commands = \{
 :nuget => File.join(Folders[:tools], "NuGet.exe")
 \}}
-	end
-	
-	def create_path_uris(metas, f)
-	  	f.puts %q{Uris = \{
+    end
+
+    def create_path_uris(metas, f)
+      f.puts %q{Uris = \{
 :nuget_offical => "http://packages.nuget.org/v1/"
 \}}
-	end
-	
-	def init_paths_rb(metas)
+    end
+
+    def init_paths_rb metas
       File.open(File.join(@root_path, @buildscripts_path, "paths.rb"), "w") do |f|
         create_path_folders(metas, f)
-		create_path_files(metas, f)
-		create_path_commands(metas, f)
-		create_path_uris(metas, f)
-	  end
-	  # File.open(File.join(@root_path, @buildscripts_path, "paths.rb"), "r") do |infile|
-        # puts ""
-		# puts ""
-		# while (line = infile.gets)
-          # puts "#{line}"
-        # end
-	  # end
-	end
-	
-	def init_environement_rb
-	  base_path = ensure_path @buildscripts_path
-	  path = File.join base_path, "environment.rb"
-	  File.open(path, "w") do |f|
-	    f.puts Net::HTTP.get(
-		  URI.parse('https://raw.github.com/haf/logirel/master/content/environment.rb'))
-	  end
-	end
-	
-	def parse_folders
-	  src = File.join(@root_path, 'src', '*')
-	  Dir.
-	    glob(src).
-	    keep_if{ |i| 
-		  projs = File.join(i, "*.{csproj,vbproj,fsproj}")
-		  File.directory? i and Dir.glob(projs).length > 0
-		}.
-		map{|x| File.basename(x) }
-	end
-	
-	def init_gemfile
-	  File.open(File.join(@root_path, "Gemfile"), "w+") do |f|
+        create_path_files(metas, f)
+        create_path_commands(metas, f)
+        create_path_uris(metas, f)
+      end
+    end
+
+    def init_environement_rb
+      base_path = ensure_path @buildscripts_path
+      path = File.join base_path, "environment.rb"
+      File.open(path, "w") do |f|
+        f.puts Net::HTTP.get(
+                   URI.parse('https://raw.github.com/haf/logirel/master/content/environment.rb'))
+      end
+    end
+
+
+    def init_gemfile
+      File.open(File.join(@root_path, "Gemfile"), "w+") do |f|
         f.puts 'source "http://rubygems.org"'
         f.puts 'gem "albacore"'
-		f.puts 'gem "semver"'
-		f.puts 'gem "bundler"'
-	  end
-	end
-	
-	def init_utils
-	  base_path = ensure_path @buildscripts_path
-	  path = File.join base_path, "utils.rb"
-	  File.open(path, "w") do |f|
-	    f.puts Net::HTTP.get(
-		  URI.parse('https://raw.github.com/haf/logirel/master/content/utils.rb'))
-	  end
-	end
-	
-	def build_tasks(metas)
-	  
-	end
-	
-	def assembly_infos(metas)
-	  
-	end
-	# asm info for every nuget
-	def nugets(metas)
-	  
-	end
-	
-	def init_rakefile(metas)
-	  base_path = ensure_path @buildscripts_path
+        f.puts 'gem "semver"'
+        f.puts 'gem "bundler"'
+      end
+    end
+
+    def init_utils
+      base_path = ensure_path @buildscripts_path
+      path = File.join base_path, "utils.rb"
+      File.open(path, "w") do |f|
+        f.puts Net::HTTP.get(
+                   URI.parse('https://raw.github.com/haf/logirel/master/content/utils.rb'))
+      end
+    end
+
+    def build_tasks metas
+
+    end
+
+    def assembly_infos metas
+
+    end
+
+    def nugets metas
+
+    end
+
+    def init_rakefile(metas)
+      base_path = ensure_path @buildscripts_path
       File.open File.join(base_path, "Rakefile.rb"), "w" do |f|
-	    f.puts %q{
+        f.puts %q{
 require 'rubygems'
 require 'bundler'
 Bundler.setup
@@ -164,46 +136,27 @@ task :release => ["env:release", :build]
 task :ci => ["env:release", :build, :package]
 }
         f.puts "task :build => #{metas[:ruby_key]}"
-		
-		f.puts build_tasks(metas)
-	  end
-	end
-	
+
+        f.puts build_tasks(metas)
+      end
+    end
+
     def init_project_details(metadata)
-	  base_path = ensure_path @buildscripts_path
-	  projects = {}
-	  metadata.each{|m|
-	    projects[:"#{m[:ruby_key]}"] = m #.select{|kv| :"#{kv[0]}" != :"ruby_key"}
-	  }
+      base_path = ensure_path @buildscripts_path
+      projects = {}
+      metadata.each { |m|
+        projects[:"#{m[:ruby_key]}"] = m #.select{|kv| :"#{kv[0]}" != :"ruby_key"}
+      }
       File.open(File.join(base_path, "project_details.rb"), "w+") do |f|
         f.puts "Projects = #{p(projects)}"
       end
     end
-	
-	def ensure_path path
+
+    def ensure_path path
       base_path = File.join @root_path, path
       Dir.mkdir base_path unless Dir.exists? base_path
-	  base_path
-	end
-	
-	def meta_for p, dir
-        base = File.basename(p)
-        
-        puts "META DATA FOR: '#{base}'"
-        p_dir = File.join(dir, base)
-        
-        {
-          :title => StrQ.new("Title", base).exec,
-          :dir => p_dir,
-          :test_dir => StrQ.new("Test Directory", base + ".Tests").exec,
-          :description => StrQ.new("Description", "Missing description for #{base}").exec,
-          :copyright => StrQ.new("Copyright").exec,
-          :authors => StrQ.new("Authors").exec,
-          :company => StrQ.new("Company").exec,
-          :nuget_key => StrQ.new("NuGet key", base).exec,
-          :ruby_key => StrQ.new("Ruby key (e.g. 'autotx')", nil, STDIN, lambda { |s| s != nil && s.length > 0 }).exec,
-          :guid => UUID.new.generate
-        }
-	end
+      base_path
+    end
+
   end
 end

data/lib/logirel/cli.rb

@@ -1,74 +1,75 @@
-require 'logirel/initer'
 require 'logirel/version'
-require 'logirel/q_model'
+require 'logirel/queries'
+require 'logirel/vs/solution'
+require 'logirel/vs/environment'
+require 'logirel/tasks/albacore_tasks'
+require 'logirel/cli_helper'
 require 'uuid'
 require 'thor'
-require 'FileUtils'
+require 'fileutils'
 
 module Logirel
- class CLI < Thor
-    
-	desc "init", "Convert the current folder's projects (src) into a rake+albacore build"
-	def init(root_dir = Dir.pwd)
-      
-      puts "logirel"
-      puts "======="
-      curr = Dir.pwd
-      puts "Current dir: #{curr}"
+  class CLI < Thor
+    include Thor::Actions
+    include Logirel::Tasks
+    include Logirel::Queries
 
-      puts ""
-      puts "Directories Selection"
-      puts "---------------------"
-      
-      folder = lambda { |query, default|
-        StrQ.new(query, default, STDIN, lambda { |dir| 
-          true # perform validation here if you wish
-        }, STDOUT)
-      }
-      
-      src_folders = Initer.new('.').parse_folders.inspect
-      dir = folder.call("Source Directory. Default (src) contains (#{src_folders})", "src").exec
-      buildscripts = folder.call("Buildscripts Directory", "buildscripts").exec
-      tools = folder.call("Tools Directory", "tools").exec
-      initer = Initer.new(".")
-      initer.buildscripts_path = buildscripts
-      
-      puts ""
-      puts "Project Selection"
-      puts "-----------------"
-      
-      selected_projs = initer.parse_folders.
-        find_all { |f| BoolQ.new(f).exec }
+    source_paths << File.expand_path("../templates", __FILE__)
+    source_paths << Dir.pwd
+
+    default_task :init
+    class_option "verbose",  :type => :boolean, :banner => "Enable verbose output mode", :aliases => "-v"
+
+    desc "init [[--root=]ROOT-DIR] [[--template=]FILENAME]", "Initialize rakefile w/ albacore. Defaults to the current directory"
+    long_desc <<-D
+      Init scaffolds a directory structure for building the .Net project with albacore/rake. It takes as parameters
+      the root directory, which contains a 'src' folder, which should contain the projects. It aims not to overwrite
+      existing infrastructure, should such infrastructure exist.
+    D
+    method_option "root", :type => :string, :banner => "Perform the initialization in the given root directory"
+    method_option "raketempl", :type => :string, :banner => "Specify the initialization template to use"
+    def init(root = Dir.pwd, raketempl = 'Rakefile.tt')
+      opts = options.dup
+      helper = CliHelper.new opts.fetch("root", root)
+
+      puts "logirel v#{Logirel::VERSION}"
+      @folders = helper.folders_selection
+      @files = helper.files_selection folders
+
+      puts "Choose what projects to include:"
+      selected_projs = helper.parse_folders(folders[:src]).find_all { |f| BoolQ.new(f).exec }
 
-      puts "Selected: #{selected_projs.inspect}"
-      
-      
-      puts "initing semver in folder #{dir}"
-      `semver init`
-      puts "done..."
       puts ""
-      puts "Project Meta-Data Definitions"
-      puts "-----------------------------"
-      puts "Let's set up some meta-data!"
-      metas = selected_projs.map{|p| initer.meta_for p, dir }
-      
-	  puts "initing project details"
-	  initer.init_project_details(metas)
-      
-	  puts "initing paths"
-	  initer.init_path_rb(metas)
-      
-	  puts "initing environment"
-	  initer.init_environement_rb
-	  
-	  puts "initing gemfile"
-	  initer.init_gemfile
-	  
-	  puts "initing utils"
-	  initer.init_utils
-	  
-	  puts "initing meta-datas"
-      initer.init_rakefile(metas)
+      @metas = selected_projs.empty? ? [] : helper.metadata_interactive(selected_projs)
+
+      puts "initing main environment"
+      run 'semver init'
+
+      template 'Gemfile',             File.join(root, 'Gemfile')
+      template 'gitignore.tt',        File.join(root, '.gitignore')
+      template 'project_details.tt',  File.join(root, folders[:buildscripts], 'project_details.rb')
+      template 'paths.tt',            File.join(root, folders[:buildscripts], 'paths.rb')
+      template 'environment.tt',      File.join(root, folders[:buildscripts], 'environment.rb')
+      template 'utils.tt',            File.join(root, folders[:buildscripts], 'utils.rb')
+      template raketempl,             File.join(root, 'Rakefile.rb')
+      run 'git init'
+      run 'git add .'
+      # TODO: add a few nuget, nuspec, owrap, fpm, puppet etc tasks here!
+
+      helper.say_goodbye
+    end
+
+    protected
+    def metas
+      @metas ||= {}
+    end
+
+    def folders
+      @folders ||= {}
+    end
+
+    def files
+      @files ||= {}
     end
   end
 end

data/lib/logirel/cli_helper.rb

@@ -0,0 +1,86 @@
+require 'logirel/queries'
+
+module Logirel
+  class CliHelper
+    include Logirel::Queries
+
+    def initialize root_dir
+      @root_dir = root_dir
+    end
+
+    # src: relative path!
+    def parse_folders src
+      src = File.join(@root_dir, src, '*')
+      Dir.
+          glob(src).
+          keep_if { |i|
+        projs = File.join(i, "*.{csproj,vbproj,fsproj}")
+        File.directory? i and Dir.glob(projs).length > 0
+      }.map { |x| File.basename(x) }
+    end
+
+    def folders_selection
+      puts "Directories Selection"
+      puts "---------------------"
+      puts "Current dir: #{@root_dir}, #{Dir.entries(@root_dir).keep_if{|x|
+        x != '.' && x != '..' && File.directory?(File.join(@root_dir, x))
+      }.
+          empty? ? 'which is empty.' : 'which contains folders.'}"
+      puts ""
+
+      {
+          :src => StrQ.new("Source Directory. Default (src) contains (#{parse_folders('src').inspect})", 'src').exec,
+          :buildscripts => StrQ.new("Buildscripts Directory", "buildscripts").exec,
+          :build => StrQ.new("Build Output Directory", "build").exec,
+          :tools => StrQ.new("Tools Directory", "tools").exec
+      }
+    end
+
+    # folders: hash (as defined above), of folder paths
+    def files_selection folders
+      puts "Looking at src folder: '#{folders[:src]}'."
+      {
+          :sln => StrQ.new("sln file", Dir.glob(File.join(@root_dir, folders[:src],"*.sln")).first).exec
+      }
+    end
+
+    def metadata_interactive selected_projs
+      puts "Project Meta-Data Definitions"
+      puts "-----------------------------"
+      puts "Let's set up some meta-data!"
+      puts ""
+      selected_projs.map { |p| meta_for p }
+    end
+
+    def say_goodbye
+      puts ""
+      puts "SCAFFOLDING DONE! Now run 'bundle install' to install any dependencies for your albacore rakefile,"
+      puts " and git commit to commit changes!"
+      puts ""
+      puts "Footnote:"
+      puts "If you hack a nice task or deployment script - feel free to send some code to henrik@haf.se to"
+      puts "make it available for everyone and get support on it through the community for free!"
+    end
+
+    private
+    def meta_for p
+      base = File.basename(p)
+
+      puts "META DATA FOR: '#{base}'"
+      p_dir = File.join(@root_dir, base)
+
+      {
+          :title => StrQ.new("Title", base).exec,
+          :dir => p_dir,
+          :test_dir => StrQ.new("Test Directory", base + ".Tests").exec,
+          :description => StrQ.new("Description", "Missing description for #{base}").exec,
+          :copyright => StrQ.new("Copyright").exec,
+          :authors => StrQ.new("Authors").exec,
+          :company => StrQ.new("Company").exec,
+          :nuget_key => StrQ.new("NuGet key", base).exec,
+          :ruby_key => StrQ.new("Ruby key (e.g. 'autotx')", nil, STDIN, lambda { |s| s != nil && s.length > 0 }).exec,
+          :guid => UUID.new.generate
+      }
+    end
+  end
+end

data/lib/logirel/queries/bool_q.rb

@@ -0,0 +1,34 @@
+require 'logirel/queries/query'
+
+module Logirel
+  module Queries
+    class BoolQ < Query
+      attr_accessor :pos_answer, :neg_answer
+
+      def initialize(question,
+          default = true,
+          io_source = STDIN,
+          io_target = STDOUT)
+        @question = question
+        @default = default
+        @io_source = io_source
+        @io_target = io_target
+      end
+
+      def default_str
+
+        @default ? "[Yn]" : "[yN]"
+
+      end
+
+      def exec
+        @io_target.print @question + " " + default_str
+        a = ""
+        begin
+          a = @io_source.gets.chomp
+        end while !a.empty? && !['y', 'n'].include?(a.downcase)
+        a.empty? ? @default : (a == 'y')
+      end
+    end
+  end
+end