hem 1.0.1.beta1

data/lib/hem/tasks/deps.rb

@@ -0,0 +1,103 @@
+desc "Dependency related tasks"
+hidden true
+namespace :deps do
+
+  desc "Install Gem dependencies"
+  task :gems do
+    locate "*Gemfile" do
+      required = shell("bundle", "check", :exit_status => true) != 0
+      if required
+        Hem.ui.title "Installing Gem dependencies"
+        shell "bundle", "install", realtime: true, indent: 2
+        Hem.ui.separator
+      end
+    end
+  end
+
+  desc "Install composer dependencies"
+  task :composer do
+    if File.exists? File.join(Hem.project_path, "composer.json")
+      Rake::Task["tools:composer"].invoke
+      Hem.ui.title "Installing composer dependencies"
+      Dir.chdir Hem.project_path do
+        ansi = Hem.ui.supports_color? ? '--ansi' : ''
+        args = [ "php bin/composer.phar install #{ansi} --prefer-dist", { realtime: true, indent: 2 } ]
+        complete = false
+
+        unless maybe(Hem.project_config.tasks.deps.composer.disable_host_run)
+          check = Hem::Lib::HostCheck.check(:filter => /php_present/)
+
+          if check[:php_present] == :ok
+            begin
+              shell *args
+              complete = true
+            rescue Hem::ExternalCommandError
+              Hem.ui.warning "Installing composer dependencies locally failed!"
+            end
+          end
+        end
+
+        if !complete
+          vm_shell *args
+        end
+
+        Hem.ui.success "Composer dependencies installed"
+      end
+
+      Hem.ui.separator
+    end
+  end
+
+  desc "Install vagrant plugins"
+  task :vagrant_plugins => [ "deps:gems" ] do
+    plugins = shell "vagrant plugin list", :capture => true
+    locate "*Vagrantfile" do
+      to_install = []
+      File.read("Vagrantfile").split("\n").each do |line|
+        if line.match /#\s*Hem.vagrant_plugin (.*)/ or line.match /#\s*Hobo.vagrant_plugin (.*)/
+          to_install << $1
+        else
+          next if line.match /^\s*#/
+          next unless line.match /Vagrant\.require_plugin (.*)/
+          to_install << $1
+        end
+      end
+
+      to_install.each do |plugin|
+        plugin.gsub!(/['"]*/, '')
+        next if plugins.include? "#{plugin} "
+        Hem.ui.title "Installing vagrant plugin: #{plugin}"
+        shell "vagrant", "plugin", "install", plugin, :realtime => true, :indent => 2
+        Hem.ui.separator
+      end
+    end
+  end
+
+  desc "Install chef dependencies"
+  task :chef => [ "deps:gems" ] do
+    locate "*Cheffile" do
+      Hem.ui.title "Installing chef dependencies via librarian"
+      bundle_shell "librarian-chef", "install", "--verbose", :realtime => true, :indent => 2 do |line|
+        line =~ /Installing.*</ ? line.strip + "\n" : nil
+      end
+      Hem.ui.separator
+    end
+
+    locate "*Berksfile" do
+      Hem.ui.title "Installing chef dependencies via berkshelf"
+      executor = (shell("bash -c 'which berks'", :capture => true).strip =~ /chefdk/) ?
+        lambda { |*args| shell *args } :
+        lambda { |*args| bundle_shell *args }
+
+      executor.call "berks", "install", :realtime => true, :indent => 2
+      version = executor.call "berks", "-v", :capture => true
+      if version =~ /^[3-9]/
+        shell "rm -rf cookbooks"
+        executor.call "berks", "vendor", "cookbooks"
+      else
+        executor.call "berks", "install", "--path", "cookbooks"
+      end
+      Hem.ui.separator
+    end
+  end
+end

data/lib/hem/tasks/exec.rb

@@ -0,0 +1,3 @@
+task 'exec' do
+  exec(*$HEM_ARGV)
+end

data/lib/hem/tasks/magento.rb

@@ -0,0 +1,281 @@
+namespace :tools do
+  desc "Fetches the n98-magerun utility"
+  task :n98magerun do
+    FileUtils.mkdir_p "bin"
+    vm_shell '"wget" --no-check-certificate "https://raw.github.com/netz98/n98-magerun/master/n98-magerun.phar" -O bin/n98-magerun.phar'
+    FileUtils.chmod 0755, "bin/n98-magerun.phar"
+  end
+end
+
+desc "Magento related tasks"
+namespace :magento do
+
+  desc "Patch tasks"
+  namespace :patches do
+    def magento_path
+      unless @magento_path
+        files = locate('*app/Mage.php')
+        unless files.length > 0
+          raise Hem::UserError.new "Could not find app/Mage.php in the git repository, this command should only be run for Magento projects"
+        end
+
+        /(?:(.*)\/)app\/Mage\.php/.match(files[0])
+        @magento_path = $1
+      end
+      @magento_path
+    end
+
+    def detect_clean
+      status = shell('git status -z', :capture => true, :strip => false)
+      status.split("\u0000").each do |line|
+        match = line.match(/^([\s\S]{2})\s+(.*)$/)
+        next if match.nil?
+
+        if ![' ', '?'].include?($1[0]) || $2.start_with?(magento_path)
+          raise Hem::UserError.new "Please remove all files from the git index, and stash all changes in '#{magento_path}' before continuing"
+        end
+      end
+    end
+
+    def detect_version
+      config_dirty = false
+      magento_version_file = "#{magento_path}/app/Mage.php"
+
+      if Hem.project_config[:magento_edition].nil?
+        magento_edition = nil
+        if magento_version_file
+          args = [ "php -r \"require '#{magento_version_file}'; echo Mage::getEdition();\""]
+
+          magento_edition = vm_shell(*args, :capture => true).to_s.downcase
+        end
+
+        edition_options = ['community', 'enterprise', 'professional', 'go']
+
+        unless edition_options.include? magento_edition
+          raise Hem::Error.new "Invalid Magento edition '#{magento_edition}' was found when calling Mage::getEdition(), skipping patches"
+        end
+
+        Hem.project_config[:magento_edition] = magento_edition
+        config_dirty = true
+      end
+
+      if Hem.project_config[:magento_version].nil?
+        magento_version = nil
+        if magento_version_file
+          args = [ "php -r \"require '#{magento_version_file}'; echo Mage::getVersion();\""]
+
+          magento_version = vm_shell(*args, :capture => true)
+        end
+
+        version_regex = /^\d+(\.\d+){3}$/
+
+        unless version_regex.match(magento_version)
+          raise Hem::Error.new "Invalid Magento version '#{magento_version}' was found when calling Mage::getVersion(), skipping patches"
+        end
+
+        Hem.project_config[:magento_version] = magento_version
+        config_dirty = true
+      end
+
+      if config_dirty
+        Hem::Config::File.save(Hem.project_config_file, Hem.project_config)
+      end
+    end
+
+    def detect_tools
+      use_vm = shell("which which", :exit_status => true) != 0
+
+      tools = ['patch', 'sed']
+      tools_command = tools.map {|tool| "which #{tool}"}.join " && "
+      status = 0
+
+      unless use_vm
+        status = shell(tools_command, :exit_status => true)
+        use_vm = status != 0
+      end
+
+      if use_vm
+        status = vm_shell(tools_command, :exit_status => true)
+      end
+
+      if status != 0
+        raise Hem::UserError.new "Please make sure '#{tools.join(',')}' is installed on your host or VM before continuing"
+      end
+
+      use_vm
+    end
+
+    desc "Apply patches to Magento"
+    task "apply" do
+      detect_clean
+      detect_version
+
+      config = Hem.project_config
+
+      sync = Hem::Lib::S3::Sync.new(Hem.aws_credentials)
+
+      patches_path = "#{Hem.project_path}/tools/patches"
+      incoming_path = "#{patches_path}/incoming"
+
+      Hem.ui.success("Downloading Magento #{config[:magento_edition].capitalize} #{config[:magento_version]} patches")
+      changes = sync.sync(
+        "s3://inviqa-assets-magento/#{config[:magento_edition]}/patches/#{config[:magento_version]}/",
+        "#{incoming_path}/",
+        :delete => false
+      )
+      Hem.ui.separator
+
+      use_vm = false
+      use_vm = detect_tools if Dir.glob("#{incoming_path}/*.sh").length > 0
+
+      patch_files = Dir.glob("#{incoming_path}/*.{sh,patch,diff}")
+
+      Hem.ui.success("#{patch_files.length} new patches found")
+
+      Hem.ui.separator
+
+      patch_files.each do |file|
+        filename = File.basename(file)
+        base_filename = File.basename(filename, File.extname(filename))
+
+        if File.exist?("#{patches_path}/#{filename}")
+          Hem.ui.debug("Patch #{filename} has already been applied, so skipping it")
+
+          File.delete file
+          next
+        end
+
+        if File.exist?("#{patches_path}/#{base_filename}.skip")
+          File.delete file
+          next
+        end
+
+        Hem.ui.success("Applying patch #{filename}")
+
+        yaml_file = File.join(File.dirname(file), base_filename + ".yaml")
+
+        metadata = {
+          'commit_message' => "Apply Magento patch #{filename}"
+        }
+        if File.exist?(yaml_file)
+          metadata = Hem::Config::File.load(yaml_file)
+        end
+
+        Hem.ui.info(metadata['description']) unless metadata['description'].nil?
+
+        patch_options = %w( yes never skip )
+        answer = Hem.ui.ask_choice('Do you want to apply this patch?', patch_options)
+
+        if answer == 'skip'
+          next
+        end
+
+        if answer == 'never'
+          File.delete file
+          File.write("#{patches_path}/#{base_filename}.skip", '')
+
+          shell "git add '#{patches_path}/#{base_filename}.skip'"
+          shell "git commit -m 'Add a skip file for patch #{filename}'"
+          next
+        end
+
+        if /\.sh$/.match(file)
+          File.rename file, "#{magento_path}/#{filename}"
+          file = "#{magento_path}/#{filename}"
+          if use_vm
+            vm_shell "cd #{magento_path} && sh #{filename}", :realtime => true, :indent => 2
+          else
+            shell "cd #{magento_path} && sh #{filename}", :realtime => true, :indent => 2
+          end
+        else
+          shell "git apply --directory #{magento_path} #{file}"
+        end
+        File.rename file, "#{patches_path}/#{filename}"
+        shell "git add #{magento_path}"
+        shell "git add #{patches_path}/#{filename}"
+
+        if File.exist?(yaml_file)
+          yaml_filename = File.basename(yaml_file)
+          File.rename yaml_file, "#{patches_path}/#{yaml_filename}"
+          shell "git add #{patches_path}/#{yaml_filename}"
+        end
+        shell "git commit -m #{metadata['commit_message'].shellescape}"
+
+        Hem.ui.separator
+      end
+
+      Hem.ui.success("Finished applying #{patch_files.length} patches")
+    end
+  end
+
+  desc "Setup script tasks"
+  namespace :'setup-scripts' do
+    desc "Run magento setup scripts"
+    task :run => ['tools:n98magerun']  do
+      Hem.ui.success "Running setup scripts"
+      vm_shell("bin/n98-magerun.phar cache:clean config", :realtime => true, :indent => 2)
+      vm_shell("bin/n98-magerun.phar sys:setup:incremental -n", :realtime => true, :indent => 2)
+      Hem.ui.separator
+    end
+  end
+
+  desc "Cache tasks"
+  namespace :cache do
+    desc "Clear cache"
+    task :clear => ['tools:n98magerun']  do
+      Hem.ui.success "Clearing magento cache"
+      vm_shell("bin/n98-magerun.phar cache:flush", :realtime => true, :indent => 2)
+      Hem.ui.separator
+    end
+  end
+
+  desc "Configuration related tasks"
+  namespace :config do
+    desc "Configure magento base URLs"
+    task :'configure-urls' => ['tools:n98magerun'] do
+      Hem.ui.success "Configuring magento base urls"
+      domain = Hem.project_config.hostname
+      vm_shell("bin/n98-magerun.phar config:set web/unsecure/base_url 'http://#{domain}/'", :realtime => true, :indent => 2)
+      vm_shell("bin/n98-magerun.phar config:set web/secure/base_url 'https://#{domain}/'", :realtime => true, :indent => 2)
+      Hem.ui.separator
+    end
+
+    desc "Enable magento errors"
+    task :'enable-errors' do
+      error_config = File.join(Hem.project_path, 'public/errors/local.xml')
+
+      FileUtils.cp(
+          error_config + ".sample",
+          error_config
+      ) unless File.exists? error_config
+    end
+
+    desc "Create admin user"
+    task :'create-admin-user' do
+      initialized = vm_shell("bin/n98-magerun.phar admin:user:list | grep admin", :exit_status => true) == 0
+      unless initialized
+        Hem.ui.success "Creating admin user"
+        vm_shell("bin/n98-magerun.phar admin:user:create admin '' admin admin admin", :realtime => true, :indent => 2)
+        Hem.ui.separator
+      end
+    end
+
+    desc "Enable rewrites"
+    task :'enable-rewrites' do
+      Hem.ui.success "Enabling rewrites"
+      vm_shell("bin/n98-magerun.phar config:set web/seo/use_rewrites 1", :realtime => true, :indent => 2)
+      Hem.ui.separator
+    end
+  end
+
+  desc "Initializes magento specifics on the virtual machine after a fresh build"
+  task :'initialize-vm' => [
+    'magento:config:enable-errors',
+    'tools:n98magerun',
+    'magento:setup-scripts:run',
+    'magento:config:configure-urls',
+    'magento:config:create-admin-user',
+    'magento:config:enable-rewrites',
+    'magento:cache:clear'
+  ]
+end

data/lib/hem/tasks/ops.rb

@@ -0,0 +1,6 @@
+namespace :ops do
+  task 'generate-self-signed-cert', [ 'domain' ] do |task, args|
+    cert = Hem::Lib::SelfSignedCertGenerator.generate args[:domain]
+    puts "Key:\n#{cert[:key]}\nCert:\n#{cert[:cert]}\n"
+  end
+end

data/lib/hem/tasks/pr.rb

@@ -0,0 +1,45 @@
+desc 'Perform pull request operations'
+namespace :pr do
+  desc 'Create a new pull request'
+  task :create do
+    source_branch = Hem.ui.ask 'Source branch', default: (Hem::Helper.shell 'git rev-parse --abbrev-ref HEAD', :capture => true)
+    target_branch = Hem.ui.ask 'Target branch', default: 'develop'
+
+    pr_content = <<-prbody
+# The line below this comment is the title of your pull request. Keep it short and on a single line.
+PR_TITLE
+
+# All text below this comment will appear as the body of the pull request.
+# If your project has a DoD.md in the project root, it will be automatically included.
+# Any line starting with a hash (comment) will be ignored
+
+PR_DOD
+prbody
+
+    pr_content['PR_TITLE'] = Hem::Helper.shell 'git log -1 --pretty=%B', :capture => true
+
+    dod_path = Hem::Helper.locate('DoD.md')
+
+    if dod_path && !dod_path.empty?
+      dod_file = File.open dod_path[0]
+      pr_content['PR_DOD'] = dod_file.read
+      dod_file.close
+    else
+      pr_content['PR_DOD'] = '# No DoD.md file found, add one to your project root.'
+    end
+
+    pr_body = Hem.ui.editor(pr_content).lines.reject{ |line| line[0] == '#' }.join
+
+    pr_title = pr_body.lines.to_a[0]
+
+    pr_body = pr_body.lines.to_a[1..-1].join
+
+    git_parts = Hem::Helper.parse_github_url(Hem.project_config.git_url)
+    repo = "#{git_parts[:owner]}/#{git_parts[:repo]}"
+
+    api = Hem::Lib::Github::Api.new
+    pr_url = api.create_pull_request(repo, target_branch, source_branch, pr_title, pr_body)
+
+    Hem::ui.success "Pull request created: #{pr_url}"
+  end
+end

data/lib/hem/tasks/seed.rb

@@ -0,0 +1,61 @@
+
+desc "Project seed commands"
+namespace :seed do
+
+  desc "Create a new project from a seed repository"
+
+  option '-g=', '--git-url=', 'Git repository for project'
+  option '-s=', '--seed=', 'Seed name or URL to use'
+  option '-b=', '--branch=', 'Seed branch to use'
+  option '-d=', '--data=', 'Seed data to save to the project hem configuration', :as => Hash
+
+  task :plant, [ :name ] do |t, args|
+    name = args[:name]
+
+    Hem.project_path = File.join(Dir.pwd, name)
+
+    raise Hem::UserError.new "Name must match sprint zero guidelines" unless name.match /[a-z0-9\-]+/
+    raise Hem::UserError.new "#{Hem.project_path} already exists!" if File.exists? Hem.project_path
+
+    config = {
+      :name => name,
+      :project_path => Hem.project_path,
+      :git_url => t.opts[:'git-url'] || Hem.ui.ask("Repository URL", default: "git@github.com:inviqa/#{name}"),
+      :ref => t.opts[:branch] || 'master'
+    }
+
+    seed_options = %w( default magento symfony custom )
+
+    seed_name = t.opts[:seed] || Hem.ui.ask_choice('Project seed', seed_options, default: 'default')
+    use_short_seed_name = true
+
+    if seed_name == 'custom'
+      seed_name = Hem.ui.ask('Please enter a git url or a path to a local git checkout containing the seed')
+      use_short_seed_name = false
+    end
+
+    config[:seed] = {
+      :name => File.basename(seed_name, '.git'),
+      :url => Hem::Lib::Seed::Seed.name_to_url(seed_name, :use_short_seed_name => use_short_seed_name)
+    }
+
+    unless t.opts[:data].nil?
+      data = t.opts[:data].inject({}){|hash,(k,v)| hash[k.to_sym] = v; hash}
+      config.merge!(data)
+    end
+
+    seed = Hem::Lib::Seed::Seed.new(
+      File.join(Hem.seed_cache_path, config[:seed][:name]),
+      config[:seed][:url]
+    )
+
+    config[:vm_ip] = seed.vm_ip
+
+    Hem::Lib::Seed::Project.new().setup(seed, config)
+
+    Hem.ui.separator
+    Hem.ui.success "Your new project is available in #{Hem.project_path}."
+    Hem.ui.success "You will need to review the initial commit and if all is well, push the repository to github using `git push origin --all`."
+    Hem.ui.separator
+  end
+end

data/lib/hem/tasks/self.rb

@@ -0,0 +1,45 @@
+desc "Internal hem debugging tools"
+hidden true
+namespace 'self'  do
+
+  desc "REPL"
+  task :repl do
+    require 'pry'
+    Pry.config.prompt = if STDIN.tty?
+      proc { 'hem > '}
+    else
+      proc { '' }
+    end
+    pry
+  end
+
+  desc "Tasks for debugging hem"
+  namespace 'debug' do
+    desc "Display project paths"
+    project_only
+    task "paths" do
+      Hem.ui.info "<%=color('Project path:', :green)%> " + Hem.project_path
+      {
+        :gemfile => "*Gemfile",
+        :vagrantfile => "*Vagrantfile",
+        :cheffile => "*Cheffile",
+        :berksfile => "*Berksfile",
+        :'composer.json' => "composer.json"
+      }.each do |k,v|
+        path = nil
+        locate v do |file, full_file|
+          path = full_file
+        end
+        Hem.ui.info "<%=color('#{k.to_s}:', :green) %> #{path.nil? ? "none" : path}"
+      end
+    end
+
+    desc "Locate"
+    project_only
+    task "locate", [ :arg ] do |task, args|
+      locate args[:arg] do |file, full_file|
+        puts full_file
+      end
+    end
+  end
+end

data/lib/hem/tasks/shell_init.rb

@@ -0,0 +1,25 @@
+namespace 'shell-init' do
+  def posix_export_path
+    Hem.ui.output %Q(export PATH="#{ENV['PATH']}")
+  end
+
+  def fish_export_path
+    Hem.ui.output %Q(set -gx PATH "#{ENV['PATH'].split(':').join('" "')}" 2>/dev/null;)
+  end
+
+  task 'bash' do
+    posix_export_path
+  end
+
+  task 'sh' do
+    posix_export_path
+  end
+
+  task 'zsh' do
+    posix_export_path
+  end
+
+  task 'fish' do
+    fish_export_path
+  end
+end

data/lib/hem/tasks/system/completions.rb

@@ -0,0 +1,76 @@
+desc "System configuration related commands"
+namespace :system do
+
+  desc "Shell completion related commands"
+  namespace :completions do
+
+    desc "Install shell completion helpers"
+    option '-f', '--fish', 'Install completions for FISH'
+    option '-b', '--bash', 'Install completions for Bash'
+    option '-z', '--zsh', 'Install completions for ZSH'
+    task "install" do |task|
+      if task.opts[:fish]
+        script = <<-EOF
+function __hem_completion -d "Create hem completions"
+  set -l cache_dir "/tmp/fish_hem_completion_cache"
+  mkdir -p $cache_dir
+  set -l hashed_pwd (ruby -r 'digest' -e 'puts Digest::MD5.hexdigest(`pwd`)')
+  set -l hem_cache_file "$cache_dir/$hashed_pwd"
+
+  if not test -f "$hem_cache_file"
+    hem system completions fish --skip-host-checks > "$hem_cache_file"
+  end
+
+  cat "$hem_cache_file"
+end
+
+function __hem_scope_test -d "Hem scoped completion test"
+  set cmd (commandline -opc)
+  if [ "$cmd" = "$argv" ]
+    return 0
+  end
+  return 1
+end
+
+eval (__hem_completion)
+EOF
+        target = File.join(ENV['HOME'], '.config/fish/completions/hem.fish')
+        FileUtils.mkdir_p(File.dirname(target))
+        File.write(target, script)
+      end
+
+      if task.opts[:bash]
+        raise "Bash completions not yet implemented"
+      end
+
+      if task.opts[:zsh]
+        raise "ZSH completions not yet implemented"
+      end
+    end
+
+    desc "Display FISH shell completion commands"
+    task :fish do
+      Hem.cli.slop.options.each do |option|
+        short = option.short.nil? ? '' : "-s #{option.short}"
+        long = option.long.nil? ? '' : "-l #{option.long}"
+        arg = option.config[:argument] ? '' : '-x'
+        puts "complete #{arg} -c hem #{short} #{long} --description '#{option.description}';"
+      end
+
+      map = Hem.cli.help_formatter.command_map
+      map.each do |k, v|
+        next if v.description.nil? || v.description.empty?
+        k = k.split(':')
+        k.unshift 'hem'
+        c = k.pop
+        puts "complete -x -c hem -n '__hem_scope_test #{k.join(' ')}' -a #{c} --description '#{v.description}';"
+        v.options.each do |option|
+          short = option.short.nil? ? '' : "-s #{option.short}"
+          long = option.long.nil? ? '' : "-l #{option.long}"
+          arg = option.config[:argument] ? '' : '-x'
+          puts "complete #{arg} -c hem -n '__hem_scope_test #{k.concat([c]).join(' ')}' #{short} #{long} --description '#{option.description}';"
+        end
+      end
+    end
+  end
+end

data/lib/hem/tasks/system.rb

@@ -0,0 +1,18 @@
+desc "System configuration related commands"
+namespace :system do
+
+  desc "Check system configuration for potential problems"
+  task :check do
+    Hem::Lib::HostCheck.check.each do |k,v|
+      name = k.to_s.gsub('_', ' ')
+      name[0] = name[0].upcase
+
+      if v == :ok
+        Hem.ui.success "#{name}: OK"
+      else
+        Hem.ui.error "#{name}: FAILED\n"
+        Hem.ui.warning v.advice.gsub(/^/, '  ')
+      end
+    end
+  end
+end

data/lib/hem/tasks/tools.rb

@@ -0,0 +1,17 @@
+desc "Tasks to retrieve common tools"
+hidden
+namespace :tools do
+
+  desc "Fetch composer"
+  task :composer do
+    bin_file = File.join(Hem.project_bin_path, "composer.phar")
+    unless File.exists?(bin_file)
+      Hem.ui.success "Getting composer"
+      FileUtils.mkdir_p File.dirname(bin_file)
+      vm_shell "cd bin && php -r \"readfile('https://getcomposer.org/installer');\" | php", :realtime => true, :indent => 2
+    else
+      Hem.ui.success "Composer already available in bin/composer.phar"
+    end
+    Hem.ui.separator
+  end
+end