flux 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,56 @@
+Flux
+====
+
+Flux is a command-line tool that tries to eliminate the drudgery from your
+workflow.
+
+It provides hooks for interacting with the following:
+
+* Tracker (currently only Pivotal Tracker is supported)
+* RCS (currently, git only)
+* Anything else you can think of, as long as someone implements it.
+
+Some examples
+-------------
+
+Let's list all stories that have been scheduled (i.e., moved out of the icebox
+and into some iteration):
+
+    $ flux stories
+    ID        STATE      ASSIGNEE    STORY
+    12345678  unstarted              A developer can grab a story
+    12345679  finished   David Leal  A developer can link a branch to a story
+    12345680  finished   David Leal  A developer can mark a story as started
+    ...
+
+[TODO Complete workflow. For now try `flux` to see a list of implemented tasks.]
+
+Configuration
+-------------
+
+A project is configured by placing a file named `.flux` in the project root.
+Each top level key represents a functional domain.
+
+This project's `.flux` file is as follows:
+
+    trackers:
+      adapter: pivotal_tracker
+      project_id: 128808
+    rcs:
+      adapter: git
+    workflows:
+      adapter: mojotech
+
+### Local configuration
+
+The `.flux` file should be used for project-wide configuration and kept under
+version control. Obviously you aren't going to store your account credentials
+there, so you need a different place where you can store them. That place is
+`.flux.local`. If you're using Git, this file should be added to the project's
+`.gitignore`.
+
+Here's an example of a `.flux.local` file.
+
+    trackers:
+      token: abcdef1234567890
+      email: david@mojotech.com

data/VERSION

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

data/flux.gemspec

@@ -0,0 +1,87 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{flux}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Leal"]
+  s.date = %q{2011-09-07}
+  s.default_executable = %q{flux}
+  s.email = %q{david@mojotech.com}
+  s.executables = ["flux"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".flux",
+    ".flux.local.sample",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/flux",
+    "flux.gemspec",
+    "lib/flux.rb",
+    "lib/flux/ext/pivotal-tracker.rb",
+    "lib/flux/rcs/git.rb",
+    "lib/flux/trackers/pivotal_tracker.rb",
+    "lib/flux/util.rb",
+    "lib/flux/util/output.rb",
+    "lib/flux/util/table.rb",
+    "lib/flux/workflows/mojotech.rb",
+    "spec/flux/rcs/git_spec.rb",
+    "spec/flux/trackers/pivotal_tracker_spec.rb",
+    "spec/flux/util/table_spec.rb",
+    "spec/flux_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/matchers/print_table.rb",
+    "spec/support/rr.rb"
+  ]
+  s.homepage = %q{http://github.com/mojotech/flux}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Command line workflow manager.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<thor>, ["~> 0.14.0"])
+      s.add_runtime_dependency(%q<pivotal-tracker>, ["~> 0.4.0"])
+      s.add_development_dependency(%q<grit>, ["~> 2.4.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rr>, ["~> 1.0.0"])
+    else
+      s.add_dependency(%q<thor>, ["~> 0.14.0"])
+      s.add_dependency(%q<pivotal-tracker>, ["~> 0.4.0"])
+      s.add_dependency(%q<grit>, ["~> 2.4.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rr>, ["~> 1.0.0"])
+    end
+  else
+    s.add_dependency(%q<thor>, ["~> 0.14.0"])
+    s.add_dependency(%q<pivotal-tracker>, ["~> 0.4.0"])
+    s.add_dependency(%q<grit>, ["~> 2.4.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rr>, ["~> 1.0.0"])
+  end
+end
+

data/lib/flux/rcs/git.rb

@@ -10,16 +10,35 @@ module Flux
         repo.head.name.tap { |h| $stdout.puts h }
       end
 
+      desc "checkout BRANCH_ID", "checkout a branch"
+      def checkout(branch_id)
+        git.checkout({}, branch_id)
+      end
+
+      desc "create BRANCH_ID", "create a branch"
+      method_option :public, :type => :boolean, :aliases => '-p'
+      def create(branch_id)
+        git.branch({}, branch_id)
+
+        if options[:public]
+          git.push({}, 'origin', "+#{branch_id}:#{branch_id}")
+          git.branch({:set_upstream => true}, branch_id, "origin/#{branch_id}")
+        end
+      end
+
       private
 
+      def git
+        @git ||= Grit::Git.new(repo_path)
+      end
+
       def repo
-        @repo ||=
-          begin
-            repo = Flux.find_upwards('.git', Dir.pwd) or
-              raise RCSError, "Couldn't find git repo starting at #{Dir.pwd}."
+        @repo ||= Grit::Repo.new(repo_path)
+      end
 
-            Grit::Repo.new(repo)
-          end
+      def repo_path
+        Flux.find_upwards('.git', Dir.pwd) or
+          raise RCSError, "Couldn't find git repo starting at #{Dir.pwd}."
       end
     end
   end

data/lib/flux/trackers/pivotal_tracker.rb

@@ -23,8 +23,12 @@ module Flux
       end
 
       desc "grab STORY_ID", "assign yourself the given story"
+      method_option :estimate, :type => :numeric, :aliases => '-e'
       def grab(story_id)
-        invoke :update, [story_id], :attributes => {:owner => me.name}
+        attrs            = {:owner => me.name}
+        attrs[:estimate] = options[:estimate] if options[:estimate]
+
+        update_attributes story_id, attrs
       end
 
       desc "start STORY_ID", "start the given story"
@@ -43,34 +47,7 @@ module Flux
       desc "update STORY_ID", "update a story's attributes"
       method_option :attributes, :type => :hash, :required => true
       def update(story_id)
-        story          = story!(story_id)
-        native, custom =
-          options[:attributes].
-            map { |k, v| [MAPPINGS[k.to_s], v] }.
-            partition { |(k, v)| story.respond_to?("#{k}=") }
-
-        native_h = Hash[*native.flatten]
-
-        if native_h['current_state']
-          unless STATES.include?(native_h['current_state'])
-            raise TrackerError, "Invalid state: #{native_h['current_state']}"
-          end
-
-          if STATES_W_ESTIMATE.include?(native_h['current_state']) &&
-             ! story.estimate &&
-             ! native_h['estimate']
-            raise TrackerError,
-                  "Need an estimate for state `#{native_h['current_state']}'."
-          end
-        end
-
-        story.update(native_h) unless native.empty?
-
-        unless custom.empty?
-          str = YAML.dump(Hash[*custom.flatten])
-
-          pt::Note.new(:owner => story, :text => str).create
-        end
+        update_attributes story_id, options[:attributes]
       end
 
       private
@@ -88,11 +65,15 @@ module Flux
                       :project_id => config['project_id'])
       end
 
-      STORY_LIST_HEADERS = %w(ID STATE ASSIGNEE STORY)
+      STORY_LIST_HEADERS = %w(ID STATE ASSIGNEE >EST. STORY)
 
       def list_stories(stories)
         puts_table [STORY_LIST_HEADERS] + stories.map { |s|
-          [s.id, s.current_state, s.owned_by, s.name]
+          [s.id,
+           s.current_state,
+           s.owned_by,
+           normalize_estimate(s.estimate).to_s,
+           s.name.strip]
         }
       end
 
@@ -106,6 +87,10 @@ module Flux
         ms.find { |m| m.email == config['email'] }
       end
 
+      def normalize_estimate(estimate)
+        (estimate && estimate < 0) ? nil : estimate
+      end
+
       def pt
         login and return ::PivotalTracker
       end
@@ -118,11 +103,43 @@ module Flux
         story(id) or raise TrackerError, "Couldn't find story #{id}."
       end
 
+      def update_attributes(story_id, attrs)
+        story          = story!(story_id)
+        native, custom =
+          attrs.
+            map { |k, v| [MAPPINGS[k.to_s], v] }.
+            partition { |(k, v)| story.respond_to?("#{k}=") }
+
+        native_h = Hash[*native.flatten]
+
+        if native_h['current_state']
+          unless STATES.include?(native_h['current_state'])
+            raise TrackerError, "Invalid state: #{native_h['current_state']}"
+          end
+
+          if STATES_W_ESTIMATE.include?(native_h['current_state']) &&
+             ! normalize_estimate(story.estimate) &&
+             ! native_h['estimate']
+            raise TrackerError,
+                  "Need an estimate for state `#{native_h['current_state']}'."
+          end
+        end
+
+        story.update(native_h) unless native.empty?
+
+        unless custom.empty?
+          str = YAML.dump(Hash[*custom.flatten])
+
+          pt::Note.new(:owner => story, :text => str).create
+        end
+
+      end
+
       def update_state(story_id, state)
         attrs            = {:state => state}
         attrs[:estimate] = options[:estimate] if options[:estimate]
 
-        invoke :update, [story_id], :attributes => attrs
+        update_attributes story_id, attrs
       end
     end
   end

data/lib/flux/util.rb

@@ -1,2 +1,3 @@
 require 'flux/util/table'
+require 'flux/util/output'
 

data/lib/flux/util/output.rb

@@ -0,0 +1,25 @@
+module Flux
+  module Util
+    module Output
+      # Capture standard IO channel.
+      #
+      # @yield the block that encloses the channel capture
+      #
+      # @return everything that was written to the given channel
+      def capture(channel = :stdout)
+        io     = StringIO.new
+        old_io = eval("$#{channel}")
+
+        eval("$#{channel} = io")
+
+        yield
+
+        io.string
+      ensure
+        eval("$#{channel} = old_io")
+      end
+
+      alias_method :silence, :capture
+    end
+  end
+end

data/lib/flux/workflows/mojotech.rb

@@ -2,6 +2,8 @@ module Flux
   module Workflows
     module MojoTech
       class Developer < Thor
+        include Util::Output
+
         namespace :dev
 
         desc "link STORY_ID", "link a story to a branch"
@@ -11,20 +13,21 @@ module Flux
                  :attributes => {'branch' => current_branch_id}
         end
 
+        desc "start STORY_ID BRANCH_ID", "start working on a story"
+        method_option :estimate, :type => :numeric
+        def start(story_id, branch_id)
+          invoke 'stories:grab', [story_id], :estimate => options[:estimate]
+          invoke 'stories:start', [story_id]
+          invoke 'branches:create', [branch_id]
+          invoke 'branches:checkout', [branch_id]
+          invoke :link, [story_id]
+        end
+
         private
 
         def current_branch_id
           silence { @current_branch_id ||= invoke('branches:current', []) }
         end
-
-        def silence
-          old_stdout = $stdout
-          $stdout    = StringIO.new
-
-          yield
-        ensure
-          $stdout = old_stdout
-        end
       end
     end
   end

data/spec/flux/rcs/git_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require 'flux/rcs/git'
+
+describe Flux::RCS::Branches do
+  include Flux::Util::Output
+
+  it "displays the current branch" do
+    mock(mock_root(Grit::Repo)).head.mock!.name { 'zee_current_branch' }
+
+    retval = nil
+    capture { retval = subject.invoke('branches:current', []) }.
+      should == "zee_current_branch\n"
+    retval.should == 'zee_current_branch'
+  end
+
+  it "creates a branch" do
+    mock(mock_root(Grit::Git)).branch({}, 'new_branch')
+
+    subject.invoke 'branches:create', %w(new_branch)
+  end
+
+  it "creates a public branch" do
+    git = mock_root(Grit::Git)
+
+    mock(git).branch({}, 'new_branch')
+    mock(git).push({}, 'origin', '+new_branch:new_branch')
+    mock(git).branch({:set_upstream => true}, 'new_branch', 'origin/new_branch')
+
+    subject.invoke 'branches:create', %w(new_branch), :public => true
+  end
+
+  it "checks out a branch" do
+    mock(mock_root(Grit::Git)).checkout({}, 'new_branch')
+
+    subject.invoke 'branches:checkout', %w(new_branch)
+  end
+
+  def mock_root(klass)
+    repo_path = File.expand_path(File.dirname(__FILE__) + '/../../../.git')
+    root      = Object.new
+
+    mock(klass).new(repo_path) { root }
+
+    root
+  end
+end

data/spec/flux/trackers/pivotal_tracker_spec.rb

@@ -40,6 +40,15 @@ describe Flux::Trackers::PivotalTracker do
     subject.invoke :grab, [123]
   end
 
+  it "grabs a story and estimates it" do
+    prepare_myself
+
+    mock_update(123, 'owned_by' => 'David Leal',
+                     'estimate' => 2)
+
+    subject.invoke :grab, [123], :estimate => 2
+  end
+
   [%w(starts started start),
    %w(finishes finished finish)].each do |(action, state, task)|
     it "#{action} a story that was already estimated" do

metadata

@@ -2,7 +2,7 @@
 name: flux
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - David Leal
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-05 00:00:00 +01:00
+date: 2011-09-07 00:00:00 +01:00
 default_executable: flux
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -109,6 +109,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
+- README.md
 files: 
 - .document
 - .flux
@@ -116,16 +117,20 @@ files:
 - .rspec
 - Gemfile
 - LICENSE.txt
+- README.md
 - Rakefile
 - VERSION
 - bin/flux
+- flux.gemspec
 - lib/flux.rb
 - lib/flux/ext/pivotal-tracker.rb
 - lib/flux/rcs/git.rb
 - lib/flux/trackers/pivotal_tracker.rb
 - lib/flux/util.rb
+- lib/flux/util/output.rb
 - lib/flux/util/table.rb
 - lib/flux/workflows/mojotech.rb
+- spec/flux/rcs/git_spec.rb
 - spec/flux/trackers/pivotal_tracker_spec.rb
 - spec/flux/util/table_spec.rb
 - spec/flux_spec.rb
@@ -146,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 692717009
+      hash: 1054297281
       segments: 
       - 0
       version: "0"