workarea-product_documents 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d59e9ef25d717590bb3a54df6cf2e6d0b8e43c4d91650e0d52b837b7b429945e
+  data.tar.gz: 9f9043874a201750bdbf4f5699888f69dc7fcb3ef97efcac427babd335bc9ef5
+SHA512:
+  metadata.gz: f652e0b942a7ab63199e5d85bbfd8c0154305466d25a13b1e4d3c23a33f4d2da19f58de0f2de6d08ee575f51bdbe4bf6516566b7344b08ba9d4310a15b8f2100
+  data.tar.gz: 810f7ae861289df7b26c0af0ce973285ccc729d88e8ba7113ba922722e1ebbf4152b5c0e057f5b042831f186606944cf421f4d1bb90cb553bfb1baafc9b6d16c

data/.editorconfig

@@ -0,0 +1,20 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.rb,*.haml,*.decorator,*.yml,*.yaml,*.jbuilder}]
+indent_size = 2
+indent_style = space
+
+[{*.js,*.jst,*.ejs,*.scss}]
+indent_size = 4
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve Workarea
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+⚠️**Before you create**⚠️
+Please verify the issue you're experiencing is not part of your Workarea project customizations. The best way to do this is with a [vanilla Workarea installation](https://developer.workarea.com/articles/create-a-new-host-application.html). This will help us spend time on fixes/improvements for the whole community. Thank you!
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Workarea Setup (please complete the following information):**
+ - Workarea Version: [e.g. v3.4.6]
+ - Plugins [e.g. workarea-blog, workarea-sitemaps]
+
+**Attachments**
+If applicable, add any attachments to help explain your problem, things like:
+- screenshots
+- Gemfile.lock
+- test cases
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,17 @@
+---
+name: Documentation request
+about: Suggest documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Is your documentation related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm confused by [...]
+
+**Describe the article you'd like**
+A clear and concise description of what would be in the documentation article.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for Workarea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+on: [push]
+
+jobs:
+  static_analysis:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: workarea-commerce/ci/bundler-audit@v1
+    - uses: workarea-commerce/ci/rubocop@v1
+    - uses: workarea-commerce/ci/eslint@v1
+      with:
+        args: '**/*.js'
+
+  admin_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:admin
+
+  core_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:core
+
+  storefront_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:storefront
+
+  plugins_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:plugins

data/.gitignore

@@ -0,0 +1,18 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/tmp/
+.DS_Store
+.byebug_history
+.bundle/
+.sass-cache/
+Gemfile.lock
+pkg/
+test/dummy/tmp/
+test/dummy/public/
+log/*.log
+test/dummy/log/*.log
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+coverage/
+.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+  - https://raw.githubusercontent.com/workarea-commerce/workarea/master/.rubocop.yml
+

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+Workarea ProductDocuments 1.0.0 (2019-11-26)
+--------------------------------------------------------------------------------
+
+
+Workarea ProductDocuments 1.0.0 (2018-04-25)
+--------------------------------------------------------------------------------
+
+*   Upgrade product documents to v.3 compatibility
+
+    Upgrades the plugin to v3. Commit does away with explicit document types,
+    instead it groups documents by display name, making this a zero configuration
+    plugin. New drag-and-drop functionality for ordering has been introduced
+    in this version.
+
+    DOCUMENTS-1
+    Jeff Yucis

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+View this plugin's code of conduct here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md>

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+View this plugin's contribution guidelines here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CONTRIBUTING.md>

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec
+
+gem 'workarea', github: 'workarea-commerce/workarea'
+
+group :test do
+  gem 'simplecov', require: false
+end

data/LICENSE.md

@@ -0,0 +1,3 @@
+View this plugin's license here: 
+
+<https://github.com/workarea-commerce/workarea/blob/master/LICENSE.md>

data/README.md

@@ -0,0 +1,39 @@
+WebLinc Product Documents
+================================================================================
+
+Product Documents plugin for the Workarea platform.
+-------------------------------------------------------------------------------
+
+This gem adds the ability to add documents to a product for display on the detail page.
+
+Files can be added via the product admin. Each file requires a display name and a file for downloading.
+Files with the same display name will be grouped together when output on the product detail page.
+
+The display order of the files can be modified via drag-and-drop in the admin.
+
+
+Getting Started
+--------------------------------------------------------------------------------
+
+This gem contains a rails engine that must be mounted onto a host Rails application.
+
+Add the gem to your application's Gemfile specifying the source:
+
+    # ...
+    gem 'workarea-product_documents'
+    # ...
+
+Update your application's bundle.
+
+    cd path/to/application
+    bundle
+
+WebLinc Platform Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com/](https://developer.workarea.com/) for Workarea platform documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Emarsys is released under the [Business Software License](LICENSE)

data/Rakefile

@@ -0,0 +1,116 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "ProductDocuments"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path("lib", __dir__)
+require "workarea/product_documents/version"
+
+desc "Generate the changelog based on git history"
+task :changelog, :from, :to do |_t, args|
+  require "date"
+
+  from = if args[:from].present?
+    args[:from]
+         elsif `git tag`.empty?
+           `git rev-list --max-parents=0 HEAD`
+         else
+           `git describe --tags --abbrev=0`.strip
+  end
+
+  to = args[:to] || "HEAD"
+  log = `git log #{from}..#{to} --pretty=format:'%an|%B___'`
+
+  puts "Workarea ProductDocuments #{Workarea::ProductDocuments::VERSION} (#{Date.today})"
+  puts "-" * 80
+  puts
+
+  log.split(/___/).each do |commit|
+    pieces = commit.split("|").reverse
+    author = pieces.pop.strip
+    message = pieces.join.strip
+
+    next if message =~ /^\s*Merge pull request/
+    next if message =~ /No changelog/i
+
+    project_key = "DOCUMENTS" # TODO: Replace with your Project's Jira key
+
+    if project_key.blank?
+      puts "To clean up your release notes, add your project's Jira key to the Changelog Rake task!"
+    else
+      ticket = message.scan(/#{project_key}-\d+/)[0]
+      next if ticket.nil?
+      next if message =~ /^\s*Merge branch/ && ticket.nil?
+    end
+
+    first_line = false
+
+    message.each_line do |line|
+      if !first_line
+        first_line = true
+        puts "*   #{line}"
+      elsif line.strip.empty?
+        puts
+      else
+        puts "    #{line}"
+      end
+    end
+
+    puts "    #{author}"
+    puts
+  end
+end
+
+desc "Release version #{Workarea::ProductDocuments::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  system "touch CHANGELOG.md"
+  system 'echo "$(rake changelog)
+
+
+$(cat CHANGELOG.md)" > CHANGELOG.md'
+  system 'git add CHANGELOG.md && git commit -m "Update changelog" && git push origin HEAD'
+
+  system "git tag -a v#{Workarea::ProductDocuments::VERSION} -m 'Tagging #{Workarea::ProductDocuments::VERSION}'"
+  system "git push --tags"
+
+  system "gem build workarea-product_documents.gemspec"
+  system "gem push workarea-product_documents-#{Workarea::ProductDocuments::VERSION}.gem"
+  system "gem push workarea-product_documents-#{Workarea::ProductDocuments::VERSION}.gem --host #{host}"
+  system "rm workarea-product_documents-#{Workarea::ProductDocuments::VERSION}.gem"
+end
+
+desc "Run the JavaScript tests"
+ENV["TEASPOON_RAILS_ENV"] = File.expand_path("test/dummy/config/environment", __dir__)
+task teaspoon: "app:teaspoon"
+
+desc "Start a server at http://localhost:3000/teaspoon for JavaScript tests"
+task :teaspoon_server do
+  Dir.chdir("test/dummy")
+  teaspoon_env = File.expand_path("test/teaspoon_env.rb", __dir__)
+  system "RAILS_ENV=test TEASPOON_ENV=#{teaspoon_env} rails s"
+end

data/app/assets/javascripts/workarea/admin/modules/sort_documents.js

@@ -0,0 +1,68 @@
+/**
+ * @namespace WORKAREA.sortDocuments
+ */
+WORKAREA.registerModule('sortDocuments', (function () {
+    'use strict';
+
+    var findDocumentPositions = function (event) {
+            var result = {},
+                $documents = $('[data-sort-document-id]', event.target);
+
+            $documents.each(function (index, menu) {
+                var id = $(menu).data('sortDocumentId');
+
+                if (id) {
+                    result['positions[' + id + ']'] = index;
+                }
+            });
+
+            return result;
+        },
+
+        saveSort = function (event) {
+            var productId = $(event.target)
+                                .closest('[data-sort-document]')
+                                .data('productId'),
+
+                url = WORKAREA.routes.admin.moveCatalogProductDocumentsPath(
+                    { catalog_product_id: productId }
+                );
+
+            $.post(url, findDocumentPositions(event));
+        },
+
+        setCellWidth = function (event, ui) {
+            $('td', ui.item).each(function (index, cell) {
+                $(cell).width($(cell).width());
+            });
+
+            return ui;
+        },
+
+        resetCellWidth = function (event, ui) {
+            $('td', ui.item).each(function (index, cell) {
+                $(cell).width('auto');
+            });
+
+            return ui;
+        },
+
+        /**
+         * @method
+         * @name init
+         * @memberof WORKAREA.sortDocuments
+         */
+        init = function ($scope) {
+            $('[data-sort-document]', $scope).sortable({
+                axis: 'y',
+                update: saveSort,
+                tolerance: 'pointer',
+                helper: setCellWidth,
+                stop: resetCellWidth
+            });
+        };
+
+    return {
+        init: init
+    };
+}()));