diff --git a/.rubocop.yml b/.rubocop.yml index 80d4c1bf7e..b49623c344 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -16,6 +16,8 @@ AllCops: - !ruby/regexp /old_and_unused\.rb$/ # The parser gem fails to parse this file with out current Ruby version. - 'spec/factories.rb' + # Excluding: inadequate Naming/FileName rule rejects GemFile name with camelcase + - 'engines/web/Gemfile' # OFN SETTINGS # Cop settings that have been agreed upon by the OFN community diff --git a/Gemfile b/Gemfile index 2b33c60993..2efad595c0 100644 --- a/Gemfile +++ b/Gemfile @@ -10,6 +10,8 @@ gem 'i18n-js', '~> 3.0.0' # Patched version. See http://rubysec.com/advisories/CVE-2015-5312/. gem 'nokogiri', '>= 1.6.7.1' +gem 'web', path: './engines/web' + gem 'pg' gem 'spree', github: 'openfoodfoundation/spree', branch: 'step-6a', ref: '69db1c090f3711088d84b524f1b94d25e6d21616' gem 'spree_i18n', github: 'spree/spree_i18n', branch: '1-3-stable' diff --git a/Gemfile.lock b/Gemfile.lock index 25844f45e9..2f2701fd55 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -133,6 +133,11 @@ GIT activemodel (>= 3.0) railties (>= 3.0) +PATH + remote: engines/web + specs: + web (0.0.1) + GEM remote: https://rubygems.org/ specs: @@ -767,6 +772,7 @@ DEPENDENCIES capybara (>= 2.15.4) coffee-rails (~> 3.2.1) compass-rails + web! custom_error_message! daemons dalli diff --git a/app/controllers/api/cookies_consent_controller.rb b/app/controllers/api/cookies_consent_controller.rb deleted file mode 100644 index 89016c2066..0000000000 --- a/app/controllers/api/cookies_consent_controller.rb +++ /dev/null @@ -1,26 +0,0 @@ -module Api - class CookiesConsentController < BaseController - include ActionController::Cookies - respond_to :json - - def show - render json: { cookies_consent: cookies_consent.exists? } - end - - def create - cookies_consent.set - show - end - - def destroy - cookies_consent.destroy - show - end - - private - - def cookies_consent - @cookies_consent ||= CookiesConsent.new(cookies, request.host) - end - end -end diff --git a/app/services/cookies_consent.rb b/app/services/cookies_consent.rb deleted file mode 100644 index 64c4dfa083..0000000000 --- a/app/services/cookies_consent.rb +++ /dev/null @@ -1,29 +0,0 @@ -class CookiesConsent - COOKIE_NAME = 'cookies_consent'.freeze - - def initialize(cookies, domain) - @cookies = cookies - @domain = domain - end - - def exists? - cookies.key?(COOKIE_NAME) - end - - def destroy - cookies.delete(COOKIE_NAME, domain: domain) - end - - def set - cookies[COOKIE_NAME] = { - value: COOKIE_NAME, - expires: 1.year.from_now, - domain: domain, - httponly: true - } - end - - private - - attr_reader :cookies, :domain -end diff --git a/app/views/layouts/darkswarm.html.haml b/app/views/layouts/darkswarm.html.haml index e3cd92951f..83173c16e3 100644 --- a/app/views/layouts/darkswarm.html.haml +++ b/app/views/layouts/darkswarm.html.haml @@ -19,6 +19,8 @@ %script{src: "//maps.googleapis.com/maps/api/js?libraries=places,geometry#{ ENV['GOOGLE_MAPS_API_KEY'] ? '&key=' + ENV['GOOGLE_MAPS_API_KEY'] : ''} "} = stylesheet_link_tag "darkswarm/all" = javascript_include_tag "darkswarm/all" + = stylesheet_link_tag "web/all" + = javascript_include_tag "web/all" = render "layouts/i18n_script" = render "layouts/bugherd_script" diff --git a/app/views/shared/_footer.html.haml b/app/views/shared/_footer.html.haml index 9c7126c999..21a9525e0a 100644 --- a/app/views/shared/_footer.html.haml +++ b/app/views/shared/_footer.html.haml @@ -140,7 +140,7 @@ = t '.footer_legal_text_html', {content_license: link_to('CC BY-SA 3.0', 'https://creativecommons.org/licenses/by-sa/3.0/'), code_license: link_to('AGPL 3', 'https://tldrlegal.com/license/gnu-affero-general-public-license-v3-(agpl-3.0)' )} %p.text-small %div - - cookies_policy_link = link_to( t( '.footer_data_cookies_policy' ), '', 'cookies-policy-modal' => true, 'cookies-banner' => !CookiesConsent.new(cookies, request.host).exists? && Spree::Config.cookies_consent_banner_toggle) + - cookies_policy_link = link_to( t( '.footer_data_cookies_policy' ), '', 'cookies-policy-modal' => true, 'cookies-banner' => !Web::CookiesConsent.new(cookies, request.host).exists? && Spree::Config.cookies_consent_banner_toggle) - privacy_policy_link = link_to( t( '.footer_data_privacy_policy' ), Spree::Config.privacy_policy_url, :target => '_blank' ) - if Spree::Config.privacy_policy_url.present? = t '.footer_data_text_with_privacy_policy_html', {cookies_policy: cookies_policy_link.html_safe, privacy_policy: privacy_policy_link.html_safe } diff --git a/config/routes.rb b/config/routes.rb index 4f6125c8ac..21d2346933 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -109,10 +109,6 @@ Openfoodnetwork::Application.routes.draw do get :job_queue end - scope '/cookies' do - resource :consent, only: [:show, :create, :destroy], :controller => "cookies_consent" - end - resources :customers, only: [:index, :update] post '/product_images/:product_id', to: 'product_images#update_product_image' @@ -120,6 +116,9 @@ Openfoodnetwork::Application.routes.draw do get 'sitemap.xml', to: 'sitemap#index', defaults: { format: 'xml' } + # Mount Web engine routes + mount Web::Engine, :at => '/' + # Mount Spree's routes mount Spree::Core::Engine, :at => '/' end diff --git a/engines/web/README.md b/engines/web/README.md new file mode 100644 index 0000000000..87945856ef --- /dev/null +++ b/engines/web/README.md @@ -0,0 +1,5 @@ +# Web + +This is the rails engine for the Web domain. + +See our wiki for [more info about domains and engines in OFN](https://github.com/openfoodfoundation/openfoodnetwork/wiki/Tech-Doc:-How-OFN-is-organized-in-Domains-using-Rails-Engines). diff --git a/engines/web/app/assets/javascripts/web/all.js b/engines/web/app/assets/javascripts/web/all.js new file mode 100644 index 0000000000..15ebed9422 --- /dev/null +++ b/engines/web/app/assets/javascripts/web/all.js @@ -0,0 +1,13 @@ +// This is a manifest file that'll be compiled into application.js, which will include all the files +// listed below. +// +// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts, +// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path. +// +// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the +// the compiled file. +// +// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD +// GO AFTER THE REQUIRES BELOW. +// +//= require_tree . diff --git a/app/assets/javascripts/darkswarm/cookies_banner/cookies_banner_controller.js.coffee b/engines/web/app/assets/javascripts/web/cookies_banner/cookies_banner_controller.js.coffee similarity index 100% rename from app/assets/javascripts/darkswarm/cookies_banner/cookies_banner_controller.js.coffee rename to engines/web/app/assets/javascripts/web/cookies_banner/cookies_banner_controller.js.coffee diff --git a/app/assets/javascripts/darkswarm/cookies_banner/cookies_banner_directive.js.coffee b/engines/web/app/assets/javascripts/web/cookies_banner/cookies_banner_directive.js.coffee similarity index 100% rename from app/assets/javascripts/darkswarm/cookies_banner/cookies_banner_directive.js.coffee rename to engines/web/app/assets/javascripts/web/cookies_banner/cookies_banner_directive.js.coffee diff --git a/app/assets/javascripts/darkswarm/cookies_banner/cookies_banner_service.js.coffee b/engines/web/app/assets/javascripts/web/cookies_banner/cookies_banner_service.js.coffee similarity index 86% rename from app/assets/javascripts/darkswarm/cookies_banner/cookies_banner_service.js.coffee rename to engines/web/app/assets/javascripts/web/cookies_banner/cookies_banner_service.js.coffee index 139552a214..c9d2911f73 100644 --- a/app/assets/javascripts/darkswarm/cookies_banner/cookies_banner_service.js.coffee +++ b/engines/web/app/assets/javascripts/web/cookies_banner/cookies_banner_service.js.coffee @@ -4,7 +4,7 @@ Darkswarm.factory "CookiesBannerService", (Navigation, $modal, $location, Redire modalMessage: null isEnabled: false - open: (path, template = 'darkswarm/cookies_banner/cookies_banner.html') => + open: (path, template = 'angular-templates/cookies_banner.html') => return unless @isEnabled @modalInstance = $modal.open templateUrl: template diff --git a/app/assets/javascripts/darkswarm/cookies_policy/cookies_policy_modal_controller.js.coffee b/engines/web/app/assets/javascripts/web/cookies_policy/cookies_policy_modal_controller.js.coffee similarity index 100% rename from app/assets/javascripts/darkswarm/cookies_policy/cookies_policy_modal_controller.js.coffee rename to engines/web/app/assets/javascripts/web/cookies_policy/cookies_policy_modal_controller.js.coffee diff --git a/app/assets/javascripts/darkswarm/cookies_policy/cookies_policy_modal_directive.js.coffee b/engines/web/app/assets/javascripts/web/cookies_policy/cookies_policy_modal_directive.js.coffee similarity index 100% rename from app/assets/javascripts/darkswarm/cookies_policy/cookies_policy_modal_directive.js.coffee rename to engines/web/app/assets/javascripts/web/cookies_policy/cookies_policy_modal_directive.js.coffee diff --git a/app/assets/javascripts/darkswarm/cookies_policy/cookies_policy_modal_service.js.coffee b/engines/web/app/assets/javascripts/web/cookies_policy/cookies_policy_modal_service.js.coffee similarity index 100% rename from app/assets/javascripts/darkswarm/cookies_policy/cookies_policy_modal_service.js.coffee rename to engines/web/app/assets/javascripts/web/cookies_policy/cookies_policy_modal_service.js.coffee diff --git a/engines/web/app/assets/javascripts/web/web.js b/engines/web/app/assets/javascripts/web/web.js new file mode 100644 index 0000000000..dee720facd --- /dev/null +++ b/engines/web/app/assets/javascripts/web/web.js @@ -0,0 +1,2 @@ +// Place all the behaviors and hooks related to the matching controller here. +// All this logic will automatically be available in application.js. diff --git a/engines/web/app/assets/stylesheets/web/all.css b/engines/web/app/assets/stylesheets/web/all.css new file mode 100644 index 0000000000..3192ec897b --- /dev/null +++ b/engines/web/app/assets/stylesheets/web/all.css @@ -0,0 +1,13 @@ +/* + * This is a manifest file that'll be compiled into application.css, which will include all the files + * listed below. + * + * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets, + * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path. + * + * You're free to add application-wide styles to this file and they'll appear at the top of the + * compiled file, but it's generally better to create a new file per style scope. + * + *= require_self + *= require_tree . + */ diff --git a/app/assets/stylesheets/darkswarm/pages/cookies_banner.css.scss b/engines/web/app/assets/stylesheets/web/pages/cookies_banner.css.scss similarity index 87% rename from app/assets/stylesheets/darkswarm/pages/cookies_banner.css.scss rename to engines/web/app/assets/stylesheets/web/pages/cookies_banner.css.scss index 6223220977..afd0d73d43 100644 --- a/app/assets/stylesheets/darkswarm/pages/cookies_banner.css.scss +++ b/engines/web/app/assets/stylesheets/web/pages/cookies_banner.css.scss @@ -1,4 +1,4 @@ -@import '../branding'; +@import '../../../../../../../app/assets/stylesheets/darkswarm/branding'; .cookies-banner { background: $dark-grey; diff --git a/app/assets/stylesheets/darkswarm/pages/cookies_policy_modal.css.scss b/engines/web/app/assets/stylesheets/web/pages/cookies_policy_modal.css.scss similarity index 86% rename from app/assets/stylesheets/darkswarm/pages/cookies_policy_modal.css.scss rename to engines/web/app/assets/stylesheets/web/pages/cookies_policy_modal.css.scss index 8cf87b1ebb..2279bf6983 100644 --- a/app/assets/stylesheets/darkswarm/pages/cookies_policy_modal.css.scss +++ b/engines/web/app/assets/stylesheets/web/pages/cookies_policy_modal.css.scss @@ -1,4 +1,4 @@ -@import '../branding'; +@import '../../../../../../../app/assets/stylesheets/darkswarm/branding'; .cookies-policy-modal { background: $disabled-light; diff --git a/engines/web/app/controllers/web/api/cookies_consent_controller.rb b/engines/web/app/controllers/web/api/cookies_consent_controller.rb new file mode 100644 index 0000000000..e0ea13bafe --- /dev/null +++ b/engines/web/app/controllers/web/api/cookies_consent_controller.rb @@ -0,0 +1,30 @@ +require_dependency 'web/cookies_consent' + +module Web + module Api + class CookiesConsentController < BaseController + include ActionController::Cookies + respond_to :json + + def show + render json: { cookies_consent: cookies_consent.exists? } + end + + def create + cookies_consent.set + show + end + + def destroy + cookies_consent.destroy + show + end + + private + + def cookies_consent + @cookies_consent ||= Web::CookiesConsent.new(cookies, request.host) + end + end + end +end diff --git a/engines/web/app/controllers/web/application_controller.rb b/engines/web/app/controllers/web/application_controller.rb new file mode 100644 index 0000000000..410b0ae531 --- /dev/null +++ b/engines/web/app/controllers/web/application_controller.rb @@ -0,0 +1,5 @@ +module Web + class ApplicationController < ActionController::Base + protect_from_forgery with: :exception + end +end diff --git a/app/views/angular_templates/_cookies_policy_entry.html.haml b/engines/web/app/views/angular_templates/_cookies_policy_entry.html.haml similarity index 100% rename from app/views/angular_templates/_cookies_policy_entry.html.haml rename to engines/web/app/views/angular_templates/_cookies_policy_entry.html.haml diff --git a/app/assets/javascripts/darkswarm/cookies_banner/cookies_banner.html.haml b/engines/web/app/views/angular_templates/cookies_banner.html.haml similarity index 100% rename from app/assets/javascripts/darkswarm/cookies_banner/cookies_banner.html.haml rename to engines/web/app/views/angular_templates/cookies_banner.html.haml diff --git a/app/views/angular_templates/cookies_policy.html.haml b/engines/web/app/views/angular_templates/cookies_policy.html.haml similarity index 100% rename from app/views/angular_templates/cookies_policy.html.haml rename to engines/web/app/views/angular_templates/cookies_policy.html.haml diff --git a/engines/web/config/routes.rb b/engines/web/config/routes.rb new file mode 100644 index 0000000000..e9143b1c7d --- /dev/null +++ b/engines/web/config/routes.rb @@ -0,0 +1,7 @@ +Web::Engine.routes.draw do + namespace :api do + scope '/cookies' do + resource :consent, only: [:show, :create, :destroy], controller: "cookies_consent" + end + end +end diff --git a/engines/web/lib/web.rb b/engines/web/lib/web.rb new file mode 100644 index 0000000000..613b763014 --- /dev/null +++ b/engines/web/lib/web.rb @@ -0,0 +1,4 @@ +require "web/engine" + +module Web +end diff --git a/engines/web/lib/web/cookies_consent.rb b/engines/web/lib/web/cookies_consent.rb new file mode 100644 index 0000000000..64f6c0c825 --- /dev/null +++ b/engines/web/lib/web/cookies_consent.rb @@ -0,0 +1,31 @@ +module Web + class CookiesConsent + COOKIE_NAME = 'cookies_consent'.freeze + + def initialize(cookies, domain) + @cookies = cookies + @domain = domain + end + + def exists? + cookies.key?(COOKIE_NAME) + end + + def destroy + cookies.delete(COOKIE_NAME, domain: domain) + end + + def set + cookies[COOKIE_NAME] = { + value: COOKIE_NAME, + expires: 1.year.from_now, + domain: domain, + httponly: true + } + end + + private + + attr_reader :cookies, :domain + end +end diff --git a/engines/web/lib/web/engine.rb b/engines/web/lib/web/engine.rb new file mode 100644 index 0000000000..11a353a3fd --- /dev/null +++ b/engines/web/lib/web/engine.rb @@ -0,0 +1,4 @@ +module Web + class Engine < ::Rails::Engine + end +end diff --git a/engines/web/lib/web/version.rb b/engines/web/lib/web/version.rb new file mode 100644 index 0000000000..ae51029b5c --- /dev/null +++ b/engines/web/lib/web/version.rb @@ -0,0 +1,3 @@ +module Web + VERSION = "0.0.1".freeze +end diff --git a/engines/web/spec/spec_helper.rb b/engines/web/spec/spec_helper.rb new file mode 100644 index 0000000000..3306063166 --- /dev/null +++ b/engines/web/spec/spec_helper.rb @@ -0,0 +1,8 @@ +ENV["RAILS_ENV"] = "test" + +require File.expand_path("dummy/config/environment.rb", __dir__) +require "rails/test_help" + +Rails.backtrace_cleaner.remove_silencers! + +Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f } diff --git a/engines/web/web.gemspec b/engines/web/web.gemspec new file mode 100644 index 0000000000..f44ee68909 --- /dev/null +++ b/engines/web/web.gemspec @@ -0,0 +1,13 @@ +$LOAD_PATH.push File.expand_path('lib', __dir__) + +require "web/version" + +Gem::Specification.new do |s| + s.name = "web" + s.version = Web::VERSION + s.authors = ["developers@ofn"] + s.summary = "Web domain of the OFN solution." + + s.files = Dir["{app,config,db,lib}/**/*"] + ["LICENSE.txt", "Rakefile", "README.rdoc"] + s.test_files = Dir["test/**/*"] +end