spree_easy_homepage 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07a6b8470e8fe93f97aee4eef3e1a20b8a70a1b4e5959a6f46419009e5c1dc83
+  data.tar.gz: 011fb3662bd6335ed7886e47f10fa826e8a12011edbaa7268b937ee1314236cb
+SHA512:
+  metadata.gz: d9555510dfd993241ae76c4fe2ba017bf71bf0ab8d10ba80f574365fca1e5e1cc081ce83272dab49dae9902d33134d986a3d8c24fc7823d0f6485f051d951472
+  data.tar.gz: 1c4890144873221edad49e955619d8a46c6840b5bc65fa1d5434fa2f979a1df3464ffedf3af1e5b269381a02d6e8b1d72af8290ad042613fb963625fd9a5c19f

data/.gitignore

@@ -0,0 +1,22 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.localeapp/locales
+.project
+.vscode
+coverage
+default
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.sw?
+spec/dummy
+.rvmrc
+.sass-cache
+public/spree
+.ruby-version
+.ruby-gemset
+gemfiles/*.gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-r spec_helper
+-f documentation

data/.rubocop.yml

@@ -0,0 +1,34 @@
+require: rubocop-rails
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.6.4
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/generators/**/*'
+    - 'bin/rails'
+    - 'lib/spree_easy_homepage/engine.rb'
+
+Rails:
+  Enabled: true
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Rails/BelongsTo:
+  Exclude:
+    - 'app/models/spree/home_section_product.rb'
+
+Layout/LineLength:
+  Exclude:
+    - 'app/overrides/spree/admin/shared/sub_menu/_configuration.rb'
+    - 'spree_easy_homepage.gemspec'
+
+Rails/RakeEnvironment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,51 @@
+sudo: required
+dist: trusty
+
+language: ruby
+
+env:
+  - DB=postgres
+  - DB=mysql
+
+addons:
+  chrome: stable
+  postgresql: 9.4
+
+gemfile:
+  - gemfiles/spree_3_5.gemfile
+  - gemfiles/spree_3_7.gemfile
+  - gemfiles/spree_4_0.gemfile
+  - gemfiles/spree_master.gemfile
+
+script:
+  - bundle exec rake test_app
+  - bundle exec rake spec
+
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.8
+
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/spree_master.gemfile
+  exclude:
+    - rvm: 2.3.8
+      gemfile: gemfiles/spree_4_0.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/spree_4_0.gemfile
+    - rvm: 2.3.8
+      gemfile: gemfiles/spree_master.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/spree_master.gemfile
+    - rvm: 2.5.1
+      gemfile: gemfiles/spree_3_5.gemfile
+
+before_install:
+  - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"
+  - wget -N https://chromedriver.storage.googleapis.com/2.35/chromedriver_linux64.zip -P ~/
+  - unzip ~/chromedriver_linux64.zip -d ~/
+  - rm ~/chromedriver_linux64.zip
+  - sudo mv -f ~/chromedriver /usr/local/share/
+  - sudo chmod +x /usr/local/share/chromedriver
+  - sudo ln -s /usr/local/share/chromedriver /usr/local/bin/chromedriver

data/Appraisals

@@ -0,0 +1,28 @@
+appraise 'spree-3-5' do
+  gem 'spree_core', '~> 3.5.0'
+  gem 'spree_backend', '~> 3.5.0'
+  gem 'spree_auth_devise', '~> 3.4.0'
+  gem 'rails-controller-testing'
+end
+
+appraise 'spree-3-7' do
+  gem 'spree_core', '~> 3.7.0'
+  gem 'spree_backend', '~> 3.7.0'
+  gem 'spree_auth_devise', '~> 3.5.0'
+  gem 'rails-controller-testing'
+  gem 'sass-rails'
+end
+
+appraise 'spree-4-0' do
+  gem 'spree_core', '~> 4.0.0.rc2'
+  gem 'spree_backend', '~> 4.0.0.rc2'
+  gem 'spree_auth_devise', '~> 4.0'
+  gem 'rails-controller-testing'
+end
+
+appraise 'spree-master' do
+  gem 'spree_core', github: 'spree/spree', branch: 'master'
+  gem 'spree_backend', github: 'spree/spree', branch: 'master'
+  gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+  gem 'rails-controller-testing'
+end

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'spree_backend', github: 'spree/spree', branch: 'master'
+gem 'spree_core', github: 'spree/spree', branch: 'master'
+# Provides basic authentication functionality for testing parts of your engine
+gem 'rails-controller-testing'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+
+gem 'rubocop', require: false
+gem 'rubocop-rails', require: false
+gem 'rubocop-rspec', require: false
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2019 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,124 @@
+# SpreeEasyHomepage
+
+This is a complete open source [Spree](https://github.com/spree/spree) extension for easily managing your website's homepage products. Particularly useful for programmers who have clients or users with limited technological literacy. The current default operation for managing your homepage is cumbersome and time consuming for what is suppose to be a simple operation. Spree also does not include related frontend helpers which would require effort from the programmer to create and maintain.
+
+![SpreeEasyHomepage Demonstration](https://media.giphy.com/media/ekedAYQFgW0iIW1hCg/giphy.gif)
+
+**SpreeEasyHomepage** provides a beautiful and intuitive interface for populating and categorizing products without compromising ease of use. Developers would be delighted to know that setup is as simple as calling a single method from the view.
+
+
+Getting Started
+----------------------
+
+##### Add this extension to your Gemfile with this line:
+
+```ruby
+gem 'spree_easy_homepage'
+```
+
+##### Install the gem
+
+```shell
+bundle install
+```
+
+##### Run the install generators from your console
+
+```shell
+rails g spree_easy_homepage:install
+```
+
+Admins can manage their Homepage by navigating to the configurations tab from the sidebar.
+
+Frontend Setup
+----------------------
+
+#### To populate your homepage with products
+
+Expose this gem's frontend helper in your controller, eg:
+
+```ruby
+class ApplicationController < ActionController::Base
+  helper Spree::EasyHomepageHelper
+end
+```
+Then from your view, add the helper method `fill_with_sections` eg:
+
+```
+<div class="row">
+  <%= fill_with_sections %>
+</div>
+```
+
+#### Thats it!
+
+`fill_with_sections` defaults to use the product "tile" partial in `app/views/spree/products/_product.html.erb`. If none are found in your project folder, the call is delegated to the official "tile" partial used by Spree.
+
+The default product "tile" partial can be optionally overridden by passing `locals: {product_partial: '/path/to/tile_partial'}` in `fill_with_sections` arguments. EG:
+
+```ruby
+fill_with_sections(locals: {product_partial: 'spree/shared/product_tile'})
+```
+
+If you want to pass variables to the product "tile" partial, you can use `product_locals: {}`, similar to the procedure above. EG:
+
+```ruby
+fill_with_sections(locals: {product_locals: {taxon: @taxon, product_tile_size: :small}})
+```
+
+deep inside the helper, between the products loop, the locals passed from the above code is passed to the product "tile" partial:
+
+```ruby
+render partial: 'spree/products/product', locals: {product: product, taxon: @taxon, product_tile_size: :small}
+```
+
+Information
+----------------------
+
+#### Editing the view generated by `fill_with_sections`
+
+By default, `fill_with_sections` renders the `_home_sections.html.erb` partial located in `app/views/spree/shared/`. To change the default path.
+
+```ruby
+fill_with_sections(partial: 'spree/shared/custom_home_sections')
+```
+
+or simply create a `_home_sections.html.erb` partial file in your `spree/shared` folder.
+
+If you want to edit the HTML elements outputted by `fill_with_sections`. Investigate the `shared/_home_sections.html.erb` partial from the gem then override with your edited version in your main project as instructed above.
+
+Testing via Rspec
+----------------------
+
+From the gem's root folder
+
+```shell
+bundle install
+```
+
+Generate a dummy app via Rspec
+
+```shell
+bundle exec rake generate_dummy_app
+```
+
+Then call Rspec
+
+```shell
+rspec
+```
+
+Note: for feature tests, chrome (headless) is selected by default.
+
+
+##### Run the install generators from your console
+
+```shell
+rails g spree_easy_homepage:install
+```
+
+Contributing
+----------------------
+This gem has only been released recently. Feedback is appreciated. I have no guidelines for pull-requests other than the basic description and reproduction steps (for bugs). Proper OOP must be followed for feature submissions.
+
+Copyright (c) 2020 [Jibril Tapiador](https://www.jibril.ch/), released under the New BSD License.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+
+task :generate_dummy_app do
+  ENV['LIB_NAME'] = 'spree_easy_homepage'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/product_autosearch.js

@@ -0,0 +1,33 @@
+(function ($) {
+  $.fn.productAutoSearch = function(formatResult) {
+    return this.select2({
+      placeholder: Spree.translations.product_placeholder,
+      minimumInputLength: 3,
+      ajax: {
+        url: Spree.routes.products_api,
+        quietMillis: 200,
+        datatype: 'json',
+        cache: true,
+        data: function(term) {
+          return {
+            q: {
+              name_or_master_sku_cont: term
+            },
+            token: Spree.api_key,
+            per_page: 5
+          };
+        },
+        results: function(data) {
+          var products = data.products ? data.products : [];
+          return {
+            results: data.products
+          };
+        }
+      },
+      formatResult: formatResult,
+      formatSelection: function(product) {
+        return Select2.util.escapeMarkup(product.name);
+      }
+    });
+  };
+})(jQuery);

data/app/assets/javascripts/spree/backend/spree_easy_homepage.js

@@ -0,0 +1,42 @@
+(function ($) {
+  const addProductSection = function(product, lineItemTemplate) {
+   $("#section-product-list").append(lineItemTemplate({product: product}));
+  };
+
+  const fillSectionsList = function(lineItemTemplate) {
+    const products = $("#section-product-list").data("home-sections");
+    $.each(products, function() {
+      addProductSection(this, lineItemTemplate);
+    });
+  };
+
+  const ready = function() {
+    const productSearchResult = $("#product-search-result");
+    if (productSearchResult.length === 0) return;
+
+    const productResultTemplate = Handlebars.compile(productSearchResult.text());
+    const lineItemTemplate = Handlebars.compile($("#product-search-lineitem").text());
+
+    fillSectionsList(lineItemTemplate);
+
+    $(".product-autosearch").productAutoSearch(function(product) {
+      const masterImage = product.master.images[0];
+      if (masterImage !== undefined && masterImage.mini_url !== undefined) {
+        product.image = masterImage.mini_url;
+      }
+      return productResultTemplate({
+        product: product
+      });
+    }).on("change", function(e) {
+      addProductSection(e.added, lineItemTemplate);
+    });
+
+    $('#section-product-list').on("click", ".delete-resource", function(e) {
+      $(this).closest("tr").remove();
+    });
+
+    $('#section-product-list').sortable({handle: '.handle'});
+  };
+
+$(document).ready(ready);
+})(jQuery);

data/app/assets/javascripts/spree/frontend/spree_easy_homepage.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/spree_easy_homepage.scss

@@ -0,0 +1,12 @@
+.grabbable {
+  cursor: move;
+  cursor: grab;
+  cursor: -moz-grab;
+  cursor: -webkit-grab;
+
+  &:active {
+    cursor: grabbing;
+    cursor: -moz-grabbing;
+    cursor: -webkit-grabbing;
+  }
+}