hem-tasks-magento2 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa408e4d64fc2ce0c78144c4bc85b4de304a0877
+  data.tar.gz: 45f71e8f79720594a365507cbcfe9547d8f96ea0
+SHA512:
+  metadata.gz: 43600bd7b73558123f662262342df6c54ea3a2ef7c968d91c49046f75aae0c8ae247ad86c0937df6a1e5cf735999d2f61bd6eb8854de72f95be743b5d3583dec
+  data.tar.gz: 2499ed94e66d8327f8b384a0f3693682e9a18bee8a536654df448256f42db250702f3e56cabc96d3ab80c1d3402ad7644bc366c57bc021ed157992da51806b40

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics/LineLength:
+  Max: 120

data/Gemfile

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

data/README.md

@@ -0,0 +1,33 @@
+# Hem::Tasks::Magento2
+
+Contains tasks for [Hem](https://github.com/inviqa/hem) to provide functionality
+for Magento 2.* projects
+
+## Installation
+
+Add this line to your application's Hemfile:
+
+```ruby
+plugins do
+  gem 'hem-tasks-magento2'
+end
+```
+
+## Usage
+
+Run the following to see usage:
+
+```bash
+hem magento2
+```
+
+## 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-magento2. 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-magento2.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'hem/tasks/magento2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hem-tasks-magento2'
+  spec.version       = Hem::Tasks::Magento2::VERSION
+  spec.authors       = ['Norbert Nagy', 'Kieren Evans']
+  spec.email         = ['nnagy@inviqa.com', 'kevans+hem_tasks@inviqa.com']
+
+  spec.summary       = 'Magento 2 tasks for Hem'
+  spec.description   = 'Magento 2 tasks for Hem'
+  spec.homepage      = ''
+  spec.licenses = ['MIT']
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|\.rubocop\.yml|Rakefile)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.43.0'
+end

data/lib/hem/tasks/magento2/cache.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+desc 'Cache related functionality'
+namespace :cache do
+  desc 'Clean cache'
+  task :clean do
+    Hem.ui.title 'Cleaning cache'
+    run_command 'bin/magento cache:clean', realtime: true, indent: 2
+    Hem.ui.success('Cache cleaned')
+  end
+
+  desc 'Flush cache'
+  task :flush do
+    Hem.ui.title 'Cleaning cache'
+    run_command 'bin/magento cache:flush', realtime: true, indent: 2
+    Hem.ui.success('Cache flushed')
+  end
+end

data/lib/hem/tasks/magento2/configure.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+desc 'Setup cache, session, varnish settings and magento mode variables'
+task :configure do
+  Hem.ui.title('Updating Magento2 configuration')
+  configuration_file = File.join(Hem.project_config.vm.project_mount_path, 'configure-magento-config.php')
+  run_command "php #{configuration_file}", realtime: true, indent: 2
+
+  [File.join(Hem.project_path, 'var', 'cache'), File.join(Hem.project_path, 'var', 'page_cache')].each do |dir|
+    FileUtils.rm_rf("#{dir}/.", secure: true)
+  end
+
+  Hem.ui.success('Magento2 configuration update finished')
+end

data/lib/hem/tasks/magento2/development.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+desc 'Development related functionality'
+namespace :development do
+  desc 'Quickly create the asset symlinks for development mode'
+  task :asset_symlinks do
+    Hem.ui.title 'Creating asset symlinks to pub/static/'
+    run_command 'sudo php tools/magento2/create_development_symlinks.php', realtime: true, indent: 2
+    Hem.ui.success('Asset symlinks finished')
+  end
+
+  desc 'Compile the less files'
+  task :compile_less do
+    Hem.ui.title 'Compiling Less files for the en_GB frontend'
+    run_command 'bin/magento setup:static-content:deploy --no-javascript '\
+                '--no-images --no-html --no-misc --no-fonts --no-css '\
+                '--language en_GB --area frontend '\
+                '--theme Magento/luma --theme Magento/blank',
+                realtime: true,
+                indent: 2
+    Hem.ui.success('Compile finished')
+
+    Hem.ui.title 'Compiling Less files for the en_GB and en_US backend'
+    run_command 'bin/magento setup:static-content:deploy --no-javascript '\
+                '--no-images --no-html --no-misc --no-fonts --no-css '\
+                '--language en_GB --language en_US --area adminhtml',
+                realtime: true,
+                indent: 2
+    Hem.ui.success('Compile finished')
+  end
+
+  desc 'Compile the Dependency Injection container'
+  task :compile_di do
+    Hem.ui.title 'Compiling the Dependency Injection container'
+    run_command 'bin/magento setup:di:compile', realtime: true, indent: 2
+    Hem.ui.success('Compile finished')
+  end
+end

data/lib/hem/tasks/magento2/index.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+desc 'Index related functionality'
+namespace :index do
+  desc 'Reindex indexers'
+  task :refresh do
+    Hem.ui.title 'Reindex indexers'
+    run_command 'bin/magento indexer:reindex', realtime: true, indent: 2
+    Hem.ui.success('Reindexing complete')
+  end
+end

data/lib/hem/tasks/magento2/install.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+desc 'Magento2 installation related tasks'
+namespace :install do
+  desc 'Create the vendor and bin directories'
+  task :create_vendor_dir do
+    Hem.ui.title 'Creating vendor directory'
+    FileUtils.mkdir_p(File.join(Hem.project_path, 'bin'))
+    FileUtils.mkdir_p(File.join(Hem.project_path, 'vendor'))
+    Hem.ui.success('Vendor directory created')
+  end
+
+  desc "Move the composer file to the project's root folder"
+  task :move_composer_json_file do
+    unless File.exist? File.join(Hem.project_path, 'composer.json')
+      Hem.ui.title 'Setup composer file'
+      target_file = File.join(Hem.project_path, 'composer.json')
+      FileUtils.cp Hem.project_config.composer_file, target_file
+      Hem.ui.success('Composer file copied to the correct place')
+    end
+  end
+
+  desc 'Installs Magento based on the install shell script'
+  task :install_magento do
+    magento_config = File.join(Hem.project_path, 'app', 'etc', 'env.php')
+    magento_installer = File.join(Hem.project_config.vm.project_mount_path, 'install-magento2.sh')
+
+    unless File.exist? magento_config
+      Rake::Task['magento2:install:set_permissions'].invoke
+
+      Hem.ui.title 'Installing Magento2'
+      run_command "sh #{magento_installer}", realtime: true, indent: 2
+      Hem.ui.success('Magento2 install finished')
+
+      Rake::Task['magento2:configure'].invoke
+      Rake::Task['magento2:sample_data:add'].invoke(from_install: true)
+      Rake::Task['magento2:setup_script:run'].invoke
+      Rake::Task['magento2:index:refresh'].invoke
+      Rake::Task['magento2:cache:clean'].invoke
+      Rake::Task['magento2:development:asset_symlinks'].invoke
+      Rake::Task['magento2:development:compile_less'].invoke
+    end
+
+    Rake::Task['magento2:install:set_permissions'].execute
+    Rake::Task['magento2:install:optimise_autoloader'].invoke
+  end
+
+  desc 'Optimise the composer autoloader for a speed boost'
+  task :optimise_autoloader do
+    Hem.ui.title 'Optimising composer autoloader'
+    run_command 'bin/composer.phar dump-autoload --optimize', realtime: true, indent: 2
+    Hem.ui.success('Composer optimisation finished')
+  end
+
+  desc 'Sets up magento permissions'
+  task :set_permissions do
+    Hem.ui.title 'Setup permissions'
+
+    magento_binfile = File.join(Hem.project_config.vm.project_mount_path, 'bin', 'magento')
+    magento_var_directory = File.join(Hem.project_config.vm.project_mount_path, 'var')
+    magento_media_directory = File.join(Hem.project_config.vm.project_mount_path, 'pub', 'media')
+    magento_static_directory = File.join(Hem.project_config.vm.project_mount_path, 'pub', 'static')
+
+    Hem.ui.title "Setup permissions - #{magento_binfile}"
+    run_command "sudo chmod +x #{magento_binfile}", realtime: true, indent: 2
+
+    [magento_var_directory].each do |dir|
+      Hem.ui.title "Setup permissions - #{dir}"
+      run_command "sudo setfacl -R -m 'u:apache:rwX' -m 'u:vagrant:rwX' '#{dir}'", realtime: true, indent: 2
+      run_command "sudo setfacl -dR -m 'u:apache:rwX' -m 'u:vagrant:rwX' '#{dir}'", realtime: true, indent: 2
+    end
+
+    [magento_media_directory, magento_static_directory].each do |dir|
+      Hem.ui.title "Setup permissions - #{dir}"
+      run_command "if [ -e '#{dir}' ]; then sudo find '#{dir}' -type d -exec chmod a+rwx {} + ; fi",
+                  realtime: true,
+                  indent: 2
+      run_command "if [ -e '#{dir}' ]; then sudo find '#{dir}' -type f -exec chmod a+rw {} + ; fi",
+                  realtime: true,
+                  indent: 2
+    end
+
+    Hem.ui.success('Permissions setup finished')
+  end
+end

data/lib/hem/tasks/magento2/sample_data.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+desc 'Sample data related functionality'
+namespace :sample_data do
+  def execute_if_defined(task_name)
+    Rake::Task[task_name].execute if Rake::Task.task_defined?(task_name)
+  end
+
+  desc 'Adds Sample data to Magento 2'
+  argument :from_install, optional: true, default: false
+  task :add do |_task_name, task_args|
+    sample_data_answer = 'no'
+    sample_data_answers = %w(yes no)
+    if Hem.project_config[:sample_data].nil? || !sample_data_answers.include?(Hem.project_config[:sample_data])
+      sample_data_answer = Hem.ui.ask_choice('Sample data', sample_data_answers, default: 'yes')
+      Hem.project_config[:sample_data] = sample_data_answer
+      Hem::Config::File.save(Hem.project_config_file, Hem.project_config)
+    end
+
+    # Return early if we aren't meant to install sample data
+    next unless sample_data_answer == 'yes'
+
+    Hem.ui.title 'Installing sample data'
+
+    args = ['php -d memory_limit=-1 bin/magento sampledata:deploy', 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)
+
+          execute_if_defined('vm:rsync_mount_sync')
+
+          complete = true
+        rescue Hem::ExternalCommandError
+          Hem.ui.warning 'Installing sample data locally failed!'
+        end
+      end
+    end
+
+    unless complete
+      run(*args)
+
+      execute_if_defined('deps:sync:composer_files_from_guest')
+      execute_if_defined('deps:sync:vendor_directory_from_guest')
+    end
+
+    magento_var_directory = File.join(Hem.project_config.vm.project_mount_path, 'var')
+    run_command "sudo rm -rf #{magento_var_directory}/*", realtime: true, indent: 2
+
+    Rake::Task['magento2:install:set_permissions'].invoke
+    Rake::Task['magento2:setup_script:run'].invoke
+
+    unless task_args[:from_install]
+      Rake::Task['magento2:development:asset_symlinks'].invoke
+      Rake::Task['magento2:development:compile_less'].invoke
+    end
+  end
+end

data/lib/hem/tasks/magento2/setup_script.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+desc 'Setup script related functionality'
+namespace :setup_script do
+  desc 'Run setup scripts'
+  task :run do
+    Hem.ui.title 'Running setup scripts'
+    run_command 'bin/magento setup:upgrade', realtime: true, indent: 2
+    Hem.ui.success('Setup scripts finished')
+  end
+end

data/lib/hem/tasks/magento2/version.rb

@@ -0,0 +1,7 @@
+module Hem
+  module Tasks
+    module Magento2
+      VERSION = '2.0.0'.freeze
+    end
+  end
+end

data/lib/hem/tasks/magento2.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+before 'vm:up', 'magento2:install:create_vendor_dir'
+before 'vm:up', 'magento2:install:move_composer_json_file'
+after 'vm:up', 'magento2:initialize-vm'
+
+namespace :magento2 do
+  require_relative 'magento2/install'
+  require_relative 'magento2/configure'
+  require_relative 'magento2/sample_data'
+  require_relative 'magento2/setup_script'
+  require_relative 'magento2/index'
+  require_relative 'magento2/cache'
+  require_relative 'magento2/development'
+
+  desc 'Initializes Magento2 specifics on the virtual machine after a fresh build'
+  task 'initialize-vm': [
+    'magento2:install:install_magento'
+  ]
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: hem-tasks-magento2
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Norbert Nagy
+- Kieren Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-13 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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+description: Magento 2 tasks for Hem
+email:
+- nnagy@inviqa.com
+- kevans+hem_tasks@inviqa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- hem-tasks-magento2.gemspec
+- lib/hem/tasks/magento2.rb
+- lib/hem/tasks/magento2/cache.rb
+- lib/hem/tasks/magento2/configure.rb
+- lib/hem/tasks/magento2/development.rb
+- lib/hem/tasks/magento2/index.rb
+- lib/hem/tasks/magento2/install.rb
+- lib/hem/tasks/magento2/sample_data.rb
+- lib/hem/tasks/magento2/setup_script.rb
+- lib/hem/tasks/magento2/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 2 tasks for Hem
+test_files: []