hem-tasks-magento1 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 537f914a28dd20a0a140d802acf97e631fdd22c0
+  data.tar.gz: 2e45dba213a5eb0fdce228f70555b8a9ae8b0d3b
+SHA512:
+  metadata.gz: 1dd8533fee5e99558db0a5fa39553c7f8b74d3c344e31478e0fd57dc2056491f5cc5568a24f87a3bee659abaab6a7b5705de0cb7194f362ab604411ebef0d966
+  data.tar.gz: 43ca6a5ec901d152d4eae2e175b3a2437d7dd5432f5d8ea255019c962a5aef9f82d42e22933761b3f05aa2e5aba13775478959bc2db5c0fd58a1729254e65781

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hem-tasks-magento1.gemspec
+gemspec

data/README.md

@@ -0,0 +1,32 @@
+# Hem::Tasks::Magento1
+
+Contains tasks for [Hem](https://github.com/inviqa.com/) to provide functionality
+for Magento 1.* projects
+
+## Installation
+
+Add this line to your application's Hemfile:
+
+```ruby
+plugins
+  gem 'hem-tasks-magento1'
+end
+```
+
+## Usage
+
+Run the following to see usage:
+
+```bash
+hem magento
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/inviqa/hem-tasks-magento1. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/hem-tasks-magento1.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'hem/tasks/magento1/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hem-tasks-magento1"
+  spec.version       = Hem::Tasks::Magento1::VERSION
+  spec.authors       = ["Andy Thompson"]
+  spec.email         = ["athompson@inviqa.com"]
+
+  spec.summary       = %q{Magento 1 tasks for Hem}
+  spec.description   = %q{Magento 1 tasks for Hem}
+  spec.homepage      = ""
+  spec.licenses = ["MIT"]
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/hem/tasks/magento1.rb

@@ -0,0 +1,281 @@
+namespace :tools do
+  desc "Fetches the n98-magerun utility"
+  task :n98magerun do
+    FileUtils.mkdir_p "bin"
+    run_command '"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 = run_command(*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 = run_command(*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 = run_command(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
+            run_command "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"
+      run_command("bin/n98-magerun.phar cache:clean config", :realtime => true, :indent => 2)
+      run_command("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"
+      run_command("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
+      run_command("bin/n98-magerun.phar config:set web/unsecure/base_url 'http://#{domain}/'", :realtime => true, :indent => 2)
+      run_command("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 = run_command("bin/n98-magerun.phar admin:user:list | grep admin", :exit_status => true) == 0
+      unless initialized
+        Hem.ui.success "Creating admin user"
+        run_command("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"
+      run_command("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/magento1/version.rb

@@ -0,0 +1,7 @@
+module Hem
+  module Tasks
+    module Magento1
+      VERSION = '1.0.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: hem-tasks-magento1
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andy Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Magento 1 tasks for Hem
+email:
+- athompson@inviqa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- hem-tasks-magento1.gemspec
+- lib/hem/tasks/magento1.rb
+- lib/hem/tasks/magento1/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Magento 1 tasks for Hem
+test_files: []