projit 0.4.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rbenv-gemsets

@@ -0,0 +1 @@
+projit global

data/.rvmrc

@@ -0,0 +1,57 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-p180@projit"
+
+echo "loading $environment_id"
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficicent compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "$rvm_path/hooks/after_use" ]]
+  then
+    . "$rvm_path/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment ''."
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]] ; then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+#
+# If you use bundler and would like to run bundle each time you enter the
+# directory, you can uncomment the following code.
+#
+#   # Ensure that Bundler is installed. Install it if it is not.
+#   if ! command -v bundle >/dev/null; then
+#      printf "The rubygem 'bundler' is not installed. Installing it now.\n"
+#      gem install bundler
+#   fi
+#
+#   # Bundle while reducing excess noise.
+#   printf "Bundling your gems. This may take a few minutes on a fresh clone.\n"
+#   bundle | grep -v '^Using ' | grep -v ' is complete' | sed '/^$/d'
+#
+

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem 'projit', path: '.'
+# Specify your gem's dependencies in projit.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,34 @@
+# A clean ~ keeps a development environment together
+
+Projit is a utility to specify directory structures for the different types of projects you work on and consistently generate them. It very nicely supports creating directories and files, copying directories and files, symlinking to dropbox and cloning source code directly from any git repository.
+
+## Installation
+
+    gem install projit
+
+If you don't use Ruby on a regular basis you may want to hold off until I get a chance to create some package manager recipes.
+
+## Usage
+
+    projit new personal/projit
+
+This will run the recipe you have installed in `~/.projit/template.rb`. To get the generator that I use for web applications download [this gist][template].
+
+    projit new personal/projit --git joefiorini/projit
+
+This will run the same recipe but also clone the specified git repository (assuming you have `clone_from_git` in your recipe).
+
+    projit new personal/projit\_demo --type screencast
+
+Runs the recipe stored in `~/.projit/screencast.rb` to setup a directory structure for screencasting. To get the generator that I use for screencasting download [this gist][screencasting] (structure stolen from @topfunky).
+
+## Contributions
+
+Contributions are encouraged, but given the very personal nature of workflows don't be suprised if I prefer creating recipes over adding to projit itself. Feel free to send pull requests though, it's the only way for me to see how other people use this. I will not accept Ruby code without spec coverage.
+
+I would especially welcome package manager packages/tips. I don't want to require Rubygems for others to use this, but I have never packaged anything for distribution to brew/apt/emerge/port/etc.
+
+Now, go get your home directory organized!
+
+[template]: https://gist.github.com/1336554
+[screencasting]: https://gist.github.com/1336563

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/projit

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'projit/cli'
+Projit::CLI.start

data/lib/projit/cli.rb

@@ -0,0 +1,15 @@
+require 'thor'
+require 'projit'
+
+module Projit
+  class CLI < Thor
+
+    desc "new NAME", "Create project named NAME under current directory or CLIENT if specified"
+    class_options dropbox: false, git: nil, type: nil
+    def new(name)
+      args = ARGV.reject { |a| a == "new" }
+      Projit::ProjectGenerator.start args
+    end
+
+  end
+end

data/lib/projit/config.rb

@@ -0,0 +1,49 @@
+module Projit
+
+  class Config
+
+    def projects_home
+      config_dir(read_config(:projects_home) || defaults[:projects_home])
+    end
+
+    def read_config(config)
+      return nil unless read_config_file
+      read_config_file[config.to_s]
+    end
+
+    def dropbox_configured?
+      !dropbox_home.nil?
+    end
+
+    def dropbox_home
+      config_dir(read_config(:dropbox_home) || defaults[:dropbox_home])
+    end
+
+    private
+
+      def read_config_file
+        begin
+          YAML.load_file(projit_config)
+        rescue
+          {}
+        end
+      end
+
+      def projit_config
+        File.expand_path("~/.projit/config")
+      end
+
+      def config_dir(dir)
+        return if dir.nil?
+        File.expand_path(dir)
+      end
+
+      def defaults
+        {
+          projects_home: "~/Projects",
+          dropbox_home:  nil
+        }
+      end
+
+  end
+end

data/lib/projit/project_generator.rb

@@ -0,0 +1,110 @@
+require 'thor/group'
+require 'pathname'
+require 'projit'
+
+module Projit
+
+  class ProjectGenerator < Thor::Group
+    include Thor::Actions
+
+    source_root "~/.projit"
+
+    argument :project
+    class_options dropbox: false, git: nil
+    class_option :type, default: "template"
+
+    def new
+      apply projit_template
+    end
+
+
+    protected
+
+    def projit_template
+      "#{options[:type]}.rb"
+    end
+
+    def in_project_root(&block)
+      inside projects_home.to_s, &block
+    end
+
+    def in_project_directory(&block)
+      inside projects_home_path.join(project), &block
+    end
+
+    def create_link_in_dropbox(name)
+      return unless options[:dropbox]
+      unless dropbox_configured?
+        say "How can I create a link to your Dropbox if you haven't told me where in your Dropbox to create it? Please add a value for 'dropbox_home' to ~/.projit/config."
+        return
+      end
+      create_link dropbox_path_to(name), project_full_path
+    end
+
+    def clone_from_git_into(name)
+      return unless options[:git]
+
+      git = 'git clone'
+
+      if !hub_installed? && git_path =~ /github/
+        say "Did you know you that the `hub` command gives you secret GitHub powers? Install it with Homebrew using 'brew install hub'. Not using Homebrew? Ditch MacPorts and Fink and get it now! https://github.com/mxcl/homebrew"
+      elsif hub_installed?
+        git = 'hub clone -p'
+      end
+
+      say_status :clone, git_path
+      `#{git} #{git_path} #{project_full_path.join(name)}`
+    end
+
+    def project_path
+      Pathname.new project
+    end
+
+    def project_full_path
+      projects_home_path.join(project)
+    end
+
+    def project_base
+      project_path.basename.to_s
+    end
+
+    def projects_home_path
+      Pathname.new(projects_home)
+    end
+
+    def projects_home
+      config.projects_home
+    end
+
+    def git_path
+      options[:git]
+    end
+
+    def dropbox_path
+      Pathname.new dropbox_home
+    end
+
+    def dropbox_path_to(path)
+      dropbox_path.join(path).to_s
+    end
+
+    def dropbox_home
+      Projit.config.dropbox_home
+    end
+
+    def dropbox_configured?
+      config.dropbox_configured?
+    end
+
+    def config
+      Projit.config
+    end
+
+    def hub_installed?
+      `which hub`
+      $?.success?
+    end
+
+  end
+
+end

data/lib/projit/version.rb

@@ -0,0 +1,3 @@
+module Projit
+  VERSION = "0.4.0"
+end

data/lib/projit.rb

@@ -0,0 +1,19 @@
+require "projit/version"
+require 'yaml'
+
+module Projit
+
+  autoload :CLI,              'projit/cli'
+  autoload :Config,           'projit/config'
+  autoload :ProjectGenerator, 'projit/project_generator'
+
+  def self.config
+    @config ||= load_config!
+    @config
+  end
+
+  def self.load_config!
+    Config.new
+  end
+
+end

data/projit.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "projit/version"
+
+Gem::Specification.new do |s|
+  s.name        = "projit"
+  s.version     = Projit::VERSION
+  s.authors     = ["Joe Fiorini"]
+  s.email       = ["joe@joefiorini.com"]
+  s.homepage    = ""
+  s.summary     = %q{Generate project directory structure based on a switchable template.}
+  s.description = %q{Generate project directory structure based on a switchable template.}
+
+  s.rubyforge_project = "projit"
+
+  s.add_dependency 'thor'
+
+  s.add_development_dependency 'rspec'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/projit/config_spec.rb

@@ -0,0 +1,59 @@
+require 'projit/config'
+
+describe Projit::Config do
+
+  context "projit settings" do
+
+    before do
+      (subject.stub :read_config_file).and_return({ "projects_home" => "~/Testing" })
+    end
+
+    its(:projit_config) { should == "/Users/joe/.projit/config" }
+    its(:projects_home) { should == "/Users/joe/Testing" }
+
+  end
+
+  context "setting defaults" do
+
+    before do
+      (subject.stub :read_config_file).and_return(nil)
+    end
+
+    its(:projects_home) { should == "/Users/joe/Projects" }
+    its(:dropbox_home)  { should be_nil }
+
+  end
+
+  context "reading config settings" do
+
+    before do
+      (subject.stub :read_config_file).and_return(nil)
+    end
+
+    it "doesn't crash for non-existant config" do
+      expect { subject.read_config(:blah) }.to_not raise_error
+    end
+
+  end
+
+  context "without dropbox configured" do
+
+    before do
+      (subject.stub :read_config_file).and_return  "dropbox_home" => nil
+    end
+
+    its(:dropbox_configured?) { should be_false }
+
+  end
+
+  context "with dropbox configured" do
+
+    before do
+      (subject.stub :read_config_file).and_return  "dropbox_home" => "/Users/joe/Dropbox/home"
+    end
+
+    its(:dropbox_home)        { should == "/Users/joe/Dropbox/home" }
+    its(:dropbox_configured?) { should be_true }
+  end
+
+end

data/spec/projit/project_generator_spec.rb

@@ -0,0 +1,117 @@
+require 'projit/project_generator'
+
+describe Projit::ProjectGenerator do
+
+  subject { Projit::ProjectGenerator.new ["blah"] }
+
+  it "Loads projects_home from config settings" do
+    ((Projit.stub :config).and_return stub projects_home: "~/Projects")
+    (subject.send :projects_home).should == "~/Projects"
+  end
+
+  it "Loads dropbox_home from config settings" do
+    ((Projit.stub :config).and_return stub dropbox_home: "~/Dropbox/personal")
+    (subject.send :dropbox_home).should == "~/Dropbox/personal"
+  end
+
+  context "Dropbox integration" do
+
+    before do
+      subject.stub :create_link
+    end
+
+    it "Skips linking with Dropbox when option is not supplied" do
+      (subject.stub :options).and_return dropbox: false
+      subject.should_not_receive :create_link
+      subject.send :create_link_in_dropbox, "test"
+    end
+
+    context "with Dropbox configured" do
+
+      before do
+        subject.stub dropbox_configured?: true
+        subject.stub dropbox_path_to: "~/Dropbox/home/test"
+        (subject.stub :options).and_return dropbox: true
+      end
+
+      it "Symlinks the project to Dropbox" do
+        (subject.should_receive :create_link).with "~/Dropbox/home/test", anything
+        subject.send :create_link_in_dropbox, "test"
+      end
+
+      it "Loads Dropbox path from config" do
+        (subject.should_receive :dropbox_path_to).with 'test'
+        subject.send :create_link_in_dropbox, "test"
+      end
+
+    end
+
+    context "without Dropbox configured" do
+
+      before do
+        subject.stub dropbox_configured?: false
+        (subject.stub :options).and_return dropbox: true
+      end
+
+      it "Prints a warning" do
+        subject.should_receive :say
+        subject.send :create_link_in_dropbox, "test"
+      end
+
+    end
+
+    it "Gives access to the basename of the project directory" do
+      ((subject.stub :project_path).and_return Pathname.new "~/Projects/personal/test")
+      (subject.send :project_base).should == "test"
+    end
+
+    it "Provides helper for generating dropbox paths" do
+      subject.stub dropbox_path: (Pathname.new "~/Dropbox/home")
+      (subject.send :dropbox_path_to, "test").should == "~/Dropbox/home/test"
+    end
+
+  end
+
+  context "git integration" do
+
+    before do
+      subject.stub hub_installed?: true
+      subject.stub options:     { git: 'test/blah' },
+                   git_path: 'test/blah'
+    end
+
+    it "Doesn't clone from Git when option is not supplied" do
+      subject.stub options: {}
+      subject.should_not_receive :`
+      subject.send :clone_from_git_into, 'source'
+    end
+
+    it "Clones a repository from Git into specified directory" do
+      (subject.should_receive :`).with "hub clone -p test/blah /Users/joe/Projects/blah/source"
+      subject.send :clone_from_git_into, 'source'
+    end
+
+    it "Prints a warning if hub isn't installed" do
+      subject.stub :`
+      subject.stub(:git_path) { "http://github.com/blah/diddy" }
+      subject.stub hub_installed?: false
+      subject.should_receive :say
+      subject.send :clone_from_git_into, 'source'
+    end
+
+    it "uses git if hub is not installed" do
+      subject.stub hub_installed?: false
+      subject.should_receive(:`).with /^git clone test\/blah/
+      subject.send :clone_from_git_into, 'source'
+    end
+
+  end
+
+  context "support project types" do
+    it "uses type parameter to find the template script" do
+      subject.stub(options: { type: "web_application" })
+      subject.send(:projit_template).should eq "web_application.rb"
+    end
+  end
+
+end

data/spec/projit_spec.rb

@@ -0,0 +1,15 @@
+require 'projit'
+
+describe Projit do
+
+  context "when retrieving config" do
+
+    it "loads config if not already set" do
+      Projit.instance_variable_set("@config", nil)
+      Projit.should_receive(:load_config!)
+      Projit.config
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: projit
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Joe Fiorini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70287568473380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70287568473380
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70287568472960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70287568472960
+description: Generate project directory structure based on a switchable template.
+email:
+- joe@joefiorini.com
+executables:
+- projit
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-gemsets
+- .rvmrc
+- Gemfile
+- README.markdown
+- Rakefile
+- bin/projit
+- lib/projit.rb
+- lib/projit/cli.rb
+- lib/projit/config.rb
+- lib/projit/project_generator.rb
+- lib/projit/version.rb
+- projit.gemspec
+- spec/projit/config_spec.rb
+- spec/projit/project_generator_spec.rb
+- spec/projit_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: projit
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Generate project directory structure based on a switchable template.
+test_files:
+- spec/projit/config_spec.rb
+- spec/projit/project_generator_spec.rb
+- spec/projit_spec.rb