pageflow-panorama 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c457397c261ea9a1ade84a3bb97a17f20fa7268bbb3c9d23a0e46e96e7b240f3
-  data.tar.gz: a1bcf318d142760ec391a51b2237fa5d76595653f9a104ea3e45624c6859b000
+  metadata.gz: 3db4ed7e2dac5aadca40c3177669f4c6640577eb9f941f568a8156890e7d3dd0
+  data.tar.gz: 5048ed5d21482edb03f99b9feca34518a35689864d8962af14031dcc6933de45
 SHA512:
-  metadata.gz: e3e8c34ed50b57fc2d8127d811b795b7199180037a6171c38d48016472f705fd223476c1dcde4510d8bc1bf7f4a3d004f9a5ef5868f2f4848e5a1311b3860a52
-  data.tar.gz: 12792526b512f691eafca8bb58cda0b4f5e228c9747d4e57677a3fc1444486ffbc30478f999ff0568736f20c81e997d26e8e77bdeae7cde15d083703ef069a1d
+  metadata.gz: 13c02586c8b56f9c40137bdfb917d16fb3e58ddb2737ffb648fc813e0daa7c6fc7ae2f243afb559ff8671a36e6d693092697e9d14c0761e00dd476923fd52c6c
+  data.tar.gz: 80fe4b7abf2332853ba64c46bec403dc8f50b1b4d5855a1f2c6157e33b5f49eba1feb15fa01f66ca1e87f8652dd67ce94c52768ea2aa7897949da1d7447255db

data/.travis.yml

@@ -8,3 +8,6 @@ cache: bundler
 
 script:
   - bin/rspec
+
+services:
+  - mysql

data/CHANGELOG.md

@@ -1,18 +1,18 @@
 # CHANGELOG
 
-### Version 2.1.0
+### Version 2.2.0
 
-2019-04-08
+2019-11-04
 
-[Compare changes](https://github.com/codevise/pageflow-panorama/compare/2-0-stable...v2.1.0)
+[Compare changes](https://github.com/codevise/pageflow-panorama/compare/2-1-stable...v2.2.0)
 
-- Adapt page dom for pageflow 14
-  ([#31](https://github.com/codevise/pageflow-panorama/pull/31))
-- Setup page type lint specs
-  ([#30](https://github.com/codevise/pageflow-panorama/pull/30))
-- Allow bundler 2 in development dependencies
-  ([#29](https://github.com/codevise/pageflow-panorama/pull/29))
+- Add importer for Packages
+  ([#35](https://github.com/codevise/pageflow-panorama/pull/35))
+- Fix Travis CI
+  ([#34](https://github.com/codevise/pageflow-panorama/pull/34))
+- Always lookup files by revisions usage scope
+  ([#32](https://github.com/codevise/pageflow-panorama/pull/32))
 
 See
-[2-0-stable branch](https://github.com/codevise/pageflow-panorama/blob/2-0-stable/CHANGELOG.md)
+[2-1-stable branch](https://github.com/codevise/pageflow-panorama/blob/2-1-stable/CHANGELOG.md)
 for previous changes.

data/app/assets/javascripts/pageflow/panorama/editor/models/package.js

@@ -1,4 +1,4 @@
-pageflow.panorama.Package = pageflow.HostedFile.extend({
+pageflow.panorama.Package = pageflow.UploadableFile.extend({
   processingStages: [
     {
       name: 'unpacking',

data/app/assets/stylesheets/pageflow/panorama/editor.scss

@@ -1,3 +1,3 @@
-@include pageflow-hosted-file-stage('unpacking') {
+@include pageflow-uploadable-file-stage('unpacking') {
   @include archive-icon;
 }

data/app/helpers/pageflow/panorama/packages_helper.rb

@@ -1,11 +1,13 @@
 module Pageflow
   module Panorama
     module PackagesHelper
+      include RevisionFileHelper
+
       def panorama_url(configuration)
         if configuration['panorama_source'] == 'url'
           configuration['panorama_url']
         else
-          package = Package.find_by_id(configuration['panorama_package_id'])
+          package = find_file_in_entry(Package, configuration['panorama_package_id'])
           package ? package.index_document_path : nil
         end
       end

data/app/models/pageflow/panorama/package.rb

@@ -3,7 +3,7 @@ require 'zip'
 module Pageflow
   module Panorama
     class Package < ActiveRecord::Base
-      include HostedFile
+      include UploadableFile
 
       processing_state_machine do
         state 'unpacking'
@@ -14,11 +14,11 @@ module Pageflow
           transition any => 'unpacking'
         end
 
-        event :retry do
+        event :retry_unpacking do
           transition 'unpacking_failed' => 'unpacking'
         end
 
-        before_transition on: :retry do |package|
+        before_transition on: :retry_unpacking do |package|
           JobStatusAttributes.reset(package, stage: :unpacking)
         end
 
@@ -47,6 +47,15 @@ module Pageflow
       def unpack_base_path
         attachment_on_s3.present? ? File.dirname(attachment_on_s3.path(:unpacked)) : nil
       end
+
+      # UploadableFile-overrides
+      def retry!
+        retry_unpacking!
+      end
+
+      def ready?
+        unpacked?
+      end
     end
   end
 end

data/lib/pageflow/panorama/page_type.rb

@@ -10,11 +10,7 @@ module Pageflow
       end
 
       def file_types
-        [
-          FileType.new(model: Package,
-                       editor_partial: 'pageflow/panorama/editor/packages/package',
-                       top_level_type: true)
-        ]
+        [Panorama.package_file_type]
       end
 
       def json_seed_template
@@ -23,10 +19,22 @@ module Pageflow
 
       def thumbnail_candidates
         [
-          {attribute: 'thumbnail_image_id', file_collection: 'image_files'},
-          {attribute: 'panorama_package_id', file_collection: 'pageflow_panorama_packages'}
+          {
+            attribute: 'thumbnail_image_id',
+            file_collection: 'image_files'
+          },
+          {
+            attribute: 'panorama_package_id',
+            file_collection: 'pageflow_panorama_packages'
+          }
         ]
       end
     end
+
+    def self.package_file_type
+      FileType.new(model: Package,
+                   editor_partial: 'pageflow/panorama/editor/packages/package',
+                   top_level_type: true)
+    end
   end
 end

data/lib/pageflow/panorama/version.rb

@@ -1,5 +1,5 @@
 module Pageflow
   module Panorama
-    VERSION = '2.1.0'.freeze
+    VERSION = '2.2.0'.freeze
   end
 end

data/pageflow-panorama.gemspec

@@ -18,12 +18,12 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.1'
 
-  spec.add_runtime_dependency 'pageflow', '~> 14.x'
+  spec.add_runtime_dependency 'pageflow', '~> 15.x'
   spec.add_runtime_dependency 'rubyzip', '~> 1.1'
   spec.add_runtime_dependency 'aws-sdk-s3', '~> 1.17'
   spec.add_runtime_dependency 'pageflow-public-i18n', '~> 1.0'
 
-  spec.add_development_dependency 'pageflow-support', '~> 14.x'
+  spec.add_development_dependency 'pageflow-support', '~> 15.x'
   spec.add_development_dependency 'bundler', ['>= 1.0', '< 3']
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec-rails', '~> 3.7'

data/spec/factories/panorama_package.rb

@@ -0,0 +1,11 @@
+module Pageflow
+  module Panorama
+    FactoryBot.define do
+      factory :package, class: Package do
+        attachment { File.open(Engine.root.join('spec', 'fixtures', 'some.txt.zip')) }
+        index_document { true }
+        state { 'unpacked' }
+      end
+    end
+  end
+end

data/spec/helpers/pageflow/panorama/packages_helper_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'pageflow/used_file_test_helper'
+
+module Pageflow
+  module Panorama
+    describe PackagesHelper do
+      include UsedFileTestHelper
+
+      describe '#panorama_url' do
+        context 'URL panorama source' do
+          it 'should return specified panorama url when panorama source is URL' do
+            @entry = PublishedEntry.new(create(:entry, :published))
+            configuration = {
+              'panorama_source' => 'url',
+              'panorama_url' => 'S3-url'
+            }
+
+            url = helper.panorama_url(configuration)
+            expect(url).to eq('S3-url')
+          end
+        end
+
+        it 'should return nil if no package can be found' do
+          @entry = PublishedEntry.new(create(:entry, :published))
+          configuration = {
+            'panorama_package_id' => 500
+          }
+
+          expect(helper.panorama_url(configuration)).to be_nil
+        end
+
+        it 'should return the packages index document path' do
+          panorama_package_file = create_used_file(:package)
+          configuration = {
+            'panorama_package_id' => panorama_package_file.perma_id
+          }
+
+          url = helper.panorama_url(configuration)
+          expect(url).to match(/#{panorama_package_file.id}\/unpacked\/#{panorama_package_file.perma_id}/)
+        end
+      end
+    end
+  end
+end

data/spec/integration/file_type_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'pageflow/lint'
+
+module Pageflow
+  module Panorama
+    Pageflow::Lint.file_type(:package,
+                             create_file_type: -> { Panorama.package_file_type },
+                             create_file: -> { create(:package) })
+  end
+end

data/spec/support/config/factory_bot.rb

@@ -0,0 +1,14 @@
+require 'factory_bot_rails'
+
+RSpec.configure do |config|
+  # Allow to use build and create methods without FactoryBot prefix.
+  config.include FactoryBot::Syntax::Methods
+
+  # Make sure factories are up to date when using spring. Skip in CI
+  # since reloading causes factories to be excluded in test coverage.
+  unless ENV['CI']
+    config.before(:all) do
+      FactoryBot.reload
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pageflow-panorama
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Codevise Solutions
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pageflow
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 14.x
+        version: 15.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 14.x
+        version: 15.x
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 14.x
+        version: 15.x
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 14.x
+        version: 15.x
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -216,10 +216,13 @@ files:
 - lib/pageflow/panorama/version.rb
 - lib/pageflow/panorama/zip_entry_paperclip_io_adapter.rb
 - pageflow-panorama.gemspec
+- spec/factories/panorama_package.rb
 - spec/fixtures/dir_some.txt.zip
 - spec/fixtures/krpano.zip
 - spec/fixtures/krpano_with_unprocessable_thumbnail.zip
 - spec/fixtures/some.txt.zip
+- spec/helpers/pageflow/panorama/packages_helper_spec.rb
+- spec/integration/file_type_spec.rb
 - spec/integration/page_type_spec.rb
 - spec/models/pageflow/panorama/package_spec.rb
 - spec/pageflow/panorama/job_status_attributes_spec.rb
@@ -227,6 +230,7 @@ files:
 - spec/pageflow/panorama/validation/kr_pano_spec.rb
 - spec/spec_helper.rb
 - spec/support/config/active_job.rb
+- spec/support/config/factory_bot.rb
 - spec/support/config/pageflow_panorama.rb
 - spec/support/helpers/doubles.rb
 homepage: https://github.com/codevise/pageflow-panorama
@@ -254,10 +258,13 @@ signing_key:
 specification_version: 4
 summary: Pagetype for iframe embedded 360° panoramas
 test_files:
+- spec/factories/panorama_package.rb
 - spec/fixtures/dir_some.txt.zip
 - spec/fixtures/krpano.zip
 - spec/fixtures/krpano_with_unprocessable_thumbnail.zip
 - spec/fixtures/some.txt.zip
+- spec/helpers/pageflow/panorama/packages_helper_spec.rb
+- spec/integration/file_type_spec.rb
 - spec/integration/page_type_spec.rb
 - spec/models/pageflow/panorama/package_spec.rb
 - spec/pageflow/panorama/job_status_attributes_spec.rb
@@ -265,5 +272,6 @@ test_files:
 - spec/pageflow/panorama/validation/kr_pano_spec.rb
 - spec/spec_helper.rb
 - spec/support/config/active_job.rb
+- spec/support/config/factory_bot.rb
 - spec/support/config/pageflow_panorama.rb
 - spec/support/helpers/doubles.rb