leap-cli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8787a01442a6f05a729b42403a0d3fe1f4d5e5d1
+  data.tar.gz: 2341e315764f8954674438a6f38d1bfa3249bf3f
+SHA512:
+  metadata.gz: 5a5d3b63026eaa8d8e3ea6052cbf6dc5cdac5b09afc044bb23491b93b97d90efcd2a68f58010ae877b9f6742a876e23cedbf4b51b09bf2006016edc5685f92e4
+  data.tar.gz: 571097b889476c3170f1616b836408f7cef6f5485c40e0ea9608611f2323141e90181e8678c1f8fc9442de5733c5834f6d2af50dd36ab6b8f95688f588d1dd50

data/.gitignore

@@ -0,0 +1,2 @@
+mkmf.log
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    leap-cli (1.0.0)
+      thor (= 0.19.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.6)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    slop (3.6.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  leap-cli!
+  pry (= 0.10.0)
+  rake (= 10.3.2)
+  rspec (= 3.1.0)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 General Assembly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Leap
+
+Leap is a CLI to make working on projects inside a service oriented architecture easier.
+
+## Dependencies
+
+Leap is built upon Ruby 2.1.2.
+
+While not a strict dependency, leap has not been tested on Linux or Windows. Don’t expect the latter to work.
+
+## Installation
+
+To install leap and take advantage of its full command, you’ll want to install it globally.
+
+`sudo gem install leap-cli`
+
+## Adding leap to a project
+
+Leap uses convention through configuration. What that means is individual teams enforce their conventions through configuration in leap.
+
+To do this, in each project create a `.leap` directory, inside of which you’ll create a `config` file. This is ultimately a YAML file.
+
+#### Example `config` file
+
+```YAML
+dependencies:
+  - postgresql
+  - redis
+
+remotes:
+  - origin:
+    - git@github.com:generalassembly/turbo-octo-happiness.git
+```
+
+#### Adding leap start
+
+The start script is just a shell script that starts your server. This could be as simple as:
+
+```shell
+rails s
+```
+
+Or as complex as you like. This simply gives a clear way for any dev new to a project start the server without having to ask, “Is this a foreman project or do I use 'rails s' or some other way?”
+
+## Using leap
+
+Leap is now part of your CLI. Using it is simple!
+
+`$ leap`
+
+## Contributing to leap
+
+We’d love to have all contributions that are sent our way that match the mission of the project. To that end, opening an issue before submitting a pull request is the best way to kick off the discussion as to whether your vision and our vision matches.
+

data/bin/leap

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative '../lib/leap/cli'
+Leap::CLI.start

data/leap.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'leap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'leap-cli'
+  spec.version       = Leap::VERSION
+  spec.authors       = ['General Assembly', 'Dustin Coates']
+  spec.email         = ['tech@generalassemb.ly', 'dustin@dcoates.com']
+  spec.description   = %q{Tools for projects inside a SOA.}
+  spec.summary       = %q{A CLI for setting up, running, and making changes to project inside a SOA.}
+  spec.homepage      = 'http://github.com/generalassembly/leap'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'pry', '0.10.0'
+  spec.add_development_dependency 'rake', '10.3.2'
+  spec.add_development_dependency 'rspec', '3.1.0'
+
+  spec.add_dependency 'thor', '0.19.1'
+end

data/lib/leap.rb

@@ -0,0 +1,9 @@
+
+module Leap
+end
+
+require 'leap/version'
+require 'leap/cli'
+require 'leap/config'
+require 'leap/support/brew'
+require 'leap/support/remotes'

data/lib/leap/cli.rb

@@ -0,0 +1,63 @@
+require 'thor'
+require 'mkmf'
+require 'leap'
+require 'pry'
+
+require_relative 'config'
+require_relative 'support/brew'
+require_relative 'support/remotes'
+
+class Leap::CLI < Thor
+
+  desc 'setup USERNAME/PROJECT', 'Clone and install dependencies of a project'
+  def setup(username_project)
+    username, project_name = split_source(username_project)
+    invoke :clone, [username_project]
+    invoke :remotes, [project_name]
+    invoke :dependencies, [project_name]
+  end
+
+  desc 'clone USERNAME/PROJECT', 'Clone project into current directory'
+  def clone(username_project)
+    username, project_name = split_source(username_project)
+    if Dir.exists?(project_name)
+      say "Project appears to already exist. Skipping clone.", :green
+    else
+      say "Cloning #{project_name}.", :green
+      `git clone git@github.com:#{username}/#{project_name}.git`
+    end
+  end
+
+  desc 'remotes', 'Sets up all relevant remotes for a project'
+  def remotes(project_name = nil)
+    # setup above invokes dependencies with an argument so we allow for a single
+    # unused argument when called inside a project
+    Remotes.new(self, Leap::CONFIG, project_name).add_specified_remotes
+  end
+
+  desc 'dependencies', 'Guided installation of dependencies for project'
+  # setup above invokes dependencies with an argument so we allow for a single
+  # unused argument when called inside a project
+  def dependencies(project_name = nil)
+    brew = Brew.new(self, Leap::CONFIG, project_name)
+
+    brew.install unless brew.present?
+    brew.install_dependencies
+  end
+
+  desc 'start', 'Starts a local server'
+  def start
+    remotes_file = '.leap/start'
+    if File.exists?(remotes_file)
+      exec(remotes_file)
+    else
+      say 'No start script', :red
+    end
+  end
+
+  no_commands do
+    def split_source(username_project)
+      username_project.downcase.split("/")
+    end
+  end
+end

data/lib/leap/config.rb

@@ -0,0 +1,6 @@
+require 'yaml'
+
+module Leap
+  CONFIG_FILE = '.leap/config'
+  CONFIG = File.exists?(CONFIG_FILE) ? YAML.load_file(CONFIG_FILE) : {}
+end

data/lib/leap/support/brew.rb

@@ -0,0 +1,44 @@
+class Brew
+  attr_reader :dependencies
+
+  def initialize(thor, config, project_name)
+    @dependencies = extract_dependencies(config, project_name)
+    @thor = thor
+  end
+
+  def eligible?
+    !RbConfig::CONFIG['host_os'].match(/darwin|mac os/).nil?
+  end
+
+  def install
+    @thor.say 'Installing brew', :green
+    exec('ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"')
+  end
+
+  def install_dependencies
+    @dependencies.each do |dependency|
+      local_package = `brew list | grep #{dependency}`
+      if local_package.empty?
+        @thor.say "Installing #{dependency}", :green
+        exec("brew install #{dependency}")
+      end
+    end.empty? and begin
+      @thor.say "No dependencies found in leap config", :red
+    end
+  end
+
+  def present?
+    !(find_executable 'brew').nil?
+  end
+
+  private
+  def extract_dependencies(config, project_name)
+    config.fetch('dependencies') do
+      if File.exists? "./#{project_name}/.leap/config"
+        YAML.load_file("./#{project_name}/.leap/config")['dependencies']
+      else
+        []
+      end
+    end
+  end
+end

data/lib/leap/support/remotes.rb

@@ -0,0 +1,37 @@
+class Remotes
+  attr_reader :remotes
+
+  def initialize(thor, config, project_name = nil)
+    @thor = thor
+    @remotes = extract_remotes(config, project_name)
+    @project_name = project_name
+  end
+
+  def add_specified_remotes
+    if @remotes.nil?
+      @thor.say 'No remotes specified', :red
+    else
+      @remotes.each do |name, remote_url|
+        add_remote(name, remote_url, @project_name)
+      end
+    end
+  end
+
+  def add_remote(name, remote_url, project_name = nil)
+    @thor.say "Adding #{name} remote"
+    if project_name.nil?
+      `git remote add #{name} #{remote_url}`
+    else
+      `cd #{project_name} && git remote add #{name} #{remote_url}`
+    end
+  end
+
+  private
+  def extract_remotes(config, project_name)
+    config.fetch('remotes') do
+      if File.exists? "./#{project_name}/.leap/config"
+        YAML.load_file("./#{project_name}/.leap/config")['remotes']
+      end
+    end
+  end
+end

data/lib/leap/version.rb

@@ -0,0 +1,3 @@
+module Leap
+  VERSION = '1.0.0'
+end

data/spec/lib/leap/cli_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'pry'
+
+describe Leap::CLI do
+  let(:cli) { Leap::CLI.new }
+
+  describe 'setup' do
+    it 'invokes clone, remotes, dependencies' do
+      expect(cli).to receive(:invoke).exactly(:thrice)
+
+      cli.setup('username/project')
+    end
+  end
+
+  describe 'clone' do
+    context 'when directory with same name already exists' do
+      before do
+        allow(Dir).to receive(:exists?).and_return(true)
+      end
+
+      it 'does not clone project' do
+        expect(cli).to_not receive(:`)
+      end
+
+      it 'warns user' do
+        expect(cli).to receive(:say)
+          .exactly(:once)
+          .with('Project appears to already exist. Skipping clone.', :green)
+
+        cli.clone('username/project')
+      end
+    end
+
+    context 'when directory with same name does not exist' do
+      before do
+        allow(Dir).to receive(:exists?).and_return(false)
+      end
+
+      it 'clones project' do
+        expect(cli).to receive(:`).with("git clone git@github.com:username/project.git")
+
+        cli.clone('username/project')
+      end
+
+      it 'notifies user' do
+        expect(cli).to receive(:say)
+          .exactly(:once)
+          .with("Cloning project.", :green)
+
+        cli.clone('username/project')
+      end
+    end
+  end
+
+  describe 'dependencies' do
+    context 'when brew is not present' do
+      it 'installs brew' do
+        allow_any_instance_of(Brew).to receive(:present?).and_return(false)
+
+        expect_any_instance_of(Brew).to receive(:install_brew).exactly(:once)
+
+        cli.dependencies
+      end
+    end
+
+    context 'when brew is present' do
+      it 'does not install brew' do
+        allow_any_instance_of(Brew).to receive(:present?).and_return(true)
+
+        expect_any_instance_of(Brew).to_not receive(:install_brew)
+
+        cli.dependencies
+      end
+    end
+
+    it 'installs dependencies' do
+      expect_any_instance_of(Brew).to receive(:install_dependencies)
+
+      cli.dependencies
+    end
+  end
+
+  describe 'start' do
+    context 'when start script exists' do
+      before do
+        allow(File).to receive(:exists?).and_return(false)
+      end
+
+      it 'alerts user of no start script' do
+        expect(cli)
+          .to receive(:say)
+          .with('No start script', :red)
+          .exactly(:once)
+
+        cli.start
+      end
+    end
+
+    context 'when start script does not exist' do
+      before do
+        allow(File).to receive(:exists?).and_return(true)
+        allow_any_instance_of(Object).to receive(:exec).and_return(double)
+      end
+
+      it 'executes that script' do
+        expect_any_instance_of(Object)
+          .to receive(:exec)
+          .with('.leap/start')
+          .exactly(:once)
+
+        cli.start
+      end
+    end
+  end
+end

data/spec/lib/leap/support/brew_spec.rb

@@ -0,0 +1,109 @@
+require "spec_helper"
+
+describe Brew do
+  let(:brew) { Brew.new(Leap::CLI.new, {}, 'project') }
+
+  describe '#eligible?' do
+    it 'returns true for mac os' do
+      RbConfig::CONFIG['host_os'] = 'mac os'
+      expect(brew).to be_eligible
+    end
+
+    it 'returns true for darwin' do
+      RbConfig::CONFIG['host_os'] = 'darwin'
+      expect(brew).to be_eligible
+    end
+
+    it 'returns false for anything else' do
+      RbConfig::CONFIG['host_os'] = 'mswin'
+      expect(brew).to_not be_eligible
+    end
+  end
+
+  describe '#install' do
+    it 'notifies user' do
+      expect_any_instance_of(Leap::CLI)
+        .to receive('say')
+        .exactly(:once)
+        .with('Installing brew', :green)
+
+      allow_any_instance_of(Object).to receive(:exec).and_return(double)
+
+      brew.install
+    end
+
+    it 'installs brew' do
+      expect_any_instance_of(Object)
+        .to receive(:exec)
+        .with('ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"')
+        .exactly(:once)
+
+      brew.install
+    end
+  end
+
+  describe '#install_dependencies' do
+    before do
+      allow_any_instance_of(Object).to receive(:exec).and_return(double)
+    end
+
+    context 'when no dependencies are present' do
+      it 'alerts user' do
+        brew = Brew.new(Leap::CLI.new, {}, 'project')
+
+        expect_any_instance_of(Leap::CLI)
+          .to receive('say')
+          .exactly(:once)
+          .with('No dependencies found in leap config', :red)
+
+        brew.install_dependencies
+      end
+    end
+
+    context 'when dependencies are present' do
+      context 'when local_package is not present' do
+        before { allow_any_instance_of(Object).to receive(:`).and_return('') }
+
+        it 'notifies user for every dependency' do
+          brew = Brew.new(Leap::CLI.new, { 'dependencies' => ['redis', 'awk'] }, 'project')
+
+          expect_any_instance_of(Leap::CLI)
+            .to receive('say')
+            .exactly(:twice)
+
+          brew.install_dependencies
+        end
+
+        it 'installs dependencies via brew' do
+          brew = Brew.new(Leap::CLI.new, { 'dependencies' => ['redis'] }, 'project')
+
+          expect_any_instance_of(Object)
+            .to receive(:exec)
+            .with("brew install redis")
+
+          brew.install_dependencies
+        end
+      end
+    end
+  end
+
+  describe '#present?' do
+    it 'returns false if brew executable is not found' do
+      allow_any_instance_of(Object)
+        .to receive(:find_executable)
+        .with('brew')
+        .and_return(nil)
+
+      expect(brew).to_not be_present
+    end
+
+    it 'returns true if brew executable is found' do
+      allow_any_instance_of(Object)
+        .to receive(:find_executable)
+        .with('brew')
+        .and_return('/usr/local/bin/brew')
+
+      expect(brew).to be_present
+    end
+  end
+end

data/spec/lib/leap/support/remotes_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+describe Remotes do
+
+  describe '#add_specified_remotes' do
+    context 'when no remotes are present' do
+      let(:remotes) { Remotes.new(Leap::CLI.new, {}) }
+
+      it 'alerts the user' do
+        expect{
+          remotes.add_specified_remotes
+        }.to output("No remotes specified\n").to_stdout
+      end
+
+      it 'does not add remotes' do
+        expect(remotes).to_not receive(:add_remote)
+
+        remotes.add_specified_remotes
+      end
+    end
+
+    context 'when remotes are present' do
+      let(:remotes) do
+        Remotes.new(
+          Leap::CLI.new,
+          { "remotes" => {
+              "origin" => 'git@github.com:generalassembly/leap.git'
+            }
+          }
+        )
+      end
+
+      it 'adds remotes' do
+        expect(remotes).to receive(:add_remote).exactly(:once)
+
+        remotes.add_specified_remotes
+      end
+    end
+  end
+
+  describe '#add_remote' do
+    let(:remotes) do
+      Remotes.new(
+        Leap::CLI.new,
+        { "remotes" => {
+            "origin" => 'git@github.com:generalassembly/leap.git'
+          }
+        },
+        'project'
+      )
+    end
+
+    it 'notifies user' do
+      expect_any_instance_of(Leap::CLI)
+        .to receive('say')
+        .exactly(:once)
+        .with('Adding origin remote')
+
+      remotes.add_remote(remotes.remotes.keys.first, remotes.remotes.values.first)
+    end
+
+    context 'when project name is present' do
+      it 'cds into project and adds remote' do
+        expect(remotes)
+          .to receive(:`)
+          .exactly(:once)
+          .with("cd project && git remote add origin git@github.com:generalassembly/leap.git")
+
+        remotes.add_remote(remotes.remotes.keys.first, remotes.remotes.values.first, "project")
+      end
+    end
+
+    context 'when project name is not present' do
+      it 'does not cd into project, then adds remote' do
+        expect(remotes)
+          .to receive(:`)
+          .exactly(:once)
+          .with("git remote add origin git@github.com:generalassembly/leap.git")
+
+        remotes.add_remote(remotes.remotes.keys.first, remotes.remotes.values.first, nil)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'leap'

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: leap-cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- General Assembly
+- Dustin Coates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+description: Tools for projects inside a SOA.
+email:
+- tech@generalassemb.ly
+- dustin@dcoates.com
+executables:
+- leap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/leap
+- leap.gemspec
+- lib/leap.rb
+- lib/leap/cli.rb
+- lib/leap/config.rb
+- lib/leap/support/brew.rb
+- lib/leap/support/remotes.rb
+- lib/leap/version.rb
+- spec/lib/leap/cli_spec.rb
+- spec/lib/leap/support/brew_spec.rb
+- spec/lib/leap/support/remotes_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/generalassembly/leap
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A CLI for setting up, running, and making changes to project inside a SOA.
+test_files:
+- spec/lib/leap/cli_spec.rb
+- spec/lib/leap/support/brew_spec.rb
+- spec/lib/leap/support/remotes_spec.rb
+- spec/spec_helper.rb
+has_rdoc: