importable_attachments 0.0.13

data/bin/set_lc.sh

@@ -0,0 +1,47 @@
+# Pick one EVENT or SWIFTIPLY
+# To run a Rails app in evented mode (eventmachine gem)
+export EVENT=1
+
+# To run in swiftiplied mode (swiftiply gem)
+#export SWIFTIPLY=1
+
+# HACK: broken locales
+my_hosttype="${HOSTTYPE:='unknown_hosttype'}"
+my_kernel="${OSTYPE:='unknown_kernel'}"
+my_hosttype=$(uname -a)
+my_kernel=$(uname -s)
+
+if [ "${my_kernel}" != 'Darwin' ]; then
+ my_kernel="${my_kernel/SunOS/solaris}"
+fi
+
+# TODO: re-write my_osver detection to include major-minor-patch
+my_ostype="${my_kernel/Darwin*/darwin}"
+my_osver="${my_kernel/darwin/}"
+
+if [ "${my_ostype}" != 'darwin' ]; then
+  my_ostype="${my_kernel/Linux*/linux}"
+  if [ "${my_ostype}" != 'linux' ]; then
+    my_ostype="${my_kernel/-gnu/}"
+  fi
+  my_osver="${my_kernel/linux-/}"
+  if [ ${my_ostype} != 'linux' ]; then
+    my_ostype="${my_kernel/solaris*/solaris}"
+    my_osver="${my_kernel/solaris/}"
+  fi
+fi
+
+case "${my_ostype}" in
+'darwin' )
+  LC_CTYPE='en_US.UTF-8'; builtin export LC_CTYPE
+  LC_ALL='en_US.UTF-8'; builtin export LC_ALL # Mnt. Lion
+  ;;
+'linux' )
+  LANG='en_US.UTF-8'; builtin export LANG
+  LC_ALL='en_US.UTF-8'; builtin export LC_ALL
+  ;;
+* )
+  echo "Unsupported OS: ${my_ostype}"
+  ;;
+esac
+

data/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/config/features/attachments.rb

@@ -0,0 +1,8 @@
+Configuration.for('attachments') do
+  enabled true
+  include_revision_in_filename false
+  validate_on_import true
+  path ':rails_root/public/system/:rails_env/:style/:attachable_klass/:id_partition/:basename.:extension'
+  url %w(development test).include?(Rails.env) ? '/attachments/:id/download' : '/system/:rails_env/:style/:attachable_klass/:id_partition/:basename.:extension'
+end
+

data/config/features/mark_requirements.rb

@@ -0,0 +1,3 @@
+Configuration.for('mark_requirements') do
+  enabled true
+end

data/config/features/smarter_dates.rb

@@ -0,0 +1,3 @@
+Configuration.for('smarter_dates') do
+  enabled true
+end

data/config/features/versioning.rb

@@ -0,0 +1,7 @@
+Configuration.for('versioning') do
+  enabled true
+  validate_item_type_constants true
+  path ':rails_root/public/system/:rails_env/:style/:attachable_klass/:id_partition/:basename.:stream_version.:extension'
+  url %w(development test).include?(Rails.env) ? '/attachments/:id/download' : '/system/:rails_env/:style/:attachable_klass/:id_partition/:basename.:stream_version.:extension'
+end
+

data/config/initializers/0_configuration.rb

@@ -0,0 +1,7 @@
+Configuration.path = 'config/features'
+
+# load feature configurations
+features = Configuration.path.collect { |path| Dir.glob(File.join(path, '**')) }.flatten
+features.each do |feature|
+  Configuration.load feature
+end

data/config/initializers/formtastic.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+# Set the default text field size when input is a string. Default is nil.
+# Formtastic::FormBuilder.default_text_field_size = 50
+
+# Set the default text area height when input is a text. Default is 20.
+# Formtastic::FormBuilder.default_text_area_height = 5
+
+# Set the default text area width when input is a text. Default is nil.
+# Formtastic::FormBuilder.default_text_area_width = 50
+
+# Should all fields be considered "required" by default?
+# Defaults to true.
+# Formtastic::FormBuilder.all_fields_required_by_default = true
+
+# Should select fields have a blank option/prompt by default?
+# Defaults to true.
+# Formtastic::FormBuilder.include_blank_for_select_by_default = true
+
+# Set the string that will be appended to the labels/fieldsets which are required
+# It accepts string or procs and the default is a localized version of
+# '<abbr title="required">*</abbr>'. In other words, if you configure formtastic.required
+# in your locale, it will replace the abbr title properly. But if you don't want to use
+# abbr tag, you can simply give a string as below
+# Formtastic::FormBuilder.required_string = "(required)"
+
+# Set the string that will be appended to the labels/fieldsets which are optional
+# Defaults to an empty string ("") and also accepts procs (see required_string above)
+# Formtastic::FormBuilder.optional_string = "(optional)"
+
+# Set the way inline errors will be displayed.
+# Defaults to :sentence, valid options are :sentence, :list, :first and :none
+# Formtastic::FormBuilder.inline_errors = :sentence
+# Formtastic uses the following classes as default for hints, inline_errors and error list
+
+# If you override the class here, please ensure to override it in your stylesheets as well
+# Formtastic::FormBuilder.default_hint_class = "inline-hints"
+# Formtastic::FormBuilder.default_inline_error_class = "inline-errors"
+# Formtastic::FormBuilder.default_error_list_class = "errors"
+
+# Set the method to call on label text to transform or format it for human-friendly
+# reading when formtastic is used without object. Defaults to :humanize.
+# Formtastic::FormBuilder.label_str_method = :humanize
+
+# Set the array of methods to try calling on parent objects in :select and :radio inputs
+# for the text inside each @<option>@ tag or alongside each radio @<input>@. The first method
+# that is found on the object will be used.
+# Defaults to ["to_label", "display_name", "full_name", "name", "title", "username", "login", "value", "to_s"]
+# Formtastic::FormBuilder.collection_label_methods = [
+#   "to_label", "display_name", "full_name", "name", "title", "username", "login", "value", "to_s"]
+
+# Specifies if labels/hints for input fields automatically be looked up using I18n.
+# Default value: true. Overridden for specific fields by setting value to true,
+# i.e. :label => true, or :hint => true (or opposite depending on initialized value)
+# Formtastic::FormBuilder.i18n_lookups_by_default = false
+
+# Specifies if I18n lookups of the default I18n Localizer should be cached to improve performance.
+# Defaults to true.
+# Formtastic::FormBuilder.i18n_cache_lookups = false
+
+# Specifies the class to use for localization lookups. You can create your own
+# class and use it instead by subclassing Formtastic::Localizer (which is the default).
+# Formtastic::FormBuilder.i18n_localizer = MyOwnLocalizer
+
+# You can add custom inputs or override parts of Formtastic by subclassing Formtastic::FormBuilder and
+# specifying that class here.  Defaults to Formtastic::FormBuilder.
+# Formtastic::Helpers::FormHelper.builder = MyCustomBuilder
+
+# You can opt-in to Formtastic's use of the HTML5 `required` attribute on `<input>`, `<select>` 
+# and `<textarea>` tags by setting this to false (defaults to true).
+# Formtastic::FormBuilder.use_required_attribute = true
+
+# You can opt-in to new HTML5 browser validations (for things like email and url inputs) by setting
+# this to false. Doing so will add a `novalidate` attribute to the `<form>` tag.
+# See http://diveintohtml5.org/forms.html#validation for more info.
+# Formtastic::FormBuilder.perform_browser_validations = true

data/config/initializers/generators.rb

@@ -0,0 +1,10 @@
+Rails.application.config.generators do |g|
+  g.view_specs false
+  g.helper_specs false
+  g.test_framework :rspec
+  g.fixture_replacement :machinist
+  g.orm :active_record
+  g.template_engine :haml
+  g.stylesheet_engine :sass
+end
+

data/config/initializers/paperclip.rb

@@ -0,0 +1,27 @@
+Paperclip.interpolates :stream_version do |attachment, _|
+  attachment.instance.revision_number
+end
+
+Paperclip.interpolates :attachable_klass do |attachment, _|
+  attachable_type = attachment.instance.attachable_type
+  attachable_type && attachable_type.respond_to?(:tableize) ? attachable_type.tableize : '.'
+end
+
+Paperclip.interpolates :rails_env do |_, _|
+  Rails.env
+end
+
+# brew on darwin
+if File.directory?(File.join("", 'usr', 'local', 'bin'))
+  Paperclip.options[:command_path] = '/usr/local/bin'
+
+# macports on darwin
+elsif File.directory?(File.join("", 'opt', 'local', 'bin'))
+  Paperclip.options[:command_path] = '/opt/local/bin'
+
+# "disabled" macports due to brew on darwin
+elsif File.directory?(File.join("", 'opt', 'local.brew', 'bin'))
+  Paperclip.options[:command_path] = '/opt/local.brew/bin'
+else
+  raise RuntimeError, 'can not locate identify binary'
+end

data/config/locales/responders.en.yml

@@ -0,0 +1,10 @@
+en:
+  flash:
+    actions:
+      create:
+        notice: '%{resource_name} was successfully created.'
+      update:
+        notice: '%{resource_name} was successfully updated.'
+      destroy:
+        notice: '%{resource_name} was successfully destroyed.'
+        alert: '%{resource_name} could not be destroyed.'

data/config/routes.rb

@@ -0,0 +1,11 @@
+ImportableAttachments::Engine.routes.draw do
+  root to: 'attachments#index'
+  resources :versions
+  resources :attachments
+  match 'attachments/:id/download', action: :download, via: :get
+end
+
+Rails.application.routes.draw do
+  resources :attachments, controller: 'importable_attachments/attachments'
+  match 'attachments/:id/download', controller: 'importable_attachments/attachments', action: :download, via: :get
+end

data/db/migrate/001_create_importable_attachments_versions.rb

@@ -0,0 +1,14 @@
+class CreateImportableAttachmentsVersions < ActiveRecord::Migration
+  def change
+    create_table :importable_attachments_versions, force: true do |t|
+      t.string :item_type, null: false
+      t.string :item_id, null: false  # item_type.id generally should be GUID
+      t.string :event, null: false
+      t.string :whodunnit
+      t.text :object
+      t.datetime :created_at
+    end
+    add_index :importable_attachments_versions, [:item_type, :item_id]
+  end
+end
+

data/db/migrate/100_create_attachments.rb

@@ -0,0 +1,19 @@
+class CreateAttachments < ActiveRecord::Migration
+
+  # Store application specific data for attachments a.k.a. uploaded files
+  def change
+    create_table :importable_attachments_attachments, :force => true do |t|
+      t.string   :attachable_type
+      t.string   :attachable_id  # project might be using alpha-numeric IDs
+      t.string   :io_stream_file_name
+      t.string   :io_stream_content_type
+      t.integer  :io_stream_file_size, :limit => 8
+      t.datetime :io_stream_updated_at
+
+      t.timestamps
+    end
+    add_index :importable_attachments_attachments, [:attachable_type, :attachable_id], name: 'idx_importable_attachments_on_attachable_type_and_id'
+    add_index :importable_attachments_attachments, :io_stream_file_name
+  end
+end
+

data/importable_attachments.gemspec

@@ -0,0 +1,81 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'importable_attachments/version'
+#Bundler.require(:default, :development)
+
+REQUIREMENTS = {
+  runtime: {
+    :'haml-rails' => ['~> 0.4'],
+    paper_trail: ['~> 2.7.1'],
+    paperclip: ['~> 3.4.2'],
+    configuration: ['~> 1.3.2'],
+    smarter_dates: ['~> 0.2.12'],
+    :'ruby-filemagic' => ['~> 0.4.2'],
+    :'rspec-paper_trail' => ['~> 0.0.10'],
+    :'rails-mark_requirements' => ['~> 0.0.1'],
+    :'rails-alpha_numeric_validator' => ['~> 0.1.1'],
+    formtastic: ['~> 2.2.1'],
+    remotipart: ['~> 1.0.5'],
+    roo: ['~> 1.11.2'],
+    rails: ['~> 3.2.13'],
+    :'activerecord-import' => ['~> 0.3.1'],
+    :'coffee-script' => ['~> 2.2.0'],
+    :'coffee-rails' => ['~> 3.2.2'] }, # coffee-rails is needed for <= 3.0.x
+  development: {
+    bundler: ['~> 1.3.0'],
+    rake: ['>= 0'],
+    sqlite3: ['~> 1.3.7'],
+    debugger: ['~> 1.5.0'],
+    rspec: ['~> 2.13.0'],
+    mocha: ['~> 0.13.0'],
+    database_cleaner: ['~> 1.0.1'],
+    machinist: ['~> 2.0.0'],
+    :'rspec-rails' => ['~> 2.13.0'],
+    :'cucumber-rails' => ['~> 1.3.1'],
+    poltergeist: ['< 1.1.0'],
+    capybara: ['< 2.0.0'],
+    launchy: ['~> 2.3.0'],
+    valid_attribute: ['~> 1.3.1'] }
+}
+
+Gem::Specification.new do |spec|
+  spec.name          = 'importable_attachments'
+  spec.version       = ImportableAttachments::VERSION
+  spec.authors       = ['Paul Belt']
+  spec.email         = %w(saprb@channing.harvard.edu)
+  spec.description   = %q{Easier upload management for ActiveRecord}
+  spec.summary       = %q{upload, save-to-disk, attach-to-model_instance, importing}
+  spec.homepage      = 'https://github.com/belt/importable_attachments'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.requirements = %w(libmagic)
+  spec.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
+  spec.required_rubygems_version = Gem::Requirement.new('>= 0') if spec.respond_to? :required_rubygems_version=
+
+  [:runtime, :development].each do |mode|
+    REQUIREMENTS[mode].each do |req,ver|
+      if spec.respond_to? :specification_version
+        spec.specification_version = 3
+        if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0')
+          if mode == :runtime
+            spec.add_runtime_dependency req.to_s, ver
+          else
+            spec.add_development_dependency req.to_s, ver
+          end
+        else
+          spec.add_dependency req.to_s, ver
+        end
+      else
+        spec.add_dependency req.to_s, ver
+      end
+    end
+  end
+
+end

data/lib/generators/importable_attachments/install_generator.rb

@@ -0,0 +1,66 @@
+require 'rails/generators/active_record/migration'
+
+# :nodoc:
+module ImportableAttachments
+  # copies configuration file for configuration.gem
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+    class_option :with_string_ids, type: :boolean, default: true, desc: 'versions.type_id as string (vs integer)'
+
+    # paperclip-3.3.x seems to require this
+    # paperclip-3.4.x seems to have broken this
+    class_option :with_revision_in_filename, type: :boolean, default: false, desc: 'filename on system to include version-number'
+
+    class_option :'skip-migrations', type: :boolean, default: false, desc: 'do not generate migrations'
+    class_option :force, type: :boolean, default: false, desc: 'force generation migrations'
+
+    desc 'Runs rspec:paper_trail:install'
+
+    def generate_rspec_paper_trail_install
+      return if skip_migrations?
+      cli_opts = options.select { |key, val| val }.map { |key, val| val ? "--#{key}" : val.join(",") }
+      cmd = 'rspec:paper_trail:install ' + cli_opts.join(" ")
+      generate cmd
+    end
+
+    desc 'Generates updated rspec:paper_trail:install config'
+
+    def generate_updated_rspec_paper_trail_config
+      template 'features/versioning.rb', 'config/features/versioning.rb'
+    end
+
+    desc 'Runs smarter_dates:install'
+
+    def generate_smarter_dates_install
+      cli_opts = options.select { |key, val| val }.map { |key, val| val ? "--#{key}" : val.join(",") }
+      generate 'smarter_dates:install ' + cli_opts.join(" ")
+    end
+
+    desc 'Generates initialization files.'
+
+    def generate_configuration_files
+      template 'features/attachments.rb.erb', 'config/features/attachments.rb'
+      copy_file 'initializers/paperclip.rb', 'config/initializers/paperclip.rb'
+    end
+
+    desc 'Augments spec/spec_helper.rb for formtastic deployment'
+
+    def augment_spec_helper
+      insert_into_file 'config/environments/production.rb', '  config.assets.precompile += %w(ie6.css ie7.css)', after: "# config.assets.precompile += %w( search.js )\n"
+    end
+
+    private
+
+    def skip_migrations?
+      return true if options.send(:'skip-migrations')
+      false
+    end
+
+    def use_versioned_filename?
+      options.with_revision_in_filename?
+    end
+  end
+end

data/lib/generators/importable_attachments/templates/features/attachments.rb.erb

@@ -0,0 +1,7 @@
+Configuration.for('attachments') do
+  enabled true
+  include_revision_in_filename <%= use_versioned_filename? %>
+  path ":rails_root/public/system/:rails_env/:style/:attachable_klass/:id_partition/:basename.:extension"
+  url ['development', 'test'].include?(Rails.env) ? "/attachments/:id/download" : "/system/:rails_env/:style/:attachable_klass/:id_partition/:basename.:extension"
+end
+

data/lib/generators/importable_attachments/templates/features/versioning.rb

@@ -0,0 +1,7 @@
+Configuration.for('versioning') do
+  enabled true
+  validate_item_type_constants false
+  path ':rails_root/public/system/:rails_env/:style/:attachable_klass/:id_partition/:basename.:stream_version.:extension'
+  url %w(development test).include?(Rails.env) ? '/attachments/:id/download' : '/system/:rails_env/:style/:attachable_klass/:id_partition/:basename.:stream_version.:extension'
+end
+

data/lib/generators/importable_attachments/templates/initializers/paperclip.rb

@@ -0,0 +1,27 @@
+Paperclip.interpolates :stream_version do |attachment, _|
+  attachment.instance.revision_number
+end
+
+Paperclip.interpolates :attachable_klass do |attachment, _|
+  attachable_type = attachment.instance.attachable_type
+  attachable_type && attachable_type.respond_to?(:tableize) ? attachable_type.tableize : '.'
+end
+
+Paperclip.interpolates :rails_env do |_, _|
+  Rails.env
+end
+
+# brew on darwin
+if File.directory?(File.join("", 'usr', 'local', 'bin'))
+  Paperclip.options[:command_path] = '/usr/local/bin'
+
+# macports on darwin
+elsif File.directory?(File.join("", 'opt', 'local', 'bin'))
+  Paperclip.options[:command_path] = '/opt/local/bin'
+
+# "disabled" macports due to brew on darwin
+elsif File.directory?(File.join("", 'opt', 'local.brew', 'bin'))
+  Paperclip.options[:command_path] = '/opt/local.brew/bin'
+else
+  raise RuntimeError, 'can not locate identify binary'
+end

data/lib/importable_attachments/base.rb

@@ -0,0 +1,108 @@
+module ImportableAttachments::Base
+  module ClassMethods
+
+    # :call-seq:
+    # has_importable_attachment opts
+    #
+    # = opts
+    #   :import_method
+    #   :import_into
+    #   :spreadsheet_columns
+
+    def has_importable_attachment(options)
+      lopt = {import_method: :import_rows}
+      lopt.merge! options
+
+      validate_importable_attachment_options lopt
+      install_importable_attachment_options lopt
+      install_importable_attachment_associations
+      install_importable_attachment_validations
+      install_importable_attachment_assignment_protection
+
+      include InstanceMethods
+
+      # for assigning attachment to new record
+      after_create :import_attachment
+    end
+
+    def validate_importable_attachment_options(options)
+      [:spreadsheet_columns, :import_into].each do |sym|
+        raise RuntimeError, "has_importable_attachment: needs :#{sym}" unless options.has_key? sym
+      end
+
+      unless options[:spreadsheet_columns].is_a?(Enumerable)
+        raise RuntimeError, 'has_importable_attachment: :spreadsheet_columns must be Enumerable'
+      end
+    end
+
+    def install_importable_attachment_options(options)
+      [:import_method, :import_into, :spreadsheet_columns].each do |sym|
+        cattr_accessor sym
+        self.send("#{sym}=".to_sym, options[sym])
+      end
+    end
+
+    def install_importable_attachment_associations
+      has_one :attachment, :dependent => :nullify, :as => :attachable
+      delegate :io_stream, :to => :attachment, :prefix => true
+      delegate :io_stream_url, :to => :attachment, :prefix => true
+      delegate :io_stream_file_name, :to => :attachment, :prefix => true
+    end
+
+    def install_importable_attachment_validations
+      validates :attachment, :associated => true
+      validate do |record|
+        if @columns_not_found
+          invalid_attachment_error "column(s) not found: #{@columns_not_found}"
+        end
+        if !@row_errors.blank?
+          invalid_attachment_error "failed to import #{@row_errors.length} record(s)"
+          @row_errors.each {|row| attachment.errors.add(:base, row)}
+        end
+      end
+
+      # These go in the class calling has_importable_attachment as they are
+      # dependent on mime-type expectations
+      #validates_with CsvValidator, :if => Proc.new {|model| model.attachment.present?}
+      #validates_with ExcelValidator, :if => Proc.new {|model| model.attachment.present?}
+    end
+
+    def install_importable_attachment_assignment_protection
+      attr_accessible :attachment, :attachment_attributes, :attachment_id
+      accepts_nested_attributes_for :attachment, :allow_destroy => true,
+        :reject_if => :all_blank
+    end
+  end
+
+  module InstanceMethods
+    # : call-seq:
+    # import_attachment
+    #
+    # imports an attachment of a given mime-type (data-stream to ruby),
+    # calls import_rows with a ruby data-store
+    #
+    # NOTE: this is a stub
+
+    def import_attachment
+      raise RuntimeError, '[importable_attachments] .import_attachment not implemented'
+    end
+
+    # : call-seq:
+    # import_rows params
+    #
+    # imports an attachment contents into :import_into association
+    #
+    # NOTE: this is a stub
+
+    def import_rows(*opts)
+      return unless self.attachment
+      logger.debug "[importable_attachments] .import_rows #{opts}"
+      raise RuntimeError, '[importable_attachments] .import_rows not implemented'
+    end
+
+    def invalid_attachment_error(msg)
+      attachment.errors.add(:base, msg)
+      errors.add(:attachment, 'invalid attachment')
+    end
+  end
+end

data/lib/importable_attachments/blueprints.rb

@@ -0,0 +1,9 @@
+require 'machinist/active_record'
+
+ImportableAttachments::Attachment.blueprint do
+  io_stream { File.new Rails.root.join('spec', 'attachments', 'mostly_empty_copy.xls') }
+end
+
+Version.blueprint do
+end
+

data/lib/importable_attachments/engine.rb

@@ -0,0 +1,8 @@
+require 'configuration'
+require 'rails/alpha_numeric_validator'
+
+module ImportableAttachments
+  class Engine < ::Rails::Engine
+    isolate_namespace ImportableAttachments
+  end
+end