flit 0.1.pre

data/History.txt

@@ -0,0 +1,2 @@
+== 0.1.dev / 2010-08-27
+  * Developer preview

data/LICENCE

@@ -0,0 +1,8 @@
+Flit
+Copyright (C) 2010 Matt Kirman <matt@mattkirman.com>
+
+This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

data/README.md

@@ -0,0 +1,62 @@
+#Flit
+
+Flit contains super simple branch management extensions for Git. It aims to give quick repository functions to improve a typical Git workflow as described at [http://mattkirman.com/2010/08/27/my-git-workflow-introducing-flit/](http://mattkirman.com/2010/08/27/my-git-workflow-introducing-flit/).
+
+_Flit is an extremely early alpha. Features may be broken or just plain missing, but getting this code out into the open-source community where people can start hacking away with it is much more important. If something’s missing just fork the code, add your fix and send me a pull request._
+
+
+##Installation
+
+The easiest way to install Flit is through RubyGems:
+
+    gem install flit --pre
+
+
+##Usage
+
+Flit is capable of being used with both existing and brand new Git repositories. You will also be asked a number of questions so that we can set up your repository as you would like. For the majority of installations it is perfectly safe to use the default, suggested, settings. To initialise a Flit powered Git repository simply run:
+
+    flit init
+
+_**Please note:** Flit commands can only be run from the top level directory of your Git repository. This will be rectified in future releases._
+
+
+###Working with branches
+
+Flit expects that you work on features and bugfixes in different, topic specific, branches. When switching branches Flit doesn't care whether the branch already exists, if it doesn't exist it will be created in the background. Currently you can only work in `feature` or `bugfix` branches.
+
+When starting work on a new feature or bugfix use the following commands:
+
+    flit start feature the_name_of_my_new_feature
+    flit start bugfix the_issue_number_of_the_bug
+
+You can now go ahead and committing your code as normal. Once you're ready to stop work for the day on your feature or bugfix, and want to return to your development branch, run:
+
+    flit stop
+
+_**Please note:** This will not automatically commit your code. You will have to do a `git commit` before running `flit stop`._
+
+Once your code is finished and you're ready to merge it back into your development branch you'll need to use the `finish` command:
+
+    flit finish feature the_name_of_my_new_feature
+    flit finish bugfix the_issue_number_of_the_bug
+
+This will pull down changes in master, rebase them into your feature branch and then merge your feature back into master.
+
+
+##Contributing
+
+You want to contribute? Great!
+
+1. Fork Flit
+2. Create a new feature branch (`flit start feature my_feature`)
+3. Commit your changes (`git commit -am "Added my feature"`)
+4. Push the branch (`git push origin feature/my_feature`)
+5. Send me a pull request
+
+I won't accept any pull requests if your feature is on the `master` branch as this makes it more difficult to cherry-pick your changes in. Also, please don't be offended if I don't pull your changes in immediately. I'll bring them in when I've got time.
+
+
+##Licence
+
+See LICENCE.

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake'
+require 'rdoc/task'
+require 'rake/gempackagetask'
+
+
+desc "Run all tests by default"
+task :default => :test
+
+
+desc "Run tests"
+task :test do
+  
+end
+
+
+desc "Install the gem for testing locally"
+task :install => :repackage do
+  version = File.read("VERSION").strip
+  system("gem install pkg/flit-#{version}.gem --no-ri --no-rdoc")
+end
+
+
+spec = eval(File.read('flit.gemspec'))
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+
+desc "Push the gem to gemcutter"
+task :release do
+  require 'rake/gemcutter'
+  Rake::Gemcutter::Tasks.new(spec).define
+  Rake::Task['gem:push'].invoke
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.pre

data/bin/flit

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby
+
+begin
+  require "flit/cli"
+rescue LoadError
+  path = File.expand_path('../../lib', __FILE__)
+  $:.unshift(path)
+  require 'flit/cli'
+end

data/lib/flit.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'yaml'
+require 'highline'
+
+
+module Flit
+  autoload :Help,     'flit/help'
+  autoload :Version,  'flit/version'
+  
+  
+  module Commands
+    autoload :Base,     "flit/commands"
+    autoload :Init,     "flit/commands/init"
+    autoload :Start,    "flit/commands/start"
+    autoload :Stop,     "flit/commands/stop"
+    autoload :Finish,   "flit/commands/finish"
+    autoload :Version,  "flit/commands/version"
+  end
+  
+  
+  def self.exec_script!
+    if %w(--version -v).include? ARGV.first
+      puts "Flit #{Version::STRING}"
+      
+    elsif ARGV[0].nil? || %w(help --help -h).include?(ARGV.first)
+      puts Help.display
+      
+    else
+      command = ARGV.first
+      
+      begin
+        klass = eval "Commands::#{command.camelize}.new"
+        klass.extend Commands::Base
+        begin
+          klass.run ARGV[1..-1]
+        rescue
+          klass.run
+        end
+      rescue
+        puts "flit: '#{command}' is not a command. See 'flit help'."
+      end
+      
+    end
+  end
+  
+end
+
+
+# Load our custom extensions
+Dir[File.join(File.dirname(__FILE__), 'flit', 'extensions', '*.rb')].each do |extension|
+  require extension
+end

data/lib/flit/cli.rb

@@ -0,0 +1,8 @@
+path = File.expand_path('../', __FILE__)
+$:.unshift(path)
+
+require 'flit'
+
+Signal.trap("INT") { puts; exit }
+
+Flit.exec_script!

data/lib/flit/commands.rb

@@ -0,0 +1,45 @@
+module Flit
+  module Commands
+    module Base
+      
+      def working_directory
+        `pwd`.gsub("\n", '')
+      end
+      
+      
+      def fatal(string)
+        puts "fatal: #{string}"
+        exit(0)
+      end
+      
+      
+      def is_flit?(path = nil)
+        path ||= "#{working_directory}/.flit_config"
+        File.exists? path
+      end
+      
+      
+      def is_git?(path = nil)
+        path ||= "#{working_directory}/.git"
+        File.directory? path
+      end
+      
+      
+      def save_config(config)
+        File.open(".flit_config",'w') { |f| f.puts config.to_yaml }
+      end
+      
+      
+      def open_config
+        YAML::load(File.open('.flit_config'))
+      end
+      
+      
+      def show_help
+        puts Flit::Help.display_for_command(self.class.name)
+        exit(0)
+      end
+      
+    end
+  end
+end

data/lib/flit/commands/finish.rb

@@ -0,0 +1,14 @@
+module Flit
+  module Commands
+    class Finish
+      DESC = "Finish up a feature or bugfix and merge it back into the development branch"
+      
+      def run(args)
+        # TODO: Show the help page if no options are set
+        
+        puts "flit: not implemented yet"
+      end
+      
+    end
+  end
+end

data/lib/flit/commands/init.rb

@@ -0,0 +1,54 @@
+module Flit
+  module Commands
+    class Init
+      DESC = "Create a new Flit repository"
+      
+      def run
+        # Don't allow us to reinitialise an existing Flit repository
+        if is_flit?
+          fatal "directory is already a flit repository"
+        end
+        
+        # Don't allow us to reinitialise an existing Git repository
+        unless is_git?
+          puts "Creating a new repository..."
+          `git init`
+        end
+        
+        
+        # Set up our initial config
+        puts "No branches exist yet. Base branches must be created now."
+        
+        h = HighLine.new
+        
+        bleeding_edge_branch_name = h.ask("Branch name for bleeding edge development: ") { |q| q.default = 'master' }
+        staging_branch_name = h.ask("Branch name for staging releases: ") { |q| q.default = 'staging' }
+        production_branch_name = h.ask("Branch name for production releases: ") { |q| q.default = 'production' }
+        
+        puts "Name your supporting branch prefixes."
+        
+        feature_branch_prefix = h.ask("Feature branches? ") { |q| q.default = 'feature/' }
+        bugfix_branch_prefix = h.ask("Bugfix branches? ") { |q| q.default = 'bugfix/' }
+        version_tag_prefix = h.ask("Version tag prefix? ") { |q| q.default = 'v' }
+        
+        
+        # Save our config
+        save_config ({
+          :branches => {
+            :bleeding_edge => bleeding_edge_branch_name,
+            :staging => staging_branch_name,
+            :production => production_branch_name,
+            :feature_prefix => feature_branch_prefix,
+            :bugfix_prefix => bugfix_branch_prefix
+          },
+          :tags => {
+            :version_prefix => version_tag_prefix
+          }
+        })
+        
+        # Repository created!
+      end
+      
+    end
+  end
+end

data/lib/flit/commands/start.rb

@@ -0,0 +1,33 @@
+module Flit
+  module Commands
+    class Start
+      DESC = "Start work on a new feature or bugfix"
+      USAGE = "TYPE NAME"
+      OPTIONS = {
+        :type => "Can be either a feature or bugfix",
+        :name => "The name of your feature or bugfix",
+      }
+      
+      def run(args)
+        # Gatekeepers
+        fatal "directory isn't a flit repository" unless is_flit?
+        show_help unless args.count == 2
+        
+        type, name = args
+        config = open_config
+        
+        branch_name = case type
+          when "feature" then config[:branches][:feature_prefix]
+          when "bugfix" then config[:branches][:bugfix_prefix]
+          else puts "flit: unknown branch type '#{type}'"; exit(0)
+        end
+        
+        branch_name << name
+        
+        `git branch #{branch_name}` if `git branch`.match(branch_name).nil?
+        `git checkout #{branch_name}`
+      end
+      
+    end
+  end
+end

data/lib/flit/commands/stop.rb

@@ -0,0 +1,14 @@
+module Flit
+  module Commands
+    class Stop
+      DESC = "Stop work on a feature of bugfix"
+      
+      def run(args)
+        # TODO: Show the help page if no options are set
+        
+        `git checkout #{open_config[:branches][:bleeding_edge]}`
+      end
+      
+    end
+  end
+end

data/lib/flit/commands/version.rb

@@ -0,0 +1,12 @@
+module Flit
+  module Commands
+    class Version
+      DESC = "Mark the current commit as a new version"
+      
+      def run(args)
+        
+      end
+      
+    end
+  end
+end

data/lib/flit/extensions/string.rb

@@ -0,0 +1,11 @@
+class String
+  
+  def camelize(first_letter_in_uppercase = true)
+    if first_letter_in_uppercase
+      self.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    else
+      self.to_s[0].chr.downcase + camelize(lower_case_and_underscored_word)[1..-1]
+    end
+  end
+  
+end

data/lib/flit/help.rb

@@ -0,0 +1,63 @@
+module Flit
+  class Help
+    USAGE = <<USAGE
+Usage:
+  flit COMMAND [options]
+
+Commands:
+  {{commands}}
+  
+  help                # Show this page
+  -v, --version       # Get Flit version information
+
+USAGE
+    
+    
+    def self.display
+      USAGE.gsub("{{commands}}", available_commands)
+    end
+    
+    
+    def self.available_commands
+      commands_dir = File.expand_path('../commands', __FILE__)
+      commands = []
+      Dir.new(commands_dir).each do |f|
+        if f.match(/(.*)\.rb/)
+          begin
+            command = f.gsub(/\.rb/, '')
+            klass = "Flit::Commands::#{command.camelize}"
+            commands << "#{command.ljust(20)}# #{ eval("#{klass}::DESC") }"
+          rescue
+          end
+        end
+      end
+      
+      commands.sort.join("\n  ")
+    end
+    
+    
+    def self.display_for_command(klass)
+      command = klass.split(/::/)[-1].downcase
+      
+      help = "Usage:\n  flit #{command}"
+      begin
+        help << " #{eval("#{klass}::USAGE")}"
+      rescue
+      end
+      
+      begin
+        options = eval("#{klass}::OPTIONS")
+        unless options.count == 0
+          help << "\n\nOptions:"
+          options.each do |opt, desc|
+            help << "\n  #{opt.to_s.ljust(20)}# #{desc}"
+          end
+        end
+      rescue
+      end
+      
+      "#{help}\n "
+    end
+    
+  end
+end

data/lib/flit/version.rb

@@ -0,0 +1,5 @@
+module Flit
+  module Version
+    STRING = "0.1.dev"
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: flit
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 1
+  - pre
+  version: 0.1.pre
+platform: ruby
+authors: 
+- Matt Kirman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-28 00:00:00 +01:00
+default_executable: flit
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Flit contains super simple branch management extensions for Git. It aims to give quick repository functions to improve a typical Git workflow.
+email: matt@mattkirman.com
+executables: 
+- flit
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- History.txt
+- LICENCE
+- Rakefile
+- README.md
+- VERSION
+- lib/flit.rb
+- lib/flit/cli.rb
+- lib/flit/commands.rb
+- lib/flit/help.rb
+- lib/flit/version.rb
+- lib/flit/commands/finish.rb
+- lib/flit/commands/init.rb
+- lib/flit/commands/start.rb
+- lib/flit/commands/stop.rb
+- lib/flit/commands/version.rb
+- lib/flit/extensions/string.rb
+- bin/flit
+has_rdoc: true
+homepage: http://github.com/mattkirman/flit
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Branch management extensions for Git
+test_files: []
+