paperclip-migrator 0.9.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paperclip-migrator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrew Eberbach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Paperclip::Migrator
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paperclip-migrator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperclip-migrator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/paperclip_migrate

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'paperclip-migrator'
+Paperclip::Migrator::Command.run(ARGV)

data/lib/paperclip-migrator.rb

@@ -0,0 +1,16 @@
+require "clamp"
+require "progressbar"
+require "highline"
+require "thor"
+require "paperclip"
+require "colored"
+require 'active_record'
+
+module Paperclip
+  module Migrator
+    autoload :AttachmentInstance, 'paperclip-migrator/attachment_instance'
+    autoload :Command, 'paperclip-migrator/command'
+    autoload :PaperclipMover, 'paperclip-migrator/paperclip_mover'
+    autoload :VERSION, 'paperclip-migrator/version'
+  end
+end

data/lib/paperclip-migrator/attachment_instance.rb

@@ -0,0 +1,31 @@
+module Paperclip
+  module Migrator
+    class AttachmentInstance
+      def initialize(instance, klass, attachment, old_layout, dry_run = true)
+        @dry_run = dry_run
+        @instance = instance
+        @klass = klass
+        @attachment = attachment
+        @old_layout = old_layout
+        @old_path = @instance.send(@attachment).send(:interpolate, @old_layout)
+      end
+
+      def migrate!
+        if File.exists?(@old_path)
+          if @dry_run
+            puts "Would be loading it from #{@old_path}".green
+          else
+            begin
+              @instance.send(:"#{@attachment}=", File.open(@old_path))
+              @instance.save!
+            rescue
+              raise "#{@klass.name} (##{@instance.id}) got an exception when saving #{@attachment} using #{@old_path}: #{$!}"
+            end
+          end
+        else
+          raise "#{@klass.name} (##{@instance.id}) can't find picture for #{@attachment} using #{@old_path}"
+        end
+      end
+    end
+  end
+end

data/lib/paperclip-migrator/command.rb

@@ -0,0 +1,120 @@
+module Paperclip
+  module Migrator
+    class Command < Clamp::Command
+      option ["-q", "--quiet"], :flag, "suppress output", :default => false
+      option ["-p", "--progress-bar"], :flag, "show a progress bar", :default => false
+      option ["-d", "--dry-run"], :flag, "dry run, don't actually do antying", :default => true
+
+      def execute
+        warn "This is a dry run, no changes will be made to the actual files." if dry_run?
+        begin
+          request_class.tap do |klass|
+            request_attachment(klass).tap do |attachment|
+              request_old_layout(klass, attachment).tap do |old_layout|
+                with_progress_bar(klass, attachment) do |progress_bar|
+                  PaperclipMover.new(klass, attachment, old_layout, dry_run?).each_attachment do |attachment_instance|
+                    begin
+                      attachment_instance.migrate!
+                    rescue
+                      complain($!)
+                    end
+                    progress_bar.try(:inc)
+                  end
+                end
+              end
+            end
+          end
+        rescue Interrupt
+          error "Control-C, Quitting"
+        rescue
+          error $!
+        end
+      end
+
+      private
+
+      def error(message)
+        puts message.to_s.red unless quiet?
+        exit 1
+      end
+
+      def complain(message)
+        puts message.to_s.red unless quiet?
+      end
+
+      def warn(message)
+        puts message.to_s.yellow unless quiet?
+      end
+
+      def say(message)
+        puts message.green unless quiet?
+      end
+
+      def request_class
+        PaperclipMover.candidate_classes.tap do |classes|
+          raise "No classes have paperclips" if classes.empty?
+          HighLine.new.choose do |menu|
+            menu.prompt = "Please choose your class:  "
+            classes.each do |klass|
+              menu.choice(klass.name) { return klass }
+            end
+          end
+        end
+      end
+
+      def request_attachment(klass)
+        attachments = PaperclipMover.attachment_keys_for(klass)
+
+        if attachments.size == 1
+          say "Using #{attachments.first} (it's the only one)"
+          return attachments.first
+        else
+          HighLine.new.choose do |menu|
+            menu.prompt = "Please choose your attachment:  "
+            attachments.each do |attachment|
+              menu.choice(attachment.to_s) { return attachment.to_sym }
+            end
+          end
+        end
+      end
+
+      def request_old_layout(klass, attachment)
+        auto_detected_layouts = PaperclipMover.auto_detected_layouts_for(klass, attachment)
+
+        HighLine.new.choose do |menu|
+          if auto_detected_layouts.empty?
+            menu.prompt = "Could not autodetect layout, please select: "
+          else
+            menu.prompt = "Please select layout: "
+          end
+
+          PaperclipMover::DEFAULT_LAYOUTS.each do |layout|
+            label = layout
+            if auto_detected_layouts.include?(layout)
+              label += " (autodetected)"
+              label = label.green
+            end
+            menu.choice(label) { layout }
+          end
+          menu.choice("Other") do
+            HighLine.new.ask("Enter the layout: ") do |q|
+              q.validate = PaperclipMover::SANTITY_CHECK
+              q.responses[:not_valid] = "That doesn't look like a Paperclip interpolated path."
+            end
+          end
+        end
+      end
+
+      def with_progress_bar(klass, attachment)
+        if quiet? || !progress_bar?
+          yield nil
+        else
+          ProgressBar.new("#{klass}##{attachment}", klass.count).tap do |pbar|
+            yield pbar
+            pbar.finish
+          end
+        end
+      end
+    end
+  end
+end

data/lib/paperclip-migrator/paperclip_mover.rb

@@ -0,0 +1,78 @@
+module Paperclip
+  module Migrator
+    class PaperclipMover
+      DEFAULT_LAYOUTS = [
+        ":rails_root/public/system/:attachment/:id/:style/:filename",
+        ":rails_root/public/system/:attachment/:id/:style/:basename.:extension",
+        ":rails_root/public/system/:class/:attachment/:id_partition/:style/:basename.:extension",
+        ":rails_root/public/system/:class/:attachment/:id_partition/:style/:filename",
+        Paperclip::Attachment.default_options[:path]
+      ].uniq
+
+      SANTITY_CHECK = /(:filename|:basename|:id)/
+
+      class << self
+        def auto_detected_layouts_for(klass, attachment)
+          [].tap do |auto_detected_layouts|
+            possible_attachments_for(klass, attachment).tap do |instances|
+              raise "no instances found" if instances.empty?
+              instances.each do |inst|
+                if inst.send(:"#{attachment}?")
+                  DEFAULT_LAYOUTS.detect do |layout|
+                    old_file_name = inst.send(attachment).send(:interpolate, layout)
+                    if File.exists?(old_file_name)
+                      auto_detected_layouts << layout unless auto_detected_layouts.include?(layout)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+
+        def root_dir
+          if defined?(Rails)
+            Rails.root
+          else
+            Dir.pwd
+          end
+        end
+
+        def possible_attachments_for(klass, attachment)
+          klass.find(:all, :order => "rand()", :limit => 100).select { |inst| inst.send(:"#{attachment}?") }
+        end
+
+        def attachment_keys_for(klass)
+          klass.attachment_definitions.keys.map(&:to_sym)
+        end
+
+        def candidate_classes
+          ActiveSupport::Autoload.eager_autoload! if defined?(ActiveSupport::Autoload)
+          if ActiveRecord::Base.respond_to?(:descendants)
+            ActiveRecord::Base.descendants
+          else
+            Object.subclasses_of(ActiveRecord::Base)
+          end.reject { |c| c.attachment_definitions.nil? }.sort { |a, b| a.name <=> b.name }
+        end
+      end
+
+      def initialize(klass, attachment, old_layout, dry_run = true)
+        if old_layout == Paperclip::Attachment.default_options[:path]
+          raise "we are already on this layout"
+        end
+
+        @klass = klass
+        @attachment = attachment
+        @old_layout = old_layout
+        @dry_run = dry_run
+      end
+
+      def each_attachment
+        @klass.all.tap { |collection| raise "No instances found" if collection.empty? }.each do |inst|
+          next unless inst.send(:"#{@attachment}?")
+          yield AttachmentInstance.new(inst, @klass, @attachment, @old_layout, @dry_run)
+        end
+      end
+    end
+  end
+end

data/lib/paperclip-migrator/version.rb

@@ -0,0 +1,5 @@
+module Paperclip
+  module Migrator
+    VERSION = "0.9.1"
+  end
+end

data/paperclip-migrator.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/paperclip-migrator/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Eberbach"]
+  gem.email         = ["andrew@ebertech.ca"]
+  gem.description   = %q{A gem that helps migrate paperclips to a different layout}
+  gem.summary       = %q{A gem that helps migrate paperclips to a different layout}
+  gem.homepage      = "https://github.com/ebertech/paperclip-migrator"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "paperclip-migrator"
+  gem.require_paths = ["lib"]
+  gem.version       = Paperclip::Migrator::VERSION
+  
+  gem.add_dependency 'activesupport'
+  gem.add_dependency "clamp"
+  gem.add_dependency "progressbar"
+  gem.add_dependency "highline"
+  gem.add_dependency "thor"
+  gem.add_dependency "paperclip"
+  gem.add_dependency "colored"
+
+  gem.add_development_dependency "rspec", ">= 2.0"
+  gem.add_development_dependency 'rails', "~> 2.3.14"
+end

data/spec/models/paperclip_mover_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Paperclip::Migrator::PaperclipMover do
+  describe "class methods" do
+    describe ".candidate_classes" do
+      subject { Paperclip::Migrator::PaperclipMover.candidate_classes }
+      it "be empty if there are no classes that have paperclips" do
+        should be_empty
+      end
+    end
+
+    describe ".root_dir" do
+      context "with Rails defined" do
+        before(:each) do
+          Rails = double("rails").tap do |double|
+            double.stub(:root) { "/some/path" }
+          end
+        end
+
+        it "should return the current Rails.root" do
+          Paperclip::Migrator::PaperclipMover.root_dir.should == Rails.root
+        end
+
+        after(:each) do
+          Object.instance_eval{remove_const(:Rails)}
+        end
+      end
+
+      context "without Rails defined" do
+        it "should return the current Rails.root" do
+          Paperclip::Migrator::PaperclipMover.root_dir.should == Dir.pwd
+        end
+      end
+    end
+  end
+
+  it "should raise an exception if we are trying to migrate to the current layout" do
+    expect do
+      Paperclip::Migrator::PaperclipMover.new(nil, nil, Paperclip::Attachment.default_options[:path])
+    end.to raise_exception RuntimeError, "we are already on this layout"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+ENV["RAILS_ENV"] = "test"
+
+require 'active_support/all'
+require File.expand_path("../../lib/paperclip-migrator", __FILE__)
+ActiveSupport::Deprecation.silenced = true
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification 
+name: paperclip-migrator
+version: !ruby/object:Gem::Version 
+  hash: 57
+  prerelease: 
+  segments: 
+  - 0
+  - 9
+  - 1
+  version: 0.9.1
+platform: ruby
+authors: 
+- Andrew Eberbach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: clamp
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: progressbar
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: paperclip
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: colored
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 3
+        - 14
+        version: 2.3.14
+  type: :development
+  version_requirements: *id009
+description: A gem that helps migrate paperclips to a different layout
+email: 
+- andrew@ebertech.ca
+executables: 
+- paperclip_migrate
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/paperclip_migrate
+- lib/paperclip-migrator.rb
+- lib/paperclip-migrator/attachment_instance.rb
+- lib/paperclip-migrator/command.rb
+- lib/paperclip-migrator/paperclip_mover.rb
+- lib/paperclip-migrator/version.rb
+- paperclip-migrator.gemspec
+- spec/models/paperclip_mover_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ebertech/paperclip-migrator
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: A gem that helps migrate paperclips to a different layout
+test_files: 
+- spec/models/paperclip_mover_spec.rb
+- spec/spec_helper.rb
+has_rdoc: