sprig-reap 0.0.5 → 0.0.6

data/lib/sprig/reap/association.rb

@@ -2,12 +2,14 @@ module Sprig::Reap
   class Association
     attr_reader :association
 
+    delegate :foreign_key, :to => :association
+
     def initialize(association)
       @association = association
     end
 
     def klass
-      name.to_s.classify.constantize
+      polymorphic? ? nil : association.klass
     end
 
     def name
@@ -33,13 +35,8 @@ module Sprig::Reap
       polymorphic? ? polymorphic_dependencies : Array(klass)
     end
 
-    def foreign_key
-      association.options[:foreign_key] || name.to_s + '_id'
-    end
-
     def polymorphic_type
-      name.to_s + '_type'
+      polymorphic? ? association.foreign_type : nil
     end
-
   end
 end

data/lib/sprig/reap/file_attribute.rb

@@ -0,0 +1,82 @@
+module Sprig::Reap
+  class FileAttribute
+    attr_reader :input
+
+    def initialize(input)
+      @input = input
+    end
+
+    def file
+      local_file if file?
+    end
+
+    def file?
+      input.is_a? CarrierWave::Uploader::Base
+    end
+
+    def existing_location
+      begin
+        input.url if input.url.present? && open(input.url).is_a?(Tempfile)
+      rescue
+        input.path
+      end
+    end
+
+    def filename
+      File.basename(existing_location)
+    end
+
+    def target_folder
+      @target_folder ||= begin
+        path = Rails.root.join('db', 'seeds', Sprig::Reap.target_env, 'files')
+        FileUtils.mkdir_p(path)
+        path
+      end
+    end
+
+    def target_location
+      target_folder.join(filename)
+    end
+
+    def local_file
+      @local_file ||= LocalFile.new(existing_location, target_location)
+    end
+
+    private
+
+    class LocalFile < Struct.new(:uri, :target_location)
+      delegate :path, :size, :to => :file
+
+      def file
+        @file ||= File.open(unique_location, 'w', :encoding => encoding).tap do |file|
+          io.rewind
+          file.write(io.read)
+          io.close
+        end
+      end
+
+      def io
+        @io ||= open uri
+      end
+
+      def sprig_location
+        "<%= sprig_file('#{File.basename(file.path)}') %>"
+      end
+
+      private
+
+      def unique_location
+        File.exist?(target_location) ? target_location.to_s.gsub(basename, basename + SecureRandom::uuid.to_s) : target_location
+      end
+
+      def encoding
+        io.rewind
+        io.read.encoding
+      end
+
+      def basename
+        @basename ||= File.basename(target_location).gsub(File.extname(target_location), '')
+      end
+    end
+  end
+end

data/lib/sprig/reap/record.rb

@@ -30,11 +30,11 @@ module Sprig::Reap
       if dependency?(attr)
         klass    = klass_for(attr)
         id       = record.send(attr)
-        sprig_id = Model.find(klass, id).sprig_id
+        sprig_id = Model.find(klass, id).try(:sprig_id)
 
         sprig_record(klass, sprig_id)
       else
-        record.send(attr)
+        read_attribute attr
       end
     end
 
@@ -57,7 +57,15 @@ module Sprig::Reap
     end
 
     def sprig_record(klass, sprig_id)
+      return if sprig_id.nil?
+
       "<%= sprig_record(#{klass}, #{sprig_id}).id %>"
     end
+
+    def read_attribute(attr)
+      file_attr = FileAttribute.new(record.send(attr))
+
+      file_attr.file.try(:sprig_location) || record.read_attribute(attr)
+    end
   end
 end

data/lib/sprig/reap/version.rb

@@ -1,5 +1,5 @@
 module Sprig
   module Reap
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/sprig/reap.rb

@@ -8,6 +8,7 @@ module Sprig::Reap
   autoload :Association,   'sprig/reap/association'
   autoload :Record,        'sprig/reap/record'
   autoload :SeedFile,      'sprig/reap/seed_file'
+  autoload :FileAttribute, 'sprig/reap/file_attribute'
 
   class << self
     def reap(input = {})

data/spec/fixtures/models/post.rb

@@ -2,4 +2,12 @@ class Post < ActiveRecord::Base
   belongs_to :poster, :class_name => "User"
 
   has_many :votes, :as => :votable
+
+  def title
+    WrappedAttribute.new(self[:title])
+  end
+
+  private
+
+  WrappedAttribute = Struct.new(:value)
 end

data/spec/fixtures/models/user.rb

@@ -1,3 +1,7 @@
+require './spec/fixtures/uploaders/avatar_uploader'
+
 class User < ActiveRecord::Base
   validates :first_name, :last_name, :presence => true
+
+  mount_uploader :avatar, AvatarUploader
 end

data/spec/fixtures/uploaders/avatar_uploader.rb

@@ -0,0 +1,3 @@
+class AvatarUploader < CarrierWave::Uploader::Base
+  storage :file
+end

data/spec/lib/sprig/reap/association_spec.rb

@@ -36,6 +36,12 @@ describe Sprig::Reap::Association do
 
       its(:klass) { should == User }
     end
+
+    context "given a polymorphic association" do
+      subject { described_class.new(polymorphic_association) }
+
+      its(:klass) { should == nil }
+    end
   end
 
   describe "#polymorphic_dependencies" do
@@ -72,15 +78,49 @@ describe Sprig::Reap::Association do
 
   describe "#dependencies" do
     context "when the association is polymorphic" do
-      subject { described_class.new(standard_association) }
+      subject { described_class.new(polymorphic_association) }
 
       its(:dependencies) { should == [Post] }
     end
 
     context "when the association is not polymorphic" do
-      subject { described_class.new(polymorphic_association) }
+      subject { described_class.new(standard_association) }
 
       its(:dependencies) { should == [Post] }
     end
   end
+
+  describe "#foreign_key" do
+    context "given a standard association" do
+      subject { described_class.new(standard_association) }
+
+      its(:foreign_key) { should == 'post_id' }
+    end
+
+    context "given a named association" do
+      subject { described_class.new(class_named_association) }
+
+      its(:foreign_key) { should == 'poster_id' }
+    end
+
+    context "given a polymorphic association" do
+      subject { described_class.new(polymorphic_association) }
+
+      its(:foreign_key) { should == 'votable_id' }
+    end
+  end
+
+  describe "#polymorphic_type" do
+    context "when the association is polymorphic" do
+      subject { described_class.new(polymorphic_association) }
+
+      its(:polymorphic_type) { should == 'votable_type' }
+    end
+
+    context "when the association is not polymorphic" do
+      subject { described_class.new(standard_association) }
+
+      its(:polymorphic_type) { should == nil }
+    end
+  end
 end

data/spec/lib/sprig/reap/file_attribute_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+
+describe Sprig::Reap::FileAttribute do
+  let!(:user) do
+    User.create(:first_name => 'Bo',
+                :last_name  => 'Janglez',
+                :avatar     => File.open('spec/fixtures/images/avatar.png'))
+  end
+
+  let!(:carrierwave) { described_class.new(user.avatar) }
+  let!(:not_a_file)  { described_class.new(user.first_name) }
+
+  before do
+    stub_rails_root
+    Sprig::Reap.stub(:target_env).and_return('dreamland')
+  end
+
+  after do
+    FileUtils.remove_dir('./uploads') # Generated by CarrierWave
+  end
+
+  describe "#file" do
+    around do |example|
+      setup_seed_folder('./spec/fixtures/db/seeds/dreamland/files', &example)
+    end
+
+    context "when the given input is a carrierwave uploader" do
+      subject { carrierwave }
+
+      its(:file) { should be_an_instance_of(Sprig::Reap::FileAttribute::LocalFile) }
+    end
+
+    context "when the given input is not a recognized file object" do
+      subject { not_a_file }
+
+      its(:file) { should == nil }
+    end
+  end
+
+  describe "#file?" do
+    context "when the given input is a carrierwave uploader" do
+      subject { carrierwave }
+
+      its(:file?) { should == true }
+    end
+
+    context "when the given input is not a recognized file object" do
+      subject { not_a_file }
+
+      its(:file?) { should == false }
+    end
+  end
+
+  describe "#existing_location" do
+    subject { carrierwave }
+
+    context "for a locally-stored file" do
+      its(:existing_location) { should == subject.input.path }
+    end
+
+    context "for a remotely-stored file" do
+      context "with an incomplete url (CarrierWave storage set to :file for dev/test)" do
+        before { subject.input.stub(:url).and_return('/carrierwave/storage/file') }
+
+        it "falls back to the local path in the case of " do
+          subject.existing_location.should == subject.input.path
+        end
+      end
+
+      context "with a valid url" do
+        before { mock_remote subject }
+
+        its(:existing_location) { should == sprig_logo_url }
+      end
+    end
+  end
+
+  describe "#filename" do
+    subject { carrierwave }
+
+    context "for a locally-stored file" do
+      its(:filename) { should == 'avatar.png' }
+    end
+
+    context "for a remotely-stored file" do
+      before { mock_remote subject }
+
+      its(:filename) { should == File.basename(sprig_logo_url) }
+    end
+  end
+
+  describe "#target_location" do
+    subject { carrierwave }
+
+    context "when the files folder does not exist" do
+      let(:files_folder)  { './spec/fixtures/db/seeds/dreamland/files' }
+      let(:delete_folder) { FileUtils.remove_dir(files_folder) if Dir.exists?(files_folder) }
+
+      before { delete_folder }
+      after  { delete_folder }
+
+      it "creates the folder and returns the path" do
+        Dir.exists?(files_folder).should == false
+
+        subject.target_location.to_s.should == files_folder + '/' + subject.filename
+
+        Dir.exists?(files_folder).should == true
+      end
+    end
+
+    context "when the files folder exists" do
+      around do |example|
+        setup_seed_folder('./spec/fixtures/db/seeds/dreamland/files', &example)
+      end
+
+      its(:target_location) { should == Rails.root.join('db', 'seeds', 'dreamland', 'files', subject.filename) }
+    end
+  end
+
+  describe "#local_file" do
+    around do |example|
+      setup_seed_folder('./spec/fixtures/db/seeds/dreamland/files', &example)
+    end
+
+    context "when the existing location is a url" do
+      subject { carrierwave }
+
+      let(:local_file) { subject.local_file }
+
+      before do
+        mock_remote subject
+      end
+
+      it "returns a LocalFile" do
+        local_file.should be_an_instance_of(Sprig::Reap::FileAttribute::LocalFile)
+      end
+
+      it "creates a file at the target location" do
+        local_file.path.should == subject.target_location.to_s
+      end
+
+      it "creates a file with the same contents as the file from the existing location" do
+        File.open(local_file.path, 'r') do |local_file|
+          open(subject.existing_location) do |existing_file|
+            local_file.should be_same_file_as(existing_file)
+          end
+        end
+      end
+
+      context "and a file already exists at the target location" do
+        before do
+          File.stub(:exist?).with(subject.target_location).and_return(true)
+        end
+
+        it "assigns a unique filename" do
+          local_file.path.should_not == subject.target_location.to_s
+        end
+      end
+    end
+
+    context "when the existing location is a path" do
+      subject { carrierwave }
+
+      let(:local_file) { subject.local_file }
+
+      it "returns a LocalFile" do
+        local_file.should be_an_instance_of(Sprig::Reap::FileAttribute::LocalFile)
+      end
+
+      it "creates a file at the target location" do
+        local_file.path.should == subject.target_location.to_s
+      end
+
+      it "creates a file with the same contents as the file from the existing location" do
+        File.open(local_file.path, 'r') do |local_file|
+          File.open(subject.existing_location, 'r') do |existing_file|
+            local_file.should be_same_file_as(existing_file)
+          end
+        end
+      end
+
+      context "and a file already exists at the target location" do
+        before do
+          File.stub(:exist?).with(subject.target_location).and_return(true)
+        end
+
+        it "assigns a unique filename" do
+          local_file.path.should_not == subject.target_location.to_s
+        end
+      end
+    end
+  end
+
+  def mock_remote(file_attr)
+    file_attr.input.stub(:url).and_return(sprig_logo_url)
+  end
+
+  def sprig_logo_url
+    'https://camo.githubusercontent.com/ac48b093dc90330d2b9f3bb59671d384fe092166/687474703a2f2f692e696d6775722e636f6d2f5843753369564f2e706e67'
+  end
+end

data/spec/lib/sprig/reap/record_spec.rb

@@ -3,68 +3,116 @@ require 'spec_helper'
 class Very; end
 
 describe Sprig::Reap::Record do
-  let(:record)       { double('ActiveRecord::Base Instance') }
-  let(:model)        { double('Sprig::Reap::Model') }
-  let(:reap_record)  { double('Sprig::Reap::Record for class Very', :sprig_id => 5) }
-  let(:association) do
-    double('Sprig::Reap::Association',
-      :foreign_key  => "very_id",
-      :klass        => Very,
-      :polymorphic? => false
-    )
+  let!(:user) do
+    User.create(:first_name => 'Bo',
+                :last_name  => 'Janglez',
+                :avatar     => File.open('spec/fixtures/images/avatar.png'))
   end
-  let(:sprig_record) { "<%= sprig_record(Very, 5).id %>" }
 
-  subject { described_class.new(record, model) }
+  let!(:post) do
+    Post.create(:poster    => user,
+                :title     => 'Such Title',
+                :content   => 'Very Content',
+                :published => true)
+  end
 
-  before do
-    attrs = {
-      'id'      => 0,
-      'such'    => 1,
-      'wow'     => 2,
-      'very_id' => 3
-    }
-
-    attrs.each_pair do |attr, val|
-      record.stub(attr).and_return(val)
-    end
+  let!(:posterless_post) do
+    Post.create(:poster    => nil,
+                :title     => 'Wow Title',
+                :content   => 'Much Content',
+                :published => false)
+  end
 
-    model.stub(:attributes).and_return(attrs.keys)
-    model.stub(:existing_sprig_ids).and_return([])
-    model.stub(:associations).and_return([association])
+  let!(:models) { Sprig::Reap::Model.all }
+  let!(:model)  { models.find { |model| model.klass == Post } }
+
+  before do
+    stub_rails_root
+    Sprig::Reap.stub(:target_env).and_return('dreamland')
+  end
 
-    Sprig::Reap::Model.stub(:find).and_return(reap_record)
+  after do
+    FileUtils.remove_dir('./uploads')
   end
 
-  its(:id) { should == 0 }
+  describe "#id" do
+    subject { described_class.new(post, model) }
+
+    its(:id) { should == post.id }
+  end
 
   describe "#attributes" do
+    subject { described_class.new(post, model) }
+
     it "returns an array of attributes from the given model sans id" do
       subject.attributes.should == %w(
-        such
-        wow
-        very_id
+        title
+        content
+        published
+        poster_id
       )
     end
   end
 
   describe "#to_hash" do
+    subject { described_class.new(post, model) }
+
     it "returns its attributes and their values in a hash" do
       subject.to_hash.should == {
-        'sprig_id' => 0,
-        'such'     => 1,
-        'wow'      => 2,
-        'very_id'  => sprig_record
+        'sprig_id'  => post.id,
+        'title'     => 'Such Title',
+        'content'   => 'Very Content',
+        'published' => true,
+        'poster_id' => "<%= sprig_record(User, #{user.id}).id %>"
       }
     end
+
+    context "when an association/foreign_key is nil" do
+      subject { described_class.new(posterless_post, model) }
+
+      it "does not list a sprig record for the nil association" do
+        subject.to_hash.should == {
+          'sprig_id'  => posterless_post.id,
+          'title'     => 'Wow Title',
+          'content'   => 'Much Content',
+          'published' => false,
+          'poster_id' => nil
+        }
+      end
+    end
+
+    context "when an attribute is wrapped in a CarrierWave uploader" do
+      let(:user_model) { models.find { |model| model.klass == User } }
+
+      subject { described_class.new(user, user_model) }
+
+      around do |example|
+        setup_seed_folder('./spec/fixtures/db/seeds/dreamland/files', &example)
+      end
+
+      it "provides a path for a locally-stored version of the file" do
+        subject.to_hash.should == {
+          'sprig_id'   => user.id,
+          'first_name' => 'Bo',
+          'last_name'  => 'Janglez',
+          'type'       => user.type,
+          'avatar'     => "<%= sprig_file('avatar.png') %>"
+        }
+      end
+    end
+  end
+
+  describe "#local_file_for" do
   end
 
   describe "#sprig_id" do
-    its(:sprig_id) { should == record.id }
+    subject { described_class.new(post, model) }
+
+    its(:sprig_id) { should == post.id }
 
     context "when an existing seed record has a sprig_id equal to the record's id" do
       before do
-        model.stub(:existing_sprig_ids).and_return([record.id])
+        model.stub(:existing_sprig_ids).and_return([post.id])
         model.stub(:generate_sprig_id).and_return(25)
       end
 

data/spec/spec_helper.rb

@@ -5,11 +5,13 @@ require "active_record"
 require "database_cleaner"
 require "pry"
 require "generator_spec"
+require "carrierwave"
+require 'carrierwave/orm/activerecord'
 
 require "sprig-reap"
 
 %w(
-  /fixtures/models/*rb
+  /fixtures/**/*.rb
   /support/**/*.rb
 ).each do |file_set|
   Dir[File.dirname(__FILE__) + file_set].each { |file| require file }
@@ -39,7 +41,7 @@ end
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => "spec/db/activerecord.db")
 
 User.connection.execute "DROP TABLE IF EXISTS users;"
-User.connection.execute "CREATE TABLE users (id INTEGER PRIMARY KEY , first_name VARCHAR(255), last_name VARCHAR(255), type VARCHAR(255));"
+User.connection.execute "CREATE TABLE users (id INTEGER PRIMARY KEY , first_name VARCHAR(255), last_name VARCHAR(255), type VARCHAR(255), avatar VARCHAR(225));"
 
 Post.connection.execute "DROP TABLE IF EXISTS posts;"
 Post.connection.execute "CREATE TABLE posts (id INTEGER PRIMARY KEY , title VARCHAR(255), content VARCHAR(255), published BOOLEAN , poster_id INTEGER);"

data/spec/support/matchers/be_same_file_as.rb

@@ -0,0 +1,21 @@
+RSpec::Matchers.define(:be_same_file_as) do |exected_file|
+  match do |actual_file|
+    md5_hash(relevant_contents_of(actual_file)).should == md5_hash(relevant_contents_of(exected_file))
+  end
+
+  def md5_hash(string)
+    Digest::MD5.hexdigest(string)
+  end
+
+  def relevant_contents_of(file)
+    file.read.encode('UTF-8', 'binary', :invalid => :replace, :undef => :replace, :replace => '').tap do |contents|
+      contents.sub!(/\/Title[^\n]*/, '')
+      contents.sub!(/\/CreationDate[^\n]*/, '')
+      contents.sub!(/\/ModDate[^\n]*/, '')
+      contents.sub!(/\/Producer[^\n]*/, '')
+      contents.sub!(/\/ID[^\]]*/, '')
+      contents.sub!(/\/DocChecksum[^\n]*/, '')
+      contents.sub!(/startxref\n[\d]+/, '')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprig-reap
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -107,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 description: Sprig-Reap is a gem that allows you to output your application's data
   state to seed files.
 email:
@@ -117,6 +133,7 @@ extra_rdoc_files: []
 files:
 - lib/sprig/reap/association.rb
 - lib/sprig/reap/configuration.rb
+- lib/sprig/reap/file_attribute.rb
 - lib/sprig/reap/model.rb
 - lib/sprig/reap/railtie.rb
 - lib/sprig/reap/record.rb
@@ -130,10 +147,12 @@ files:
 - Rakefile
 - README.md
 - spec/db/activerecord.db
+- spec/fixtures/images/avatar.png
 - spec/fixtures/models/comment.rb
 - spec/fixtures/models/post.rb
 - spec/fixtures/models/user.rb
 - spec/fixtures/models/vote.rb
+- spec/fixtures/uploaders/avatar_uploader.rb
 - spec/fixtures/yaml/comment_seeds.yml
 - spec/fixtures/yaml/polymorphic_vote_record.yml
 - spec/fixtures/yaml/post_seeds.yml
@@ -142,6 +161,7 @@ files:
 - spec/fixtures/yaml/user_seeds.yml
 - spec/lib/sprig/reap/association_spec.rb
 - spec/lib/sprig/reap/configuration_spec.rb
+- spec/lib/sprig/reap/file_attribute_spec.rb
 - spec/lib/sprig/reap/model_spec.rb
 - spec/lib/sprig/reap/record_spec.rb
 - spec/lib/sprig/reap/seed_file_spec.rb
@@ -149,6 +169,7 @@ files:
 - spec/lib/sprig_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_setup.rb
+- spec/support/matchers/be_same_file_as.rb
 - spec/support/rails_stubs.rb
 homepage: http://www.github.com/vigetlabs/sprig-reap
 licenses:
@@ -177,10 +198,12 @@ specification_version: 3
 summary: Automatic seed file generation for Rails apps using Sprig.
 test_files:
 - spec/db/activerecord.db
+- spec/fixtures/images/avatar.png
 - spec/fixtures/models/comment.rb
 - spec/fixtures/models/post.rb
 - spec/fixtures/models/user.rb
 - spec/fixtures/models/vote.rb
+- spec/fixtures/uploaders/avatar_uploader.rb
 - spec/fixtures/yaml/comment_seeds.yml
 - spec/fixtures/yaml/polymorphic_vote_record.yml
 - spec/fixtures/yaml/post_seeds.yml
@@ -189,6 +212,7 @@ test_files:
 - spec/fixtures/yaml/user_seeds.yml
 - spec/lib/sprig/reap/association_spec.rb
 - spec/lib/sprig/reap/configuration_spec.rb
+- spec/lib/sprig/reap/file_attribute_spec.rb
 - spec/lib/sprig/reap/model_spec.rb
 - spec/lib/sprig/reap/record_spec.rb
 - spec/lib/sprig/reap/seed_file_spec.rb
@@ -196,4 +220,5 @@ test_files:
 - spec/lib/sprig_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_setup.rb
+- spec/support/matchers/be_same_file_as.rb
 - spec/support/rails_stubs.rb