workarea-jquery_magnify 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85422a157552b0b4970f5ab7e13b9baa321f28fe428385e930d5901e203b6d58
+  data.tar.gz: 57afd6220dd041ea02d7eb15ecedfa6fbaf86745555c61a9d2057224ead50c03
+SHA512:
+  metadata.gz: 1d3f93171998bbbd23eb7082232c9ab717faa6aa0121180bcb8b73f39d6882867d30434e11a96ac11d4565e7747336d95d03705f2d4a2e5c6ab396db22143a01
+  data.tar.gz: 49278183b6c7387533e6d5a4c001b8e5e9367dca6a12fb3a6c780dea7668ff0178008fb2779da62a45efb8b06b7d810d2d64850e08d3491ca3cf9e4e5ef91a26

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,54 @@
+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
+
+  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,21 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+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
+node_modules/
+.rubocop-https-*

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1 @@
+

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,7 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec
+
+gem 'workarea', github: 'workarea-commerce/workarea'
+gem 'rubocop'

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,99 @@
+Workarea Jquery Magnify
+================================================================================
+
+Note: This work is in progress and part of the workarea-zoom plugin.
+
+About
+--------------------------------------------------------------------------------
+Jquery Magnify let your user enlarge images on mouseover, it's a great candidate for non-touch enabled devices with a small support for touch-enabled devices.
+
+If you are looking for a better experience on touch-enabled devices, you should check out: https://stash.tools.weblinc.com/projects/WP/repos/workarea-jquery-zoom/browse.
+
+
+Getting Started
+--------------------------------------------------------------------------------
+
+Add the gem to your application's Gemfile:
+
+    # ...
+    gem 'workarea-jquery_magnify'
+    # ...
+
+This Gem will mount the jquery.magnify asset in your application.
+
+Example
+--------------------------------------------------------------------------------
+
+```html
+    <div class="magnify">
+        <div data-magnify-src="http://example.com/big-image.jpg" class="magnify__container">
+            <img src="http://example.com/small-image.jpg" class="magnify__image">
+        </div>
+    </div>
+```
+
+```css
+.magnify {
+    width: 320px;
+}
+
+.magnify__container {
+    position: relative;
+}
+
+.magnify__image{
+    display: block;
+    width: 100%;
+    min-width: 100%;
+}
+```
+
+```javascript
+$(document).ready(function() {
+    $('.magnify__container').magnify();
+});
+```
+
+
+Options
+--------------------------------------------------------------------------------
+
+You have the ability to pass your options like this:
+
+```javascript
+$('.magnify').magnify({
+    url: null,
+    touchSupport: false
+});
+```
+
+Different options are available:
+
+Name  | Default | Description
+------------- | ------------- | -------------
+touchSupport  | ```false``` | Enable/Disable finger gestures on touch-enabled devices
+url | ```null``` | The url of the big magnify image, if not defined, jquery.magnify will fetch the attribute  ```data-magnify-src```given.
+
+Events
+--------------------------------------------------------------------------------
+
+You can destroy the widget for the instance given, it's helpful when you want to go back to a clean state.
+
+```javascript
+// Create instance
+$('.magnify__container').magnify();
+
+// Remove instance
+$('.magnify__container').trigger('magnify.destroy');
+```
+
+Workarea Commerce Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Styled Selects is released under the [Business Software License](LICENSE)
+

data/Rakefile

@@ -0,0 +1,109 @@
+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    = 'Jquery Magnify'
+  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", __FILE__)
+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', __FILE__)
+require 'workarea/jquery_magnify/version'
+
+desc 'Generate the changelog based on git history'
+task :changelog, :from, :to do |t, args|
+  require 'date'
+
+  from = args[:from] || `git describe --tags --abbrev=0`.strip
+  to = args[:to] || 'HEAD'
+  log = `git log #{from}..#{to} --pretty=format:'%an|%B___'`
+
+  puts "Workarea Jquery Magnify #{Workarea::JqueryMagnify::VERSION} (#{Time.zone.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 = nil # 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::JqueryMagnify::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::JqueryMagnify::VERSION} -m 'Tagging #{Workarea::JqueryMagnify::VERSION}'"
+  system 'git push --tags'
+
+  system "gem build workarea-jquery_magnify.gemspec"
+  system "gem push workarea-jquery_magnify-#{Workarea::JqueryMagnify::VERSION}.gem"
+  system "gem push workarea-jquery_magnify-#{Workarea::JqueryMagnify::VERSION}.gem --host #{host}"
+  system "rm workarea-jquery_magnify-#{Workarea::JqueryMagnify::VERSION}.gem"
+end
+
+desc 'Run the JavaScript tests'
+ENV['TEASPOON_RAILS_ENV'] = File.expand_path('../test/dummy/config/environment', __FILE__)
+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', __FILE__)
+  system "RAILS_ENV=test TEASPOON_ENV=#{teaspoon_env} rails s"
+end

data/app/assets/javascripts/jquery_magnify/jquery.magnify.js

@@ -0,0 +1,236 @@
+/**
+ * @author Jeremie Ges <jges@weblinc.com>
+ */
+(function($) {
+
+  function Magnify() {
+
+      /**
+       * DOM accessors
+       * @type {Object}
+       */
+      this.$dom = {
+          container: null,
+          image: null
+      },
+
+      /**
+       * Keep track of things
+       * @type {Object}
+       */
+      this.flags = {
+          imageLoaded: false,
+      },
+
+      /**
+       * Contains every options of $.fn.magnify.defaults
+       * merged with the options provided by the user
+       * @type {Object}
+       */
+      this.options = {},
+
+      /**
+       * Initialize the widget with the right options,
+       * scope (container) and boot
+       * @param {HTMLElement} container - The container of the zoom element
+       * @param {Object} options - The options provided by the user
+       */
+      this.init = function(container, options) {
+          this.$dom.container = $(container);
+          this.options = _.extend($.fn.magnify.defaults, options);
+          this.setup();
+          this.events();
+      },
+
+      /**
+       * Setup minimal dependencies
+       */
+      this.setup = function() {
+          this.setupImage();
+      },
+
+      /**
+       * Create a blank <img> tag which
+       * will be used as the zoom image.
+       */
+      this.setupImage = function() {
+          this.$dom.image = $('<img/>');
+      },
+
+      /**
+       * Attach events and start listen
+       */
+      this.events = function() {
+          this.$dom.image.on('load', this.onLoadImage.bind(this));
+
+          this.$dom.container
+            .on('mouseenter', this.onEnterContainer.bind(this))
+            .on('mouseleave', this.onLeaveContainer.bind(this))
+            .on('mousemove', this.onMoveContainer.bind(this));
+
+          if (this.options.touchSupport) {
+            this.$dom.container
+              .on('touchstart', this.onEnterContainer.bind(this))
+              .on('touchend', this.onLeaveContainer.bind(this))
+              .on('touchmove', this.onMoveContainer.bind(this));
+          }
+
+          this.$dom.container.on('magnify.destroy', this.destroy.bind(this));
+      },
+
+      /**
+       * Callback when the zoom image is loaded
+       */
+      this.onLoadImage = function() {
+          // Insert zoom image in page
+          this.$dom.image
+              .css({
+                  position: 'absolute',
+                  top: 0,
+                  left: 0,
+                  width: this.$dom.image.get(0).width,
+                  height: this.$dom.image.get(0).height,
+                  border: 'none',
+                  maxWidth: 'none',
+                  maxHeight: 'none',
+              })
+              .attr('role', 'presentation')
+              .appendTo(this.$dom.container);
+
+          this.$dom.container.css('overflow', 'hidden');
+          this.flags.imageLoaded = true;
+      },
+
+      /**
+       * Callback when the mouse / finger enters inside
+       * the container
+       */
+      this.onEnterContainer = function(e) {
+          e.preventDefault();
+
+          if (!this.flags.imageLoaded) {
+            this.loadImage();
+          }
+
+          this.showImage();
+      },
+
+      /**
+       * Callback when the mouse / finger leaves
+       * the container
+       */
+      this.onLeaveContainer = function(e) {
+        e.preventDefault();
+        this.hideImage();
+      },
+
+      /**
+       * Callback when the mouse / finger is moving
+       * in the container
+       */
+      this.onMoveContainer = function(e) {
+        e.preventDefault();
+        this.refreshPositionImage(e);
+      },
+
+      /**
+       * Depending the current position of the mouse / finger,
+       * moves the properties top/left of the zoom image. 
+       */
+      this.refreshPositionImage = function(e) {
+          var pageX = e.pageX || e.originalEvent.pageX,
+              pageY = e.pageY || e.originalEvent.pageY,
+              containerOffset = this.$dom.container.offset(),
+              containerWidth = this.$dom.container.outerWidth(),
+              containerHeight = this.$dom.container.outerHeight(),
+              xRatio = (this.$dom.image.prop('width') - containerWidth) / containerWidth,
+              yRatio = (this.$dom.image.prop('height') - containerHeight) / containerHeight,
+              top = (pageY - containerOffset.top),
+              left = (pageX - containerOffset.left);
+
+        top = Math.max(Math.min(top, containerHeight), 0);
+        left = Math.max(Math.min(left, containerWidth), 0);
+
+        this.$dom.image.css({
+          top: (top * -yRatio) + 'px',
+          left: (left * -xRatio) + 'px'
+        });
+      },
+
+      /**
+       * Add the attribute src of the zoom image,
+       * therefore it triggers the load of the zoom
+       * image.
+       */
+      this.loadImage = function() {
+        this.$dom.image.attr('src', this.getUrlImage());
+      },
+
+      /**
+       * Hide the zoom image
+       */
+      this.hideImage = function() {
+        this.$dom.image.css('opacity', 0);
+      },
+
+      /**
+       * Show the zoom image
+       */
+      this.showImage = function() {
+        this.$dom.image.css('opacity', 1);
+      },
+
+      /**
+       * Get the src url of the zoom image
+       */
+      this.getUrlImage = function() {
+        if (!_.isEmpty(this.options.url)) {
+          return this.options.url;
+        }
+
+        return this.$dom.container.data('magnify-src');
+      },
+
+      /**
+       * Teardown the changes
+       */
+      this.destroy = function() {
+        this.$dom.container.off('mouseenter mouseleave mousemove magnify.destroy');
+        this.$dom.image.off('load');
+        this.$dom.image.remove();
+        this.$dom.container.css('overflow', '');
+      }
+  }
+
+  /**
+   * Public jQuery API
+   */
+  
+  $.fn.magnify = function(options) {
+
+      var options = options || {};
+
+      return this.each(function() {
+          new Magnify().init(this, options);
+      });
+  };
+
+  $.fn.magnify.defaults = {
+
+    /**
+     * The url of the zoom image. 
+     * If not specified, the plugin will look for the data attribute
+     * data-magnify-src on the thumbnail <img>.
+     * @type {String}
+     */
+    url: null,
+
+    /**
+     * Do you want to enable finger gestures on
+     * touch-enabled devices?
+     * @type {Boolean}
+     */
+    touchSupport: false
+  };
+
+})(window.jQuery);