vagrant-layout 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7df38e9feb8a4e818a87ad7924a1452bcbf50d02
-  data.tar.gz: 25df792cda72734a15feafabf5e8b118f2024468
+  metadata.gz: fa4d543c7752fe9ae1cde442aaa9edd83deffe82
+  data.tar.gz: 7e30892ce995cf83eb7e1ea931f84f8eb0ab6f81
 SHA512:
-  metadata.gz: b231cae5fa8d2ee031deb77c5ddf3b86b48080d5e04043b1cddc6d88a6a4d8b60060affde27fa253c1c212cb660b7488ed3fe8c6951fab177fdec9bece1fdd7a
-  data.tar.gz: f10b53efc735c7988b05aed1e562e180416458367c9210fdd6e14fdad1fcb53e625184d9ec46bbd53d4876d063740eea8660f6c3a47dc3bdaf0f57600956eb59
+  metadata.gz: b179aed280d0edc79234813af903c08ed662e3fddaa0f58fc5fb2923bba2d3d54bc8f414ca631c621344806abf020b159b7b410ec097d1ef0df73f05defe5286
+  data.tar.gz: a288b0fd74ada757c60b6e2b2ae6eb6f3c5d689923b21ad148762df2c2aa65737ae6ff19cccb30b0e7dc789e5634d27d1e955f36127925e1492e98a29b17c597

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 group :development do
   # https://github.com/mitchellh/vagrant/pull/4869
   gem 'vagrant', :git => 'https://github.com/mitchellh/vagrant.git', :ref => 'v1.6.5'
+  gem 'rspec'
 end
 
 group :plugins do

data/README.md

@@ -1,24 +1,118 @@
-# Vagrant::Layout
+# vagrant-layout plugin
+
+vagrant-layout plugin do:
+
+1. Download files from GitHub repository
+2. Patch or overwrite the files using Gist
 
-TODO: Write a gem description
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```
+$ vagrant plugin install vagrant-layout
+$ vagrant layout --help
+```
+
+## Plugin Usage
+
+```
+$ vagrant layout init [target]
+```
+
+The targets can be one of the:
+
+ * GitHub branch name (`ruby`)
+ * GitHub user name and branch name (`koseki/ruby`)
+ * GitHub user name, repository name and branch name (`koseki/vagrant-layout/ruby`)
+ * GitHub commit URL (`https://github.com/koseki/vagrant-layout/commit/e09768d`)
+ * GitHub tree URL (`https://github.com/koseki/vagrant-layout/tree/e09768d`)
+ * Gist URL (`https://gist.github.com/koseki/37f61d9a02b9a48e6651`)
+ * Blank. The default target is `koseki/vagrant-layout/master`
+
+### Examples
+
+At first, create project directory.
+
+```
+$ mkdir your_project_name
+$ cd your_project_name
+```
+
+Download from [master branch](https://github.com/koseki/vagrant-layout/tree/master). This is default layout sample. Install Nginx to CentOS.
+
+```
+$ vagrant layout init
+```
+
+Download from [php branch](https://github.com/koseki/vagrant-layout/tree/php). Install Nginx, MySQL, PHP, php-fpm and Composer.
+
+```
+$ vagrant layout init php
+```
+
+Download from [ruby branch](https://github.com/koseki/vagrant-layout/tree/ruby). Install Nginx, MySQL, Ruby and Bundler.
+
+```
+$ vagrant layout init ruby
+```
+
+Download from specific commit and apply patch using [gist](https://gist.github.com/koseki/efbd631472c932ff2153). Install Laravel.
+
+```
+$ vagrant layout init https://gist.github.com/koseki/efbd631472c932ff2153
+```
+
+Download from specific commit and apply patch using [gist](https://gist.github.com/koseki/37f61d9a02b9a48e6651). Install Rails.
+
+```
+$ vagrant layout init https://gist.github.com/koseki/37f61d9a02b9a48e6651
+```
+
+Fork this repository and create your own layout.
+
+```
+## default repository is vagrant-layout.
+$ vagrant layout init ${github_username}/${branch_name}
+$ vagrant layout init ${github_username}/${repository}/${branch_name}
+```
+
+Download from specific commit.
+
+```
+$ vagrant layout init https://github.com/koseki/vagrant-layout/commit/e73c4b21
+```
+
+## Start VM
+
+Doble click `sandbox/osx/start.command` or `sandbox/win/start.command`.
+
+ * You need VirtualBox and Vagrant.
+
+On Windows:
+
+ * ssh command required for `vagrant ssh`. Git includes `ssh.exe`
+ * use `LF` to execute shellscript. check `convert-eol.bat`
+ * do not include white space and non-ASCII character in your project directory path
+ * do not include white space and non-ASCII character in VAGRANT_HOME
+
+If you want to use proxy:
+
+ * execute `sandbox/osx/use-proxy.command` or `use-proxy.bat` and edit generated config file
 
-    gem 'vagrant-layout'
+## Stop VM
 
-And then execute:
+Dobule click `sandbox/osx/stop.command` or `stop.bat`.
 
-    $ bundle
+## Update team member's VM
 
-Or install it yourself as:
+1. Update `sandbox/bin/provision.sh` and commit, push
+2. Ask all team members to pull and execute `sandbox/osx/manage/provision.command` or `provision.bat`
 
-    $ gem install vagrant-layout
+You can't change old provisioning commands. Add new command blocks to `provisioning.sh`.
 
-## Usage
+## Uninstall VM
 
-TODO: Write usage instructions here
+Double click `sandbox/osx/manage/uninstall.command` or `uninstall.bat`.
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
-
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/lib/vagrant-layout/command.rb

@@ -9,13 +9,13 @@ module VagrantPlugins
     #
     class Command < Vagrant.plugin(2, :command)
       def self.synopsis
-        'TODO: synopsis'
+        'create Vagrant layout files'
       end
 
       def execute
         opts = { force: false }
         oparser = OptionParser.new do |o|
-          o.banner = 'Usage: vagrant layout init [gist-url]'
+          o.banner = 'Usage: vagrant layout init [branch|url]'
           o.on('-f', '--force', 'Overwrite existing files') do |f|
             opts[:force] = f
           end
@@ -23,7 +23,10 @@ module VagrantPlugins
         end
 
         opts[:argv] = parse_options(oparser)
-        if opts[:argv].empty?
+
+        if opts[:argv].nil? # --help
+          return -1
+        elsif opts[:argv].to_a.empty?
           puts oparser.help
           return -1
         end

data/lib/vagrant-layout/command_init.rb

@@ -2,6 +2,7 @@ require 'yaml'
 require 'fileutils'
 require 'tmpdir'
 require 'open-uri'
+require_relative 'target'
 require_relative 'tar_gz'
 
 module VagrantPlugins
@@ -10,15 +11,16 @@ module VagrantPlugins
     # init command
     #
     class CommandInit
-      DEFAULT_REPOSITORY = %w{koseki vagrant-layout master}
-
       def initialize(opts)
         @opts = opts
       end
 
       def execute
-        target = parse_target(@opts[:argv].shift)
-        return -1 unless target
+        begin
+          target = Target.new(@opts[:argv].shift)
+        rescue InvalidArgumentException
+          return -1
+        end
 
         Dir.mktmpdir do |root|
           dir = download_layout(root, target)
@@ -28,61 +30,28 @@ module VagrantPlugins
         0
       end
 
-      def parse_target(target)
-        return github_target(DEFAULT_REPOSITORY) unless target
-
-        if target =~ %r{\A(https://gist\.github\.com/[^/]+/[0-9a-f]+)(/(download)?)?}
-          url  = Regexp.last_match[1]
-          path = Regexp.last_match[2]
-          if path == '/'
-            url += 'download'
-          elsif path.to_s == ''
-            url += '/download'
-          else
-            url += path
-          end
-          return [:gist, url]
-        end
-
-        target = target.split('/')
-        if target.length == 1
-          target = [DEFAULT_REPOSITORY[0], DEFAULT_REPOSITORY[1], target[0]]
-        elsif target.length == 2
-          target = [target[0], DEFAULT_REPOSITORY[1], target[1]]
-        elsif target.length >= 4
-          target = target[0..3]
-        end
-
-        github_target(target)
-      end
-
-      def github_target(target)
-        url = "https://github.com/#{ target[0] }/#{ target[1] }/archive/#{ target[2] }.tar.gz"
-        [:github, url]
-      end
-
       def download_layout(root, target)
-        if target[0] == :github
+        if target.type == :github
           return download_github(root, target)
-        elsif target[0] == :gist
+        elsif target.type == :gist
           dir = download_gist(root, target)
           return merge_gist_to_github(root, dir)
         end
       end
 
       def download_github(root, target)
-        puts "Downloading: #{ target[1] }"
+        puts "Downloading: #{ target.url }"
         targz = File.join(root, 'base.tar.gz')
         dest = File.join(root, 'github')
-        extract_tgz(target[1], targz, dest)
+        extract_tgz(target.url, targz, dest)
         first_dir(dest)
       end
 
       def download_gist(root, target)
-        puts "Downloading: #{ target[1] }"
+        puts "Downloading: #{ target.url }"
         targz = File.join(root, 'gist.tar.gz')
         dest = File.join(root, 'gist')
-        extract_tgz(target[1], targz, dest)
+        extract_tgz(target.url, targz, dest)
         first_dir(dest)
       end
 
@@ -106,15 +75,21 @@ module VagrantPlugins
       def merge_gist_to_github(root, gist_dir)
         dotfile = File.join(gist_dir, '.vagrant-layout')
         github_dir = nil
+
         if File.file?(dotfile)
           dot = YAML.load(File.read(dotfile))
           if dot['base']
-            if dot['base'] =~ %r{https://github.com/([-\w]+)/([-\w]+)/tree/([0-9a-f]{40})}
-              github_dir = download_github(root, github_target(Regexp.last_match[1..3]))
+            begin
+              target = Target.new(dot['base'])
+            rescue ArgumentError
+            end
+
+            if target && target.type == :github
+              github_dir = download_github(root, target)
             else
-              msg = 'Illegal base url. Base URL must be like '
-              msg += 'https://github.com/{user}/{repos}/tree/[0-9a-f]{40}'
-              fail msg
+              err = 'Illegal base url. Base URL must be like '
+              err += 'https://github.com/{user}/{repos}/(tree|commit)/[0-9a-f]+'
+              fail err
             end
           end
         end
@@ -150,9 +125,7 @@ module VagrantPlugins
 
         overwrite = []
         sources.each do |src|
-          if File.exist?(src) && ! File.directory?(src)
-            overwrite << src
-          end
+          overwrite << src if File.exist?(src) && !File.directory?(src)
         end
 
         unless overwrite.empty?

data/lib/vagrant-layout/target.rb

@@ -0,0 +1,70 @@
+module VagrantPlugins
+  module Layout
+    #
+    # Command Target
+    #
+    class Target
+      DEFAULT_REPOSITORY = %w{koseki vagrant-layout master}
+
+      attr_reader :type, :url
+
+      def initialize(target_str, default_repository = nil)
+        @default_repository = default_repository || DEFAULT_REPOSITORY
+        if target_str.to_s.strip.empty?
+          github_target(@default_repository)
+        elsif target_str =~ %r{https://}
+          parse_url(target_str)
+        else
+          parse_repository_name(target_str)
+        end
+      end
+
+      private
+
+      #
+      # * GitHub Tree URL
+      #   https://github.com/koseki/vagrant-layout/tree/php
+      #   https://github.com/koseki/vagrant-layout/tree/e09768d91387ea4465abb8755a3cd2eb011bee9a
+      # * GitHub Commit URL
+      #   https://github.com/koseki/vagrant-layout/commit/e09768d91387ea4465abb8755a3cd2eb011bee9a
+      # * Gist URL
+      #   https://gist.github.com/koseki/37f61d9a02b9a48e6651
+      #
+      def parse_url(url)
+        if url =~ %r{\A(https://gist\.github\.com/[^/]+/[0-9a-f]+)/?\z}
+          gist_target(Regexp.last_match[1])
+        elsif url =~ %r{\Ahttps://github.com/([^/]+)/([^/]+)/(?:tree|commit)/([^/]+)/?\z}
+          github_target(Regexp.last_match[1..3])
+        else
+          msg = 'Invalid target URL. URL must be Gist URL or GitHub tree URL'
+          fail ArgumentError, msg
+        end
+      end
+
+      def parse_repository_name(name)
+        target = name.split('/')
+        fail ArgumentError, 'Invalid target' if target.any? { |t| t.strip.empty? }
+
+        if target.length == 1
+          target = [@default_repository[0], @default_repository[1], target[0]]
+        elsif target.length == 2
+          target = [target[0], @default_repository[1], target[1]]
+        elsif target.length >= 4
+          target = target[0..3]
+        end
+        github_target(target)
+      end
+
+      def github_target(target)
+        url = "https://github.com/#{ target[0] }/#{ target[1] }/archive/#{ target[2] }.tar.gz"
+        @type = :github
+        @url = url
+      end
+
+      def gist_target(url)
+        @type = :gist
+        @url = url + '/download'
+      end
+    end
+  end
+end

data/lib/vagrant-layout/version.rb

@@ -3,6 +3,6 @@ module VagrantPlugins
   # Vagrant Layout Plugin
   #
   module Layout
-    VERSION = '0.0.8'
+    VERSION = '0.0.9'
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+  config.order = :random
+end

data/spec/target_spec.rb

@@ -0,0 +1,67 @@
+require 'vagrant-layout/target'
+
+describe VagrantPlugins::Layout::Target do
+  let(:default_target) { %w{user repo tree} }
+  subject { VagrantPlugins::Layout::Target.new(target, default_target) }
+
+  context 'with nil target' do
+    subject { VagrantPlugins::Layout::Target.new(nil) }
+
+    its(:type) { should eq :github }
+    its(:url) { should eq 'https://github.com/koseki/vagrant-layout/archive/master.tar.gz' }
+  end
+
+  context 'with default_target argument' do
+    let(:target) { nil }
+    its(:type) { should eq :github }
+    its(:url) { should eq 'https://github.com/user/repo/archive/tree.tar.gz' }
+  end
+
+  context 'with tree target' do
+    let(:target) { 'php' }
+    its(:type) { should eq :github }
+    its(:url) { should eq 'https://github.com/user/repo/archive/php.tar.gz' }
+  end
+
+  context 'with user/tree target' do
+    let(:target) { 'someone/php' }
+    its(:type) { should eq :github }
+    its(:url) { should eq 'https://github.com/someone/repo/archive/php.tar.gz' }
+  end
+
+  context 'with user/repo/tree target' do
+    let(:target) { 'someone/layout/php' }
+    its(:type) { should eq :github }
+    its(:url) { should eq 'https://github.com/someone/layout/archive/php.tar.gz' }
+  end
+
+  context 'with user/repo/tree target' do
+    let(:target) { 'someone/layout/php' }
+    its(:type) { should eq :github }
+    its(:url) { should eq 'https://github.com/someone/layout/archive/php.tar.gz' }
+  end
+
+  context 'with Gist URL' do
+    let(:target) { 'https://gist.github.com/koseki/37f61d9a02b9a48e6651' }
+    its(:type) { should eq :gist }
+    its(:url) { should eq target + '/download' }
+  end
+
+  context 'with branch name tree URL' do
+    let(:target) { 'https://github.com/koseki/vagrant-layout/tree/php' }
+    its(:type) { should eq :github }
+    its(:url) { should eq 'https://github.com/koseki/vagrant-layout/archive/php.tar.gz' }
+  end
+
+  context 'with hash tree URL' do
+    let(:target) { 'https://github.com/koseki/vagrant-layout/tree/e09768d9' }
+    its(:type) { should eq :github }
+    its(:url) { should eq 'https://github.com/koseki/vagrant-layout/archive/e09768d9.tar.gz' }
+  end
+
+  context 'with commit URL' do
+    let(:target) { 'https://github.com/koseki/vagrant-layout/commit/e09768d9' }
+    its(:type) { should eq :github }
+    its(:url) { should eq 'https://github.com/koseki/vagrant-layout/archive/e09768d9.tar.gz' }
+  end
+end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-layout
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - KOSEKI Kengo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2015-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: vagrant layout plugin
@@ -45,8 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -56,7 +57,10 @@ files:
 - lib/vagrant-layout/command_init.rb
 - lib/vagrant-layout/plugin.rb
 - lib/vagrant-layout/tar_gz.rb
+- lib/vagrant-layout/target.rb
 - lib/vagrant-layout/version.rb
+- spec/spec_helper.rb
+- spec/target_spec.rb
 - vagrant-layout.gemspec
 homepage: ''
 licenses:
@@ -68,12 +72,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -82,4 +86,6 @@ rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: vagrant layout plugin
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/target_spec.rb