vagrant-solidus 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODIzMzI0NmQ0YTgyNWUzNjdhYjY5MDRjNmM4NjY4M2Y0ODM1NTFkYw==
+  data.tar.gz: !binary |-
+    MDU5NzMzYWMyNzFmYmQxN2U4NTRlMGIxY2IyNWZlZDlhMjM2NjYzOQ==
+SHA512:
+  metadata.gz: !binary |-
+    NDg0NjJlMDFiMzdlYTMyM2Y1Yjg3Mzk3NDUwYmE0OGIzZTc0YTFhNjlhN2Vi
+    ZTIwZTBiZTg3NGU5YTliYjk2OTQ0MDkxMzE0N2Y5Yjk2NWQ3NjcwODg1ZDI4
+    YmEzMzY5NzlmY2VmZWU4MDhhNzY5YmJjNjczMmY5NTE5NWY3ZmE=
+  data.tar.gz: !binary |-
+    OTVlY2IxMTczYTg4NzUyNzg5YTdmZDYyMzI0OTkwNzRjZTZiZTNjMTJhMDgw
+    N2IwNTAyM2JjMDIyZjkwZWM5MDc1ZjliNDZkNmY3ZDgwYjkyZWIwZTQzZTBm
+    ZThlOGYyMzM5YmIyNDg0NGIwN2M1MWUxOWQ2NWFhNWI4ZGFjNmU=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem "vagrant", :git => "https://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gem "vagrant-solidus", path: "."
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sparkart Group, Inc.
+
+MIT License
+
+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,201 @@
+# Vagrant plugin for Solidus sites development
+
+This is a [Vagrant][vagrant] plugin that adds a [Solidus][solidus] provisioner and command to manage Solidus sites. It enables you to easily create, run and update Solidus sites in the virtual machine without having to setup or log into the machine itself, through the vagrant command line interface.
+
+## Getting Started
+
+### [Install VirtualBox][virtualbox-install]
+
+[VirtualBox][virtualbox] is a free cross-platform virtualization app that makes it easy to simultaneously run multiple operating systems on your machine. In our usage it is merely a [provider][vagrant-provider] for Vagrant.
+
+### [Install Vagrant][vagrant-install]
+
+[Vagrant][vagrant] layers provisioning, file-based configuration, and a command-line interface on top of VirtualBox. This provides disposable, consistent environments for running development servers. [Synced Folders][vagrant-synced-folders] and [Networking][vagrant-networking] features make the development experience the same as if running in your own environment: your own tools and whatever ports you’d like for access via your browser and other clients.
+
+### [Install Pow][pow] (Mac only)
+
+Among other things, Pow enables port proxying on your Mac, to let you route all web traffic on a particular hostname to another port on your computer. So you'll be able to access your site on `http://sitename.dev` instead of `http://localhost:8081` or `http://lvh.me:8081`. No need to remember weird urls with changing port numbers! Install [Anvil][anvil] to get a handy menubar extra showing all of your Pow-powered hosts. This plugin will automatically configure Pow for your sites, if it is installed.
+
+### Create the Vagrant environment
+
+Using this plugin, you can easily create a `Vagrantfile` ready for Solidus:
+
+```
+$ vagrant plugin install vagrant-solidus
+$ mkdir solidus
+$ cd solidus
+$ vagrant solidus-box init
+```
+
+### Up!
+
+You are now ready to start the virtual machine:
+
+```
+$ vagrant up
+```
+
+This will boot the VM, and automatically install and configure everything that is required to run Solidus sites, a process called [Provisioning][vagrant-provisioning]: `Vagrantfile` defines a pre-built 64-bit Ubuntu 12.04.3 LTS (Precise) “box” provided by the Vagrant team. This file also defines basic configuration such as port mapping and synced folder locations, it can be updated at any time. New boxes are only downloaded to your machine the first time you provision a new VM however. Once the operating system is booted, this plugin will perform additional provisioning. You can redo the provisioning process at any time by running `vagrant provision`.
+
+At this point, you are ready to work on your Solidus site!
+
+## Development Process
+
+A number of ports are automatically opened and forwarded to the virtual machine: `8081 to 8095` for the Solidus sites, and `35730 to 35744` for [LiveReload][livereload]. Whenever a site is started, two ports will be used for that site, so you can load them on your local browser.
+
+A new `site` Vagrant command has been added to help create and manage your Solidus sites. To see all available sub-commands:
+
+```
+$ vagrant site
+```
+
+For help on a specific command, use the `-h` argument. For example:
+
+```
+$ vagrant site create -h
+```
+
+### Creating a site
+
+The easiest way to create a new Solidus site is to use the handy Solidus site template. And the easiest way to do that is to use the following command:
+
+```
+$ vagrant site create my-site
+```
+
+This will create a new sub-directory called `my-site`, initialized with a new site based on the latest [Solidus site template][solidus-site-template]. Another option is to create the directory and site yourself, from the ground up.
+
+### Adding an existing site
+
+To work on an existing Solidus site, copy it or clone it to a sub-directory of this repo. The name of the site will be the name of that sub-directory.
+
+### Starting a site
+
+Once the site has been added, start the Solidus server (which will run within the virtual machine) with this command:
+
+```
+$ cd my-site
+$ vagrant site start
+```
+
+You can now access the website on http://my-site.dev if you installed Pow. If not, look at the `start` command's output, the site's urls will have been displayed. Note that many sites can run at the same time.
+
+Hint: Site files are actually stored on your machine, not in the virtual machine. You can edit them as usual, and the server will load them from your machine. Stopping or deleting the virtual machine will not affect your files.
+
+### Stopping a site
+
+```
+$ vagrant site stop
+```
+
+### Restarting a site
+
+```
+$ vagrant site restart
+```
+
+### Updating a site
+
+As the Solidus and Solidus site templates projects progress, you'll probably want to update your sites to use the latest versions of those repos. This is done with the `update` command:
+
+```
+$ vagrant site update
+```
+
+Note that this command will modify some of your site files. Make sure to review all changes applied to your files before committing those changes.
+
+### Running command line commands
+
+If you need to run custom commands for your site, for example [Grunt tasks][gruntjs], you will need to run them in the VM itself.
+
+Hard way (ssh into the VM and run your commands):
+
+```
+$ vagrant ssh
+$ cd my-site
+$ grunt my-task --option=something
+$ exit
+```
+
+Easy way (use the `run` command):
+
+```
+$ vagrant site run grunt my-site --option=something
+```
+
+### Are my sites running?
+
+```
+$ vagrant site status
+```
+
+### Debugging a site
+
+Run this command to follow the site's log:
+
+```
+$ vagrant site log
+```
+
+### Deleting a site
+
+Warning: you will obviously lose your local site files!
+
+```
+$ vagrant site stop
+$ cd ..
+$ rm -rf my-site
+```
+
+### Managing the VM
+
+To stop the virtual machine, run:
+
+```
+$ vagrant halt
+```
+
+[See the CLI docs][vagrant-cli] for other commands.
+
+### Updating
+
+To use the latest version of vagrant-solidus, simply update the plugin and re-initialize your `Vagrantfile`:
+
+```
+$ vagrant halt
+$ vagrant plugin update vagrant-solidus
+$ vagrant solidus-box init
+$ vagrant up
+```
+
+## Troubleshooting ##
+
+### Windows: 'ssh' executable not found
+
+Vagrant needs an `ssh.exe` executable to log into the virtual machine when running `vagrant ssh`. Windows doesn't provide such an executable by default, but Git does. The easiest way to fix this problem is by adding Git's `bin` path to the system's `PATH` environment variable. In the Start menu, search for "system environment variables". Then locate the `PATH` system environment variable, click `Edit` and add Git's `bin` path (probably located in `C:\Program Files (x86)\Git\bin`). Note that you will need to restart your Command Prompt for the changes to take effect. Also, note that Git's own executables like `find.exe` will be now be used instead of Windows' default executables.
+
+### Resetting the VM
+
+If your virtual machine is in a weird state, the simplest solution is sometimes to rebuild it. All you need to do is destroy the VM and rebuild. This process will not delete your sites files, since they are hosted on your machine, not in the virtual machine.
+
+```
+$ vagrant destroy
+$ vagrant up
+```
+
+[virtualbox]: https://www.virtualbox.org
+[virtualbox-install]: https://www.virtualbox.org/wiki/Downloads
+[vagrant]: http://www.vagrantup.com
+[vagrantfile]: https://docs.vagrantup.com/v2/vagrantfile/
+[vagrant-provider]: http://docs.vagrantup.com/v2/providers
+[vagrant-install]: http://www.vagrantup.com/downloads.html
+[vagrant-synced-folders]: http://docs.vagrantup.com/v2/synced-folders/index.html
+[vagrant-networking]: http://docs.vagrantup.com/v2/networking/index.html
+[vagrant-provisioning]: http://docs.vagrantup.com/v2/provisioning/index.html
+[solidus]: https://github.com/solidusjs/solidus
+[pow]: http://pow.cx
+[anvil]: http://anvilformac.com
+[livereload]: http://livereload.com
+[solidus-site-template]: https://github.com/solidusjs/solidus-site-template
+[gruntjs]: http://gruntjs.com
+[vagrant-cli]: http://docs.vagrantup.com/v2/cli

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/vagrant-solidus.rb

@@ -0,0 +1,26 @@
+require_relative 'vagrant-solidus/site_helpers'
+require_relative 'vagrant-solidus/version'
+
+module VagrantPlugins
+  module Solidus
+    class Plugin < Vagrant.plugin('2')
+      name 'Solidus'
+      description 'This plugin provides a provisioner and a `site` command that allows Solidus sites to be managed by Vagrant.'
+
+      provisioner(:solidus) do
+        require_relative 'vagrant-solidus/provisioner'
+        Provisioner
+      end
+
+      command(:site) do
+        require_relative 'vagrant-solidus/site/command'
+        Site::Command
+      end
+
+      command('solidus-box') do
+        require_relative 'vagrant-solidus/solidus-box/command'
+        SolidusBox::Command
+      end
+    end
+  end
+end

data/lib/vagrant-solidus/command.rb

@@ -0,0 +1,70 @@
+module VagrantPlugins
+  module Solidus
+    class Command < Vagrant.plugin('2', :command)
+      def self.synopsis
+        'command description'
+      end
+
+      def command
+        'the-command'
+      end
+
+      def subcommands
+        %w[the subcommands]
+      end
+
+      def initialize(argv, env)
+        super
+
+        @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+
+        @subcommands = Vagrant::Registry.new
+        subcommands.each do |subcommand|
+          @subcommands.register(subcommand.to_sym) do
+            require_relative "#{command}/#{subcommand}"
+            eval((self.class.to_s.split('::')[0...-1] + [subcommand.capitalize]).join('::'))
+          end
+        end
+      end
+
+      def execute
+        if @main_args.include?("-h") || @main_args.include?("--help")
+          # Print the help for all the site commands.
+          return help
+        end
+
+        # If we reached this far then we must have a subcommand. If not,
+        # then we also just print the help and exit.
+        command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
+        return help if !command_class || !@sub_command
+        @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")
+
+        # Initialize and execute the command class
+        command_class.new(@sub_args, @env).execute
+      end
+
+      # Prints the help out for this command
+      def help
+        opts = OptionParser.new do |opts|
+          opts.banner = "Usage: vagrant #{command} SUBCOMMAND [OPTIONS]"
+          opts.separator ""
+          opts.separator "Available subcommands:"
+
+          # Add the available subcommands as separators in order to print them
+          # out as well.
+          keys = []
+          @subcommands.each { |key, value| keys << key.to_s }
+
+          keys.sort.each do |key|
+            opts.separator "     #{key}"
+          end
+
+          opts.separator ""
+          opts.separator "For help on any individual subcommand run `vagrant #{command} SUBCOMMAND -h`"
+        end
+
+        @env.ui.info(opts.help, :prefix => false)
+      end
+    end
+  end
+end

data/lib/vagrant-solidus/provisioner.rb

@@ -0,0 +1,87 @@
+module VagrantPlugins
+  module Solidus
+    class Provisioner < Vagrant.plugin('2', :provisioner)
+      include VagrantPlugins::Solidus::SiteHelpers
+
+      def configure(root_config)
+        # TODO: Make this configurable
+        15.times do |i|
+          port = VagrantPlugins::Solidus::SiteHelpers::BASE_PORT + i
+          root_config.vm.network :forwarded_port, guest: port, host: port
+
+          port = VagrantPlugins::Solidus::SiteHelpers::BASE_LIVERELOAD_PORT + i
+          root_config.vm.network :forwarded_port, guest: port, host: port
+        end
+      end
+
+      def provision
+        # ***********************************************************************
+        # !! IMPORTANT !! Update SiteHelpers::PROVISION_ID when this method is
+        #                 changed, to force a re-provisioning.
+        # ***********************************************************************
+
+        @env = @machine.env
+
+        @env.ui.info('Retrieving new lists of packages')
+        execute('apt-get update', sudo: true)
+
+        @env.ui.info('Installing curl')
+        execute('apt-get -y install curl', sudo: true)
+
+        @env.ui.info('Installing vim')
+        execute('apt-get -y install vim', sudo: true)
+
+        @env.ui.info('Installing git')
+        execute('apt-get -y install git', sudo: true)
+
+        @env.ui.info('Installing dos2unix')
+        execute('apt-get -y install dos2unix', sudo: true)
+
+        @env.ui.info('Installing nvm, node.js and npm')
+        execute('curl -s https://raw.githubusercontent.com/creationix/nvm/v0.5.1/install.sh | sh')
+        execute('source ~/.nvm/nvm.sh')
+        execute('nvm install 0.10.22')
+        execute('nvm use 0.10.22')
+        execute('nvm alias default 0.10.22')
+
+        @env.ui.info('Installing grunt.js')
+        execute('npm install grunt-cli@"~0.1.13" -g')
+        execute('npm install grunt-init@"~0.3.1" -g')
+
+        @env.ui.info('Configuring rubygems')
+        @machine.communicate.upload(File.expand_path('provisioner/.gemrc', File.dirname(__FILE__)), '/home/vagrant/.gemrc')
+        execute('dos2unix -o ~/.gemrc')
+
+        @env.ui.info('Installing rvm and ruby')
+        execute('curl -sSL https://get.rvm.io | bash -s stable --ruby=1.9.3-p545')
+        execute('source ~/.rvm/scripts/rvm')
+        execute('rvm rvmrc warning ignore allGemfiles')
+        execute('rvm use --default ruby-1.9.3-p545')
+
+        @env.ui.info('Configuring bash')
+        @machine.communicate.upload(File.expand_path('provisioner/.bashrc', File.dirname(__FILE__)), '/home/vagrant/.bashrc-vagrant-solidus')
+        execute('dos2unix -o ~/.bashrc-vagrant-solidus')
+        unless guest_exec(nil, 'grep "^\. ~/.bashrc-vagrant-solidus" ~/.bashrc')
+          execute('echo ". ~/.bashrc-vagrant-solidus" >> ~/.bashrc')
+          execute('. ~/.bashrc-vagrant-solidus')
+        end
+
+        execute(provisioned!)
+
+        # ***********************************************************************
+        # !! IMPORTANT !! Update SiteHelpers::PROVISION_ID when this method is
+        #                 changed, to force a re-provisioning.
+        # ***********************************************************************
+      end
+
+      private
+
+      def execute(*args)
+        unless guest_exec(:log_on_error, *args)
+          @env.ui.error('Virtual machine could not be provisioned')
+          abort
+        end
+      end
+    end
+  end
+end