solidus_starter_frontend 0.1.0

data/bin/sandbox

@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+
+set -e
+
+case "$DB" in
+postgres|postgresql)
+  RAILSDB="postgresql"
+  ;;
+mysql)
+  RAILSDB="mysql"
+  ;;
+sqlite|'')
+  RAILSDB="sqlite3"
+  ;;
+*)
+  echo "Invalid DB specified: $DB"
+  exit 1
+  ;;
+esac
+
+if [ ! -z $SOLIDUS_BRANCH ]
+then
+  BRANCH=$SOLIDUS_BRANCH
+else
+  BRANCH="master"
+fi
+
+extension_name="solidus_starter_frontend"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox --database="$RAILSDB" \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  --skip-javascript
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
+gem 'solidus_auth_devise', '>= 2.1.0'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+unbundled bundle exec rails generate spree:install \
+  --auto-accept \
+  --user_class=Spree::User \
+  --enforce_available_locales=true \
+  --with-authentication=false \
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🚀 Using $RAILSDB and Solidus $BRANCH"
+echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"
+echo "🚀 This app is intended for test purposes."

data/bin/sandbox_rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update
+bin/rake clobber

data/bin/solidus_compare

@@ -0,0 +1,155 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'json'
+require 'pathname'
+require 'time'
+require 'yaml'
+require 'zlib'
+
+CONFIG_PATH = 'config/solidus_compare.yml'
+
+@config = {}
+@cmd_options = {}
+ARGV.each do |arg|
+  case arg
+  when '-h', '--help'
+    puts <<~HELP
+      Solidus Compare: a tool to detect changes between 2 repositories
+
+      Options:
+        -h or --help          : show this help
+        -s or --summary       : generate an XML summary of the files changed (used in CI)
+        -u or --update-ignore : update the config file setting the current hashes to ignore
+    HELP
+    exit 0
+  when '-s', '--summary'
+    @cmd_options[:summary] = true
+  when '-u', '--update-ignore'
+    @cmd_options[:update] = true
+  end
+end
+
+# ---------------------------------------------------------------------------- #
+
+def generate_comparison(report)
+  report.each do |data|
+    conf = @config['ignore'].find { |cfg| cfg['path'] == data['path'] }
+    diffs = conf ? (conf['diffs'] || []) : []
+    data['diffs'].each do |result|
+      info = diffs.find { |diff| diff['file'] == result['file'] } || {}
+      if info['skip']
+        result['skip'] = true
+        result.delete 'hash'
+        next
+      elsif info['hash'] == result['hash']
+        next
+      end
+
+      puts result['diff']
+    end
+  end
+  update_ignore(report) if @cmd_options[:update]
+end
+
+def generate_summary(report) # rubocop:disable Metrics/MethodLength
+  summary = {}
+  report.each do |data|
+    path = data['path']
+    conf = @config['ignore'].find { |cfg| cfg['path'] == path }
+    diffs = conf ? (conf['diffs'] || []) : []
+    data['diffs'].each do |result|
+      info = diffs.find { |diff| diff['file'] == result['file'] } || {}
+      next if info['skip'] || info['hash'] == result['hash']
+
+      (summary[path] ||= {})[result['hash']] = result['file']
+    end
+  end
+
+  count = 0
+  testcases = summary.map do |file_path, value|
+    value.map do |hash, file|
+      count += 1
+      full_path = Pathname.new(file_path).join(file).to_s
+      "<testcase name=\"#{file}\" file=\"#{full_path}\" time=\"0\"><failure>hash: #{hash}\nfile: #{file}</failure></testcase>"
+    end
+  end.join("\n")
+
+  output = <<~SUMMARY
+    <?xml version="1.0" encoding="UTF-8"?>
+    <testsuite name="solidus_compare" tests="#{count}" skipped="0" failures="#{count}" errors="#{count}" time="1" timestamp="#{Time.now.iso8601}">
+    #{testcases}
+    </testsuite>
+  SUMMARY
+  puts output
+
+  exit 1 if count.positive?
+end
+
+def load_config
+  @config = YAML.load_file(CONFIG_PATH) if File.exist?(CONFIG_PATH)
+  @config ||= {}
+  @config['ignore'] ||= []
+  @config['project_paths'] ||= []
+  @config['source_repo'] ||= 'https://github.com/solidusio/solidus.git'
+  @config['source_name'] ||= 'solidus'
+  @config['source_branch'] ||= 'master'
+  @config['source_base_path'] ||= 'frontend/'
+end
+
+def solidus_compare
+  report = @config['project_paths'].map do |path|
+    remote_source = "remotes/#{@config['source_name']}/#{@config['source_branch']}"
+    remote_path = "#{@config['source_base_path']}#{path}"
+    result = `git diff "#{remote_source}" -- "#{remote_path}" "#{path}"`
+    puts("error with git diff #{path}") & exit if $?.exitstatus != 0
+
+    result.gsub!(/index\s[\w\d]+\.\.[\w\d]+\s[\w\d]+\n/, '')
+    diffs = result.split(/diff --git /)[1..-1]
+    next unless diffs
+
+    {
+      'path' => path,
+      'diffs' => diffs.map do |diff|
+        next if diff.include? 'similarity index 100%'
+
+        {
+          'hash' => Zlib.crc32(diff),
+          'file' => diff.match(%r{a/([^\s]+)})&.send(:[], 1),
+          'diff' => 'diff --git ' + diff
+        }
+      end.compact
+    }
+
+    # end
+  end.compact
+
+  @cmd_options[:summary] ? generate_summary(report) : generate_comparison(report)
+end
+
+def update_ignore(report)
+  report.each do |data|
+    data['diffs'].each do |result|
+      result.delete('diff')
+    end
+  end.compact
+  @config['ignore'] = report
+  File.open(CONFIG_PATH, 'w') { |f| f.puts(@config.to_yaml) }
+end
+
+def update_source
+  if `git remote`.split("\n").none? @config['source_name']
+    `git remote add -f #{@config['source_name']} #{@config['source_repo']}`
+    puts('error with git remote add') & exit if $?.exitstatus != 0
+  end
+
+  `git remote update > /dev/null 2>&1`
+  puts('error with git remote update') & exit if $?.exitstatus != 0
+end
+
+# ---------------------------------------------------------------------------- #
+
+load_config
+update_source
+solidus_compare

data/config/initializers/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.precompile << 'solidus_starter_frontend_manifest.js'

data/config/initializers/canonical_rails.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+CanonicalRails.setup do |config|
+  # http://en.wikipedia.org/wiki/URL_normalization
+  # Trailing slash represents semantics of a directory, ie a collection view - implying an :index get route;
+  # otherwise we have to assume semantics of an instance of a resource type, a member view - implying a :show get route
+  #
+  # Acts as a whitelist for routes to have trailing slashes
+
+  config.collection_actions # = [:index]
+
+  # Parameter spamming can cause index dilution by creating seemingly different URLs with identical or near-identical content.
+  # Unless whitelisted, these parameters will be omitted
+
+  config.whitelisted_parameters = [:keywords, :page, :search, :taxon]
+end

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: Hello world

data/config/routes.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
+  root to: 'home#index'
+
+  resources :products, only: [:index, :show]
+
+  get '/locale/set', to: 'locale#set'
+  post '/locale/set', to: 'locale#set', as: :select_locale
+
+  # non-restful checkout stuff
+  patch '/checkout/update/:state', to: 'checkout#update', as: :update_checkout
+  get '/checkout/:state', to: 'checkout#edit', as: :checkout_state
+  get '/checkout', to: 'checkout#edit', as: :checkout
+
+  get '/orders/populate', to: 'orders#populate_redirect'
+  get '/orders/:id/token/:token' => 'orders#show', as: :token_order
+
+  resources :orders, except: [:index, :new, :create, :destroy] do
+    post :populate, on: :collection
+    resources :coupon_codes, only: :create
+  end
+
+  get '/cart', to: 'orders#edit', as: :cart
+  patch '/cart', to: 'orders#update', as: :update_cart
+  put '/cart/empty', to: 'orders#empty', as: :empty_cart
+
+  # route globbing for pretty nested taxon and product paths
+  get '/t/*id', to: 'taxons#show', as: :nested_taxons
+
+  get '/unauthorized', to: 'home#unauthorized', as: :unauthorized
+  get '/cart_link', to: 'store#cart_link', as: :cart_link
+end

data/config/solidus_compare.yml

@@ -0,0 +1,33 @@
+---
+project_paths:
+- app/controllers
+- app/helpers
+source_repo: https://github.com/solidusio/solidus.git
+source_name: solidus
+source_branch: master
+source_base_path: frontend/
+ignore:
+- path: app/controllers
+  diffs:
+  - file: app/controllers/concerns/solidus_starter_frontend/auth_views.rb
+    skip: true
+  - file: app/controllers/concerns/solidus_starter_frontend/taxonomies.rb
+    skip: true
+  - hash: 2722004413
+    file: frontend/app/controllers/spree/checkout_controller.rb
+  - hash: 1422395649
+    file: frontend/app/controllers/spree/coupon_codes_controller.rb
+  - hash: 2175977023
+    file: frontend/app/controllers/spree/home_controller.rb
+  - hash: 2194836599
+    file: frontend/app/controllers/spree/orders_controller.rb
+  - hash: 61096156
+    file: frontend/app/controllers/spree/products_controller.rb
+  - hash: 2154899617
+    file: frontend/app/controllers/spree/store_controller.rb
+  - hash: 910927973
+    file: frontend/app/controllers/spree/taxons_controller.rb
+  - hash: 3582561552
+    file: frontend/app/controllers/spree/content_controller.rb
+- path: app/helpers
+  diffs: []

data/docs/development.md

@@ -0,0 +1,28 @@
+# Solidus Starter Frontend development information
+This document aims to give some extra information for developers that are going 
+to contribute to our `solidus_starter_frontend` component.
+
+## Solidus Compare tool
+`solidus_compare` is a tool that we created to keep track of the changes made to
+[solidus_frontend](https://github.com/solidusio/solidus/tree/master/frontend), 
+which we used as source project in the beginning.
+
+It is connected to our CI; when a new PR is opened, if a change is detected on 
+Solidus Frontend, the workflow will fail and it will report the files changed.
+
+In that case, it is needed to evaluate those changes and eventually apply them 
+to our component. After this step, it is possible to mark those changes as 
+"managed".
+
+In practical terms:
+- run locally `bin/solidus_compare` in any branch;
+- evaluate the diff of the changes shown in the console;
+- apply the required changes (if they are useful to the project);
+- run `bin/solidus_compare -u` which will update the hashes in the config file;
+- commit the changes and check the CI.
+
+The tool internally works in this way:
+- configuration file is loaded (`config/solidus_compare.yml`);
+- remote GIT source is updated using the parameters provided by the config file;
+- compare process is executed and a hash for each file is calculated;
+- if they match the hashes saved in the configuration there are no differences.

data/exe/solidus_starter_frontend

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'active_support'
+require 'rails/generators'
+require 'solidus_starter_frontend'
+
+Rails::Generators.invoke('solidus_starter_frontend')

data/lib/generators/solidus_starter_frontend/install/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SolidusStarterFrontend
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_starter_frontend\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_starter_frontend\n", before: %r{\*/}, verbose: true
+      end
+    end
+  end
+end

data/lib/generators/solidus_starter_frontend/solidus_starter_frontend_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class SolidusStarterFrontendGenerator < Rails::Generators::Base
+  source_root File.expand_path('../../..', __dir__)
+
+  def install
+    # Copy directories
+    directory 'app', 'app'
+    directory 'lib/views', 'lib/views'
+
+    # Copy files
+    copy_file 'lib/solidus_starter_frontend/config.rb', 'lib/solidus_starter_frontend/config.rb'
+    copy_file 'lib/solidus_starter_frontend_configuration.rb', 'lib/solidus_starter_frontend_configuration.rb'
+
+    # Routes
+    copy_file 'config/routes.rb', 'tmp/routes.rb'
+    prepend_file 'config/routes.rb', File.read('tmp/routes.rb')
+
+    # Gems
+    gem 'canonical-rails'
+    gem 'truncate_html'
+
+    # Text updates
+    append_file 'config/initializers/assets.rb', "Rails.application.config.assets.precompile += ['solidus_starter_frontend_manifest.js']"
+    append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_starter_frontend\n"
+    inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_starter_frontend\n", before: %r{\*/}, verbose: true
+    inject_into_file 'config/initializers/spree.rb', "require_relative Rails.root.join('lib/solidus_starter_frontend/config')\n", before: /Spree.config do/, verbose: true
+    gsub_file 'app/assets/stylesheets/application.css', '*= require_tree', '* OFF require_tree'
+  end
+end