workarea-upgrade 3.0.2

data/CHANGELOG.md

@@ -0,0 +1,285 @@
+Workarea Upgrade 3.0.2 (2019-12-17)
+--------------------------------------------------------------------------------
+
+*   Pass supplied options to Diff
+
+    Diffy formatting wasn't working due to a blunder in the way we were
+    supplying options to Diffy::Diff
+
+    UPGRADE-3
+    Curt Howard
+
+*   Fix invocation bug when running `workarea_upgrade prepare -l`
+
+    The `--latest` option breaks the `prepare` -> `report` invocation chain
+    in the CLI. This fix passes empty hashes around to all invocations used
+    in the CLI.
+
+    UPGRADE-5
+    Curt Howard
+
+*   Avoid Method Errors When Upgrading New Gems
+
+    When a new gem has been included in an upgrading gem's dependencies, an
+    error can be thrown when viewing the diff or report if the gem is not
+    already included in the app's Gemfile prior to running the upgrade
+    tools. Ensure that `Workarea::Upgrade::Diff#find_from_path!` returns
+    `nil` when this occurs, and the diff generator skips over gems that it
+    cannot produce a `Workarea::Upgrade::GemDiff` for.
+
+    UPGRADE-7
+    Tom Scott
+
+*   Add theme upgrade notes to README
+
+    Curt Howard
+
+
+
+Workarea Upgrade 3.0.1 (2019-10-16)
+--------------------------------------------------------------------------------
+
+*   Fix Error on Startup
+
+    Make sure ActiveSupport is required so that methods like `#present?`
+    will be defined on all objects.
+
+    UPGRADE-39
+    Tom Scott
+
+*   Remove workflow
+
+    Matt Duffy
+
+*   Migrate to Github
+
+    Matt Duffy
+
+
+
+Workarea Upgrade 3.0.0 (2019-09-17)
+--------------------------------------------------------------------------------
+
+*   Overhaul Upgrade Plugin
+
+    * Add version checking functionality
+    * Remove Migrations. Now they live in base.
+    * Remove references to `weblinc`. Only support v3+.
+    * Add Gemfile.next support
+    * Clean up API and plugin flow
+    * Consolodate Diff-based tasks
+    * Remove useless output from Breakdown report
+
+    UPGRADE-36
+    Curt Howard
+
+
+
+Workarea Upgrade 2.0.9 (2019-04-30)
+--------------------------------------------------------------------------------
+
+*   Update README
+
+    * General improvements
+    * Add a note about upgrading themes
+
+    UPGRADE-35
+    Curt Howard
+
+
+
+Workarea Upgrade 2.0.8 (2019-04-30)
+--------------------------------------------------------------------------------
+
+*   Update README
+
+    * General improvements
+    * Add a note about upgrading themes
+
+    UPGRADE-35
+    Curt Howard
+
+
+
+Workarea Upgrade 2.0.8 (2019-01-08)
+--------------------------------------------------------------------------------
+
+*   Update README
+
+    UPGRADE-34
+    Curt Howard
+
+
+
+Workarea Upgrade 2.0.7 (2018-04-17)
+--------------------------------------------------------------------------------
+
+*   Leverage Workarea Changelog task
+
+    ECOMMERCE-5355
+    Curt Howard
+
+*   Migrate dragonfly assets to v3.x cleanly
+
+    When v2.x clients use the v3 migration script, none of their content
+    assets can be found because the job ID has changed as we upgraded the
+    Dragonfly library. When upgrading Dragonfly assets, try to find an asset
+    match by the filename of the image rather than the entire asset URL.
+    This isn't 100% perfect because we don't validate uniqueness on content
+    asset filenames, but it should get us most of the way there.
+
+    UPGRADE-30
+    Tom Scott
+
+
+
+Workarea Upgrade 2.0.6 (2018-02-06)
+--------------------------------------------------------------------------------
+
+*   Rename term_facets to terms_facets
+
+    Fixes issue where v2.x filters are being migrated into the wrong place.
+
+    UPGRADE-25
+    Tom Scott
+
+
+Workarea Upgrade 2.0.5 (2018-01-23)
+--------------------------------------------------------------------------------
+
+*   Add logic to update content presets during v3 migration
+
+    UPGRADE-26
+    Matt Duffy
+
+
+Workarea Upgrade 2.0.4 (2017-09-06)
+--------------------------------------------------------------------------------
+
+*   Loosen version pattern to allow upgrading to beta releases
+
+    UPGRADE-24
+    Curt Howard
+
+
+Workarea Upgrade 2.0.3 (2017-08-08)
+--------------------------------------------------------------------------------
+
+*   Add additional changes to taxon fields
+
+    UPGRADE-23
+    Matt Duffy
+
+*   Fix facet field names for categories in v3 migration
+
+    UPGRADE-23
+    Matt Duffy
+
+*   Properly migrate order item product hashes from v2 to v3
+
+    UPGRADE-23
+    Matt Duffy
+
+
+Workarea Upgrade 2.0.2 (2017-07-25)
+--------------------------------------------------------------------------------
+
+*   Archive unneeded shipping items during v3 db migration
+
+    UPGRADE-22
+    Matt Duffy
+
+
+Workarea Upgrade 2.0.1 (2017-06-20)
+--------------------------------------------------------------------------------
+
+*   Fix issues with v3 migration script
+
+    - Handle Products without variants
+    - Handle Pricing::Sku without prices
+    - Handle indexing orders after changing IDs
+    - Remove purchase dates from variants
+    - Remove meta_keywords from products and content
+    - Check order number presence to prevent looping through new documents
+
+    UPGRADE-20
+    Matt Duffy
+
+*   Modify diffing logic to allow diff between v3 versions
+
+    UPGRADE-19
+    Matt Duffy
+
+*   Remove incorrect reference to Weblinc constant
+
+    UPGRADE-18
+    Matt Duffy
+
+
+Workarea Upgrade 2.0.0 (2017-05-05)
+--------------------------------------------------------------------------------
+
+*   Allow workarea gems to be diffed with weblinc gems
+
+    UPGRADE-16
+    Matt Duffy
+
+*   Create v3 database migration script
+
+    UPGRADE-15
+    Matt Duffy
+
+
+WebLinc Upgrade 1.1.0 (2016-10-12)
+--------------------------------------------------------------------------------
+
+*   Add support for .decorator files
+
+    UPGRADE-13
+    Ben Crouse
+
+
+WebLinc Upgrade 1.0.2 (2016-08-30)
+--------------------------------------------------------------------------------
+
+*   Require active_support delegation method for compatibility with weblinc v2.2.x
+
+    UPGRADE-9
+    Matt Duffy
+
+*   Fixing various issues found in data migration scripts
+
+    Running data migration on real life data revealed several issues with the
+    migration scripts that I addressed as they came up.
+
+    * Create a method to migrate fulfillment data
+    * Removal of 'packaged_product_ids' and 'categorizations' from
+    'product_attributes' in 'order.items'
+    * Guard against users having no passwords because of sign in through facebook
+    or other third party
+    * 'cancelled_at' to 'canceled_at' on orders
+    * Guard against possibility of duplicate slugs from deleted Smart Categories
+    * Guard against non-existent categories in product.categorizations
+    * Added 'db:mongoid:remove_indexes' invocation
+    * Cleaning of possible malformed URLs in Email::Share
+
+    UPGRADE-8
+    Jesse McPherson
+
+*   UPGRADE-7: update documentation to ensure target versions are installed
+    prior to to running the diff or report
+    fgalarza
+
+
+WebLinc Upgrade 1.0.1 (2016-04-05)
+--------------------------------------------------------------------------------
+
+
+Weblinc Upgrade 1.0.0 (February 18, 2016)
+--------------------------------------------------------------------------------
+
+*   Add CLI tools for diffing weblinc versions
+
+*   Add a report to help a developer understand and begin an upgrade
+
+*   Add migration for migrating from v0.12 to v2.0

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+
+# Declare your gem's dependencies in upgrade.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+
+gem 'workarea', '>= 3.2.0'

data/README.md

@@ -0,0 +1,210 @@
+# Workarea Upgrade 
+
+A plugin for upgrading to newer versions of Workarea and its plugins.
+
+## Overview
+
+* Used for upgrading to new patches, minors, or majors
+* View a report of the complexity of the upgrade
+* Diff code change between any two version of Workarea in the v3 series 
+* See results relevant to the overridden or decorated files in your application
+
+## Features
+
+* __Command Line Interface__
+  
+  The features of this plugin are accessibile by invoking the `workarea_upgrade`
+  command. After installing this plugin run `bundle exec workarea_upgrade help`
+  for an overview of which commands are available to you.
+
+* __Upgrade Preparation__
+  
+  The Upgrade plugin uses the differences found between your `Gemfile` and a 
+  `Gemfile.next` file present in your application's root directory to generate
+  its reporting and diffing functionality. You can create and manage this 
+  `Gemfile.next` yourself or use the `prepare` task to automate its creation.
+
+* __Reporting__
+
+  To get an idea of how complex your upgrade will be the Upgrade gem provides
+  a `report` task which shows basic statistics about the amount of change the 
+  Workarea platform has undergone between versions listed in your `Gemfile` and
+  `Gemfile.next`. These statistics should give you a general idea of how much 
+  work may be required to perform the upgrade.
+
+* __Diffing__
+ 
+ The Upgrade plugin will display a full diff of changes made to Workarea as they
+ pertain to your application. If you've overridden or decorated any core 
+ Workarea file or a file from a Workarea plugin the Upgrade gem will show you
+ the change to that file between the versions specified in your `Gemfile` and 
+ `Gemfile.next`. Use this information to upgrade your application accordingly.
+
+## Getting Started
+
+### Installation
+
+Add the plugin to your application's `Gemfile`:
+
+    group :development do
+      gem 'workarea-upgrade', '>= 3.0.0', source: 'https://gems.workarea.com'
+    end
+
+Update your bundle. Use `bundle update` to get the latest version:
+
+    cd path/to/your_app
+    bundle update workarea-upgrade
+
+### View Help
+
+Run `workarea_upgrade help` for an overview of the commands and what they do:
+
+    bundle exec workarea_upgrade help
+
+Run `workarea_upgrade help TASK` to get more information about a given task:
+
+    bundle exec workarea_upgrade help report
+
+### Create a Gemfile.next
+
+The Upgrade plugin uses a `Gemfile.next` file in your application's root
+directory to determine the versions you wish to upgrade to.
+
+This file may be created manually, by copying and modifying your `Gemfile` as a
+`Gemfile.next` file, or automatically, by running:
+
+    bundle exec workarea_upgrade
+
+This will drop you into a wizard that will determine the newest versions of each
+of your Workarea gems and iterate over them, allowing you to add, remove, or 
+modify the version of each gem found. These choices are used to generate the 
+`Gemfile.next` file for you automatically. 
+
+Once the process is complete the `Gemfile.next` will be tested for installation.
+If it fails installation you will be given instructions on how to fix it
+manually until it is in an installable state.
+
+### View Report
+
+Once the `Gemfile.next` file is installable, you may get an idea of the
+complexity of your upgrade by viewing the report:
+
+    bundle exec workarea_upgrade report
+
+### View Diffs
+
+Finally, view the actual changes that have occurred to any Workarea gems you 
+have installed with:
+
+    bundle exec workarea_upgrade diff
+
+The output of this command will be limited to the files that have been 
+overridden or decorated in your application only, as its these files that will
+not automatically receive the updates from the core platform. Use this output
+to make informed decisions about how your application will need to change to 
+stay up to date.
+
+You may also view a list of all files added or removed between each version 
+by running either:
+
+    bundle exec workarea_upgrade diff --added # or
+    bundle exec workarea_upgrade diff --removed
+
+View `bundle exec workarea_upgrade help diff` for more ways you can format these
+results.
+
+### Copy Gemfile.next to Gemfile
+
+Once all of the updates have been applied to your application, move the
+`Gemfile.next` files over to replace your `Gemfile` files:
+
+    mv Gemfile.next Gemfile
+    mv Gemfile.next.lock Gemfile.lock
+
+### Test
+
+Lastly you should run your test suite to ensure all of the tests pass:
+
+    bin/rails workarea:test
+
+Once the tests pass, deploy your upgrade to your QA environment for real user
+testing.
+
+### Upgrading Themes
+
+Themes, by nature, are structured differently than host applications. The main
+difference is that themes list their dependencies in a `gemspec` instead of a 
+`Gemfile`. Secondly, they are more permissive in their dependencies, since they
+are intended to "just work" for all patches within a dependency's minor version
+or, in some cases, all minors and patches within a dependency's major version.
+
+```rb
+# snipped from the NVY Theme's gemspec
+
+s.add_dependency 'workarea', '~> 3.4.x'                                       
+s.add_dependency 'workarea-theme', '~> 1.1.1'                                 
+                                                                              
+s.add_dependency 'workarea-blog', '~> 3.x', '>= 3.3.0'                        
+s.add_dependency 'workarea-gift_cards', '~> 3.x', '>= 3.4.0'                  
+s.add_dependency 'workarea-product_quickview', '~> 2.0.2'                     
+s.add_dependency 'workarea-reviews', '~> 3.x'                                 
+s.add_dependency 'workarea-share', '~> 1.x', '>= 1.2.0'                       
+s.add_dependency 'workarea-swatches', '~> 1.x'                                
+s.add_dependency 'workarea-styled_selects', '~> 1.x'                          
+s.add_dependency 'workarea-slick_slider', '~> 1.x'                            
+s.add_dependency 'workarea-wish_lists', '>= 2.1.0' 
+```
+
+```rb
+# snipped from the NVY theme's Gemfile
+
+gem 'workarea', github: 'workarea-commerce/workarea'
+```
+
+In order to use the `workarea_upgrade` command effectively within the context
+of a theme you will need to _temporarily create entries in the theme's Gemfile_
+effectively fixing the theme's dependencies to a known version before proceeding
+with the upgrade.
+
+Doing this is fairly straightforward. It's best to glean the fixed dependency
+versions from the gemspec directly. Using the example above we can safely assume
+the adjusted Gemfile should look something like this:
+
+```rb
+gem 'workarea', '3.4.0'
+gem 'workarea-blog', '3.3.0'
+gem 'workarea-gift_cards', '3.4.0'
+gem 'workarea-product_quickview', '2.0.2'
+gem 'workarea-reviews', '3.0.0'
+gem 'workarea-share', '1.2.0'
+gem 'workarea-swatches', '1.0.0'
+gem 'workarea-styled_selects', '1.0.0'
+gem 'workarea-slick_slider', '1.0.0'
+gem 'workarea-wish_lists', '2.1.0'
+
+# Don't forget to include workarea-upgrade either
+gem 'workarea-upgrade', source: 'https://gems.workarea.com'
+```
+
+Running `bundle exec workarea_upgrade` at this point should work as expected.
+
+Once you've finished going through the generated diff and applying all of the
+changes, don't forget to
+
+1. revert the changes you made to your Gemfile
+1. update your gemspec to point to the new versions you've upgraded to
+1. delete your Gemfile.next and Gemfile.next.lock files
+1. run a bundle install to check that the dependencies are correct
+1. run your tests
+
+## More Information
+
+Please visit 
+<https://developer.workarea.com/articles/upgrading-your-application.html> for a
+more comprehensive overview of how to use this plugin.
+
+# Copyright & Licensing
+
+Copyright Weblinc 2017. All rights reserved.
+
+For licensing, contact sales@workarea.com.