importable_attachments 0.0.13

data/spec/dummy/features/support/env.rb

@@ -0,0 +1,53 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+require 'rubygems'
+
+if defined?(IRB) && IRB.class.to_s == 'Class'
+  Object.send(:remove_const, :IRB)
+  require 'IRB'
+  require 'IRB/init'
+  require 'IRB/context'
+  require 'IRB/extend-command'
+  require 'IRB/locale'
+end
+
+begin
+  ; require 'ruby-debug'
+rescue LoadError => err;
+  puts err;
+end
+
+begin
+  ; require 'pry'
+  if defined?(IRB) && IRB.class.to_s == 'Module'
+    Object.send(:remove_const, :IRB)
+    IRB = Pry
+  end
+rescue LoadError => err;
+end
+
+require 'cucumber/rails'
+
+# By default, any exception happening in your Rails application will bubble up
+# to Cucumber so that your scenario will fail. This is a different from how
+# your application behaves in the production environment, where an error page will
+# be rendered instead.
+#
+# Sometimes we want to override this default behaviour and allow Rails to rescue
+# exceptions and display an error page (just like when the app is running in production).
+# Typical scenarios where you want to do this is when you test your error pages.
+# There are two ways to allow Rails to rescue exceptions:
+#
+# 1) Tag your scenario (or feature) with @allow-rescue
+#
+# 2) Set the value below to true. Beware that doing this globally is not
+# recommended as it will mask a lot of errors for you!
+#
+ActionController::Base.allow_rescue = false
+
+require 'cucumber/rails/world'
+

data/spec/dummy/features/support/paths.rb

@@ -0,0 +1,33 @@
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in web_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+
+    when /^the home\s?page$/
+      '/'
+
+      # Add more mappings here.
+      # Here is an example that pulls values out of the Regexp:
+      #
+      #   when /^(.*)'s profile page$/i
+      #     user_profile_path(User.find_by_login($1))
+
+    else
+      begin
+        page_name =~ /^the (.*) page$/
+        path_components = $1.split(/\s+/)
+        self.send(path_components.push('path').join('_').to_sym)
+      rescue NoMethodError, ArgumentError
+        raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+          "Now, go and add a mapping in #{__FILE__}"
+      end
+    end
+  end
+end
+
+World(NavigationHelpers)

data/spec/dummy/features/support/poltergeist.rb

@@ -0,0 +1 @@
+Capybara.javascript_driver = :poltergeist

data/spec/dummy/features/support/selectors.rb

@@ -0,0 +1,39 @@
+module HtmlSelectorsHelpers
+  # Maps a name to a selector. Used primarily by the
+  #
+  #   When /^(.+) within (.+)$/ do |step, scope|
+  #
+  # step definitions in web_steps.rb
+  #
+  def selector_for(locator)
+    case locator
+
+    when "the page"
+      "html > body"
+
+      # Add more mappings here.
+      # Here is an example that pulls values out of the Regexp:
+      #
+      #  when /^the (notice|error|info) flash$/
+      #    ".flash.#{$1}"
+
+      # You can also return an array to use a different selector
+      # type, like:
+      #
+      #  when /the header/
+      #    [:xpath, "//header"]
+
+      # This allows you to provide a quoted selector as the scope
+      # for "within" steps as was previously the default for the
+      # web steps:
+    when /^"(.+)"$/
+      $1
+
+    else
+      raise "Can't find mapping from \"#{locator}\" to a selector.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(HtmlSelectorsHelpers)

data/spec/dummy/features/support/transactional_fixtures.rb

@@ -0,0 +1,14 @@
+# If you set this to true, each scenario will run in a database transaction.
+# You can still turn off transactions on a per-scenario basis, simply tagging
+# a feature or scenario with the @no-txn tag. If you are using Capybara,
+# tagging with @culerity or @javascript will also turn transactions off.
+#
+# If you set this to false, transactions will be off for all scenarios,
+# regardless of whether you use @no-txn or not.
+#
+# Beware that turning transactions off will leave data in your database
+# after each scenario, which can lead to hard-to-debug failures in
+# subsequent scenarios. If you do this, we recommend you create a Before
+# block that will explicitly put your database in a known state.
+Cucumber::Rails::World.use_transactional_fixtures = true
+

data/spec/dummy/public/404.html

@@ -0,0 +1,38 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body {
+      background-color: #fff;
+      color:            #666;
+      text-align:       center;
+      font-family:      arial, sans-serif;
+    }
+
+    div.dialog {
+      width:               25em;
+      padding:             0 4em;
+      margin:              4em auto 0 auto;
+      border:              1px solid #ccc;
+      border-right-color:  #999;
+      border-bottom-color: #999;
+    }
+
+    h1 {
+      font-size:   100%;
+      color:       #f00;
+      line-height: 1.5em;
+    }
+  </style>
+</head>
+
+<body>
+<!-- This file lives in public/404.html -->
+<div class="dialog">
+  <h1>The page you were looking for doesn't exist.</h1>
+
+  <p>You may have mistyped the address or the page may have moved.</p>
+</div>
+</body>
+</html>

data/spec/dummy/public/422.html

@@ -0,0 +1,38 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body {
+      background-color: #fff;
+      color:            #666;
+      text-align:       center;
+      font-family:      arial, sans-serif;
+    }
+
+    div.dialog {
+      width:               25em;
+      padding:             0 4em;
+      margin:              4em auto 0 auto;
+      border:              1px solid #ccc;
+      border-right-color:  #999;
+      border-bottom-color: #999;
+    }
+
+    h1 {
+      font-size:   100%;
+      color:       #f00;
+      line-height: 1.5em;
+    }
+  </style>
+</head>
+
+<body>
+<!-- This file lives in public/422.html -->
+<div class="dialog">
+  <h1>The change you wanted was rejected.</h1>
+
+  <p>Maybe you tried to change something you didn't have access to.</p>
+</div>
+</body>
+</html>

data/spec/dummy/public/500.html

@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body {
+      background-color: #fff;
+      color:            #666;
+      text-align:       center;
+      font-family:      arial, sans-serif;
+    }
+
+    div.dialog {
+      width:               25em;
+      padding:             0 4em;
+      margin:              4em auto 0 auto;
+      border:              1px solid #ccc;
+      border-right-color:  #999;
+      border-bottom-color: #999;
+    }
+
+    h1 {
+      font-size:   100%;
+      color:       #f00;
+      line-height: 1.5em;
+    }
+  </style>
+</head>
+
+<body>
+<!-- This file lives in public/500.html -->
+<div class="dialog">
+  <h1>We're sorry, but something went wrong.</h1>
+</div>
+</body>
+</html>

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require File.expand_path('../../config/boot', __FILE__)
+require 'rails/commands'

data/spec/dummy/spec/support/paperclip.rb

@@ -0,0 +1 @@
+require 'paperclip/matchers'

data/spec/models/importable_attachments/attachment_spec.rb

@@ -0,0 +1,177 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe ImportableAttachments::Attachment do
+  # :call-seq:
+  # mock_io_stream [:opts]
+  #
+  # yields a mock Paperclip::Attachment object
+
+  def mock_io_stream(opts = {})
+    attached_to = opts[:attach_to]
+    @io_stream = Paperclip::Attachment.new(:io_stream, attached_to,
+      {path: ::Configuration.for('attachments').path,
+        preserve_files: true, processors: [:save_upload]})
+    spec_dir = File.dirname(@io_stream.path).sub(/(?:\/\.?)?$/, "")
+    FileUtils.mkdir_p spec_dir unless File.directory? spec_dir
+    @io_stream
+  end
+
+  # :call-seq:
+  # mock_attachment [:opts]
+  #
+  # yields a mock Attachment object
+
+  def mock_attachment(opts = {})
+    lopts = {id: 27,
+      io_stream: nil,
+      io_stream_file_name: 'mostly_empty.csv',
+      io_stream_content_type: 'Test Content Type',
+      io_stream_file_size: 1,
+      io_stream_updated_at: DateTime.now,
+      revision_number: 1,
+      attachable_type: nil, attachable_id: nil, version: 1}
+    @attachment = mock_model(ImportableAttachments::Attachment, lopts.merge(opts))
+    @attachment.stubs(:io_stream).returns(mock_io_stream(:attach_to => @attachment))
+    FileUtils.cp @spec_file, @attachment.io_stream.path
+    @attachment
+  end
+
+  before :each do
+    #ActiveRecord::Base.send(:subclasses).each{|m|m.destroy_all}
+    @spec_file = Rails.root.join('spec', 'attachments', 'mostly_empty.csv')
+
+    mock_attachment
+    #Attachment.stubs(:find).with(@attachment.id.to_s).returns(@attachment)
+  end
+
+  context 'validations' do
+    it { should have_valid(:attachable_id).when(nil, 1, 2^64-1) }
+    it { should_not have_valid(:attachable_id).when(-1, 1.1) }
+
+    it { should have_valid(:attachable_type).when(nil, 'ImportableAttachments::Attachment') }
+    it { should_not have_valid(:attachable_type).when("Test \x0 data") }
+
+    it { should have_valid(:io_stream_file_name).when('Test data') }
+    it { should_not have_valid(:io_stream_file_name).when(nil, "Test \x0 data") }
+
+    it { should have_valid(:io_stream_content_type).when('Test data') }
+    it { should_not have_valid(:io_stream_content_type).when(nil, "Test \x0 data") }
+
+    it { should have_valid(:io_stream_updated_at).when(nil, Date.today) }
+    #it { should_not have_valid(:io_stream_updated_at).when("Test \x0 data") }
+
+    it 'should ensure the attachment exists' do
+      should validate_attachment_presence(:io_stream)
+    end
+
+    it 'should ensure the attachment is non-empty' do
+      should validate_attachment_size(:io_stream).greater_than(0)
+    end
+
+    it 'should require an :io_stream_file_name' do
+      attachment = ImportableAttachments::Attachment.new :io_stream => File.new(@spec_file, 'rb')
+      attachment.io_stream_file_name = nil
+      attachment.should_not be_valid
+      attachment.should have(1).error_on(:io_stream_file_name)
+    end
+
+    it 'should not allow odd characters in :io_stream_file_name' do
+      attachment = ImportableAttachments::Attachment.new :io_stream => File.new(@spec_file, 'rb')
+      attachment.io_stream_file_name = "file_path\b\b\b\b\bpath"
+      attachment.should_not be_valid
+      attachment.should have(1).error_on(:io_stream_file_name)
+    end
+  end
+
+  context 'expected behavior:' do
+    it 'should provide an :io_stream_content_type' do
+      attachment = ImportableAttachments::Attachment.new :io_stream => File.new(@spec_file, 'rb')
+      attachment.should be_valid
+    end
+
+    it 'should save the file to the filesystem' do
+      attachment = ImportableAttachments::Attachment.new :io_stream => File.new(@spec_file, 'rb')
+      attachment.save!
+      File.exist?(attachment.io_stream.path).should be_true
+    end
+
+    it 'should identify an unsaved file as nil' do
+      attachment = ImportableAttachments::Attachment.new :io_stream => File.new(@spec_file, 'rb')
+      attachment.magic_mime_type.should be_nil
+    end
+
+    it 'should identify the file mime_type as CSV' do
+      attachment = ImportableAttachments::Attachment.create! :io_stream => File.new(@spec_file, 'rb')
+      attachment.magic_mime_type.should == 'text/plain'
+      attachment.io_stream.content_type.should == 'text/csv'
+    end
+
+    it 'should provide an :io_stream_mime_type' do
+      attachment = ImportableAttachments::Attachment.new :io_stream => File.new(@spec_file, 'rb')
+      attachment.io_stream_mime_type.should be_a(MIME::Type)
+    end
+
+    it 'should save multiple versions of the file to the filesystem' do
+      with_versioning do
+        spec_file = Rails.root.join('spec', 'attachments', 'mostly_empty.csv')
+        attachment1 = ImportableAttachments::Attachment.new :io_stream => File.new(spec_file, 'rb')
+        attachment1.save!
+        File.exist?(attachment1.io_stream.path).should be_true
+        if ::Configuration.for('attachments').include_revision_in_filename
+          attachment1.io_stream.path.should match /mostly_empty\.1\.csv$/
+        else
+          attachment1.io_stream.path.should match /mostly_empty\.csv$/
+        end
+
+        #attachment1.io_stream = File.new(@spec_file,'rb')
+        ImportableAttachments::Attachment.stubs(:find).with(attachment1.id).returns(attachment1)
+        attachment2 = ImportableAttachments::Attachment.find(attachment1.id)
+        spec_file = Rails.root.join('spec', 'attachments', 'mostly_empty.csv')
+        attachment2.update_attributes :io_stream => File.new(spec_file, 'rb')
+        File.exist?(attachment2.io_stream.path).should be_true
+        if ::Configuration.for('attachments').include_revision_in_filename
+          attachment2.io_stream.path.should match /mostly_empty\.2\.csv$/
+        else
+          attachment1.io_stream.path.should match /mostly_empty\.csv$/
+        end
+      end
+    end
+
+    it 'should yield a revision_number' do
+      with_versioning do
+        spec_file = Rails.root.join('spec', 'attachments', 'mostly_empty.csv')
+        attachment1 = ImportableAttachments::Attachment.new :io_stream => File.new(spec_file, 'rb')
+        attachment1.save!
+        attachment1.revision_number.should == 1
+
+        #attachment1.io_stream = File.new(@spec_file,'rb')
+        ImportableAttachments::Attachment.stubs(:find).with(attachment1.id).returns(attachment1)
+        attachment2 = ImportableAttachments::Attachment.find(attachment1.id)
+        spec_file = Rails.root.join('spec', 'attachments', 'mostly_empty_copy.xls')
+        attachment2.update_attributes :io_stream => File.new(spec_file, 'rb')
+        attachment2.revision_number.should == 2
+      end
+    end
+  end
+end
+
+# == Schema Information
+#
+# Table name: attachments
+#
+#  id                     :integer          not null, primary key
+#  attachable_type        :string(255)
+#  attachable_id          :string(255)
+#  io_stream_file_name    :string(255)
+#  io_stream_content_type :string(255)
+#  io_stream_file_size    :integer
+#  io_stream_updated_at   :datetime
+#  created_at             :datetime         not null
+#  updated_at             :datetime         not null
+#
+# Indexes
+#
+#  idx_importable_attachments_on_attachable_type_and_id  (attachable_type,attachable_id)
+#  index_attachments_on_io_stream_file_name              (io_stream_file_name)
+#
+

data/spec/models/importable_attachments/library_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+def spec_file(file_name)
+  Rails.root.join('spec', 'attachments', file_name)
+end
+
+describe Library do
+  before :each do
+    @spec_file = spec_file('books.csv')
+  end
+
+  context 'attachment validations' do
+    subject { Library.create(name: 'XYZ Library', address: '123 Main St.') }
+    it { subject.should have_valid(:attachment).when(nil, Attachment.new(io_stream: File.new(@spec_file))) }
+    it {
+      subject.should_not have_valid(:attachment).when(Attachment.new io_stream: File.new(Rails.root.join('spec', 'attachments', 'books.txt'))) }
+  end
+
+  context 'importing attachments' do
+    before :each do
+      @attachment = Attachment.new io_stream: File.new(@spec_file, 'rb')
+    end
+
+    subject { Library.create(name: 'XYZ Library', address: '123 Main St.') }
+
+    context 'in the right format' do
+      it 'should optionally allow an attachment' do
+        subject.attachment = @attachment
+        subject.attachment.should_not be_nil
+        subject.attachment.attachable_type.should == 'Library'
+        subject.attachment.io_stream_file_name.should == File.basename(@spec_file)
+      end
+
+      it 'should import a spreadsheet if it is in the right format' do
+        subject.books.should be_empty
+        lambda {
+          subject.attachment = @attachment
+        }.should change(subject.books, :count).by(5)
+      end
+    end
+
+    context 'wrong extension' do
+      before :each do
+        @spec_file = spec_file('books.txt')
+      end
+
+      it 'should not import a spreadsheet if it has the wrong extension' do
+        attachment = Attachment.new io_stream: File.new(@spec_file, 'rb')
+        subject.attachment = attachment
+        subject.should_not be_valid
+      end
+
+      it 'should not delete existing data if new upload has the wrong extension' do
+        subject.attachment = @attachment
+        attachment = Attachment.new io_stream: File.new(@spec_file, 'rb')
+        lambda {
+          subject.attachment = attachment
+        }.should_not change(subject.books, :count)
+      end
+
+      it 'should not register / acknowledge the file is still in the system' do
+        subject.attachment = @attachment
+        attachment = Attachment.new io_stream: File.new(@spec_file, 'rb')
+        lambda {
+          subject.attachment = attachment
+        }.should_not change(subject.attachment, :io_stream_file_name)
+      end
+    end
+
+    context 'invalid headers' do
+      before :each do
+        @spec_file = spec_file('invalid_headers.csv')
+      end
+
+      it 'should not import a spreadsheet if it has invalid headers' do
+        attachment = Attachment.new io_stream: File.new(@spec_file, 'rb')
+        subject.attachment = attachment
+        subject.should_not be_valid
+      end
+
+      it 'should not delete existing data if new upload has invalid headers' do
+        subject.attachment = @attachment
+        attachment = Attachment.new io_stream: File.new(@spec_file, 'rb')
+        lambda {
+          subject.attachment = attachment
+        }.should_not change(subject.books, :count)
+      end
+
+      it 'should not register / acknowledge the file is still in the system' do
+        subject.attachment = @attachment
+        attachment = Attachment.new io_stream: File.new(@spec_file, 'rb')
+        lambda {
+          subject.attachment = attachment
+        }.should_not change(subject.attachment, :io_stream_file_name)
+      end
+    end
+
+    context 'failed instances' do
+      before :each do
+        @spec_file = spec_file('failed_instances.csv')
+      end
+
+      it 'should not import a spreadsheet if it has failed instances' do
+        attachment = Attachment.new io_stream: File.new(@spec_file, 'rb')
+        subject.attachment = attachment
+        subject.should_not be_valid
+      end
+
+      it 'should not delete existing data if new upload has failed instances' do
+        subject.attachment = @attachment
+        attachment = Attachment.new io_stream: File.new(@spec_file, 'rb')
+        lambda {
+          subject.attachment = attachment
+        }.should_not change(subject.books, :count)
+      end
+
+      it 'should not register / acknowledge the file is still in the system' do
+        subject.attachment = @attachment
+        attachment = Attachment.new io_stream: File.new(@spec_file, 'rb')
+        lambda {
+          subject.attachment = attachment
+        }.should_not change(subject.attachment, :io_stream_file_name)
+      end
+    end
+
+    context 'updating when an attachment already exists with destructive import' do
+      it 'should delete the rows from old file and replace them with rows from new file' do
+        subject.attachment = @attachment
+        attachment = Attachment.new io_stream: File.new(spec_file('books2.csv'), 'rb')
+        lambda {
+          subject.attachment = attachment
+        }.should change(subject.books, :count).by(-2)
+      end
+    end
+
+    context 'assigning attachment to new record' do
+      subject { Library.new(name: 'XYZ Library', address: '123 Main St.') }
+
+      it 'should not import when the record is not persisted' do
+        lambda {
+          subject.attachment = @attachment
+        }.should_not change(subject.books, :count)
+      end
+
+      it 'should import upon saving the record' do
+        lambda {
+          subject.attachment = @attachment
+          subject.save
+        }.should change(subject.books, :count).by(5)
+      end
+    end
+  end
+
+end
+

data/spec/models/importable_attachments/version_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe ImportableAttachments::Version do
+  # :call-seq:
+  # mock_version [:opts]
+  #
+  # yields a mock Version object
+
+  def mock_version(opts = {})
+    lopts = {:id => 27, :item_type => nil, :item_id => nil}
+    @version = mock_model(Version, lopts.merge(opts))
+    @version
+  end
+
+  before :each do
+    mock_version
+  end
+
+  context 'validations' do
+    it { should have_valid(:item_id).when(nil, 1, 'uniqueId', 'unique_id', 'unique.id') }
+
+    it { should have_valid(:item_type).when(nil, 'Attachment', 'ImportableAttachments::Attachment') }
+    it { should_not have_valid(:item_type).when("Test \x0 data") }
+  end
+end

data/spec/routing/importable_attachments/versions_routing_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module ImportableAttachments
+  describe VersionsController do
+    context 'routing' do
+
+      before :each do
+        @routes = ::ImportableAttachments::Engine.routes
+
+        # https://github.com/rspec/rspec-rails/pull/539
+        assertion_instance.instance_variable_set(:@routes, ::ImportableAttachments::Engine.routes)
+      end
+
+      it 'routes to #index' do
+        get('/versions').should route_to('importable_attachments/versions#index')
+      end
+
+      it 'routes to #new' do
+        get('/versions/new').should route_to('importable_attachments/versions#new')
+      end
+
+      it 'routes to #show' do
+        get('/versions/1').should route_to('importable_attachments/versions#show', :id => '1')
+      end
+
+      it 'routes to #edit' do
+        get('/versions/1/edit').should route_to('importable_attachments/versions#edit', :id => '1')
+      end
+
+      it 'routes to #create' do
+        post('/versions').should route_to('importable_attachments/versions#create')
+      end
+
+      it 'routes to #update' do
+        put('/versions/1').should route_to('importable_attachments/versions#update', :id => '1')
+      end
+
+      it 'routes to #destroy' do
+        delete('/versions/1').should route_to('importable_attachments/versions#destroy', :id => '1')
+      end
+    end
+  end
+end